diff options
| author | Carsten Dominik | 2008-10-12 06:22:56 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2008-10-12 06:22:56 +0000 |
| commit | 864c974046643cafbd269cf3d8dd62a6125395ee (patch) | |
| tree | 47d9da0449ead0054fb584954570759d14d58a14 | |
| parent | a6520ff37856b7dcdeefc72167aa00ce3a3d7091 (diff) | |
| download | emacs-864c974046643cafbd269cf3d8dd62a6125395ee.tar.gz emacs-864c974046643cafbd269cf3d8dd62a6125395ee.zip | |
Lots of minor fixes.
(Capture): New chapter.
(Org Plot): New section.
| -rw-r--r-- | doc/misc/ChangeLog | 2 | ||||
| -rw-r--r-- | doc/misc/org.texi | 483 |
2 files changed, 371 insertions, 114 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index a007d30b9d1..a244fba1548 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | 2008-10-12 Carsten Dominik <dominik@science.uva.nl> | 1 | 2008-10-12 Carsten Dominik <dominik@science.uva.nl> |
| 2 | 2 | ||
| 3 | * org.texi: Lost of minor fixes. | 3 | * org.texi: Lots of minor fixes. |
| 4 | (Capture): New chapter. | 4 | (Capture): New chapter. |
| 5 | (Org Plot): New section. | 5 | (Org Plot): New section. |
| 6 | 6 | ||
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 39ac7c0f8fc..019d9578e13 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.06b | 6 | @set VERSION 6.09a |
| 7 | @set DATE July 2008 | 7 | @set DATE October 2008 |
| 8 | 8 | ||
| 9 | @dircategory Emacs | 9 | @dircategory Emacs |
| 10 | @direntry | 10 | @direntry |
| @@ -87,7 +87,7 @@ license to the document, as described in section 6 of the license. | |||
| 87 | * Tags:: Tagging headlines and matching sets of tags | 87 | * Tags:: Tagging headlines and matching sets of tags |
| 88 | * Properties and Columns:: Storing information about an entry | 88 | * Properties and Columns:: Storing information about an entry |
| 89 | * Dates and Times:: Making items useful for planning | 89 | * Dates and Times:: Making items useful for planning |
| 90 | * Remember:: Quickly adding nodes to the outline tree | 90 | * Capture:: Creating tasks and attaching files |
| 91 | * Agenda Views:: Collecting information into views | 91 | * Agenda Views:: Collecting information into views |
| 92 | * Embedded LaTeX:: LaTeX fragments and formulas | 92 | * Embedded LaTeX:: LaTeX fragments and formulas |
| 93 | * Exporting:: Sharing and publishing of notes | 93 | * Exporting:: Sharing and publishing of notes |
| @@ -135,6 +135,7 @@ Tables | |||
| 135 | * Column groups:: Grouping to trigger vertical lines | 135 | * Column groups:: Grouping to trigger vertical lines |
| 136 | * Orgtbl mode:: The table editor as minor mode | 136 | * Orgtbl mode:: The table editor as minor mode |
| 137 | * The spreadsheet:: The table editor has spreadsheet capabilities | 137 | * The spreadsheet:: The table editor has spreadsheet capabilities |
| 138 | * Org Plot:: Plotting from org tables | ||
| 138 | 139 | ||
| 139 | The spreadsheet | 140 | The spreadsheet |
| 140 | 141 | ||
| @@ -229,6 +230,11 @@ Deadlines and scheduling | |||
| 229 | * Inserting deadline/schedule:: Planning items | 230 | * Inserting deadline/schedule:: Planning items |
| 230 | * Repeated tasks:: Items that show up again and again | 231 | * Repeated tasks:: Items that show up again and again |
| 231 | 232 | ||
| 233 | Capture | ||
| 234 | |||
| 235 | * Remember:: Capture new tasks/ideas with little interruption | ||
| 236 | * Attachments:: Add files to tasks. | ||
| 237 | |||
| 232 | Remember | 238 | Remember |
| 233 | 239 | ||
| 234 | * Setting up Remember:: Some code for .emacs to get things going | 240 | * Setting up Remember:: Some code for .emacs to get things going |
| @@ -280,6 +286,7 @@ Embedded LaTeX | |||
| 280 | Exporting | 286 | Exporting |
| 281 | 287 | ||
| 282 | * Markup rules:: Which structures are recognized? | 288 | * Markup rules:: Which structures are recognized? |
| 289 | * Selective export:: Using tags to select and exclude trees | ||
| 283 | * Export options:: Per-file export settings | 290 | * Export options:: Per-file export settings |
| 284 | * The export dispatcher:: How to access exporter commands | 291 | * The export dispatcher:: How to access exporter commands |
| 285 | * ASCII export:: Exporting to plain ASCII | 292 | * ASCII export:: Exporting to plain ASCII |
| @@ -768,9 +775,9 @@ CONTENTS view up to headlines of level N will be shown. Note that inside | |||
| 768 | tables, @kbd{S-@key{TAB}} jumps to the previous field. | 775 | tables, @kbd{S-@key{TAB}} jumps to the previous field. |
| 769 | 776 | ||
| 770 | @cindex show all, command | 777 | @cindex show all, command |
| 771 | @kindex C-c C-a | 778 | @kindex C-u C-u C-u @key{TAB} |
| 772 | @item C-c C-a | 779 | @item C-u C-u C-u @key{TAB} |
| 773 | Show all. | 780 | Show all, including drawers. |
| 774 | @kindex C-c C-r | 781 | @kindex C-c C-r |
| 775 | @item C-c C-r | 782 | @item C-c C-r |
| 776 | Reveal context around point, showing the current entry, the following heading | 783 | Reveal context around point, showing the current entry, the following heading |
| @@ -890,11 +897,16 @@ of a headline), then a headline like the current one will be inserted | |||
| 890 | after the end of the subtree. | 897 | after the end of the subtree. |
| 891 | @kindex C-@key{RET} | 898 | @kindex C-@key{RET} |
| 892 | @item C-@key{RET} | 899 | @item C-@key{RET} |
| 893 | Insert a new heading after the current subtree, same level as the | 900 | Just like @kbd{M-@key{RET}}, but if the heading is inserted after the current, |
| 894 | current headline. This command works from anywhere in the entry. | 901 | insert it actually after the entire subtree. |
| 895 | @kindex M-S-@key{RET} | 902 | @kindex M-S-@key{RET} |
| 896 | @item M-S-@key{RET} | 903 | @item M-S-@key{RET} |
| 897 | Insert new TODO entry with same level as current heading. | 904 | Insert new TODO entry with same level as current heading. |
| 905 | @kindex C-S-@key{RET} | ||
| 906 | @item C-S-@key{RET} | ||
| 907 | Insert new TODO entry with same level as current heading. Like | ||
| 908 | @kbd{C-@key{RET}}, the new headline will be inserted after the current | ||
| 909 | subtree. | ||
| 898 | @kindex M-@key{left} | 910 | @kindex M-@key{left} |
| 899 | @item M-@key{left} | 911 | @item M-@key{left} |
| 900 | Promote current heading by one level. | 912 | Promote current heading by one level. |
| @@ -1366,6 +1378,7 @@ calculator). | |||
| 1366 | * Column groups:: Grouping to trigger vertical lines | 1378 | * Column groups:: Grouping to trigger vertical lines |
| 1367 | * Orgtbl mode:: The table editor as minor mode | 1379 | * Orgtbl mode:: The table editor as minor mode |
| 1368 | * The spreadsheet:: The table editor has spreadsheet capabilities | 1380 | * The spreadsheet:: The table editor has spreadsheet capabilities |
| 1381 | * Org Plot:: Plotting from org tables | ||
| 1369 | @end menu | 1382 | @end menu |
| 1370 | 1383 | ||
| 1371 | @node Built-in table editor, Narrow columns, Tables, Tables | 1384 | @node Built-in table editor, Narrow columns, Tables, Tables |
| @@ -1508,7 +1521,7 @@ blank all fields in the rectangle. So this is the ``cut'' operation. | |||
| 1508 | @kindex C-c C-x C-y | 1521 | @kindex C-c C-x C-y |
| 1509 | @item C-c C-x C-y | 1522 | @item C-c C-x C-y |
| 1510 | Paste a rectangular region into a table. | 1523 | Paste a rectangular region into a table. |
| 1511 | The upper right corner ends up in the current field. All involved fields | 1524 | The upper left corner ends up in the current field. All involved fields |
| 1512 | will be overwritten. If the rectangle does not fit into the present table, | 1525 | will be overwritten. If the rectangle does not fit into the present table, |
| 1513 | the table is enlarged as needed. The process ignores horizontal separator | 1526 | the table is enlarged as needed. The process ignores horizontal separator |
| 1514 | lines. | 1527 | lines. |
| @@ -1540,12 +1553,12 @@ be inserted with @kbd{C-y}. | |||
| 1540 | @c | 1553 | @c |
| 1541 | @kindex S-@key{RET} | 1554 | @kindex S-@key{RET} |
| 1542 | @item S-@key{RET} | 1555 | @item S-@key{RET} |
| 1543 | When current field is empty, copy from first non-empty field above. | 1556 | When current field is empty, copy from first non-empty field above. When not |
| 1544 | When not empty, copy current field down to next row and move cursor | 1557 | empty, copy current field down to next row and move cursor along with it. |
| 1545 | along with it. Depending on the variable | 1558 | Depending on the variable @code{org-table-copy-increment}, integer field |
| 1546 | @code{org-table-copy-increment}, integer field values will be | 1559 | values will be incremented during copy. Integers that are too large will not |
| 1547 | incremented during copy. This key is also used by CUA mode | 1560 | be incremented. Also, a @code{0} prefix argument temporarily dispables the |
| 1548 | (@pxref{Cooperation}). | 1561 | increment. This key is also used by CUA mode (@pxref{Cooperation}). |
| 1549 | 1562 | ||
| 1550 | @tsubheading{Miscellaneous} | 1563 | @tsubheading{Miscellaneous} |
| 1551 | @kindex C-c ` | 1564 | @kindex C-c ` |
| @@ -1693,7 +1706,7 @@ construct La@TeX{} tables with the underlying ease and power of | |||
| 1693 | Orgtbl mode, including spreadsheet capabilities. For details, see | 1706 | Orgtbl mode, including spreadsheet capabilities. For details, see |
| 1694 | @ref{Tables in arbitrary syntax}. | 1707 | @ref{Tables in arbitrary syntax}. |
| 1695 | 1708 | ||
| 1696 | @node The spreadsheet, , Orgtbl mode, Tables | 1709 | @node The spreadsheet, Org Plot, Orgtbl mode, Tables |
| 1697 | @section The spreadsheet | 1710 | @section The spreadsheet |
| 1698 | @cindex calculations, in tables | 1711 | @cindex calculations, in tables |
| 1699 | @cindex spreadsheet capabilities | 1712 | @cindex spreadsheet capabilities |
| @@ -2160,9 +2173,8 @@ to reserve the first column of the table for special marking characters. | |||
| 2160 | @kindex C-# | 2173 | @kindex C-# |
| 2161 | @item C-# | 2174 | @item C-# |
| 2162 | Rotate the calculation mark in first column through the states @samp{}, | 2175 | Rotate the calculation mark in first column through the states @samp{}, |
| 2163 | @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters | 2176 | @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, |
| 2164 | is discussed below. When there is an active region, change all marks in | 2177 | change all marks in the region. |
| 2165 | the region. | ||
| 2166 | @end table | 2178 | @end table |
| 2167 | 2179 | ||
| 2168 | Here is an example of a table that collects exam results of students and | 2180 | Here is an example of a table that collects exam results of students and |
| @@ -2178,7 +2190,6 @@ makes use of these features: | |||
| 2178 | | ^ | | m1 | m2 | m3 | mt | | | 2190 | | ^ | | m1 | m2 | m3 | mt | | |
| 2179 | |---+---------+--------+--------+--------+-------+------| | 2191 | |---+---------+--------+--------+--------+-------+------| |
| 2180 | | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | 2192 | | # | Peter | 10 | 8 | 23 | 41 | 8.2 | |
| 2181 | | # | Sara | 6 | 14 | 19 | 39 | 7.8 | | ||
| 2182 | | # | Sam | 2 | 4 | 3 | 9 | 1.8 | | 2193 | | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
| 2183 | |---+---------+--------+--------+--------+-------+------| | 2194 | |---+---------+--------+--------+--------+-------+------| |
| 2184 | | | Average | | | | 29.7 | | | 2195 | | | Average | | | | 29.7 | | |
| @@ -2254,6 +2265,87 @@ functions. | |||
| 2254 | @end group | 2265 | @end group |
| 2255 | @end example | 2266 | @end example |
| 2256 | 2267 | ||
| 2268 | @page | ||
| 2269 | @node Org Plot, , The spreadsheet, Tables | ||
| 2270 | @section Org Plot | ||
| 2271 | @cindex graph, in tables | ||
| 2272 | @cindex plot tables using gnuplot | ||
| 2273 | |||
| 2274 | Org Plot can produce 2D and 3D graphs of information stored in org tables | ||
| 2275 | using @file{Gnuplot} (see @uref{http://www.gnuplot.info/, the Gnuplot | ||
| 2276 | website}) and @file{gnuplot-mode} (see | ||
| 2277 | @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html, the | ||
| 2278 | gnuplot-mode website}). To see this in action ensure that you have both | ||
| 2279 | Gnuplot and Gnuplot-mode installed on your system, then call | ||
| 2280 | @code{org-plot/gnuplot} on the following table. | ||
| 2281 | |||
| 2282 | @example | ||
| 2283 | @group | ||
| 2284 | #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" | ||
| 2285 | | Sede | Max cites | H-index | | ||
| 2286 | |-----------+-----------+---------| | ||
| 2287 | | Chile | 257.72 | 21.39 | | ||
| 2288 | | Leeds | 165.77 | 19.68 | | ||
| 2289 | | Sao Paolo | 71.00 | 11.50 | | ||
| 2290 | | Stockholm | 134.19 | 14.33 | | ||
| 2291 | | Morelia | 257.56 | 17.67 | | ||
| 2292 | @end group | ||
| 2293 | @end example | ||
| 2294 | |||
| 2295 | Notice that Org Plot is smart enough to apply the tables headers as labels. | ||
| 2296 | Further control over the labels, type, content, and appearance of plots can | ||
| 2297 | be exercised through the @code{#+Plot:} lines preceding a table. See below | ||
| 2298 | for a complete list of Org plot options. For more information and examples | ||
| 2299 | @uref{http://orgmode.org/worg/org-tutorials/org-plot.php, the org-plot | ||
| 2300 | tutorial}. | ||
| 2301 | |||
| 2302 | @subsubheading Plot Options | ||
| 2303 | |||
| 2304 | @table @code | ||
| 2305 | @item set | ||
| 2306 | Specify any @file{gnuplot} option to be set when graphing. | ||
| 2307 | |||
| 2308 | @item title | ||
| 2309 | Specify the title of the plot. | ||
| 2310 | |||
| 2311 | @item ind | ||
| 2312 | Specify which column of the table to use as the @code{x} axis. | ||
| 2313 | |||
| 2314 | @item deps | ||
| 2315 | Specify (as a comma seperated list with no spaces) which columns of the table | ||
| 2316 | to graph against the ind (defaults to all other columns). | ||
| 2317 | |||
| 2318 | @item type | ||
| 2319 | Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. | ||
| 2320 | |||
| 2321 | @item with | ||
| 2322 | Specify a @code{with} option to be inserted for every col being plotted | ||
| 2323 | (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). | ||
| 2324 | Defaults to 'lines'. | ||
| 2325 | |||
| 2326 | @item file | ||
| 2327 | If you want to plot to a file specify the @code{"path/to/desired/output-file"}. | ||
| 2328 | |||
| 2329 | @item labels | ||
| 2330 | List of labels to be used for the deps (defaults to column headers if they | ||
| 2331 | exist). | ||
| 2332 | |||
| 2333 | @item line | ||
| 2334 | Specify an entire line to be inserted in the gnuplot script. | ||
| 2335 | |||
| 2336 | @item map | ||
| 2337 | When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a | ||
| 2338 | flat mapping rather than a @code{3d} slope. | ||
| 2339 | |||
| 2340 | @item script | ||
| 2341 | If you want total control you can specify a script file (place the file name | ||
| 2342 | between double quotes) which will be used to plot. Before plotting, every | ||
| 2343 | instance of @code{$datafile} in the specified script will be replaced with | ||
| 2344 | the path to the generated data file. Note even if you set this option you | ||
| 2345 | may still want to specify the plot type, as that can impact the content of | ||
| 2346 | the data file. | ||
| 2347 | @end table | ||
| 2348 | |||
| 2257 | @node Hyperlinks, TODO Items, Tables, Top | 2349 | @node Hyperlinks, TODO Items, Tables, Top |
| 2258 | @chapter Hyperlinks | 2350 | @chapter Hyperlinks |
| 2259 | @cindex hyperlinks | 2351 | @cindex hyperlinks |
| @@ -2524,17 +2616,16 @@ link and description parts of the link. | |||
| 2524 | @kindex C-c C-o | 2616 | @kindex C-c C-o |
| 2525 | @item C-c C-o | 2617 | @item C-c C-o |
| 2526 | Open link at point. This will launch a web browser for URLs (using | 2618 | Open link at point. This will launch a web browser for URLs (using |
| 2527 | @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB | 2619 | @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for |
| 2528 | for the corresponding links, and execute the command in a shell link. | 2620 | the corresponding links, and execute the command in a shell link. When the |
| 2529 | When the cursor is on an internal link, this commands runs the | 2621 | cursor is on an internal link, this commands runs the corresponding search. |
| 2530 | corresponding search. When the cursor is on a TAG list in a headline, | 2622 | When the cursor is on a TAG list in a headline, it creates the corresponding |
| 2531 | it creates the corresponding TAGS view. If the cursor is on a time | 2623 | TAGS view. If the cursor is on a time stamp, it compiles the agenda for that |
| 2532 | stamp, it compiles the agenda for that date. Furthermore, it will visit | 2624 | date. Furthermore, it will visit text and remote files in @samp{file:} links |
| 2533 | text and remote files in @samp{file:} links with Emacs and select a | 2625 | with Emacs and select a suitable application for local non-text files. |
| 2534 | suitable application for local non-text files. Classification of files | 2626 | Classification of files is based on file extension only. See option |
| 2535 | is based on file extension only. See option @code{org-file-apps}. If | 2627 | @code{org-file-apps}. If you want to override the default application and |
| 2536 | you want to override the default application and visit the file with | 2628 | visit the file with Emacs, use a @kbd{C-u} prefix. |
| 2537 | Emacs, use a @kbd{C-u} prefix. | ||
| 2538 | @c | 2629 | @c |
| 2539 | @kindex mouse-2 | 2630 | @kindex mouse-2 |
| 2540 | @kindex mouse-1 | 2631 | @kindex mouse-1 |
| @@ -3619,15 +3710,6 @@ release, number of tracks, and so on. | |||
| 3619 | Properties can be conveniently edited and viewed in column view | 3710 | Properties can be conveniently edited and viewed in column view |
| 3620 | (@pxref{Column view}). | 3711 | (@pxref{Column view}). |
| 3621 | 3712 | ||
| 3622 | Properties are like tags, but with a value. For example, in a file | ||
| 3623 | where you document bugs and plan releases of a piece of software, | ||
| 3624 | instead of using tags like @code{:release_1:}, @code{:release_2:}, it | ||
| 3625 | can be more efficient to use a property @code{:Release:} with a value | ||
| 3626 | @code{1.0} or @code{2.0}. Second, you can use properties to implement | ||
| 3627 | (very basic) database capabilities in an Org buffer, for example to | ||
| 3628 | create a list of Music CD's you own. You can edit and view properties | ||
| 3629 | conveniently in column view (@pxref{Column view}). | ||
| 3630 | |||
| 3631 | @menu | 3713 | @menu |
| 3632 | * Property syntax:: How properties are spelled out | 3714 | * Property syntax:: How properties are spelled out |
| 3633 | * Special properties:: Access to other Org mode features | 3715 | * Special properties:: Access to other Org mode features |
| @@ -3775,7 +3857,7 @@ If the comparison value is enclosed in double quotes @emph{and} angular | |||
| 3775 | brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are | 3857 | brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are |
| 3776 | assumed to be date/time specifications in the standard Org way@footnote{The | 3858 | assumed to be date/time specifications in the standard Org way@footnote{The |
| 3777 | only special values that will be recognized are @samp{"<now>"} for now, and | 3859 | only special values that will be recognized are @samp{"<now>"} for now, and |
| 3778 | @samp{"<today"} today at 0:00 hours, i.e. without a time specification.}, and | 3860 | @samp{"<today>"} today at 0:00 hours, i.e. without a time specification.}, and |
| 3779 | the comparison will be done accordingly. | 3861 | the comparison will be done accordingly. |
| 3780 | @item | 3862 | @item |
| 3781 | If the comparison value is enclosed | 3863 | If the comparison value is enclosed |
| @@ -4028,7 +4110,7 @@ current column view. | |||
| 4028 | Make the column narrower/wider by one character. | 4110 | Make the column narrower/wider by one character. |
| 4029 | @kindex S-M-@key{right} | 4111 | @kindex S-M-@key{right} |
| 4030 | @item S-M-@key{right} | 4112 | @item S-M-@key{right} |
| 4031 | Insert a new column, to the right of the current column. | 4113 | Insert a new column, to the left of the current column. |
| 4032 | @kindex S-M-@key{left} | 4114 | @kindex S-M-@key{left} |
| 4033 | @item S-M-@key{left} | 4115 | @item S-M-@key{left} |
| 4034 | Delete the current column. | 4116 | Delete the current column. |
| @@ -4083,8 +4165,8 @@ column view is @code{ITEM}. | |||
| 4083 | The following commands insert or update the dynamic block: | 4165 | The following commands insert or update the dynamic block: |
| 4084 | 4166 | ||
| 4085 | @table @kbd | 4167 | @table @kbd |
| 4086 | @kindex C-c C-x r | 4168 | @kindex C-c C-x i |
| 4087 | @item C-c C-x r | 4169 | @item C-c C-x i |
| 4088 | Insert a dynamic block capturing a column view. You will be prompted | 4170 | Insert a dynamic block capturing a column view. You will be prompted |
| 4089 | for the scope or id of the view. | 4171 | for the scope or id of the view. |
| 4090 | @kindex C-c C-c | 4172 | @kindex C-c C-c |
| @@ -4099,6 +4181,11 @@ Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |||
| 4099 | you have several clock table blocks in a buffer. | 4181 | you have several clock table blocks in a buffer. |
| 4100 | @end table | 4182 | @end table |
| 4101 | 4183 | ||
| 4184 | You can add formulas to the column view table and you may add plotting | ||
| 4185 | instructions in front of the table - these will survive an update of the | ||
| 4186 | block. If there is a @code{#+TBLFM:} after the table, the table will | ||
| 4187 | actually be recalculated automatically after an update. | ||
| 4188 | |||
| 4102 | @node Property API, , Column view, Properties and Columns | 4189 | @node Property API, , Column view, Properties and Columns |
| 4103 | @section The Property API | 4190 | @section The Property API |
| 4104 | @cindex properties, API | 4191 | @cindex properties, API |
| @@ -4109,7 +4196,7 @@ be used by Emacs Lisp programs to work with properties and to implement | |||
| 4109 | features based on them. For more information see @ref{Using the | 4196 | features based on them. For more information see @ref{Using the |
| 4110 | property API}. | 4197 | property API}. |
| 4111 | 4198 | ||
| 4112 | @node Dates and Times, Remember, Properties and Columns, Top | 4199 | @node Dates and Times, Capture, Properties and Columns, Top |
| 4113 | @chapter Dates and Times | 4200 | @chapter Dates and Times |
| 4114 | @cindex dates | 4201 | @cindex dates |
| 4115 | @cindex times | 4202 | @cindex times |
| @@ -4220,9 +4307,10 @@ format. | |||
| 4220 | @table @kbd | 4307 | @table @kbd |
| 4221 | @kindex C-c . | 4308 | @kindex C-c . |
| 4222 | @item C-c . | 4309 | @item C-c . |
| 4223 | Prompt for a date and insert a corresponding time stamp. When the | 4310 | Prompt for a date and insert a corresponding time stamp. When the cursor is |
| 4224 | cursor is at a previously used time stamp, it is updated to NOW. When | 4311 | at an existing time stamp in the buffer, the command is used to modify this |
| 4225 | this command is used twice in succession, a time range is inserted. | 4312 | timestamp instead of inserting a new one. When this command is used twice in |
| 4313 | succession, a time range is inserted. | ||
| 4226 | @c | 4314 | @c |
| 4227 | @kindex C-u C-c . | 4315 | @kindex C-u C-c . |
| 4228 | @item C-u C-c . | 4316 | @item C-u C-c . |
| @@ -4788,8 +4876,23 @@ option @code{org-agenda-columns-add-appointments-to-effort-sum}. The | |||
| 4788 | appointments on a day that take place over a specified time interval will | 4876 | appointments on a day that take place over a specified time interval will |
| 4789 | then also be added to the load estimate of the day. | 4877 | then also be added to the load estimate of the day. |
| 4790 | 4878 | ||
| 4791 | @node Remember, Agenda Views, Dates and Times, Top | 4879 | |
| 4792 | @chapter Remember | 4880 | @node Capture, Agenda Views, Dates and Times, Top |
| 4881 | @chapter Capture | ||
| 4882 | @cindex capture | ||
| 4883 | |||
| 4884 | An important part of any organization system is the ability to quickly | ||
| 4885 | capture new ideas and tasks, and to associate reference material with them. | ||
| 4886 | Org uses the @file{remember} package to create tasks, and stores files | ||
| 4887 | related to a task (@i{attachments}) in a special directory. | ||
| 4888 | |||
| 4889 | @menu | ||
| 4890 | * Remember:: Capture new tasks/ideas with little interruption | ||
| 4891 | * Attachments:: Add files to tasks. | ||
| 4892 | @end menu | ||
| 4893 | |||
| 4894 | @node Remember, Attachments, Capture, Capture | ||
| 4895 | @section Remember | ||
| 4793 | @cindex @file{remember.el} | 4896 | @cindex @file{remember.el} |
| 4794 | 4897 | ||
| 4795 | The @i{Remember} package by John Wiegley lets you store quick notes with | 4898 | The @i{Remember} package by John Wiegley lets you store quick notes with |
| @@ -4810,7 +4913,7 @@ interactively, on the fly. | |||
| 4810 | @end menu | 4913 | @end menu |
| 4811 | 4914 | ||
| 4812 | @node Setting up Remember, Remember templates, Remember, Remember | 4915 | @node Setting up Remember, Remember templates, Remember, Remember |
| 4813 | @section Setting up Remember | 4916 | @subsection Setting up Remember |
| 4814 | 4917 | ||
| 4815 | The following customization will tell @i{remember} to use org files as | 4918 | The following customization will tell @i{remember} to use org files as |
| 4816 | target, and to create annotations compatible with Org links. | 4919 | target, and to create annotations compatible with Org links. |
| @@ -4838,7 +4941,7 @@ inserted by the selected remember template (see below) will default to | |||
| 4838 | the cursor date in the agenda, rather than to the current date. | 4941 | the cursor date in the agenda, rather than to the current date. |
| 4839 | 4942 | ||
| 4840 | @node Remember templates, Storing notes, Setting up Remember, Remember | 4943 | @node Remember templates, Storing notes, Setting up Remember, Remember |
| 4841 | @section Remember templates | 4944 | @subsection Remember templates |
| 4842 | @cindex templates, for remember | 4945 | @cindex templates, for remember |
| 4843 | 4946 | ||
| 4844 | In combination with Org, you can use templates to generate | 4947 | In combination with Org, you can use templates to generate |
| @@ -4918,7 +5021,10 @@ insertion of content: | |||
| 4918 | %^C @r{Interactive selection of which kill or clip to use.} | 5021 | %^C @r{Interactive selection of which kill or clip to use.} |
| 4919 | %^L @r{Like @code{%^C}, but insert as link.} | 5022 | %^L @r{Like @code{%^C}, but insert as link.} |
| 4920 | %^g @r{prompt for tags, with completion on tags in target file.} | 5023 | %^g @r{prompt for tags, with completion on tags in target file.} |
| 5024 | %k @r{title of currently clocked task} | ||
| 5025 | %K @r{link to currently clocked task} | ||
| 4921 | %^G @r{prompt for tags, with completion all tags in all agenda files.} | 5026 | %^G @r{prompt for tags, with completion all tags in all agenda files.} |
| 5027 | %^@{prop@}p @r{Prompt the user for a value for property @code{prop}} | ||
| 4922 | %:keyword @r{specific information for certain link types, see below} | 5028 | %:keyword @r{specific information for certain link types, see below} |
| 4923 | %[pathname] @r{insert the contents of the file given by @code{pathname}} | 5029 | %[pathname] @r{insert the contents of the file given by @code{pathname}} |
| 4924 | %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result} | 5030 | %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result} |
| @@ -4962,7 +5068,7 @@ If you change your mind about which template to use, call | |||
| 4962 | template that will be filled with the previous context information. | 5068 | template that will be filled with the previous context information. |
| 4963 | 5069 | ||
| 4964 | @node Storing notes, Refiling notes, Remember templates, Remember | 5070 | @node Storing notes, Refiling notes, Remember templates, Remember |
| 4965 | @section Storing notes | 5071 | @subsection Storing notes |
| 4966 | 5072 | ||
| 4967 | When you are finished preparing a note with @i{remember}, you have to press | 5073 | When you are finished preparing a note with @i{remember}, you have to press |
| 4968 | @kbd{C-c C-c} to file the note away. If you have started the clock in the | 5074 | @kbd{C-c C-c} to file the note away. If you have started the clock in the |
| @@ -4976,11 +5082,12 @@ specified in the template, or it will use the default file and headlines. | |||
| 4976 | The window configuration will be restored, sending you back to the working | 5082 | The window configuration will be restored, sending you back to the working |
| 4977 | context before the call to @code{remember}. To re-use the location found | 5083 | context before the call to @code{remember}. To re-use the location found |
| 4978 | during the last call to @code{remember}, exit the remember buffer with | 5084 | during the last call to @code{remember}, exit the remember buffer with |
| 4979 | @kbd{C-u C-u C-c C-c}, i.e. specify a double prefix argument to @kbd{C-c | 5085 | @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}. |
| 4980 | C-c}. | 5086 | Another special case is @kbd{C-2 C-c C-c} which files the note as a child of |
| 5087 | the currently clocked item. | ||
| 4981 | 5088 | ||
| 4982 | If you want to store the note directly to a different place, use | 5089 | If you want to store the note directly to a different place, use |
| 4983 | @kbd{C-u C-c C-c} instead to exit remember@footnote{Configure the | 5090 | @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the |
| 4984 | variable @code{org-remember-store-without-prompt} to make this behavior | 5091 | variable @code{org-remember-store-without-prompt} to make this behavior |
| 4985 | the default.}. The handler will then first prompt for a target file - | 5092 | the default.}. The handler will then first prompt for a target file - |
| 4986 | if you press @key{RET}, the value specified for the template is used. | 5093 | if you press @key{RET}, the value specified for the template is used. |
| @@ -5012,15 +5119,14 @@ then leads to the following result. | |||
| 5012 | @tab at cursor position, level taken from context. | 5119 | @tab at cursor position, level taken from context. |
| 5013 | @end multitable | 5120 | @end multitable |
| 5014 | 5121 | ||
| 5015 | Before inserting the text into a tree, the function ensures that the | 5122 | Before inserting the text into a tree, the function ensures that the text has |
| 5016 | text has a headline, i.e. a first line that starts with a @samp{*}. If | 5123 | a headline, i.e. a first line that starts with a @samp{*}. If not, a |
| 5017 | not, a headline is constructed from the current date and some additional | 5124 | headline is constructed from the current date. If you have indented the text |
| 5018 | data. If you have indented the text of the note below the headline, the | 5125 | of the note below the headline, the indentation will be adapted if inserting |
| 5019 | indentation will be adapted if inserting the note into the tree requires | 5126 | the note into the tree requires demotion from level 1. |
| 5020 | demotion from level 1. | ||
| 5021 | 5127 | ||
| 5022 | @node Refiling notes, , Storing notes, Remember | 5128 | @node Refiling notes, , Storing notes, Remember |
| 5023 | @section Refiling notes | 5129 | @subsection Refiling notes |
| 5024 | @cindex refiling notes | 5130 | @cindex refiling notes |
| 5025 | 5131 | ||
| 5026 | Remember is usually used to quickly capture notes and tasks into one or | 5132 | Remember is usually used to quickly capture notes and tasks into one or |
| @@ -5051,7 +5157,88 @@ Use the refile interface to jump to a heading. | |||
| 5051 | Jump to the location where @code{org-refile} last moved a tree to. | 5157 | Jump to the location where @code{org-refile} last moved a tree to. |
| 5052 | @end table | 5158 | @end table |
| 5053 | 5159 | ||
| 5054 | @node Agenda Views, Embedded LaTeX, Remember, Top | 5160 | @node Attachments, , Remember, Capture |
| 5161 | @section Attachments | ||
| 5162 | @cindex attachments | ||
| 5163 | |||
| 5164 | It is often useful to associate reference material with an outline node/task. | ||
| 5165 | Small chunks of plain text can simply be stored in the subtree of a project. | ||
| 5166 | Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with | ||
| 5167 | files that live elsewhere on your computer or in the cloud, like emails or | ||
| 5168 | source code files belonging to a project. Another method is @i{attachments}, | ||
| 5169 | which are files located in a directory belonging to an outline node. Org | ||
| 5170 | uses directories named by the unique ID of each entry. These directories are | ||
| 5171 | located in the @file{data} directory which lives in the same directory where | ||
| 5172 | your org-file lives@footnote{If you move entries or Org-files from one | ||
| 5173 | directory to the next, you may want to configure @code{org-attach-directory} | ||
| 5174 | to contain an absolute path.}. If you initialize this directory with | ||
| 5175 | @code{git-init}, Org will automatically commit changes when it sees them. | ||
| 5176 | The attachment system has been contributed to Org by John Wiegley. | ||
| 5177 | |||
| 5178 | @noindent The following commands deal with attachments. | ||
| 5179 | |||
| 5180 | @table @kbd | ||
| 5181 | |||
| 5182 | @kindex C-c C-a | ||
| 5183 | @item C-c C-a | ||
| 5184 | The dispatcher for commands related to the attachment system. After these | ||
| 5185 | keys, a list of commands is displayed and you need to press an additional key | ||
| 5186 | to select a command: | ||
| 5187 | |||
| 5188 | @table @kbd | ||
| 5189 | @kindex C-c C-a a | ||
| 5190 | @item a | ||
| 5191 | Select a file and move it into the task's attachment directory. The file | ||
| 5192 | will be copied, moved, or linked, depending on @code{org-attach-method}. | ||
| 5193 | Note that hard links are not supported on all systems. | ||
| 5194 | |||
| 5195 | @kindex C-c C-a c | ||
| 5196 | @kindex C-c C-a m | ||
| 5197 | @kindex C-c C-a l | ||
| 5198 | @item c/m/l | ||
| 5199 | Attach a file using the copy/move/link method. | ||
| 5200 | Note that hard links are not supported on all systems. | ||
| 5201 | |||
| 5202 | @kindex C-c C-a n | ||
| 5203 | @item n | ||
| 5204 | Create a new attachment as an Emacs buffer. | ||
| 5205 | |||
| 5206 | @kindex C-c C-a z | ||
| 5207 | @item z | ||
| 5208 | Synchronize the current task with its attachment directory, in case you added | ||
| 5209 | attachments yourself. | ||
| 5210 | |||
| 5211 | @kindex C-c C-a o | ||
| 5212 | @item o | ||
| 5213 | Open current task's attachment. If there are more than one, prompt for a | ||
| 5214 | file name first. Opening will follow the rules set by @code{org-file-apps}. | ||
| 5215 | For more details, see the information on following hyperlings | ||
| 5216 | (@pxref{Handling links}). | ||
| 5217 | |||
| 5218 | @kindex C-c C-a O | ||
| 5219 | @item O | ||
| 5220 | Also open the attachment, but force opening the file in Emacs. | ||
| 5221 | |||
| 5222 | @kindex C-c C-a f | ||
| 5223 | @item f | ||
| 5224 | Open the current task's attachment directory. | ||
| 5225 | |||
| 5226 | @kindex C-c C-a F | ||
| 5227 | @item F | ||
| 5228 | Also open the directory, but force using @code{dired} in Emacs. | ||
| 5229 | |||
| 5230 | @kindex C-c C-a d | ||
| 5231 | @item d | ||
| 5232 | Select and delete a single attachment. | ||
| 5233 | |||
| 5234 | @kindex C-c C-a D | ||
| 5235 | @item D | ||
| 5236 | Delete all of a task's attachments. A safer way is to open the directory in | ||
| 5237 | dired and delete from there. | ||
| 5238 | @end table | ||
| 5239 | @end table | ||
| 5240 | |||
| 5241 | @node Agenda Views, Embedded LaTeX, Capture, Top | ||
| 5055 | @chapter Agenda Views | 5242 | @chapter Agenda Views |
| 5056 | @cindex agenda views | 5243 | @cindex agenda views |
| 5057 | 5244 | ||
| @@ -5072,8 +5259,8 @@ for specific dates, | |||
| 5072 | a @emph{TODO list} that covers all unfinished | 5259 | a @emph{TODO list} that covers all unfinished |
| 5073 | action items, | 5260 | action items, |
| 5074 | @item | 5261 | @item |
| 5075 | a @emph{tags view}, showings headlines based on | 5262 | a @emph{match view}, showings headlines based on the tags, properties and |
| 5076 | the tags associated with them, | 5263 | TODO state associated with them, |
| 5077 | @item | 5264 | @item |
| 5078 | a @emph{timeline view} that shows all events in a single Org file, | 5265 | a @emph{timeline view} that shows all events in a single Org file, |
| 5079 | in time-sorted view, | 5266 | in time-sorted view, |
| @@ -5267,13 +5454,13 @@ paper agenda, showing all the tasks for the current week or day. | |||
| 5267 | @cindex org-agenda, command | 5454 | @cindex org-agenda, command |
| 5268 | @kindex C-c a a | 5455 | @kindex C-c a a |
| 5269 | @item C-c a a | 5456 | @item C-c a a |
| 5270 | Compile an agenda for the current week from a list of org files. The | 5457 | Compile an agenda for the current week from a list of org files. The agenda |
| 5271 | agenda shows the entries for each day. With a numeric | 5458 | shows the entries for each day. With a numeric prefix@footnote{For backward |
| 5272 | prefix@footnote{For backward compatibility, the universal prefix | 5459 | compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be |
| 5273 | @kbd{C-u} causes all TODO entries to be listed before the agenda. This | 5460 | listed before the agenda. This feature is deprecated, use the dedicated TODO |
| 5274 | feature is deprecated, use the dedicated TODO list, or a block agenda | 5461 | list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1 |
| 5275 | instead.} (like @kbd{C-u 2 1 C-c a a}) you may set the number of days | 5462 | C-c a a}) you may set the number of days to be displayed (see also the |
| 5276 | to be displayed (see also the variable @code{org-agenda-ndays}) | 5463 | variable @code{org-agenda-ndays}) |
| 5277 | @end table | 5464 | @end table |
| 5278 | 5465 | ||
| 5279 | Remote editing from the agenda buffer means, for example, that you can | 5466 | Remote editing from the agenda buffer means, for example, that you can |
| @@ -5400,6 +5587,7 @@ and omit the sublevels from the global list. Configure the variable | |||
| 5400 | @cindex matching, of tags | 5587 | @cindex matching, of tags |
| 5401 | @cindex matching, of properties | 5588 | @cindex matching, of properties |
| 5402 | @cindex tags view | 5589 | @cindex tags view |
| 5590 | @cindex match view | ||
| 5403 | 5591 | ||
| 5404 | If headlines in the agenda files are marked with @emph{tags} | 5592 | If headlines in the agenda files are marked with @emph{tags} |
| 5405 | (@pxref{Tags}), you can select headlines based on the tags that apply | 5593 | (@pxref{Tags}), you can select headlines based on the tags that apply |
| @@ -5499,9 +5687,9 @@ work for you. The built-in default assumes that all your projects are | |||
| 5499 | level-2 headlines, and that a project is not stuck if it has at least | 5687 | level-2 headlines, and that a project is not stuck if it has at least |
| 5500 | one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. | 5688 | one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. |
| 5501 | 5689 | ||
| 5502 | Lets assume that you, in your own way of using Org mode, identify | 5690 | Let's assume that you, in your own way of using Org mode, identify |
| 5503 | projects with a tag PROJECT, and that you use a TODO keyword MAYBE to | 5691 | projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
| 5504 | indicate a project that should not be considered yet. Lets further | 5692 | indicate a project that should not be considered yet. Let's further |
| 5505 | assume that the TODO keyword DONE marks finished projects, and that NEXT | 5693 | assume that the TODO keyword DONE marks finished projects, and that NEXT |
| 5506 | and TODO indicate next actions. The tag @@SHOP indicates shopping and | 5694 | and TODO indicate next actions. The tag @@SHOP indicates shopping and |
| 5507 | is a next action even without the NEXT tag. Finally, if the project | 5695 | is a next action even without the NEXT tag. Finally, if the project |
| @@ -5799,21 +5987,31 @@ that entry would be in the original buffer (taken from a property, from a | |||
| 5799 | @code{#+COLUMNS} line, or from the default variable | 5987 | @code{#+COLUMNS} line, or from the default variable |
| 5800 | @code{org-columns-default-format}), will be used in the agenda. | 5988 | @code{org-columns-default-format}), will be used in the agenda. |
| 5801 | 5989 | ||
| 5802 | @tsubheading{Query editing} | 5990 | @tsubheading{Secondary filtering and query editing} |
| 5803 | @cindex query editing, in agenda | 5991 | @cindex query editing, in agenda |
| 5804 | 5992 | ||
| 5993 | @kindex / | ||
| 5994 | @item / | ||
| 5995 | Filter the current agenda view with respect to a tag. You will be prompted | ||
| 5996 | for a tag selection letter. Pressing @key{TAB} at that prompt will offer use | ||
| 5997 | completion to select a tag (including any tags that do not have a selection | ||
| 5998 | character). The command then hides all entries that do not contain or | ||
| 5999 | inherit this tag. When called with prefix arg, remove the entries that | ||
| 6000 | @emph{do} have the tag. A second @kbd{/} at the prompt will unhide any | ||
| 6001 | hidden entries. | ||
| 6002 | |||
| 5805 | @kindex [ | 6003 | @kindex [ |
| 5806 | @kindex ] | 6004 | @kindex ] |
| 5807 | @kindex @{ | 6005 | @kindex @{ |
| 5808 | @kindex @} | 6006 | @kindex @} |
| 5809 | @item [ ] @{ @} | 6007 | @item [ ] @{ @} |
| 5810 | In the @i{search view} (@pxref{Keyword search}), these keys add new | 6008 | In the @i{search view} (@pxref{Keyword search}), these keys add new search |
| 5811 | search words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} | 6009 | words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and |
| 5812 | and @kbd{@}}) to the query string. The opening bracket/brace will add a | 6010 | @kbd{@}}) to the query string. The opening bracket/brace will add a positive |
| 5813 | positive search term prefixed by @samp{+}, indicating that this search | 6011 | search term prefixed by @samp{+}, indicating that this search term @i{must} |
| 5814 | term @i{must} occur/match in the entry. Closing bracket/brace add a | 6012 | occur/match in the entry. The closing bracket/brace will add a negative |
| 5815 | negative search term which @i{must not} occur/match in the entry for it | 6013 | search term which @i{must not} occur/match in the entry for it to be |
| 5816 | to be selected. | 6014 | selected. |
| 5817 | 6015 | ||
| 5818 | 6016 | ||
| 5819 | @tsubheading{Remote editing} | 6017 | @tsubheading{Remote editing} |
| @@ -5890,6 +6088,10 @@ key for this. | |||
| 5890 | @itemx S-@key{down} | 6088 | @itemx S-@key{down} |
| 5891 | Decrease the priority of the current item. | 6089 | Decrease the priority of the current item. |
| 5892 | @c | 6090 | @c |
| 6091 | @kindex C-c C-a | ||
| 6092 | @item C-c C-a | ||
| 6093 | Dispatcher for all command related to attachments. | ||
| 6094 | @c | ||
| 5893 | @kindex C-c C-s | 6095 | @kindex C-c C-s |
| 5894 | @item C-c C-s | 6096 | @item C-c C-s |
| 5895 | Schedule this item | 6097 | Schedule this item |
| @@ -6537,7 +6739,8 @@ Angles are written as Greek letters \alpha, \beta and \gamma. | |||
| 6537 | 6739 | ||
| 6538 | During HTML export (@pxref{HTML export}), these symbols are translated | 6740 | During HTML export (@pxref{HTML export}), these symbols are translated |
| 6539 | into the proper syntax for HTML, for the above examples this is | 6741 | into the proper syntax for HTML, for the above examples this is |
| 6540 | @samp{α} and @samp{→}, respectively. | 6742 | @samp{α} and @samp{→}, respectively. If you need such a symbol |
| 6743 | inside a word, terminate it like this: @samp{\Aacute@{@}stor}. | ||
| 6541 | 6744 | ||
| 6542 | @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX | 6745 | @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX |
| 6543 | @section Subscripts and superscripts | 6746 | @section Subscripts and superscripts |
| @@ -6722,6 +6925,7 @@ Org mode only supports export, not import of these different formats. | |||
| 6722 | 6925 | ||
| 6723 | @menu | 6926 | @menu |
| 6724 | * Markup rules:: Which structures are recognized? | 6927 | * Markup rules:: Which structures are recognized? |
| 6928 | * Selective export:: Using tags to select and exclude trees | ||
| 6725 | * Export options:: Per-file export settings | 6929 | * Export options:: Per-file export settings |
| 6726 | * The export dispatcher:: How to access exporter commands | 6930 | * The export dispatcher:: How to access exporter commands |
| 6727 | * ASCII export:: Exporting to plain ASCII | 6931 | * ASCII export:: Exporting to plain ASCII |
| @@ -6731,7 +6935,7 @@ Org mode only supports export, not import of these different formats. | |||
| 6731 | * iCalendar export:: Exporting in iCalendar format | 6935 | * iCalendar export:: Exporting in iCalendar format |
| 6732 | @end menu | 6936 | @end menu |
| 6733 | 6937 | ||
| 6734 | @node Markup rules, Export options, Exporting, Exporting | 6938 | @node Markup rules, Selective export, Exporting, Exporting |
| 6735 | @section Markup rules | 6939 | @section Markup rules |
| 6736 | 6940 | ||
| 6737 | When exporting Org mode documents, the exporter tries to reflect the | 6941 | When exporting Org mode documents, the exporter tries to reflect the |
| @@ -6858,8 +7062,11 @@ can use this construct, which can also be used to format poetry. | |||
| 6858 | 7062 | ||
| 6859 | @example | 7063 | @example |
| 6860 | #+BEGIN_VERSE | 7064 | #+BEGIN_VERSE |
| 6861 | Everything should be made as simple as possible, | 7065 | Great clouds overhead |
| 6862 | but not any simpler -- Albert Einstein | 7066 | Tiny black birds rise and fall |
| 7067 | Snow covers Emacs | ||
| 7068 | |||
| 7069 | -- AlexSchroeder | ||
| 6863 | #+END_VERSE | 7070 | #+END_VERSE |
| 6864 | @end example | 7071 | @end example |
| 6865 | 7072 | ||
| @@ -6920,7 +7127,16 @@ example: | |||
| 6920 | @item C-c ' | 7127 | @item C-c ' |
| 6921 | Edit the source code example at point in its native mode. This works by | 7128 | Edit the source code example at point in its native mode. This works by |
| 6922 | switching to an indirect buffer, narrowing the buffer and switching to the | 7129 | switching to an indirect buffer, narrowing the buffer and switching to the |
| 6923 | other mode. You need to exit by pressing @kbd{C-c '} again. | 7130 | other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon |
| 7131 | exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to | ||
| 7132 | keep them from being interpreted by Org as outline nodes or special | ||
| 7133 | comments. These commas will be striped for editing with @kbd{C-c '}, and | ||
| 7134 | also for export.}. Fixed-width | ||
| 7135 | regions (where each line starts with a colon followed by a space) will be | ||
| 7136 | edited using @code{artist-mode}@footnote{You may select a different-mode with | ||
| 7137 | the variable @code{org-edit-fixed-width-region-mode}.} to allow creating | ||
| 7138 | ASCII drawings easily. Using this command in an empty line will create a new | ||
| 7139 | fixed-width region. | ||
| 6924 | @end table | 7140 | @end table |
| 6925 | 7141 | ||
| 6926 | 7142 | ||
| @@ -7047,7 +7263,28 @@ never be exported. Also entire subtrees starting with the word | |||
| 7047 | Toggle the COMMENT keyword at the beginning of an entry. | 7263 | Toggle the COMMENT keyword at the beginning of an entry. |
| 7048 | @end table | 7264 | @end table |
| 7049 | 7265 | ||
| 7050 | @node Export options, The export dispatcher, Markup rules, Exporting | 7266 | @node Selective export, Export options, Markup rules, Exporting |
| 7267 | @section Selective export | ||
| 7268 | @cindex export, selective by tags | ||
| 7269 | |||
| 7270 | You may use tags to select the parts of a document that should be exported, | ||
| 7271 | or to exclude parts from export. This behavior is governed by two variables: | ||
| 7272 | @code{org-export-select-tags} and @code{org-export-exclude-tags}. | ||
| 7273 | |||
| 7274 | Org first checks if any of the @emph{select} tags is present in the buffer. | ||
| 7275 | If yes, all trees that do not carry one of these tags will be excluded. If a | ||
| 7276 | selected tree is a subtree, the heading hierarchy above it will also be | ||
| 7277 | selected for export, but not the text below those headings. | ||
| 7278 | |||
| 7279 | @noindent | ||
| 7280 | If none of the select tags is found, the whole buffer will be selected for | ||
| 7281 | export. | ||
| 7282 | |||
| 7283 | @noindent | ||
| 7284 | Finally, all subtrees that are marked by any of the @emph{exclude} tags will | ||
| 7285 | be removed from the export buffer. | ||
| 7286 | |||
| 7287 | @node Export options, The export dispatcher, Selective export, Exporting | ||
| 7051 | @section Export options | 7288 | @section Export options |
| 7052 | @cindex options, for export | 7289 | @cindex options, for export |
| 7053 | 7290 | ||
| @@ -7074,6 +7311,8 @@ Insert template with export options, see example below. | |||
| 7074 | @cindex #+OPTIONS: | 7311 | @cindex #+OPTIONS: |
| 7075 | @cindex #+LINK_UP: | 7312 | @cindex #+LINK_UP: |
| 7076 | @cindex #+LINK_HOME: | 7313 | @cindex #+LINK_HOME: |
| 7314 | @cindex #+EXPORT_SELECT_TAGS: | ||
| 7315 | @cindex #+EXPORT_EXCLUDE_TAGS: | ||
| 7077 | @example | 7316 | @example |
| 7078 | #+TITLE: the title to be shown (default is the buffer name) | 7317 | #+TITLE: the title to be shown (default is the buffer name) |
| 7079 | #+AUTHOR: the author (default taken from @code{user-full-name}) | 7318 | #+AUTHOR: the author (default taken from @code{user-full-name}) |
| @@ -7085,6 +7324,8 @@ Insert template with export options, see example below. | |||
| 7085 | #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... | 7324 | #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... |
| 7086 | #+LINK_UP: the ``up'' link of an exported page | 7325 | #+LINK_UP: the ``up'' link of an exported page |
| 7087 | #+LINK_HOME: the ``home'' link of an exported page | 7326 | #+LINK_HOME: the ``home'' link of an exported page |
| 7327 | #+EXPORT_SELECT_TAGS: Tags that select a tree for export | ||
| 7328 | #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export | ||
| 7088 | @end example | 7329 | @end example |
| 7089 | 7330 | ||
| 7090 | @noindent | 7331 | @noindent |
| @@ -7381,27 +7622,15 @@ Each exported files contains a compact default style that defines these | |||
| 7381 | classes in a basic way. You may overwrite these settings, or add to them by | 7622 | classes in a basic way. You may overwrite these settings, or add to them by |
| 7382 | using the variables @code{org-export-html-style} (for Org-wide settings) and | 7623 | using the variables @code{org-export-html-style} (for Org-wide settings) and |
| 7383 | @code{org-export-html-style-extra} (for more granular settings, like | 7624 | @code{org-export-html-style-extra} (for more granular settings, like |
| 7384 | file-local settings). If you want to use a file-local style, you may use | 7625 | file-local settings). To set the latter variable individually for each |
| 7385 | file variables, best wrapped into a COMMENT section at the end of the outline | 7626 | file, you can use |
| 7386 | tree. For example@footnote{Under Emacs 21, the continuation lines for a | ||
| 7387 | variable value should have no @samp{#} at the start of the line.}: | ||
| 7388 | 7627 | ||
| 7389 | @example | 7628 | @example |
| 7390 | * COMMENT html style specifications | 7629 | #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" /> |
| 7391 | |||
| 7392 | # Local Variables: | ||
| 7393 | # org-export-html-style-extra: | ||
| 7394 | # "<style> | ||
| 7395 | # p @{font-weight: normal; color: gray; @} | ||
| 7396 | # h1 @{color: black; @} | ||
| 7397 | # </style>" | ||
| 7398 | # End: | ||
| 7399 | @end example | 7630 | @end example |
| 7400 | 7631 | ||
| 7401 | Remember to execute @kbd{M-x normal-mode} after changing this to make the new | 7632 | @noindent |
| 7402 | style immediately visible to Emacs. This command restarts Org mode for the | 7633 | For longer style definitions, you can use several such lines. |
| 7403 | current buffer and forces Emacs to re-evaluate the local variables section in | ||
| 7404 | the buffer. | ||
| 7405 | 7634 | ||
| 7406 | @c FIXME: More about header and footer styles | 7635 | @c FIXME: More about header and footer styles |
| 7407 | @c FIXME: Talk about links and targets. | 7636 | @c FIXME: Talk about links and targets. |
| @@ -7595,7 +7824,10 @@ stamps as VEVENT, and TODO items as VTODO. It will also create events from | |||
| 7595 | deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO | 7824 | deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO |
| 7596 | items will be used to set the start and due dates for the todo | 7825 | items will be used to set the start and due dates for the todo |
| 7597 | entry@footnote{See the variables @code{org-icalendar-use-deadline} and | 7826 | entry@footnote{See the variables @code{org-icalendar-use-deadline} and |
| 7598 | @code{org-icalendar-use-scheduled}.}. | 7827 | @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags |
| 7828 | locally defined in the heading, and the file/tree category@footnote{To add | ||
| 7829 | inherited tags or the TODO state, configure the variable | ||
| 7830 | @code{org-icalendar-categories}.}. | ||
| 7599 | 7831 | ||
| 7600 | The iCalendar standard requires each entry to have a globally unique | 7832 | The iCalendar standard requires each entry to have a globally unique |
| 7601 | identifier (UID). Org creates these identifiers during export. If you set | 7833 | identifier (UID). Org creates these identifiers during export. If you set |
| @@ -7816,6 +8048,8 @@ respective variable for details. | |||
| 7816 | @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} | 8048 | @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} |
| 7817 | @item @code{:author} @tab @code{user-full-name} | 8049 | @item @code{:author} @tab @code{user-full-name} |
| 7818 | @item @code{:email} @tab @code{user-mail-address} | 8050 | @item @code{:email} @tab @code{user-mail-address} |
| 8051 | @item @code{:select-tags} @tab @code{org-export-select-tags} | ||
| 8052 | @item @code{:exclude-tags} @tab @code{org-export-exclude-tags} | ||
| 7819 | @end multitable | 8053 | @end multitable |
| 7820 | 8054 | ||
| 7821 | If you use several email addresses, separate them by a semi-column. | 8055 | If you use several email addresses, separate them by a semi-column. |
| @@ -8332,10 +8566,12 @@ the variable @code{org-hide-leading-stars} or change this on a per-file basis | |||
| 8332 | with | 8566 | with |
| 8333 | 8567 | ||
| 8334 | @example | 8568 | @example |
| 8335 | #+STARTUP: showstars | ||
| 8336 | #+STARTUP: hidestars | 8569 | #+STARTUP: hidestars |
| 8337 | @end example | 8570 | @end example |
| 8338 | 8571 | ||
| 8572 | @noindent | ||
| 8573 | Note that the opposite behavior is selected with @code{showstars}. | ||
| 8574 | |||
| 8339 | With hidden stars, the tree becomes: | 8575 | With hidden stars, the tree becomes: |
| 8340 | 8576 | ||
| 8341 | @example | 8577 | @example |
| @@ -8658,6 +8894,8 @@ distribution, others are available somewhere on the web. | |||
| 8658 | to publish the same file using either org-publish or Muse. | 8894 | to publish the same file using either org-publish or Muse. |
| 8659 | @item @file{org-panel.el} by @i{Lennard Borgman} | 8895 | @item @file{org-panel.el} by @i{Lennard Borgman} |
| 8660 | Simplified and display-aided access to some Org commands. | 8896 | Simplified and display-aided access to some Org commands. |
| 8897 | @c @item @file{org-plot.el} by @i{Eric Schulte} | ||
| 8898 | @c Plotting Org tables with Gnuplot. | ||
| 8661 | @item @file{org-registry.el} by @i{Bastien Guerry} | 8899 | @item @file{org-registry.el} by @i{Bastien Guerry} |
| 8662 | A registry for Org links, to find out from where links point to a given | 8900 | A registry for Org links, to find out from where links point to a given |
| 8663 | file or location. | 8901 | file or location. |
| @@ -8700,7 +8938,7 @@ Org. | |||
| 8700 | 8938 | ||
| 8701 | Org has a large number of hyperlink types built-in | 8939 | Org has a large number of hyperlink types built-in |
| 8702 | (@pxref{Hyperlinks}). If you would like to add new link types, it | 8940 | (@pxref{Hyperlinks}). If you would like to add new link types, it |
| 8703 | provides an interface for doing so. Lets look at an example file | 8941 | provides an interface for doing so. Let's look at an example file |
| 8704 | @file{org-man.el} that will add support for creating links like | 8942 | @file{org-man.el} that will add support for creating links like |
| 8705 | @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside | 8943 | @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
| 8706 | emacs: | 8944 | emacs: |
| @@ -8755,7 +8993,7 @@ You would activate this new link type in @file{.emacs} with | |||
| 8755 | @end lisp | 8993 | @end lisp |
| 8756 | 8994 | ||
| 8757 | @noindent | 8995 | @noindent |
| 8758 | Lets go through the file and see what it does. | 8996 | Let's go through the file and see what it does. |
| 8759 | @enumerate | 8997 | @enumerate |
| 8760 | @item | 8998 | @item |
| 8761 | It does @code{(require 'org)} to make sure that @file{org.el} has been | 8999 | It does @code{(require 'org)} to make sure that @file{org.el} has been |
| @@ -9307,6 +9545,16 @@ Get all property keys in the current buffer. | |||
| 9307 | Insert a property drawer at point. | 9545 | Insert a property drawer at point. |
| 9308 | @end defun | 9546 | @end defun |
| 9309 | 9547 | ||
| 9548 | @defun org-entry-put-multivalued-property pom property &rest values | ||
| 9549 | Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of | ||
| 9550 | strings. They will be concatenated, with spaces as separators. | ||
| 9551 | @end defun | ||
| 9552 | |||
| 9553 | @defun org-entry-get-multivalued-property pom property | ||
| 9554 | Treat the value of the property PROPERTY as a whitespace-separated list of | ||
| 9555 | values and return the values as a list of strings. | ||
| 9556 | @end defun | ||
| 9557 | |||
| 9310 | @defun org-entry-add-to-multivalued-property pom property value | 9558 | @defun org-entry-add-to-multivalued-property pom property value |
| 9311 | Treat the value of the property PROPERTY as a whitespace-separated list of | 9559 | Treat the value of the property PROPERTY as a whitespace-separated list of |
| 9312 | values and make sure that VALUE is in this list. | 9560 | values and make sure that VALUE is in this list. |
| @@ -9341,7 +9589,7 @@ arguments, with the cursor positioned at the beginning of the headline. | |||
| 9341 | The return values of all calls to the function will be collected and | 9589 | The return values of all calls to the function will be collected and |
| 9342 | returned as a list. | 9590 | returned as a list. |
| 9343 | 9591 | ||
| 9344 | MATCH is a tags/property/todo match as it is used in the agenda tags view. | 9592 | MATCH is a tags/property/todo match as it is used in the agenda match view. |
| 9345 | Only headlines that are matched by this query will be considered during | 9593 | Only headlines that are matched by this query will be considered during |
| 9346 | the iteration. When MATCH is nil or t, all headlines will be | 9594 | the iteration. When MATCH is nil or t, all headlines will be |
| 9347 | visited by the iteration. | 9595 | visited by the iteration. |
| @@ -9513,6 +9761,9 @@ has been prolific with patches, ideas, and bug reports. | |||
| 9513 | task state change logging, and the clocktable. His clear explanations have | 9761 | task state change logging, and the clocktable. His clear explanations have |
| 9514 | been critical when we started to adopt the GIT version control system. | 9762 | been critical when we started to adopt the GIT version control system. |
| 9515 | @item | 9763 | @item |
| 9764 | @i{Manuel Hermenegildo} has contributed various ideas, small fixed and | ||
| 9765 | patches. | ||
| 9766 | @item | ||
| 9516 | @i{Phil Jackson} wrote @file{org-irc.el}. | 9767 | @i{Phil Jackson} wrote @file{org-irc.el}. |
| 9517 | @item | 9768 | @item |
| 9518 | @i{Scott Jaderholm} proposed footnotes, control over whitespace between | 9769 | @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
| @@ -9575,6 +9826,8 @@ of feedback, developed and applied standards to the Org documentation. | |||
| 9575 | @i{Christian Schlauer} proposed angular brackets around links, among | 9826 | @i{Christian Schlauer} proposed angular brackets around links, among |
| 9576 | other things. | 9827 | other things. |
| 9577 | @item | 9828 | @item |
| 9829 | @i{Eric Schulte} wrote @file{org-plot.el}. | ||
| 9830 | @item | ||
| 9578 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s | 9831 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
| 9579 | @file{organizer-mode.el}. | 9832 | @file{organizer-mode.el}. |
| 9580 | @item | 9833 | @item |
| @@ -9585,6 +9838,9 @@ subtrees. | |||
| 9585 | @item | 9838 | @item |
| 9586 | @i{Dale Smith} proposed link abbreviations. | 9839 | @i{Dale Smith} proposed link abbreviations. |
| 9587 | @item | 9840 | @item |
| 9841 | @i{James TD Smith} has contributed a large number of patches for useful | ||
| 9842 | tweaks and features. | ||
| 9843 | @item | ||
| 9588 | @i{Adam Spiers} asked for global linking commands, inspired the link | 9844 | @i{Adam Spiers} asked for global linking commands, inspired the link |
| 9589 | extension system, added support for mairix, and proposed the mapping API. | 9845 | extension system, added support for mairix, and proposed the mapping API. |
| 9590 | @item | 9846 | @item |
| @@ -9605,8 +9861,9 @@ system. | |||
| 9605 | development of Org was fully independent because I was not aware of the | 9861 | development of Org was fully independent because I was not aware of the |
| 9606 | existence of these packages. But with time I have accasionally looked | 9862 | existence of these packages. But with time I have accasionally looked |
| 9607 | at John's code and learned a lot from it. John has also contributed a | 9863 | at John's code and learned a lot from it. John has also contributed a |
| 9608 | number of great ideas and patches directly to Org, including the file | 9864 | number of great ideas and patches directly to Org, including the attachment |
| 9609 | @code{org-mac-message.el}' | 9865 | system (@file{org-attach.el}) and integration with Apple Mail |
| 9866 | (@file{org-mac-message.el}). | ||
| 9610 | @item | 9867 | @item |
| 9611 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in | 9868 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in |
| 9612 | linking to Gnus. | 9869 | linking to Gnus. |