Codebase list org-mode-doc / ebde703
Imported Upstream version 8.2.10 Sébastien Delafond 9 years ago
10 changed file(s) with 365 addition(s) and 35 deletion(s). Raw diff Collapse all Expand all
doc/org less more
Binary diff not shown
+2
-2
doc/org-version.inc less more
00 @c automatically generated, do not edit
1 @set VERSION 8.2.7c (release_8.2.7c)
2 @set DATE 2014-07-30
1 @set VERSION 8.2.10 (release_8.2.10)
2 @set DATE 2014-10-12
doc/org.pdf less more
Binary diff not shown
+344
-13
doc/org.texi less more
264264 Permission is granted to copy, distribute and/or modify this document
265265 under the terms of the GNU Free Documentation License, Version 1.3 or
266266 any later version published by the Free Software Foundation; with no
267 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
267 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
268268 and with the Back-Cover Texts as in (a) below. A copy of the license
269269 is included in the section entitled ``GNU Free Documentation License.''
270270
584584 * Markdown export:: Exporting to Markdown
585585 * OpenDocument Text export:: Exporting to OpenDocument Text
586586 * Org export:: Exporting to Org
587 * Texinfo export:: Exporting to Texinfo
587588 * 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
589590 * Export in foreign buffers:: Author tables and lists in Org syntax
590591 * Advanced configuration:: Fine-tuning the export output
591592
636637 * Creating one-off styles:: How to produce custom highlighting etc
637638 * Customizing tables in ODT export:: How to define and use Table templates
638639 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
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::
639650
640651 Publishing
641652
44124423
44134424 @noindent
44144425 @vindex org-log-done
4415 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
44164427 request that a time is recorded when the entry is set to
44174428 DONE@footnote{It is possible that Org mode will record two timestamps
44184429 when you are using both @code{org-log-done} and state change logging.
1036510376 * Markdown export:: Exporting to Markdown
1036610377 * OpenDocument Text export:: Exporting to OpenDocument Text
1036710378 * Org export:: Exporting to Org
10379 * Texinfo export:: Exporting to Texinfo
1036810380 * iCalendar export:: Exporting to iCalendar
10369 * Other built-in back-ends:: Exporting to @code{Texinfo} or a man page
10381 * Other built-in back-ends:: Exporting to a man page
1037010382 * Export in foreign buffers:: Author tables and lists in Org syntax
1037110383 * Advanced configuration:: Fine-tuning the export output
1037210384 @end menu
1069110703 Toggle inclusion of tables (@code{org-export-with-tables}).
1069210704 @end table
1069310705
10694 @cindex property, EXPORT_FILE_NAME
1069510706 When exporting only a subtree, each of the previous keywords@footnote{With
1069610707 the exception of @samp{SETUPFILE}.} can be overridden locally by special node
1069710708 properties. These begin with @samp{EXPORT_}, followed by the name of the
1069810709 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
1069910710 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10700 properties. Subtree export also supports the self-explicit
10701 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent
10702 for this property. The file name in this case is derived from the file
10703 associated to the buffer, if possible, or asked to the user otherwise.}.
10711 properties.
1070410712
1070510713 @cindex #+BIND
1070610714 @vindex org-export-allow-bind-keywords
1070810716 can become buffer-local during export by using the BIND keyword. Its syntax
1070910717 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
1071010718 settings that cannot be changed using specific keywords.
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.
1071110726
1071210727 @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting
1071310728 @section ASCII/Latin-1/UTF-8 export
1283512850 Export to an Org file, then open it.
1283612851 @end table
1283712852
12838 @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
1283913171 @section iCalendar export
1284013172 @cindex iCalendar export
1284113173
1291313245
1291413246 @itemize
1291513247 @item @file{ox-man.el}: export to a man page.
12916 @item @file{ox-texinfo.el}: export to @code{Texinfo} format.
1291713248 @end itemize
1291813249
1291913250 To activate these export back-end, customize @code{org-export-backends} or
12920 load them directly with e.g., @code{(require 'ox-texinfo)}. This will add
12921 new keys in the export dispatcher (@pxref{The Export Dispatcher}).
13251 load them directly with e.g., @code{(require 'ox-man)}. This will add new
13252 keys in the export dispatcher (@pxref{The Export Dispatcher}).
1292213253
1292313254 See the comment section of these files for more information on how to use
1292413255 them.
doc/orgcard.pdf less more
Binary diff not shown
doc/orgcard_letter.pdf less more
Binary diff not shown
doc/orgguide.pdf less more
Binary diff not shown
+9
-10
doc/orgguide.texi less more
4444 Permission is granted to copy, distribute and/or modify this document
4545 under the terms of the GNU Free Documentation License, Version 1.3 or
4646 any later version published by the Free Software Foundation; with no
47 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
47 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
4848 and with the Back-Cover Texts as in (a) below. A copy of the license
4949 is included in the section entitled ``GNU Free Documentation License.''
5050
15161516 HH:MM}.
15171517 @item C-c C-x C-e
15181518 Update the effort estimate for the current clock task.
1519 @item C-c C-x C-x
1519 @item C-c C-x C-q
15201520 Cancel the current clock. This is useful if a clock was started by
15211521 mistake, or if you ended up working on something else.
15221522 @item C-c C-x C-j
23332333 @node Export options, The export dispatcher, Exporting, Exporting
23342334 @section Export options
23352335
2336 The exporter recognizes special lines in the buffer which provide
2337 additional information. These lines may be put anywhere in the file.
2338 The whole set of lines can be inserted into the buffer with @kbd{C-c
2339 C-e t}.
2340
2341 @table @kbd
2342 @item C-c C-e t
2336 The exporter recognizes special lines in the buffer which provide additional
2337 information. These lines may be put anywhere in the file. The whole set of
2338 lines can be inserted into the buffer with @kbd{C-c C-e #}.
2339
2340 @table @kbd
2341 @item C-c C-e #
23432342 Insert template with export options, see example below.
23442343 @end table
23452344
23502349 #+EMAIL: his/her email address (default from @code{user-mail-address})
23512350 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
23522351 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
2353 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
2352 #+LANGUAGE: language, e.g.@: @samp{en} (@code{org-export-default-language})
23542353 #+OPTIONS: H:2 num:t toc:t \n:nil ::t |:t ^:t f:t tex:t ...
23552354 @end smallexample
23562355
+8
-8
mk/org-fixup.el less more
5757 \f\n;; Local Variables:\n;; version-control: never
5858 ;; no-byte-compile: t
5959 ;; coding: utf-8\n;; End:\n;;; org-version.el ends here\n")
60 (toggle-read-only 0)
61 (write-file "org-version.el")))
60 (let ((inhibit-read-only t))
61 (write-file "org-version.el"))))
6262
6363 (defun org-make-org-loaddefs ()
6464 "Make the file org-loaddefs.el in the current directory.
7676 (insert "\f\n;; Local Variables:\n;; version-control: never\n")
7777 (insert ";; no-byte-compile: t\n;; no-update-autoloads: t\n")
7878 (insert ";; coding: utf-8\n;; End:\n;;; org-loaddefs.el ends here\n")
79 (toggle-read-only 0)
80 (save-buffer)))
79 (let ((inhibit-read-only t))
80 (save-buffer))))
8181
8282 (defun org-make-autoloads (&optional compile force)
8383 "Make the files org-loaddefs.el and org-version.el in the install directory.
139139 (insert "\
140140 # See default.mk for further configuration options.
141141 ")
142 (toggle-read-only 0)
143 (write-file local))
142 (let ((inhibit-read-only t))
143 (write-file local)))
144144 nil)))
145145
146146 (defun org-make-letterformat (a4name lettername)
151151 (goto-char (point-min))
152152 (while (search-forward "\\pdflayout=(0l)" nil t)
153153 (replace-match "\\pdflayout=(1l)" nil t))
154 (toggle-read-only 0)
155 (write-file lettername))
154 (let ((inhibit-read-only t))
155 (write-file lettername)))
156156 nil))
157157
158158 ;; redefine version functions
+2
-2
mk/version.mk less more
0 ORGVERSION ?= 8.2.7c
1 GITVERSION ?= 8.2.7c-dist
0 ORGVERSION ?= 8.2.10
1 GITVERSION ?= 8.2.10-dist