[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs/man/org.texi
|
From: |
Carsten Dominik |
|
Subject: |
[Emacs-diffs] Changes to emacs/man/org.texi |
|
Date: |
Fri, 29 Apr 2005 04:37:29 -0400 |
Index: emacs/man/org.texi
diff -c emacs/man/org.texi:1.7 emacs/man/org.texi:1.8
*** emacs/man/org.texi:1.7 Fri Apr 15 06:55:07 2005
--- emacs/man/org.texi Fri Apr 29 08:37:28 2005
***************
*** 1,9 ****
\input texinfo
@c %**start of header
@setfilename ../info/org
@settitle Org Mode Manual
! @set VERSION 3.06
@set DATE April 2005
@dircategory Emacs
--- 1,10 ----
\input texinfo
@c %**start of header
+ @c @setfilename org
@setfilename ../info/org
@settitle Org Mode Manual
! @set VERSION 3.08
@set DATE April 2005
@dircategory Emacs
***************
*** 76,84 ****
@menu
* Introduction:: Getting started
* Document Structure:: A tree works like your brain
- * TODO items:: Every tree branch can be a TODO item
* Tables:: Pure magic for quick formatting
* Hyperlinks:: Notes in context
* Timestamps:: Assign date and time to items
* Timeline and Agenda:: Use time-stamped items to produce an agenda
* Exporting:: Sharing and publishing of notes
--- 77,85 ----
@menu
* Introduction:: Getting started
* Document Structure:: A tree works like your brain
* Tables:: Pure magic for quick formatting
* Hyperlinks:: Notes in context
+ * TODO items:: Every tree branch can be a TODO item
* Timestamps:: Assign date and time to items
* Timeline and Agenda:: Use time-stamped items to produce an agenda
* Exporting:: Sharing and publishing of notes
***************
*** 93,98 ****
--- 94,100 ----
* Summary:: Brief summary of what Org-mode does
* Installation and Activation:: How to install Org-mode
+ * Feedback:: Bug reportes, ideas, patches etc.
Document Structure
***************
*** 103,108 ****
--- 105,121 ----
* Structure editing:: Changing sequence and level of headlines
* Sparse trees:: Matches embedded in context
+ Tables
+
+ * Built-in table editor:: Simple tables
+ * table.el:: Complex tables
+ * orgtbl-mode:: The table editor as minor mode
+
+ Hyperlinks
+
+ * Links:: URL-like links to the world
+ * Remember:: Org-trees store quick notes
+
TODO items
* TODO basics:: Marking and displaying TODO entries
***************
*** 115,131 ****
* TODO types:: I do this, Fred the rest
* Per file keywords:: Different files, different requirements
- Tables
-
- * Built-in table editor:: Simple tables
- * table.el:: Complex tables
- * orgtbl-mode:: The table editor as minor mode
-
- Hyperlinks
-
- * Links:: URL-like links to the world
- * Remember:: Org-trees store quick notes
-
Timestamps
* Time stamps:: Assigning a time to a tree entry
--- 128,133 ----
***************
*** 169,174 ****
--- 171,177 ----
@menu
* Summary:: Brief summary of what Org-mode does
* Installation and Activation:: How to install Org-mode
+ * Feedback:: Bug reportes, ideas, patches etc.
@end menu
@node Summary, Installation and Activation, Introduction, Introduction
***************
*** 214,220 ****
@page
! @node Installation and Activation, , Summary, Introduction
@section Installation and Activation
@cindex installation
@cindex autoload
--- 217,223 ----
@page
! @node Installation and Activation, Feedback, Summary, Introduction
@section Installation and Activation
@cindex installation
@cindex autoload
***************
*** 263,269 ****
the file's name is. See also the variable
@code{org-insert-mode-line-in-empty-file'}.
! @node Document Structure, TODO items, Introduction, Top
@chapter Document Structure
@cindex document structure
@cindex structure of document
--- 266,297 ----
the file's name is. See also the variable
@code{org-insert-mode-line-in-empty-file'}.
! @node Feedback, , Installation and Activation, Introduction
! @section Feedback
! @cindex feedback
! @cindex bug reports
! @cindex maintainer
! @cindex author
!
! If you find problems with Org-mode, or if you have questions, remarks,
! or ideas about it, please contact the maintainer Carsten Dominik at
! @value{MAINTAINEREMAIL}.
!
! For bug reports, please provide as much information as possible,
! including the version information of Emacs (@kbd{C-h v emacs-version
! @key{RET}}) and Org-mode (@kbd{M-x org-version}), as well as the
! Org-mode related setup in @file{.emacs}. If an error occurs, a
! traceback can be very useful. Often a small example file helps, along
! with clear information about:
! @enumerate
! @item What exactly did you do?
! @item What did you expect to happen?
! @item What happened instead?
! @end enumerate
! @noindent Thanks for helping to improve this mode.
!
!
! @node Document Structure, Tables, Introduction, Top
@chapter Document Structure
@cindex document structure
@cindex structure of document
***************
*** 503,711 ****
the document to another file (extension @file{.txt}) which then can be
printed in any desired way.
! @node TODO items, Tables, Document Structure, Top
! @chapter TODO items
! @cindex TODO items
!
! Org-mode does not maintain TODO lists as a separate document. TODO
! items are an integral part of the notes file, because TODO items
! usually come up while taking notes! With Org-mode, you simply mark
! any entry in a tree as being a TODO item. In this way, the
! information is not duplicated, and the entire context from which the
! item emerged is always present when you check.
!
! Of course, this technique causes TODO items to be scattered throughout
! your file. Org-mode provides methods to give you an overview over all
! things you have to do.
!
! @menu
! * TODO basics:: Marking and displaying TODO entries
! * TODO extensions:: Workflow and assignments
! * Priorities:: Some things are more important than others
! @end menu
!
! @node TODO basics, TODO extensions, TODO items, TODO items
! @section Basic TODO functionality
!
! Any headline can become a TODO item by starting it with the word TODO,
! for example
!
! @example
! *** TODO Write letter to Sam Fortune
! @end example
!
! @noindent
! The most important commands to work with TODO entries are:
!
! @table @kbd
! @kindex C-c C-t
! @item C-c C-t
! Rotate the TODO state of the current item between
! @example
! ,-> (unmarked) -> TODO -> DONE --.
! '--------------------------------'
! @end example
! The same rotation can also be done ``remotely'' from the timeline and
! agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
! @kindex C-c C-v
! @cindex sparse tree, for TODO
! @item C-c C-v
! View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
! the entire buffer, but shows all TODO items and the headings hierarchy
! above them. With prefix arg, show also the DONE entries.
! @item C-u C-c a
! A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda})
! collects all unfinished TODO items into a single place.
! @end table
!
! @node TODO extensions, Priorities, TODO basics, TODO items
! @section Extended use of TODO keywords
! @cindex extended TODO keywords
!
! The default implementation of TODO entries is just two states: TODO
! and DONE. You can, however, use the TODO feature for more
! complicated things by configuring the variables
! @code{org-todo-keywords} and @code{org-todo-interpretation}. Using
! special setup, you can even use TODO keywords in different ways in
! different org files.
!
! @menu
! * Workflow states:: From TODO to DONE in steps
! * TODO types:: I do this, Fred the rest
! * Per file keywords:: Different files, different requirements
! @end menu
!
! @node Workflow states, TODO types, TODO extensions, TODO extensions
! @subsection TODO keywords as workflow states
! @cindex TODO workflow
! @cindex workflow states as TODO keywords
!
! You can use TODO keywords to indicate different states in the process
! of working on an item, for example
!
! @lisp
! (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
! org-todo-interpretation 'sequence)
! @end lisp
!
! With this setup, the command @kbd{C-c C-t} will cycle an entry from
! TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also
! use a prefix argument to quickly select a specific state. For example
! @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
! If you define many keywords, you can use in-buffer completion (see
! @ref{Completion}) to insert these words into the buffer.
!
! @node TODO types, Per file keywords, Workflow states, TODO extensions
! @subsection TODO keywords as types
! @cindex TODO types
! @cindex names as TODO keywords
! @cindex types as TODO keywords
!
! The second possibility is to use TODO keywords to indicate different
! types of action items. For example, you might want to indicate that
! items are for ``work'' or ``home''. Or, when you work with several
! people on a single project, you might want to assign action items
! directly to persons, by using their names as TODO keywords. This
! would be set up like this:
!
! @lisp
! (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
! org-todo-interpretation 'type)
! @end lisp
!
! In this case, different keywords do not indicate a sequence, but
! rather different types. So it is normally not useful to change from
! one type to another. Therefore, in this case the the behavior of the
! command @kbd{C-c C-t} is changed address@hidden is also true
! for the @kbd{t} command in the timeline and agenda buffers}. When
! used several times in succession, it will still cycle through all
! names. But when when you return to the item after some time and
! execute @kbd{C-c C-t} again, it will switch from each name directly to
! DONE. Use prefix arguments or completion to quickly select a specific
! name.
!
! @node Per file keywords, , TODO types, TODO extensions
! @subsection Setting up TODO keywords for individual files
! @cindex keyword options
! @cindex per file keywords
!
! It can be very useful to use different aspects of the TODO mechanism
! in different files, which is not possible with the global settings
! described above. For file-local settings, you need to add special
! lines to the file which set the keywords and interpretation for that
! file only. For example, to set one of the two examples discussed
! above, you need one of the following lines, starting in column zero
! anywhere in the file:
!
! @example
! #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
! #+TYP_TODO: Fred Sara Lucy Mike DONE
! @end example
!
! @cindex Completing option keywords
! @kindex address@hidden
! @noindent To make sure you are using the correct keyword, type
! @samp{#+} into the buffer and then use @address@hidden completion.
!
! @cindex DONE, final TODO keyword
! Remember that the last keyword must always mean that the item is DONE
! (you may use a different word, though). Also note that in each file,
! only one of the two aspects of TODO keywords can be used. After
! changing one of these lines, use @kbd{C-c C-c} with the cursor still
! in the line to make the changes known to address@hidden
! parses these lines only when Org-mode is activated after visiting a
! file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-}
! is simply restarting Org-mode, making sure that these changes will be
! respected.}.
!
! If you want to use very many keywords, for example when working with a
! large group of people, you may split the names over several lines:
!
! @example
! #+TYP_TODO: Fred Sara Lucy Mike
! #+TYP_TODO: Luis George Jules Jessica
! #+TYP_TODO: Kim Arnold Peter
! #+TYP_TODO: DONE
! @end example
!
! @node Priorities, , TODO extensions, TODO items
! @section Priorities
! @cindex priorities
!
! If you use Org-mode extensively to organize your work, you may end up
! with a number of TODO entries so large that you'd like to prioritize
! them. This can be done by placing a @emph{priority cookie} into the
! headline, like this
!
! @example
! *** TODO [#A] Write letter to Sam Fortune
! @end example
!
! @noindent
! With its standard setup, Org-mode supports priorities @samp{A},
! @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry
! without a cookie is treated as priority @samp{B}. Priorities make a
! difference only in the agenda (@pxref{Agenda}).
!
! @table @kbd
! @kindex @kbd{C-c ,}
! @item @kbd{C-c ,}
! Set the priority of the current item. The command prompts for a
! priority character @samp{A}, @samp{B} or @samp{C}. When you press
! @key{SPC} instead, the priority cookie is removed from the headline.
! The priorities can also be changed ``remotely'' from the timeline and
! agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
!
! @kindex address@hidden
! @kindex address@hidden
! @item address@hidden
! @itemx address@hidden
! Increase/decrease priority of current item. Note that these keys are
! also used to modify time stamps (@pxref{Creating timestamps}).
! @end table
!
!
! @node Tables, Hyperlinks, TODO items, Top
@chapter Tables
@cindex tables
--- 531,537 ----
the document to another file (extension @file{.txt}) which then can be
printed in any desired way.
! @node Tables, Hyperlinks, Document Structure, Top
@chapter Tables
@cindex tables
***************
*** 951,964 ****
If you like the intuitive way the Org-mode table editor works, you
might want to use it also in other modes like text-mode or mail-mode.
! The minor mode Orgtbl-mode make this possible. You can always toggle
the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
example in mail mode, use
@lisp
(add-hook 'mail-mode-hook 'turn-on-orgtbl)
@end lisp
! @node Hyperlinks, Timestamps, Tables, Top
@chapter Hyperlinks
@cindex hyperlinks
--- 777,790 ----
If you like the intuitive way the Org-mode table editor works, you
might want to use it also in other modes like text-mode or mail-mode.
! The minor mode Orgtbl-mode makes this possible. You can always toggle
the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
example in mail mode, use
@lisp
(add-hook 'mail-mode-hook 'turn-on-orgtbl)
@end lisp
! @node Hyperlinks, TODO items, Tables, Top
@chapter Hyperlinks
@cindex hyperlinks
***************
*** 1006,1012 ****
@end example
A link may contain space characters and is terminated by the end of
! the line. Therefore, there can be only one link per line (but see the
variable @code{org-allow-space-in-links}).
@cindex storing links
--- 832,839 ----
@end example
A link may contain space characters and is terminated by the end of
! the line or, in tables, by the end of the table field. Therefore,
! outside of tables there can be only one link per line (but see the
variable @code{org-allow-space-in-links}).
@cindex storing links
***************
*** 1115,1121 ****
non-nil, the entire text is also indented so that it starts in the
same column as the headline (after the asterisks).
! @node Timestamps, Timeline and Agenda, Hyperlinks, Top
@chapter Timestamps
Items can be labeled with timestamps to make them useful for project
--- 942,1151 ----
non-nil, the entire text is also indented so that it starts in the
same column as the headline (after the asterisks).
! @node TODO items, Timestamps, Hyperlinks, Top
! @chapter TODO items
! @cindex TODO items
!
! Org-mode does not maintain TODO lists as a separate document. TODO
! items are an integral part of the notes file, because TODO items
! usually come up while taking notes! With Org-mode, you simply mark
! any entry in a tree as being a TODO item. In this way, the
! information is not duplicated, and the entire context from which the
! item emerged is always present when you check.
!
! Of course, this technique causes TODO items to be scattered throughout
! your file. Org-mode provides methods to give you an overview over all
! things you have to do.
!
! @menu
! * TODO basics:: Marking and displaying TODO entries
! * TODO extensions:: Workflow and assignments
! * Priorities:: Some things are more important than others
! @end menu
!
! @node TODO basics, TODO extensions, TODO items, TODO items
! @section Basic TODO functionality
!
! Any headline can become a TODO item by starting it with the word TODO,
! for example
!
! @example
! *** TODO Write letter to Sam Fortune
! @end example
!
! @noindent
! The most important commands to work with TODO entries are:
!
! @table @kbd
! @kindex C-c C-t
! @item C-c C-t
! Rotate the TODO state of the current item between
! @example
! ,-> (unmarked) -> TODO -> DONE --.
! '--------------------------------'
! @end example
! The same rotation can also be done ``remotely'' from the timeline and
! agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
! @kindex C-c C-v
! @cindex sparse tree, for TODO
! @item C-c C-v
! View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
! the entire buffer, but shows all TODO items and the headings hierarchy
! above them. With prefix arg, show also the DONE entries.
! @item C-u C-c a
! A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda})
! collects all unfinished TODO items into a single place.
! @end table
!
! @node TODO extensions, Priorities, TODO basics, TODO items
! @section Extended use of TODO keywords
! @cindex extended TODO keywords
!
! The default implementation of TODO entries is just two states: TODO
! and DONE. You can, however, use the TODO feature for more
! complicated things by configuring the variables
! @code{org-todo-keywords} and @code{org-todo-interpretation}. Using
! special setup, you can even use TODO keywords in different ways in
! different org files.
!
! @menu
! * Workflow states:: From TODO to DONE in steps
! * TODO types:: I do this, Fred the rest
! * Per file keywords:: Different files, different requirements
! @end menu
!
! @node Workflow states, TODO types, TODO extensions, TODO extensions
! @subsection TODO keywords as workflow states
! @cindex TODO workflow
! @cindex workflow states as TODO keywords
!
! You can use TODO keywords to indicate different states in the process
! of working on an item, for example
!
! @lisp
! (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
! org-todo-interpretation 'sequence)
! @end lisp
!
! With this setup, the command @kbd{C-c C-t} will cycle an entry from
! TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also
! use a prefix argument to quickly select a specific state. For example
! @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
! If you define many keywords, you can use in-buffer completion (see
! @ref{Completion}) to insert these words into the buffer.
!
! @node TODO types, Per file keywords, Workflow states, TODO extensions
! @subsection TODO keywords as types
! @cindex TODO types
! @cindex names as TODO keywords
! @cindex types as TODO keywords
!
! The second possibility is to use TODO keywords to indicate different
! types of action items. For example, you might want to indicate that
! items are for ``work'' or ``home''. Or, when you work with several
! people on a single project, you might want to assign action items
! directly to persons, by using their names as TODO keywords. This
! would be set up like this:
!
! @lisp
! (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
! org-todo-interpretation 'type)
! @end lisp
!
! In this case, different keywords do not indicate a sequence, but
! rather different types. So it is normally not useful to change from
! one type to another. Therefore, in this case the the behavior of the
! command @kbd{C-c C-t} is changed address@hidden is also true
! for the @kbd{t} command in the timeline and agenda buffers}. When
! used several times in succession, it will still cycle through all
! names. But when when you return to the item after some time and
! execute @kbd{C-c C-t} again, it will switch from each name directly to
! DONE. Use prefix arguments or completion to quickly select a specific
! name.
!
! @node Per file keywords, , TODO types, TODO extensions
! @subsection Setting up TODO keywords for individual files
! @cindex keyword options
! @cindex per file keywords
!
! It can be very useful to use different aspects of the TODO mechanism
! in different files, which is not possible with the global settings
! described above. For file-local settings, you need to add special
! lines to the file which set the keywords and interpretation for that
! file only. For example, to set one of the two examples discussed
! above, you need one of the following lines, starting in column zero
! anywhere in the file:
!
! @example
! #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
! #+TYP_TODO: Fred Sara Lucy Mike DONE
! @end example
!
! @cindex Completing option keywords
! @kindex address@hidden
! @noindent To make sure you are using the correct keyword, type
! @samp{#+} into the buffer and then use @address@hidden completion.
!
! @cindex DONE, final TODO keyword
! Remember that the last keyword must always mean that the item is DONE
! (you may use a different word, though). Also note that in each file,
! only one of the two aspects of TODO keywords can be used. After
! changing one of these lines, use @kbd{C-c C-c} with the cursor still
! in the line to make the changes known to address@hidden
! parses these lines only when Org-mode is activated after visiting a
! file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-}
! is simply restarting Org-mode, making sure that these changes will be
! respected.}.
!
! If you want to use very many keywords, for example when working with a
! large group of people, you may split the names over several lines:
!
! @example
! #+TYP_TODO: Fred Sara Lucy Mike
! #+TYP_TODO: Luis George Jules Jessica
! #+TYP_TODO: Kim Arnold Peter
! #+TYP_TODO: DONE
! @end example
!
! @node Priorities, , TODO extensions, TODO items
! @section Priorities
! @cindex priorities
!
! If you use Org-mode extensively to organize your work, you may end up
! with a number of TODO entries so large that you'd like to prioritize
! them. This can be done by placing a @emph{priority cookie} into the
! headline, like this
!
! @example
! *** TODO [#A] Write letter to Sam Fortune
! @end example
!
! @noindent
! With its standard setup, Org-mode supports priorities @samp{A},
! @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry
! without a cookie is treated as priority @samp{B}. Priorities make a
! difference only in the agenda (@pxref{Agenda}).
!
! @table @kbd
! @kindex @kbd{C-c ,}
! @item @kbd{C-c ,}
! Set the priority of the current item. The command prompts for a
! priority character @samp{A}, @samp{B} or @samp{C}. When you press
! @key{SPC} instead, the priority cookie is removed from the headline.
! The priorities can also be changed ``remotely'' from the timeline and
! agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
!
! @kindex address@hidden
! @kindex address@hidden
! @item address@hidden
! @itemx address@hidden
! Increase/decrease priority of current item. Note that these keys are
! also used to modify time stamps (@pxref{Creating timestamps}).
! @end table
!
!
!
! @node Timestamps, Timeline and Agenda, TODO items, Top
@chapter Timestamps
Items can be labeled with timestamps to make them useful for project
***************
*** 1415,1424 ****
@end example
@noindent
After changing this line, press @kbd{C-c C-c} with the cursor still in
! the line, to make the changes know to org-mode. Otherwise, the change
! will only be active the next time you visit this file with Emacs.
! The display in the agenda buffer looks best if the category is no
longer than 10 characters.
@subsection Sorting of agenda items
--- 1445,1455 ----
@end example
@noindent
After changing this line, press @kbd{C-c C-c} with the cursor still in
! the line, to make the changes known to org-mode. Otherwise, the
! change will only be active the next time you visit this file with
! Emacs.
! The display in the agenda buffer looks best if the category is not
longer than 10 characters.
@subsection Sorting of agenda items
***************
*** 2078,2087 ****
@cindex acknowledgments
Org-mode was written by Carsten Dominik, who still maintains it at the
! Org-mode homepage
! @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. The following
! people have helped the development along with ideas, suggestions and
! patches.
@itemize @bullet
@item
--- 2109,2117 ----
@cindex acknowledgments
Org-mode was written by Carsten Dominik, who still maintains it at the
! Org-mode homepage @uref{http://www.astro.uva.nl/~dominik/Tools/org/}.
! The following people have helped the development along with ideas,
! suggestions and patches.
@itemize @bullet
@item
***************
*** 2112,2117 ****
--- 2142,2150 ----
@item
Carsten Wimmer suggested some changes and helped fix a bug in linking
to GNUS.
+ @item
+ Stefan Monnier provided a patch with lots of little fixes to keep the
+ Emacs-Lisp compiler happy.
@end itemize
@node Bugs, , Acknowledgments, Miscellaneous
***************
*** 2154,2159 ****
--- 2187,2193 ----
@bye
+
@ignore
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
@end ignore