emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Nicolas Goaziou
Subject: Re: [O] [org.texi] New keywords tables
Date: Tue, 31 Mar 2015 22:33:53 +0200

Rasmus <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.

> WDYT?

Thanks. It is a good idea.

> 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.

> +#+TITLE: This is the title of the document
> +#+: This is the title of the document

Typo.

> +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.

> address@hidden BEAMER_FONT_THEME
>  @cindex #+BEAMER_FONT_THEME
> +The Beamer font theme.  See chapter 18 in the Beamer manual.

Ditto.

> address@hidden BEAMER_INNER_THEME
>  @cindex #+BEAMER_INNER_THEME
> +The Beamer inner theme.  See chapter 16 in the Beamer manual.

Ditto.

> address@hidden BEAMER_OUTER_THEME
>  @cindex #+BEAMER_OUTER_THEME
> -Beamer export introduces a number of keywords to insert code in the
> -document's header.  Four control appearance of the presentation:
> address@hidden, @code{#+BEAMER_COLOR_THEME},
> address@hidden, @code{#+BEAMER_INNER_THEME} and
> address@hidden  All of them accept optional arguments within
> -square brackets.  The last one, @code{#+BEAMER_HEADER}, is more generic and
> -allows you to append any line of code in the address@hidden are
> -appended at the end of the preamble, allowing for any final customization
> -such as the inclusion of short titles.}.
> +The Beamer outer theme.  See chapter 16 in the Beamer manual.

Ditto.

> address@hidden This one is probably not needed

Why this comment?

> 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.

> 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?

> address@hidden #+HTML_MATHJAX
> +Options for MathJax (@code{org-html-mathjax-options}).  See also
> address@hidden

See above.

> 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?

> address@hidden
> address@hidden

Typo.

>  [[./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?


Regards,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]