Mercurial > emacs

--- a/doc/misc/org.texi	Tue Dec 16 13:30:37 2008 +0000
+++ b/doc/misc/org.texi	Tue Dec 16 13:30:58 2008 +0000
@@ -3,7 +3,7 @@
 @setfilename ../../info/org
 @settitle The Org Manual

-@set VERSION 6.14
+@set VERSION 6.15a
 @set DATE December 2008

 @dircategory Emacs
@@ -307,6 +307,7 @@
 * Literal examples::            Source code and other examples
 * Include files::               Include the contents of a file during export
 * Tables exported::             Tables are exported richly
+* Inlined images::              How to inline images during export
 * Footnotes::                   Numbers like [1]
 * Emphasis and monospace::      To bold or not to bold
 * TeX macros and LaTeX fragments::  Create special, rich export.
@@ -318,15 +319,17 @@
 * HTML Export commands::        How to invoke HTML export
 * Quoting HTML tags::           Using direct HTML in Org mode
 * Links::                       Transformation of links for HTML
-* Images::                      How to include images
+* Images in HTML export::
 * CSS support::                 Changing the appearance of the output
 * Javascript support::          Info and Folding in a web browser

 LaTeX and PDF export

-* LaTeX/PDF export commands::
+* LaTeX/PDF export commands::   Which key invode which commands
 * Quoting LaTeX code::          Incorporating literal LaTeX code
 * Sectioning structure::        Changing sectioning in LaTeX output
+* Tables in LaTeX export::      Options for exporting tables to LaTeX
+* Images in LaTeX export::      How to insert figures into LaTeX output

 Publishing

@@ -1779,7 +1782,8 @@

 @noindent
 Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
-or relative to the current column like @samp{+1} or @samp{-2}.
+or relative to the current column like @samp{+1} or @samp{-2}.  As a special
+case, @samp{@@0} references the last data line in the table.

 The row specification only counts data lines and ignores horizontal
 separator lines (hlines).  You can use absolute row numbers
@@ -2570,26 +2574,25 @@
 @kindex C-c l
 @cindex storing links
 @item C-c l
-Store a link to the current location.  This is a @emph{global} command
-which can be used in any buffer to create a link.  The link will be
-stored for later insertion into an Org buffer (see below).  For
-Org files, if there is a @samp{<<target>>} at the cursor, the
-link points to the target.  Otherwise it points to the current
-headline.  For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the
-link will indicate the current article/entry.  For W3 and W3M buffers,
-the link goes to the current URL.  For IRC links, if you set the
-variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
-store a @samp{file:/} style link to the relevant point in the logs for
-the current conversation. Otherwise an @samp{irc:/} style link to the
-user/channel/server under the point will be stored.  For any other
-files, the link will point to the file, with a search string
-(@pxref{Search options}) pointing to the contents of the current line.
-If there is an active region, the selected words will form the basis
-of the search string.  If the automatically created link is not
-working correctly or accurately enough, you can write custom functions
-to select the search string and to do the search for particular file
-types - see @ref{Custom searches}.  The key binding @kbd{C-c l} is
-only a suggestion - see @ref{Installation}.
+Store a link to the current location.  This is a @emph{global} command which
+can be used in any buffer to create a link.  The link will be stored for
+later insertion into an Org buffer (see below).  For Org files, if there is a
+@samp{<<target>>} at the cursor, the link points to the target.  Otherwise it
+points to the current headline, either by text, or, if @file{org-id.el} is
+loaded, by ID property.  For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB
+buffers, the link will indicate the current article/entry.  For W3 and W3M
+buffers, the link goes to the current URL.  For IRC links, if you set the
+variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
+@samp{file:/} style link to the relevant point in the logs for the current
+conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
+under the point will be stored.  For any other files, the link will point to
+the file, with a search string (@pxref{Search options}) pointing to the
+contents of the current line.  If there is an active region, the selected
+words will form the basis of the search string.  If the automatically created
+link is not working correctly or accurately enough, you can write custom
+functions to select the search string and to do the search for particular
+file types - see @ref{Custom searches}.  The key binding @kbd{C-c l} is only
+a suggestion - see @ref{Installation}.
 @c
 @kindex C-c C-l
 @cindex link completion
@@ -5468,8 +5471,8 @@
 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
 or @kbd{>} in the agenda dispatcher.  If there is a window displaying an
 agenda view, the new restriction takes effect immediately.
-@kindex C-c C-x <
-@item C-c C-x <
+@kindex C-c C-x >
+@item C-c C-x >
 Remove the permanent restriction created by @kbd{C-c C-x <}.
 @end table

@@ -5483,7 +5486,7 @@
 Speedbar frame, either an Org file or a subtree in such a file.
 If there is a window displaying an agenda view, the new restriction takes
 effect immediately.
-@kindex <
+@kindex >
 @item > @r{in the speedbar frame}
 Lift the restriction again.
 @end table
@@ -7101,6 +7104,7 @@
 * Literal examples::            Source code and other examples
 * Include files::               Include the contents of a file during export
 * Tables exported::             Tables are exported richly
+* Inlined images::              How to inline images during export
 * Footnotes::                   Numbers like [1]
 * Emphasis and monospace::      To bold or not to bold
 * TeX macros and LaTeX fragments::  Create special, rich export.
@@ -7318,16 +7322,41 @@
 Visit the include file at point.
 @end table

-@node Tables exported, Footnotes, Include files, Markup rules
+@node Tables exported, Inlined images, Include files, Markup rules
 @subheading Tables
 @cindex tables, markup rules

 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
 the @file{table.el} package will be exported properly.  For Org mode tables,
 the lines before the first horizontal separator line will become table header
-lines.
-
-@node Footnotes, Emphasis and monospace, Tables exported, Markup rules
+lines.  You can use the following lines somewhere before the table to asssign
+a caption and a label for cross references:
+
+@example
+#+CAPTION: This is the caption for the next table (or link)
+#+LABEL:   tbl:basic-data
+@end example
+
+@node Inlined images, Footnotes, Tables exported, Markup rules
+@subheading Inlined Images
+@cindex inlined images, markup rules
+
+Some backends (HTML and LaTeX) allow to directly include images into the
+exported document.  Org does this, if a link to an image files does not have
+a description part, for example @code{[[./img/a.jpg]]}.  If you wish to
+define a caption for the image and maybe a label for internal cross
+references, you can use (before, but close to the link)
+
+@example
+#+CAPTION: This is the caption for the next figure link (or table)
+#+LABEL:   fig:SED-HR4049
+@end example
+
+You may also define additional attributes for the figure.  As this is
+backend-specific, see the sections about the individual backends for more
+information.
+
+@node Footnotes, Emphasis and monospace, Inlined images, Markup rules
 @subheading Footnotes
 @cindex footnotes, markup rules
 @cindex @file{footnote.el}
@@ -7617,7 +7646,7 @@
 * HTML Export commands::        How to invoke HTML export
 * Quoting HTML tags::           Using direct HTML in Org mode
 * Links::                       Transformation of links for HTML
-* Images::                      How to include images
+* Images in HTML export::
 * CSS support::                 Changing the appearance of the output
 * Javascript support::          Info and Folding in a web browser
 @end menu
@@ -7704,31 +7733,32 @@
 @end example


-@node Links, Images, Quoting HTML tags, HTML export
+@node Links, Images in HTML export, Quoting HTML tags, HTML export
 @subsection Links

 @cindex links, in HTML export
 @cindex internal links, in HTML export
 @cindex external links, in HTML export
-Internal links (@pxref{Internal links}) will continue to work in HTML
-files only if they match a dedicated @samp{<<target>>}.  Automatic links
-created by radio targets (@pxref{Radio targets}) will also work in the
-HTML file.  Links to external files will still work if the HTML file is
-in the same directory as the Org file.  Links to other @file{.org}
-files will be translated into HTML links under the assumption that an
-HTML version also exists of the linked file.  For information related to
-linking files while publishing them to a publishing directory see
-@ref{Publishing links}.
+Internal links (@pxref{Internal links}) will continue to work in HTML.
+Automatic links created by radio targets (@pxref{Radio targets}) will also
+work in the HTML file.  Links to external files will still work if the HTML
+file is in the same directory as the Org file.  Links to other @file{.org}
+files will be translated into HTML links under the assumption that an HTML
+version also exists of the linked file.  For information related to linking
+files while publishing them to a publishing directory see @ref{Publishing
+links}.

 If you want to specify attributes for links, you can do so using a special
-syntax.  Here is an example that sets @code{alt} and @code{title} attributes
-for an inlined image:
-
-@example
-[[./img/a.jpg@{@{alt="This is image A" title="Image with no action"@}@}]]
-@end example
-
-@node Images, CSS support, Links, HTML export
+@code{#+ATTR_HTML} line to define attributes that wil be added to the
+@code{<a>} or @code{<img>} tags.  Here is an example that sets @code{alt} and
+@code{title} attributes for an inlined image:
+
+@example
+#+ATTR_HTML: alt="This is image A" title="Image with no action"
+[[./img/a.jpg]]
+@end example
+
+@node Images in HTML export, CSS support, Links, HTML export
 @subsection Images

 @cindex images, inline in HTML
@@ -7752,7 +7782,7 @@
 @noindent
 and you could use @code{http} addresses just as well.

-@node CSS support, Javascript support, Images, HTML export
+@node CSS support, Javascript support, Images in HTML export, HTML export
 @subsection CSS support
 @cindex CSS, for HTML export
 @cindex HTML export, CSS
@@ -7865,9 +7895,11 @@
 references, the PDF output file will be fully linked.

 @menu
-* LaTeX/PDF export commands::
+* LaTeX/PDF export commands::   Which key invode which commands
 * Quoting LaTeX code::          Incorporating literal LaTeX code
 * Sectioning structure::        Changing sectioning in LaTeX output
+* Tables in LaTeX export::      Options for exporting tables to LaTeX
+* Images in LaTeX export::      How to insert figures into LaTeX output
 @end menu

 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
@@ -7944,7 +7976,7 @@
 #+END_LaTeX
 @end example

-@node   Sectioning structure,  , Quoting LaTeX code, LaTeX and PDF export
+@node   Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
 @subsection Sectioning structure
 @cindex LaTeX class
 @cindex LaTeX sectioning structure
@@ -7958,6 +7990,47 @@
 structure for each class, as well as defining additonal classes.


+@node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
+@subsection Tables in LaTeX export
+@cindex tables, in LaTeX export
+
+For LaTeX export of a table, you can specify a label and a caption
+(@pxref{Tables exported}).  You can also use the @code{ATTR_LaTeX} line to
+request a longtable environment for the table, so that it may span several
+pages:
+
+@example
+#+CAPTION: A long table
+#+LABEL: tbl:long
+#+ATTR_LaTeX: longtable
+| ..... | ..... |
+| ..... | ..... |
+@end example
+
+
+@node Images in LaTeX export,  , Tables in LaTeX export, LaTeX and PDF export
+@subsection Images in LaTeX export
+@cindex images, inline in LaTeX
+@cindex inlining images in LaTeX
+
+Images that are linked to without a description part in the link, like
+@samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
+output files resulting from LaTeX output.  Org will use an
+@code{\includegraphics} macro to insert the image.  If you have specified a
+caption and/or a label as described in @ref{Markup rules}, the figure will
+be wrappend into a @code{figure} environment and thus become a floating
+element.  Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the
+options that can be used in the optional argument of the
+@code{\includegraphics} macro.
+
+@example
+#+CAPTION:    The black-body emission of the disk around HR 4049
+#+LABEL:      fig:SED-HR4049
+#+ATTR_LaTeX: width=5cm,angle=90
+[[./img/sed-hr4049.pdf]]
+@end example
+
+
 @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
 @section XOXO export
 @cindex XOXO export