aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Dominik2009-01-25 15:57:04 +0000
committerCarsten Dominik2009-01-25 15:57:04 +0000
commit55e0839db58e3a37588d7e4faba31a28b3a56e62 (patch)
tree3a69d72788ecc5ecd6da22f1d2a013c9ed28af3d
parent0bd48b37bb27e64f7502ad8603f7ace81ca617e6 (diff)
downloademacs-55e0839db58e3a37588d7e4faba31a28b3a56e62.tar.gz
emacs-55e0839db58e3a37588d7e4faba31a28b3a56e62.zip
2009-01-25 Carsten Dominik <dominik@science.uva.nl>
* org.texi (References): Add information about remote references. (Built-in table editor): Document `C-c RET' in tables. (Math symbols, Quoting LaTeX code): Mention that simple LaTeX macros survive LaTeX export. (Images in LaTeX export): Show how to create a reference to a figure. (Sectioning structure): Document that the LaTeX class can be specified in a property. (Text areas in HTML export): New section. (External links): Add examples for text search and ID links. (Built-in table editor): Remove the descriptio of `C-c C-q', it not longer works. (Literal examples): Document that a space must follow the colon in short examples. (Relative timer): Document `org-timer-stop'. (Footnotes): New section. (Footnote markup): Shorten section and refer to new Footnote section. (Literal examples): Add documentation for line numbering in and references to code examples. (CSS support): Fix the description of default CSS styles. (Capturing column view): Document "file:path/to/file.org" as an allowed value for the ID property of a dynamic block copying column view.
-rw-r--r--doc/misc/org.texi612
-rw-r--r--etc/ChangeLog6
2 files changed, 441 insertions, 177 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index 0042634561c..6d33930f7c9 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -3,8 +3,8 @@
3@setfilename ../../info/org 3@setfilename ../../info/org
4@settitle The Org Manual 4@settitle The Org Manual
5 5
6@set VERSION 6.16 6@set VERSION 6.19a
7@set DATE December 2008 7@set DATE January 2009
8 8
9@dircategory Emacs 9@dircategory Emacs
10@direntry 10@direntry
@@ -121,6 +121,7 @@ Document Structure
121* Sparse trees:: Matches embedded in context 121* Sparse trees:: Matches embedded in context
122* Plain lists:: Additional structure within an entry 122* Plain lists:: Additional structure within an entry
123* Drawers:: Tucking stuff away 123* Drawers:: Tucking stuff away
124* Footnotes:: How footnotes are defined in Org's syntax
124* Orgstruct mode:: Structure editing outside Org 125* Orgstruct mode:: Structure editing outside Org
125 126
126Archiving 127Archiving
@@ -308,7 +309,7 @@ Markup rules
308* Include files:: Include the contents of a file during export 309* Include files:: Include the contents of a file during export
309* Tables exported:: Tables are exported richly 310* Tables exported:: Tables are exported richly
310* Inlined images:: How to inline images during export 311* Inlined images:: How to inline images during export
311* Footnotes:: Numbers like [1] 312* Footnote markup::
312* Emphasis and monospace:: To bold or not to bold 313* Emphasis and monospace:: To bold or not to bold
313* TeX macros and LaTeX fragments:: Create special, rich export. 314* TeX macros and LaTeX fragments:: Create special, rich export.
314* Horizontal rules:: A line across the page 315* Horizontal rules:: A line across the page
@@ -319,7 +320,8 @@ HTML export
319* HTML Export commands:: How to invoke HTML export 320* HTML Export commands:: How to invoke HTML export
320* Quoting HTML tags:: Using direct HTML in Org mode 321* Quoting HTML tags:: Using direct HTML in Org mode
321* Links:: Transformation of links for HTML 322* Links:: Transformation of links for HTML
322* Images in HTML export:: 323* Images in HTML export:: How to insert figures into HTML output
324* Text areas in HTML export:: An alternative way to show an example
323* CSS support:: Changing the appearance of the output 325* CSS support:: Changing the appearance of the output
324* Javascript support:: Info and Folding in a web browser 326* Javascript support:: Info and Folding in a web browser
325 327
@@ -529,6 +531,7 @@ make install-info
529(require 'org-install) 531(require 'org-install)
530@end lisp 532@end lisp
531 533
534Do not forget to activate Org as described in the following section.
532 535
533@node Activation, Feedback, Installation, Introduction 536@node Activation, Feedback, Installation, Introduction
534@section Activation 537@section Activation
@@ -580,7 +583,7 @@ MY PROJECTS -*- mode: org; -*-
580the file's name is. See also the variable 583the file's name is. See also the variable
581@code{org-insert-mode-line-in-empty-file}. 584@code{org-insert-mode-line-in-empty-file}.
582 585
583Many commands in Org work on the region is the region is active. To make use 586Many commands in Org work on the region is he region is active. To make use
584of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in 587of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in
585XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to 588XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to
586do this yourself with 589do this yourself with
@@ -686,6 +689,7 @@ edit the structure of the document.
686* Sparse trees:: Matches embedded in context 689* Sparse trees:: Matches embedded in context
687* Plain lists:: Additional structure within an entry 690* Plain lists:: Additional structure within an entry
688* Drawers:: Tucking stuff away 691* Drawers:: Tucking stuff away
692* Footnotes:: How footnotes are defined in Org's syntax
689* Orgstruct mode:: Structure editing outside Org 693* Orgstruct mode:: Structure editing outside Org
690@end menu 694@end menu
691 695
@@ -991,10 +995,11 @@ Narrow buffer to current subtree.
991Widen buffer to remove a narrowing. 995Widen buffer to remove a narrowing.
992@kindex C-c * 996@kindex C-c *
993@item C-c * 997@item C-c *
994Turn a normal line or plain list item into a headline (so that it 998Turn a normal line or plain list item into a headline (so that it becomes a
995becomes a subheading at its location). Also turn a headline into a 999subheading at its location). Also turn a headline into a normal line by
996normal line by removing the stars. If there is an active region, turn 1000removing the stars. If there is an active region, turn all lines in the
997all lines in the region into headlines. Or, if the first line is a 1001region into headlines. If the first line in the region was an item, turn
1002only the item lines into headlines. Finally, if the first line is a
998headline, remove the stars from all headlines in the region. 1003headline, remove the stars from all headlines in the region.
999@end table 1004@end table
1000 1005
@@ -1116,7 +1121,7 @@ each specifies the archive location for the text below it. The first
1116such line also applies to any text before its definition. However, 1121such line also applies to any text before its definition. However,
1117using this method is @emph{strongly} deprecated as it is incompatible 1122using this method is @emph{strongly} deprecated as it is incompatible
1118with the outline structure of the document. The correct method for 1123with the outline structure of the document. The correct method for
1119setting multiple archive locations in a buffer is using a property.}: 1124setting multiple archive locations in a buffer is using properties.}:
1120 1125
1121@example 1126@example
1122#+ARCHIVE: %s_done:: 1127#+ARCHIVE: %s_done::
@@ -1336,7 +1341,7 @@ converted into a list item.
1336Also cycle bullet styles when in the first line of an item. 1341Also cycle bullet styles when in the first line of an item.
1337@end table 1342@end table
1338 1343
1339@node Drawers, Orgstruct mode, Plain lists, Document Structure 1344@node Drawers, Footnotes, Plain lists, Document Structure
1340@section Drawers 1345@section Drawers
1341@cindex drawers 1346@cindex drawers
1342@cindex visibility cycling, drawers 1347@cindex visibility cycling, drawers
@@ -1364,7 +1369,98 @@ drawer line and press @key{TAB} there. Org mode uses a drawer for
1364storing properties (@pxref{Properties and Columns}), and another one for 1369storing properties (@pxref{Properties and Columns}), and another one for
1365storing clock times (@pxref{Clocking work time}). 1370storing clock times (@pxref{Clocking work time}).
1366 1371
1367@node Orgstruct mode, , Drawers, Document Structure 1372@node Footnotes, Orgstruct mode, Drawers, Document Structure
1373@section Footnotes
1374@cindex footnotes
1375
1376Org-mode supports the creation of footnotes. In contrast to the
1377@file{footnote.el} package, Org-mode's footnotes are designed for work on a
1378larger document, not only for one-off documents like emails. The basic
1379syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1380defined in a paragraph that is started by a footnote marker in square
1381brackets in column 0, no indentation allowed. If you need a paragraph break
1382inside a footnote, use the LaTeX idiom @samp{\par}. The footnote reference
1383is simply the marker in square brackets, inside text. For example:
1384
1385@example
1386The Org homepage[fn:1] now looks a lot better than it used to.
1387...
1388[fn:1] The link is: http://orgmode.org
1389@end example
1390
1391Org-mode extends the number-based syntax to @emph{named} footnotes and
1392optional inline definition. Using plain numbers as markers (as
1393@file{footnote.el} does) is supported for backward compatibility, but not
1394encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
1395LaTeX}. Here are the valid references:
1396
1397@table @code
1398@item [1]
1399A plain numeric footnote marker.
1400@item [fn:name]
1401A named footnote reference, where @code{name} is a unique label word, or, for
1402simplicity of automatic creation, a number.
1403@item [fn:: This is the inline definition of this footnote]
1404A LaTeX-like anonymous footnote where the definition is given directly at the
1405reference point.
1406@item [fn:name: a definition]
1407An inline definition of a footnote, which also specifies a name for the note.
1408Since Org allows multiple references to the same note, you can then use use
1409@code{[fn:name]} to create additional references.
1410@end table
1411
1412Footnote labels can be created automatically, or you create names yourself.
1413This is handled by the variable @code{org-footnote-auto-label} and its
1414corresponding @code{#+STARTUP} keywords, see the docstring of that variable
1415for details.
1416
1417@noindent The following command handles footnotes:
1418
1419@table @kbd
1420@kindex C-c C-x f
1421@item C-c C-x f
1422The footnote action command.
1423
1424When the cursor is on a footnote reference, jump to the definition. When it
1425is at a definition, jump to the (first) reference.
1426
1427Otherwise, create a new footnote. Depending on the variable
1428@code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1429setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1430definition will be placed right into the text as part of the reference, or
1431separately into the location determined by the variable
1432@code{org-footnote-section}.
1433
1434When this command is called with a prefix argument, a menu of additional
1435options is offered:
1436@example
1437s @r{Sort the footnote definitions by reference sequence. During editing,}
1438 @r{Org makes no effort to sort footnote definitions into a particular}
1439 @r{sequence. If you want them sorted, use this command, which will}
1440 @r{also move entries according to @code{org-footnote-section}.}
1441n @r{Normalize the footnotes by collecting all definitions (including}
1442 @r{inline definitions) into a special section, and then numbering them}
1443 @r{in sequence. The references will then also be numbers. This is}
1444 @r{meant to be the final step before finishing a document (e.g. sending}
1445 @r{off an email). The exporters do this automatically, and so could}
1446 @r{something like @code{message-send-hook}.}
1447d @r{Delete the footnote at point, and all definitions of and references}
1448 @r{to it.}
1449@end example
1450@kindex C-c C-c
1451@item C-c C-c
1452If the cursor is on a footnote reference, jump to the definition. If it is a
1453the definition, jump back to the reference. When called at a footnote
1454location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1455@kindex C-c C-o
1456@kindex mouse-1
1457@kindex mouse-2
1458@item C-c C-c @r{or} mouse-1/2
1459Footnote labels are also links to the corresponding definition/reference, and
1460you can use the usual commands to follow these links.
1461@end table
1462
1463@node Orgstruct mode, , Footnotes, Document Structure
1368@section The Orgstruct minor mode 1464@section The Orgstruct minor mode
1369@cindex Orgstruct mode 1465@cindex Orgstruct mode
1370@cindex minor mode for structure editing 1466@cindex minor mode for structure editing
@@ -1443,7 +1539,8 @@ create the above table, you would only type
1443@end example 1539@end example
1444 1540
1445@noindent and then press @key{TAB} to align the table and start filling in 1541@noindent and then press @key{TAB} to align the table and start filling in
1446fields. 1542fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1543@kbd{C-c @key{RET}}.
1447 1544
1448When typing text into a field, Org treats @key{DEL}, 1545When typing text into a field, Org treats @key{DEL},
1449@key{Backspace}, and all character keys in a special way, so that 1546@key{Backspace}, and all character keys in a special way, so that
@@ -1525,6 +1622,11 @@ created below the current one.
1525Insert a horizontal line below current row. With a prefix argument, the line 1622Insert a horizontal line below current row. With a prefix argument, the line
1526is created above the current line. 1623is created above the current line.
1527@c 1624@c
1625@kindex C-c @key{RET}
1626@item C-c @key{RET}
1627Insert a horizontal line below current row. and mode the cursor into the row
1628below that line.
1629@c
1528@kindex C-c ^ 1630@kindex C-c ^
1529@item C-c ^ 1631@item C-c ^
1530Sort the table lines in the region. The position of point indicates the 1632Sort the table lines in the region. The position of point indicates the
@@ -1557,9 +1659,7 @@ will be overwritten. If the rectangle does not fit into the present table,
1557the table is enlarged as needed. The process ignores horizontal separator 1659the table is enlarged as needed. The process ignores horizontal separator
1558lines. 1660lines.
1559@c 1661@c
1560@kindex C-c C-q
1561@kindex M-@key{RET} 1662@kindex M-@key{RET}
1562@item C-c C-q
1563@itemx M-@kbd{RET} 1663@itemx M-@kbd{RET}
1564Wrap several fields in a column like a paragraph. If there is an active 1664Wrap several fields in a column like a paragraph. If there is an active
1565region, and both point and mark are in the same column, the text in the 1665region, and both point and mark are in the same column, the text in the
@@ -1819,7 +1919,8 @@ references because the same reference operator can reference different
1819fields depending on the field being calculated by the formula. 1919fields depending on the field being calculated by the formula.
1820 1920
1821As a special case references like @samp{$LR5} and @samp{$LR12} can be used to 1921As a special case references like @samp{$LR5} and @samp{$LR12} can be used to
1822refer in a stable way to the 5th and 12th field in the last row of the table. 1922refer in a stable way to the 5th and 12th field in the last row of the
1923table.
1823 1924
1824Here are a few examples: 1925Here are a few examples:
1825 1926
@@ -1890,6 +1991,27 @@ lines. These are described below, see @ref{Advanced features}. All
1890names must start with a letter, and further consist of letters and 1991names must start with a letter, and further consist of letters and
1891numbers. 1992numbers.
1892 1993
1994@subsubheading Remote references
1995@cindex remote references
1996@cindex references, remote
1997@cindex references, to a different table
1998@cindex name, of column or field
1999@cindex constants, in calculations
2000
2001You may also reference constants, fields and ranges from a different table,
2002either in the current file or even in a different file. The syntax is
2003
2004@example
2005remote(NAME-OR-ID,REF)
2006@end example
2007
2008@noindent
2009where NAME can be the name of a table in the current file as set by a
2010@code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2011entry, even in a different file, and the reference then refers to the first
2012table in that entry. REF is an absolute field or range reference as
2013described above, valid in the referenced table.
2014
1893@node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet 2015@node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
1894@subsection Formula syntax for Calc 2016@subsection Formula syntax for Calc
1895@cindex formula syntax, Calc 2017@cindex formula syntax, Calc
@@ -2534,11 +2656,15 @@ file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
2534/home/dominik/images/jupiter.jpg @r{same as above} 2656/home/dominik/images/jupiter.jpg @r{same as above}
2535file:papers/last.pdf @r{file, relative path} 2657file:papers/last.pdf @r{file, relative path}
2536./papers/last.pdf @r{same as above} 2658./papers/last.pdf @r{same as above}
2659file:projects.org @r{another org file}
2660file:projects.org::some words @r{text search in org file}
2661file:projects.org::*task title @r{heading search in org file}
2662id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
2537news:comp.emacs @r{Usenet link} 2663news:comp.emacs @r{Usenet link}
2538mailto:adent@@galaxy.net @r{Mail link} 2664mailto:adent@@galaxy.net @r{Mail link}
2539vm:folder @r{VM folder link} 2665vm:folder @r{VM folder link}
2540vm:folder#id @r{VM message link} 2666vm:folder#id @r{VM message link}
2541vm://myself@@some.where.org/folder#id @r{VM on remote machine} 2667vm://myself@@some.where.org/folder#id @r{VM on remote machine}
2542wl:folder @r{WANDERLUST folder link} 2668wl:folder @r{WANDERLUST folder link}
2543wl:folder#id @r{WANDERLUST message link} 2669wl:folder#id @r{WANDERLUST message link}
2544mhe:folder @r{MH-E folder link} 2670mhe:folder @r{MH-E folder link}
@@ -2587,25 +2713,31 @@ insert it into an Org file, and to follow the link.
2587@kindex C-c l 2713@kindex C-c l
2588@cindex storing links 2714@cindex storing links
2589@item C-c l 2715@item C-c l
2590Store a link to the current location. This is a @emph{global} command which 2716Store a link to the current location. This is a @emph{global} command (you
2591can be used in any buffer to create a link. The link will be stored for 2717must create the key binding yourself) which can be used in any buffer to
2592later insertion into an Org buffer (see below). For Org files, if there is a 2718create a link. The link will be stored for later insertion into an Org
2593@samp{<<target>>} at the cursor, the link points to the target. Otherwise it 2719buffer (see below).
2594points to the current headline, either by text, or, if @file{org-id.el} is 2720
2595loaded, by ID property. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB 2721For Org files, if there is a @samp{<<target>>} at the cursor, the link points
2596buffers, the link will indicate the current article/entry. For W3 and W3M 2722to the target. Otherwise it points to the current headline, either by text
2597buffers, the link goes to the current URL. For IRC links, if you set the 2723(unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
2598variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a 2724is set, by ID property.
2725
2726For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
2727indicate the current article/entry. For W3 and W3M buffers, the link goes to
2728the current URL. For IRC links, if you set the variable
2729@code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
2599@samp{file:/} style link to the relevant point in the logs for the current 2730@samp{file:/} style link to the relevant point in the logs for the current
2600conversation. Otherwise an @samp{irc:/} style link to the user/channel/server 2731conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
2601under the point will be stored. For any other files, the link will point to 2732under the point will be stored.
2602the file, with a search string (@pxref{Search options}) pointing to the 2733
2603contents of the current line. If there is an active region, the selected 2734For any other files, the link will point to the file, with a search string
2604words will form the basis of the search string. If the automatically created 2735(@pxref{Search options}) pointing to the contents of the current line. If
2605link is not working correctly or accurately enough, you can write custom 2736there is an active region, the selected words will form the basis of the
2606functions to select the search string and to do the search for particular 2737search string. If the automatically created link is not working correctly or
2607file types - see @ref{Custom searches}. The key binding @kbd{C-c l} is only 2738accurately enough, you can write custom functions to select the search string
2608a suggestion - see @ref{Installation}. 2739and to do the search for particular file types - see @ref{Custom searches}.
2740The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
2609@c 2741@c
2610@kindex C-c C-l 2742@kindex C-c C-l
2611@cindex link completion 2743@cindex link completion
@@ -4215,7 +4347,9 @@ capture, you can use 3 values:
4215@example 4347@example
4216local @r{use the tree in which the capture block is located} 4348local @r{use the tree in which the capture block is located}
4217global @r{make a global view, including all headings in the file} 4349global @r{make a global view, including all headings in the file}
4218"label" @r{call column view in the tree that has an @code{:ID:}} 4350"file:path-to-file"
4351 @r{run column view at the top of this file}
4352"ID" @r{call column view in the tree that has an @code{:ID:}}
4219 @r{property with the value @i{label}. You can use} 4353 @r{property with the value @i{label}. You can use}
4220 @r{@kbd{M-x org-id-copy} to create a globally unique ID for} 4354 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
4221 @r{the current entry and copy it to the kill-ring.} 4355 @r{the current entry and copy it to the kill-ring.}
@@ -4985,6 +5119,14 @@ argument, first reset the timer to 0.
4985@item M-@key{RET} 5119@item M-@key{RET}
4986Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert 5120Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
4987new timer items. 5121new timer items.
5122@kindex C-c C-x ,
5123@item C-c C-x ,
5124Pause the timer, or continue it if it is already paused. With prefix
5125argument, stop it entirely.
5126@kindex C-u C-c C-x ,
5127@item C-u C-c C-x ,
5128Stop the timer. After this, you can only start a new timer, not continue the
5129old one. This command also removes the timer from the mode line.
4988@kindex C-c C-x 0 5130@kindex C-c C-x 0
4989@item C-c C-x 0 5131@item C-c C-x 0
4990Reset the timer without inserting anything into the buffer. By default, the 5132Reset the timer without inserting anything into the buffer. By default, the
@@ -5302,6 +5444,11 @@ to contain an absolute path.}. If you initialize this directory with
5302@code{git-init}, Org will automatically commit changes when it sees them. 5444@code{git-init}, Org will automatically commit changes when it sees them.
5303The attachment system has been contributed to Org by John Wiegley. 5445The attachment system has been contributed to Org by John Wiegley.
5304 5446
5447In cases where this seems better, you can also attach a directory of your
5448choice to an entry. You can also make children inherit the attachment
5449directory from a parent, so that an entire subtree uses the same attached
5450directory.
5451
5305@noindent The following commands deal with attachments. 5452@noindent The following commands deal with attachments.
5306 5453
5307@table @kbd 5454@table @kbd
@@ -5362,6 +5509,16 @@ Select and delete a single attachment.
5362@item D 5509@item D
5363Delete all of a task's attachments. A safer way is to open the directory in 5510Delete all of a task's attachments. A safer way is to open the directory in
5364dired and delete from there. 5511dired and delete from there.
5512
5513@kindex C-c C-a s
5514@item C-c C-a s
5515Set a specific directory as the entry's attachment directory. This works by
5516putting the directory path into the @code{ATTACH_DIR} property.
5517
5518@kindex C-c C-a i
5519@item C-c C-a i
5520Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
5521same directory for attachments as the parent.
5365@end table 5522@end table
5366@end table 5523@end table
5367 5524
@@ -5872,8 +6029,8 @@ property.}:
5872 6029
5873@noindent 6030@noindent
5874If you would like to have a special CATEGORY for a single entry or a 6031If you would like to have a special CATEGORY for a single entry or a
5875(sub)tree, give the entry a @code{:CATEGORY:} property with the location 6032(sub)tree, give the entry a @code{:CATEGORY:} property with the
5876as the value (@pxref{Properties and Columns}). 6033special category you want to apply as the value.
5877 6034
5878@noindent 6035@noindent
5879The display in the agenda buffer looks best if the category is not 6036The display in the agenda buffer looks best if the category is not
@@ -5921,7 +6078,7 @@ timed entries are embedded in a time grid, like
5921 18:00...... ------------------ 6078 18:00...... ------------------
5922 19:00...... The Vogon reads his poem 6079 19:00...... The Vogon reads his poem
5923 20:00...... ------------------ 6080 20:00...... ------------------
5924 20:30-22:15 Marvin escorts the Hitchhikers to the bridge 6081 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
5925@end example 6082@end example
5926 6083
5927The time grid can be turned on and off with the variable 6084The time grid can be turned on and off with the variable
@@ -6024,7 +6181,7 @@ previously used indirect buffer.
6024@c 6181@c
6025@kindex l 6182@kindex l
6026@item l 6183@item l
6027Toggle Logbook mode. In Logbook mode, entries that where marked DONE while 6184Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
6028logging was on (variable @code{org-log-done}) are shown in the agenda, as are 6185logging was on (variable @code{org-log-done}) are shown in the agenda, as are
6029entries that have been clocked on that day. You can configure the entry 6186entries that have been clocked on that day. You can configure the entry
6030types that should be included in log mode using the variable 6187types that should be included in log mode using the variable
@@ -6034,10 +6191,10 @@ prefix args @kbd{C-u C-u}, show only logging information, nothing else.
6034@c 6191@c
6035@kindex v 6192@kindex v
6036@item v 6193@item v
6037Toggle Archives mode. In archives mode, trees that are marked are also 6194Toggle Archives mode. In archives mode, trees that are marked
6038scanned when producing the agenda. When you call this command with a 6195@code{ARCHIVED} are also scanned when producing the agenda. When you call
6039@kbd{C-u} prefix argument, even all archive files are included. To exit 6196this command with a @kbd{C-u} prefix argument, even all archive files are
6040archives mode, press @kbd{v} again. 6197included. To exit archives mode, press @kbd{v} again.
6041@c 6198@c
6042@kindex R 6199@kindex R
6043@item R 6200@item R
@@ -6577,7 +6734,7 @@ yourself.
6577If you are away from your computer, it can be very useful to have a 6734If you are away from your computer, it can be very useful to have a
6578printed version of some agenda views to carry around. Org mode can 6735printed version of some agenda views to carry around. Org mode can
6579export custom agenda views as plain text, HTML@footnote{You need to 6736export custom agenda views as plain text, HTML@footnote{You need to
6580install Hrvoje Niksic's @file{htmlize.el}.}, postscript, and iCalendar 6737install Hrvoje Niksic's @file{htmlize.el}.} postscript, and iCalendar
6581files. If you want to do this only occasionally, use the command 6738files. If you want to do this only occasionally, use the command
6582 6739
6583@table @kbd 6740@table @kbd
@@ -6891,12 +7048,12 @@ to do with it.
6891@cindex math symbols 7048@cindex math symbols
6892@cindex TeX macros 7049@cindex TeX macros
6893 7050
6894You can use La@TeX{} macros to insert special symbols like @samp{\alpha} 7051You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
6895to indicate the Greek letter, or @samp{\to} to indicate an arrow. 7052indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
6896Completion for these macros is available, just type @samp{\} and maybe a 7053for these macros is available, just type @samp{\} and maybe a few letters,
6897few letters, and press @kbd{M-@key{TAB}} to see possible completions. 7054and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{}
6898Unlike La@TeX{} code, Org mode allows these macros to be present 7055code, Org mode allows these macros to be present without surrounding math
6899without surrounding math delimiters, for example: 7056delimiters, for example:
6900 7057
6901@example 7058@example
6902Angles are written as Greek letters \alpha, \beta and \gamma. 7059Angles are written as Greek letters \alpha, \beta and \gamma.
@@ -6960,12 +7117,12 @@ Environments of any kind. The only requirement is that the
6960whitespace. 7117whitespace.
6961@item 7118@item
6962Text within the usual La@TeX{} math delimiters. To avoid conflicts with 7119Text within the usual La@TeX{} math delimiters. To avoid conflicts with
6963currency specifications, single @samp{$} characters are only recognized 7120currency specifications, single @samp{$} characters are only recognized as
6964as math delimiters if the enclosed text contains at most two line breaks, 7121math delimiters if the enclosed text contains at most two line breaks, is
6965is directly attached to the @samp{$} characters with no whitespace in 7122directly attached to the @samp{$} characters with no whitespace in between,
6966between, and if the closing @samp{$} is followed by whitespace or 7123and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
6967punctuation. For the other delimiters, there is no such restriction, so 7124For the other delimiters, there is no such restriction, so when in doubt, use
6968when in doubt, use @samp{\(...\)} as inline math delimiters. 7125@samp{\(...\)} as inline math delimiters.
6969@end itemize 7126@end itemize
6970 7127
6971@noindent For example: 7128@noindent For example:
@@ -7123,7 +7280,7 @@ markup rule used in an Org mode buffer.
7123* Include files:: Include the contents of a file during export 7280* Include files:: Include the contents of a file during export
7124* Tables exported:: Tables are exported richly 7281* Tables exported:: Tables are exported richly
7125* Inlined images:: How to inline images during export 7282* Inlined images:: How to inline images during export
7126* Footnotes:: Numbers like [1] 7283* Footnote markup::
7127* Emphasis and monospace:: To bold or not to bold 7284* Emphasis and monospace:: To bold or not to bold
7128* TeX macros and LaTeX fragments:: Create special, rich export. 7285* TeX macros and LaTeX fragments:: Create special, rich export.
7129* Horizontal rules:: A line across the page 7286* Horizontal rules:: A line across the page
@@ -7254,6 +7411,7 @@ but not any simpler -- Albert Einstein
7254@node Literal examples, Include files, Paragraphs, Markup rules 7411@node Literal examples, Include files, Paragraphs, Markup rules
7255@subheading Literal examples 7412@subheading Literal examples
7256@cindex literal examples, markup rules 7413@cindex literal examples, markup rules
7414@cindex code line refenences, markup rules
7257 7415
7258You can include literal examples that should not be subjected to 7416You can include literal examples that should not be subjected to
7259markup. Such examples will be typeset in monospace, so this is well suited 7417markup. Such examples will be typeset in monospace, so this is well suited
@@ -7267,10 +7425,12 @@ Some example from a text file.
7267@end example 7425@end example
7268 7426
7269For simplicity when using small examples, you can also start the example 7427For simplicity when using small examples, you can also start the example
7270lines with a colon: 7428lines with a colon followed by a space. There may also be additional
7429whitespace before the colon:
7271 7430
7272@example 7431@example
7273: Some example from a text file. 7432Here is an example
7433 : Some example from a text file.
7274@end example 7434@end example
7275 7435
7276@cindex formatting source code, markup rules 7436@cindex formatting source code, markup rules
@@ -7291,6 +7451,37 @@ example:
7291#+END_SRC 7451#+END_SRC
7292@end example 7452@end example
7293 7453
7454Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
7455switch to the end of the @code{BEGIN} line, to get the lines of the example
7456numbered. If you use a @code{+n} switch, the numbering from the previous
7457numbered snippet will be continued in the current one. In literal examples,
7458Org will interpret strings like @samp{(ref:name)} as labels, and use them as
7459targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference
7460name enclosed in single parenthesis). In HTML, hoovering the mouse over such
7461a link will remote-highlight the corresponding code line, which is kind of
7462cool. If the example/src snippet is numbered, you can also add a @code{-r}
7463switch. Then labels will be @i{removed} from the source code and the links
7464will be @i{replaced}@footnote{If you want to explain the use of such labels
7465themelves in org-mode example code, you can use the @code{-k} switch to make
7466sure they are not touched.} with line numbers from the code listing. Here is
7467an example:
7468
7469@example
7470#+BEGIN_SRC emacs-lisp -n -r
7471(save-excursion (ref:sc)
7472 (goto-char (point-min)) (ref:jump)
7473#+END SRC
7474In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
7475jumps to point-min.
7476@end example
7477
7478If the syntax for the label format conflicts with the language syntax, use a
7479@code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
7480-n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
7481
7482HTML export also allows examples to be publishes as text areas, @pxref{Text
7483areas in HTML export}
7484
7294@table @kbd 7485@table @kbd
7295@kindex C-c ' 7486@kindex C-c '
7296@item C-c ' 7487@item C-c '
@@ -7306,6 +7497,13 @@ edited using @code{artist-mode}@footnote{You may select a different-mode with
7306the variable @code{org-edit-fixed-width-region-mode}.} to allow creating 7497the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
7307ASCII drawings easily. Using this command in an empty line will create a new 7498ASCII drawings easily. Using this command in an empty line will create a new
7308fixed-width region. 7499fixed-width region.
7500@kindex C-c l
7501@item C-c l
7502Calling @code{org-store-link} while editing a source code example in a
7503temporary buffer created with @kbd{C-c '} will prompt for a label, make sure
7504that it is unique in the current buffer, and insert it with the proper
7505formatting like @samp{(ref:label)} at the end of the current line. Then the
7506label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
7309@end table 7507@end table
7310 7508
7311 7509
@@ -7327,8 +7525,8 @@ language for formatting the contents. The markup is optional, if it is not
7327given, the text will be assumed to be in Org mode format and will be 7525given, the text will be assumed to be in Org mode format and will be
7328processed normally. The include line will also allow additional keyword 7526processed normally. The include line will also allow additional keyword
7329parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the 7527parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
7330first line and for each following line. For example, to include a file as an 7528first line and for each following line, as well as any options accepted by
7331item, use 7529the selected markup. For example, to include a file as an item, use
7332 7530
7333@example 7531@example
7334#+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " 7532#+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
@@ -7355,7 +7553,7 @@ a caption and a label for cross references:
7355#+LABEL: tbl:basic-data 7553#+LABEL: tbl:basic-data
7356@end example 7554@end example
7357 7555
7358@node Inlined images, Footnotes, Tables exported, Markup rules 7556@node Inlined images, Footnote markup, Tables exported, Markup rules
7359@subheading Inlined Images 7557@subheading Inlined Images
7360@cindex inlined images, markup rules 7558@cindex inlined images, markup rules
7361 7559
@@ -7374,29 +7572,16 @@ You may also define additional attributes for the figure. As this is
7374backend-specific, see the sections about the individual backends for more 7572backend-specific, see the sections about the individual backends for more
7375information. 7573information.
7376 7574
7377@node Footnotes, Emphasis and monospace, Inlined images, Markup rules 7575@node Footnote markup, Emphasis and monospace, Inlined images, Markup rules
7378@subheading Footnotes 7576@subheading Footnote markup
7379@cindex footnotes, markup rules 7577@cindex footnotes, markup rules
7380@cindex @file{footnote.el} 7578@cindex @file{footnote.el}
7381 7579
7382@kindex C-c ! 7580Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
7383Numbers in square brackets are treated as footnote markers, and lines 7581all backends. Org does allow multiple references to the same note, and
7384starting with such a marker are interpreted as the footnote itself. You can 7582different backends support this to varying degree.
7385use the Emacs package @file{footnote.el} to create footnotes@footnote{The
7386@file{footnote} package uses @kbd{C-c !} to invoke its commands. This
7387binding conflicts with the Org mode command for inserting inactive time
7388stamps. You could use the variable @code{footnote-prefix} to switch
7389footnotes commands to another key. Or, if you are too used to this binding,
7390you could use @code{org-replace-disputed-keys} and @code{org-disputed-keys}
7391to change the settings in Org.}. For example:
7392
7393@example
7394The Org homepage[1] now looks a lot better than it used to.
7395
7396[1] The link is: http://orgmode.org
7397@end example
7398 7583
7399@node Emphasis and monospace, TeX macros and LaTeX fragments, Footnotes, Markup rules 7584@node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
7400@subheading Emphasis and monospace 7585@subheading Emphasis and monospace
7401 7586
7402@cindex underlined text, markup rules 7587@cindex underlined text, markup rules
@@ -7425,7 +7610,7 @@ output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
7425This applies for a large number of entities, with names taken from both HTML 7610This applies for a large number of entities, with names taken from both HTML
7426and La@TeX{}, see the variable @code{org-html-entities} for the complete 7611and La@TeX{}, see the variable @code{org-html-entities} for the complete
7427list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion 7612list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
7428after having types the backslash and maybe a few characters 7613after having typed the backslash and maybe a few characters
7429(@pxref{Completion}). 7614(@pxref{Completion}).
7430 7615
7431La@TeX{} fragments are converted into images for HTML export, and they are 7616La@TeX{} fragments are converted into images for HTML export, and they are
@@ -7665,7 +7850,8 @@ language, but with additional support for tables.
7665* HTML Export commands:: How to invoke HTML export 7850* HTML Export commands:: How to invoke HTML export
7666* Quoting HTML tags:: Using direct HTML in Org mode 7851* Quoting HTML tags:: Using direct HTML in Org mode
7667* Links:: Transformation of links for HTML 7852* Links:: Transformation of links for HTML
7668* Images in HTML export:: 7853* Images in HTML export:: How to insert figures into HTML output
7854* Text areas in HTML export:: An alternative way to show an example
7669* CSS support:: Changing the appearance of the output 7855* CSS support:: Changing the appearance of the output
7670* Javascript support:: Info and Folding in a web browser 7856* Javascript support:: Info and Folding in a web browser
7671@end menu 7857@end menu
@@ -7759,14 +7945,15 @@ All lines between these markers are exported literally
7759@cindex links, in HTML export 7945@cindex links, in HTML export
7760@cindex internal links, in HTML export 7946@cindex internal links, in HTML export
7761@cindex external links, in HTML export 7947@cindex external links, in HTML export
7762Internal links (@pxref{Internal links}) will continue to work in HTML. 7948Internal links (@pxref{Internal links}) will continue to work in HTML. This
7763Automatic links created by radio targets (@pxref{Radio targets}) will also 7949does include automatic links created by radio targets (@pxref{Radio
7764work in the HTML file. Links to external files will still work if the HTML 7950targets}). Links to external files will still work if the target file is on
7765file is in the same directory as the Org file. Links to other @file{.org} 7951the same @i{relative} path as the published Org file. Links to other
7766files will be translated into HTML links under the assumption that an HTML 7952@file{.org} files will be translated into HTML links under the assumption
7767version also exists of the linked file. For information related to linking 7953that an HTML version also exists of the linked file, at the same relative
7768files while publishing them to a publishing directory see @ref{Publishing 7954path. @samp{id:} links can then be used to jump to specific entries across
7769links}. 7955files. For information related to linking files while publishing them to a
7956publishing directory see @ref{Publishing links}.
7770 7957
7771If you want to specify attributes for links, you can do so using a special 7958If you want to specify attributes for links, you can do so using a special
7772@code{#+ATTR_HTML} line to define attributes that will be added to the 7959@code{#+ATTR_HTML} line to define attributes that will be added to the
@@ -7778,7 +7965,7 @@ If you want to specify attributes for links, you can do so using a special
7778[[./img/a.jpg]] 7965[[./img/a.jpg]]
7779@end example 7966@end example
7780 7967
7781@node Images in HTML export, CSS support, Links, HTML export 7968@node Images in HTML export, Text areas in HTML export, Links, HTML export
7782@subsection Images 7969@subsection Images
7783 7970
7784@cindex images, inline in HTML 7971@cindex images, inline in HTML
@@ -7802,21 +7989,47 @@ will link to a high resolution version of the image, you could use:
7802@noindent 7989@noindent
7803and you could use @code{http} addresses just as well. 7990and you could use @code{http} addresses just as well.
7804 7991
7805@node CSS support, Javascript support, Images in HTML export, HTML export 7992@node Text areas in HTML export, CSS support, Images in HTML export, HTML export
7993@subsection Text areas
7994
7995@cindex text areas, in HTML
7996An alternative way to publish literal code examples in HTML is to use text
7997areas, where the example can even be edited before pasting it into an
7998application. It is triggered by a @code{-t} switch at an @code{example} or
7999@code{src} block. Using this switch disables any options for syntax and
8000label highlighting, and line numbering, which may be present. You may also
8001use @code{-h} and @code{-w} switches to specify the height and width of the
8002text area, which default to the number of lines in the example, and 80,
8003respectively. For example
8004
8005@example
8006#+BEGIN_EXAMPLE -t -w 40
8007(defun org-xor (a b)
8008 "Exclusive or."
8009 (if a (not b) b))
8010#+END_EXAMPLE
8011@end example
8012
8013
8014@node CSS support, Javascript support, Text areas in HTML export, HTML export
7806@subsection CSS support 8015@subsection CSS support
7807@cindex CSS, for HTML export 8016@cindex CSS, for HTML export
7808@cindex HTML export, CSS 8017@cindex HTML export, CSS
7809 8018
7810You can also give style information for the exported file. The HTML 8019You can also give style information for the exported file. The HTML exporter
7811exporter assigns the following CSS classes to appropriate parts of the 8020assigns the following special CSS classes to appropriate parts of the
7812document - your style specifications may change these: 8021document - your style specifications may change these, in addition to any of
8022the standard classes like for headlines, tables etc.
7813@example 8023@example
7814.todo @r{TODO keywords} 8024.todo @r{TODO keywords}
7815.done @r{the DONE keyword} 8025.done @r{the DONE keyword}
7816.timestamp @r{time stamp} 8026.timestamp @r{time stamp}
7817.timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} 8027.timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
7818.tag @r{tag in a headline} 8028.tag @r{tag in a headline}
7819.target @r{target for links} 8029.target @r{target for links}
8030div.figure @r{how to format an inlined image}
8031.linenr @r{the line number in a code example}
8032.code-highlighted @r{for highlighting referenced code lines}
7820@end example 8033@end example
7821 8034
7822Each exported files contains a compact default style that defines these 8035Each exported files contains a compact default style that defines these
@@ -7846,17 +8059,16 @@ referring to an external file.
7846 8059
7847@emph{Sebastian Rose} has written a JavaScript program especially designed to 8060@emph{Sebastian Rose} has written a JavaScript program especially designed to
7848enhance the web viewing experience of HTML files created with Org. This 8061enhance the web viewing experience of HTML files created with Org. This
7849program allows you to view large files in two different ways. The first one is 8062program allows you to view large files in two different ways. The first one
7850an @emph{Info}-like mode where each section is displayed separately and 8063is an @emph{Info}-like mode where each section is displayed separately and
7851navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys 8064navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
7852as well, press @kbd{?} for an overview of the available keys). The second 8065as well, press @kbd{?} for an overview of the available keys). The second
7853view type is a @emph{folding} view much like Org provides inside Emacs. 8066view type is a @emph{folding} view much like Org provides inside Emacs. The
7854The script is available at @url{http://orgmode.org/org-info.js} and you can 8067script is available at @url{http://orgmode.org/org-info.js} and you can find
7855find the documentation for it at 8068the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
7856@url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}. We are 8069We are serving the script from our site, but if you use it a lot, you might
7857serving the script from our site, but if you use it a lot, you might not want 8070not want to be dependent on @url{orgmode.org} and prefer to install a local
7858to be dependent on @url{orgmode.org} and prefer to install a local copy on 8071copy on your own web server.
7859your own web server.
7860 8072
7861To use the script, you need to make sure that the @file{org-jsinfo.el} module 8073To use the script, you need to make sure that the @file{org-jsinfo.el} module
7862gets loaded. It should be loaded by default, but you can try @kbd{M-x 8074gets loaded. It should be loaded by default, but you can try @kbd{M-x
@@ -7983,9 +8195,10 @@ creates two levels of headings and does the rest as items.
7983@subsection Quoting LaTeX code 8195@subsection Quoting LaTeX code
7984 8196
7985Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly 8197Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
7986inserted into the La@TeX{} file. Furthermore, you can add special code 8198inserted into the La@TeX{} file. This includes simple macros like
7987that should only be present in La@TeX{} export with the following 8199@samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
7988constructs: 8200you can add special code that should only be present in La@TeX{} export with
8201the following constructs:
7989 8202
7990@example 8203@example
7991#+LaTeX: Literal LaTeX code for export 8204#+LaTeX: Literal LaTeX code for export
@@ -8000,7 +8213,7 @@ All lines between these markers are exported literally
8000#+END_LaTeX 8213#+END_LaTeX
8001@end example 8214@end example
8002 8215
8003@node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export 8216@node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
8004@subsection Sectioning structure 8217@subsection Sectioning structure
8005@cindex LaTeX class 8218@cindex LaTeX class
8006@cindex LaTeX sectioning structure 8219@cindex LaTeX sectioning structure
@@ -8009,17 +8222,18 @@ By default, the La@TeX{} output uses the class @code{article}.
8009 8222
8010You can change this globally by setting a different value for 8223You can change this globally by setting a different value for
8011@code{org-export-latex-default-class} or locally by adding an option like 8224@code{org-export-latex-default-class} or locally by adding an option like
8012@code{#+LaTeX_CLASS: myclass} in your file. The class should be listed in 8225@code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
8013@code{org-export-latex-classes}, where you can also define the sectioning 8226property that applies when exporting a region containing only this (sub)tree.
8014structure for each class, as well as defining additional classes. 8227The class should be listed in @code{org-export-latex-classes}, where you can
8015 8228also define the sectioning structure for each class, as well as defining
8229additional classes.
8016 8230
8017@node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export 8231@node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
8018@subsection Tables in LaTeX export 8232@subsection Tables in LaTeX export
8019@cindex tables, in LaTeX export 8233@cindex tables, in LaTeX export
8020 8234
8021For LaTeX export of a table, you can specify a label and a caption 8235For LaTeX export of a table, you can specify a label and a caption
8022(@pxref{Tables exported}). You can also use the @code{ATTR_LaTeX} line to 8236(@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
8023request a longtable environment for the table, so that it may span several 8237request a longtable environment for the table, so that it may span several
8024pages: 8238pages:
8025 8239
@@ -8054,6 +8268,12 @@ options that can be used in the optional argument of the
8054[[./img/sed-hr4049.pdf]] 8268[[./img/sed-hr4049.pdf]]
8055@end example 8269@end example
8056 8270
8271If you need references to a label created in this way, write
8272@samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will
8273recognize files types that can be included as images during processing by
8274pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
8275files in a different way, you may need to customize the variable
8276@code{org-export-latex-inline-image-extensions}.
8057 8277
8058@node XOXO export, iCalendar export, LaTeX and PDF export, Exporting 8278@node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
8059@section XOXO export 8279@section XOXO export
@@ -8723,6 +8943,25 @@ The following options influence the table spreadsheet (variable
8723constcgs @r{@file{constants.el} should use the c-g-s unit system} 8943constcgs @r{@file{constants.el} should use the c-g-s unit system}
8724constSI @r{@file{constants.el} should use the SI unit system} 8944constSI @r{@file{constants.el} should use the SI unit system}
8725@end example 8945@end example
8946To influence footnote settings, use the following keywords. The
8947corresponding variables are @code{org-footnote-define-inline} and
8948@code{org-footnote-auto-label}.
8949@cindex @code{fninline}, STARTUP keyword
8950@cindex @code{fnnoinline}, STARTUP keyword
8951@cindex @code{fnlocal}, STARTUP keyword
8952@cindex @code{fnprompt}, STARTUP keyword
8953@cindex @code{fnauto}, STARTUP keyword
8954@cindex @code{fnconfirm}, STARTUP keyword
8955@cindex @code{fnplain}, STARTUP keyword
8956@example
8957fninline @r{define footnotes inline}
8958fnnoinline @r{define footnotes in separate section}
8959fnlocal @r{define footnotes near first reference, but not inline}
8960fnprompt @r{prompt for footnote labels}
8961fnauto @r{create [fn:1]-like labels automatically (default)}
8962fnconfirm @r{offer automatic label for editing or confirmation}
8963fnplain @r{create [1]-like labels automatically}
8964@end example
8726@item #+TAGS: TAG1(c1) TAG2(c2) 8965@item #+TAGS: TAG1(c1) TAG2(c2)
8727These lines (several such lines are allowed) specify the valid tags in 8966These lines (several such lines are allowed) specify the valid tags in
8728this file, and (potentially) the corresponding @emph{fast tag selection} 8967this file, and (potentially) the corresponding @emph{fast tag selection}
@@ -8778,6 +9017,9 @@ corresponding links in this buffer.
8778If the cursor is in a property line or at the start or end of a property 9017If the cursor is in a property line or at the start or end of a property
8779drawer, offer property commands. 9018drawer, offer property commands.
8780@item 9019@item
9020If the cursor is at a footnote reference, go to the corresponding
9021definition, and vice versa.
9022@item
8781If the cursor is in a plain list item with a checkbox, toggle the status 9023If the cursor is in a plain list item with a checkbox, toggle the status
8782of the checkbox. 9024of the checkbox.
8783@item 9025@item
@@ -9023,8 +9265,9 @@ possible.
9023@file{table.el} is part of Emacs 22. 9265@file{table.el} is part of Emacs 22.
9024@cindex @file{footnote.el} 9266@cindex @file{footnote.el}
9025@item @file{footnote.el} by Steven L. Baur 9267@item @file{footnote.el} by Steven L. Baur
9026Org mode recognizes numerical footnotes as provided by this package 9268Org mode recognizes numerical footnotes as provided by this package.
9027(@pxref{Footnotes}). 9269However, Org-mode also has its own footnote support (@pxref{Footnotes}),
9270which makes using @file{footnote.el} unnecessary.
9028@end table 9271@end table
9029 9272
9030@node Conflicts, , Cooperation, Interaction 9273@node Conflicts, , Cooperation, Interaction
@@ -9064,15 +9307,6 @@ to have other replacement keys, look at the variable
9064Also this package uses the @kbd{S-<cursor>} keys, so everything written 9307Also this package uses the @kbd{S-<cursor>} keys, so everything written
9065in the paragraph above about CUA mode also applies here. 9308in the paragraph above about CUA mode also applies here.
9066 9309
9067@cindex @file{footnote.el}
9068@item @file{footnote.el} by Steven L. Baur
9069Org supports the syntax of the footnote package, but only the
9070numerical footnote markers. Also, the default key for footnote
9071commands, @kbd{C-c !} is already used by Org. You could use the
9072variable @code{footnote-prefix} to switch footnotes commands to another
9073key. Or, you could use @code{org-replace-disputed-keys} and
9074@code{org-disputed-keys} to change the settings in Org.
9075
9076@end table 9310@end table
9077 9311
9078 9312
@@ -9134,67 +9368,85 @@ go to @url{http://orgmode.org} to get access to these modules.
9134 9368
9135@table @asis 9369@table @asis
9136@item @file{org-annotate-file.el} by @i{Philip Jackson} 9370@item @file{org-annotate-file.el} by @i{Philip Jackson}
9137 Annotate a file with org syntax, in a separate file, with links back to 9371Annotate a file with org syntax, in a separate file, with links back to the
9138 the annotated file. 9372annotated file.
9373
9139@item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German} 9374@item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
9140 Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. 9375Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. When
9141 When activating a special link or bookmark, Emacs receives a trigger to 9376activating a special link or bookmark, Emacs receives a trigger to create a
9142 create a note with a link back to the website. Requires some setup, a 9377note with a link back to the website. Requires some setup, a detailed
9143 detailed description is in 9378description is in @file{contrib/packages/org-annotation-helper}.
9144 @file{contrib/packages/org-annotation-helper}. 9379
9145@item @file{org-bookmark.el} by @i{Tokuya Kameshima} 9380@item @file{org-bookmark.el} by @i{Tokuya Kameshima}
9146 Support for links to Emacs bookmarks. 9381Support for links to Emacs bookmarks.
9382
9147@item @file{org-depend.el} by @i{Carsten Dominik} 9383@item @file{org-depend.el} by @i{Carsten Dominik}
9148 TODO dependencies for Org-mode. Make TODO state changes in one entry 9384TODO dependencies for Org-mode. Make TODO state changes in one entry trigger
9149 trigger changes in another, or be blocked by the state of another 9385changes in another, or be blocked by the state of another entry. Also,
9150 entry. Also, easily create chains of TODO items with exactly one 9386easily create chains of TODO items with exactly one active item at any time.
9151 active item at any time. 9387
9152@item @file{org-elisp-symbol.el} by @i{Bastien Guerry} 9388@item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
9153 Org links to emacs-lisp symbols. This can create annotated links that 9389Org links to emacs-lisp symbols. This can create annotated links that
9154 exactly point to the definition location of a variable of function. 9390exactly point to the definition location of a variable of function.
9391
9155@item @file{org-eval.el} by @i{Carsten Dominik} 9392@item @file{org-eval.el} by @i{Carsten Dominik}
9156 The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows 9393The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows text to
9157 text to be included in a document that is the result of evaluating some 9394be included in a document that is the result of evaluating some code. Other
9158 code. Other scripting languages like @code{perl} can be supported with 9395scripting languages like @code{perl} can be supported with this package as
9159 this package as well. 9396well.
9397
9160@item @file{org-eval-light.el} by @i{Eric Schulte} 9398@item @file{org-eval-light.el} by @i{Eric Schulte}
9161 User-controlled evaluation of code in an Org buffer. 9399User-controlled evaluation of code in an Org buffer.
9400
9162@item @file{org-exp-blocks.el} by @i{Eric Schulte} 9401@item @file{org-exp-blocks.el} by @i{Eric Schulte}
9163 Preprocess user-defined blocks for export. 9402Preprocess user-defined blocks for export.
9403
9164@item @file{org-expiry.el} by @i{Bastien Guerry} 9404@item @file{org-expiry.el} by @i{Bastien Guerry}
9165 Expiry mechanism for Org entries. 9405Expiry mechanism for Org entries.
9406
9166@item @file{org-indent.el} by @i{Carsten Dominik} 9407@item @file{org-indent.el} by @i{Carsten Dominik}
9167 Dynamic indentation of Org outlines. The plan is to indent an outline 9408Dynamic indentation of Org outlines. The plan is to indent an outline
9168 according to level, but so far this is too hard for a proper and stable 9409according to level, but so far this is too hard for a proper and stable
9169 implementation. Still, it works somewhat. 9410implementation. Still, it works somewhat.
9411
9170@item @file{org-interactive-query.el} by @i{Christopher League} 9412@item @file{org-interactive-query.el} by @i{Christopher League}
9171 Interactive modification of tags queries. After running a general 9413Interactive modification of tags queries. After running a general query in
9172 query in Org, this package allows to narrow down the results by adding 9414Org, this package allows to narrow down the results by adding more tags or
9173 more tags or keywords. 9415keywords.
9416
9174@item @file{org-mairix.el} by @i{Georg C. F. Greve} 9417@item @file{org-mairix.el} by @i{Georg C. F. Greve}
9175 Hook mairix search into Org for different MUAs. 9418Hook mairix search into Org for different MUAs.
9419
9176@item @file{org-man.el} by @i{Carsten Dominik} 9420@item @file{org-man.el} by @i{Carsten Dominik}
9177 Support for links to manpages in Org-mode. 9421Support for links to manpages in Org-mode.
9422
9178@item @file{org-mtags.el} by @i{Carsten Dominik} 9423@item @file{org-mtags.el} by @i{Carsten Dominik}
9179 Support for some Muse-like tags in Org-mode. This package allows you 9424Support for some Muse-like tags in Org-mode. This package allows you to
9180 to write @code{<example>} and @code{<src>} and other syntax copied from 9425write @code{<example>} and @code{<src>} and other syntax copied from Emacs
9181 Emacs Muse, right inside an Org file. The goal here is to make it easy 9426Muse, right inside an Org file. The goal here is to make it easy to publish
9182 to publish the same file using either org-publish or Muse. 9427the same file using either org-publish or Muse.
9428
9183@item @file{org-panel.el} by @i{Lennart Borgman} 9429@item @file{org-panel.el} by @i{Lennart Borgman}
9184 Simplified and display-aided access to some Org commands. 9430Simplified and display-aided access to some Org commands.
9431
9185@item @file{org-registry.el} by @i{Bastien Guerry} 9432@item @file{org-registry.el} by @i{Bastien Guerry}
9186 A registry for Org links, to find out from where links point to a given 9433A registry for Org links, to find out from where links point to a given file
9187 file or location. 9434or location.
9435
9188@item @file{org2rem.el} by @i{Bastien Guerry} 9436@item @file{org2rem.el} by @i{Bastien Guerry}
9189 Convert org appointments into reminders for the @file{remind} program. 9437Convert org appointments into reminders for the @file{remind} program.
9438
9190@item @file{org-screen.el} by @i{Andrew Hyatt} 9439@item @file{org-screen.el} by @i{Andrew Hyatt}
9191 Visit screen sessions through Org-mode links. 9440Visit screen sessions through Org-mode links.
9441
9192@item @file{org-toc.el} by @i{Bastien Guerry} 9442@item @file{org-toc.el} by @i{Bastien Guerry}
9193 Table of contents in a separate buffer, with fast access to sections 9443Table of contents in a separate buffer, with fast access to sections and easy
9194 and easy visibility cycling. 9444visibility cycling.
9445
9195@item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy} 9446@item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
9196 Convert Org-mode tables to SQL insertions. Documentation for this can 9447Convert Org-mode tables to SQL insertions. Documentation for this can be
9197 be found on the Org pages. 9448found on the Worg pages.
9449
9198@end table 9450@end table
9199 9451
9200@node Other extensions, , Extensions in the contrib directory, Extensions 9452@node Other extensions, , Extensions in the contrib directory, Extensions
@@ -9426,7 +9678,7 @@ header. Orgtbl mode can insert a radio table skeleton@footnote{By
9426default this works only for La@TeX{}, HTML, and Texinfo. Configure the 9678default this works only for La@TeX{}, HTML, and Texinfo. Configure the
9427variable @code{orgtbl-radio-tables} to install templates for other 9679variable @code{orgtbl-radio-tables} to install templates for other
9428modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will 9680modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
9429be prompted for a table name, lets say we use @samp{salesfigures}. You 9681be prompted for a table name, let's say we use @samp{salesfigures}. You
9430will then get the following template: 9682will then get the following template:
9431 9683
9432@cindex #+ORGTBL: SEND 9684@cindex #+ORGTBL: SEND
@@ -9471,7 +9723,7 @@ variable @code{LaTeX-verbatim-environments}.}:
9471When you are done, press @kbd{C-c C-c} in the table to get the converted 9723When you are done, press @kbd{C-c C-c} in the table to get the converted
9472table inserted between the two marker lines. 9724table inserted between the two marker lines.
9473 9725
9474Now lets assume you want to make the table header by hand, because you 9726Now let's assume you want to make the table header by hand, because you
9475want to control how columns are aligned etc. In this case we make sure 9727want to control how columns are aligned etc. In this case we make sure
9476that the table translator does skip the first 2 lines of the source 9728that the table translator does skip the first 2 lines of the source
9477table, and tell the command to work as a @i{splice}, i.e. to not produce 9729table, and tell the command to work as a @i{splice}, i.e. to not produce
@@ -10059,6 +10311,9 @@ folded entries, and column view for properties.
10059@i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also 10311@i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
10060provided frequent feedback and some patches. 10312provided frequent feedback and some patches.
10061@item 10313@item
10314@i{Matt Lundin} has proposed last-row references for table formulas and named
10315invisible anchors. He has also worked a lot on the FAQ.
10316@item
10062@i{Jason F. McBrayer} suggested agenda export to CSV format. 10317@i{Jason F. McBrayer} suggested agenda export to CSV format.
10063@item 10318@item
10064@i{Max Mikhanosha} came up with the idea of refiling. 10319@i{Max Mikhanosha} came up with the idea of refiling.
@@ -10093,6 +10348,8 @@ provided frequent feedback.
10093@i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality 10348@i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
10094control. 10349control.
10095@item 10350@item
10351@i{Paul Rivier} provided the basic implementation of named footnotes.
10352@item
10096@i{Kevin Rogers} contributed code to access VM files on remote hosts. 10353@i{Kevin Rogers} contributed code to access VM files on remote hosts.
10097@item 10354@item
10098@i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying 10355@i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
@@ -10116,7 +10373,8 @@ other things.
10116Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s 10373Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
10117@file{organizer-mode.el}. 10374@file{organizer-mode.el}.
10118@item 10375@item
10119@i{Ilya Shlyakhter} proposed the Archive Sibling. 10376@i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
10377examples, and remote highlighting for referenced code lines.
10120@item 10378@item
10121@i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is 10379@i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
10122now packaged into Org's @file{contrib} directory. 10380now packaged into Org's @file{contrib} directory.
diff --git a/etc/ChangeLog b/etc/ChangeLog
index c5791e2bd4e..0114da8a9e4 100644
--- a/etc/ChangeLog
+++ b/etc/ChangeLog
@@ -1,3 +1,9 @@
12009-01-25 Carsten Dominik <dominik@science.uva.nl>
2
3 * refcards/orgcard.tex: New year and version number.
4 Document heading/item conversion commands.
5 Document C-c RET in tables.
6
12009-01-03 Michael Albinus <michael.albinus@gmx.de> 72009-01-03 Michael Albinus <michael.albinus@gmx.de>
2 8
3 * NEWS: Tramp supports IPv6 addresses. 9 * NEWS: Tramp supports IPv6 addresses.