Mercurial > emacs
comparison doc/misc/org.texi @ 96976:86e1b62bcc3e
New version 6.06a.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Thu, 24 Jul 2008 14:01:49 +0000 |
parents | 2398ec3bc9c5 |
children | 70c4b1cbc9e3 |
comparison
equal
deleted
inserted
replaced
96975:60149c696033 | 96976:86e1b62bcc3e |
---|---|
1 \input texinfo | 1 \input texinfo |
2 @c %**start of header | 2 @c %**start of header |
3 @setfilename ../../info/org | 3 @setfilename ../../info/org |
4 @settitle The Org Manual | 4 @settitle The Org Manual |
5 | 5 |
6 @set VERSION 6.05a | 6 @set VERSION 6.06a |
7 @set DATE June 2008 | 7 @set DATE July 2008 |
8 | 8 |
9 @dircategory Emacs | 9 @dircategory Emacs |
10 @direntry | 10 @direntry |
11 * Org Mode: (org). Outline-based notes management and organizer | 11 * Org Mode: (org). Outline-based notes management and organizer |
12 @end direntry | 12 @end direntry |
40 @quotation | 40 @quotation |
41 Permission is granted to copy, distribute and/or modify this document | 41 Permission is granted to copy, distribute and/or modify this document |
42 under the terms of the GNU Free Documentation License, Version 1.2 or | 42 under the terms of the GNU Free Documentation License, Version 1.2 or |
43 any later version published by the Free Software Foundation; with no | 43 any later version published by the Free Software Foundation; with no |
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | 44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' |
45 and with the Back-Cover Texts as in (a) below. A copy of the license | 45 and with the Back-Cover Texts as in (a) below. A copy of the |
46 is included in the section entitled ``GNU Free Documentation License.'' | 46 license is included in the section entitled ``GNU Free Documentation |
47 -License.'' | |
47 | 48 |
48 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and | 49 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
49 modify this GNU manual. Buying copies from the FSF supports it in | 50 modify this GNU manual. Buying copies from the FSF supports it in |
50 developing GNU and promoting software freedom.'' | 51 developing GNU and promoting software freedom.'' |
51 | 52 |
91 * Agenda Views:: Collecting information into views | 92 * Agenda Views:: Collecting information into views |
92 * Embedded LaTeX:: LaTeX fragments and formulas | 93 * Embedded LaTeX:: LaTeX fragments and formulas |
93 * Exporting:: Sharing and publishing of notes | 94 * Exporting:: Sharing and publishing of notes |
94 * Publishing:: Create a web site of linked Org files | 95 * Publishing:: Create a web site of linked Org files |
95 * Miscellaneous:: All the rest which did not fit elsewhere | 96 * Miscellaneous:: All the rest which did not fit elsewhere |
96 * Extensions:: | 97 * Extensions:: Add-ons for Org mode |
97 * Hacking:: | 98 * Hacking:: How hack your way around |
98 * History and Acknowledgments:: How Org came into being | 99 * History and Acknowledgments:: How Org came into being |
99 * Main Index:: An index of Org's concepts and features | 100 * Main Index:: An index of Org's concepts and features |
100 * Key Index:: Key bindings and where they are described | 101 * Key Index:: Key bindings and where they are described |
101 | 102 |
102 @detailmenu | 103 @detailmenu |
526 @cindex global key bindings | 527 @cindex global key bindings |
527 @cindex key bindings, global | 528 @cindex key bindings, global |
528 | 529 |
529 @iftex | 530 @iftex |
530 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the | 531 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the |
531 PDF documentation as viewed by Acrobat reader to your .emacs file, the | 532 PDF documentation as viewed by some PDF viewers to your .emacs file, the |
532 single quote character comes out incorrectly and the code will not work. | 533 single quote character comes out incorrectly and the code will not work. |
533 You need to fix the single quotes by hand, or copy from Info | 534 You need to fix the single quotes by hand, or copy from Info |
534 documentation.} | 535 documentation.} |
535 @end iftex | 536 @end iftex |
536 | 537 |
1003 archived subtrees are not exposed, unless you configure the option | 1004 archived subtrees are not exposed, unless you configure the option |
1004 @code{org-sparse-tree-open-archived-trees}. | 1005 @code{org-sparse-tree-open-archived-trees}. |
1005 @item | 1006 @item |
1006 During agenda view construction (@pxref{Agenda Views}), the content of | 1007 During agenda view construction (@pxref{Agenda Views}), the content of |
1007 archived trees is ignored unless you configure the option | 1008 archived trees is ignored unless you configure the option |
1008 @code{org-agenda-skip-archived-trees}. | 1009 @code{org-agenda-skip-archived-trees}, in which case these trees will always |
1010 be included. In the agenda you can press the @kbd{v} key to get archives | |
1011 temporarily included. | |
1009 @item | 1012 @item |
1010 Archived trees are not exported (@pxref{Exporting}), only the headline | 1013 Archived trees are not exported (@pxref{Exporting}), only the headline |
1011 is. Configure the details using the variable | 1014 is. Configure the details using the variable |
1012 @code{org-export-with-archived-trees}. | 1015 @code{org-export-with-archived-trees}. |
1013 @end itemize | 1016 @end itemize |
1035 @node Moving subtrees, , ARCHIVE tag, Archiving | 1038 @node Moving subtrees, , ARCHIVE tag, Archiving |
1036 @subsection Moving subtrees | 1039 @subsection Moving subtrees |
1037 @cindex external archiving | 1040 @cindex external archiving |
1038 | 1041 |
1039 Once an entire project is finished, you may want to move it to a different | 1042 Once an entire project is finished, you may want to move it to a different |
1040 location. Org can move it to an @emph{Attic Sibling} in the same tree, to a | 1043 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a |
1041 different tree in the current file, or to a different file, the archive file. | 1044 different tree in the current file, or to a different file, the archive file. |
1042 | 1045 |
1043 @table @kbd | 1046 @table @kbd |
1044 @kindex C-c C-x A | 1047 @kindex C-c C-x A |
1045 @item C-c C-x A | 1048 @item C-c C-x A |
1046 Move the current entry to the @emph{Attic Sibling}. This is a sibling of the | 1049 Move the current entry to the @emph{Archive Sibling}. This is a sibling of |
1047 entry with the heading @samp{Attic} and the tag @samp{ARCHIVE} | 1050 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE} |
1048 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this | 1051 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this |
1049 way retains a lot of its original context, including inherited tags and | 1052 way retains a lot of its original context, including inherited tags and |
1050 approximate position in the outline. | 1053 approximate position in the outline. |
1051 @kindex C-c C-x C-s | 1054 @kindex C-c C-x C-s |
1052 @item C-c C-x C-s | 1055 @item C-c C-x C-s |
1562 argument is passed on to the converter, which uses it to determine the | 1565 argument is passed on to the converter, which uses it to determine the |
1563 separator. | 1566 separator. |
1564 @item C-c | | 1567 @item C-c | |
1565 Tables can also be imported by pasting tabular text into the Org | 1568 Tables can also be imported by pasting tabular text into the Org |
1566 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the | 1569 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
1567 @kbd{C-c |} command (see above under @i{Creation and conversion}. | 1570 @kbd{C-c |} command (see above under @i{Creation and conversion}). |
1568 @c | 1571 @c |
1569 @item M-x org-table-export | 1572 @item M-x org-table-export |
1570 Export the table, by default as a TAB-separated file. Useful for data | 1573 Export the table, by default as a TAB-separated file. Useful for data |
1571 exchange with, for example, spreadsheet or database programs. The format | 1574 exchange with, for example, spreadsheet or database programs. The format |
1572 used to export the file can be configured in the variable | 1575 used to export the file can be configured in the variable |
1656 | / | <> | < | | > | < | > | | 1659 | / | <> | < | | > | < | > | |
1657 | # | 1 | 1 | 1 | 1 | 1 | 1 | | 1660 | # | 1 | 1 | 1 | 1 | 1 | 1 | |
1658 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | 1661 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | |
1659 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | 1662 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | |
1660 |---+----+-----+-----+-----+---------+------------| | 1663 |---+----+-----+-----+-----+---------+------------| |
1661 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)) | 1664 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))) |
1662 @end example | 1665 @end example |
1663 | 1666 |
1664 It is also sufficient to just insert the column group starters after | 1667 It is also sufficient to just insert the column group starters after |
1665 every vertical line you'd like to have: | 1668 every vertical line you'd like to have: |
1666 | 1669 |
1862 @cindex format specifier | 1865 @cindex format specifier |
1863 @cindex mode, for @file{calc} | 1866 @cindex mode, for @file{calc} |
1864 A formula can contain an optional mode string after a semicolon. This | 1867 A formula can contain an optional mode string after a semicolon. This |
1865 string consists of flags to influence Calc and other modes during | 1868 string consists of flags to influence Calc and other modes during |
1866 execution. By default, Org uses the standard Calc modes (precision | 1869 execution. By default, Org uses the standard Calc modes (precision |
1867 12, angular units degrees, fraction and symbolic modes off. The display | 1870 12, angular units degrees, fraction and symbolic modes off). The display |
1868 format, however, has been changed to @code{(float 5)} to keep tables | 1871 format, however, has been changed to @code{(float 5)} to keep tables |
1869 compact. The default settings can be configured using the variable | 1872 compact. The default settings can be configured using the variable |
1870 @code{org-calc-default-modes}. | 1873 @code{org-calc-default-modes}. |
1871 | 1874 |
1872 @example | 1875 @example |
2394 the colon. The following list shows examples for each link type. | 2397 the colon. The following list shows examples for each link type. |
2395 | 2398 |
2396 @example | 2399 @example |
2397 http://www.astro.uva.nl/~dominik @r{on the web} | 2400 http://www.astro.uva.nl/~dominik @r{on the web} |
2398 file:/home/dominik/images/jupiter.jpg @r{file, absolute path} | 2401 file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
2402 /home/dominik/images/jupiter.jpg @r{same as above} | |
2399 file:papers/last.pdf @r{file, relative path} | 2403 file:papers/last.pdf @r{file, relative path} |
2404 ./papers/last.pdf @r{same as above} | |
2400 news:comp.emacs @r{Usenet link} | 2405 news:comp.emacs @r{Usenet link} |
2401 mailto:adent@@galaxy.net @r{Mail link} | 2406 mailto:adent@@galaxy.net @r{Mail link} |
2402 vm:folder @r{VM folder link} | 2407 vm:folder @r{VM folder link} |
2403 vm:folder#id @r{VM message link} | 2408 vm:folder#id @r{VM message link} |
2404 vm://myself@@some.where.org/folder#id @r{VM on remote machine} | 2409 vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
2405 wl:folder @r{WANDERLUST folder link} | 2410 wl:folder @r{WANDERLUST folder link} |
2406 wl:folder#id @r{WANDERLUST message link} | 2411 wl:folder#id @r{WANDERLUST message link} |
2407 mhe:folder @r{MH-E folder link} | 2412 mhe:folder @r{MH-E folder link} |
2408 mhe:folder#id @r{MH-E message link} | 2413 mhe:folder#id @r{MH-E message link} |
2409 rmail:folder @r{RMAIL folder link} | 2414 rmail:folder @r{RMAIL folder link} |
2706 to be added to the hook variables | 2711 to be added to the hook variables |
2707 @code{org-create-file-search-functions} and | 2712 @code{org-create-file-search-functions} and |
2708 @code{org-execute-file-search-functions}. See the docstring for these | 2713 @code{org-execute-file-search-functions}. See the docstring for these |
2709 variables for more information. Org actually uses this mechanism | 2714 variables for more information. Org actually uses this mechanism |
2710 for Bib@TeX{} database files, and you can use the corresponding code as | 2715 for Bib@TeX{} database files, and you can use the corresponding code as |
2711 an implementation example. Search for @samp{BibTeX links} in the source | 2716 an implementation example. See the file @file{org-bibtex.el}. |
2712 file. | |
2713 | 2717 |
2714 @node TODO Items, Tags, Hyperlinks, Top | 2718 @node TODO Items, Tags, Hyperlinks, Top |
2715 @chapter TODO Items | 2719 @chapter TODO Items |
2716 @cindex TODO items | 2720 @cindex TODO items |
2717 | 2721 |
2718 Org mode does not maintain TODO lists as separate documents. Instead, | 2722 Org mode does not maintain TODO lists as separate documents@footnote{Of |
2719 TODO items are an integral part of the notes file, because TODO items | 2723 course, you can make a document that contains inly long lists of TODO items, |
2720 usually come up while taking notes! With Org mode, simply mark any | 2724 but this is not required.}. Instead, TODO items are an integral part of the |
2721 entry in a tree as being a TODO item. In this way, information is not | 2725 notes file, because TODO items usually come up while taking notes! With Org |
2722 duplicated, and the entire context from which the TODO item emerged is | 2726 mode, simply mark any entry in a tree as being a TODO item. In this way, |
2723 always present. | 2727 information is not duplicated, and the entire context from which the TODO |
2728 item emerged is always present. | |
2724 | 2729 |
2725 Of course, this technique for managing TODO items scatters them | 2730 Of course, this technique for managing TODO items scatters them |
2726 throughout your notes file. Org mode compensates for this by providing | 2731 throughout your notes file. Org mode compensates for this by providing |
2727 methods to give you an overview of all the things that you have to do. | 2732 methods to give you an overview of all the things that you have to do. |
2728 | 2733 |
2836 (setq org-todo-keywords | 2841 (setq org-todo-keywords |
2837 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | 2842 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) |
2838 @end lisp | 2843 @end lisp |
2839 | 2844 |
2840 The vertical bar separates the TODO keywords (states that @emph{need | 2845 The vertical bar separates the TODO keywords (states that @emph{need |
2841 action}) from the DONE states (which need @emph{no further action}. If | 2846 action}) from the DONE states (which need @emph{no further action}). If |
2842 you don't provide the separator bar, the last state is used as the DONE | 2847 you don't provide the separator bar, the last state is used as the DONE |
2843 state. | 2848 state. |
2844 @cindex completion, of TODO keywords | 2849 @cindex completion, of TODO keywords |
2845 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | 2850 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO |
2846 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may | 2851 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may |
3316 support for tags. | 3321 support for tags. |
3317 | 3322 |
3318 Every headline can contain a list of tags; they occur at the end of the | 3323 Every headline can contain a list of tags; they occur at the end of the |
3319 headline. Tags are normal words containing letters, numbers, @samp{_}, | 3324 headline. Tags are normal words containing letters, numbers, @samp{_}, |
3320 and @samp{@@}. Tags must be preceded and followed by a single colon, | 3325 and @samp{@@}. Tags must be preceded and followed by a single colon, |
3321 e.g., @samp{:WORK:}. Several tags can be specified, as in | 3326 e.g., @samp{:work:}. Several tags can be specified, as in |
3322 @samp{:work:URGENT:}. | 3327 @samp{:work:urgent:}. |
3323 | 3328 |
3324 @menu | 3329 @menu |
3325 * Tag inheritance:: Tags use the tree structure of the outline | 3330 * Tag inheritance:: Tags use the tree structure of the outline |
3326 * Setting tags:: How to assign tags to a headline | 3331 * Setting tags:: How to assign tags to a headline |
3327 * Tag searches:: Searching for combinations of tags | 3332 * Tag searches:: Searching for combinations of tags |
3750 To create sparse trees and special lists with selection based on properties, | 3755 To create sparse trees and special lists with selection based on properties, |
3751 the same commands are used as for tag searches (@pxref{Tag searches}), and | 3756 the same commands are used as for tag searches (@pxref{Tag searches}), and |
3752 the same logic applies. For example, here is a search string: | 3757 the same logic applies. For example, here is a search string: |
3753 | 3758 |
3754 @example | 3759 @example |
3755 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2+With=@{Sarah\|Denny@} | 3760 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \ |
3761 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>" | |
3756 @end example | 3762 @end example |
3757 | 3763 |
3758 @noindent | 3764 @noindent |
3765 The type of comparison will depend on how the comparison value is written: | |
3766 @itemize @minus | |
3767 @item | |
3759 If the comparison value is a plain number, a numerical comparison is done, | 3768 If the comparison value is a plain number, a numerical comparison is done, |
3760 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, | 3769 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, |
3761 @samp{>=}, and @samp{<>}. If the comparison value is enclosed in double | 3770 @samp{>=}, and @samp{<>}. |
3762 quotes, a string comparison is done, and the same operators are allowed. If | 3771 @item |
3763 the comparison value is enclosed in curly braces, a regexp match is | 3772 If the comparison value is enclosed in double |
3764 performed, with @samp{=} meaning that the regexp matches the property value, | 3773 quotes, a string comparison is done, and the same operators are allowed. |
3765 and @samp{<>} meaning that it does not match. So the search string in the | 3774 @item |
3766 example finds entries tagged @samp{:work:} but not @samp{:boss:}, which also | 3775 If the comparison value is enclosed in double quotes @emph{and} angular |
3767 have a priority value @samp{A}, a @samp{:Coffee:} property with the value | 3776 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are |
3768 @samp{unlimited}, an @samp{Effort} property that is numerically smaller than | 3777 assumed to be date/time specifications in the standard Org way@footnote{The |
3769 2, and a @samp{:With:} property that is matched by the regular expression | 3778 only special values that will be recognized are @samp{"<now>"} for now, and |
3770 @samp{Sarah\|Denny}. | 3779 @samp{"<today"} today at 0:00 hours, i.e. without a time specification.}, and |
3780 the comparison will be done accordingly. | |
3781 @item | |
3782 If the comparison value is enclosed | |
3783 in curly braces, a regexp match is performed, with @samp{=} meaning that the | |
3784 regexp matches the property value, and @samp{<>} meaning that it does not | |
3785 match. | |
3786 @end itemize | |
3787 | |
3788 So the search string in the example finds entries tagged @samp{:work:} but | |
3789 not @samp{:boss:}, which also have a priority value @samp{A}, a | |
3790 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort} | |
3791 property that is numerically smaller than 2, a @samp{:With:} property that is | |
3792 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled | |
3793 on or after October 11, 2008. | |
3771 | 3794 |
3772 You can configure Org mode to use property inheritance during a search, but | 3795 You can configure Org mode to use property inheritance during a search, but |
3773 beware that this can slow down searches considerably. See @ref{Property | 3796 beware that this can slow down searches considerably. See @ref{Property |
3774 inheritance} for details. | 3797 inheritance} for details. |
3775 | 3798 |
4945 When you are finished preparing a note with @i{remember}, you have to press | 4968 When you are finished preparing a note with @i{remember}, you have to press |
4946 @kbd{C-c C-c} to file the note away. If you have started the clock in the | 4969 @kbd{C-c C-c} to file the note away. If you have started the clock in the |
4947 remember buffer, you will first be asked if you want to clock out | 4970 remember buffer, you will first be asked if you want to clock out |
4948 now@footnote{To avoid this query, configure the variable | 4971 now@footnote{To avoid this query, configure the variable |
4949 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock | 4972 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock |
4950 will continue to run after the note is filed away. | 4973 will continue to run after the note was filed away. |
4951 | 4974 |
4952 The handler will then store the note in the file and under the headline | 4975 The handler will then store the note in the file and under the headline |
4953 specified in the template, or it will use the default file and headlines. | 4976 specified in the template, or it will use the default file and headlines. |
4954 The window configuration will be restored, sending you back to the working | 4977 The window configuration will be restored, sending you back to the working |
4955 context before the call to @code{remember}. To re-use the location found | 4978 context before the call to @code{remember}. To re-use the location found |
5552 ranges can be specified with two time stamps, like | 5575 ranges can be specified with two time stamps, like |
5553 @c | 5576 @c |
5554 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | 5577 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. |
5555 | 5578 |
5556 In the headline of the entry itself, a time(range) may also appear as | 5579 In the headline of the entry itself, a time(range) may also appear as |
5557 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda | 5580 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda |
5558 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time | 5581 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
5559 specifications in diary entries are recognized as well. | 5582 specifications in diary entries are recognized as well. |
5560 | 5583 |
5561 For agenda display, Org mode extracts the time and displays it in a | 5584 For agenda display, Org mode extracts the time and displays it in a |
5562 standard 24 hour format as part of the prefix. The example times in | 5585 standard 24 hour format as part of the prefix. The example times in |
5685 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the | 5708 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the |
5686 previously used indirect buffer. | 5709 previously used indirect buffer. |
5687 @c | 5710 @c |
5688 @kindex l | 5711 @kindex l |
5689 @item l | 5712 @item l |
5690 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while | 5713 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while |
5691 logging was on (variable @code{org-log-done}) are shown in the agenda, | 5714 logging was on (variable @code{org-log-done}) are shown in the agenda, |
5692 as are entries that have been clocked on that day. | 5715 as are entries that have been clocked on that day. |
5716 @c | |
5717 @kindex v | |
5718 @item v | |
5719 Toggle Archives mode. In archives mode, trees that are marked are also | |
5720 scanned when producing the agenda. When you call this command with a | |
5721 @kbd{C-u} prefix argument, even all archive files are included. To exit | |
5722 archives mode, press @kbd{v} again. | |
5693 @c | 5723 @c |
5694 @kindex R | 5724 @kindex R |
5695 @item R | 5725 @item R |
5696 Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will | 5726 Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will |
5697 always show a table with the clocked times for the timespan and file scope | 5727 always show a table with the clocked times for the timespan and file scope |
6909 | 6939 |
6910 The optional second and third parameter are the markup (@samp{quote}, | 6940 The optional second and third parameter are the markup (@samp{quote}, |
6911 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the | 6941 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the |
6912 language for formatting the contents. The markup is optional, if it is not | 6942 language for formatting the contents. The markup is optional, if it is not |
6913 given, the text will be assumed to be in Org mode format and will be | 6943 given, the text will be assumed to be in Org mode format and will be |
6914 processed normally. | 6944 processed normally. The include line will also allow additional keyword |
6945 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the | |
6946 first line and for each following line. For example, to include a file as an | |
6947 item, use | |
6948 | |
6949 @example | |
6950 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " | |
6951 @end example | |
6915 | 6952 |
6916 @table @kbd | 6953 @table @kbd |
6917 @kindex C-c ' | 6954 @kindex C-c ' |
6918 @item C-c ' | 6955 @item C-c ' |
6919 Visit the include file at point. | 6956 Visit the include file at point. |
7289 files will be translated into HTML links under the assumption that an | 7326 files will be translated into HTML links under the assumption that an |
7290 HTML version also exists of the linked file. For information related to | 7327 HTML version also exists of the linked file. For information related to |
7291 linking files while publishing them to a publishing directory see | 7328 linking files while publishing them to a publishing directory see |
7292 @ref{Publishing links}. | 7329 @ref{Publishing links}. |
7293 | 7330 |
7331 If you want to specify attributes for links, you can do so using a special | |
7332 syntax. Here is an example that sets @code{alt} and @code{title} attributes | |
7333 for an inlined image: | |
7334 | |
7335 @example | |
7336 [[./img/a.jpg@{@{alt="This is image A" title="Image with no action"@}@}]] | |
7337 @end example | |
7338 | |
7294 @node Images, CSS support, Links, HTML export | 7339 @node Images, CSS support, Links, HTML export |
7295 @subsection Images | 7340 @subsection Images |
7296 | 7341 |
7297 @cindex images, inline in HTML | 7342 @cindex images, inline in HTML |
7298 @cindex inlining images in HTML | 7343 @cindex inlining images in HTML |
7330 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} | 7375 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} |
7331 .tag @r{tag in a headline} | 7376 .tag @r{tag in a headline} |
7332 .target @r{target for links} | 7377 .target @r{target for links} |
7333 @end example | 7378 @end example |
7334 | 7379 |
7335 The default style specification can be configured through the option | 7380 Each exported files contains a compact default style that defines these |
7336 @code{org-export-html-style}. If you want to use a file-local style, | 7381 classes in a basic way. You may overwrite these settings, or add to them by |
7337 you may use file variables, best wrapped into a COMMENT section at the | 7382 using the variables @code{org-export-html-style} (for Org-wide settings) and |
7338 end of the outline tree. For example@footnote{Under Emacs 21, the | 7383 @code{org-export-html-style-extra} (for more granular settings, like |
7339 continuation lines for a variable value should have no @samp{#} at the | 7384 file-local settings). If you want to use a file-local style, you may use |
7340 start of the line.}: | 7385 file variables, best wrapped into a COMMENT section at the end of the outline |
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.}: | |
7341 | 7388 |
7342 @example | 7389 @example |
7343 * COMMENT html style specifications | 7390 * COMMENT html style specifications |
7344 | 7391 |
7345 # Local Variables: | 7392 # Local Variables: |
7346 # org-export-html-style: " <style type=\"text/css\"> | 7393 # org-export-html-style-extra: |
7347 # p @{font-weight: normal; color: gray; @} | 7394 # "<style> |
7348 # h1 @{color: black; @} | 7395 # p @{font-weight: normal; color: gray; @} |
7396 # h1 @{color: black; @} | |
7349 # </style>" | 7397 # </style>" |
7350 # End: | 7398 # End: |
7351 @end example | 7399 @end example |
7352 | 7400 |
7353 Remember to execute @kbd{M-x normal-mode} after changing this to make | 7401 Remember to execute @kbd{M-x normal-mode} after changing this to make the new |
7354 the new style visible to Emacs. This command restarts Org mode for the | 7402 style immediately visible to Emacs. This command restarts Org mode for the |
7355 current buffer and forces Emacs to re-evaluate the local variables | 7403 current buffer and forces Emacs to re-evaluate the local variables section in |
7356 section in the buffer. | 7404 the buffer. |
7357 | 7405 |
7358 @c FIXME: More about header and footer styles | 7406 @c FIXME: More about header and footer styles |
7359 @c FIXME: Talk about links and targets. | 7407 @c FIXME: Talk about links and targets. |
7360 | 7408 |
7361 @node Javascript support, , CSS support, HTML export | 7409 @node Javascript support, , CSS support, HTML export |
7534 | 7582 |
7535 @node iCalendar export, , XOXO export, Exporting | 7583 @node iCalendar export, , XOXO export, Exporting |
7536 @section iCalendar export | 7584 @section iCalendar export |
7537 @cindex iCalendar export | 7585 @cindex iCalendar export |
7538 | 7586 |
7539 Some people like to use Org mode for keeping track of projects, but | 7587 Some people like to use Org mode for keeping track of projects, but still |
7540 still prefer a standard calendar application for anniversaries and | 7588 prefer a standard calendar application for anniversaries and appointments. |
7541 appointments. In this case it can be useful to have deadlines and | 7589 In this case it can be useful to have deadlines and other time-stamped items |
7542 other time-stamped items in Org files show up in the calendar | 7590 in Org files show up in the calendar application. Org mode can export |
7543 application. Org mode can export calendar information in the standard | 7591 calendar information in the standard iCalendar format. If you also want to |
7544 iCalendar format. If you also want to have TODO entries included in the | 7592 have TODO entries included in the export, configure the variable |
7545 export, configure the variable @code{org-icalendar-include-todo}. | 7593 @code{org-icalendar-include-todo}. iCalendar export will export plain time |
7594 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 | |
7596 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 | |
7598 @code{org-icalendar-use-scheduled}.}. | |
7546 | 7599 |
7547 The iCalendar standard requires each entry to have a globally unique | 7600 The iCalendar standard requires each entry to have a globally unique |
7548 identifier (UID). Org creates these identifiers during export. If you set | 7601 identifier (UID). Org creates these identifiers during export. If you set |
7549 the variable @code{org-icalendar-store-UID}, the UID will be stored in the | 7602 the variable @code{org-icalendar-store-UID}, the UID will be stored in the |
7550 @code{:ID:} property of the entry and re-used next time you report this | 7603 @code{:ID:} property of the entry and re-used next time you report this |
7574 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if | 7627 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if |
7575 the selected entries have them. If not, the summary will be derived | 7628 the selected entries have them. If not, the summary will be derived |
7576 from the headline, and the description from the body (limited to | 7629 from the headline, and the description from the body (limited to |
7577 @code{org-icalendar-include-body} characters). | 7630 @code{org-icalendar-include-body} characters). |
7578 | 7631 |
7579 How this calendar is best read and updated, depends on the application | 7632 How this calendar is best read and updated, that depends on the application |
7580 you are using. The FAQ covers this issue. | 7633 you are using. The FAQ covers this issue. |
7581 | 7634 |
7582 @node Publishing, Miscellaneous, Exporting, Top | 7635 @node Publishing, Miscellaneous, Exporting, Top |
7583 @chapter Publishing | 7636 @chapter Publishing |
7584 @cindex publishing | 7637 @cindex publishing |
7742 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts} | 7795 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts} |
7743 @item @code{:special-strings} @tab @code{org-export-with-special-strings} | 7796 @item @code{:special-strings} @tab @code{org-export-with-special-strings} |
7744 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} | 7797 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
7745 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} | 7798 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} |
7746 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} | 7799 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} |
7747 @item @code{:timestamps} .@tab @code{org-export-with-timestamps} | 7800 @item @code{:timestamps} @tab @code{org-export-with-timestamps} |
7748 @item @code{:tags} .@tab @code{org-export-with-tags} | 7801 @item @code{:author-info} @tab @code{org-export-author-info} |
7802 @item @code{:creator-info} @tab @code{org-export-creator-info} | |
7803 @item @code{:tags} @tab @code{org-export-with-tags} | |
7749 @item @code{:tables} @tab @code{org-export-with-tables} | 7804 @item @code{:tables} @tab @code{org-export-with-tables} |
7750 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | 7805 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} |
7751 @item @code{:style} @tab @code{org-export-html-style} | 7806 @item @code{:style} @tab @code{org-export-html-style} |
7807 @item @code{:style-extra} @tab @code{org-export-html-style-extra} | |
7752 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} | 7808 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} |
7753 @item @code{:inline-images} @tab @code{org-export-html-inline-images} | 7809 @item @code{:inline-images} @tab @code{org-export-html-inline-images} |
7754 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} | 7810 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} |
7755 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} | 7811 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} |
7756 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | 7812 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} |
9582 @c Local variables: | 9638 @c Local variables: |
9583 @c ispell-local-dictionary: "en_US-w_accents" | 9639 @c ispell-local-dictionary: "en_US-w_accents" |
9584 @c ispell-local-pdict: "./.aspell.org.pws" | 9640 @c ispell-local-pdict: "./.aspell.org.pws" |
9585 @c fill-column: 77 | 9641 @c fill-column: 77 |
9586 @c End: | 9642 @c End: |
9643 |