diff options
| author | Bastien Guerry | 2014-10-03 10:13:51 +0200 |
|---|---|---|
| committer | Bastien Guerry | 2014-10-03 10:13:51 +0200 |
| commit | a81e5de3a34d27cea43d49ffdfd9755f0eddb262 (patch) | |
| tree | 94d0e2b93f054d2cc9f7f7dc5423561ea3c00a2c /doc | |
| parent | e197284d4789d7caa613fc406516f58fbec02547 (diff) | |
| download | emacs-a81e5de3a34d27cea43d49ffdfd9755f0eddb262.tar.gz emacs-a81e5de3a34d27cea43d49ffdfd9755f0eddb262.zip | |
Sync with Org 8.2.8.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 22 | ||||
| -rw-r--r-- | doc/misc/org.texi | 382 |
2 files changed, 378 insertions, 26 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 0ad35d3803a..6e0b164b72b 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,25 @@ | |||
| 1 | 2014-10-02 Bastien Guerry <bzg@gnu.org> | ||
| 2 | |||
| 3 | * org.texi (Key bindings and useful functions): Fix typo. Use the | ||
| 4 | correct function's name. | ||
| 5 | |||
| 6 | 2014-10-02 Michael Brand <michael.ch.brand@gmail.com> | ||
| 7 | |||
| 8 | * org.texi (Formula syntax for Calc): Add `f-1' to TBLFM example | ||
| 9 | about `nan'. | ||
| 10 | |||
| 11 | 2014-10-02 Nicolas Goaziou <mail@nicolasgoaziou.fr> | ||
| 12 | |||
| 13 | * org.texi (Export settings): Be more explicit about how output | ||
| 14 | file name is built. | ||
| 15 | |||
| 16 | * org.texi (Headings and sectioning structure): Document menus. | ||
| 17 | |||
| 18 | 2014-10-02 Nicolas Goaziou <n.goaziou@gmail.com> | ||
| 19 | |||
| 20 | * org.texi (Include files, Publishing options): Remove reference | ||
| 21 | to inexistent variable. | ||
| 22 | |||
| 1 | 2014-07-25 Stephen Berman <stephen.berman@gmx.net> | 23 | 2014-07-25 Stephen Berman <stephen.berman@gmx.net> |
| 2 | 24 | ||
| 3 | * todo-mode.texi (Marked Items): Correct omission of item deletion | 25 | * todo-mode.texi (Marked Items): Correct omission of item deletion |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 3800a41d239..d8a83fc18a4 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -2,7 +2,7 @@ | |||
| 2 | @c %**start of header | 2 | @c %**start of header |
| 3 | @setfilename ../../info/org | 3 | @setfilename ../../info/org |
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | @set VERSION 8.2.6 | 5 | @set VERSION 8.2.8 |
| 6 | 6 | ||
| 7 | @c Version and Contact Info | 7 | @c Version and Contact Info |
| 8 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} | 8 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} |
| @@ -584,8 +584,9 @@ Exporting | |||
| 584 | * Markdown export:: Exporting to Markdown | 584 | * Markdown export:: Exporting to Markdown |
| 585 | * OpenDocument Text export:: Exporting to OpenDocument Text | 585 | * OpenDocument Text export:: Exporting to OpenDocument Text |
| 586 | * Org export:: Exporting to Org | 586 | * Org export:: Exporting to Org |
| 587 | * Texinfo export:: Exporting to Texinfo | ||
| 587 | * iCalendar export:: Exporting to iCalendar | 588 | * iCalendar export:: Exporting to iCalendar |
| 588 | * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page | 589 | * Other built-in back-ends:: Exporting to a man page |
| 589 | * Export in foreign buffers:: Author tables and lists in Org syntax | 590 | * Export in foreign buffers:: Author tables and lists in Org syntax |
| 590 | * Advanced configuration:: Fine-tuning the export output | 591 | * Advanced configuration:: Fine-tuning the export output |
| 591 | 592 | ||
| @@ -637,6 +638,16 @@ Advanced topics in ODT export | |||
| 637 | * Customizing tables in ODT export:: How to define and use Table templates | 638 | * Customizing tables in ODT export:: How to define and use Table templates |
| 638 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files | 639 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files |
| 639 | 640 | ||
| 641 | Texinfo export | ||
| 642 | |||
| 643 | * Texinfo export commands:: How to invoke Texinfo export | ||
| 644 | * Document preamble:: File header, title and copyright page | ||
| 645 | * Headings and sectioning structure:: Building document structure | ||
| 646 | * Indices:: Creating indices | ||
| 647 | * Quoting Texinfo code:: Incorporating literal Texinfo code | ||
| 648 | * Texinfo specific attributes:: Controlling Texinfo output | ||
| 649 | * An example:: | ||
| 650 | |||
| 640 | Publishing | 651 | Publishing |
| 641 | 652 | ||
| 642 | * Configuration:: Defining projects | 653 | * Configuration:: Defining projects |
| @@ -2725,9 +2736,11 @@ Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example | |||
| 2725 | @item if($1 < 20, teen, string("")) | 2736 | @item if($1 < 20, teen, string("")) |
| 2726 | "teen" if age $1 is less than 20, else the Org table result field is set to | 2737 | "teen" if age $1 is less than 20, else the Org table result field is set to |
| 2727 | empty with the empty string. | 2738 | empty with the empty string. |
| 2728 | @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E | 2739 | @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1 |
| 2729 | Sum of the first two columns. When at least one of the input fields is empty | 2740 | Sum of the first two columns. When at least one of the input fields is empty |
| 2730 | the Org table result field is set to empty. | 2741 | the Org table result field is set to empty. @samp{E} is required to not |
| 2742 | convert empty fields to 0. @samp{f-1} is an optional Calc format string | ||
| 2743 | similar to @samp{%.1f} but leaves empty results empty. | ||
| 2731 | @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E | 2744 | @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E |
| 2732 | Mean value of a range unless there is any empty field. Every field in the | 2745 | Mean value of a range unless there is any empty field. Every field in the |
| 2733 | range that is empty is replaced by @samp{nan} which lets @samp{vmean} result | 2746 | range that is empty is replaced by @samp{nan} which lets @samp{vmean} result |
| @@ -4410,7 +4423,7 @@ To record a timestamp without a note for TODO keywords configured with | |||
| 4410 | 4423 | ||
| 4411 | @noindent | 4424 | @noindent |
| 4412 | @vindex org-log-done | 4425 | @vindex org-log-done |
| 4413 | you not only define global TODO keywords and fast access keys, but also | 4426 | You not only define global TODO keywords and fast access keys, but also |
| 4414 | request that a time is recorded when the entry is set to | 4427 | request that a time is recorded when the entry is set to |
| 4415 | DONE@footnote{It is possible that Org mode will record two timestamps | 4428 | DONE@footnote{It is possible that Org mode will record two timestamps |
| 4416 | when you are using both @code{org-log-done} and state change logging. | 4429 | when you are using both @code{org-log-done} and state change logging. |
| @@ -9951,11 +9964,10 @@ include your @file{.emacs} file, you could use: | |||
| 9951 | @end example | 9964 | @end example |
| 9952 | 9965 | ||
| 9953 | @noindent | 9966 | @noindent |
| 9954 | The optional second and third parameter are the markup (e.g., @samp{quote}, | 9967 | The optional second and third parameter are the markup (i.e., @samp{example} |
| 9955 | @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the | 9968 | or @samp{src}), and, if the markup is @samp{src}, the language for formatting |
| 9956 | language for formatting the contents. The markup is optional; if it is not | 9969 | the contents. The markup is optional; if it is not given, the text will be |
| 9957 | given, the text will be assumed to be in Org mode format and will be | 9970 | assumed to be in Org mode format and will be processed normally. |
| 9958 | processed normally. | ||
| 9959 | 9971 | ||
| 9960 | Contents of the included file will belong to the same structure (headline, | 9972 | Contents of the included file will belong to the same structure (headline, |
| 9961 | item) containing the @code{INCLUDE} keyword. In particular, headlines within | 9973 | item) containing the @code{INCLUDE} keyword. In particular, headlines within |
| @@ -10364,8 +10376,9 @@ in the iCalendar format. | |||
| 10364 | * Markdown export:: Exporting to Markdown | 10376 | * Markdown export:: Exporting to Markdown |
| 10365 | * OpenDocument Text export:: Exporting to OpenDocument Text | 10377 | * OpenDocument Text export:: Exporting to OpenDocument Text |
| 10366 | * Org export:: Exporting to Org | 10378 | * Org export:: Exporting to Org |
| 10379 | * Texinfo export:: Exporting to Texinfo | ||
| 10367 | * iCalendar export:: Exporting to iCalendar | 10380 | * iCalendar export:: Exporting to iCalendar |
| 10368 | * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page | 10381 | * Other built-in back-ends:: Exporting to a man page |
| 10369 | * Export in foreign buffers:: Author tables and lists in Org syntax | 10382 | * Export in foreign buffers:: Author tables and lists in Org syntax |
| 10370 | * Advanced configuration:: Fine-tuning the export output | 10383 | * Advanced configuration:: Fine-tuning the export output |
| 10371 | @end menu | 10384 | @end menu |
| @@ -10690,16 +10703,12 @@ Toggle inclusion of TODO keywords into exported text | |||
| 10690 | Toggle inclusion of tables (@code{org-export-with-tables}). | 10703 | Toggle inclusion of tables (@code{org-export-with-tables}). |
| 10691 | @end table | 10704 | @end table |
| 10692 | 10705 | ||
| 10693 | @cindex property, EXPORT_FILE_NAME | ||
| 10694 | When exporting only a subtree, each of the previous keywords@footnote{With | 10706 | When exporting only a subtree, each of the previous keywords@footnote{With |
| 10695 | the exception of @samp{SETUPFILE}.} can be overridden locally by special node | 10707 | the exception of @samp{SETUPFILE}.} can be overridden locally by special node |
| 10696 | properties. These begin with @samp{EXPORT_}, followed by the name of the | 10708 | properties. These begin with @samp{EXPORT_}, followed by the name of the |
| 10697 | keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords | 10709 | keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords |
| 10698 | become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS} | 10710 | become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS} |
| 10699 | properties. Subtree export also supports the self-explicit | 10711 | properties. |
| 10700 | @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent | ||
| 10701 | for this property. The file name in this case is derived from the file | ||
| 10702 | associated to the buffer, if possible, or asked to the user otherwise.}. | ||
| 10703 | 10712 | ||
| 10704 | @cindex #+BIND | 10713 | @cindex #+BIND |
| 10705 | @vindex org-export-allow-bind-keywords | 10714 | @vindex org-export-allow-bind-keywords |
| @@ -10708,6 +10717,13 @@ can become buffer-local during export by using the BIND keyword. Its syntax | |||
| 10708 | is @samp{#+BIND: variable value}. This is particularly useful for in-buffer | 10717 | is @samp{#+BIND: variable value}. This is particularly useful for in-buffer |
| 10709 | settings that cannot be changed using specific keywords. | 10718 | settings that cannot be changed using specific keywords. |
| 10710 | 10719 | ||
| 10720 | @cindex property, EXPORT_FILE_NAME | ||
| 10721 | The name of the output file to be generated is taken from the file associated | ||
| 10722 | to the buffer, when possible, or asked to you otherwise. For subtree export, | ||
| 10723 | you can also set @samp{EXPORT_FILE_NAME} property. In all cases, only the | ||
| 10724 | base name of the file is retained, and a back-end specific extension is | ||
| 10725 | added. | ||
| 10726 | |||
| 10711 | @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting | 10727 | @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting |
| 10712 | @section ASCII/Latin-1/UTF-8 export | 10728 | @section ASCII/Latin-1/UTF-8 export |
| 10713 | @cindex ASCII export | 10729 | @cindex ASCII export |
| @@ -12228,7 +12244,7 @@ height:width ratio, do the following | |||
| 12228 | @cindex #+ATTR_ODT | 12244 | @cindex #+ATTR_ODT |
| 12229 | You can control the manner in which an image is anchored by setting the | 12245 | You can control the manner in which an image is anchored by setting the |
| 12230 | @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one | 12246 | @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one |
| 12231 | of the the following three values for the @code{:anchor} property: | 12247 | of the following three values for the @code{:anchor} property: |
| 12232 | @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}. | 12248 | @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}. |
| 12233 | 12249 | ||
| 12234 | To create an image that is anchored to a page, do the following: | 12250 | To create an image that is anchored to a page, do the following: |
| @@ -12834,7 +12850,324 @@ Export to a temporary buffer. Do not create a file. | |||
| 12834 | Export to an Org file, then open it. | 12850 | Export to an Org file, then open it. |
| 12835 | @end table | 12851 | @end table |
| 12836 | 12852 | ||
| 12837 | @node iCalendar export, Other built-in back-ends, Org export, Exporting | 12853 | @node Texinfo export, iCalendar export, Org export, Exporting |
| 12854 | @section Texinfo export | ||
| 12855 | @cindex Texinfo export | ||
| 12856 | |||
| 12857 | @samp{texinfo} export back-end generates Texinfo code and can compile it into | ||
| 12858 | an Info file. | ||
| 12859 | |||
| 12860 | @menu | ||
| 12861 | * Texinfo export commands:: How to invoke Texinfo export | ||
| 12862 | * Document preamble:: File header, title and copyright page | ||
| 12863 | * Headings and sectioning structure:: Building document structure | ||
| 12864 | * Indices:: Creating indices | ||
| 12865 | * Quoting Texinfo code:: Incorporating literal Texinfo code | ||
| 12866 | * Texinfo specific attributes:: Controlling Texinfo output | ||
| 12867 | * An example:: | ||
| 12868 | @end menu | ||
| 12869 | |||
| 12870 | @node Texinfo export commands, Document preamble, Texinfo export, Texinfo export | ||
| 12871 | @subsection Texinfo export commands | ||
| 12872 | |||
| 12873 | @vindex org-texinfo-info-process | ||
| 12874 | @table @kbd | ||
| 12875 | @orgcmd{C-c C-e i t,org-texinfo-export-to-texinfo} | ||
| 12876 | Export as a Texinfo file. For an Org file, @file{myfile.org}, the resulting | ||
| 12877 | file will be @file{myfile.texi}. The file will be overwritten without | ||
| 12878 | warning. | ||
| 12879 | @orgcmd{C-c C-e i i,org-texinfo-export-to-info} | ||
| 12880 | Export to Texinfo and then process to an Info file@footnote{By setting | ||
| 12881 | @code{org-texinfo-info-process}, it is possible to generate other formats, | ||
| 12882 | including DocBook.}. | ||
| 12883 | @end table | ||
| 12884 | |||
| 12885 | @node Document preamble, Headings and sectioning structure, Texinfo export commands, Texinfo export | ||
| 12886 | @subsection Document preamble | ||
| 12887 | |||
| 12888 | When processing a document, @samp{texinfo} back-end generates a minimal file | ||
| 12889 | header along with a title page, a copyright page, and a menu. You control | ||
| 12890 | the latter through the structure of the document (@pxref{Headings and | ||
| 12891 | sectioning structure}). Various keywords allow to tweak the other parts. It | ||
| 12892 | is also possible to give directions to install the document in the @samp{Top} | ||
| 12893 | node. | ||
| 12894 | |||
| 12895 | @subsubheading File header | ||
| 12896 | |||
| 12897 | @cindex #+TEXINFO_FILENAME | ||
| 12898 | Upon creating the header of a Texinfo file, the back-end guesses a name for | ||
| 12899 | the Info file to be compiled. This may not be a sensible choice, e.g., if | ||
| 12900 | you want to produce the final document in a different directory. Specify an | ||
| 12901 | alternate path with @code{#+TEXINFO_FILENAME} keyword to override the default | ||
| 12902 | destination. | ||
| 12903 | |||
| 12904 | @vindex org-texinfo-coding-system | ||
| 12905 | @vindex org-texinfo-classes | ||
| 12906 | @cindex #+TEXINFO_HEADER | ||
| 12907 | @cindex #+TEXINFO_CLASS | ||
| 12908 | Along with the output file name, the header contains information about the | ||
| 12909 | language (@pxref{Export settings}) and current encoding used@footnote{See | ||
| 12910 | @code{org-texinfo-coding-system} for more information.}. Insert | ||
| 12911 | a @code{#+TEXINFO_HEADER} keyword for each additional command needed, e.g., | ||
| 12912 | @@code@{@@synindex@}. | ||
| 12913 | |||
| 12914 | If you happen to regularly install the same set of commands, it may be easier | ||
| 12915 | to define your own class in @code{org-texinfo-classes}, which see. Set | ||
| 12916 | @code{#+TEXINFO_CLASS} keyword accordingly in your document to activate it. | ||
| 12917 | |||
| 12918 | @subsubheading Title and copyright page | ||
| 12919 | |||
| 12920 | @cindex #+TEXINFO_PRINTED_TITLE | ||
| 12921 | @cindex #+SUBTITLE | ||
| 12922 | The default template includes a title page for hard copy output. The title | ||
| 12923 | and author displayed on this page are extracted from, respectively, | ||
| 12924 | @code{#+TITLE} and @code{#+AUTHOR} keywords (@pxref{Export settings}). It is | ||
| 12925 | also possible to print a different, more specific, title with | ||
| 12926 | @code{#+TEXINFO_PRINTED_TITLE} keyword, and add subtitles with | ||
| 12927 | @code{#+SUBTITLE} keyword. Both expect raw Texinfo code in their value. | ||
| 12928 | |||
| 12929 | @cindex #+SUBAUTHOR | ||
| 12930 | Likewise, information brought by @code{#+AUTHOR} may not be enough. You can | ||
| 12931 | include other authors with several @code{#+SUBAUTHOR} keywords. Values are | ||
| 12932 | also expected to be written in Texinfo code. | ||
| 12933 | |||
| 12934 | @example | ||
| 12935 | #+AUTHOR: Jane Smith | ||
| 12936 | #+SUBAUTHOR: John Doe | ||
| 12937 | #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@} | ||
| 12938 | @end example | ||
| 12939 | |||
| 12940 | @cindex property, COPYING | ||
| 12941 | Copying material is defined in a dedicated headline with a non-nil | ||
| 12942 | @code{:COPYING:} property. The contents are inserted within | ||
| 12943 | a @code{@@copying} command at the beginning of the document whereas the | ||
| 12944 | heading itself does not appear in the structure of the document. | ||
| 12945 | |||
| 12946 | Copyright information is printed on the back of the title page. | ||
| 12947 | |||
| 12948 | @example | ||
| 12949 | * Copying | ||
| 12950 | :PROPERTIES: | ||
| 12951 | :COPYING: t | ||
| 12952 | :END: | ||
| 12953 | |||
| 12954 | This is a short example of a complete Texinfo file, version 1.0. | ||
| 12955 | |||
| 12956 | Copyright \copy 2014 Free Software Foundation, Inc. | ||
| 12957 | @end example | ||
| 12958 | |||
| 12959 | @subsubheading The Top node | ||
| 12960 | |||
| 12961 | @cindex #+TEXINFO_DIR_CATEGORY | ||
| 12962 | @cindex #+TEXINFO_DIR_TITLE | ||
| 12963 | @cindex #+TEXINFO_DIR_DESC | ||
| 12964 | You may ultimately want to install your new Info file to your system. You | ||
| 12965 | can write an appropriate entry in the top level directory specifying its | ||
| 12966 | category and title with, respectively, @code{#+TEXINFO_DIR_CATEGORY} and | ||
| 12967 | @code{#+TEXINFO_DIR_TITLE}. Optionally, you can add a short description | ||
| 12968 | using @code{#+TEXINFO_DIR_DESC}. The following example would write an entry | ||
| 12969 | similar to Org's in the @samp{Top} node. | ||
| 12970 | |||
| 12971 | @example | ||
| 12972 | #+TEXINFO_DIR_CATEGORY: Emacs | ||
| 12973 | #+TEXINFO_DIR_TITLE: Org Mode: (org) | ||
| 12974 | #+TEXINFO_DIR_DESC: Outline-based notes management and organizer | ||
| 12975 | @end example | ||
| 12976 | |||
| 12977 | @node Headings and sectioning structure, Indices, Document preamble, Texinfo export | ||
| 12978 | @subsection Headings and sectioning structure | ||
| 12979 | |||
| 12980 | @vindex org-texinfo-classes | ||
| 12981 | @vindex org-texinfo-default-class | ||
| 12982 | @cindex #+TEXINFO_CLASS | ||
| 12983 | @samp{texinfo} uses a pre-defined scheme, or class, to convert headlines into | ||
| 12984 | Texinfo structuring commands. For example, a top level headline appears as | ||
| 12985 | @code{@@chapter} if it should be numbered or as @code{@@unnumbered} | ||
| 12986 | otherwise. If you need to use a different set of commands, e.g., to start | ||
| 12987 | with @code{@@part} instead of @code{@@chapter}, install a new class in | ||
| 12988 | @code{org-texinfo-classes}, then activate it with @code{#+TEXINFO_CLASS} | ||
| 12989 | keyword. Export process defaults to @code{org-texinfo-default-class} when | ||
| 12990 | there is no such keyword in the document. | ||
| 12991 | |||
| 12992 | If a headline's level has no associated structuring command, or is below | ||
| 12993 | a certain threshold @pxref{Export settings}, that headline becomes a list in | ||
| 12994 | Texinfo output. | ||
| 12995 | |||
| 12996 | @cindex property, APPENDIX | ||
| 12997 | As an exception, a headline with a non-nil @code{:APPENDIX:} property becomes | ||
| 12998 | an appendix, independently on its level and the class used. | ||
| 12999 | |||
| 13000 | @cindex property, DESCRIPTION | ||
| 13001 | Each regular sectioning structure creates a menu entry, named after the | ||
| 13002 | heading. You can provide a different, e.g., shorter, title in | ||
| 13003 | @code{:ALT_TITLE:} property (@pxref{Table of contents}). Optionally, you can | ||
| 13004 | specify a description for the item in @code{:DESCRIPTION:} property. E.g., | ||
| 13005 | |||
| 13006 | @example | ||
| 13007 | * Controlling Screen Display | ||
| 13008 | :PROPERTIES: | ||
| 13009 | :ALT_TITLE: Display | ||
| 13010 | :DESCRIPTION: Controlling Screen Display | ||
| 13011 | :END: | ||
| 13012 | @end example | ||
| 13013 | |||
| 13014 | @node Indices, Quoting Texinfo code, Headings and sectioning structure, Texinfo export | ||
| 13015 | @subsection Indices | ||
| 13016 | |||
| 13017 | @cindex #+CINDEX | ||
| 13018 | @cindex #+FINDEX | ||
| 13019 | @cindex #+KINDEX | ||
| 13020 | @cindex #+PINDEX | ||
| 13021 | @cindex #+TINDEX | ||
| 13022 | @cindex #+VINDEX | ||
| 13023 | Index entries are created using dedicated keywords. @samp{texinfo} back-end | ||
| 13024 | provides one for each predefined type: @code{#+CINDEX}, @code{#+FINDEX}, | ||
| 13025 | @code{#+KINDEX}, @code{#+PINDEX}, @code{#+TINDEX} and @code{#+VINDEX}. For | ||
| 13026 | custom indices, you can write raw Texinfo code (@pxref{Quoting Texinfo | ||
| 13027 | code}). | ||
| 13028 | |||
| 13029 | @example | ||
| 13030 | #+CINDEX: Defining indexing entries | ||
| 13031 | @end example | ||
| 13032 | |||
| 13033 | @cindex property, INDEX | ||
| 13034 | To generate an index, you need to set the @code{:INDEX:} property of | ||
| 13035 | a headline to an appropriate abbreviation (e.g., @samp{cp} or @samp{vr}). | ||
| 13036 | The headline is then exported as an unnumbered chapter or section command and | ||
| 13037 | the index is inserted after its contents. | ||
| 13038 | |||
| 13039 | @example | ||
| 13040 | * Concept Index | ||
| 13041 | :PROPERTIES: | ||
| 13042 | :INDEX: cp | ||
| 13043 | :END: | ||
| 13044 | @end example | ||
| 13045 | |||
| 13046 | @node Quoting Texinfo code, Texinfo specific attributes, Indices, Texinfo export | ||
| 13047 | @subsection Quoting Texinfo code | ||
| 13048 | |||
| 13049 | It is possible to insert raw Texinfo code using any of the following | ||
| 13050 | constructs | ||
| 13051 | |||
| 13052 | @cindex #+TEXINFO | ||
| 13053 | @cindex #+BEGIN_TEXINFO | ||
| 13054 | @example | ||
| 13055 | Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU. | ||
| 13056 | |||
| 13057 | #+TEXINFO: @@need800 | ||
| 13058 | This paragraph is preceded by... | ||
| 13059 | |||
| 13060 | #+BEGIN_TEXINFO | ||
| 13061 | @@auindex Johnson, Mark | ||
| 13062 | @@auindex Lakoff, George | ||
| 13063 | #+END_TEXINFO | ||
| 13064 | @end example | ||
| 13065 | |||
| 13066 | @node Texinfo specific attributes, An example, Quoting Texinfo code, Texinfo export | ||
| 13067 | @subsection Texinfo specific attributes | ||
| 13068 | |||
| 13069 | @cindex #+ATTR_TEXINFO | ||
| 13070 | @samp{texinfo} back-end understands several attributes in plain lists and | ||
| 13071 | tables. They must be specified using an @code{#+ATTR_TEXINFO} keyword, | ||
| 13072 | written just above the list or table. | ||
| 13073 | |||
| 13074 | @subsubheading Plain lists | ||
| 13075 | |||
| 13076 | In Texinfo output, description lists appear as two-column tables, using the | ||
| 13077 | default command @code{@@table}. You can use @code{@@ftable} or | ||
| 13078 | @code{@@vtable}@footnote{For more information, @inforef{Two-column | ||
| 13079 | Tables,,texinfo}.} instead with @code{:table-type} attribute. | ||
| 13080 | |||
| 13081 | @vindex org-texinfo-def-table-markup | ||
| 13082 | In any case, these constructs require a highlighting command for entries in | ||
| 13083 | the list. You can provide one with @code{:indic} attribute. If you do not, | ||
| 13084 | it defaults to the value stored in @code{org-texinfo-def-table-markup}, which | ||
| 13085 | see. | ||
| 13086 | |||
| 13087 | @example | ||
| 13088 | #+ATTR_TEXINFO: :indic @@asis | ||
| 13089 | - foo :: This is the text for /foo/, with no highlighting. | ||
| 13090 | @end example | ||
| 13091 | |||
| 13092 | @subsubheading Tables | ||
| 13093 | |||
| 13094 | When exporting a table, column widths are deduced from the longest cell in | ||
| 13095 | each column. You can also define them explicitly as fractions of the line | ||
| 13096 | length, using @code{:columns} attribute. | ||
| 13097 | |||
| 13098 | @example | ||
| 13099 | #+ATTR_TEXINFO: :columns .5 .5 | ||
| 13100 | | a cell | another cell | | ||
| 13101 | @end example | ||
| 13102 | |||
| 13103 | @node An example, , Texinfo specific attributes, Texinfo export | ||
| 13104 | @subsection An example | ||
| 13105 | |||
| 13106 | Here is a thorough example, taken from @inforef{GNU Sample Texts,,texinfo}. | ||
| 13107 | |||
| 13108 | @smallexample | ||
| 13109 | #+MACRO: version 2.0 | ||
| 13110 | #+MACRO: updated last updated 4 March 2014 | ||
| 13111 | |||
| 13112 | #+OPTIONS: ':t toc:t author:t email:t | ||
| 13113 | #+TITLE: GNU Sample @{@{@{version@}@}@} | ||
| 13114 | #+AUTHOR: A.U. Thor | ||
| 13115 | #+EMAIL: bug-sample@@gnu.org | ||
| 13116 | #+LANGUAGE: en | ||
| 13117 | |||
| 13118 | #+TEXINFO_FILENAME: sample.info | ||
| 13119 | #+TEXINFO_HEADER: @@syncodeindex pg cp | ||
| 13120 | |||
| 13121 | #+TEXINFO_DIR_CATEGORY: Texinfo documentation system | ||
| 13122 | #+TEXINFO_DIR_TITLE: sample: (sample) | ||
| 13123 | #+TEXINFO_DIR_DESC: Invoking sample | ||
| 13124 | |||
| 13125 | #+TEXINFO_PRINTED_TITLE: GNU Sample | ||
| 13126 | #+SUBTITLE: for version 2.0, last updated 4 March 2014 | ||
| 13127 | |||
| 13128 | * Copying | ||
| 13129 | :PROPERTIES: | ||
| 13130 | :COPYING: t | ||
| 13131 | :END: | ||
| 13132 | |||
| 13133 | This manual is for GNU Sample (version @{@{@{version@}@}@}, | ||
| 13134 | @{@{@{updated@}@}@}), which is an example in the Texinfo documentation. | ||
| 13135 | |||
| 13136 | Copyright @@@@texinfo:@@copyright@{@}@@@@ 2013 Free Software Foundation, | ||
| 13137 | Inc. | ||
| 13138 | |||
| 13139 | #+BEGIN_QUOTE | ||
| 13140 | Permission is granted to copy, distribute and/or modify this | ||
| 13141 | document under the terms of the GNU Free Documentation License, | ||
| 13142 | Version 1.3 or any later version published by the Free Software | ||
| 13143 | Foundation; with no Invariant Sections, with no Front-Cover Texts, | ||
| 13144 | and with no Back-Cover Texts. A copy of the license is included in | ||
| 13145 | the section entitled "GNU Free Documentation License". | ||
| 13146 | #+END_QUOTE | ||
| 13147 | |||
| 13148 | * Invoking sample | ||
| 13149 | |||
| 13150 | #+PINDEX: sample | ||
| 13151 | #+CINDEX: invoking @@command@{sample@} | ||
| 13152 | |||
| 13153 | This is a sample manual. There is no sample program to invoke, but | ||
| 13154 | if there were, you could see its basic usage and command line | ||
| 13155 | options here. | ||
| 13156 | |||
| 13157 | * GNU Free Documentation License | ||
| 13158 | :PROPERTIES: | ||
| 13159 | :APPENDIX: t | ||
| 13160 | :END: | ||
| 13161 | |||
| 13162 | #+TEXINFO: @@include fdl.texi | ||
| 13163 | |||
| 13164 | * Index | ||
| 13165 | :PROPERTIES: | ||
| 13166 | :INDEX: cp | ||
| 13167 | :END: | ||
| 13168 | @end smallexample | ||
| 13169 | |||
| 13170 | @node iCalendar export, Other built-in back-ends, Texinfo export, Exporting | ||
| 12838 | @section iCalendar export | 13171 | @section iCalendar export |
| 12839 | @cindex iCalendar export | 13172 | @cindex iCalendar export |
| 12840 | 13173 | ||
| @@ -12912,12 +13245,11 @@ On top of the aforementioned back-ends, Org comes with other built-in ones: | |||
| 12912 | 13245 | ||
| 12913 | @itemize | 13246 | @itemize |
| 12914 | @item @file{ox-man.el}: export to a man page. | 13247 | @item @file{ox-man.el}: export to a man page. |
| 12915 | @item @file{ox-texinfo.el}: export to @code{Texinfo} format. | ||
| 12916 | @end itemize | 13248 | @end itemize |
| 12917 | 13249 | ||
| 12918 | To activate these export back-end, customize @code{org-export-backends} or | 13250 | To activate these export back-end, customize @code{org-export-backends} or |
| 12919 | load them directly with e.g., @code{(require 'ox-texinfo)}. This will add | 13251 | load them directly with e.g., @code{(require 'ox-man)}. This will add new |
| 12920 | new keys in the export dispatcher (@pxref{The Export Dispatcher}). | 13252 | keys in the export dispatcher (@pxref{The Export Dispatcher}). |
| 12921 | 13253 | ||
| 12922 | See the comment section of these files for more information on how to use | 13254 | See the comment section of these files for more information on how to use |
| 12923 | them. | 13255 | them. |
| @@ -13334,7 +13666,6 @@ string of these options for details. | |||
| 13334 | @item @code{:headline-levels} @tab @code{org-export-headline-levels} | 13666 | @item @code{:headline-levels} @tab @code{org-export-headline-levels} |
| 13335 | @item @code{:language} @tab @code{org-export-default-language} | 13667 | @item @code{:language} @tab @code{org-export-default-language} |
| 13336 | @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks} | 13668 | @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks} |
| 13337 | @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | ||
| 13338 | @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} | 13669 | @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} |
| 13339 | @item @code{:select-tags} @tab @code{org-export-select-tags} | 13670 | @item @code{:select-tags} @tab @code{org-export-select-tags} |
| 13340 | @item @code{:with-author} @tab @code{org-export-with-author} | 13671 | @item @code{:with-author} @tab @code{org-export-with-author} |
| @@ -15473,10 +15804,10 @@ are active: | |||
| 15473 | @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block} | 15804 | @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block} |
| 15474 | @kindex C-c C-o | 15805 | @kindex C-c C-o |
| 15475 | @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result} | 15806 | @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result} |
| 15476 | @kindex C-up | 15807 | @kindex M-up |
| 15477 | @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session} | 15808 | @item @kbd{M-@key{up}} @tab @code{org-babel-load-in-session} |
| 15478 | @kindex M-down | 15809 | @kindex M-down |
| 15479 | @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session} | 15810 | @item @kbd{M-@key{down}} @tab @code{org-babel-switch-to-session} |
| 15480 | @end multitable | 15811 | @end multitable |
| 15481 | 15812 | ||
| 15482 | In an Org mode buffer, the following key bindings are active: | 15813 | In an Org mode buffer, the following key bindings are active: |
| @@ -18208,7 +18539,6 @@ org-customize @key{RET}} and then click yourself through the tree. | |||
| 18208 | @bye | 18539 | @bye |
| 18209 | 18540 | ||
| 18210 | @c Local variables: | 18541 | @c Local variables: |
| 18211 | @c coding: utf-8 | ||
| 18212 | @c fill-column: 77 | 18542 | @c fill-column: 77 |
| 18213 | @c indent-tabs-mode: nil | 18543 | @c indent-tabs-mode: nil |
| 18214 | @c paragraph-start: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$" | 18544 | @c paragraph-start: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$" |