emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <n.goaziou@gmail.com>
To: Jambunathan K <kjambunathan@gmail.com>
Cc: Orgmode <emacs-orgmode@gnu.org>
Subject: Re: Frontmatter / Text before first headline
Date: Wed, 01 Feb 2012 14:43:04 +0100	[thread overview]
Message-ID: <874nvasm8n.fsf@gmail.com> (raw)
In-Reply-To: <81lion57bd.fsf@gmail.com> (Jambunathan K.'s message of "Wed, 01 Feb 2012 13:11:42 +0530")

Hello,

Jambunathan K <kjambunathan@gmail.com> writes:

> I have trouble understanding what the real purpose of the "text before
> the first headline" is. It looks to me more like a placeholder for
> capturing the "Frontmatter" [1].

If you're talking about the first section in the parse tree, the e-ascii
back-end makes use of it: even if that part of the document, links may
have to be collected and displayed before the first headline.

Also, "Frontmatter" probably only makes sense for large
documents. I sometimes write documents that doesn't even have an
headline. Should they be considered as one big frontmatter? Where would
be the matter, then?

> I have also trouble understanding what the rightful position for it is:
>
> Should it be like:
> (a) Title, Initial Text, TOC, Chapters
> 	Or like
> (b) Title, TOC, Initial Text, Chapters
>
> Currently org-latex does a (b). 
>
> But if I look at an organization of a typical document, I am inclined to
> think that it should be (a). It is also my contention that Table Of
> Contents is relocatable only as a means to achieve (b).

Honestly, (b) is easier to achieve than (a), since TOC can be stuffed in
preamble (that is before reading the parse tree). Also, as it's
configurable, I don't think we should bother too much here.

> I am wondering if you would be interested in formalizing frontmatter in
> Org documents. Backends will then be obligated to render the front
> matter headings as "centered text".

What about using special blocks?

--8<---------------cut here---------------start------------->8---
#+begin_abstract
This is the document abstract.
#+end_abstract
--8<---------------cut here---------------end--------------->8---

You can even use a drawer and define its export behaviour in
`org-export-format-drawer-function' (current exporter) or an equivalent.

Anyway, if it happens that tools to build complex documents are
missing[1], I agree that we should provide them, as long as they aren't
imposed to the user.


Regards,

[1] But, first, let's make sure that it's impossible, or at least very
difficult, with current ones.

-- 
Nicolas Goaziou

  reply	other threads:[~2012-02-01 13:45 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-02-01  7:41 Jambunathan K
2012-02-01 13:43 ` Nicolas Goaziou [this message]
2012-02-01 18:46 ` Achim Gratz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874nvasm8n.fsf@gmail.com \
    --to=n.goaziou@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=kjambunathan@gmail.com \
    --subject='Re: Frontmatter / Text before first headline' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).