diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 47 | ||||
| -rw-r--r-- | doc/misc/org.texi | 620 |
2 files changed, 518 insertions, 149 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index d34748cd443..e9aa87e8d50 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,50 @@ | |||
| 1 | 2010-04-15 Carsten Dominik <carsten.dominik@gmail.com> | ||
| 2 | |||
| 3 | * org.texi (LaTeX and PDF export): Add a footnote about xetex. | ||
| 4 | (LaTeX/PDF export commands): Section renamed and | ||
| 5 | moved. | ||
| 6 | (Sectioning structure): Update. | ||
| 7 | (References): New use case for field coordinates. | ||
| 8 | (The export dispatcher): Renamed from ASCII export. | ||
| 9 | (Setting up the staging area): Document the availability of | ||
| 10 | encryption for MobileOrg. | ||
| 11 | (Images and tables): Document how to reference labels. | ||
| 12 | (Index entries): New section. | ||
| 13 | (Generating an index): New section. | ||
| 14 | (Column width and alignment): Document that <N> now | ||
| 15 | means a fixed width, not a maximum width. | ||
| 16 | (Publishing options): Document the :email option. | ||
| 17 | (Beamer class export): Fix bug in the BEAMER example. | ||
| 18 | (Refiling notes): Document refile logging. | ||
| 19 | (In-buffer settings): Document refile logging keywords. | ||
| 20 | (Drawers): Document `C-c C-z' command. | ||
| 21 | (Agenda commands): Mention the alternative key `C-c C-z'. | ||
| 22 | (Special properties): Document the BLOCKED property. | ||
| 23 | (The spreadsheet): Mention the formula editor. | ||
| 24 | (References): Document field coordinates. | ||
| 25 | (Publishing action): Correct the documentation for the | ||
| 26 | publishing function. | ||
| 27 | (The date/time prompt): Document that we accept dates | ||
| 28 | like month/day/year. | ||
| 29 | (Cooperation): Document the changes in table.el support. | ||
| 30 | (Faces for TODO keywords, Faces for TODO keywords) | ||
| 31 | (Priorities): Document the easy colors. | ||
| 32 | (Visibility cycling): Document the new double prefix | ||
| 33 | arg for `org-reveal'. | ||
| 34 | (Cooperation): Remember.el is part of Emacs. | ||
| 35 | (Clean view): Mention that `wrap-prefix' is also set by | ||
| 36 | org-indent-mode. | ||
| 37 | (Agenda commands): Add information about prefix args to | ||
| 38 | scheduling and deadline commands. | ||
| 39 | (Search view): Point to the docstring of | ||
| 40 | `org-search-view' for more details. | ||
| 41 | (Agenda commands): Document that `>' prompts for a | ||
| 42 | date. | ||
| 43 | (Setting tags): Document variable | ||
| 44 | org-complete-tags-always-offer-all-agenda-tags. | ||
| 45 | (Column attributes): Cross-reference special | ||
| 46 | properties. | ||
| 47 | |||
| 1 | 2010-04-10 Michael Albinus <michael.albinus@gmx.de> | 48 | 2010-04-10 Michael Albinus <michael.albinus@gmx.de> |
| 2 | 49 | ||
| 3 | Synchronize with Tramp repository. | 50 | Synchronize with Tramp repository. |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 507dfad5c31..00474f6d708 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -3,8 +3,8 @@ | |||
| 3 | @setfilename ../../info/org | 3 | @setfilename ../../info/org |
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | 5 | ||
| 6 | @set VERSION 6.33x | 6 | @set VERSION 6.35i |
| 7 | @set DATE November 2009 | 7 | @set DATE April 2010 |
| 8 | 8 | ||
| 9 | @c Version and Contact Info | 9 | @c Version and Contact Info |
| 10 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage} | 10 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage} |
| @@ -45,7 +45,7 @@ e.g., | |||
| 45 | @copying | 45 | @copying |
| 46 | This manual is for Org version @value{VERSION}. | 46 | This manual is for Org version @value{VERSION}. |
| 47 | 47 | ||
| 48 | Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation | 48 | Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation |
| 49 | 49 | ||
| 50 | @quotation | 50 | @quotation |
| 51 | Permission is granted to copy, distribute and/or modify this document | 51 | Permission is granted to copy, distribute and/or modify this document |
| @@ -304,6 +304,7 @@ Markup for rich export | |||
| 304 | * Images and tables:: Tables and Images will be included | 304 | * Images and tables:: Tables and Images will be included |
| 305 | * Literal examples:: Source code examples with special formatting | 305 | * Literal examples:: Source code examples with special formatting |
| 306 | * Include files:: Include additional files into a document | 306 | * Include files:: Include additional files into a document |
| 307 | * Index entries:: | ||
| 307 | * Macro replacement:: Use macros to create complex output | 308 | * Macro replacement:: Use macros to create complex output |
| 308 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents | 309 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents |
| 309 | 310 | ||
| @@ -333,7 +334,7 @@ Exporting | |||
| 333 | * Selective export:: Using tags to select and exclude trees | 334 | * Selective export:: Using tags to select and exclude trees |
| 334 | * Export options:: Per-file export settings | 335 | * Export options:: Per-file export settings |
| 335 | * The export dispatcher:: How to access exporter commands | 336 | * The export dispatcher:: How to access exporter commands |
| 336 | * ASCII export:: Exporting to plain ASCII | 337 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding |
| 337 | * HTML export:: Exporting to HTML | 338 | * HTML export:: Exporting to HTML |
| 338 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF | 339 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF |
| 339 | * DocBook export:: Exporting to DocBook | 340 | * DocBook export:: Exporting to DocBook |
| @@ -355,10 +356,11 @@ HTML export | |||
| 355 | La@TeX{} and PDF export | 356 | La@TeX{} and PDF export |
| 356 | 357 | ||
| 357 | * LaTeX/PDF export commands:: Which key invokes which commands | 358 | * LaTeX/PDF export commands:: Which key invokes which commands |
| 359 | * Header and sectioning:: Setting up the export file structure | ||
| 358 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code | 360 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code |
| 359 | * Sectioning structure:: Changing sectioning in La@TeX{} output | ||
| 360 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} | 361 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} |
| 361 | * Images in LaTeX export:: How to insert figures into La@TeX{} output | 362 | * Images in LaTeX export:: How to insert figures into La@TeX{} output |
| 363 | * Beamer class export:: Turning the file into a presentation | ||
| 362 | 364 | ||
| 363 | DocBook export | 365 | DocBook export |
| 364 | 366 | ||
| @@ -384,7 +386,8 @@ Configuration | |||
| 384 | * Publishing action:: Setting the function doing the publishing | 386 | * Publishing action:: Setting the function doing the publishing |
| 385 | * Publishing options:: Tweaking HTML export | 387 | * Publishing options:: Tweaking HTML export |
| 386 | * Publishing links:: Which links keep working after publishing? | 388 | * Publishing links:: Which links keep working after publishing? |
| 387 | * Project page index:: Publishing a list of project files | 389 | * Sitemap:: Generating a list of all pages |
| 390 | * Generating an index:: An index that reaches across pages | ||
| 388 | 391 | ||
| 389 | Sample configuration | 392 | Sample configuration |
| 390 | 393 | ||
| @@ -876,7 +879,8 @@ Reveal context around point, showing the current entry, the following heading | |||
| 876 | and the hierarchy above. Useful for working near a location that has been | 879 | and the hierarchy above. Useful for working near a location that has been |
| 877 | exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command | 880 | exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command |
| 878 | (@pxref{Agenda commands}). With a prefix argument show, on each | 881 | (@pxref{Agenda commands}). With a prefix argument show, on each |
| 879 | level, all sibling headings. | 882 | level, all sibling headings. With double prefix arg, also show the entire |
| 883 | subtree of the parent. | ||
| 880 | @kindex C-c C-x b | 884 | @kindex C-c C-x b |
| 881 | @item C-c C-x b | 885 | @item C-c C-x b |
| 882 | Show the current subtree in an indirect buffer@footnote{The indirect | 886 | Show the current subtree in an indirect buffer@footnote{The indirect |
| @@ -1388,7 +1392,15 @@ look inside the drawer, you need to move the cursor to the drawer line and | |||
| 1388 | press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for | 1392 | press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for |
| 1389 | storing properties (@pxref{Properties and Columns}), and you can also arrange | 1393 | storing properties (@pxref{Properties and Columns}), and you can also arrange |
| 1390 | for state change notes (@pxref{Tracking TODO state changes}) and clock times | 1394 | for state change notes (@pxref{Tracking TODO state changes}) and clock times |
| 1391 | (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. | 1395 | (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you |
| 1396 | want to store a quick note in the LOGBOOK drawer, in a similar way as this is | ||
| 1397 | done by state changes, use | ||
| 1398 | |||
| 1399 | @table @kbd | ||
| 1400 | @kindex C-c C-z | ||
| 1401 | @item C-c C-z | ||
| 1402 | Add a time-stamped note to the LOGBOOK drawer. | ||
| 1403 | @end table | ||
| 1392 | 1404 | ||
| 1393 | @node Blocks, Footnotes, Drawers, Document Structure | 1405 | @node Blocks, Footnotes, Drawers, Document Structure |
| 1394 | @section Blocks | 1406 | @section Blocks |
| @@ -1815,13 +1827,13 @@ The width of columns is automatically determined by the table editor. And | |||
| 1815 | also the alignment of a column is determined automatically from the fraction | 1827 | also the alignment of a column is determined automatically from the fraction |
| 1816 | of number-like versus non-number fields in the column. | 1828 | of number-like versus non-number fields in the column. |
| 1817 | 1829 | ||
| 1818 | Sometimes a single field or a few fields need to carry more text, | 1830 | Sometimes a single field or a few fields need to carry more text, leading to |
| 1819 | leading to inconveniently wide columns. To limit@footnote{This feature | 1831 | inconveniently wide columns. Or maybe you want to make a table with several |
| 1820 | does not work on XEmacs.} the width of a column, one field anywhere in | 1832 | columns having a fixed width, regardless of content. To set@footnote{This |
| 1821 | the column may contain just the string @samp{<N>} where @samp{N} is an | 1833 | feature does not work on XEmacs.} the width of a column, one field anywhere |
| 1822 | integer specifying the width of the column in characters. The next | 1834 | in the column may contain just the string @samp{<N>} where @samp{N} is an |
| 1823 | re-align will then set the width of this column to no more than this | 1835 | integer specifying the width of the column in characters. The next re-align |
| 1824 | value. | 1836 | will then set the width of this column to this value. |
| 1825 | 1837 | ||
| 1826 | @example | 1838 | @example |
| 1827 | @group | 1839 | @group |
| @@ -1926,11 +1938,13 @@ Orgtbl mode, including spreadsheet capabilities. For details, see | |||
| 1926 | 1938 | ||
| 1927 | The table editor makes use of the Emacs @file{calc} package to implement | 1939 | The table editor makes use of the Emacs @file{calc} package to implement |
| 1928 | spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to | 1940 | spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to |
| 1929 | derive fields from other fields. While fully featured, Org's | 1941 | derive fields from other fields. While fully featured, Org's implementation |
| 1930 | implementation is not identical to other spreadsheets. For example, | 1942 | is not identical to other spreadsheets. For example, Org knows the concept |
| 1931 | Org knows the concept of a @emph{column formula} that will be | 1943 | of a @emph{column formula} that will be applied to all non-header fields in a |
| 1932 | applied to all non-header fields in a column without having to copy the | 1944 | column without having to copy the formula to each relevant field. There is |
| 1933 | formula to each relevant field. | 1945 | also a formula debugger, and a formula editor with features for highlighting |
| 1946 | fields in the table corresponding to the references at the point in the | ||
| 1947 | formula, moving these references by arrow keys | ||
| 1934 | 1948 | ||
| 1935 | @menu | 1949 | @menu |
| 1936 | * References:: How to refer to another field or range | 1950 | * References:: How to refer to another field or range |
| @@ -2038,6 +2052,28 @@ suppressed, so that the vector contains only the non-empty fields (but | |||
| 2038 | see the @samp{E} mode switch below). If there are no non-empty fields, | 2052 | see the @samp{E} mode switch below). If there are no non-empty fields, |
| 2039 | @samp{[0]} is returned to avoid syntax errors in formulas. | 2053 | @samp{[0]} is returned to avoid syntax errors in formulas. |
| 2040 | 2054 | ||
| 2055 | @subsubheading Field coordinates in formulas | ||
| 2056 | @cindex field coordinates | ||
| 2057 | @cindex coordinates, of field | ||
| 2058 | @cindex row, of field coordinates | ||
| 2059 | @cindex column, of field coordinates | ||
| 2060 | |||
| 2061 | For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to | ||
| 2062 | get the row or column number of the field where the formula result goes. | ||
| 2063 | The traditional Lisp formula equivalents are @code{org-table-current-dline} | ||
| 2064 | and @code{org-table-current-column}. Examples: | ||
| 2065 | |||
| 2066 | @example | ||
| 2067 | if(@@# % 2, $#, string("")) @r{column number on odd lines only} | ||
| 2068 | $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into} | ||
| 2069 | @r{column 3 of the current table} | ||
| 2070 | @end example | ||
| 2071 | |||
| 2072 | @noindent For the second example, table FOO must have at least as many rows | ||
| 2073 | as the current table. Inefficient@footnote{The computation time scales as | ||
| 2074 | O(N^2) because table FOO is parsed for each field to be copied.} for large | ||
| 2075 | number of rows. | ||
| 2076 | |||
| 2041 | @subsubheading Named references | 2077 | @subsubheading Named references |
| 2042 | @cindex named references | 2078 | @cindex named references |
| 2043 | @cindex references, named | 2079 | @cindex references, named |
| @@ -2127,8 +2163,11 @@ compact. The default settings can be configured using the variable | |||
| 2127 | @code{org-calc-default-modes}. | 2163 | @code{org-calc-default-modes}. |
| 2128 | 2164 | ||
| 2129 | @example | 2165 | @example |
| 2130 | p20 @r{switch the internal precision to 20 digits} | 2166 | p20 @r{set the internal Calc calculation precision to 20 digits} |
| 2131 | n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} | 2167 | n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed} |
| 2168 | @r{format of the result of Calc passed back to Org.} | ||
| 2169 | @r{Calc formatting is unlimited in precision as} | ||
| 2170 | @r{long as the Calc calculation precision is greater.} | ||
| 2132 | D R @r{angle modes: degrees, radians} | 2171 | D R @r{angle modes: degrees, radians} |
| 2133 | F S @r{fraction and symbolic modes} | 2172 | F S @r{fraction and symbolic modes} |
| 2134 | N @r{interpret all fields as numbers, use 0 for non-numbers} | 2173 | N @r{interpret all fields as numbers, use 0 for non-numbers} |
| @@ -2138,8 +2177,16 @@ L @r{literal} | |||
| 2138 | @end example | 2177 | @end example |
| 2139 | 2178 | ||
| 2140 | @noindent | 2179 | @noindent |
| 2141 | In addition, you may provide a @code{printf} format specifier to | 2180 | Unless you use large integer numbers or high-precision-calculation |
| 2142 | reformat the final result. A few examples: | 2181 | and -display for floating point numbers you may alternatively provide a |
| 2182 | @code{printf} format specifier to reformat the Calc result after it has been | ||
| 2183 | passed back to Org instead of letting Calc already do the | ||
| 2184 | formatting@footnote{The @code{printf} reformatting is limited in precision | ||
| 2185 | because the value passed to it is converted into an @code{integer} or | ||
| 2186 | @code{double}. The @code{integer} is limited in size by truncating the | ||
| 2187 | signed value to 32 bits. The @code{double} is limited in precision to 64 | ||
| 2188 | bits overall which leaves approximately 16 significant decimal digits.}. | ||
| 2189 | A few examples: | ||
| 2143 | 2190 | ||
| 2144 | @example | 2191 | @example |
| 2145 | $1+$2 @r{Sum of first and second field} | 2192 | $1+$2 @r{Sum of first and second field} |
| @@ -2756,10 +2803,13 @@ file:/home/dominik/images/jupiter.jpg @r{file, absolute path} | |||
| 2756 | /home/dominik/images/jupiter.jpg @r{same as above} | 2803 | /home/dominik/images/jupiter.jpg @r{same as above} |
| 2757 | file:papers/last.pdf @r{file, relative path} | 2804 | file:papers/last.pdf @r{file, relative path} |
| 2758 | ./papers/last.pdf @r{same as above} | 2805 | ./papers/last.pdf @r{same as above} |
| 2806 | file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine} | ||
| 2807 | /myself@@some.where:papers/last.pdf @r{same as above} | ||
| 2759 | file:sometextfile::NNN @r{file with line number to jump to} | 2808 | file:sometextfile::NNN @r{file with line number to jump to} |
| 2760 | file:projects.org @r{another Org file} | 2809 | file:projects.org @r{another Org file} |
| 2761 | file:projects.org::some words @r{text search in Org file} | 2810 | file:projects.org::some words @r{text search in Org file} |
| 2762 | file:projects.org::*task title @r{heading search in Org file} | 2811 | file:projects.org::*task title @r{heading search in Org file} |
| 2812 | docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN} | ||
| 2763 | id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} | 2813 | id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} |
| 2764 | news:comp.emacs @r{Usenet link} | 2814 | news:comp.emacs @r{Usenet link} |
| 2765 | mailto:adent@@galaxy.net @r{Mail link} | 2815 | mailto:adent@@galaxy.net @r{Mail link} |
| @@ -3075,6 +3125,7 @@ link, together with an explanation: | |||
| 3075 | [[file:~/code/main.c::255]] | 3125 | [[file:~/code/main.c::255]] |
| 3076 | [[file:~/xx.org::My Target]] | 3126 | [[file:~/xx.org::My Target]] |
| 3077 | [[file:~/xx.org::*My Target]] | 3127 | [[file:~/xx.org::*My Target]] |
| 3128 | [[file:~/xx.org::#my-custom-id]] | ||
| 3078 | [[file:~/xx.org::/regexp/]] | 3129 | [[file:~/xx.org::/regexp/]] |
| 3079 | @end example | 3130 | @end example |
| 3080 | 3131 | ||
| @@ -3089,6 +3140,8 @@ link will become an HTML reference to the corresponding named anchor in | |||
| 3089 | the linked file. | 3140 | the linked file. |
| 3090 | @item *My Target | 3141 | @item *My Target |
| 3091 | In an Org file, restrict search to headlines. | 3142 | In an Org file, restrict search to headlines. |
| 3143 | @item #my-custom-id | ||
| 3144 | Link to a heading with a @code{CUSTOM_ID} property | ||
| 3092 | @item /regexp/ | 3145 | @item /regexp/ |
| 3093 | Do a regular expression search for @code{regexp}. This uses the Emacs | 3146 | Do a regular expression search for @code{regexp}. This uses the Emacs |
| 3094 | command @code{occur} to list all matches in a separate window. If the | 3147 | command @code{occur} to list all matches in a separate window. If the |
| @@ -3451,15 +3504,16 @@ special faces for some of them. This can be done using the variable | |||
| 3451 | @lisp | 3504 | @lisp |
| 3452 | @group | 3505 | @group |
| 3453 | (setq org-todo-keyword-faces | 3506 | (setq org-todo-keyword-faces |
| 3454 | '(("TODO" . org-warning) | 3507 | '(("TODO" . org-warning) ("STARTED" . "yellow") |
| 3455 | ("DEFERRED" . shadow) | 3508 | ("CANCELED" . (:foreground "blue" :weight bold)))) |
| 3456 | ("CANCELED" . (:foreground "blue" :weight bold)))) | ||
| 3457 | @end group | 3509 | @end group |
| 3458 | @end lisp | 3510 | @end lisp |
| 3459 | 3511 | ||
| 3460 | While using a list with face properties as shown for CANCELED | 3512 | While using a list with face properties as shown for CANCELED @emph{should} |
| 3461 | @emph{should} work, this does not aways seem to be the case. If | 3513 | work, this does not aways seem to be the case. If necessary, define a |
| 3462 | necessary, define a special face and use that. | 3514 | special face and use that. A string is interpreted as a color. The variable |
| 3515 | @code{org-faces-easy-properties} determines if that color is interpreted as a | ||
| 3516 | foreground or a background color. | ||
| 3463 | 3517 | ||
| 3464 | @node TODO dependencies, , Faces for TODO keywords, TODO extensions | 3518 | @node TODO dependencies, , Faces for TODO keywords, TODO extensions |
| 3465 | @subsection TODO dependencies | 3519 | @subsection TODO dependencies |
| @@ -3764,11 +3818,13 @@ this | |||
| 3764 | @end example | 3818 | @end example |
| 3765 | 3819 | ||
| 3766 | @noindent | 3820 | @noindent |
| 3821 | @vindex org-priority-faces | ||
| 3767 | By default, Org mode supports three priorities: @samp{A}, @samp{B}, and | 3822 | By default, Org mode supports three priorities: @samp{A}, @samp{B}, and |
| 3768 | @samp{C}. @samp{A} is the highest priority. An entry without a cookie | 3823 | @samp{C}. @samp{A} is the highest priority. An entry without a cookie is |
| 3769 | is treated as priority @samp{B}. Priorities make a difference only in | 3824 | treated as priority @samp{B}. Priorities make a difference only in the |
| 3770 | the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have | 3825 | agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have no |
| 3771 | no inherent meaning to Org mode. | 3826 | inherent meaning to Org mode. The cookies can be highlighted with special |
| 3827 | faces by customizing the variable @code{org-priority-faces}. | ||
| 3772 | 3828 | ||
| 3773 | Priorities can be attached to any outline tree entries; they do not need | 3829 | Priorities can be attached to any outline tree entries; they do not need |
| 3774 | to be TODO items. | 3830 | to be TODO items. |
| @@ -4233,6 +4289,26 @@ C-c}). If you set the variable to the value @code{expert}, the special | |||
| 4233 | window is not even shown for single-key tag selection, it comes up only | 4289 | window is not even shown for single-key tag selection, it comes up only |
| 4234 | when you press an extra @kbd{C-c}. | 4290 | when you press an extra @kbd{C-c}. |
| 4235 | 4291 | ||
| 4292 | @vindex org-complete-tags-always-offer-all-agenda-tags | ||
| 4293 | As said before, when setting tags and @code{org-tag-alist} is nil, then the | ||
| 4294 | list of tags in the current buffer is used. Normally, this behavior is very | ||
| 4295 | convenient, except in org remember buffers (@pxref{Remember}), because there | ||
| 4296 | are no tags that can be calculated dynamically. Here, you most probably want | ||
| 4297 | to have completion for all tags in all agenda files. This can be done by | ||
| 4298 | setting @code{org-complete-tags-always-offer-all-agenda-tags} to non-nil in | ||
| 4299 | those buffers. | ||
| 4300 | |||
| 4301 | @lisp | ||
| 4302 | (add-hook 'org-remember-mode-hook | ||
| 4303 | (lambda () | ||
| 4304 | (set (make-local-variable | ||
| 4305 | 'org-complete-tags-always-offer-all-agenda-tags) | ||
| 4306 | t))) | ||
| 4307 | @end lisp | ||
| 4308 | |||
| 4309 | Of course, you can also set it to @code{t} globally if you always want to | ||
| 4310 | have completion of all tags in all agenda files. | ||
| 4311 | |||
| 4236 | @node Tag searches, , Setting tags, Tags | 4312 | @node Tag searches, , Setting tags, Tags |
| 4237 | @section Tag searches | 4313 | @section Tag searches |
| 4238 | @cindex tag searches | 4314 | @cindex tag searches |
| @@ -4407,6 +4483,7 @@ used as keys in the properties drawer: | |||
| 4407 | @cindex property, special, TIMESTAMP | 4483 | @cindex property, special, TIMESTAMP |
| 4408 | @cindex property, special, TIMESTAMP_IA | 4484 | @cindex property, special, TIMESTAMP_IA |
| 4409 | @cindex property, special, CLOCKSUM | 4485 | @cindex property, special, CLOCKSUM |
| 4486 | @cindex property, special, BLOCKED | ||
| 4410 | @c guessing that ITEM is needed in this area; also, should this list be sorted? | 4487 | @c guessing that ITEM is needed in this area; also, should this list be sorted? |
| 4411 | @cindex property, special, ITEM | 4488 | @cindex property, special, ITEM |
| 4412 | @example | 4489 | @example |
| @@ -4422,6 +4499,7 @@ TIMESTAMP @r{The first keyword-less timestamp in the entry.} | |||
| 4422 | TIMESTAMP_IA @r{The first inactive timestamp in the entry.} | 4499 | TIMESTAMP_IA @r{The first inactive timestamp in the entry.} |
| 4423 | CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} | 4500 | CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} |
| 4424 | @r{must be run first to compute the values.} | 4501 | @r{must be run first to compute the values.} |
| 4502 | BLOCKED @r{"t" if task is currently blocked by children or siblings} | ||
| 4425 | ITEM @r{The content of the entry.} | 4503 | ITEM @r{The content of the entry.} |
| 4426 | @end example | 4504 | @end example |
| 4427 | 4505 | ||
| @@ -4845,7 +4923,7 @@ is used in a much wider sense. | |||
| 4845 | A timestamp is a specification of a date (possibly with a time or a range of | 4923 | A timestamp is a specification of a date (possibly with a time or a range of |
| 4846 | times) in a special format, either @samp{<2003-09-16 Tue>} or | 4924 | times) in a special format, either @samp{<2003-09-16 Tue>} or |
| 4847 | @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue | 4925 | @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue |
| 4848 | 12:00-12:30>}@footnote{This is inspired by the standard ISO 6801 date/time | 4926 | 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time |
| 4849 | format. To use an alternative format, see @ref{Custom time format}.}. A | 4927 | format. To use an alternative format, see @ref{Custom time format}.}. A |
| 4850 | timestamp can appear anywhere in the headline or body of an Org tree entry. | 4928 | timestamp can appear anywhere in the headline or body of an Org tree entry. |
| 4851 | Its presence causes entries to be shown on specific dates in the agenda | 4929 | Its presence causes entries to be shown on specific dates in the agenda |
| @@ -5020,8 +5098,10 @@ in @b{bold}. | |||
| 5020 | 5098 | ||
| 5021 | @example | 5099 | @example |
| 5022 | 3-2-5 --> 2003-02-05 | 5100 | 3-2-5 --> 2003-02-05 |
| 5101 | 2/5/3 --> 2003-02-05 | ||
| 5023 | 14 --> @b{2006}-@b{06}-14 | 5102 | 14 --> @b{2006}-@b{06}-14 |
| 5024 | 12 --> @b{2006}-@b{07}-12 | 5103 | 12 --> @b{2006}-@b{07}-12 |
| 5104 | 2/5 --> @b{2003}-02-05 | ||
| 5025 | Fri --> nearest Friday (defaultdate or later) | 5105 | Fri --> nearest Friday (defaultdate or later) |
| 5026 | sep 15 --> @b{2006}-09-15 | 5106 | sep 15 --> @b{2006}-09-15 |
| 5027 | feb 15 --> @b{2007}-02-15 | 5107 | feb 15 --> @b{2007}-02-15 |
| @@ -5945,13 +6025,13 @@ now@footnote{To avoid this query, configure the variable | |||
| 5945 | will continue to run after the note was filed away. | 6025 | will continue to run after the note was filed away. |
| 5946 | 6026 | ||
| 5947 | The handler will then store the note in the file and under the headline | 6027 | The handler will then store the note in the file and under the headline |
| 5948 | specified in the template, or it will use the default file and headline. | 6028 | specified in the template, or it will use the default file and headline. The |
| 5949 | The window configuration will be restored, sending you back to the working | 6029 | window configuration will be restored, sending you back to the working |
| 5950 | context before the call to Remember. To re-use the location found | 6030 | context before the call to Remember. To re-use the location found during the |
| 5951 | during the last call to Remember, exit the Remember buffer with | 6031 | last call to Remember, exit the Remember buffer with @kbd{C-0 C-c C-c}, |
| 5952 | @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}. | 6032 | i.e. specify a zero prefix argument to @kbd{C-c C-c}. Another special case |
| 5953 | Another special case is @kbd{C-2 C-c C-c} which files the note as a child of | 6033 | is @kbd{C-2 C-c C-c} which files the note as a child of the currently clocked |
| 5954 | the currently clocked item. | 6034 | item, and @kbd{C-3 C-c C-c} files as a sibling of the currently clocked item. |
| 5955 | 6035 | ||
| 5956 | @vindex org-remember-store-without-prompt | 6036 | @vindex org-remember-store-without-prompt |
| 5957 | If you want to store the note directly to a different place, use | 6037 | If you want to store the note directly to a different place, use |
| @@ -6170,6 +6250,7 @@ process, you can use the following special command: | |||
| 6170 | @vindex org-refile-use-outline-path | 6250 | @vindex org-refile-use-outline-path |
| 6171 | @vindex org-outline-path-complete-in-steps | 6251 | @vindex org-outline-path-complete-in-steps |
| 6172 | @vindex org-refile-allow-creating-parent-nodes | 6252 | @vindex org-refile-allow-creating-parent-nodes |
| 6253 | @vindex org-log-refile | ||
| 6173 | Refile the entry or region at point. This command offers possible locations | 6254 | Refile the entry or region at point. This command offers possible locations |
| 6174 | for refiling the entry and lets you select one with completion. The item (or | 6255 | for refiling the entry and lets you select one with completion. The item (or |
| 6175 | all items in the region) is filed below the target heading as a subitem. | 6256 | all items in the region) is filed below the target heading as a subitem. |
| @@ -6183,6 +6264,10 @@ the variables @code{org-refile-use-outline-path} and | |||
| 6183 | @code{org-outline-path-complete-in-steps}. If you would like to be able to | 6264 | @code{org-outline-path-complete-in-steps}. If you would like to be able to |
| 6184 | create new nodes as new parents for refiling on the fly, check the | 6265 | create new nodes as new parents for refiling on the fly, check the |
| 6185 | variable @code{org-refile-allow-creating-parent-nodes}. | 6266 | variable @code{org-refile-allow-creating-parent-nodes}. |
| 6267 | When the variable @code{org-log-refile}@footnote{with corresponding | ||
| 6268 | @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile}, | ||
| 6269 | and @code{nologrefile}} is set, a time stamp or a note will be | ||
| 6270 | recorded when an entry has been refiled. | ||
| 6186 | @kindex C-u C-c C-w | 6271 | @kindex C-u C-c C-w |
| 6187 | @item C-u C-c C-w | 6272 | @item C-u C-c C-w |
| 6188 | Use the refile interface to jump to a heading. | 6273 | Use the refile interface to jump to a heading. |
| @@ -6618,8 +6703,8 @@ will be made in the agenda: | |||
| 6618 | #+CATEGORY: Holiday | 6703 | #+CATEGORY: Holiday |
| 6619 | %%(org-calendar-holiday) ; special function for holiday names | 6704 | %%(org-calendar-holiday) ; special function for holiday names |
| 6620 | #+CATEGORY: Ann | 6705 | #+CATEGORY: Ann |
| 6621 | %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old | 6706 | %%(diary-anniversary 5 14 1956)@footnote{Note that the order of the arguments (month, day, year) depends on the setting of @code{calendar-date-style}.} Arthur Dent is %d years old |
| 6622 | %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old | 6707 | %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old |
| 6623 | @end example | 6708 | @end example |
| 6624 | 6709 | ||
| 6625 | @subsubheading Anniversaries from BBDB | 6710 | @subsubheading Anniversaries from BBDB |
| @@ -6936,7 +7021,9 @@ logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}} | |||
| 6936 | will search for note entries that contain the keywords @code{computer} | 7021 | will search for note entries that contain the keywords @code{computer} |
| 6937 | and @code{wifi}, but not the keyword @code{ethernet}, and which are also | 7022 | and @code{wifi}, but not the keyword @code{ethernet}, and which are also |
| 6938 | not matched by the regular expression @code{8\.11[bg]}, meaning to | 7023 | not matched by the regular expression @code{8\.11[bg]}, meaning to |
| 6939 | exclude both 8.11b and 8.11g. | 7024 | exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on |
| 7025 | word search, other @samp{+} characters are optional. For more details, see | ||
| 7026 | the docstring of the command @code{org-search-view}. | ||
| 6940 | 7027 | ||
| 6941 | @vindex org-agenda-text-search-extra-files | 7028 | @vindex org-agenda-text-search-extra-files |
| 6942 | Note that in addition to the agenda files, this command will also search | 7029 | Note that in addition to the agenda files, this command will also search |
| @@ -7245,6 +7332,7 @@ Prompt for a date and go there. | |||
| 7245 | Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. | 7332 | Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
| 7246 | @c | 7333 | @c |
| 7247 | @kindex v l | 7334 | @kindex v l |
| 7335 | @kindex v L | ||
| 7248 | @kindex l | 7336 | @kindex l |
| 7249 | @item v l @ @r{or short} @ l | 7337 | @item v l @ @r{or short} @ l |
| 7250 | @vindex org-log-done | 7338 | @vindex org-log-done |
| @@ -7256,6 +7344,7 @@ types that should be included in log mode using the variable | |||
| 7256 | @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show | 7344 | @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show |
| 7257 | all possible logbook entries, including state changes. When called with two | 7345 | all possible logbook entries, including state changes. When called with two |
| 7258 | prefix args @kbd{C-u C-u}, show only logging information, nothing else. | 7346 | prefix args @kbd{C-u C-u}, show only logging information, nothing else. |
| 7347 | @kbd{v L} is equivalent to @kbd{C-u v l}. | ||
| 7259 | @c | 7348 | @c |
| 7260 | @kindex v [ | 7349 | @kindex v [ |
| 7261 | @kindex [ | 7350 | @kindex [ |
| @@ -7523,8 +7612,9 @@ key for this. | |||
| 7523 | @itemx S-@key{down} | 7612 | @itemx S-@key{down} |
| 7524 | Decrease the priority of the current item. | 7613 | Decrease the priority of the current item. |
| 7525 | @c | 7614 | @c |
| 7615 | @kindex C-c C-z | ||
| 7526 | @kindex z | 7616 | @kindex z |
| 7527 | @item z | 7617 | @item z @ @r{or also} @ C-c C-z |
| 7528 | @vindex org-log-into-drawer | 7618 | @vindex org-log-into-drawer |
| 7529 | Add a note to the entry. This note will be recorded, and then files to the | 7619 | Add a note to the entry. This note will be recorded, and then files to the |
| 7530 | same location where state change notes are put. Depending on | 7620 | same location where state change notes are put. Depending on |
| @@ -7536,11 +7626,11 @@ Dispatcher for all command related to attachments. | |||
| 7536 | @c | 7626 | @c |
| 7537 | @kindex C-c C-s | 7627 | @kindex C-c C-s |
| 7538 | @item C-c C-s | 7628 | @item C-c C-s |
| 7539 | Schedule this item | 7629 | Schedule this item, with prefix arg remove the scheduling timestamp |
| 7540 | @c | 7630 | @c |
| 7541 | @kindex C-c C-d | 7631 | @kindex C-c C-d |
| 7542 | @item C-c C-d | 7632 | @item C-c C-d |
| 7543 | Set a deadline for this item. | 7633 | Set a deadline for this item, with prefix arg remove the deadline. |
| 7544 | @c | 7634 | @c |
| 7545 | @kindex k | 7635 | @kindex k |
| 7546 | @item k | 7636 | @item k |
| @@ -7576,9 +7666,8 @@ into the past. | |||
| 7576 | @c | 7666 | @c |
| 7577 | @kindex > | 7667 | @kindex > |
| 7578 | @item > | 7668 | @item > |
| 7579 | Change the timestamp associated with the current line to today. | 7669 | Change the timestamp associated with the current line. The key @kbd{>} has |
| 7580 | The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | 7670 | been chosen, because it is the same as @kbd{S-.} on my keyboard. |
| 7581 | on my keyboard. | ||
| 7582 | @c | 7671 | @c |
| 7583 | @kindex I | 7672 | @kindex I |
| 7584 | @item I | 7673 | @item I |
| @@ -7601,7 +7690,7 @@ Jump to the running clock in another window. | |||
| 7601 | @cindex remote editing, bulk, from agenda | 7690 | @cindex remote editing, bulk, from agenda |
| 7602 | 7691 | ||
| 7603 | @kindex m | 7692 | @kindex m |
| 7604 | @item s | 7693 | @item m |
| 7605 | Mark the entry at point for bulk action. | 7694 | Mark the entry at point for bulk action. |
| 7606 | 7695 | ||
| 7607 | @kindex u | 7696 | @kindex u |
| @@ -7615,7 +7704,9 @@ Unmark all marked entries for bulk action. | |||
| 7615 | @kindex B | 7704 | @kindex B |
| 7616 | @item B | 7705 | @item B |
| 7617 | Bulk action: act on all marked entries in the agenda. This will prompt for | 7706 | Bulk action: act on all marked entries in the agenda. This will prompt for |
| 7618 | another key to select the action to be applied: | 7707 | another key to select the action to be applied. The prefix arg to @kbd{B} |
| 7708 | will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove | ||
| 7709 | these special timestamps. | ||
| 7619 | @example | 7710 | @example |
| 7620 | r @r{Prompt for a single refile target and move all entries. The entries} | 7711 | r @r{Prompt for a single refile target and move all entries. The entries} |
| 7621 | @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.} | 7712 | @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.} |
| @@ -8117,6 +8208,7 @@ summarizes the markup rules used in an Org-mode buffer. | |||
| 8117 | * Images and tables:: Tables and Images will be included | 8208 | * Images and tables:: Tables and Images will be included |
| 8118 | * Literal examples:: Source code examples with special formatting | 8209 | * Literal examples:: Source code examples with special formatting |
| 8119 | * Include files:: Include additional files into a document | 8210 | * Include files:: Include additional files into a document |
| 8211 | * Index entries:: | ||
| 8120 | * Macro replacement:: Use macros to create complex output | 8212 | * Macro replacement:: Use macros to create complex output |
| 8121 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents | 8213 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents |
| 8122 | @end menu | 8214 | @end menu |
| @@ -8333,7 +8425,8 @@ Both the native Org mode tables (@pxref{Tables}) and tables formatted with | |||
| 8333 | the @file{table.el} package will be exported properly. For Org mode tables, | 8425 | the @file{table.el} package will be exported properly. For Org mode tables, |
| 8334 | the lines before the first horizontal separator line will become table header | 8426 | the lines before the first horizontal separator line will become table header |
| 8335 | lines. You can use the following lines somewhere before the table to assign | 8427 | lines. You can use the following lines somewhere before the table to assign |
| 8336 | a caption and a label for cross references: | 8428 | a caption and a label for cross references, and in the text you can refer to |
| 8429 | the object with @code{\ref@{tab:basic-data@}}: | ||
| 8337 | 8430 | ||
| 8338 | @example | 8431 | @example |
| 8339 | #+CAPTION: This is the caption for the next table (or link) | 8432 | #+CAPTION: This is the caption for the next table (or link) |
| @@ -8468,7 +8561,7 @@ label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}. | |||
| 8468 | @end table | 8561 | @end table |
| 8469 | 8562 | ||
| 8470 | 8563 | ||
| 8471 | @node Include files, Macro replacement, Literal examples, Markup | 8564 | @node Include files, Index entries, Literal examples, Markup |
| 8472 | @section Include files | 8565 | @section Include files |
| 8473 | @cindex include files, markup rules | 8566 | @cindex include files, markup rules |
| 8474 | 8567 | ||
| @@ -8499,8 +8592,25 @@ the selected markup. For example, to include a file as an item, use | |||
| 8499 | Visit the include file at point. | 8592 | Visit the include file at point. |
| 8500 | @end table | 8593 | @end table |
| 8501 | 8594 | ||
| 8595 | @node Index entries, Macro replacement, Include files, Markup | ||
| 8596 | @section Index enries | ||
| 8597 | @cindex index entries, for publishing | ||
| 8598 | |||
| 8599 | You can specify entries that will be used for generating an index during | ||
| 8600 | publishing. This is done by lines starting with @code{#+INDEX}. An entry | ||
| 8601 | the contains an exclamation mark will create a sub item. See @ref{Generating | ||
| 8602 | an index} for more information. | ||
| 8603 | |||
| 8604 | @example | ||
| 8605 | * Curriculum Vitae | ||
| 8606 | #+INDEX: CV | ||
| 8607 | #+INDEX: Application!CV | ||
| 8608 | @end example | ||
| 8609 | |||
| 8610 | |||
| 8502 | 8611 | ||
| 8503 | @node Macro replacement, Embedded LaTeX, Include files, Markup | 8612 | |
| 8613 | @node Macro replacement, Embedded LaTeX, Index entries, Markup | ||
| 8504 | @section Macro replacement | 8614 | @section Macro replacement |
| 8505 | @cindex macro replacement, during export | 8615 | @cindex macro replacement, during export |
| 8506 | @cindex #+MACRO | 8616 | @cindex #+MACRO |
| @@ -8791,7 +8901,7 @@ enabled (default in Emacs 23). | |||
| 8791 | * Selective export:: Using tags to select and exclude trees | 8901 | * Selective export:: Using tags to select and exclude trees |
| 8792 | * Export options:: Per-file export settings | 8902 | * Export options:: Per-file export settings |
| 8793 | * The export dispatcher:: How to access exporter commands | 8903 | * The export dispatcher:: How to access exporter commands |
| 8794 | * ASCII export:: Exporting to plain ASCII | 8904 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding |
| 8795 | * HTML export:: Exporting to HTML | 8905 | * HTML export:: Exporting to HTML |
| 8796 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF | 8906 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF |
| 8797 | * DocBook export:: Exporting to DocBook | 8907 | * DocBook export:: Exporting to DocBook |
| @@ -8905,7 +9015,7 @@ you can: | |||
| 8905 | H: @r{set the number of headline levels for export} | 9015 | H: @r{set the number of headline levels for export} |
| 8906 | num: @r{turn on/off section-numbers} | 9016 | num: @r{turn on/off section-numbers} |
| 8907 | toc: @r{turn on/off table of contents, or set level limit (integer)} | 9017 | toc: @r{turn on/off table of contents, or set level limit (integer)} |
| 8908 | \n: @r{turn on/off line-break-preservation} | 9018 | \n: @r{turn on/off line-break-preservation (DOES NOT WORK)} |
| 8909 | @@: @r{turn on/off quoted HTML tags} | 9019 | @@: @r{turn on/off quoted HTML tags} |
| 8910 | :: @r{turn on/off fixed-width sections} | 9020 | :: @r{turn on/off fixed-width sections} |
| 8911 | |: @r{turn on/off tables} | 9021 | |: @r{turn on/off tables} |
| @@ -8923,6 +9033,7 @@ TeX: @r{turn on/off simple @TeX{} macros in plain text} | |||
| 8923 | LaTeX: @r{turn on/off La@TeX{} fragments} | 9033 | LaTeX: @r{turn on/off La@TeX{} fragments} |
| 8924 | skip: @r{turn on/off skipping the text before the first heading} | 9034 | skip: @r{turn on/off skipping the text before the first heading} |
| 8925 | author: @r{turn on/off inclusion of author name/email into exported file} | 9035 | author: @r{turn on/off inclusion of author name/email into exported file} |
| 9036 | email: @r{turn on/off inclusion of author email into exported file} | ||
| 8926 | creator: @r{turn on/off inclusion of creator info into exported file} | 9037 | creator: @r{turn on/off inclusion of creator info into exported file} |
| 8927 | timestamp: @r{turn on/off inclusion creation time into exported file} | 9038 | timestamp: @r{turn on/off inclusion creation time into exported file} |
| 8928 | d: @r{turn on/off inclusion of drawers} | 9039 | d: @r{turn on/off inclusion of drawers} |
| @@ -8938,7 +9049,7 @@ settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE}, | |||
| 8938 | @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and | 9049 | @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and |
| 8939 | @code{EXPORT_OPTIONS}. | 9050 | @code{EXPORT_OPTIONS}. |
| 8940 | 9051 | ||
| 8941 | @node The export dispatcher, ASCII export, Export options, Exporting | 9052 | @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting |
| 8942 | @section The export dispatcher | 9053 | @section The export dispatcher |
| 8943 | @cindex dispatcher, for export commands | 9054 | @cindex dispatcher, for export commands |
| 8944 | 9055 | ||
| @@ -8970,12 +9081,15 @@ Call an the exporter, but reverse the setting of | |||
| 8970 | not set, or force processing in the current Emacs process if set. | 9081 | not set, or force processing in the current Emacs process if set. |
| 8971 | @end table | 9082 | @end table |
| 8972 | 9083 | ||
| 8973 | @node ASCII export, HTML export, The export dispatcher, Exporting | 9084 | @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting |
| 8974 | @section ASCII export | 9085 | @section ASCII/Latin-1/UTF-8 export |
| 8975 | @cindex ASCII export | 9086 | @cindex ASCII export |
| 9087 | @cindex Latin-1 export | ||
| 9088 | @cindex UTF-8 export | ||
| 8976 | 9089 | ||
| 8977 | ASCII export produces a simple and very readable version of an Org-mode | 9090 | ASCII export produces a simple and very readable version of an Org-mode |
| 8978 | file. | 9091 | file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file |
| 9092 | with special characters and symbols available in these encodings. | ||
| 8979 | 9093 | ||
| 8980 | @cindex region, active | 9094 | @cindex region, active |
| 8981 | @cindex active region | 9095 | @cindex active region |
| @@ -8996,8 +9110,18 @@ export. | |||
| 8996 | @kindex C-c C-e A | 9110 | @kindex C-c C-e A |
| 8997 | @item C-c C-e A | 9111 | @item C-c C-e A |
| 8998 | Export to a temporary buffer, do not create a file. | 9112 | Export to a temporary buffer, do not create a file. |
| 9113 | @kindex C-c C-e n | ||
| 9114 | @kindex C-c C-e N | ||
| 9115 | @item C-c C-e n @ @ @r{and} @ @ C-c C-e N | ||
| 9116 | Like the above commands, but use Latin-1 encoding. | ||
| 9117 | @kindex C-c C-e u | ||
| 9118 | @kindex C-c C-e U | ||
| 9119 | @item C-c C-e u @ @ @r{and} @ @ C-c C-e U | ||
| 9120 | Like the above commands, but use UTF-8 encoding. | ||
| 8999 | @kindex C-c C-e v a | 9121 | @kindex C-c C-e v a |
| 9000 | @item C-c C-e v a | 9122 | @kindex C-c C-e v n |
| 9123 | @kindex C-c C-e v u | ||
| 9124 | @item C-c C-e v a @ @ @r{and} @ @ C-c C-e v n @ @ @r{and} @ @ C-c C-e v u | ||
| 9001 | Export only the visible part of the document. | 9125 | Export only the visible part of the document. |
| 9002 | @end table | 9126 | @end table |
| 9003 | 9127 | ||
| @@ -9025,7 +9149,7 @@ Links will be exported in a footnote-like style, with the descriptive part in | |||
| 9025 | the text and the link in a note before the next heading. See the variable | 9149 | the text and the link in a note before the next heading. See the variable |
| 9026 | @code{org-export-ascii-links-to-notes} for details and other options. | 9150 | @code{org-export-ascii-links-to-notes} for details and other options. |
| 9027 | 9151 | ||
| 9028 | @node HTML export, LaTeX and PDF export, ASCII export, Exporting | 9152 | @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting |
| 9029 | @section HTML export | 9153 | @section HTML export |
| 9030 | @cindex HTML export | 9154 | @cindex HTML export |
| 9031 | 9155 | ||
| @@ -9378,19 +9502,25 @@ pages, configure the variable @code{org-export-html-use-infojs}. | |||
| 9378 | @cindex Guerry, Bastien | 9502 | @cindex Guerry, Bastien |
| 9379 | 9503 | ||
| 9380 | Org mode contains a La@TeX{} exporter written by Bastien Guerry. With | 9504 | Org mode contains a La@TeX{} exporter written by Bastien Guerry. With |
| 9381 | further processing, this backend is also used to produce PDF output. Since | 9505 | further processing@footnote{The default LaTeX output is designed for |
| 9382 | the La@TeX{} output uses @file{hyperref} to implement links and cross | 9506 | processing with pdftex or latex. It includes packages that are not |
| 9383 | references, the PDF output file will be fully linked. | 9507 | compatible with xetex and possibly luatex. See the variables |
| 9508 | @code{org-export-latex-default-packages-alist} and | ||
| 9509 | @code{org-export-latex-packages-alist}.}, this backend is also used to | ||
| 9510 | produce PDF output. Since the La@TeX{} output uses @file{hyperref} to | ||
| 9511 | implement links and cross references, the PDF output file will be fully | ||
| 9512 | linked. | ||
| 9384 | 9513 | ||
| 9385 | @menu | 9514 | @menu |
| 9386 | * LaTeX/PDF export commands:: Which key invokes which commands | 9515 | * LaTeX/PDF export commands:: Which key invokes which commands |
| 9516 | * Header and sectioning:: Setting up the export file structure | ||
| 9387 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code | 9517 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code |
| 9388 | * Sectioning structure:: Changing sectioning in La@TeX{} output | ||
| 9389 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} | 9518 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} |
| 9390 | * Images in LaTeX export:: How to insert figures into La@TeX{} output | 9519 | * Images in LaTeX export:: How to insert figures into La@TeX{} output |
| 9520 | * Beamer class export:: Turning the file into a presentation | ||
| 9391 | @end menu | 9521 | @end menu |
| 9392 | 9522 | ||
| 9393 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export | 9523 | @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export |
| 9394 | @subsection La@TeX{} export commands | 9524 | @subsection La@TeX{} export commands |
| 9395 | 9525 | ||
| 9396 | @cindex region, active | 9526 | @cindex region, active |
| @@ -9449,7 +9579,41 @@ with a numeric prefix argument. For example, | |||
| 9449 | @noindent | 9579 | @noindent |
| 9450 | creates two levels of headings and does the rest as items. | 9580 | creates two levels of headings and does the rest as items. |
| 9451 | 9581 | ||
| 9452 | @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export | 9582 | @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export |
| 9583 | @subsection Header and sectioning structure | ||
| 9584 | @cindex La@TeX{} class | ||
| 9585 | @cindex La@TeX{} sectioning structure | ||
| 9586 | @cindex La@TeX{} header | ||
| 9587 | @cindex header, for LaTeX files | ||
| 9588 | @cindex sectioning structure, for LaTeX export | ||
| 9589 | |||
| 9590 | By default, the La@TeX{} output uses the class @code{article}. | ||
| 9591 | |||
| 9592 | @vindex org-export-latex-default-class | ||
| 9593 | @vindex org-export-latex-classes | ||
| 9594 | @vindex org-export-latex-default-packages-alist | ||
| 9595 | @vindex org-export-latex-packages-alist | ||
| 9596 | @cindex #+LATEX_HEADER | ||
| 9597 | @cindex #+LATEX_CLASS | ||
| 9598 | @cindex #+LATEX_CLASS_OPTIONS | ||
| 9599 | @cindex property, LATEX_CLASS | ||
| 9600 | @cindex property, LATEX_CLASS_OPTIONS | ||
| 9601 | You can change this globally by setting a different value for | ||
| 9602 | @code{org-export-latex-default-class} or locally by adding an option like | ||
| 9603 | @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:} | ||
| 9604 | property that applies when exporting a region containing only this (sub)tree. | ||
| 9605 | The class must be listed in @code{org-export-latex-classes}. This variable | ||
| 9606 | defines a header template for each class@footnote{Into which the values of | ||
| 9607 | @code{org-export-latex-default-packages-alist} and | ||
| 9608 | @code{org-export-latex-packages-alist} are spliced.}, and allows you to | ||
| 9609 | define the sectioning structure for each class. You can also define your own | ||
| 9610 | classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS} | ||
| 9611 | property can specify the options for the @code{\documentclass} macro. You | ||
| 9612 | can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the | ||
| 9613 | header. See the docstring of @code{org-export-latex-classes} for more | ||
| 9614 | information. | ||
| 9615 | |||
| 9616 | @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export | ||
| 9453 | @subsection Quoting La@TeX{} code | 9617 | @subsection Quoting La@TeX{} code |
| 9454 | 9618 | ||
| 9455 | Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly | 9619 | Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly |
| @@ -9473,28 +9637,8 @@ All lines between these markers are exported literally | |||
| 9473 | #+END_LaTeX | 9637 | #+END_LaTeX |
| 9474 | @end example | 9638 | @end example |
| 9475 | 9639 | ||
| 9476 | @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export | ||
| 9477 | @subsection Sectioning structure | ||
| 9478 | @cindex La@TeX{} class | ||
| 9479 | @cindex La@TeX{} sectioning structure | ||
| 9480 | |||
| 9481 | By default, the La@TeX{} output uses the class @code{article}. | ||
| 9482 | 9640 | ||
| 9483 | @vindex org-export-latex-default-class | 9641 | @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export |
| 9484 | @vindex org-export-latex-classes | ||
| 9485 | @cindex #+LATEX_HEADER | ||
| 9486 | @cindex #+LATEX_CLASS | ||
| 9487 | @cindex property, LATEX_CLASS | ||
| 9488 | You can change this globally by setting a different value for | ||
| 9489 | @code{org-export-latex-default-class} or locally by adding an option like | ||
| 9490 | @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:} | ||
| 9491 | property that applies when exporting a region containing only this (sub)tree. | ||
| 9492 | The class should be listed in @code{org-export-latex-classes}, where you can | ||
| 9493 | also define the sectioning structure for each class, as well as defining | ||
| 9494 | additional classes. You can also use @code{#+LATEX_HEADER: | ||
| 9495 | \usepackage@{xyz@}} to add lines to the header. | ||
| 9496 | |||
| 9497 | @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export | ||
| 9498 | @subsection Tables in La@TeX{} export | 9642 | @subsection Tables in La@TeX{} export |
| 9499 | @cindex tables, in La@TeX{} export | 9643 | @cindex tables, in La@TeX{} export |
| 9500 | 9644 | ||
| @@ -9515,7 +9659,7 @@ pages. Finally, you can set the alignment string: | |||
| 9515 | @end example | 9659 | @end example |
| 9516 | 9660 | ||
| 9517 | 9661 | ||
| 9518 | @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export | 9662 | @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export |
| 9519 | @subsection Images in La@TeX{} export | 9663 | @subsection Images in La@TeX{} export |
| 9520 | @cindex images, inline in La@TeX{} | 9664 | @cindex images, inline in La@TeX{} |
| 9521 | @cindex inlining images in La@TeX{} | 9665 | @cindex inlining images in La@TeX{} |
| @@ -9555,6 +9699,133 @@ settings for @code{\includegraphics} and @code{wrapfigure}. | |||
| 9555 | If you need references to a label created in this way, write | 9699 | If you need references to a label created in this way, write |
| 9556 | @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. | 9700 | @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. |
| 9557 | 9701 | ||
| 9702 | @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export | ||
| 9703 | @subsection Beamer class export | ||
| 9704 | |||
| 9705 | The LaTeX class @file{beamer} allows to produce high quality presentations | ||
| 9706 | using LaTeX and pdf processing. Org-mode has special support for turning an | ||
| 9707 | Org-mode file or tree into a @file{beamer} presentation. | ||
| 9708 | |||
| 9709 | When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS: | ||
| 9710 | beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is | ||
| 9711 | @code{beamer}, a special export mode will turn the file or tree into a beamer | ||
| 9712 | presentation. Any tree with not-to-deep level nesting should in principle be | ||
| 9713 | exportable as a beamer presentation. By default, the top-level entries (or | ||
| 9714 | the first level below the selected subtree heading) will be turned into | ||
| 9715 | frames, and the outline structure below this level will become itemize lists. | ||
| 9716 | You can also configure the variable @code{org-beamer-frame-level} to a | ||
| 9717 | different level - then the hierarchy above frames will produce the sectioning | ||
| 9718 | structure of the presentation. | ||
| 9719 | |||
| 9720 | A template for useful in-buffer settings or properties can be inserted into | ||
| 9721 | the buffer with @kbd{M-x org-beamer-settings-template}. Among other things, | ||
| 9722 | this will install a column view format which is very handy for editing | ||
| 9723 | special properties used by beamer. | ||
| 9724 | |||
| 9725 | You can influence the structure of the presentation using the following | ||
| 9726 | properties: | ||
| 9727 | |||
| 9728 | @table @code | ||
| 9729 | @item BEAMER_env | ||
| 9730 | The environment that should be used to format this entry. Valid environments | ||
| 9731 | are defined in the constant @code{org-beamer-environments-default}, and you | ||
| 9732 | can define more in @code{org-beamer-environments-extra}. If this property is | ||
| 9733 | set, the entry will also get a @code{:B_environment:} tag to make this | ||
| 9734 | visible. This tag has no semantic meaning, it is only a visual aid. | ||
| 9735 | @item BEAMER_envargs | ||
| 9736 | The beamer-special arguments that should be used for the environment, like | ||
| 9737 | @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col} | ||
| 9738 | property is also set, something like @code{C[t]} can be added here as well to | ||
| 9739 | set an options argument for the implied @code{columns} environment. | ||
| 9740 | @code{c[t]} will set an option for the implied @code{column} environment. | ||
| 9741 | @item BEAMER_col | ||
| 9742 | The width of a column that should start with this entry. If this property is | ||
| 9743 | set, the entry will also get a @code{:BMCOL:} property to make this visible. | ||
| 9744 | Also this tag is only a visual aid. When his is a plain number, it will be | ||
| 9745 | interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed | ||
| 9746 | that you have specified the units, like @samp{3cm}. The first such property | ||
| 9747 | in a frame will start a @code{columns} environment to surround the columns. | ||
| 9748 | This environment is closed when an entry has a @code{BEAMER_col} property | ||
| 9749 | with value 0 or 1, or automatically at the end of the frame. | ||
| 9750 | @item BEAMER_extra | ||
| 9751 | Additional commands that should be inserted after the environment has been | ||
| 9752 | opened. For example, when creating a frame, this can be used to specify | ||
| 9753 | transitions. | ||
| 9754 | @end table | ||
| 9755 | |||
| 9756 | Frames will automatically receive a @code{fragile} option if they contain | ||
| 9757 | source code that uses the verbatim environment. Special @file{beamer} | ||
| 9758 | specific code can be inserted using @code{#+BEAMER:} and | ||
| 9759 | @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export | ||
| 9760 | backends, but with the difference that @code{#+LaTeX:} stuff will be included | ||
| 9761 | in the presentation as well. | ||
| 9762 | |||
| 9763 | Outline nodes with @code{BEAMER_env} property value @samp{note} or | ||
| 9764 | @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped | ||
| 9765 | into @code{\note@{...@}}. The former will include the heading as part of the | ||
| 9766 | note text, the latter will ignore the heading of that node. To simplify note | ||
| 9767 | generation, it is actually enough to mark the note with a @emph{tag} (either | ||
| 9768 | @code{:B_note:} or @code{:B_noteNH:}) instead of creating the | ||
| 9769 | @code{BEAMER_env} property. | ||
| 9770 | |||
| 9771 | You can turn on a special minor mode @code{org-beamer-mode} for editing | ||
| 9772 | support with | ||
| 9773 | |||
| 9774 | @example | ||
| 9775 | #+STARTUP: beamer | ||
| 9776 | @end example | ||
| 9777 | |||
| 9778 | @table @kbd | ||
| 9779 | @kindex C-c C-b | ||
| 9780 | @item C-c C-b | ||
| 9781 | In @code{org-beamer-mode}, this key offers fast selection of a beamer | ||
| 9782 | environment or the @code{BEAMER_col} property. | ||
| 9783 | @end table | ||
| 9784 | |||
| 9785 | Column view provides a great way to set the environment of a node and other | ||
| 9786 | important parameters. Make sure you are using a COLUMN format that is geared | ||
| 9787 | toward this special purpose. The command @kbd{M-x | ||
| 9788 | org-beamer-settings-template} does define such a format. | ||
| 9789 | |||
| 9790 | Here is a simple example Org document that is intended for beamer export. | ||
| 9791 | |||
| 9792 | @smallexample | ||
| 9793 | #+LaTeX_CLASS: beamer | ||
| 9794 | #+TITLE: Example Presentation | ||
| 9795 | #+AUTHOR: Carsten Dominik | ||
| 9796 | #+LaTeX_CLASS_OPTIONS: [presentation] | ||
| 9797 | #+BEAMER_FRAME_LEVEL: 2 | ||
| 9798 | #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@} | ||
| 9799 | #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex) | ||
| 9800 | |||
| 9801 | * This is the first structural section | ||
| 9802 | |||
| 9803 | ** Frame 1 \\ with a subtitle | ||
| 9804 | *** Thanks to Eric Fraga :BMCOL:B_block: | ||
| 9805 | :PROPERTIES: | ||
| 9806 | :BEAMER_env: block | ||
| 9807 | :BEAMER_envargs: C[t] | ||
| 9808 | :BEAMER_col: 0.5 | ||
| 9809 | :END: | ||
| 9810 | for the first viable beamer setup in Org | ||
| 9811 | *** Thanks to everyone else :BMCOL:B_block: | ||
| 9812 | :PROPERTIES: | ||
| 9813 | :BEAMER_col: 0.5 | ||
| 9814 | :BEAMER_env: block | ||
| 9815 | :BEAMER_envargs: <2-> | ||
| 9816 | :END: | ||
| 9817 | for contributing to the discussion | ||
| 9818 | **** This will be formatted as a beamer note :B_note: | ||
| 9819 | ** Frame 2 \\ where we will not use columns | ||
| 9820 | *** Request :B_block: | ||
| 9821 | Please test this stuff! | ||
| 9822 | :PROPERTIES: | ||
| 9823 | :BEAMER_env: block | ||
| 9824 | :END: | ||
| 9825 | @end smallexample | ||
| 9826 | |||
| 9827 | For more information, see the documentation on Worg. | ||
| 9828 | |||
| 9558 | @node DocBook export, Freemind export, LaTeX and PDF export, Exporting | 9829 | @node DocBook export, Freemind export, LaTeX and PDF export, Exporting |
| 9559 | @section DocBook export | 9830 | @section DocBook export |
| 9560 | @cindex DocBook export | 9831 | @cindex DocBook export |
| @@ -9883,7 +10154,8 @@ and many other properties of a project. | |||
| 9883 | * Publishing action:: Setting the function doing the publishing | 10154 | * Publishing action:: Setting the function doing the publishing |
| 9884 | * Publishing options:: Tweaking HTML export | 10155 | * Publishing options:: Tweaking HTML export |
| 9885 | * Publishing links:: Which links keep working after publishing? | 10156 | * Publishing links:: Which links keep working after publishing? |
| 9886 | * Project page index:: Publishing a list of project files | 10157 | * Sitemap:: Generating a list of all pages |
| 10158 | * Generating an index:: An index that reaches across pages | ||
| 9887 | @end menu | 10159 | @end menu |
| 9888 | 10160 | ||
| 9889 | @node Project alist, Sources and destinations, Configuration, Configuration | 10161 | @node Project alist, Sources and destinations, Configuration, Configuration |
| @@ -9929,11 +10201,15 @@ publish to a webserver using a file name syntax appropriate for | |||
| 9929 | the Emacs @file{tramp} package. Or you can publish to a local directory and | 10201 | the Emacs @file{tramp} package. Or you can publish to a local directory and |
| 9930 | use external tools to upload your website (@pxref{Uploading files}). | 10202 | use external tools to upload your website (@pxref{Uploading files}). |
| 9931 | @item @code{:preparation-function} | 10203 | @item @code{:preparation-function} |
| 9932 | @tab Function called before starting the publishing process, for example, to | 10204 | @tab Function or list of functions to be called before starting the |
| 9933 | run @code{make} for updating files to be published. | 10205 | publishing process, for example, to run @code{make} for updating files to be |
| 10206 | published. The project property list is scoped into this call as the | ||
| 10207 | variable @code{project-plist}. | ||
| 9934 | @item @code{:completion-function} | 10208 | @item @code{:completion-function} |
| 9935 | @tab Function called after finishing the publishing process, for example, to | 10209 | @tab Function or list of functions called after finishing the publishing |
| 9936 | change permissions of the resulting files. | 10210 | process, for example, to change permissions of the resulting files. The |
| 10211 | project property list is scoped into this call as the variable | ||
| 10212 | @code{project-plist}. | ||
| 9937 | @end multitable | 10213 | @end multitable |
| 9938 | @noindent | 10214 | @noindent |
| 9939 | 10215 | ||
| @@ -9994,10 +10270,11 @@ list of functions, which will all be called in turn. | |||
| 9994 | @tab Non-nil means, publish htmlized source. | 10270 | @tab Non-nil means, publish htmlized source. |
| 9995 | @end multitable | 10271 | @end multitable |
| 9996 | 10272 | ||
| 9997 | The function must accept two arguments: a property list containing at least a | 10273 | The function must accept three arguments: a property list containing at least |
| 9998 | @code{:publishing-directory} property, and the name of the file to be | 10274 | a @code{:publishing-directory} property, the name of the file to be |
| 9999 | published. It should take the specified file, make the necessary | 10275 | published, and the path to the publishing directory of the output file. It |
| 10000 | transformation (if any) and place the result into the destination folder. | 10276 | should take the specified file, make the necessary transformation (if any) |
| 10277 | and place the result into the destination folder. | ||
| 10001 | 10278 | ||
| 10002 | @node Publishing options, Publishing links, Publishing action, Configuration | 10279 | @node Publishing options, Publishing links, Publishing action, Configuration |
| 10003 | @subsection Options for the HTML/La@TeX{} exporters | 10280 | @subsection Options for the HTML/La@TeX{} exporters |
| @@ -10033,6 +10310,7 @@ respective variable for details. | |||
| 10033 | @vindex org-export-with-fixed-width | 10310 | @vindex org-export-with-fixed-width |
| 10034 | @vindex org-export-with-timestamps | 10311 | @vindex org-export-with-timestamps |
| 10035 | @vindex org-export-author-info | 10312 | @vindex org-export-author-info |
| 10313 | @vindex org-export-email | ||
| 10036 | @vindex org-export-creator-info | 10314 | @vindex org-export-creator-info |
| 10037 | @vindex org-export-with-tables | 10315 | @vindex org-export-with-tables |
| 10038 | @vindex org-export-highlight-first-table-line | 10316 | @vindex org-export-highlight-first-table-line |
| @@ -10081,6 +10359,7 @@ respective variable for details. | |||
| 10081 | @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} | 10359 | @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} |
| 10082 | @item @code{:timestamps} @tab @code{org-export-with-timestamps} | 10360 | @item @code{:timestamps} @tab @code{org-export-with-timestamps} |
| 10083 | @item @code{:author-info} @tab @code{org-export-author-info} | 10361 | @item @code{:author-info} @tab @code{org-export-author-info} |
| 10362 | @item @code{:email-info} @tab @code{org-export-email-info} | ||
| 10084 | @item @code{:creator-info} @tab @code{org-export-creator-info} | 10363 | @item @code{:creator-info} @tab @code{org-export-creator-info} |
| 10085 | @item @code{:tables} @tab @code{org-export-with-tables} | 10364 | @item @code{:tables} @tab @code{org-export-with-tables} |
| 10086 | @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | 10365 | @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} |
| @@ -10117,7 +10396,7 @@ its setting overrides the value of the corresponding user variable (if | |||
| 10117 | any) during publishing. Options set within a file (@pxref{Export | 10396 | any) during publishing. Options set within a file (@pxref{Export |
| 10118 | options}), however, override everything. | 10397 | options}), however, override everything. |
| 10119 | 10398 | ||
| 10120 | @node Publishing links, Project page index, Publishing options, Configuration | 10399 | @node Publishing links, Sitemap, Publishing options, Configuration |
| 10121 | @subsection Links between published files | 10400 | @subsection Links between published files |
| 10122 | @cindex links, publishing | 10401 | @cindex links, publishing |
| 10123 | 10402 | ||
| @@ -10154,31 +10433,48 @@ description into the HTML file, but no link. One option for this | |||
| 10154 | function is @code{org-publish-validate-link} which checks if the given | 10433 | function is @code{org-publish-validate-link} which checks if the given |
| 10155 | file is part of any project in @code{org-publish-project-alist}. | 10434 | file is part of any project in @code{org-publish-project-alist}. |
| 10156 | 10435 | ||
| 10157 | @node Project page index, , Publishing links, Configuration | 10436 | @node Sitemap, Generating an index, Publishing links, Configuration |
| 10158 | @subsection Project page index | 10437 | @subsection Generating a sitemap |
| 10159 | @cindex index, of published pages | 10438 | @cindex sitemap, of published pages |
| 10160 | 10439 | ||
| 10161 | The following properties may be used to control publishing of an | 10440 | The following properties may be used to control publishing of |
| 10162 | index of files or a summary page for a given project. | 10441 | a map of files for a given project. |
| 10163 | 10442 | ||
| 10164 | @multitable @columnfractions 0.25 0.75 | 10443 | @multitable @columnfractions 0.25 0.75 |
| 10165 | @item @code{:auto-index} | 10444 | @item @code{:auto-sitemap} |
| 10166 | @tab When non-nil, publish an index during @code{org-publish-current-project} | 10445 | @tab When non-nil, publish a sitemap during @code{org-publish-current-project} |
| 10167 | or @code{org-publish-all}. | 10446 | or @code{org-publish-all}. |
| 10168 | 10447 | ||
| 10169 | @item @code{:index-filename} | 10448 | @item @code{:sitemap-filename} |
| 10170 | @tab Filename for output of index. Defaults to @file{sitemap.org} (which | 10449 | @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which |
| 10171 | becomes @file{sitemap.html}). | 10450 | becomes @file{sitemap.html}). |
| 10172 | 10451 | ||
| 10173 | @item @code{:index-title} | 10452 | @item @code{:sitemap-title} |
| 10174 | @tab Title of index page. Defaults to name of file. | 10453 | @tab Title of sitemap page. Defaults to name of file. |
| 10175 | 10454 | ||
| 10176 | @item @code{:index-function} | 10455 | @item @code{:sitemap-function} |
| 10177 | @tab Plug-in function to use for generation of index. | 10456 | @tab Plug-in function to use for generation of the sitemap. |
| 10178 | Defaults to @code{org-publish-org-index}, which generates a plain list | 10457 | Defaults to @code{org-publish-org-sitemap}, which generates a plain list |
| 10179 | of links to all files in the project. | 10458 | of links to all files in the project. |
| 10180 | @end multitable | 10459 | @end multitable |
| 10181 | 10460 | ||
| 10461 | @node Generating an index, , Sitemap, Configuration | ||
| 10462 | @subsection Generating an index | ||
| 10463 | @cindex index, in a publishing project | ||
| 10464 | |||
| 10465 | Org-mode can generate an index across the files of a publishing project. | ||
| 10466 | |||
| 10467 | @multitable @columnfractions 0.25 0.75 | ||
| 10468 | @item @code{:makeindex} | ||
| 10469 | @tab When non-nil, generate in index in the file @file{theindex.org} and | ||
| 10470 | publish it as @file{theindex.html}. | ||
| 10471 | @end multitable | ||
| 10472 | |||
| 10473 | The file will be create when first publishing a project with the | ||
| 10474 | @code{:makeindex} set. The file only contains a statement @code{#+include: | ||
| 10475 | "theindex.inc"}. You can then built around this include statement by adding | ||
| 10476 | a title, style information etc. | ||
| 10477 | |||
| 10182 | @node Uploading files, Sample configuration, Configuration, Publishing | 10478 | @node Uploading files, Sample configuration, Configuration, Publishing |
| 10183 | @section Uploading files | 10479 | @section Uploading files |
| 10184 | @cindex rsync | 10480 | @cindex rsync |
| @@ -10561,6 +10857,9 @@ configured using these options (see variables @code{org-log-done}, | |||
| 10561 | @cindex @code{logredeadline}, STARTUP keyword | 10857 | @cindex @code{logredeadline}, STARTUP keyword |
| 10562 | @cindex @code{lognoteredeadline}, STARTUP keyword | 10858 | @cindex @code{lognoteredeadline}, STARTUP keyword |
| 10563 | @cindex @code{nologredeadline}, STARTUP keyword | 10859 | @cindex @code{nologredeadline}, STARTUP keyword |
| 10860 | @cindex @code{logrefile}, STARTUP keyword | ||
| 10861 | @cindex @code{lognoterefile}, STARTUP keyword | ||
| 10862 | @cindex @code{nologrefile}, STARTUP keyword | ||
| 10564 | @example | 10863 | @example |
| 10565 | logdone @r{record a timestamp when an item is marked DONE} | 10864 | logdone @r{record a timestamp when an item is marked DONE} |
| 10566 | lognotedone @r{record timestamp and a note when DONE} | 10865 | lognotedone @r{record timestamp and a note when DONE} |
| @@ -10576,6 +10875,9 @@ nologreschedule @r{do not record when a scheduling date changes} | |||
| 10576 | logredeadline @r{record a timestamp when deadline changes} | 10875 | logredeadline @r{record a timestamp when deadline changes} |
| 10577 | lognoteredeadline @r{record a note when deadline changes} | 10876 | lognoteredeadline @r{record a note when deadline changes} |
| 10578 | nologredeadline @r{do not record when a deadline date changes} | 10877 | nologredeadline @r{do not record when a deadline date changes} |
| 10878 | logrefile @r{record a timestamp when refiling} | ||
| 10879 | lognoterefile @r{record a note when refiling} | ||
| 10880 | nologrefile @r{do not record when refiling} | ||
| 10579 | @end example | 10881 | @end example |
| 10580 | @vindex org-hide-leading-stars | 10882 | @vindex org-hide-leading-stars |
| 10581 | @vindex org-odd-levels-only | 10883 | @vindex org-odd-levels-only |
| @@ -10695,9 +10997,6 @@ works even if the automatic table editor has been turned off. | |||
| 10695 | If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | 10997 | If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to |
| 10696 | the entire table. | 10998 | the entire table. |
| 10697 | @item | 10999 | @item |
| 10698 | If the cursor is inside a table created by the @file{table.el} package, | ||
| 10699 | activate that table. | ||
| 10700 | @item | ||
| 10701 | If the current buffer is a Remember buffer, close the note and file it. | 11000 | If the current buffer is a Remember buffer, close the note and file it. |
| 10702 | With a prefix argument, file it, without further interaction, to the | 11001 | With a prefix argument, file it, without further interaction, to the |
| 10703 | default location. | 11002 | default location. |
| @@ -10752,16 +11051,19 @@ more text | more text | |||
| 10752 | If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind | 11051 | If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind |
| 10753 | of view can be achieved dynamically at display time using | 11052 | of view can be achieved dynamically at display time using |
| 10754 | @code{org-indent-mode}. In this minor mode, all lines are prefixed for | 11053 | @code{org-indent-mode}. In this minor mode, all lines are prefixed for |
| 10755 | display with the necessary amount of space. Also headlines are prefixed with | 11054 | display with the necessary amount of space@footnote{@code{org-indent-mode} |
| 10756 | additional stars, so that the amount of indentation shifts by | 11055 | also sets the @code{wrap-prefix} property, such that @code{visual-line-mode} |
| 10757 | two@footnote{See the variable @code{org-indent-indentation-per-level}.} | 11056 | (or purely setting @code{word-wrap}) wraps long lines (including headlines) |
| 10758 | spaces per level. All headline stars but the last one are made invisible | 11057 | correctly indented. }. Also headlines are prefixed with additional stars, |
| 10759 | using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode} | 11058 | so that the amount of indentation shifts by two@footnote{See the variable |
| 10760 | sets @code{org-hide-leading-stars} to @code{t} and | 11059 | @code{org-indent-indentation-per-level}.} spaces per level. All headline |
| 10761 | @code{org-adapt-indentation} to @code{nil}.} - see below under @samp{2.} for | 11060 | stars but the last one are made invisible using the @code{org-hide} |
| 10762 | more information on how this works. You can turn on @code{org-indent-mode} | 11061 | face@footnote{Turning on @code{org-indent-mode} sets |
| 10763 | for all files by customizing the variable @code{org-startup-indented}, or you | 11062 | @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to |
| 10764 | can turn it on for individual files using | 11063 | @code{nil}.} - see below under @samp{2.} for more information on how this |
| 11064 | works. You can turn on @code{org-indent-mode} for all files by customizing | ||
| 11065 | the variable @code{org-startup-indented}, or you can turn it on for | ||
| 11066 | individual files using | ||
| 10765 | 11067 | ||
| 10766 | @example | 11068 | @example |
| 10767 | #+STARTUP: indent | 11069 | #+STARTUP: indent |
| @@ -10941,7 +11243,7 @@ the option @code{org-imenu-depth}. | |||
| 10941 | @cindex @file{remember.el} | 11243 | @cindex @file{remember.el} |
| 10942 | @cindex Wiegley, John | 11244 | @cindex Wiegley, John |
| 10943 | Org cooperates with remember, see @ref{Remember}. | 11245 | Org cooperates with remember, see @ref{Remember}. |
| 10944 | @file{Remember.el} is not part of Emacs, find it on the web. | 11246 | As of Emacs 23, @file{Remember.el} is part of the Emacs distribution. |
| 10945 | @item @file{speedbar.el} by Eric M. Ludlam | 11247 | @item @file{speedbar.el} by Eric M. Ludlam |
| 10946 | @cindex @file{speedbar.el} | 11248 | @cindex @file{speedbar.el} |
| 10947 | @cindex Ludlam, Eric M. | 11249 | @cindex Ludlam, Eric M. |
| @@ -10957,20 +11259,18 @@ the command @kbd{<} in the Speedbar frame. | |||
| 10957 | @cindex @file{table.el} | 11259 | @cindex @file{table.el} |
| 10958 | @cindex Ota, Takaaki | 11260 | @cindex Ota, Takaaki |
| 10959 | 11261 | ||
| 10960 | Complex ASCII tables with automatic line wrapping, column- and | 11262 | Complex ASCII tables with automatic line wrapping, column- and row-spanning, |
| 10961 | row-spanning, and alignment can be created using the Emacs table | 11263 | and alignment can be created using the Emacs table package by Takaaki Ota |
| 10962 | package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, | 11264 | (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22). |
| 10963 | and also part of Emacs 22). | 11265 | Org-mode will recognize these tables and export them properly. Because of |
| 10964 | When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode | 11266 | interference with other Org-mode functionality, you unfortunately cannot edit |
| 10965 | will call @command{table-recognize-table} and move the cursor into the | 11267 | these tables directly in the buffer. Instead, you need to use the command |
| 10966 | table. Inside a table, the keymap of Org mode is inactive. In order | 11268 | @kbd{C-c '} to edit them, similar to source code snippets. |
| 10967 | to execute Org mode-related commands, leave the table. | ||
| 10968 | 11269 | ||
| 10969 | @table @kbd | 11270 | @table @kbd |
| 10970 | @kindex C-c C-c | 11271 | @kindex C-c ' |
| 10971 | @item C-c C-c | 11272 | @item C-c ' |
| 10972 | Recognize @file{table.el} table. Works when the cursor is in a | 11273 | Edit a @file{table.el} table. Works when the cursor is in a table.el table. |
| 10973 | table.el table. | ||
| 10974 | @c | 11274 | @c |
| 10975 | @kindex C-c ~ | 11275 | @kindex C-c ~ |
| 10976 | @item C-c ~ | 11276 | @item C-c ~ |
| @@ -10980,7 +11280,7 @@ format. See the documentation string of the command | |||
| 10980 | @code{org-convert-table} for the restrictions under which this is | 11280 | @code{org-convert-table} for the restrictions under which this is |
| 10981 | possible. | 11281 | possible. |
| 10982 | @end table | 11282 | @end table |
| 10983 | @file{table.el} is part of Emacs 22. | 11283 | @file{table.el} is part of Emacs since Emacs 22. |
| 10984 | @item @file{footnote.el} by Steven L. Baur | 11284 | @item @file{footnote.el} by Steven L. Baur |
| 10985 | @cindex @file{footnote.el} | 11285 | @cindex @file{footnote.el} |
| 10986 | @cindex Baur, Steven L. | 11286 | @cindex Baur, Steven L. |
| @@ -11707,6 +12007,10 @@ Skip current entry if it has not been scheduled. | |||
| 11707 | Skip current entry if it has a deadline. | 12007 | Skip current entry if it has a deadline. |
| 11708 | @item '(org-agenda-skip-entry-if 'scheduled 'deadline) | 12008 | @item '(org-agenda-skip-entry-if 'scheduled 'deadline) |
| 11709 | Skip current entry if it has a deadline, or if it is scheduled. | 12009 | Skip current entry if it has a deadline, or if it is scheduled. |
| 12010 | @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING")) | ||
| 12011 | Skip current entry if the TODO keyword is TODO or WAITING. | ||
| 12012 | @item '(org-agenda-skip-entry-if 'todo 'done) | ||
| 12013 | Skip current entry if the TODO keyword marks a DONE state. | ||
| 11710 | @item '(org-agenda-skip-entry-if 'timestamp) | 12014 | @item '(org-agenda-skip-entry-if 'timestamp) |
| 11711 | Skip current entry if it has any timestamp, may also be deadline or scheduled. | 12015 | Skip current entry if it has any timestamp, may also be deadline or scheduled. |
| 11712 | @item '(org-agenda-skip-entry 'regexp "regular expression") | 12016 | @item '(org-agenda-skip-entry 'regexp "regular expression") |
| @@ -11900,6 +12204,15 @@ Treat the value of the property PROPERTY as a whitespace-separated list of | |||
| 11900 | values and check if VALUE is in this list. | 12204 | values and check if VALUE is in this list. |
| 11901 | @end defun | 12205 | @end defun |
| 11902 | 12206 | ||
| 12207 | @defopt org-property-allowed-value-functions | ||
| 12208 | Hook for functions supplying allowed values for specific. | ||
| 12209 | The functions must take a single argument, the name of the property, and | ||
| 12210 | return a flat list of allowed values. If @samp{:ETC} is one of | ||
| 12211 | the values, use the values as completion help, but allow also other values | ||
| 12212 | to be entered. The functions must return @code{nil} if they are not | ||
| 12213 | responsible for this property. | ||
| 12214 | @end defopt | ||
| 12215 | |||
| 11903 | @node Using the mapping API, , Using the property API, Hacking | 12216 | @node Using the mapping API, , Using the property API, Hacking |
| 11904 | @section Using the mapping API | 12217 | @section Using the mapping API |
| 11905 | @cindex API, for mapping | 12218 | @cindex API, for mapping |
| @@ -12044,11 +12357,14 @@ in-buffer settings, but it will understand the logistics of todo state | |||
| 12044 | 12357 | ||
| 12045 | Org-mode has commands to prepare a directory with files for @i{MobileOrg}, | 12358 | Org-mode has commands to prepare a directory with files for @i{MobileOrg}, |
| 12046 | and to read captured notes from there. If Emacs can directly write to the | 12359 | and to read captured notes from there. If Emacs can directly write to the |
| 12047 | WebDAV directory accessed by @i{MobileOrg}, just point to this directory | 12360 | WebDAV directory@footnote{If you are using a public server, you might prefer |
| 12048 | using the variable @code{org-mobile-directory}. Using the @file{tramp} | 12361 | to encrypt the files on the server. This can be done with Org-mode 6.35 and |
| 12049 | method, @code{org-mobile-directory} may point to a remote directory | 12362 | MobileOrg 1.2. On the Emacs side, configure the variables |
| 12050 | accessible through, for example, | 12363 | @code{org-mobile-use-encryption} and @code{org-mobile-encryption-password}.} |
| 12051 | @file{ssh/scp}: | 12364 | accessed by @i{MobileOrg}, just point to this directory using the variable |
| 12365 | @code{org-mobile-directory}. Using the @file{tramp} method, | ||
| 12366 | @code{org-mobile-directory} may point to a remote directory accessible | ||
| 12367 | through, for example, @file{ssh/scp}: | ||
| 12052 | 12368 | ||
| 12053 | @smallexample | 12369 | @smallexample |
| 12054 | (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/") | 12370 | (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/") |
| @@ -12195,6 +12511,8 @@ Org-mode website. | |||
| 12195 | @item | 12511 | @item |
| 12196 | @i{Alex Bochannek} provided a patch for rounding timestamps. | 12512 | @i{Alex Bochannek} provided a patch for rounding timestamps. |
| 12197 | @item | 12513 | @item |
| 12514 | @i{Jan Böcker} wrote @file{org-docview.el}. | ||
| 12515 | @item | ||
| 12198 | @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files. | 12516 | @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files. |
| 12199 | @item | 12517 | @item |
| 12200 | @i{Tom Breton} wrote @file{org-choose.el}. | 12518 | @i{Tom Breton} wrote @file{org-choose.el}. |
| @@ -12336,6 +12654,8 @@ other things. | |||
| 12336 | @i{Eric Schulte} wrote @file{org-plot.el} and (together with @i{Dan Davison}) | 12654 | @i{Eric Schulte} wrote @file{org-plot.el} and (together with @i{Dan Davison}) |
| 12337 | Org Babel, and contributed various patches, small features and modules. | 12655 | Org Babel, and contributed various patches, small features and modules. |
| 12338 | @item | 12656 | @item |
| 12657 | @i{Paul Sexton} wrote @file{org-ctags.el}. | ||
| 12658 | @item | ||
| 12339 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s | 12659 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
| 12340 | @file{organizer-mode.el}. | 12660 | @file{organizer-mode.el}. |
| 12341 | @item | 12661 | @item |
| @@ -12365,6 +12685,8 @@ chapter about publishing. | |||
| 12365 | @i{J@"urgen Vollmer} contributed code generating the table of contents | 12685 | @i{J@"urgen Vollmer} contributed code generating the table of contents |
| 12366 | in HTML output. | 12686 | in HTML output. |
| 12367 | @item | 12687 | @item |
| 12688 | @i{Samuel Wales} has provided important feedback and bug reports. | ||
| 12689 | @item | ||
| 12368 | @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} | 12690 | @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} |
| 12369 | keyword. | 12691 | keyword. |
| 12370 | @item | 12692 | @item |
| @@ -12379,7 +12701,7 @@ learned a lot from it. John has also contributed a number of great ideas and | |||
| 12379 | patches directly to Org, including the attachment system | 12701 | patches directly to Org, including the attachment system |
| 12380 | (@file{org-attach.el}), integration with Apple Mail | 12702 | (@file{org-attach.el}), integration with Apple Mail |
| 12381 | (@file{org-mac-message.el}), hierarchical dependencies of TODO items, habit | 12703 | (@file{org-mac-message.el}), hierarchical dependencies of TODO items, habit |
| 12382 | tracking (@file{org-habits.el}) and support for pcomplete. | 12704 | tracking (@file{org-habits.el}). |
| 12383 | @item | 12705 | @item |
| 12384 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in | 12706 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in |
| 12385 | linking to Gnus. | 12707 | linking to Gnus. |