diff options
| author | Bastien Guerry | 2012-04-01 11:49:25 +0200 |
|---|---|---|
| committer | Bastien Guerry | 2012-04-01 11:49:25 +0200 |
| commit | 153ae947f845f6d4f31d3d239a1449899c3384f0 (patch) | |
| tree | b7ef6c7f4b94f4a4ee19eecd079c36aff84bddc5 /doc | |
| parent | 42ee526b1adbe2ba7766203980a9d7089aae1a68 (diff) | |
| download | emacs-153ae947f845f6d4f31d3d239a1449899c3384f0.tar.gz emacs-153ae947f845f6d4f31d3d239a1449899c3384f0.zip | |
Update to Org version 7.8.07 (commit da0e6f in Org's repo)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 112 | ||||
| -rw-r--r-- | doc/misc/org.texi | 597 |
2 files changed, 481 insertions, 228 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 8d40ab5ab15..6c8a9d29c2e 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,115 @@ | |||
| 1 | 2012-04-01 Jambunathan K <kjambunathan@gmail.com> | ||
| 2 | |||
| 3 | * org.texi (Customizing tables in ODT export): Correct few errors. | ||
| 4 | |||
| 5 | 2012-04-01 Jambunathan K <kjambunathan@gmail.com> | ||
| 6 | |||
| 7 | * org.texi (Links in ODT export): Update. | ||
| 8 | (Labels and captions in ODT export): New node. | ||
| 9 | |||
| 10 | 2012-04-01 Jambunathan K <kjambunathan@gmail.com> | ||
| 11 | |||
| 12 | * org.texi (Literal examples in ODT export): htmlfontify.el in | ||
| 13 | Emacs-24.1 now supports fontification. So ODT source blocks will | ||
| 14 | be fontified by default. | ||
| 15 | |||
| 16 | 2012-04-01 Julian Gehring <julian.gehring@googlemail.com> (tiny change) | ||
| 17 | |||
| 18 | * org.texi (Refiling notes): Remove duplicated keybinding. | ||
| 19 | |||
| 20 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 21 | |||
| 22 | * org.texi (noweb): Documentation of this new option to the :noweb | ||
| 23 | header argument. | ||
| 24 | |||
| 25 | 2012-04-01 Suvayu Ali <fatkasuvayu+linux@gmail.com> | ||
| 26 | |||
| 27 | * org.texi (Header and sectioning): Add example demonstrating how | ||
| 28 | to use "LaTeX_CLASS_OPTIONS". | ||
| 29 | |||
| 30 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 31 | |||
| 32 | * org.texi (Noweb reference syntax): Describe the ability to | ||
| 33 | execute noweb references in the manual. | ||
| 34 | |||
| 35 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 36 | |||
| 37 | * org.texi (cache): Improve cache documentation when session | ||
| 38 | evaluation is used. | ||
| 39 | |||
| 40 | 2012-04-01 Nicolas Goaziou <n.goaziou@gmail.com> | ||
| 41 | |||
| 42 | * org.texi (Plain lists): Document removal. | ||
| 43 | |||
| 44 | 2012-04-01 Michael Brand <michael.ch.brand@gmail.com> | ||
| 45 | |||
| 46 | * org.texi: Decapitalize file name in references to Calc manual. | ||
| 47 | |||
| 48 | 2012-04-01 Nicolas Goaziou <n.goaziou@gmail.com> | ||
| 49 | |||
| 50 | * org.texi (Plain lists): Document removal. | ||
| 51 | |||
| 52 | 2012-04-01 Jambunathan K <kjambunathan@gmail.com> | ||
| 53 | |||
| 54 | * org.texi (Top, OpenDocument Text export) | ||
| 55 | (ODT export commands, Extending ODT export) | ||
| 56 | (Images in ODT export, Tables in ODT export) | ||
| 57 | (Configuring a document converter): Add or Update. | ||
| 58 | |||
| 59 | 2012-04-01 Carsten Dominik <carsten.dominik@gmail.com> | ||
| 60 | |||
| 61 | * org.texi (MobileOrg): Change the wording to reflect that the | ||
| 62 | Android Version is no longer just the little brother of the iOS | ||
| 63 | version. | ||
| 64 | |||
| 65 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 66 | |||
| 67 | * org.texi (Key bindings and useful functions): Updated babel key | ||
| 68 | binding documentation in manual. | ||
| 69 | |||
| 70 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 71 | |||
| 72 | * org.texi (noweb): Document new noweb header value. | ||
| 73 | |||
| 74 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 75 | |||
| 76 | * org.texi (noweb-sep): Document new header argument. | ||
| 77 | |||
| 78 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 79 | |||
| 80 | * org.texi (noweb-ref): Documentation of this new custom variable. | ||
| 81 | |||
| 82 | 2012-04-01 Eric Schulte <eric.schulte@gmx.com> | ||
| 83 | |||
| 84 | * org.texi (wrap): Update the new :wrap documentation to match the | ||
| 85 | current implementation. | ||
| 86 | |||
| 87 | 2012-04-01 Thomas Dye <dk@poto.myhome.westell.com> | ||
| 88 | |||
| 89 | * org.texi: Added documentation for :wrap. | ||
| 90 | |||
| 91 | 2012-04-01 Thomas Dye <dk@poto.myhome.westell.com> | ||
| 92 | |||
| 93 | * org.texi: #+RESULTS now user-configurable. | ||
| 94 | |||
| 95 | 2012-04-01 Thomas Dye <dk@poto.myhome.westell.com> | ||
| 96 | |||
| 97 | * org.texi: Documented :noweb no-export. | ||
| 98 | |||
| 99 | 2012-04-01 Thomas Dye <dk@poto.local> | ||
| 100 | |||
| 101 | * org.texi: Edit :noweb no header argument for correctness. | ||
| 102 | |||
| 103 | 2012-04-01 Bastien Guerry <bzg@altern.org> | ||
| 104 | |||
| 105 | * org.texi (Customization): Update the approximate number of Org | ||
| 106 | variables. | ||
| 107 | |||
| 108 | 2012-04-01 Thomas Dye <dk@poto.local> | ||
| 109 | |||
| 110 | * org.texi: The :results wrap produces a drawer instead of a | ||
| 111 | begin_results block. | ||
| 112 | |||
| 1 | 2012-03-22 Peder O. Klingenberg <peder@klingenberg.no> (tiny change) | 113 | 2012-03-22 Peder O. Klingenberg <peder@klingenberg.no> (tiny change) |
| 2 | 114 | ||
| 3 | * gnus.texi (Archived Messages): Update `gnus-message-archive-group' to | 115 | * gnus.texi (Archived Messages): Update `gnus-message-archive-group' to |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 2a41d6b9301..ab9de71277f 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -4,8 +4,8 @@ | |||
| 4 | @setfilename ../../info/org | 4 | @setfilename ../../info/org |
| 5 | @settitle The Org Manual | 5 | @settitle The Org Manual |
| 6 | 6 | ||
| 7 | @set VERSION 7.8.03 | 7 | @set VERSION 7.8.07 |
| 8 | @set DATE January 2012 | 8 | @set DATE March 2012 |
| 9 | 9 | ||
| 10 | @c Use proper quote and backtick for code sections in PDF output | 10 | @c Use proper quote and backtick for code sections in PDF output |
| 11 | @c Cf. Texinfo manual 14.2 | 11 | @c Cf. Texinfo manual 14.2 |
| @@ -265,7 +265,7 @@ | |||
| 265 | @copying | 265 | @copying |
| 266 | This manual is for Org version @value{VERSION}. | 266 | This manual is for Org version @value{VERSION}. |
| 267 | 267 | ||
| 268 | Copyright @copyright{} 2004-2012 Free Software Foundation, Inc. | 268 | Copyright @copyright{} 2004-2011 Free Software Foundation, Inc. |
| 269 | 269 | ||
| 270 | @quotation | 270 | @quotation |
| 271 | Permission is granted to copy, distribute and/or modify this document | 271 | Permission is granted to copy, distribute and/or modify this document |
| @@ -612,27 +612,29 @@ DocBook export | |||
| 612 | 612 | ||
| 613 | OpenDocument Text export | 613 | OpenDocument Text export |
| 614 | 614 | ||
| 615 | * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on | 615 | * Pre-requisites for ODT export:: What packages ODT exporter relies on |
| 616 | * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export | 616 | * ODT export commands:: How to invoke ODT export |
| 617 | * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files | ||
| 617 | * Applying custom styles:: How to apply custom styles to the output | 618 | * Applying custom styles:: How to apply custom styles to the output |
| 618 | * Links in @acronym{ODT} export:: How links will be interpreted and formatted | 619 | * Links in ODT export:: How links will be interpreted and formatted |
| 619 | * Tables in @acronym{ODT} export:: How Tables are exported | 620 | * Tables in ODT export:: How Tables are exported |
| 620 | * Images in @acronym{ODT} export:: How to insert images | 621 | * Images in ODT export:: How to insert images |
| 621 | * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted | 622 | * Math formatting in ODT export:: How @LaTeX{} fragments are formatted |
| 622 | * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted | 623 | * Labels and captions in ODT export:: How captions are rendered |
| 623 | * Advanced topics in @acronym{ODT} export:: Read this if you are a power user | 624 | * Literal examples in ODT export:: How source and example blocks are formatted |
| 625 | * Advanced topics in ODT export:: Read this if you are a power user | ||
| 624 | 626 | ||
| 625 | Math formatting in @acronym{ODT} export | 627 | Math formatting in ODT export |
| 626 | 628 | ||
| 627 | * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments | 629 | * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments |
| 628 | * Working with MathML or OpenDocument formula files:: How to embed equations in native format | 630 | * Working with MathML or OpenDocument formula files:: How to embed equations in native format |
| 629 | 631 | ||
| 630 | Advanced topics in @acronym{ODT} export | 632 | Advanced topics in ODT export |
| 631 | 633 | ||
| 632 | * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats | 634 | * Configuring a document converter:: How to register a document converter |
| 633 | * Working with OpenDocument style files:: Explore the internals | 635 | * Working with OpenDocument style files:: Explore the internals |
| 634 | * Creating one-off styles:: How to produce custom highlighting etc | 636 | * Creating one-off styles:: How to produce custom highlighting etc |
| 635 | * Customizing tables in @acronym{ODT} export:: How to define and use Table templates | 637 | * Customizing tables in ODT export:: How to define and use Table templates |
| 636 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files | 638 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files |
| 637 | 639 | ||
| 638 | Publishing | 640 | Publishing |
| @@ -708,6 +710,7 @@ Specific header arguments | |||
| 708 | * session:: Preserve the state of code evaluation | 710 | * session:: Preserve the state of code evaluation |
| 709 | * noweb:: Toggle expansion of noweb references | 711 | * noweb:: Toggle expansion of noweb references |
| 710 | * noweb-ref:: Specify block's noweb reference resolution target | 712 | * noweb-ref:: Specify block's noweb reference resolution target |
| 713 | * noweb-sep:: String used to separate noweb references | ||
| 711 | * cache:: Avoid re-evaluating unchanged code blocks | 714 | * cache:: Avoid re-evaluating unchanged code blocks |
| 712 | * sep:: Delimiter for writing tabular results outside Org | 715 | * sep:: Delimiter for writing tabular results outside Org |
| 713 | * hlines:: Handle horizontal lines in tables | 716 | * hlines:: Handle horizontal lines in tables |
| @@ -1004,7 +1007,7 @@ from within Emacs, please copy and paste the content into your Email program. | |||
| 1004 | 1007 | ||
| 1005 | Sometimes you might face a problem due to an error in your Emacs or Org mode | 1008 | Sometimes you might face a problem due to an error in your Emacs or Org mode |
| 1006 | setup. Before reporting a bug, it is very helpful to start Emacs with minimal | 1009 | setup. Before reporting a bug, it is very helpful to start Emacs with minimal |
| 1007 | customizations and reproduce the problem. Doing so often helps you determine | 1010 | customisations and reproduce the problem. Doing so often helps you determine |
| 1008 | if the problem is with your customization or with Org mode itself. You can | 1011 | if the problem is with your customization or with Org mode itself. You can |
| 1009 | start a typical minimal session with a command like the example below. | 1012 | start a typical minimal session with a command like the example below. |
| 1010 | 1013 | ||
| @@ -1435,8 +1438,7 @@ creation time, scheduled time, deadline time), by priority, by TODO keyword | |||
| 1435 | (in the sequence the keywords have been defined in the setup) or by the value | 1438 | (in the sequence the keywords have been defined in the setup) or by the value |
| 1436 | of a property. Reverse sorting is possible as well. You can also supply | 1439 | of a property. Reverse sorting is possible as well. You can also supply |
| 1437 | your own function to extract the sorting key. With a @kbd{C-u} prefix, | 1440 | your own function to extract the sorting key. With a @kbd{C-u} prefix, |
| 1438 | sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate | 1441 | sorting will be case-sensitive. |
| 1439 | entries will also be removed. | ||
| 1440 | @orgcmd{C-x n s,org-narrow-to-subtree} | 1442 | @orgcmd{C-x n s,org-narrow-to-subtree} |
| 1441 | Narrow buffer to current subtree. | 1443 | Narrow buffer to current subtree. |
| 1442 | @orgcmd{C-x n b,org-narrow-to-block} | 1444 | @orgcmd{C-x n b,org-narrow-to-block} |
| @@ -1587,16 +1589,11 @@ line. In particular, if an ordered list reaches number @samp{10.}, then the | |||
| 1587 | list. An item ends before the next line that is less or equally indented | 1589 | list. An item ends before the next line that is less or equally indented |
| 1588 | than its bullet/number. | 1590 | than its bullet/number. |
| 1589 | 1591 | ||
| 1590 | @vindex org-list-ending-method | ||
| 1591 | @vindex org-list-end-regexp | ||
| 1592 | @vindex org-empty-line-terminates-plain-lists | 1592 | @vindex org-empty-line-terminates-plain-lists |
| 1593 | Two methods@footnote{To disable either of them, configure | 1593 | A list ends whenever every item has ended, which means before any line less |
| 1594 | @code{org-list-ending-method}.} are provided to terminate lists. A list ends | 1594 | or equally indented than items at top level. It also ends before two blank |
| 1595 | whenever every item has ended, which means before any line less or equally | ||
| 1596 | indented than items at top level. It also ends before two blank | ||
| 1597 | lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In | 1595 | lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In |
| 1598 | that case, all items are closed. For finer control, you can end lists with | 1596 | that case, all items are closed. Here is an example: |
| 1599 | any pattern set in @code{org-list-end-regexp}. Here is an example: | ||
| 1600 | 1597 | ||
| 1601 | @example | 1598 | @example |
| 1602 | @group | 1599 | @group |
| @@ -1949,13 +1946,7 @@ item. | |||
| 1949 | 1946 | ||
| 1950 | Org comes with a fast and intuitive table editor. Spreadsheet-like | 1947 | Org comes with a fast and intuitive table editor. Spreadsheet-like |
| 1951 | calculations are supported using the Emacs @file{calc} package | 1948 | calculations are supported using the Emacs @file{calc} package |
| 1952 | @ifinfo | 1949 | (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}). |
| 1953 | (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). | ||
| 1954 | @end ifinfo | ||
| 1955 | @ifnotinfo | ||
| 1956 | (see the Emacs Calculator manual for more information about the Emacs | ||
| 1957 | calculator). | ||
| 1958 | @end ifnotinfo | ||
| 1959 | 1950 | ||
| 1960 | @menu | 1951 | @menu |
| 1961 | * Built-in table editor:: Simple tables | 1952 | * Built-in table editor:: Simple tables |
| @@ -2253,7 +2244,8 @@ of columns, much like horizontal lines can do for groups of rows. In | |||
| 2253 | order to specify column groups, you can use a special row where the | 2244 | order to specify column groups, you can use a special row where the |
| 2254 | first field contains only @samp{/}. The further fields can either | 2245 | first field contains only @samp{/}. The further fields can either |
| 2255 | contain @samp{<} to indicate that this column should start a group, | 2246 | contain @samp{<} to indicate that this column should start a group, |
| 2256 | @samp{>} to indicate the end of a column, or @samp{<>} to make a column | 2247 | @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<} |
| 2248 | and @samp{>}) to make a column | ||
| 2257 | a group of its own. Boundaries between column groups will upon export be | 2249 | a group of its own. Boundaries between column groups will upon export be |
| 2258 | marked with vertical lines. Here is an example: | 2250 | marked with vertical lines. Here is an example: |
| 2259 | 2251 | ||
| @@ -2515,9 +2507,8 @@ A formula can be any algebraic expression understood by the Emacs | |||
| 2515 | non-standard convention that @samp{/} has lower precedence than | 2507 | non-standard convention that @samp{/} has lower precedence than |
| 2516 | @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before | 2508 | @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before |
| 2517 | evaluation by @code{calc-eval} (@pxref{Calling Calc from | 2509 | evaluation by @code{calc-eval} (@pxref{Calling Calc from |
| 2518 | Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU | 2510 | Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU |
| 2519 | Emacs Calc Manual}), | 2511 | Emacs Calc Manual}), |
| 2520 | @c FIXME: The link to the Calc manual in HTML does not work. | ||
| 2521 | variable substitution takes place according to the rules described above. | 2512 | variable substitution takes place according to the rules described above. |
| 2522 | @cindex vectors, in table calculations | 2513 | @cindex vectors, in table calculations |
| 2523 | The range vectors can be directly fed into the Calc vector functions | 2514 | The range vectors can be directly fed into the Calc vector functions |
| @@ -5407,10 +5398,11 @@ the settings. This has been the source of much confusion. Org mode users | |||
| 5407 | can resort to special versions of these functions like @code{org-date} or | 5398 | can resort to special versions of these functions like @code{org-date} or |
| 5408 | @code{org-anniversary}. These work just like the corresponding @code{diary-} | 5399 | @code{org-anniversary}. These work just like the corresponding @code{diary-} |
| 5409 | functions, but with stable ISO order of arguments (year, month, day) wherever | 5400 | functions, but with stable ISO order of arguments (year, month, day) wherever |
| 5410 | applicable, independent of the value of @code{calendar-date-style}.}. For example | 5401 | applicable, independent of the value of @code{calendar-date-style}.}. For |
| 5402 | example with optional time | ||
| 5411 | 5403 | ||
| 5412 | @example | 5404 | @example |
| 5413 | * The nerd meeting on every 2nd Thursday of the month | 5405 | * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month |
| 5414 | <%%(org-float t 4 2)> | 5406 | <%%(org-float t 4 2)> |
| 5415 | @end example | 5407 | @end example |
| 5416 | 5408 | ||
| @@ -6162,7 +6154,7 @@ applying it to another one. | |||
| 6162 | By customizing the variable @code{org-clock-idle-time} to some integer, such | 6154 | By customizing the variable @code{org-clock-idle-time} to some integer, such |
| 6163 | as 10 or 15, Emacs can alert you when you get back to your computer after | 6155 | as 10 or 15, Emacs can alert you when you get back to your computer after |
| 6164 | being idle for that many minutes@footnote{On computers using Mac OS X, | 6156 | being idle for that many minutes@footnote{On computers using Mac OS X, |
| 6165 | idleness is based on actual user idleness, not just Emacs's idle time. For | 6157 | idleness is based on actual user idleness, not just Emacs' idle time. For |
| 6166 | X11, you can install a utility program @file{x11idle.c}, available in the | 6158 | X11, you can install a utility program @file{x11idle.c}, available in the |
| 6167 | UTILITIES directory of the Org git distribution, to get the same general | 6159 | UTILITIES directory of the Org git distribution, to get the same general |
| 6168 | treatment of idleness. On other systems, idle time refers to Emacs idle time | 6160 | treatment of idleness. On other systems, idle time refers to Emacs idle time |
| @@ -6905,10 +6897,7 @@ Use the refile interface to jump to a heading. | |||
| 6905 | Jump to the location where @code{org-refile} last moved a tree to. | 6897 | Jump to the location where @code{org-refile} last moved a tree to. |
| 6906 | @item C-2 C-c C-w | 6898 | @item C-2 C-c C-w |
| 6907 | Refile as the child of the item currently being clocked. | 6899 | Refile as the child of the item currently being clocked. |
| 6908 | @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w | ||
| 6909 | |||
| 6910 | @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear} | 6900 | @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear} |
| 6911 | |||
| 6912 | Clear the target cache. Caching of refile targets can be turned on by | 6901 | Clear the target cache. Caching of refile targets can be turned on by |
| 6913 | setting @code{org-refile-use-cache}. To make the command see new possible | 6902 | setting @code{org-refile-use-cache}. To make the command see new possible |
| 6914 | targets, you have to clear the cache with this command. | 6903 | targets, you have to clear the cache with this command. |
| @@ -9548,7 +9537,7 @@ the web, while the XOXO format provides a solid base for exchange with a | |||
| 9548 | broad range of other applications. @LaTeX{} export lets you use Org mode and | 9537 | broad range of other applications. @LaTeX{} export lets you use Org mode and |
| 9549 | its structured editing functions to easily create @LaTeX{} files. DocBook | 9538 | its structured editing functions to easily create @LaTeX{} files. DocBook |
| 9550 | export makes it possible to convert Org files to many other formats using | 9539 | export makes it possible to convert Org files to many other formats using |
| 9551 | DocBook tools. OpenDocument Text(@acronym{ODT}) export allows seamless | 9540 | DocBook tools. OpenDocument Text(ODT) export allows seamless |
| 9552 | collaboration across organizational boundaries. For project management you | 9541 | collaboration across organizational boundaries. For project management you |
| 9553 | can create gantt and resource charts by using TaskJuggler export. To | 9542 | can create gantt and resource charts by using TaskJuggler export. To |
| 9554 | incorporate entries with associated times like deadlines or appointments into | 9543 | incorporate entries with associated times like deadlines or appointments into |
| @@ -10803,34 +10792,36 @@ special characters included in XHTML entities: | |||
| 10803 | @cindex org-modules | 10792 | @cindex org-modules |
| 10804 | 10793 | ||
| 10805 | Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text | 10794 | Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text |
| 10806 | (@acronym{ODT}) format using the @file{org-odt.el} module. Documents created | 10795 | (ODT) format using the @file{org-odt.el} module. Documents created |
| 10807 | by this exporter use the @cite{OpenDocument-v1.2 | 10796 | by this exporter use the @cite{OpenDocument-v1.2 |
| 10808 | specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html, | 10797 | specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html, |
| 10809 | Open Document Format for Office Applications (OpenDocument) Version 1.2}} and | 10798 | Open Document Format for Office Applications (OpenDocument) Version 1.2}} and |
| 10810 | are compatible with LibreOffice 3.4. | 10799 | are compatible with LibreOffice 3.4. |
| 10811 | 10800 | ||
| 10812 | @menu | 10801 | @menu |
| 10813 | * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on | 10802 | * Pre-requisites for ODT export:: What packages ODT exporter relies on |
| 10814 | * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export | 10803 | * ODT export commands:: How to invoke ODT export |
| 10804 | * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files | ||
| 10815 | * Applying custom styles:: How to apply custom styles to the output | 10805 | * Applying custom styles:: How to apply custom styles to the output |
| 10816 | * Links in @acronym{ODT} export:: How links will be interpreted and formatted | 10806 | * Links in ODT export:: How links will be interpreted and formatted |
| 10817 | * Tables in @acronym{ODT} export:: How Tables are exported | 10807 | * Tables in ODT export:: How Tables are exported |
| 10818 | * Images in @acronym{ODT} export:: How to insert images | 10808 | * Images in ODT export:: How to insert images |
| 10819 | * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted | 10809 | * Math formatting in ODT export:: How @LaTeX{} fragments are formatted |
| 10820 | * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted | 10810 | * Labels and captions in ODT export:: How captions are rendered |
| 10821 | * Advanced topics in @acronym{ODT} export:: Read this if you are a power user | 10811 | * Literal examples in ODT export:: How source and example blocks are formatted |
| 10812 | * Advanced topics in ODT export:: Read this if you are a power user | ||
| 10822 | @end menu | 10813 | @end menu |
| 10823 | 10814 | ||
| 10824 | @node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export | 10815 | @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export |
| 10825 | @subsection Pre-requisites for @acronym{ODT} export | 10816 | @subsection Pre-requisites for ODT export |
| 10826 | @cindex zip | 10817 | @cindex zip |
| 10827 | The @acronym{ODT} exporter relies on the @file{zip} program to create the final | 10818 | The ODT exporter relies on the @file{zip} program to create the final |
| 10828 | output. Check the availability of this program before proceeding further. | 10819 | output. Check the availability of this program before proceeding further. |
| 10829 | 10820 | ||
| 10830 | @node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export | 10821 | @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export |
| 10831 | @subsection @acronym{ODT} export commands | 10822 | @subsection ODT export commands |
| 10832 | 10823 | ||
| 10833 | @subsubheading Exporting to @acronym{ODT} | 10824 | @subsubheading Exporting to ODT |
| 10834 | @anchor{x-export-to-odt} | 10825 | @anchor{x-export-to-odt} |
| 10835 | 10826 | ||
| 10836 | @cindex region, active | 10827 | @cindex region, active |
| @@ -10841,12 +10832,13 @@ output. Check the availability of this program before proceeding further. | |||
| 10841 | @cindex property EXPORT_FILE_NAME | 10832 | @cindex property EXPORT_FILE_NAME |
| 10842 | 10833 | ||
| 10843 | Export as OpenDocument Text file. | 10834 | Export as OpenDocument Text file. |
| 10835 | |||
| 10844 | @vindex org-export-odt-preferred-output-format | 10836 | @vindex org-export-odt-preferred-output-format |
| 10845 | If @code{org-export-odt-preferred-output-format} is specified, automatically | 10837 | If @code{org-export-odt-preferred-output-format} is specified, automatically |
| 10846 | convert the exported file to that format. | 10838 | convert the exported file to that format. @xref{x-export-to-other-formats, , |
| 10847 | @xref{x-export-to-other-formats,,Automatically exporting to other formats}. | 10839 | Automatically exporting to other formats}. |
| 10848 | 10840 | ||
| 10849 | For an Org file @file{myfile.org}, the @acronym{ODT} file will be | 10841 | For an Org file @file{myfile.org}, the ODT file will be |
| 10850 | @file{myfile.odt}. The file will be overwritten without warning. If there | 10842 | @file{myfile.odt}. The file will be overwritten without warning. If there |
| 10851 | is an active region,@footnote{This requires @code{transient-mark-mode} to be | 10843 | is an active region,@footnote{This requires @code{transient-mark-mode} to be |
| 10852 | turned on} only the region will be exported. If the selected region is a | 10844 | turned on} only the region will be exported. If the selected region is a |
| @@ -10857,30 +10849,66 @@ export. | |||
| 10857 | 10849 | ||
| 10858 | @orgcmd{C-c C-e O,org-export-as-odt-and-open} | 10850 | @orgcmd{C-c C-e O,org-export-as-odt-and-open} |
| 10859 | Export as OpenDocument Text file and open the resulting file. | 10851 | Export as OpenDocument Text file and open the resulting file. |
| 10852 | |||
| 10860 | @vindex org-export-odt-preferred-output-format | 10853 | @vindex org-export-odt-preferred-output-format |
| 10861 | If @code{org-export-odt-preferred-output-format} is specified, open the | 10854 | If @code{org-export-odt-preferred-output-format} is specified, open the |
| 10862 | converted file instead. | 10855 | converted file instead. @xref{x-export-to-other-formats, , Automatically |
| 10863 | @xref{x-export-to-other-formats,,Automatically exporting to other formats}. | 10856 | exporting to other formats}. |
| 10864 | @end table | 10857 | @end table |
| 10865 | 10858 | ||
| 10866 | @subsubheading Automatically exporting to other formats | 10859 | @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export |
| 10860 | @subsection Extending ODT export | ||
| 10861 | |||
| 10862 | The ODT exporter can interface with a variety of document | ||
| 10863 | converters and supports popular converters out of the box. As a result, you | ||
| 10864 | can use it to export to formats like @samp{doc} or convert a document from | ||
| 10865 | one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}). | ||
| 10866 | |||
| 10867 | @cindex @file{unoconv} | ||
| 10868 | @cindex LibreOffice | ||
| 10869 | If you have a working installation of LibreOffice, a document converter is | ||
| 10870 | pre-configured for you and you can use it right away. If you would like to | ||
| 10871 | use @file{unoconv} as your preferred converter, customize the variable | ||
| 10872 | @code{org-export-odt-convert-process} to point to @code{unoconv}. If you | ||
| 10873 | would like to use a converter of your own choosing or tweak the default | ||
| 10874 | settings of the default @file{LibreOffice} and @samp{unoconv} converters | ||
| 10875 | @xref{Configuring a document converter}. | ||
| 10876 | |||
| 10877 | @subsubsection Automatically exporting to other formats | ||
| 10867 | @anchor{x-export-to-other-formats} | 10878 | @anchor{x-export-to-other-formats} |
| 10879 | |||
| 10868 | @vindex org-export-odt-preferred-output-format | 10880 | @vindex org-export-odt-preferred-output-format |
| 10869 | Very often, you will find yourself exporting to @acronym{ODT} format, only to | 10881 | Very often, you will find yourself exporting to ODT format, only to |
| 10870 | immediately save the exported document to a different format like @samp{pdf}. | 10882 | immediately save the exported document to other formats like @samp{doc}, |
| 10871 | In such cases, you will find it convenient to configure a converter | 10883 | @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your |
| 10872 | (@pxref{Exporting and converting to other formats}) and specify your | ||
| 10873 | preferred output format by customizing the variable | 10884 | preferred output format by customizing the variable |
| 10874 | @code{org-export-odt-preferred-output-format}. This way, the export commands | 10885 | @code{org-export-odt-preferred-output-format}. This way, the export commands |
| 10875 | (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to | 10886 | (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a |
| 10876 | the preferred format. | 10887 | format that is of immediate interest to you. |
| 10888 | |||
| 10889 | @subsubsection Converting between document formats | ||
| 10890 | @anchor{x-convert-to-other-formats} | ||
| 10891 | |||
| 10892 | There are many document converters in the wild which support conversion to | ||
| 10893 | and from various file formats, including, but not limited to the | ||
| 10894 | ODT format. LibreOffice converter, mentioned above, is one such | ||
| 10895 | converter. Once a converter is configured, you can interact with it using | ||
| 10896 | the following command. | ||
| 10877 | 10897 | ||
| 10878 | @node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export | 10898 | @vindex org-export-odt-convert |
| 10899 | @table @kbd | ||
| 10900 | |||
| 10901 | @item M-x org-export-odt-convert | ||
| 10902 | Convert an existing document from one format to another. With a prefix | ||
| 10903 | argument, also open the newly produced file. | ||
| 10904 | @end table | ||
| 10905 | |||
| 10906 | @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export | ||
| 10879 | @subsection Applying custom styles | 10907 | @subsection Applying custom styles |
| 10880 | @cindex styles, custom | 10908 | @cindex styles, custom |
| 10881 | @cindex template, custom | 10909 | @cindex template, custom |
| 10882 | 10910 | ||
| 10883 | The @acronym{ODT} exporter ships with a set of OpenDocument styles | 10911 | The ODT exporter ships with a set of OpenDocument styles |
| 10884 | (@pxref{Working with OpenDocument style files}) that ensure a well-formatted | 10912 | (@pxref{Working with OpenDocument style files}) that ensure a well-formatted |
| 10885 | output. These factory styles, however, may not cater to your specific | 10913 | output. These factory styles, however, may not cater to your specific |
| 10886 | tastes. To customize the output, you can either modify the above styles | 10914 | tastes. To customize the output, you can either modify the above styles |
| @@ -10893,7 +10921,7 @@ users alike, and is described here. | |||
| 10893 | @enumerate | 10921 | @enumerate |
| 10894 | @item | 10922 | @item |
| 10895 | Create a sample @file{example.org} file with the below settings and export it | 10923 | Create a sample @file{example.org} file with the below settings and export it |
| 10896 | to @acronym{ODT} format. | 10924 | to ODT format. |
| 10897 | 10925 | ||
| 10898 | @example | 10926 | @example |
| 10899 | #+OPTIONS: H:10 num:t | 10927 | #+OPTIONS: H:10 num:t |
| @@ -10936,15 +10964,22 @@ met, the output is going to be less than satisfactory. So it is highly | |||
| 10936 | recommended that you only work with templates that are directly derived from | 10964 | recommended that you only work with templates that are directly derived from |
| 10937 | the factory settings. | 10965 | the factory settings. |
| 10938 | 10966 | ||
| 10939 | @node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export | 10967 | @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export |
| 10940 | @subsection Links in @acronym{ODT} export | 10968 | @subsection Links in ODT export |
| 10941 | @cindex tables, in DocBook export | 10969 | @cindex tables, in DocBook export |
| 10942 | 10970 | ||
| 10943 | The @acronym{ODT} exporter creates cross-references (aka bookmarks) for | 10971 | ODT exporter creates native cross-references for internal links. It creates |
| 10944 | internal links. It creates Internet-style links for all other links. | 10972 | Internet-style links for all other links. |
| 10973 | |||
| 10974 | A link with no description and destined to a regular (un-itemized) outline | ||
| 10975 | heading is replaced with a cross-reference and section number of the heading. | ||
| 10945 | 10976 | ||
| 10946 | @node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export | 10977 | A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced |
| 10947 | @subsection Tables in @acronym{ODT} export | 10978 | with a cross-reference and sequence number of the labelled entity. |
| 10979 | @xref{Labels and captions in ODT export}. | ||
| 10980 | |||
| 10981 | @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export | ||
| 10982 | @subsection Tables in ODT export | ||
| 10948 | @cindex tables, in DocBook export | 10983 | @cindex tables, in DocBook export |
| 10949 | 10984 | ||
| 10950 | Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el} | 10985 | Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el} |
| @@ -10952,21 +10987,47 @@ tables is supported. However, export of complex @file{table.el} tables - | |||
| 10952 | tables that have column or row spans - is not supported. Such tables are | 10987 | tables that have column or row spans - is not supported. Such tables are |
| 10953 | stripped from the exported document. | 10988 | stripped from the exported document. |
| 10954 | 10989 | ||
| 10955 | By default, a table is exported with top and bottom frames and with | 10990 | By default, a table is exported with top and bottom frames and with rules |
| 10956 | rules separating row and column groups (@pxref{Column groups}). If the table | 10991 | separating row and column groups (@pxref{Column groups}). Furthermore, all |
| 10957 | specifies alignment and relative width for its columns (@pxref{Column width | 10992 | tables are typeset to occupy the same width. If the table specifies |
| 10958 | and alignment}) then these are honored on export.@footnote{The column widths | 10993 | alignment and relative width for its columns (@pxref{Column width and |
| 10959 | are interpreted as weighted ratios with the default weight being 1} | 10994 | alignment}) then these are honored on export.@footnote{The column widths are |
| 10995 | interpreted as weighted ratios with the default weight being 1} | ||
| 10960 | 10996 | ||
| 10961 | @cindex #+ATTR_ODT | 10997 | @cindex #+ATTR_ODT |
| 10962 | If you are not satisfied with the default formatting of tables, you can | 10998 | You can control the width of the table by specifying @code{:rel-width} |
| 10963 | create custom table styles and associate them with a table using | 10999 | property using an @code{#+ATTR_ODT} line. |
| 10964 | the @code{#+ATTR_ODT} line. @xref{Customizing tables in @acronym{ODT} export}. | 11000 | |
| 11001 | For example, consider the following table which makes use of all the rules | ||
| 11002 | mentoned above. | ||
| 11003 | |||
| 11004 | @example | ||
| 11005 | #+ATTR_ODT: :rel-width 50 | ||
| 11006 | | Area/Month | Jan | Feb | Mar | Sum | | ||
| 11007 | |---------------+-------+-------+-------+-------| | ||
| 11008 | | / | < | | | < | | ||
| 11009 | | <l13> | <r5> | <r5> | <r5> | <r6> | | ||
| 11010 | | North America | 1 | 21 | 926 | 948 | | ||
| 11011 | | Middle East | 6 | 75 | 844 | 925 | | ||
| 11012 | | Asia Pacific | 9 | 27 | 790 | 826 | | ||
| 11013 | |---------------+-------+-------+-------+-------| | ||
| 11014 | | Sum | 16 | 123 | 2560 | 2699 | | ||
| 11015 | @end example | ||
| 11016 | |||
| 11017 | On export, the table will occupy 50% of text area. The columns will be sized | ||
| 11018 | (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned | ||
| 11019 | and rest of the columns will be right-aligned. There will be vertical rules | ||
| 11020 | after separating the header and last columns from other columns. There will | ||
| 11021 | be horizontal rules separating the header and last rows from other rows. | ||
| 11022 | |||
| 11023 | If you are not satisfied with the above formatting options, you can create | ||
| 11024 | custom table styles and associate them with a table using the | ||
| 11025 | @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}. | ||
| 10965 | 11026 | ||
| 10966 | @node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export | 11027 | @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export |
| 10967 | @subsection Images in @acronym{ODT} export | 11028 | @subsection Images in ODT export |
| 10968 | @cindex images, embedding in @acronym{ODT} | 11029 | @cindex images, embedding in ODT |
| 10969 | @cindex embedding images in @acronym{ODT} | 11030 | @cindex embedding images in ODT |
| 10970 | 11031 | ||
| 10971 | @subsubheading Embedding images | 11032 | @subsubheading Embedding images |
| 10972 | You can embed images within the exported document by providing a link to the | 11033 | You can embed images within the exported document by providing a link to the |
| @@ -10993,14 +11054,21 @@ link to an image file. For example, to embed a image | |||
| 10993 | 11054 | ||
| 10994 | @subsubheading Sizing and scaling of embedded images | 11055 | @subsubheading Sizing and scaling of embedded images |
| 10995 | 11056 | ||
| 11057 | @cindex #+ATTR_ODT | ||
| 10996 | You can control the size and scale of the embedded images using the | 11058 | You can control the size and scale of the embedded images using the |
| 10997 | @code{#+ATTR_ODT} attribute. | 11059 | @code{#+ATTR_ODT} attribute. |
| 10998 | 11060 | ||
| 11061 | @cindex identify, ImageMagick | ||
| 10999 | @vindex org-export-odt-pixels-per-inch | 11062 | @vindex org-export-odt-pixels-per-inch |
| 11000 | Note that the exporter specifies the desired size of the image in the final | 11063 | The exporter specifies the desired size of the image in the final document in |
| 11001 | document in units of centimeters. In order to scale the embedded images, the | 11064 | units of centimeters. In order to scale the embedded images, the exporter |
| 11002 | exporter needs to compute the size of the image. This is done by retrieving | 11065 | queries for pixel dimensions of the images using one of a) ImageMagick's |
| 11003 | the image size in pixels and converting the pixel units to centimeters using | 11066 | @file{identify} program or b) Emacs `create-image' and `image-size' |
| 11067 | APIs.@footnote{Use of @file{ImageMagick} is only desirable. However, if you | ||
| 11068 | routinely produce documents that have large images or you export your Org | ||
| 11069 | files that has images using a Emacs batch script, then the use of | ||
| 11070 | @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently | ||
| 11071 | converted in to units of centimeters using | ||
| 11004 | @code{org-export-odt-pixels-per-inch}. The default value of this variable is | 11072 | @code{org-export-odt-pixels-per-inch}. The default value of this variable is |
| 11005 | set to @code{display-pixels-per-inch}. You can tweak this variable to | 11073 | set to @code{display-pixels-per-inch}. You can tweak this variable to |
| 11006 | achieve the best results. | 11074 | achieve the best results. |
| @@ -11008,7 +11076,6 @@ achieve the best results. | |||
| 11008 | The examples below illustrate the various possibilities. | 11076 | The examples below illustrate the various possibilities. |
| 11009 | 11077 | ||
| 11010 | @table @asis | 11078 | @table @asis |
| 11011 | |||
| 11012 | @item Explicitly size the image | 11079 | @item Explicitly size the image |
| 11013 | To embed @file{img.png} as a 10 cm x 10 cm image, do the following: | 11080 | To embed @file{img.png} as a 10 cm x 10 cm image, do the following: |
| 11014 | 11081 | ||
| @@ -11044,17 +11111,31 @@ height:width ratio, do the following | |||
| 11044 | @end example | 11111 | @end example |
| 11045 | @end table | 11112 | @end table |
| 11046 | 11113 | ||
| 11047 | @node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export | 11114 | @subsubheading Anchoring of images |
| 11048 | @subsection Math formatting in @acronym{ODT} export | 11115 | |
| 11116 | @cindex #+ATTR_ODT | ||
| 11117 | You can control the manner in which an image is anchored by setting the | ||
| 11118 | @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one | ||
| 11119 | of the the following three values for the @code{:anchor} property - | ||
| 11120 | @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}. | ||
| 11121 | |||
| 11122 | To create an image that is anchored to a page, do the following: | ||
| 11123 | @example | ||
| 11124 | #+ATTR_ODT: :anchor "page" | ||
| 11125 | [[./img.png]] | ||
| 11126 | @end example | ||
| 11127 | |||
| 11128 | @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export | ||
| 11129 | @subsection Math formatting in ODT export | ||
| 11049 | 11130 | ||
| 11050 | The @acronym{ODT} exporter has special support for handling math. | 11131 | The ODT exporter has special support for handling math. |
| 11051 | 11132 | ||
| 11052 | @menu | 11133 | @menu |
| 11053 | * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments | 11134 | * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments |
| 11054 | * Working with MathML or OpenDocument formula files:: How to embed equations in native format | 11135 | * Working with MathML or OpenDocument formula files:: How to embed equations in native format |
| 11055 | @end menu | 11136 | @end menu |
| 11056 | 11137 | ||
| 11057 | @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in @acronym{ODT} export, Math formatting in @acronym{ODT} export | 11138 | @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export |
| 11058 | @subsubsection Working with @LaTeX{} math snippets | 11139 | @subsubsection Working with @LaTeX{} math snippets |
| 11059 | 11140 | ||
| 11060 | @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT | 11141 | @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT |
| @@ -11120,11 +11201,11 @@ resulting images are embedded in the exported document. This method requires | |||
| 11120 | that the @file{dvipng} program be available on your system. | 11201 | that the @file{dvipng} program be available on your system. |
| 11121 | @end enumerate | 11202 | @end enumerate |
| 11122 | 11203 | ||
| 11123 | @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export | 11204 | @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export |
| 11124 | @subsubsection Working with MathML or OpenDocument formula files | 11205 | @subsubsection Working with MathML or OpenDocument formula files |
| 11125 | 11206 | ||
| 11126 | For various reasons, you may find embedding @LaTeX{} math snippets in an | 11207 | For various reasons, you may find embedding @LaTeX{} math snippets in an |
| 11127 | @acronym{ODT} document less than reliable. In that case, you can embed a | 11208 | ODT document less than reliable. In that case, you can embed a |
| 11128 | math equation by linking to its MathML(@file{.mml}) source or its | 11209 | math equation by linking to its MathML(@file{.mml}) source or its |
| 11129 | OpenDocument formula (@file{.odf}) file as shown below: | 11210 | OpenDocument formula (@file{.odf}) file as shown below: |
| 11130 | 11211 | ||
| @@ -11138,102 +11219,95 @@ or | |||
| 11138 | [[./equation.odf]] | 11219 | [[./equation.odf]] |
| 11139 | @end example | 11220 | @end example |
| 11140 | 11221 | ||
| 11141 | @node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export | 11222 | @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export |
| 11142 | @subsection Literal examples in @acronym{ODT} export | 11223 | @subsection Labels and captions in ODT export |
| 11143 | 11224 | ||
| 11144 | Export of literal examples (@pxref{Literal examples}) with full fontification | 11225 | You can label and caption various category of objects - an inline image, a |
| 11145 | is supported. This feature is enabled by default and is activated | 11226 | table, a @LaTeX{} fragment or a Math formula - using @code{#+LABEL} and |
| 11146 | automatically if an enhanced version of @file{htmlfontify.el} is available in | 11227 | @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates |
| 11147 | the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with | 11228 | each labelled or captioned object of a given category separately. As a |
| 11148 | standard Emacs <= 24.1 has no support for @acronym{ODT} fontification. A | 11229 | result, each such object is assigned a sequence number based on order of it's |
| 11149 | copy of the proposed version is available as an attachment to | 11230 | appearance in the Org file. |
| 11150 | @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914, | ||
| 11151 | Emacs Bug #9914}.} | ||
| 11152 | 11231 | ||
| 11153 | @vindex org-export-odt-fontify-srcblocks | 11232 | In the exported document, a user-provided caption is augmented with the |
| 11233 | category and sequence number. Consider the following inline image in an Org | ||
| 11234 | file. | ||
| 11235 | |||
| 11236 | @example | ||
| 11237 | #+CAPTION: Bell curve | ||
| 11238 | #+LABEL: fig:SED-HR4049 | ||
| 11239 | [[./img/a.png]] | ||
| 11240 | @end example | ||
| 11154 | 11241 | ||
| 11155 | The character styles used for fontification of the literal blocks are | 11242 | It could be rendered as shown below in the exported document. |
| 11156 | auto-generated by the exporter in conjunction with @file{htmlfontify.el} | ||
| 11157 | library and need not be included in the default @file{styles.xml} file. | ||
| 11158 | These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color | ||
| 11159 | based on the face used by Emacs @code{font-lock} library. | ||
| 11160 | 11243 | ||
| 11161 | @vindex org-export-odt-create-custom-styles-for-srcblocks | 11244 | @example |
| 11162 | If you prefer to use your own custom styles for fontification and disable | 11245 | Figure 2: Bell curve |
| 11163 | their auto-generation altogether, you can do so by customizing the variable | 11246 | @end example |
| 11164 | @code{org-export-odt-create-custom-styles-for-srcblocks}. | 11247 | |
| 11248 | @vindex org-export-odt-category-strings | ||
| 11249 | You can modify the category component of the caption by customizing the | ||
| 11250 | variable @code{org-export-odt-category-strings}. For example, to tag all | ||
| 11251 | embedded images with the string @samp{Illustration} (instead of the default | ||
| 11252 | @samp{Figure}) use the following setting. | ||
| 11253 | |||
| 11254 | @lisp | ||
| 11255 | (setq org-export-odt-category-strings | ||
| 11256 | '(("en" "Table" "Illustration" "Equation" "Equation"))) | ||
| 11257 | @end lisp | ||
| 11165 | 11258 | ||
| 11166 | You can turn off fontification support for literal examples by customizing | 11259 | With this, previous image will be captioned as below in the exported |
| 11167 | the variable @code{org-export-odt-fontify-srcblocks}. | 11260 | document. |
| 11168 | 11261 | ||
| 11262 | @example | ||
| 11263 | Illustration 2: Bell curve | ||
| 11264 | @end example | ||
| 11265 | |||
| 11266 | @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export | ||
| 11267 | @subsection Literal examples in ODT export | ||
| 11169 | 11268 | ||
| 11170 | @node Advanced topics in @acronym{ODT} export, , Literal examples in @acronym{ODT} export, OpenDocument Text export | 11269 | Export of literal examples (@pxref{Literal examples}) with full fontification |
| 11171 | @subsection Advanced topics in @acronym{ODT} export | 11270 | is supported. Internally, the exporter relies on @file{htmlfontify.el} to |
| 11271 | generate all style definitions needed for a fancy listing.@footnote{Your | ||
| 11272 | @file{htmlfontify.el} library must atleast be at Emacs 24.1 levels for | ||
| 11273 | fontification to be turned on.} The auto-generated styles have @samp{OrgSrc} | ||
| 11274 | as prefix and inherit their color from the faces used by Emacs | ||
| 11275 | @code{font-lock} library for the source language. | ||
| 11172 | 11276 | ||
| 11173 | If you rely heavily on @acronym{ODT} export, you may want to exploit the full | 11277 | @vindex org-export-odt-fontify-srcblocks |
| 11278 | If you prefer to use your own custom styles for fontification, you can do so | ||
| 11279 | by customizing the variable | ||
| 11280 | @code{org-export-odt-create-custom-styles-for-srcblocks}. | ||
| 11281 | |||
| 11282 | @vindex org-export-odt-create-custom-styles-for-srcblocks | ||
| 11283 | You can turn off fontification of literal examples by customizing the | ||
| 11284 | variable @code{org-export-odt-fontify-srcblocks}. | ||
| 11285 | |||
| 11286 | @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export | ||
| 11287 | @subsection Advanced topics in ODT export | ||
| 11288 | |||
| 11289 | If you rely heavily on ODT export, you may want to exploit the full | ||
| 11174 | set of features that the exporter offers. This section describes features | 11290 | set of features that the exporter offers. This section describes features |
| 11175 | that would be of interest to power users. | 11291 | that would be of interest to power users. |
| 11176 | 11292 | ||
| 11177 | @menu | 11293 | @menu |
| 11178 | * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats | 11294 | * Configuring a document converter:: How to register a document converter |
| 11179 | * Working with OpenDocument style files:: Explore the internals | 11295 | * Working with OpenDocument style files:: Explore the internals |
| 11180 | * Creating one-off styles:: How to produce custom highlighting etc | 11296 | * Creating one-off styles:: How to produce custom highlighting etc |
| 11181 | * Customizing tables in @acronym{ODT} export:: How to define and use Table templates | 11297 | * Customizing tables in ODT export:: How to define and use Table templates |
| 11182 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files | 11298 | * Validating OpenDocument XML:: How to debug corrupt OpenDocument files |
| 11183 | @end menu | 11299 | @end menu |
| 11184 | 11300 | ||
| 11185 | @node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export | 11301 | @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export |
| 11186 | @subsubsection Exporting and converting to other formats | 11302 | @subsubsection Configuring a document converter |
| 11187 | @cindex convert | 11303 | @cindex convert |
| 11188 | @cindex doc, docx | 11304 | @cindex doc, docx, rtf |
| 11189 | |||
| 11190 | The @acronym{ODT} exporter adds support for exporting Org outlines to formats | ||
| 11191 | that are not supported natively by Org. It also adds support to convert | ||
| 11192 | document from one format to another. To use these features, you need to | ||
| 11193 | configure a command-line converter. Once a command-line converter is | ||
| 11194 | configured you can use it to extend the list of formats to which Org can | ||
| 11195 | export. @xref{x-export-to-other-formats,,Automatically exporting to other | ||
| 11196 | formats}. You can also use it to perform one-off document conversion as | ||
| 11197 | detailed below. | ||
| 11198 | |||
| 11199 | @vindex org-export-odt-convert | ||
| 11200 | @table @kbd | ||
| 11201 | |||
| 11202 | @item M-x org-export-odt-convert | ||
| 11203 | Convert an existing document from one format to another as determined by the | ||
| 11204 | variable @code{org-export-odt-convert-capabilities} | ||
| 11205 | (@pxref{x-odt-converter-capabilities,,Configure converter | ||
| 11206 | capabilities}). @strong{Please note} that you can use this command to even | ||
| 11207 | convert documents that are produced outside of Org and in other formats than | ||
| 11208 | @acronym{ODT} format. | ||
| 11209 | @end table | ||
| 11210 | |||
| 11211 | @subsubheading Pre-configured converters | ||
| 11212 | |||
| 11213 | @cindex converter | 11305 | @cindex converter |
| 11214 | The @acronym{ODT} exporter supports two converters out of the box: | ||
| 11215 | |||
| 11216 | @enumerate | ||
| 11217 | |||
| 11218 | @cindex @file{unoconv} | ||
| 11219 | @item @file{unoconv} | ||
| 11220 | |||
| 11221 | This converter is available as an installable package in your favorite | ||
| 11222 | distribution. | ||
| 11223 | |||
| 11224 | @cindex @file{BasicODConverter} | ||
| 11225 | @item @file{BasicODConverter} | ||
| 11226 | 11306 | ||
| 11227 | @vindex org-odt-data-dir | 11307 | The ODT exporter can work with popular converters with little or no |
| 11228 | This converter is distributed as a LibreOffice extension and can be found in | 11308 | extra configuration from your side. @xref{Extending ODT export}. |
| 11229 | your Org distribution. See the subdirectory pointed to by the variable | 11309 | If you are using a converter that is not supported by default or if you would |
| 11230 | @code{org-odt-data-dir}. | 11310 | like to tweak the default converter settings, proceed as below. |
| 11231 | |||
| 11232 | @end enumerate | ||
| 11233 | |||
| 11234 | @subsubheading Installing a new converter | ||
| 11235 | If you prefer to use a converter other than the two mentioned above, then you | ||
| 11236 | may have to do additional configuration. You can proceed as follows: | ||
| 11237 | 11311 | ||
| 11238 | @enumerate | 11312 | @enumerate |
| 11239 | @item Register the converter | 11313 | @item Register the converter |
| @@ -11262,12 +11336,12 @@ Select the newly added converter as the preferred one by customizing the | |||
| 11262 | variable @code{org-export-odt-convert-process}. | 11336 | variable @code{org-export-odt-convert-process}. |
| 11263 | @end enumerate | 11337 | @end enumerate |
| 11264 | 11338 | ||
| 11265 | @node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export | 11339 | @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export |
| 11266 | @subsubsection Working with OpenDocument style files | 11340 | @subsubsection Working with OpenDocument style files |
| 11267 | @cindex styles, custom | 11341 | @cindex styles, custom |
| 11268 | @cindex template, custom | 11342 | @cindex template, custom |
| 11269 | 11343 | ||
| 11270 | This section explores the internals of the @acronym{ODT} exporter and the | 11344 | This section explores the internals of the ODT exporter and the |
| 11271 | means by which it produces styled documents. Read this section if you are | 11345 | means by which it produces styled documents. Read this section if you are |
| 11272 | interested in exploring the automatic and custom OpenDocument styles used by | 11346 | interested in exploring the automatic and custom OpenDocument styles used by |
| 11273 | the exporter. | 11347 | the exporter. |
| @@ -11275,7 +11349,7 @@ the exporter. | |||
| 11275 | @anchor{x-factory-styles} | 11349 | @anchor{x-factory-styles} |
| 11276 | @subsubheading Factory styles | 11350 | @subsubheading Factory styles |
| 11277 | 11351 | ||
| 11278 | The @acronym{ODT} exporter relies on two files for generating its output. | 11352 | The ODT exporter relies on two files for generating its output. |
| 11279 | These files are bundled with the distribution under the directory pointed to | 11353 | These files are bundled with the distribution under the directory pointed to |
| 11280 | by the variable @code{org-odt-styles-dir}. The two files are: | 11354 | by the variable @code{org-odt-styles-dir}. The two files are: |
| 11281 | 11355 | ||
| @@ -11321,7 +11395,7 @@ are numbered. | |||
| 11321 | 11395 | ||
| 11322 | @anchor{x-overriding-factory-styles} | 11396 | @anchor{x-overriding-factory-styles} |
| 11323 | @subsubheading Overriding factory styles | 11397 | @subsubheading Overriding factory styles |
| 11324 | The following two variables control the location from which the @acronym{ODT} | 11398 | The following two variables control the location from which the ODT |
| 11325 | exporter picks up the custom styles and content template files. You can | 11399 | exporter picks up the custom styles and content template files. You can |
| 11326 | customize these variables to override the factory styles used by the | 11400 | customize these variables to override the factory styles used by the |
| 11327 | exporter. | 11401 | exporter. |
| @@ -11366,7 +11440,7 @@ Use this variable to specify the blank @file{content.xml} that will be used | |||
| 11366 | in the final output. | 11440 | in the final output. |
| 11367 | @end itemize | 11441 | @end itemize |
| 11368 | 11442 | ||
| 11369 | @node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export | 11443 | @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export |
| 11370 | @subsubsection Creating one-off styles | 11444 | @subsubsection Creating one-off styles |
| 11371 | 11445 | ||
| 11372 | There are times when you would want one-off formatting in the exported | 11446 | There are times when you would want one-off formatting in the exported |
| @@ -11433,14 +11507,14 @@ This paragraph is specially formatted and uses bold text. | |||
| 11433 | 11507 | ||
| 11434 | @end enumerate | 11508 | @end enumerate |
| 11435 | 11509 | ||
| 11436 | @node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export | 11510 | @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export |
| 11437 | @subsubsection Customizing tables in @acronym{ODT} export | 11511 | @subsubsection Customizing tables in ODT export |
| 11438 | @cindex tables, in ODT export | 11512 | @cindex tables, in ODT export |
| 11439 | 11513 | ||
| 11440 | @cindex #+ATTR_ODT | 11514 | @cindex #+ATTR_ODT |
| 11441 | You can override the default formatting of the table by specifying a custom | 11515 | You can override the default formatting of the table by specifying a custom |
| 11442 | table style with the @code{#+ATTR_ODT} line. For a discussion on default | 11516 | table style with the @code{#+ATTR_ODT} line. For a discussion on default |
| 11443 | formatting of tables @pxref{Tables in @acronym{ODT} export}. | 11517 | formatting of tables @pxref{Tables in ODT export}. |
| 11444 | 11518 | ||
| 11445 | This feature closely mimics the way table templates are defined in the | 11519 | This feature closely mimics the way table templates are defined in the |
| 11446 | OpenDocument-v1.2 | 11520 | OpenDocument-v1.2 |
| @@ -11466,7 +11540,7 @@ the table that follows. | |||
| 11466 | @end lisp | 11540 | @end lisp |
| 11467 | 11541 | ||
| 11468 | @example | 11542 | @example |
| 11469 | #+ATTR_ODT: TableWithHeaderRowAndColumn | 11543 | #+ATTR_ODT: :style "TableWithHeaderRowAndColumn" |
| 11470 | | Name | Phone | Age | | 11544 | | Name | Phone | Age | |
| 11471 | | Peter | 1234 | 17 | | 11545 | | Peter | 1234 | 17 | |
| 11472 | | Anna | 4321 | 25 | | 11546 | | Anna | 4321 | 25 | |
| @@ -11571,9 +11645,9 @@ To define a table style, create an entry for the style in the variable | |||
| 11571 | @end itemize | 11645 | @end itemize |
| 11572 | 11646 | ||
| 11573 | For example, the entry below defines two different table styles | 11647 | For example, the entry below defines two different table styles |
| 11574 | @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based | 11648 | @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow} |
| 11575 | on the same template @samp{Custom}. The styles achieve their intended effect | 11649 | based on the same template @samp{Custom}. The styles achieve their intended |
| 11576 | by selectively activating the individual cell styles in that template. | 11650 | effect by selectively activating the individual cell styles in that template. |
| 11577 | 11651 | ||
| 11578 | @lisp | 11652 | @lisp |
| 11579 | (setq org-export-odt-table-styles | 11653 | (setq org-export-odt-table-styles |
| @@ -11593,18 +11667,18 @@ To do this, specify the table style created in step (2) as part of | |||
| 11593 | the @code{ATTR_ODT} line as shown below. | 11667 | the @code{ATTR_ODT} line as shown below. |
| 11594 | 11668 | ||
| 11595 | @example | 11669 | @example |
| 11596 | #+ATTR_ODT: TableWithHeaderRowAndColumn | 11670 | #+ATTR_ODT: :style "TableWithHeaderRowAndColumn" |
| 11597 | | Name | Phone | Age | | 11671 | | Name | Phone | Age | |
| 11598 | | Peter | 1234 | 17 | | 11672 | | Peter | 1234 | 17 | |
| 11599 | | Anna | 4321 | 25 | | 11673 | | Anna | 4321 | 25 | |
| 11600 | @end example | 11674 | @end example |
| 11601 | @end enumerate | 11675 | @end enumerate |
| 11602 | 11676 | ||
| 11603 | @node Validating OpenDocument XML, , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export | 11677 | @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export |
| 11604 | @subsubsection Validating OpenDocument XML | 11678 | @subsubsection Validating OpenDocument XML |
| 11605 | 11679 | ||
| 11606 | Occasionally, you will discover that the document created by the | 11680 | Occasionally, you will discover that the document created by the |
| 11607 | @acronym{ODT} exporter cannot be opened by your favorite application. One of | 11681 | ODT exporter cannot be opened by your favorite application. One of |
| 11608 | the common reasons for this is that the @file{.odt} file is corrupt. In such | 11682 | the common reasons for this is that the @file{.odt} file is corrupt. In such |
| 11609 | cases, you may want to validate the document against the OpenDocument RELAX | 11683 | cases, you may want to validate the document against the OpenDocument RELAX |
| 11610 | NG Compact Syntax (RNC) schema. | 11684 | NG Compact Syntax (RNC) schema. |
| @@ -11618,7 +11692,7 @@ general help with validation (and schema-sensitive editing) of XML files: | |||
| 11618 | If you have ready access to OpenDocument @file{.rnc} files and the needed | 11692 | If you have ready access to OpenDocument @file{.rnc} files and the needed |
| 11619 | schema-locating rules in a single folder, you can customize the variable | 11693 | schema-locating rules in a single folder, you can customize the variable |
| 11620 | @code{org-export-odt-schema-dir} to point to that directory. The | 11694 | @code{org-export-odt-schema-dir} to point to that directory. The |
| 11621 | @acronym{ODT} exporter will take care of updating the | 11695 | ODT exporter will take care of updating the |
| 11622 | @code{rng-schema-locating-files} for you. | 11696 | @code{rng-schema-locating-files} for you. |
| 11623 | 11697 | ||
| 11624 | @c end opendocument | 11698 | @c end opendocument |
| @@ -12622,17 +12696,24 @@ of tangled code files. | |||
| 12622 | @section Evaluating code blocks | 12696 | @section Evaluating code blocks |
| 12623 | @cindex code block, evaluating | 12697 | @cindex code block, evaluating |
| 12624 | @cindex source code, evaluating | 12698 | @cindex source code, evaluating |
| 12699 | @cindex #+RESULTS | ||
| 12625 | 12700 | ||
| 12626 | Code blocks can be evaluated@footnote{Whenever code is evaluated there is a | 12701 | Code blocks can be evaluated@footnote{Whenever code is evaluated there is a |
| 12627 | potential for that code to do harm. Org mode provides safeguards to ensure | 12702 | potential for that code to do harm. Org mode provides safeguards to ensure |
| 12628 | that code is only evaluated after explicit confirmation from the user. For | 12703 | that code is only evaluated after explicit confirmation from the user. For |
| 12629 | information on these safeguards (and on how to disable them) see @ref{Code | 12704 | information on these safeguards (and on how to disable them) see @ref{Code |
| 12630 | evaluation security}.} and the results of evaluation optionally placed in the | 12705 | evaluation security}.} and the results of evaluation optionally placed in the |
| 12631 | Org mode buffer. By default, the evaluation facility is only enabled for | 12706 | Org mode buffer. The results of evaluation are placed following a line that |
| 12632 | Lisp code blocks specified as @code{emacs-lisp}. However, source code blocks | 12707 | begins by default with @code{#+RESULTS} and optionally a cache identifier |
| 12633 | in many languages can be evaluated within Org mode (see @ref{Languages} for a | 12708 | and/or the name of the evaluated code block. The default value of |
| 12634 | list of supported languages and @ref{Structure of code blocks} for | 12709 | @code{#+RESULTS} can be changed with the customizable variable |
| 12635 | information on the syntax used to define a code block). | 12710 | @code{org-babel-results-keyword}. |
| 12711 | |||
| 12712 | By default, the evaluation facility is only enabled for Lisp code blocks | ||
| 12713 | specified as @code{emacs-lisp}. However, source code blocks in many languages | ||
| 12714 | can be evaluated within Org mode (see @ref{Languages} for a list of supported | ||
| 12715 | languages and @ref{Structure of code blocks} for information on the syntax | ||
| 12716 | used to define a code block). | ||
| 12636 | 12717 | ||
| 12637 | @kindex C-c C-c | 12718 | @kindex C-c C-c |
| 12638 | There are a number of ways to evaluate code blocks. The simplest is to press | 12719 | There are a number of ways to evaluate code blocks. The simplest is to press |
| @@ -13000,6 +13081,7 @@ argument in lowercase letters. The following header arguments are defined: | |||
| 13000 | * session:: Preserve the state of code evaluation | 13081 | * session:: Preserve the state of code evaluation |
| 13001 | * noweb:: Toggle expansion of noweb references | 13082 | * noweb:: Toggle expansion of noweb references |
| 13002 | * noweb-ref:: Specify block's noweb reference resolution target | 13083 | * noweb-ref:: Specify block's noweb reference resolution target |
| 13084 | * noweb-sep:: String used to separate noweb references | ||
| 13003 | * cache:: Avoid re-evaluating unchanged code blocks | 13085 | * cache:: Avoid re-evaluating unchanged code blocks |
| 13004 | * sep:: Delimiter for writing tabular results outside Org | 13086 | * sep:: Delimiter for writing tabular results outside Org |
| 13005 | * hlines:: Handle horizontal lines in tables | 13087 | * hlines:: Handle horizontal lines in tables |
| @@ -13351,9 +13433,9 @@ The result is converted to pretty-printed code and is enclosed in a code | |||
| 13351 | block. This option currently supports Emacs Lisp, Python, and Ruby. E.g., | 13433 | block. This option currently supports Emacs Lisp, Python, and Ruby. E.g., |
| 13352 | @code{:results value pp}. | 13434 | @code{:results value pp}. |
| 13353 | @item @code{wrap} | 13435 | @item @code{wrap} |
| 13354 | The result is wrapped in a @code{begin_result} block. This can be useful for | 13436 | The result is wrapped in a RESULTS drawer. This can be useful for |
| 13355 | inserting @code{raw} or @code{org} syntax results in such a way that their | 13437 | inserting @code{raw} or @code{org} syntax results in such a way that their |
| 13356 | extend is known and they can be automatically removed or replaced. | 13438 | extent is known and they can be automatically removed or replaced. |
| 13357 | @end itemize | 13439 | @end itemize |
| 13358 | 13440 | ||
| 13359 | @subsubheading Handling | 13441 | @subsubheading Handling |
| @@ -13583,9 +13665,8 @@ argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}. | |||
| 13583 | All ``noweb'' syntax references in the body of the code block will be | 13665 | All ``noweb'' syntax references in the body of the code block will be |
| 13584 | expanded before the block is evaluated, tangled or exported. | 13666 | expanded before the block is evaluated, tangled or exported. |
| 13585 | @item @code{no} | 13667 | @item @code{no} |
| 13586 | The default. No ``noweb'' syntax specific action is taken on evaluating | 13668 | The default. No ``noweb'' syntax specific action is taken when the code |
| 13587 | code blocks, However, noweb references will still be expanded during | 13669 | block is evaluated, tangled or exported. |
| 13588 | tangling. | ||
| 13589 | @item @code{tangle} | 13670 | @item @code{tangle} |
| 13590 | All ``noweb'' syntax references in the body of the code block will be | 13671 | All ``noweb'' syntax references in the body of the code block will be |
| 13591 | expanded before the block is tangled, however ``noweb'' references will not | 13672 | expanded before the block is tangled, however ``noweb'' references will not |
| @@ -13617,7 +13698,7 @@ Note that noweb replacement text that does not contain any newlines will not | |||
| 13617 | be affected by this change, so it is still possible to use inline noweb | 13698 | be affected by this change, so it is still possible to use inline noweb |
| 13618 | references. | 13699 | references. |
| 13619 | 13700 | ||
| 13620 | @node noweb-ref, cache, noweb, Specific header arguments | 13701 | @node noweb-ref, noweb-sep, noweb, Specific header arguments |
| 13621 | @subsubsection @code{:noweb-ref} | 13702 | @subsubsection @code{:noweb-ref} |
| 13622 | When expanding ``noweb'' style references the bodies of all code block with | 13703 | When expanding ``noweb'' style references the bodies of all code block with |
| 13623 | @emph{either} a block name matching the reference name @emph{or} a | 13704 | @emph{either} a block name matching the reference name @emph{or} a |
| @@ -13661,13 +13742,27 @@ inheritance}).}. | |||
| 13661 | #+END_SRC | 13742 | #+END_SRC |
| 13662 | @end example | 13743 | @end example |
| 13663 | 13744 | ||
| 13664 | @node cache, sep, noweb-ref, Specific header arguments | 13745 | The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string |
| 13746 | used to separate accumulate noweb references like those above. By default a | ||
| 13747 | newline is used. | ||
| 13748 | |||
| 13749 | @node noweb-sep, cache, noweb-ref, Specific header arguments | ||
| 13750 | @subsubsection @code{:noweb-sep} | ||
| 13751 | |||
| 13752 | The @code{:noweb-sep} header argument holds the string used to separate | ||
| 13753 | accumulate noweb references (see @ref{noweb-ref}). By default a newline is | ||
| 13754 | used. | ||
| 13755 | |||
| 13756 | @node cache, sep, noweb-sep, Specific header arguments | ||
| 13665 | @subsubsection @code{:cache} | 13757 | @subsubsection @code{:cache} |
| 13666 | 13758 | ||
| 13667 | The @code{:cache} header argument controls the use of in-buffer caching of | 13759 | The @code{:cache} header argument controls the use of in-buffer caching of |
| 13668 | the results of evaluating code blocks. It can be used to avoid re-evaluating | 13760 | the results of evaluating code blocks. It can be used to avoid re-evaluating |
| 13669 | unchanged code blocks. This header argument can have one of two | 13761 | unchanged code blocks. Note that the @code{:cache} header argument will not |
| 13670 | values: @code{yes} or @code{no}. | 13762 | attempt to cache results when the @code{:session} header argument is used, |
| 13763 | because the results of the code block execution may be stored in the session | ||
| 13764 | outside of the Org-mode buffer. The @code{:cache} header argument can have | ||
| 13765 | one of two values: @code{yes} or @code{no}. | ||
| 13671 | 13766 | ||
| 13672 | @itemize @bullet | 13767 | @itemize @bullet |
| 13673 | @item @code{no} | 13768 | @item @code{no} |
| @@ -14004,6 +14099,14 @@ evaluation. If @code{:noweb no}, the default, then the reference is not | |||
| 14004 | expanded before evaluation. See the @ref{noweb-ref} header argument for | 14099 | expanded before evaluation. See the @ref{noweb-ref} header argument for |
| 14005 | a more flexible way to resolve noweb references. | 14100 | a more flexible way to resolve noweb references. |
| 14006 | 14101 | ||
| 14102 | It is possible to include the @emph{results} of a code block rather than the | ||
| 14103 | body. This is done by appending parenthesis to the code block name which may | ||
| 14104 | optionally contain arguments to the code block as shown below. | ||
| 14105 | |||
| 14106 | @example | ||
| 14107 | <<code-block-name(optional arguments)>> | ||
| 14108 | @end example | ||
| 14109 | |||
| 14007 | Note: the default value, @code{:noweb no}, was chosen to ensure that | 14110 | Note: the default value, @code{:noweb no}, was chosen to ensure that |
| 14008 | correct code is not broken in a language, such as Ruby, where | 14111 | correct code is not broken in a language, such as Ruby, where |
| 14009 | @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not | 14112 | @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not |
| @@ -14040,34 +14143,72 @@ are active: | |||
| 14040 | In an Org mode buffer, the following key bindings are active: | 14143 | In an Org mode buffer, the following key bindings are active: |
| 14041 | 14144 | ||
| 14042 | @multitable @columnfractions 0.45 0.55 | 14145 | @multitable @columnfractions 0.45 0.55 |
| 14043 | @kindex C-c C-v a | 14146 | @kindex C-c C-v p |
| 14044 | @kindex C-c C-v C-a | 14147 | @kindex C-c C-v C-p |
| 14045 | @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} | 14148 | @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block} |
| 14149 | @kindex C-c C-v n | ||
| 14150 | @kindex C-c C-v C-n | ||
| 14151 | @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block} | ||
| 14152 | @kindex C-c C-v e | ||
| 14153 | @kindex C-c C-v C-e | ||
| 14154 | @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe} | ||
| 14155 | @kindex C-c C-v o | ||
| 14156 | @kindex C-c C-v C-o | ||
| 14157 | @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result} | ||
| 14158 | @kindex C-c C-v v | ||
| 14159 | @kindex C-c C-v C-v | ||
| 14160 | @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block} | ||
| 14161 | @kindex C-c C-v u | ||
| 14162 | @kindex C-c C-v C-u | ||
| 14163 | @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head} | ||
| 14164 | @kindex C-c C-v g | ||
| 14165 | @kindex C-c C-v C-g | ||
| 14166 | @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block} | ||
| 14167 | @kindex C-c C-v r | ||
| 14168 | @kindex C-c C-v C-r | ||
| 14169 | @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result} | ||
| 14046 | @kindex C-c C-v b | 14170 | @kindex C-c C-v b |
| 14047 | @kindex C-c C-v C-b | 14171 | @kindex C-c C-v C-b |
| 14048 | @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} | 14172 | @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} |
| 14049 | @kindex C-c C-v f | ||
| 14050 | @kindex C-c C-v C-f | ||
| 14051 | @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} | ||
| 14052 | @kindex C-c C-v g | ||
| 14053 | @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block} | ||
| 14054 | @kindex C-c C-v h | ||
| 14055 | @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings} | ||
| 14056 | @kindex C-c C-v l | ||
| 14057 | @kindex C-c C-v C-l | ||
| 14058 | @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} | ||
| 14059 | @kindex C-c C-v p | ||
| 14060 | @kindex C-c C-v C-p | ||
| 14061 | @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} | ||
| 14062 | @kindex C-c C-v s | 14173 | @kindex C-c C-v s |
| 14063 | @kindex C-c C-v C-s | 14174 | @kindex C-c C-v C-s |
| 14064 | @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} | 14175 | @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} |
| 14176 | @kindex C-c C-v d | ||
| 14177 | @kindex C-c C-v C-d | ||
| 14178 | @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block} | ||
| 14065 | @kindex C-c C-v t | 14179 | @kindex C-c C-v t |
| 14066 | @kindex C-c C-v C-t | 14180 | @kindex C-c C-v C-t |
| 14067 | @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} | 14181 | @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} |
| 14182 | @kindex C-c C-v f | ||
| 14183 | @kindex C-c C-v C-f | ||
| 14184 | @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} | ||
| 14185 | @kindex C-c C-v c | ||
| 14186 | @kindex C-c C-v C-c | ||
| 14187 | @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block} | ||
| 14188 | @kindex C-c C-v j | ||
| 14189 | @kindex C-c C-v C-j | ||
| 14190 | @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg} | ||
| 14191 | @kindex C-c C-v l | ||
| 14192 | @kindex C-c C-v C-l | ||
| 14193 | @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session} | ||
| 14194 | @kindex C-c C-v i | ||
| 14195 | @kindex C-c C-v C-i | ||
| 14196 | @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest} | ||
| 14197 | @kindex C-c C-v I | ||
| 14198 | @kindex C-c C-v C-I | ||
| 14199 | @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info} | ||
| 14068 | @kindex C-c C-v z | 14200 | @kindex C-c C-v z |
| 14069 | @kindex C-c C-v C-z | 14201 | @kindex C-c C-v C-z |
| 14070 | @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} | 14202 | @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code} |
| 14203 | @kindex C-c C-v a | ||
| 14204 | @kindex C-c C-v C-a | ||
| 14205 | @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} | ||
| 14206 | @kindex C-c C-v h | ||
| 14207 | @kindex C-c C-v C-h | ||
| 14208 | @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings} | ||
| 14209 | @kindex C-c C-v x | ||
| 14210 | @kindex C-c C-v C-x | ||
| 14211 | @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer} | ||
| 14071 | @end multitable | 14212 | @end multitable |
| 14072 | 14213 | ||
| 14073 | @c When possible these keybindings were extended to work when the control key is | 14214 | @c When possible these keybindings were extended to work when the control key is |
| @@ -14839,7 +14980,7 @@ checks for the availability of Calc by looking for the function | |||
| 14839 | been installed properly. As of Emacs 22, Calc is part of the Emacs | 14980 | been installed properly. As of Emacs 22, Calc is part of the Emacs |
| 14840 | distribution. Another possibility for interaction between the two | 14981 | distribution. Another possibility for interaction between the two |
| 14841 | packages is using Calc for embedded calculations. @xref{Embedded Mode, | 14982 | packages is using Calc for embedded calculations. @xref{Embedded Mode, |
| 14842 | , Embedded Mode, Calc, GNU Emacs Calc Manual}. | 14983 | , Embedded Mode, calc, GNU Emacs Calc Manual}. |
| 14843 | @item @file{constants.el} by Carsten Dominik | 14984 | @item @file{constants.el} by Carsten Dominik |
| 14844 | @cindex @file{constants.el} | 14985 | @cindex @file{constants.el} |
| 14845 | @cindex Dominik, Carsten | 14986 | @cindex Dominik, Carsten |
| @@ -15215,7 +15356,7 @@ not accept any arguments, and return the full link with prefix. | |||
| 15215 | @vindex org-ctrl-c-ctrl-c-hook | 15356 | @vindex org-ctrl-c-ctrl-c-hook |
| 15216 | 15357 | ||
| 15217 | Org has several commands that act differently depending on context. The most | 15358 | Org has several commands that act differently depending on context. The most |
| 15218 | important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}). | 15359 | important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}). |
| 15219 | Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property. | 15360 | Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property. |
| 15220 | 15361 | ||
| 15221 | Add-ons can tap into this functionality by providing a function that detects | 15362 | Add-ons can tap into this functionality by providing a function that detects |
| @@ -16431,7 +16572,7 @@ with links transformation to Org syntax. | |||
| 16431 | @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual | 16572 | @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
| 16432 | chapter about publishing. | 16573 | chapter about publishing. |
| 16433 | @item | 16574 | @item |
| 16434 | @i{Jambunathan K} contributed the @acronym{ODT} exporter. | 16575 | @i{Jambunathan K} contributed the ODT exporter. |
| 16435 | @item | 16576 | @item |
| 16436 | @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and | 16577 | @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and |
| 16437 | enabled source code highlighting in Gnus. | 16578 | enabled source code highlighting in Gnus. |