Mercurial > emacs
comparison man/org.texi @ 71653:9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
exporting commands.
(Global TODO list): Document the use of the variables
`org-agenda-todo-ignore-scheduled' and
`org-agenda-todo-list-sublevels'.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Fri, 07 Jul 2006 06:32:09 +0000 |
parents | 947e64a6bc0e |
children | c7e4f78b81a6 |
comparison
equal
deleted
inserted
replaced
71652:4df24233cf1e | 71653:9c582eb56ce7 |
---|---|
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 Org Mode Manual | 4 @settitle Org Mode Manual |
5 | 5 |
6 @set VERSION 4.42 | 6 @set VERSION 4.43 |
7 @set DATE July 2006 | 7 @set DATE July 2006 |
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 |
769 a sparse tree matching the string @samp{FIXME}. | 769 a sparse tree matching the string @samp{FIXME}. |
770 | 770 |
771 Other commands use sparse trees as well. For example @kbd{C-c | 771 Other commands use sparse trees as well. For example @kbd{C-c |
772 C-v} creates a sparse TODO tree (@pxref{TODO basics}). | 772 C-v} creates a sparse TODO tree (@pxref{TODO basics}). |
773 | 773 |
774 @kindex C-c C-x v | 774 @kindex C-c C-e v |
775 @cindex printing sparse trees | 775 @cindex printing sparse trees |
776 @cindex visible text, printing | 776 @cindex visible text, printing |
777 To print a sparse tree, you can use the Emacs command | 777 To print a sparse tree, you can use the Emacs command |
778 @code{ps-print-buffer-with-faces} which does not print invisible parts | 778 @code{ps-print-buffer-with-faces} which does not print invisible parts |
779 of the document @footnote{This does not work under XEmacs, because | 779 of the document @footnote{This does not work under XEmacs, because |
780 XEmacs uses selective display for outlining, not text properties.}. | 780 XEmacs uses selective display for outlining, not text properties.}. |
781 Or you can use the command @kbd{C-c C-x v} to export only the visible | 781 Or you can use the command @kbd{C-c C-e v} to export only the visible |
782 part of the document and print the resulting file. | 782 part of the document and print the resulting file. |
783 | 783 |
784 | 784 |
785 @node Plain lists, Checkboxes, Sparse trees, Document structure | 785 @node Plain lists, Checkboxes, Sparse trees, Document structure |
786 @section Plain lists | 786 @section Plain lists |
3057 | 3057 |
3058 Remote editing of TODO items means that you can change the state of a | 3058 Remote editing of TODO items means that you can change the state of a |
3059 TODO entry with a single key press. The commands available in the | 3059 TODO entry with a single key press. The commands available in the |
3060 TODO list are described in @ref{Agenda commands}. | 3060 TODO list are described in @ref{Agenda commands}. |
3061 | 3061 |
3062 Nomally the global todo list simply shows all headlines with TODO | |
3063 keywords. This list can become very long. There are two ways to keep | |
3064 it more compact: | |
3065 @itemize @minus | |
3066 @item | |
3067 Some people view a TODO item that has been @emph{scheduled} for | |
3068 execution (@pxref{Time stamps}) as no longer @emph{open}. Configure the | |
3069 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled | |
3070 items from the global TODO list. | |
3071 @item | |
3072 TODO items may have sublevels to break up the task into subtasks. In | |
3073 such cases it may be enough to list only the highest level TODO headline | |
3074 and omit the sublevels from the global list. Configure the variable | |
3075 @code{org-agenda-todo-list-sublevels} to get this behavior. | |
3076 @end itemize | |
3077 | |
3078 | |
3062 @node Matching headline tags, Timeline, Global TODO list, Agenda views | 3079 @node Matching headline tags, Timeline, Global TODO list, Agenda views |
3063 @section Matching headline tags | 3080 @section Matching headline tags |
3064 @cindex matching, of tags | 3081 @cindex matching, of tags |
3065 @cindex tags view | 3082 @cindex tags view |
3066 | 3083 |
3339 | 3356 |
3340 @kindex H | 3357 @kindex H |
3341 @item H | 3358 @item H |
3342 Show holidays for three month around the cursor date. | 3359 Show holidays for three month around the cursor date. |
3343 | 3360 |
3361 @c FIXME: This should be a different key. | |
3344 @kindex C-c C-x C-c | 3362 @kindex C-c C-x C-c |
3345 @item C-c C-x C-c | 3363 @item C-c C-x C-c |
3346 Export a single iCalendar file containing entries from all agenda files. | 3364 Export a single iCalendar file containing entries from all agenda files. |
3347 | 3365 |
3348 @tsubheading{Quit and Exit} | 3366 @tsubheading{Quit and Exit} |
3573 import of these different formats. | 3591 import of these different formats. |
3574 | 3592 |
3575 When exporting, Org-mode uses special conventions to enrich the output | 3593 When exporting, Org-mode uses special conventions to enrich the output |
3576 produced. @xref{Text interpretation}, for more details. | 3594 produced. @xref{Text interpretation}, for more details. |
3577 | 3595 |
3596 @table @kbd | |
3597 @kindex C-c C-e | |
3598 @item C-c C-e | |
3599 Dispatcher for export and publishing commands. Displays a help-window | |
3600 listing the additional key(s) needed to launch an export or publishing | |
3601 command. | |
3602 @end table | |
3603 | |
3578 @menu | 3604 @menu |
3579 * ASCII export:: Exporting to plain ASCII | 3605 * ASCII export:: Exporting to plain ASCII |
3580 * HTML export:: Exporting to HTML | 3606 * HTML export:: Exporting to HTML |
3581 * XOXO export:: Exporting to XOXO | 3607 * XOXO export:: Exporting to XOXO |
3582 * iCalendar export:: Exporting in iCalendar format | 3608 * iCalendar export:: Exporting in iCalendar format |
3592 | 3618 |
3593 @cindex region, active | 3619 @cindex region, active |
3594 @cindex active region | 3620 @cindex active region |
3595 @cindex transient-mark-mode | 3621 @cindex transient-mark-mode |
3596 @table @kbd | 3622 @table @kbd |
3597 @kindex C-c C-x a | 3623 @kindex C-c C-e a |
3598 @item C-c C-x a | 3624 @item C-c C-e a |
3599 Export as ASCII file. If there is an active region, only the region | 3625 Export as ASCII file. If there is an active region, only the region |
3600 will be exported. For an org file @file{myfile.org}, the ASCII file | 3626 will be exported. For an org file @file{myfile.org}, the ASCII file |
3601 will be @file{myfile.txt}. The file will be overwritten without | 3627 will be @file{myfile.txt}. The file will be overwritten without |
3602 warning. | 3628 warning. |
3603 @kindex C-c C-x v a | 3629 @kindex C-c C-e v a |
3604 @item C-c C-x v a | 3630 @item C-c C-e v a |
3605 Export only the visible part of the document. | 3631 Export only the visible part of the document. |
3606 @end table | 3632 @end table |
3607 | 3633 |
3608 @cindex headline levels, for exporting | 3634 @cindex headline levels, for exporting |
3609 In the exported version, the first 3 outline levels will become | 3635 In the exported version, the first 3 outline levels will become |
3610 headlines, defining a general document structure. Additional levels | 3636 headlines, defining a general document structure. Additional levels |
3611 will be exported as itemized lists. If you want that transition to occur | 3637 will be exported as itemized lists. If you want that transition to occur |
3612 at a different level, specify it with a prefix argument. For example, | 3638 at a different level, specify it with a prefix argument. For example, |
3613 | 3639 |
3614 @example | 3640 @example |
3615 @kbd{C-1 C-c C-x a} | 3641 @kbd{C-1 C-c C-e a} |
3616 @end example | 3642 @end example |
3617 | 3643 |
3618 @noindent | 3644 @noindent |
3619 creates only top level headlines and does the rest as items. When | 3645 creates only top level headlines and does the rest as items. When |
3620 headlines are converted to items, the indentation of the text following | 3646 headlines are converted to items, the indentation of the text following |
3634 | 3660 |
3635 @cindex region, active | 3661 @cindex region, active |
3636 @cindex active region | 3662 @cindex active region |
3637 @cindex transient-mark-mode | 3663 @cindex transient-mark-mode |
3638 @table @kbd | 3664 @table @kbd |
3639 @kindex C-c C-x h | 3665 @kindex C-c C-e h |
3640 @item C-c C-x h | 3666 @item C-c C-e h |
3641 Export as HTML file @file{myfile.html}. | 3667 Export as HTML file @file{myfile.html}. |
3642 @kindex C-c C-x b | 3668 @kindex C-c C-e b |
3643 @item C-c C-x b | 3669 @item C-c C-e b |
3644 Export as HTML file and open it with a browser. | 3670 Export as HTML file and open it with a browser. |
3645 @kindex C-c C-x v h | 3671 @kindex C-c C-e v h |
3646 @kindex C-c C-x v b | 3672 @kindex C-c C-e v b |
3647 @item C-c C-x v h | 3673 @item C-c C-e v h |
3648 @item C-c C-x v b | 3674 @item C-c C-e v b |
3649 Export only the visible part of the document. | 3675 Export only the visible part of the document. |
3650 @end table | 3676 @end table |
3651 | 3677 |
3652 @cindex headline levels, for exporting | 3678 @cindex headline levels, for exporting |
3653 In the exported version, the first 3 outline levels will become | 3679 In the exported version, the first 3 outline levels will become |
3654 headlines, defining a general document structure. Additional levels | 3680 headlines, defining a general document structure. Additional levels |
3655 will be exported as itemized lists. If you want that transition to occur | 3681 will be exported as itemized lists. If you want that transition to occur |
3656 at a different level, specify it with a prefix argument. For example, | 3682 at a different level, specify it with a prefix argument. For example, |
3657 | 3683 |
3658 @example | 3684 @example |
3659 @kbd{C-2 C-c C-x b} | 3685 @kbd{C-2 C-c C-e b} |
3660 @end example | 3686 @end example |
3661 | 3687 |
3662 @noindent | 3688 @noindent |
3663 creates two levels of headings and does the rest as items. | 3689 creates two levels of headings and does the rest as items. |
3664 | 3690 |
3723 Org-mode contains an exporter that produces XOXO-style output. | 3749 Org-mode contains an exporter that produces XOXO-style output. |
3724 Currently, this exporter only handles the general outline structure and | 3750 Currently, this exporter only handles the general outline structure and |
3725 does not interpret any additional Org-mode features. | 3751 does not interpret any additional Org-mode features. |
3726 | 3752 |
3727 @table @kbd | 3753 @table @kbd |
3728 @kindex C-c C-x C-x | 3754 @kindex C-c C-e x |
3729 @item C-c C-x C-x | 3755 @item C-c C-e x |
3730 Export as XOXO file @file{myfile.html}. | 3756 Export as XOXO file @file{myfile.html}. |
3731 @kindex C-c C-x v | 3757 @kindex C-c C-e v |
3732 @item C-c C-x v x | 3758 @item C-c C-e v x |
3733 Export only the visible part of the document. | 3759 Export only the visible part of the document. |
3734 @end table | 3760 @end table |
3735 | 3761 |
3736 @node iCalendar export, Text interpretation, XOXO export, Exporting | 3762 @node iCalendar export, Text interpretation, XOXO export, Exporting |
3737 @section iCalendar export | 3763 @section iCalendar export |
3743 other time-stamped items in Org-mode files show up in the calendar | 3769 other time-stamped items in Org-mode files show up in the calendar |
3744 application. Org-mode can export calendar information in the standard | 3770 application. Org-mode can export calendar information in the standard |
3745 iCalendar format. | 3771 iCalendar format. |
3746 | 3772 |
3747 @table @kbd | 3773 @table @kbd |
3748 @kindex C-c C-x i | 3774 @kindex C-c C-e i |
3749 @item C-c C-x i | 3775 @item C-c C-e i |
3750 Create iCalendar entries for the current file and store them in the same | 3776 Create iCalendar entries for the current file and store them in the same |
3751 directory, using a file extension @file{.ics}. | 3777 directory, using a file extension @file{.ics}. |
3752 @kindex C-c C-x C-i | 3778 @kindex C-c C-e I |
3753 @item C-c C-x C-i | 3779 @item C-c C-e I |
3754 Like @kbd{C-c C-x i}, but do this for all files in | 3780 Like @kbd{C-c C-e i}, but do this for all files in |
3755 @code{org-agenda-files}. For each of these files, a separate iCalendar | 3781 @code{org-agenda-files}. For each of these files, a separate iCalendar |
3756 file will be written. | 3782 file will be written. |
3757 @kindex C-c C-x c | 3783 @kindex C-c C-e c |
3758 @item C-c C-x c | 3784 @item C-c C-e c |
3759 Create a single large iCalendar file from all files in | 3785 Create a single large iCalendar file from all files in |
3760 @code{org-agenda-files} and write it to the file given by | 3786 @code{org-agenda-files} and write it to the file given by |
3761 @code{org-combined-agenda-icalendar-file}. | 3787 @code{org-combined-agenda-icalendar-file}. |
3762 @end table | 3788 @end table |
3763 | 3789 |
3764 How this calendar is best read and updated, depends on the application | 3790 How this calendar is best read and updated, depends on the application |
3765 you are using. For example, when using iCal under Apple MacOS X, you | 3791 you are using. For example, when using iCal under Apple MacOS X, you |
3766 could create a new calendar @samp{OrgMode} (the default name for the | 3792 could create a new calendar @samp{OrgMode} (the default name for the |
3767 calendar created by @kbd{C-c C-x c}, see the variables | 3793 calendar created by @kbd{C-c C-e c}, see the variables |
3768 @code{org-icalendar-combined-name} and | 3794 @code{org-icalendar-combined-name} and |
3769 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to | 3795 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to |
3770 overwrite the corresponding file | 3796 overwrite the corresponding file |
3771 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript | 3797 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript |
3772 to make iCal re-read the calendar files each time a new version of | 3798 to make iCal re-read the calendar files each time a new version of |
3879 | 3905 |
3880 @cindex completion, of option keywords | 3906 @cindex completion, of option keywords |
3881 The exporter recognizes special lines in the buffer which provide | 3907 The exporter recognizes special lines in the buffer which provide |
3882 additional information. These lines may be put anywhere in the file. | 3908 additional information. These lines may be put anywhere in the file. |
3883 The whole set of lines can be inserted into the buffer with @kbd{C-c | 3909 The whole set of lines can be inserted into the buffer with @kbd{C-c |
3884 C-x t}. For individual lines, a good way to make sure the keyword is | 3910 C-e t}. For individual lines, a good way to make sure the keyword is |
3885 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion | 3911 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion |
3886 (@pxref{Completion}). | 3912 (@pxref{Completion}). |
3887 | 3913 |
3888 @table @kbd | 3914 @table @kbd |
3889 @kindex C-c C-x t | 3915 @kindex C-c C-e t |
3890 @item C-c C-x t | 3916 @item C-c C-e t |
3891 Insert template with export options, see example below. | 3917 Insert template with export options, see example below. |
3892 @end table | 3918 @end table |
3893 | 3919 |
3894 @example | 3920 @example |
3895 #+TITLE: the title to be shown (default is the buffer name) | 3921 #+TITLE: the title to be shown (default is the buffer name) |
4249 Once org-publish is properly configured, you can publish with the | 4275 Once org-publish is properly configured, you can publish with the |
4250 following functions: | 4276 following functions: |
4251 | 4277 |
4252 @table @kbd | 4278 @table @kbd |
4253 @item C-c C-e c | 4279 @item C-c C-e c |
4254 Prompts for a specific project to publish. | 4280 Prompt for a specific project and publish all files that belong to it. |
4255 @item C-c C-e p | 4281 @item C-c C-e p |
4256 Publishes the project the current file is part of. | 4282 Publish the project containin the current file. |
4257 @item C-c C-e f | 4283 @item C-c C-e f |
4258 Publishes only the current file. | 4284 Publish only the current file. |
4259 @item C-c C-e a | 4285 @item C-c C-e a |
4260 Publish all projects. | 4286 Publish all projects. |
4261 @end table | 4287 @end table |
4262 | 4288 |
4263 Org uses timestamps to track when a file has changed. The above | 4289 Org uses timestamps to track when a file has changed. The above |
4264 functions normally only publish changed files. You can override this and | 4290 functions normally only publish changed files. You can override this and |
4265 force publishing of all files by giving a prefix argument. | 4291 force publishing of all files by giving a prefix argument. |
4266 | 4292 |
4267 @node Miscellaneous, Extensions and Hacking, Publishing, Top | 4293 @node Miscellaneous, Extensions and Hacking, Publishing, Top |
4268 @chapter Miscellaneous | 4294 @chapter Miscellaneous |
4269 | 4295 |
4270 @menu | 4296 @menu |
4768 | 4794 |
4769 @node Dynamic blocks, , Extensions, Extensions and Hacking | 4795 @node Dynamic blocks, , Extensions, Extensions and Hacking |
4770 @section Dynamic blocks | 4796 @section Dynamic blocks |
4771 | 4797 |
4772 Org-mode documents can contain @emph{dynamic blocks}. These are | 4798 Org-mode documents can contain @emph{dynamic blocks}. These are |
4773 specially marked regions that are updates by some user-written | 4799 specially marked regions that are updated by some user-written |
4774 function. A good example for such a block is the clock table inserted | 4800 function. A good example for such a block is the clock table inserted |
4775 by the command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | 4801 by the command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). |
4776 | 4802 |
4777 Dynamic block are enclosed by a BEGIN-END structure that assigns a name | 4803 Dynamic block are enclosed by a BEGIN-END structure that assigns a name |
4778 to the block and can also specify parameters for the function producing | 4804 to the block and can also specify parameters for the function producing |
4812 | 4838 |
4813 @noindent | 4839 @noindent |
4814 The corresponding block writer function could look like this: | 4840 The corresponding block writer function could look like this: |
4815 | 4841 |
4816 @lisp | 4842 @lisp |
4817 (defun org-dblock-write:date-and-time (params) | 4843 (defun org-dblock-write:block-update-time (params) |
4818 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) | 4844 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) |
4819 (insert "Last block update at: " | 4845 (insert "Last block update at: " |
4820 (format-time-string fmt (current-time))))) | 4846 (format-time-string fmt (current-time))))) |
4821 @end lisp | 4847 @end lisp |
4822 | 4848 |