ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' of orgmode.org:org-mode

This commit is contained in:
Bastien Guerry 2013-04-07 10:23:11 +02:00
parent 5e8f30f61e 86815fc4e5
commit bb54616b0e
2 changed files with 32 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/org.texi
View File

@ -547,7 +547,7 @@ Custom agenda views
Markup for rich export Markup for rich export
* Structural markup elements:: The basic structure as seen by the exporter * Structural markup elements:: The basic structure as seen by the exporter
* Images and tables:: Tables and Images will be included * Images and tables:: Images, tables and caption mechanism
* Literal examples:: Source code examples with special formatting * Literal examples:: Source code examples with special formatting
* Include files:: Include additional files into a document * Include files:: Include additional files into a document
* Index entries:: Making an index * Index entries:: Making an index
@ -3381,9 +3381,9 @@ completions.}.
During export, internal links will be used to mark objects and assign them During export, internal links will be used to mark objects and assign them
a number. Marked objects will then be referenced by links pointing to them. a number. Marked objects will then be referenced by links pointing to them.
In particular, links without a description will appear as the number assigned In particular, links without a description will appear as the number assigned
to the marked object@footnote{When targetting a @code{#+NAME} keyword, to the marked object@footnote{When targeting a @code{#+NAME} keyword,
@code{#+CAPTION} keyword is mandatory in order to get proper numbering.}. In @code{#+CAPTION} keyword is mandatory in order to get proper numbering
the following excerpt from an Org buffer (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
@example @example
- one item - one item
@ -9549,45 +9549,48 @@ Toggle the COMMENT keyword at the beginning of an entry.
@cindex tables, markup rules @cindex tables, markup rules
@cindex #+CAPTION @cindex #+CAPTION
@cindex #+LABEL @cindex #+NAME
Both the native Org mode tables (@pxref{Tables}) and tables formatted with 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 @file{table.el} package will be exported properly. For Org mode tables,
the lines before the first horizontal separator line will become table header the lines before the first horizontal separator line will become table header
lines. You can use the following lines somewhere before the table to assign lines. You can use the following lines somewhere before the table to assign
a caption and a label for cross references, and in the text you can refer to a caption and a label for cross references, and in the text you can refer to
the object with @code{\ref@{tab:basic-data@}}: the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
@example @example
#+CAPTION: This is the caption for the next table (or link) #+CAPTION: This is the caption for the next table (or link)
#+LABEL: tab:basic-data #+NAME: tab:basic-data
| ... | ...| | ... | ...|
|-----|----| |-----|----|
@end example @end example
Optionally, the caption can take the form: Optionally, the caption can take the form:
@example @example
#+CAPTION: [Caption for list of figures]@{Caption for table (or link).@} #+CAPTION[Caption for list of tables]: Caption for table.
@end example @end example
@cindex inlined images, markup rules @cindex inlined images, markup rules
Some backends (HTML and @LaTeX{}) allow you to directly include images into Some backends allow you to directly include images into the exported
the exported document. Org does this, if a link to an image files does not document. Org does this, if a link to an image files does not have
have a description part, for example @code{[[./img/a.jpg]]}. If you wish to 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 define a caption for the image and maybe a label for internal cross
references, make sure that the link is on a line by itself and precede it references, make sure that the link is on a line by itself and precede it
with @code{#+CAPTION} and @code{#+LABEL} as follows: with @code{#+CAPTION} and @code{#+NAME} as follows:
@example @example
#+CAPTION: This is the caption for the next figure link (or table) #+CAPTION: This is the caption for the next figure link (or table)
#+LABEL: fig:SED-HR4049 #+NAME: fig:SED-HR4049
[[./img/a.jpg]] [[./img/a.jpg]]
@end example @end example
You may also define additional attributes for the figure. As this is @noindent
backend-specific, see the sections about the individual backends for more Such images can be displayed within the buffer. @xref{Handling links,the
information. discussion of image links}.
@xref{Handling links,the discussion of image links}. Even though images and tables are prominent examples of captioned structures,
the same caption mechanism can apply to many others (e.g., @LaTeX{}
equations, source code blocks). Depending on the export back-end, those may
or may not be handled.
@node Literal examples, Include files, Images and tables, Markup @node Literal examples, Include files, Images and tables, Markup
@section Literal examples @section Literal examples

26
doc/orgguide.texi
View File

@ -2090,7 +2090,7 @@ summarizes the markup rules used in an Org-mode buffer.
@menu @menu
* Structural markup elements:: The basic structure as seen by the exporter * Structural markup elements:: The basic structure as seen by the exporter
* Images and tables:: Tables and Images will be included * Images and tables:: Images, tables and caption mechanism
* Literal examples:: Source code examples with special formatting * Literal examples:: Source code examples with special formatting
* Include files:: Include additional files into a document * Include files:: Include additional files into a document
* Embedded @LaTeX{}:: @LaTeX{} can be freely used inside Org documents * Embedded @LaTeX{}:: @LaTeX{} can be freely used inside Org documents
@ -2211,32 +2211,30 @@ Toggle the COMMENT keyword at the beginning of an entry.
For Org mode tables, the lines before the first horizontal separator line For Org mode tables, the lines before the first horizontal separator line
will become table header lines. You can use the following lines somewhere will become table header lines. You can use the following lines somewhere
before the table to assign a caption and a label for cross references, and in before the table to assign a caption and a label for cross references, and in
the text you can refer to the object with @code{\ref@{tab:basic-data@}}: the text you can refer to the object with @code{[[tab:basic-data]]}:
@smallexample @smallexample
#+CAPTION: This is the caption for the next table (or link) #+CAPTION: This is the caption for the next table (or link)
#+LABEL: tbl:basic-data #+NAME: tbl:basic-data
| ... | ...| | ... | ...|
|-----|----| |-----|----|
@end smallexample @end smallexample
Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include Some backends allow you to directly include images into the exported
images into the exported document. Org does this, if a link to an image document. Org does this, if a link to an image files does not have
files does not have a description part, for example @code{[[./img/a.jpg]]}. a description part, for example @code{[[./img/a.jpg]]}. If you wish to
If you wish to define a caption for the image and maybe a label for internal define a caption for the image and maybe a label for internal cross
cross references, you sure that the link is on a line by itself precede it references, you sure that the link is on a line by itself precede it with:
with:
@smallexample @smallexample
#+CAPTION: This is the caption for the next figure link (or table) #+CAPTION: This is the caption for the next figure link (or table)
#+LABEL: fig:SED-HR4049 #+NAME: fig:SED-HR4049
[[./img/a.jpg]] [[./img/a.jpg]]
@end smallexample @end smallexample
You may also define additional attributes for the figure. As this is The same caption mechanism applies to other structures than images and tables
backend-specific, see the sections about the individual backends for more (e.g., @LaTeX{} equations, source code blocks), provided the chosen export
information. back-end supports them.
@node Literal examples, Include files, Images and tables, Markup @node Literal examples, Include files, Images and tables, Markup
@section Literal examples @section Literal examples