Re: [O] [org.texi] New keywords tables

[Rasmus]

Hi,

Nicolas Goaziou <address@hidden> 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}.
>> +
>> address@hidden @samp
>> address@hidden BEAMER_THEME
>>  @cindex #+BEAMER_THEME
>> address@hidden #+BEAMER_COLOR_THEME
>> address@hidden 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.

>> address@hidden 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.

>> address@hidden BEAMER_HEADER
>> address@hidden #+BEAMER_HEADER
>> +Arbitrary lines appended to the end of the preamble of the document.
>> +
>> address@hidden DESCRIPTION
>> address@hidden #+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
>> address@hidden and @code{org-latex-title-command}.
>
> "See also" is a bit terse. Maybe
>
>   By default these are inserted as metadata using @samp{hyperref}
>   address@hidden 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.

>> address@hidden KEYWORDS
>> address@hidden #+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
>> address@hidden
>> address@hidden 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...


>> address@hidden LATEX_HEADER
>> address@hidden #+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
>> address@hidden Document preamble
>> address@hidden 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