From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Rasmus <rasmus@gmx.us>
Cc: emacs-orgmode@gnu.org
Subject: Re: [org.texi] New keywords tables
Date: Tue, 31 Mar 2015 22:33:53 +0200 [thread overview]
Message-ID: <87iodgyki6.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87lhidi2t5.fsf_-_@gmx.us> (rasmus@gmx.us's message of "Tue, 31 Mar 2015 17:50:30 +0200")
Rasmus <rasmus@gmx.us> 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}.
> +
> +@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.
> +@item BEAMER_FONT_THEME
> @cindex #+BEAMER_FONT_THEME
> +The Beamer font theme. See chapter 18 in the Beamer manual.
Ditto.
> +@item BEAMER_INNER_THEME
> @cindex #+BEAMER_INNER_THEME
> +The Beamer inner theme. See chapter 16 in the Beamer manual.
Ditto.
> +@item 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:
> -@code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
> -@code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
> -@code{#+BEAMER_OUTER_THEME}. 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 header@footnote{Lines 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.
> +@c This one is probably not needed
Why this comment?
> +@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.
> +@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?
> +@cindex #+HTML_MATHJAX
> +Options for MathJax (@code{org-html-mathjax-options}). See also
> +@code{org-html-mathjax-template}.
See above.
> +@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?
> -@example
> +@exampl
Typo.
> [[./img.png]]
> @end example
>
> @@ -13144,7 +13294,7 @@ including DocBook.}.
> @end table
>
> @node Document preamble
> -@subsection Document preamble
> +@subsection Texinfo specific syntax
Typo?
Regards,
next prev parent reply other threads:[~2015-03-31 20:32 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 ` Nicolas Goaziou [this message]
2015-03-31 21:57 ` [org.texi] New keywords tables Rasmus
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=87iodgyki6.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=rasmus@gmx.us \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public 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).