mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-09-29 18:36:26 +00:00
Release 4.45
This commit is contained in:
parent
93a4128a6f
commit
6a9c670d81
531
org
531
org
|
@ -5,7 +5,7 @@ START-INFO-DIR-ENTRY
|
|||
* Org Mode: (org). outline-based notes management and organizer
|
||||
END-INFO-DIR-ENTRY
|
||||
|
||||
This manual is for Org-mode (version 4.44).
|
||||
This manual is for Org-mode (version 4.45).
|
||||
|
||||
Copyright (C) 2004, 2005, 2006 Free Software Foundation
|
||||
|
||||
|
@ -27,7 +27,7 @@ File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
|
|||
Org Mode Manual
|
||||
***************
|
||||
|
||||
This manual is for Org-mode (version 4.44).
|
||||
This manual is for Org-mode (version 4.45).
|
||||
|
||||
Copyright (C) 2004, 2005, 2006 Free Software Foundation
|
||||
|
||||
|
@ -80,8 +80,7 @@ Document Structure
|
|||
* Structure editing:: Changing sequence and level of headlines
|
||||
* Archiving:: Move done task trees to a different place
|
||||
* Sparse trees:: Matches embedded in context
|
||||
* Plain lists:: Editing hand-formatted lists
|
||||
* Checkboxes:: Easily checking off things.
|
||||
* Plain lists:: Additional structure within an entry
|
||||
|
||||
Archiving
|
||||
|
||||
|
@ -126,6 +125,8 @@ TODO items
|
|||
* TODO basics:: Marking and displaying TODO entries
|
||||
* TODO extensions:: Workflow and assignments
|
||||
* Priorities:: Some things are more important than others
|
||||
* Breaking down tasks:: Splitting a task into managable pieces
|
||||
* Checkboxes:: Tick-off lists
|
||||
|
||||
Extended use of TODO keywords
|
||||
|
||||
|
@ -403,8 +404,7 @@ edit the structure of the document.
|
|||
* Structure editing:: Changing sequence and level of headlines
|
||||
* Archiving:: Move done task trees to a different place
|
||||
* Sparse trees:: Matches embedded in context
|
||||
* Plain lists:: Editing hand-formatted lists
|
||||
* Checkboxes:: Easily checking off things.
|
||||
* Plain lists:: Additional structure within an entry
|
||||
|
||||
|
||||
File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
|
||||
|
@ -607,9 +607,10 @@ File: org, Node: ARCHIVE tag, Next: Moving subtrees, Prev: Archiving, Up: Ar
|
|||
A headline that is marked with the ARCHIVE tag (*note Tags::) stays at
|
||||
its location in the outline tree, but behaves in the following way:
|
||||
- It does not open when you attempt to do so with a visibility
|
||||
cycling command (*note Visibility cycling::). You can still open
|
||||
it with a normal outline command like `show-all'. Or you can
|
||||
modify the option `org-cycle-open-archived-trees'.
|
||||
cycling command (*note Visibility cycling::). You can force
|
||||
cycling archived subtrees with `C-<TAB>', or by setting the option
|
||||
`org-cycle-open-archived-trees'. Also normal outline commands like
|
||||
`show-all' will open archived subtrees.
|
||||
|
||||
- During sparse tree construction (*note Sparse trees::), matches in
|
||||
archived subtrees are not exposed, unless you configure the option
|
||||
|
@ -623,7 +624,7 @@ its location in the outline tree, but behaves in the following way:
|
|||
headline is. Configure the details using the variable
|
||||
`org-export-with-archived-trees'.
|
||||
|
||||
The following commands allow to set or clear the ARCHIVE tag:
|
||||
The following commands help managing the ARCHIVE tag:
|
||||
|
||||
`C-c C-x C-a'
|
||||
Toggle the ARCHIVE tag for the current headline. When the tag is
|
||||
|
@ -637,6 +638,9 @@ its location in the outline tree, but behaves in the following way:
|
|||
tag for the child. If the cursor is _not_ on a headline when this
|
||||
command is invoked, the level 1 trees will be checked.
|
||||
|
||||
`C-TAB'
|
||||
Cycle a tree even if it is tagged with ARCHIVE.
|
||||
|
||||
|
||||
File: org, Node: Moving subtrees, Prev: ARCHIVE tag, Up: Archiving
|
||||
|
||||
|
@ -716,17 +720,15 @@ only the visible part of the document and print the resulting file.
|
|||
display for outlining, not text properties.
|
||||
|
||||
|
||||
File: org, Node: Plain lists, Next: Checkboxes, Prev: Sparse trees, Up: Document structure
|
||||
File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
|
||||
|
||||
2.8 Plain lists
|
||||
===============
|
||||
|
||||
Headlines define both the structure of the Org-mode file, and also lists
|
||||
(for example, TODO items (*note TODO items::) should be created using
|
||||
headline levels). When taking notes, however, the plain text is
|
||||
sometimes easier to read with hand-formatted lists. Org-mode supports
|
||||
editing such lists, and the HTML exporter (*note Exporting::) does
|
||||
parse and format them.
|
||||
Within an entry of the outline tree, hand-formatted lists can provide
|
||||
additional structure. They also provide a way to create lists of
|
||||
checkboxes (*note Checkboxes::). Org-mode supports editing such lists,
|
||||
and the HTML exporter (*note Exporting::) does parse and format them.
|
||||
|
||||
Org-mode knows ordered and unordered lists. Unordered list items
|
||||
start with `-', `+', or `*'(1) as bullets. Ordered list items start
|
||||
|
@ -739,10 +741,10 @@ is indented like the bullet/number, or less. For example:
|
|||
|
||||
** Lord of the Rings
|
||||
My favorite scenes are (in this order)
|
||||
1. Eowyns fight with the witch king
|
||||
1. The attack of the Rohirrim
|
||||
2. Eowyns fight with the witch king
|
||||
+ this was already my favorite scene in the book
|
||||
+ I really like Miranda Otto.
|
||||
2. The attack of the Rohirrim
|
||||
3. Peter Jackson being shot by Legolas
|
||||
- on DVD only
|
||||
He makes a really funny face when it happens.
|
||||
|
@ -812,48 +814,6 @@ XEmacs, you should use Kyle E. Jones' `filladapt.el'. To turn is on,
|
|||
put into `.emacs':
|
||||
(require 'filladapt)
|
||||
|
||||
|
||||
File: org, Node: Checkboxes, Prev: Plain lists, Up: Document structure
|
||||
|
||||
2.9 Checkboxes
|
||||
==============
|
||||
|
||||
Every item in a plain list (ordered and unordered) can be made a
|
||||
checkbox by starting it with the string `[ ]'. This feature is similar
|
||||
to TODO items (*note TODO items::), but more lightweight. Checkboxes
|
||||
are not included into the global TODO list, so they are often great to
|
||||
split a task into a number of simple steps. Or you can use them in a
|
||||
shopping list to select the items you need to buy. To toggle a
|
||||
checkbox, use `C-c C-c', or try Piotr Zielinski's `org-mouse.el'. Here
|
||||
is an example of a checkbox list.
|
||||
|
||||
* Avoid stupid mistakes when distributing a new version
|
||||
- [ ] update also Emacs CVS
|
||||
- [X] forget to update index.html on the website
|
||||
- [X] leaving a `(debug)' form in the code
|
||||
|
||||
The following commands work with checkboxes:
|
||||
|
||||
`C-c C-c'
|
||||
Toggle checkbox at point.
|
||||
|
||||
`C-c C-x C-b'
|
||||
Toggle checkbox at point.
|
||||
- If there is an active region, toggle the first checkbox in
|
||||
the region and set all remaining boxes to the same status as
|
||||
the first. If you want to toggle all boxes in the region
|
||||
independently, use a prefix argument.
|
||||
|
||||
- If the cursor is in a headline, toggle checkboxes in the
|
||||
region between this headline and the next. This does _not_
|
||||
act on the entire subtree, just the current entry.
|
||||
|
||||
- If no active region, just toggle the checkbox at point.
|
||||
|
||||
`M-S-<RET>'
|
||||
Insert a new item with a checkbox. This works only if the cursor
|
||||
is already in a plain list item (*note Plain lists::).
|
||||
|
||||
|
||||
File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
|
||||
|
||||
|
@ -1898,6 +1858,8 @@ overview over all things you have to do.
|
|||
* TODO basics:: Marking and displaying TODO entries
|
||||
* TODO extensions:: Workflow and assignments
|
||||
* Priorities:: Some things are more important than others
|
||||
* Breaking down tasks:: Splitting a task into managable pieces
|
||||
* Checkboxes:: Tick-off lists
|
||||
|
||||
|
||||
File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
|
||||
|
@ -2057,11 +2019,10 @@ a large group of people, you may split the names over several lines:
|
|||
|
||||
(1) Org-mode parses these lines only when Org-mode is activated
|
||||
after visiting a file. `C-c C-c' with the cursor in a line starting
|
||||
with `#+' is simply restarting Org-mode, making sure that these changes
|
||||
will be respected.
|
||||
with `#+' is simply restarting Org-mode for the current buffer.
|
||||
|
||||
|
||||
File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
|
||||
File: org, Node: Priorities, Next: Breaking down tasks, Prev: TODO extensions, Up: TODO items
|
||||
|
||||
5.3 Priorities
|
||||
==============
|
||||
|
@ -2092,6 +2053,90 @@ agenda (*note Weekly/Daily agenda::).
|
|||
timestamps::). Furthermore, these keys are also used by CUA-mode
|
||||
(*note Conflicts::).
|
||||
|
||||
|
||||
File: org, Node: Breaking down tasks, Next: Checkboxes, Prev: Priorities, Up: TODO items
|
||||
|
||||
5.4 Breaking tasks down into subtasks
|
||||
=====================================
|
||||
|
||||
It is often advisable to break down large tasks into smaller, managable
|
||||
subtasks. You can do this by creating an outline tree below a TODO
|
||||
item, with detailed subtasks on the tree(1). Another possibility is
|
||||
the use of checkboxes to ideantify (a hierarchy of) a large number of
|
||||
subtasks (*note Checkboxes::).
|
||||
|
||||
---------- Footnotes ----------
|
||||
|
||||
(1) To keep subtasks out of the global TODO list, see the
|
||||
`org-agenda-todo-list-sublevels'.
|
||||
|
||||
|
||||
File: org, Node: Checkboxes, Prev: Breaking down tasks, Up: TODO items
|
||||
|
||||
5.5 Checkboxes
|
||||
==============
|
||||
|
||||
Every item in a plain list (*note Plain lists::) can be made a checkbox
|
||||
by starting it with the string `[ ]'. This feature is similar to TODO
|
||||
items (*note TODO items::), but more lightweight. Checkboxes are not
|
||||
included into the global TODO list, so they are often great to split a
|
||||
task into a number of simple steps. Or you can use them in a shopping
|
||||
list to select the items you need to buy. To toggle a checkbox, use
|
||||
`C-c C-c', or try Piotr Zielinski's `org-mouse.el'. Here is an example
|
||||
of a checkbox list.
|
||||
|
||||
* TODO Organize party [3/6]
|
||||
- call people [1/3]
|
||||
- [ ] Peter
|
||||
- [X] Sarah
|
||||
- [ ] Sam
|
||||
- [X] order food
|
||||
- [ ] think about what music to play
|
||||
- [X] talk to the neighbors
|
||||
|
||||
The `[3/6]' and `[1/3]' in the first and second line are cookies
|
||||
indicating how many checkboxes are present in this entry, and how many
|
||||
of them have been checked off. This can give you an idea on how many
|
||||
checkboxes remain, even without opening a folded entry. The cookies
|
||||
can be placed into a headline or into (the first line of) a plain list
|
||||
item. Each cookie covers all checkboxes structurally below that
|
||||
headline/item. You have to insert the cookie yourself by typing either
|
||||
`[/]' or `[%]'. In the first case you get an `n out of m' result, in
|
||||
the second case you get information about the percentage of checkboxes
|
||||
checked (in the above example, this would be `[50%]' and `[33%],
|
||||
respectively'.
|
||||
|
||||
The following commands work with checkboxes:
|
||||
|
||||
`C-c C-c'
|
||||
Toggle checkbox at point.
|
||||
|
||||
`C-c C-x C-b'
|
||||
Toggle checkbox at point.
|
||||
- If there is an active region, toggle the first checkbox in
|
||||
the region and set all remaining boxes to the same status as
|
||||
the first. If you want to toggle all boxes in the region
|
||||
independently, use a prefix argument.
|
||||
|
||||
- If the cursor is in a headline, toggle checkboxes in the
|
||||
region between this headline and the next. This does _not_
|
||||
act on the entire subtree, just the current entry.
|
||||
|
||||
- If no active region, just toggle the checkbox at point.
|
||||
|
||||
`M-S-<RET>'
|
||||
Insert a new item with a checkbox. This works only if the cursor
|
||||
is already in a plain list item (*note Plain lists::).
|
||||
|
||||
`C-c #'
|
||||
Update the checkbox statistics in the current outline entry. When
|
||||
called with a `C-u' prefix, update the entire file. Checkbox
|
||||
statistic cookies are updated automatically if you toggle
|
||||
checkboxes with `C-c C-c' and make new ones with `M-S-<RET>'. If
|
||||
you delete boxes or add/change them by hand, use this command to
|
||||
get things back into synch. Or simply toggle any checkbox twice
|
||||
with `C-c C-c'.
|
||||
|
||||
|
||||
File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
|
||||
|
||||
|
@ -3650,7 +3695,7 @@ tool.
|
|||
|
||||
---------- Footnotes ----------
|
||||
|
||||
(1) `org-publish.el' is not yet part of emacs, so if you are using
|
||||
(1) `org-publish.el' is not yet part of Emacs, so if you are using
|
||||
`org.el' as it comes with Emacs, you need to download this file
|
||||
separately. Also make sure org.el is at least version 4.27.
|
||||
|
||||
|
@ -3945,7 +3990,7 @@ following functions:
|
|||
it.
|
||||
|
||||
`C-c C-e p'
|
||||
Publish the project containin the current file.
|
||||
Publish the project containing the current file.
|
||||
|
||||
`C-c C-e f'
|
||||
Publish only the current file.
|
||||
|
@ -4113,9 +4158,9 @@ means in different contexts.
|
|||
- If the cursor is inside a table created by the `table.el' package,
|
||||
activate that table.
|
||||
|
||||
- If the current buffer is a remember buffer, close note and file it.
|
||||
with a prefix argument, file it without further interaction to the
|
||||
default location.
|
||||
- If the current buffer is a remember buffer, close the note and
|
||||
file it. With a prefix argument, file it, without further
|
||||
interaction, to the default location.
|
||||
|
||||
- If the cursor is on a `<<<target>>>', update radio targets and
|
||||
corresponding links in this buffer.
|
||||
|
@ -4489,18 +4534,17 @@ File: org, Node: History and Acknowledgments, Next: Index, Prev: Extensions a
|
|||
Appendix B History and Acknowledgments
|
||||
**************************************
|
||||
|
||||
The beginnings of Org-mode go back to 2003. It was borne out of
|
||||
frustration over the user interface of the emacs outline-mode. All I
|
||||
wanted was to make working with an outline tree possible without having
|
||||
to remember more than 10 commands just for hiding and unhiding parts of
|
||||
the outline tree, and to allow to restructure a tree easily. Visibility
|
||||
cycling and structure editing were originally implemented in the package
|
||||
`outline-magic.el', but quickly moved to the more general `org.el'.
|
||||
TODO entries, basic time stamps, and table support were added next, and
|
||||
highlight the two main goals that Org-mode still has today: To create
|
||||
a new, outline-based, plain text mode with innovative and intuitive
|
||||
editing features, and to incorporate project planning functionality
|
||||
directly into a notes file.
|
||||
Org-mode was borne in 2003, out of frustration over the user interface
|
||||
of the Emacs outline-mode. All I wanted was to make working with an
|
||||
outline tree possible without having to remember more than 10 commands
|
||||
just for hiding and unhiding parts of the outline tree, and to allow to
|
||||
restructure a tree easily. Visibility cycling and structure editing
|
||||
were originally implemented in the package `outline-magic.el', but
|
||||
quickly moved to the more general `org.el'. TODO entries, basic time
|
||||
stamps, and table support were added next, and highlight the two main
|
||||
goals that Org-mode still has today: To create a new, outline-based,
|
||||
plain text mode with innovative and intuitive editing features, and to
|
||||
incorporate project planning functionality directly into a notes file.
|
||||
|
||||
Since the first release, hundreds of emails to me or on
|
||||
`emacs-orgmode@gnu.org' have provided a constant stream of bug reports,
|
||||
|
@ -4527,6 +4571,8 @@ if I have forgotten someone, please accept my apologies and let me know.
|
|||
|
||||
* Sacha Chua suggested to copy some linking code from Planner.
|
||||
|
||||
* Eddward DeVilla proposed Checkbox statistics.
|
||||
|
||||
* Kees Dullemond inspired the use of narrowed tabled columns.
|
||||
|
||||
* Christian Egli converted the documentation into TeXInfo format,
|
||||
|
@ -4537,10 +4583,10 @@ if I have forgotten someone, please accept my apologies and let me know.
|
|||
|
||||
* Niels Giessen had the idea to automatically archive DONE trees.
|
||||
|
||||
* Bastien Guerry provoded extensive feedback.
|
||||
* Bastien Guerry provided extensive feedback.
|
||||
|
||||
* Kai Grossjohann pointed out key-binding conflicts caused by
|
||||
Org-mode.
|
||||
* Kai Grossjohann pointed out key-binding conflicts with other
|
||||
packages.
|
||||
|
||||
* Leon Liu asked for embedded LaTeX and tested it.
|
||||
|
||||
|
@ -4658,6 +4704,7 @@ Index
|
|||
* CamelCase links, completion of: CamelCase links. (line 6)
|
||||
* category: Categories. (line 6)
|
||||
* cdlatex.el: Cooperation. (line 29)
|
||||
* checkbox statistics: Checkboxes. (line 24)
|
||||
* checkboxes: Checkboxes. (line 6)
|
||||
* children, subtree visibility state: Visibility cycling. (line 10)
|
||||
* clean outline view: Clean view. (line 6)
|
||||
|
@ -4867,6 +4914,7 @@ Index
|
|||
* sparse trees: Sparse trees. (line 6)
|
||||
* special keywords: In-buffer settings. (line 6)
|
||||
* spreadsheet capabilities: Table calculations. (line 6)
|
||||
* statistics, for checkboxes: Checkboxes. (line 24)
|
||||
* storing links: Handling links. (line 9)
|
||||
* structure editing: Structure editing. (line 6)
|
||||
* structure of document: Document structure. (line 6)
|
||||
|
@ -4891,6 +4939,7 @@ Index
|
|||
* tags: Tags. (line 6)
|
||||
* tags view: Matching headline tags.
|
||||
(line 6)
|
||||
* tasks, breaking down: Breaking down tasks. (line 6)
|
||||
* templates, for remember: Remember. (line 23)
|
||||
* TeX interpretation: Embedded LaTeX. (line 6)
|
||||
* TeX macros: Export options. (line 25)
|
||||
|
@ -4937,8 +4986,8 @@ Index
|
|||
|
||||
File: org, Node: Key Index, Prev: Index, Up: Top
|
||||
|
||||
3 Key Index
|
||||
***********
|
||||
Key Index
|
||||
*********
|
||||
|
||||
|