From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rasmus Subject: Re: [org.texi] New keywords tables Date: Tue, 31 Mar 2015 23:57:31 +0200 Message-ID: <878uecu8xg.fsf@gmx.us> References: <87y4miv7y6.fsf@gmx.us> <87a8yxi0zf.fsf@nicolasgoaziou.fr> <87k2y1qfpi.fsf@gmx.us> <87d23sdtod.fsf@nicolasgoaziou.fr> <87oanct43z.fsf@gmx.us> <874mp4dkeb.fsf@nicolasgoaziou.fr> <87bnjct08z.fsf@gmx.us> <87a8yv0w8v.fsf@nicolasgoaziou.fr> <87twx24vt5.fsf@gmx.us> <87d23pzczl.fsf@nicolasgoaziou.fr> <871tk5jvyx.fsf@gmx.us> <87vbhhxx3c.fsf@nicolasgoaziou.fr> <87lhidi2t5.fsf_-_@gmx.us> <87iodgyki6.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:39435) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Yd4AG-0003hB-OP for emacs-orgmode@gnu.org; Tue, 31 Mar 2015 17:57:41 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Yd4AC-0008Fy-Ng for emacs-orgmode@gnu.org; Tue, 31 Mar 2015 17:57:40 -0400 Received: from mout.gmx.net ([212.227.17.22]:55853) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Yd4AC-0008Fs-Ew for emacs-orgmode@gnu.org; Tue, 31 Mar 2015 17:57:36 -0400 Received: from W530 ([37.133.201.102]) by mail.gmx.com (mrgmx102) with ESMTPSA (Nemesis) id 0LZlZ2-1ZK8Di2NMC-00lR8e for ; Tue, 31 Mar 2015 23:57:34 +0200 In-Reply-To: <87iodgyki6.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Tue, 31 Mar 2015 22:33:53 +0200") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org Hi, Nicolas Goaziou 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 (=E2=89=A1 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 t= he >> 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 o= ptions >> +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 Beam= er >> +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 us= ing >> +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 a= re >> +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 opti= ons >> +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 >>=20=20 >> @@ -13144,7 +13294,7 @@ including DocBook.}. >> @end table >>=20=20 >> @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. =E2=80=94Rasmus --=20 And when I=E2=80=99m finished thinking, I have to die a lot