diff options
| author | Carsten Dominik | 2008-12-16 13:32:13 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2008-12-16 13:32:13 +0000 |
| commit | 67df9cfbb2b236527eb15c61ff4d2008ae7e2a59 (patch) | |
| tree | bc8d7c52cbf98ec23310991da5f5b033e569cc91 | |
| parent | db55f368650667b0686cdcd36afa43d33ef219ca (diff) | |
| download | emacs-67df9cfbb2b236527eb15c61ff4d2008ae7e2a59.tar.gz emacs-67df9cfbb2b236527eb15c61ff4d2008ae7e2a59.zip | |
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
* org.texi: (Tables in LaTeX export): New section.
(Images in LaTeX export): New section.
(Inlined images, Images in HTML export): Sections renamed.
| -rw-r--r-- | doc/misc/org.texi | 169 | ||||
| -rw-r--r-- | etc/ChangeLog | 4 |
2 files changed, 125 insertions, 48 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 2b47d8ef701..f829537b0d8 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -3,7 +3,7 @@ | |||
| 3 | @setfilename ../../info/org | 3 | @setfilename ../../info/org |
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | 5 | ||
| 6 | @set VERSION 6.14 | 6 | @set VERSION 6.15a |
| 7 | @set DATE December 2008 | 7 | @set DATE December 2008 |
| 8 | 8 | ||
| 9 | @dircategory Emacs | 9 | @dircategory Emacs |
| @@ -307,6 +307,7 @@ Markup rules | |||
| 307 | * Literal examples:: Source code and other examples | 307 | * Literal examples:: Source code and other examples |
| 308 | * Include files:: Include the contents of a file during export | 308 | * Include files:: Include the contents of a file during export |
| 309 | * Tables exported:: Tables are exported richly | 309 | * Tables exported:: Tables are exported richly |
| 310 | * Inlined images:: How to inline images during export | ||
| 310 | * Footnotes:: Numbers like [1] | 311 | * Footnotes:: Numbers like [1] |
| 311 | * Emphasis and monospace:: To bold or not to bold | 312 | * Emphasis and monospace:: To bold or not to bold |
| 312 | * TeX macros and LaTeX fragments:: Create special, rich export. | 313 | * TeX macros and LaTeX fragments:: Create special, rich export. |
| @@ -318,15 +319,17 @@ HTML export | |||
| 318 | * HTML Export commands:: How to invoke HTML export | 319 | * HTML Export commands:: How to invoke HTML export |
| 319 | * Quoting HTML tags:: Using direct HTML in Org mode | 320 | * Quoting HTML tags:: Using direct HTML in Org mode |
| 320 | * Links:: Transformation of links for HTML | 321 | * Links:: Transformation of links for HTML |
| 321 | * Images:: How to include images | 322 | * Images in HTML export:: |
| 322 | * CSS support:: Changing the appearance of the output | 323 | * CSS support:: Changing the appearance of the output |
| 323 | * Javascript support:: Info and Folding in a web browser | 324 | * Javascript support:: Info and Folding in a web browser |
| 324 | 325 | ||
| 325 | LaTeX and PDF export | 326 | LaTeX and PDF export |
| 326 | 327 | ||
| 327 | * LaTeX/PDF export commands:: | 328 | * LaTeX/PDF export commands:: Which key invode which commands |
| 328 | * Quoting LaTeX code:: Incorporating literal LaTeX code | 329 | * Quoting LaTeX code:: Incorporating literal LaTeX code |
| 329 | * Sectioning structure:: Changing sectioning in LaTeX output | 330 | * Sectioning structure:: Changing sectioning in LaTeX output |
| 331 | * Tables in LaTeX export:: Options for exporting tables to LaTeX | ||
| 332 | * Images in LaTeX export:: How to insert figures into LaTeX output | ||
| 330 | 333 | ||
| 331 | Publishing | 334 | Publishing |
| 332 | 335 | ||
| @@ -1779,7 +1782,8 @@ Org also uses another, more general operator that looks like this: | |||
| 1779 | 1782 | ||
| 1780 | @noindent | 1783 | @noindent |
| 1781 | Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, | 1784 | Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, |
| 1782 | or relative to the current column like @samp{+1} or @samp{-2}. | 1785 | or relative to the current column like @samp{+1} or @samp{-2}. As a special |
| 1786 | case, @samp{@@0} references the last data line in the table. | ||
| 1783 | 1787 | ||
| 1784 | The row specification only counts data lines and ignores horizontal | 1788 | The row specification only counts data lines and ignores horizontal |
| 1785 | separator lines (hlines). You can use absolute row numbers | 1789 | separator lines (hlines). You can use absolute row numbers |
| @@ -2570,26 +2574,25 @@ insert it into an Org file, and to follow the link. | |||
| 2570 | @kindex C-c l | 2574 | @kindex C-c l |
| 2571 | @cindex storing links | 2575 | @cindex storing links |
| 2572 | @item C-c l | 2576 | @item C-c l |
| 2573 | Store a link to the current location. This is a @emph{global} command | 2577 | Store a link to the current location. This is a @emph{global} command which |
| 2574 | which can be used in any buffer to create a link. The link will be | 2578 | can be used in any buffer to create a link. The link will be stored for |
| 2575 | stored for later insertion into an Org buffer (see below). For | 2579 | later insertion into an Org buffer (see below). For Org files, if there is a |
| 2576 | Org files, if there is a @samp{<<target>>} at the cursor, the | 2580 | @samp{<<target>>} at the cursor, the link points to the target. Otherwise it |
| 2577 | link points to the target. Otherwise it points to the current | 2581 | points to the current headline, either by text, or, if @file{org-id.el} is |
| 2578 | headline. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the | 2582 | loaded, by ID property. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB |
| 2579 | link will indicate the current article/entry. For W3 and W3M buffers, | 2583 | buffers, the link will indicate the current article/entry. For W3 and W3M |
| 2580 | the link goes to the current URL. For IRC links, if you set the | 2584 | buffers, the link goes to the current URL. For IRC links, if you set the |
| 2581 | variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will | 2585 | variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a |
| 2582 | store a @samp{file:/} style link to the relevant point in the logs for | 2586 | @samp{file:/} style link to the relevant point in the logs for the current |
| 2583 | the current conversation. Otherwise an @samp{irc:/} style link to the | 2587 | conversation. Otherwise an @samp{irc:/} style link to the user/channel/server |
| 2584 | user/channel/server under the point will be stored. For any other | 2588 | under the point will be stored. For any other files, the link will point to |
| 2585 | files, the link will point to the file, with a search string | 2589 | the file, with a search string (@pxref{Search options}) pointing to the |
| 2586 | (@pxref{Search options}) pointing to the contents of the current line. | 2590 | contents of the current line. If there is an active region, the selected |
| 2587 | If there is an active region, the selected words will form the basis | 2591 | words will form the basis of the search string. If the automatically created |
| 2588 | of the search string. If the automatically created link is not | 2592 | link is not working correctly or accurately enough, you can write custom |
| 2589 | working correctly or accurately enough, you can write custom functions | 2593 | functions to select the search string and to do the search for particular |
| 2590 | to select the search string and to do the search for particular file | 2594 | file types - see @ref{Custom searches}. The key binding @kbd{C-c l} is only |
| 2591 | types - see @ref{Custom searches}. The key binding @kbd{C-c l} is | 2595 | a suggestion - see @ref{Installation}. |
| 2592 | only a suggestion - see @ref{Installation}. | ||
| 2593 | @c | 2596 | @c |
| 2594 | @kindex C-c C-l | 2597 | @kindex C-c C-l |
| 2595 | @cindex link completion | 2598 | @cindex link completion |
| @@ -5468,8 +5471,8 @@ the agenda scope is set to the entire file. This restriction remains in | |||
| 5468 | effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} | 5471 | effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} |
| 5469 | or @kbd{>} in the agenda dispatcher. If there is a window displaying an | 5472 | or @kbd{>} in the agenda dispatcher. If there is a window displaying an |
| 5470 | agenda view, the new restriction takes effect immediately. | 5473 | agenda view, the new restriction takes effect immediately. |
| 5471 | @kindex C-c C-x < | 5474 | @kindex C-c C-x > |
| 5472 | @item C-c C-x < | 5475 | @item C-c C-x > |
| 5473 | Remove the permanent restriction created by @kbd{C-c C-x <}. | 5476 | Remove the permanent restriction created by @kbd{C-c C-x <}. |
| 5474 | @end table | 5477 | @end table |
| 5475 | 5478 | ||
| @@ -5483,7 +5486,7 @@ Permanently restrict the agenda to the item at the cursor in the | |||
| 5483 | Speedbar frame, either an Org file or a subtree in such a file. | 5486 | Speedbar frame, either an Org file or a subtree in such a file. |
| 5484 | If there is a window displaying an agenda view, the new restriction takes | 5487 | If there is a window displaying an agenda view, the new restriction takes |
| 5485 | effect immediately. | 5488 | effect immediately. |
| 5486 | @kindex < | 5489 | @kindex > |
| 5487 | @item > @r{in the speedbar frame} | 5490 | @item > @r{in the speedbar frame} |
| 5488 | Lift the restriction again. | 5491 | Lift the restriction again. |
| 5489 | @end table | 5492 | @end table |
| @@ -7101,6 +7104,7 @@ markup rule used in an Org mode buffer. | |||
| 7101 | * Literal examples:: Source code and other examples | 7104 | * Literal examples:: Source code and other examples |
| 7102 | * Include files:: Include the contents of a file during export | 7105 | * Include files:: Include the contents of a file during export |
| 7103 | * Tables exported:: Tables are exported richly | 7106 | * Tables exported:: Tables are exported richly |
| 7107 | * Inlined images:: How to inline images during export | ||
| 7104 | * Footnotes:: Numbers like [1] | 7108 | * Footnotes:: Numbers like [1] |
| 7105 | * Emphasis and monospace:: To bold or not to bold | 7109 | * Emphasis and monospace:: To bold or not to bold |
| 7106 | * TeX macros and LaTeX fragments:: Create special, rich export. | 7110 | * TeX macros and LaTeX fragments:: Create special, rich export. |
| @@ -7318,16 +7322,41 @@ item, use | |||
| 7318 | Visit the include file at point. | 7322 | Visit the include file at point. |
| 7319 | @end table | 7323 | @end table |
| 7320 | 7324 | ||
| 7321 | @node Tables exported, Footnotes, Include files, Markup rules | 7325 | @node Tables exported, Inlined images, Include files, Markup rules |
| 7322 | @subheading Tables | 7326 | @subheading Tables |
| 7323 | @cindex tables, markup rules | 7327 | @cindex tables, markup rules |
| 7324 | 7328 | ||
| 7325 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with | 7329 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with |
| 7326 | the @file{table.el} package will be exported properly. For Org mode tables, | 7330 | the @file{table.el} package will be exported properly. For Org mode tables, |
| 7327 | the lines before the first horizontal separator line will become table header | 7331 | the lines before the first horizontal separator line will become table header |
| 7328 | lines. | 7332 | lines. You can use the following lines somewhere before the table to asssign |
| 7333 | a caption and a label for cross references: | ||
| 7334 | |||
| 7335 | @example | ||
| 7336 | #+CAPTION: This is the caption for the next table (or link) | ||
| 7337 | #+LABEL: tbl:basic-data | ||
| 7338 | @end example | ||
| 7339 | |||
| 7340 | @node Inlined images, Footnotes, Tables exported, Markup rules | ||
| 7341 | @subheading Inlined Images | ||
| 7342 | @cindex inlined images, markup rules | ||
| 7329 | 7343 | ||
| 7330 | @node Footnotes, Emphasis and monospace, Tables exported, Markup rules | 7344 | Some backends (HTML and LaTeX) allow to directly include images into the |
| 7345 | exported document. Org does this, if a link to an image files does not have | ||
| 7346 | a description part, for example @code{[[./img/a.jpg]]}. If you wish to | ||
| 7347 | define a caption for the image and maybe a label for internal cross | ||
| 7348 | references, you can use (before, but close to the link) | ||
| 7349 | |||
| 7350 | @example | ||
| 7351 | #+CAPTION: This is the caption for the next figure link (or table) | ||
| 7352 | #+LABEL: fig:SED-HR4049 | ||
| 7353 | @end example | ||
| 7354 | |||
| 7355 | You may also define additional attributes for the figure. As this is | ||
| 7356 | backend-specific, see the sections about the individual backends for more | ||
| 7357 | information. | ||
| 7358 | |||
| 7359 | @node Footnotes, Emphasis and monospace, Inlined images, Markup rules | ||
| 7331 | @subheading Footnotes | 7360 | @subheading Footnotes |
| 7332 | @cindex footnotes, markup rules | 7361 | @cindex footnotes, markup rules |
| 7333 | @cindex @file{footnote.el} | 7362 | @cindex @file{footnote.el} |
| @@ -7617,7 +7646,7 @@ language, but with additional support for tables. | |||
| 7617 | * HTML Export commands:: How to invoke HTML export | 7646 | * HTML Export commands:: How to invoke HTML export |
| 7618 | * Quoting HTML tags:: Using direct HTML in Org mode | 7647 | * Quoting HTML tags:: Using direct HTML in Org mode |
| 7619 | * Links:: Transformation of links for HTML | 7648 | * Links:: Transformation of links for HTML |
| 7620 | * Images:: How to include images | 7649 | * Images in HTML export:: |
| 7621 | * CSS support:: Changing the appearance of the output | 7650 | * CSS support:: Changing the appearance of the output |
| 7622 | * Javascript support:: Info and Folding in a web browser | 7651 | * Javascript support:: Info and Folding in a web browser |
| 7623 | @end menu | 7652 | @end menu |
| @@ -7704,31 +7733,32 @@ All lines between these markers are exported literally | |||
| 7704 | @end example | 7733 | @end example |
| 7705 | 7734 | ||
| 7706 | 7735 | ||
| 7707 | @node Links, Images, Quoting HTML tags, HTML export | 7736 | @node Links, Images in HTML export, Quoting HTML tags, HTML export |
| 7708 | @subsection Links | 7737 | @subsection Links |
| 7709 | 7738 | ||
| 7710 | @cindex links, in HTML export | 7739 | @cindex links, in HTML export |
| 7711 | @cindex internal links, in HTML export | 7740 | @cindex internal links, in HTML export |
| 7712 | @cindex external links, in HTML export | 7741 | @cindex external links, in HTML export |
| 7713 | Internal links (@pxref{Internal links}) will continue to work in HTML | 7742 | Internal links (@pxref{Internal links}) will continue to work in HTML. |
| 7714 | files only if they match a dedicated @samp{<<target>>}. Automatic links | 7743 | Automatic links created by radio targets (@pxref{Radio targets}) will also |
| 7715 | created by radio targets (@pxref{Radio targets}) will also work in the | 7744 | work in the HTML file. Links to external files will still work if the HTML |
| 7716 | HTML file. Links to external files will still work if the HTML file is | 7745 | file is in the same directory as the Org file. Links to other @file{.org} |
| 7717 | in the same directory as the Org file. Links to other @file{.org} | 7746 | files will be translated into HTML links under the assumption that an HTML |
| 7718 | files will be translated into HTML links under the assumption that an | 7747 | version also exists of the linked file. For information related to linking |
| 7719 | HTML version also exists of the linked file. For information related to | 7748 | files while publishing them to a publishing directory see @ref{Publishing |
| 7720 | linking files while publishing them to a publishing directory see | 7749 | links}. |
| 7721 | @ref{Publishing links}. | ||
| 7722 | 7750 | ||
| 7723 | If you want to specify attributes for links, you can do so using a special | 7751 | If you want to specify attributes for links, you can do so using a special |
| 7724 | syntax. Here is an example that sets @code{alt} and @code{title} attributes | 7752 | @code{#+ATTR_HTML} line to define attributes that wil be added to the |
| 7725 | for an inlined image: | 7753 | @code{<a>} or @code{<img>} tags. Here is an example that sets @code{alt} and |
| 7754 | @code{title} attributes for an inlined image: | ||
| 7726 | 7755 | ||
| 7727 | @example | 7756 | @example |
| 7728 | [[./img/a.jpg@{@{alt="This is image A" title="Image with no action"@}@}]] | 7757 | #+ATTR_HTML: alt="This is image A" title="Image with no action" |
| 7758 | [[./img/a.jpg]] | ||
| 7729 | @end example | 7759 | @end example |
| 7730 | 7760 | ||
| 7731 | @node Images, CSS support, Links, HTML export | 7761 | @node Images in HTML export, CSS support, Links, HTML export |
| 7732 | @subsection Images | 7762 | @subsection Images |
| 7733 | 7763 | ||
| 7734 | @cindex images, inline in HTML | 7764 | @cindex images, inline in HTML |
| @@ -7752,7 +7782,7 @@ will link to a high resolution version of the image, you could use: | |||
| 7752 | @noindent | 7782 | @noindent |
| 7753 | and you could use @code{http} addresses just as well. | 7783 | and you could use @code{http} addresses just as well. |
| 7754 | 7784 | ||
| 7755 | @node CSS support, Javascript support, Images, HTML export | 7785 | @node CSS support, Javascript support, Images in HTML export, HTML export |
| 7756 | @subsection CSS support | 7786 | @subsection CSS support |
| 7757 | @cindex CSS, for HTML export | 7787 | @cindex CSS, for HTML export |
| 7758 | @cindex HTML export, CSS | 7788 | @cindex HTML export, CSS |
| @@ -7865,9 +7895,11 @@ the LaTeX output uses @file{hyperref} to implement links and cross | |||
| 7865 | references, the PDF output file will be fully linked. | 7895 | references, the PDF output file will be fully linked. |
| 7866 | 7896 | ||
| 7867 | @menu | 7897 | @menu |
| 7868 | * LaTeX/PDF export commands:: | 7898 | * LaTeX/PDF export commands:: Which key invode which commands |
| 7869 | * Quoting LaTeX code:: Incorporating literal LaTeX code | 7899 | * Quoting LaTeX code:: Incorporating literal LaTeX code |
| 7870 | * Sectioning structure:: Changing sectioning in LaTeX output | 7900 | * Sectioning structure:: Changing sectioning in LaTeX output |
| 7901 | * Tables in LaTeX export:: Options for exporting tables to LaTeX | ||
| 7902 | * Images in LaTeX export:: How to insert figures into LaTeX output | ||
| 7871 | @end menu | 7903 | @end menu |
| 7872 | 7904 | ||
| 7873 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export | 7905 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export |
| @@ -7944,7 +7976,7 @@ All lines between these markers are exported literally | |||
| 7944 | #+END_LaTeX | 7976 | #+END_LaTeX |
| 7945 | @end example | 7977 | @end example |
| 7946 | 7978 | ||
| 7947 | @node Sectioning structure, , Quoting LaTeX code, LaTeX and PDF export | 7979 | @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export |
| 7948 | @subsection Sectioning structure | 7980 | @subsection Sectioning structure |
| 7949 | @cindex LaTeX class | 7981 | @cindex LaTeX class |
| 7950 | @cindex LaTeX sectioning structure | 7982 | @cindex LaTeX sectioning structure |
| @@ -7958,6 +7990,47 @@ You can change this globally by setting a different value for | |||
| 7958 | structure for each class, as well as defining additonal classes. | 7990 | structure for each class, as well as defining additonal classes. |
| 7959 | 7991 | ||
| 7960 | 7992 | ||
| 7993 | @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export | ||
| 7994 | @subsection Tables in LaTeX export | ||
| 7995 | @cindex tables, in LaTeX export | ||
| 7996 | |||
| 7997 | For LaTeX export of a table, you can specify a label and a caption | ||
| 7998 | (@pxref{Tables exported}). You can also use the @code{ATTR_LaTeX} line to | ||
| 7999 | request a longtable environment for the table, so that it may span several | ||
| 8000 | pages: | ||
| 8001 | |||
| 8002 | @example | ||
| 8003 | #+CAPTION: A long table | ||
| 8004 | #+LABEL: tbl:long | ||
| 8005 | #+ATTR_LaTeX: longtable | ||
| 8006 | | ..... | ..... | | ||
| 8007 | | ..... | ..... | | ||
| 8008 | @end example | ||
| 8009 | |||
| 8010 | |||
| 8011 | @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export | ||
| 8012 | @subsection Images in LaTeX export | ||
| 8013 | @cindex images, inline in LaTeX | ||
| 8014 | @cindex inlining images in LaTeX | ||
| 8015 | |||
| 8016 | Images that are linked to without a description part in the link, like | ||
| 8017 | @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF | ||
| 8018 | output files resulting from LaTeX output. Org will use an | ||
| 8019 | @code{\includegraphics} macro to insert the image. If you have specified a | ||
| 8020 | caption and/or a label as described in @ref{Markup rules}, the figure will | ||
| 8021 | be wrappend into a @code{figure} environment and thus become a floating | ||
| 8022 | element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the | ||
| 8023 | options that can be used in the optional argument of the | ||
| 8024 | @code{\includegraphics} macro. | ||
| 8025 | |||
| 8026 | @example | ||
| 8027 | #+CAPTION: The black-body emission of the disk around HR 4049 | ||
| 8028 | #+LABEL: fig:SED-HR4049 | ||
| 8029 | #+ATTR_LaTeX: width=5cm,angle=90 | ||
| 8030 | [[./img/sed-hr4049.pdf]] | ||
| 8031 | @end example | ||
| 8032 | |||
| 8033 | |||
| 7961 | @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting | 8034 | @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting |
| 7962 | @section XOXO export | 8035 | @section XOXO export |
| 7963 | @cindex XOXO export | 8036 | @cindex XOXO export |
diff --git a/etc/ChangeLog b/etc/ChangeLog index ea694bb120f..2ab94b40088 100644 --- a/etc/ChangeLog +++ b/etc/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2008-12-16 Carsten Dominik <dominik@science.uva.nl> | ||
| 2 | |||
| 3 | * refcards/orgcard.tex: Version number change. | ||
| 4 | |||
| 1 | 2008-12-11 Dan Nicolaescu <dann@ics.uci.edu> | 5 | 2008-12-11 Dan Nicolaescu <dann@ics.uci.edu> |
| 2 | 6 | ||
| 3 | * MACHINES: SH3 is still supported. | 7 | * MACHINES: SH3 is still supported. |