summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJambunathan K <kjambunathan@gmail.com>2012-03-21 02:13:55 +0530
committerJambunathan K <kjambunathan@gmail.com>2012-03-21 02:13:55 +0530
commit1cc2af2f2534efc95d76bfefbb47a833a4a3b8cd (patch)
tree816557115c7e45d08a5ffdd1efc7d8b36955b7b3
parentfee7de7c5697b8612a7e16e35af993917b9ba8c3 (diff)
downloadorg-mode-1cc2af2f2534efc95d76bfefbb47a833a4a3b8cd.tar.gz
org.texi: Udpate ODT section
* doc/org.texi (Links in ODT export): Update. (Labels and captions in ODT export): New node.
-rw-r--r--doc/org.texi81
1 files changed, 67 insertions, 14 deletions
diff --git a/doc/org.texi b/doc/org.texi
index 3324888..6c13727 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -613,13 +613,14 @@ DocBook export
OpenDocument Text export
* Pre-requisites for ODT export:: What packages ODT exporter relies on
-* ODT export commands:: How to invoke ODT export
-* Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
+* ODT export commands:: How to invoke ODT export
+* Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
* Applying custom styles:: How to apply custom styles to the output
-* Links in ODT export:: How links will be interpreted and formatted
-* Tables in ODT export:: How Tables are exported
-* Images in ODT export:: How to insert images
+* Links in ODT export:: How links will be interpreted and formatted
+* Tables in ODT export:: How Tables are exported
+* Images in ODT export:: How to insert images
* Math formatting in ODT export:: How @LaTeX{} fragments are formatted
+* Labels and captions in ODT export:: How captions are rendered
* Literal examples in ODT export:: How source and example blocks are formatted
* Advanced topics in ODT export:: Read this if you are a power user
@@ -10799,13 +10800,14 @@ are compatible with LibreOffice 3.4.
@menu
* Pre-requisites for ODT export:: What packages ODT exporter relies on
-* ODT export commands:: How to invoke ODT export
-* Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
+* ODT export commands:: How to invoke ODT export
+* Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
* Applying custom styles:: How to apply custom styles to the output
-* Links in ODT export:: How links will be interpreted and formatted
-* Tables in ODT export:: How Tables are exported
-* Images in ODT export:: How to insert images
+* Links in ODT export:: How links will be interpreted and formatted
+* Tables in ODT export:: How Tables are exported
+* Images in ODT export:: How to insert images
* Math formatting in ODT export:: How @LaTeX{} fragments are formatted
+* Labels and captions in ODT export:: How captions are rendered
* Literal examples in ODT export:: How source and example blocks are formatted
* Advanced topics in ODT export:: Read this if you are a power user
@end menu
@@ -10966,8 +10968,15 @@ the factory settings.
@subsection Links in ODT export
@cindex tables, in DocBook export
-The ODT exporter creates cross-references (aka bookmarks) for
-internal links. It creates Internet-style links for all other links.
+ODT exporter creates native cross-references for internal links. It creates
+Internet-style links for all other links.
+
+A link with no description and destined to a regular (un-itemized) outline
+heading is replaced with a cross-reference and section number of the heading.
+
+A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
+with a cross-reference and sequence number of the labelled entity.
+@xref{Labels and captions in ODT export}.
@node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
@subsection Tables in ODT export
@@ -11116,7 +11125,7 @@ To create an image that is anchored to a page, do the following:
[[./img.png]]
@end example
-@node Math formatting in ODT export, Literal examples in ODT export, Images in ODT export, OpenDocument Text export
+@node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
@subsection Math formatting in ODT export
The ODT exporter has special support for handling math.
@@ -11210,7 +11219,51 @@ or
[[./equation.odf]]
@end example
-@node Literal examples in ODT export, Advanced topics in ODT export, Math formatting in ODT export, OpenDocument Text export
+@node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
+@subsection Labels and captions in ODT export
+
+You can label and caption various category of objects - an inline image, a
+table, a @LaTeX{} fragment or a Math formula - using @code{#+LABEL} and
+@code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
+each labelled or captioned object of a given category separately. As a
+result, each such object is assigned a sequence number based on order of it's
+appearance in the Org file.
+
+In the exported document, a user-provided caption is augmented with the
+category and sequence number. Consider the following inline image in an Org
+file.
+
+@example
+#+CAPTION: Bell curve
+#+LABEL: fig:SED-HR4049
+[[./img/a.png]]
+@end example
+
+It could be rendered as shown below in the exported document.
+
+@example
+Figure 2: Bell curve
+@end example
+
+@vindex org-export-odt-category-strings
+You can modify the category component of the caption by customizing the
+variable @code{org-export-odt-category-strings}. For example, to tag all
+embedded images with the string @samp{Illustration} (instead of the default
+@samp{Figure}) use the following setting.
+
+@lisp
+(setq org-export-odt-category-strings
+ '(("en" "Table" "Illustration" "Equation" "Equation")))
+@end lisp
+
+With this, previous image will be captioned as below in the exported
+document.
+
+@example
+Illustration 2: Bell curve
+@end example
+
+@node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
@subsection Literal examples in ODT export
Export of literal examples (@pxref{Literal examples}) with full fontification