From: Rasmus <rasmus@gmx.us>
To: emacs-orgmode@gnu.org
Subject: Re: [org.texi] New keywords tables
Date: Tue, 31 Mar 2015 23:57:31 +0200 [thread overview]
Message-ID: <878uecu8xg.fsf@gmx.us> (raw)
In-Reply-To: <87iodgyki6.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Tue, 31 Mar 2015 22:33:53 +0200")
Hi,
Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:
>> An example of a structure change is attached. It introduces a table
>> similar to @ref{Export settings} in the beginning of most backend
>> chapters.
>>
>> I have not (re)read it yet, but I want to make sure that we roughly agree
>> on the structure before I put more time into it. It does not touch
>> texinfo (yet) 'cause it's complicated.
>
> What is complicated? I find it quite clear. I'm biased, tho.
It's complicated 'cause it already "good quality" in the sense that it
already more structure (≡ using a table-like structure) than other
sections. Thus, it's not simply a question of going through the backend
definitions, and copying in keywords.
>> Also I would kill all backend specific keywords from the table in "@node
>> In-buffer settings":
>>
>> @itemx #+LATEX_HEADER:, #+LATEX_HEADER_EXTRA:,
>> @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:,
>> #+HTML_LINK_HOME:,
>> @itemx #+ODT_STYLES_FILE:,
>>
>> It does not contain all HTML KW or any Beamer KW. IOW it's a mess and the
>> true picture here would be ugly.
>>
>> WDYT?
>
> Agreed.
OK.
>> +#+TITLE: This is the title of the document
>> +#+: This is the title of the document
>
> Typo.
I was trying to suggest that I had not put much effort into this yet,
implying comments would be premature. Anyway, thanks for the comments!
>> +Beamer export introduces a number of keywords, similar to the general options
>> +settings described in @pxref{Export settings}.
>> +
>> +@table @samp
>> +@item BEAMER_THEME
>> @cindex #+BEAMER_THEME
>> -@cindex #+BEAMER_COLOR_THEME
>> +@vindex org-beamer-theme
>> +The Beamer theme (@code{org-beamer-theme}). See chapter 15 in the Beamer
>> +manual.
>
> I think the user can find references to Beamer's theme in the
> appropriate manual by himself. I suggest to remove the second sentence.
OK.
>> +@c This one is probably not needed
>
> Why this comment?
'Cause it's work in progress. Anyway, I decided to just include any
keyword defined in the backend. Thus, it should be included.
>> +@item BEAMER_HEADER
>> +@cindex #+BEAMER_HEADER
>> +Arbitrary lines appended to the end of the preamble of the document.
>> +
>> +@item DESCRIPTION
>> +@cindex #+DESCRIPTION (Beamer)
>> +The document description. By default these are inserted as metadata using
>> +hyperref. You can use several such keywords if the list is long. See also
>> +@code{org-latex-hyperref-template} and @code{org-latex-title-command}.
>
> "See also" is a bit terse. Maybe
>
> By default these are inserted as metadata using @samp{hyperref}
> package@footnote{You can customize @code{org-latex-hyperref-template}
> to control what data is included in the document.} and can be used to
> build complex titles (see @code{org-latex-title-command} for details).
> You can use several such keywords if the description is long.
I'm indifferent, but I know these keywords too well.
>> +@item KEYWORDS
>> +@cindex #+KEYWORDS (Beamer)
>> +The keywords defining the contents of the document. By default these are
>> +inserted as metadata using hyperref. You can use several such keywords if
>> +the list is long. See also @code{org-latex-hyperref-template} and
>> +@code{org-latex-title-command}.
>> +@end table
>> +
>> +This example illustrates how to change the theme. Note that theme options
>> +can be specified in square brackets.
>
> Shouldn't the example be moved earlier, when BEAMER_THEME is discussed?
No 'cause I want a clean view of the keywords. I don't know what the
point is of that example (it was there before), but I learned about the
interpretation of square brackets...
>> +@item LATEX_HEADER
>> +@cindex #+LATEX_HEADER (HTML)
>> +used when transcoding e.g. math formulas to images.
>
> Capital. This may be expanded a bit, i.e., how is it used?
Good question.
>> [[./img.png]]
>> @end example
>>
>> @@ -13144,7 +13294,7 @@ including DocBook.}.
>> @end table
>>
>> @node Document preamble
>> -@subsection Document preamble
>> +@subsection Texinfo specific syntax
>
> Typo?
No, I would like to have consistent headings for each backend. But see my
note above on the Texinfo chapter being more structured.
—Rasmus
--
And when I’m finished thinking, I have to die a lot
next prev parent reply other threads:[~2015-03-31 21:57 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-03-27 14:19 [ox, patch] #+SUBTITLE Rasmus
2015-03-27 15:08 ` Andreas Leha
2015-03-27 15:12 ` Rasmus
2015-03-27 15:35 ` Andreas Leha
2015-03-28 15:40 ` Nicolas Goaziou
2015-03-28 15:55 ` Rasmus
2015-03-28 17:15 ` Thomas S. Dye
2015-03-29 9:44 ` Nicolas Goaziou
2015-03-29 11:50 ` Rasmus
2015-03-29 13:05 ` Nicolas Goaziou
2015-03-29 13:13 ` Rasmus
2015-03-30 7:39 ` Nicolas Goaziou
2015-03-30 10:35 ` Rasmus
2015-03-31 10:18 ` Nicolas Goaziou
2015-03-31 10:35 ` Rasmus
2015-03-31 10:47 ` Nicolas Goaziou
2015-03-31 15:50 ` [org.texi] New keywords tables (was: [ox, patch] #+SUBTITLE) Rasmus
2015-03-31 20:33 ` [org.texi] New keywords tables Nicolas Goaziou
2015-03-31 21:57 ` Rasmus [this message]
2015-04-01 11:53 ` Rasmus
2015-04-01 19:37 ` Nicolas Goaziou
2015-04-01 21:55 ` Rasmus
2015-04-01 22:34 ` [ox, patch] #+SUBTITLE Rasmus
2015-04-08 21:25 ` Rasmus
2015-03-29 11:16 ` Rasmus
2015-03-31 10:21 ` Nicolas Goaziou
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=878uecu8xg.fsf@gmx.us \
--to=rasmus@gmx.us \
--cc=emacs-orgmode@gnu.org \
--subject='Re: [org.texi] New keywords tables' \
/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).