Mercurial > emacs
comparison man/org.texi @ 67344:22aa7225124f
(TODO basics): Document the global todo list.
(TODO items): Documents sparse tree for specific TODO
keywords.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Tue, 06 Dec 2005 10:53:03 +0000 |
parents | 7dc296b93149 |
children | 7d938f699a43 |
comparison
equal
deleted
inserted
replaced
67343:69e43e82cd0a | 67344:22aa7225124f |
---|---|
2 @c %**start of header | 2 @c %**start of header |
3 @c @setfilename org | 3 @c @setfilename org |
4 @setfilename ../info/org | 4 @setfilename ../info/org |
5 @settitle Org Mode Manual | 5 @settitle Org Mode Manual |
6 | 6 |
7 @set VERSION 3.21 | 7 @set VERSION 3.22 |
8 @set DATE December 2005 | 8 @set DATE December 2005 |
9 | 9 |
10 @dircategory Emacs | 10 @dircategory Emacs |
11 @direntry | 11 @direntry |
12 * Org Mode: (org). Outline-based notes management and organizer | 12 * Org Mode: (org). Outline-based notes management and organizer |
123 * Editing/debugging formulas:: Changing a stored formula | 123 * Editing/debugging formulas:: Changing a stored formula |
124 * Appetizer:: Taste the power of calc | 124 * Appetizer:: Taste the power of calc |
125 | 125 |
126 Hyperlinks | 126 Hyperlinks |
127 | 127 |
128 * Links:: URL-like links to the world | 128 * Internal Links:: CamelCaseWords as internal links |
129 * External Links:: URL-like links to the world | |
130 * Managing links:: Creating, inserting and following | |
131 * Search Options:: Linking to a specific location | |
129 * Remember:: Org-trees store quick notes | 132 * Remember:: Org-trees store quick notes |
130 | 133 |
131 TODO items | 134 TODO items |
132 | 135 |
133 * TODO basics:: Marking and displaying TODO entries | 136 * TODO basics:: Marking and displaying TODO entries |
245 @cindex global keybindings | 248 @cindex global keybindings |
246 @cindex keybindings, global | 249 @cindex keybindings, global |
247 | 250 |
248 If Org-mode is part of the Emacs distribution or an XEmacs package, | 251 If Org-mode is part of the Emacs distribution or an XEmacs package, |
249 you only need to copy the following lines to your @file{.emacs} file. | 252 you only need to copy the following lines to your @file{.emacs} file. |
250 The last two lines define @emph{global} keys for the commands | 253 The last three lines define @emph{global} keys for the commands |
251 @command{org-store-link} and @command{org-agenda} - please choose | 254 @command{org-store-link}, @command{org-agenda}, and |
252 suitable keys yourself. | 255 @code{org-todo-list} - please choose suitable keys yourself. |
253 | 256 |
254 @lisp | 257 @lisp |
255 ;; The following lines are always needed. Choose your own keys. | 258 ;; The following lines are always needed. Choose your own keys. |
256 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) | 259 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) |
257 (define-key global-map "\C-cl" 'org-store-link) | 260 (define-key global-map "\C-cl" 'org-store-link) |
258 (define-key global-map "\C-ca" 'org-agenda) | 261 (define-key global-map "\C-ca" 'org-agenda) |
262 (define-key global-map "\C-ct" 'org-todo-list) | |
259 @end lisp | 263 @end lisp |
260 | 264 |
261 If you have downloaded Org-mode from the Web, you must byte-compile | 265 If you have downloaded Org-mode from the Web, you must byte-compile |
262 @file{org.el} and put it on your load path. In addition to the Emacs | 266 @file{org.el} and put it on your load path. In addition to the Emacs |
263 Lisp lines above, you also need to add the following lines to | 267 Lisp lines above, you also need to add the following lines to |
266 @lisp | 270 @lisp |
267 ;; These lines only if org-mode is not part of the X/Emacs distribution. | 271 ;; These lines only if org-mode is not part of the X/Emacs distribution. |
268 (autoload 'org-mode "org" "Org mode" t) | 272 (autoload 'org-mode "org" "Org mode" t) |
269 (autoload 'org-diary "org" "Diary entries from Org mode") | 273 (autoload 'org-diary "org" "Diary entries from Org mode") |
270 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t) | 274 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t) |
275 (autoload 'org-todo-list "org" "Global TODO list from Org mode" t) | |
271 (autoload 'org-store-link "org" "Store a link to the current location" t) | 276 (autoload 'org-store-link "org" "Store a link to the current location" t) |
272 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t) | 277 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t) |
273 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode") | 278 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode") |
274 @end lisp | 279 @end lisp |
275 | 280 |
559 Occur. Prompts for a regexp and shows a sparse tree with all matches. | 564 Occur. Prompts for a regexp and shows a sparse tree with all matches. |
560 If the match is in a headline, the headline is made visible. If the | 565 If the match is in a headline, the headline is made visible. If the |
561 match is in the body of an entry, headline and body are made visible. | 566 match is in the body of an entry, headline and body are made visible. |
562 In order to provide minimal context, also the full hierarchy of | 567 In order to provide minimal context, also the full hierarchy of |
563 headlines above the match is shown, as well as the headline following | 568 headlines above the match is shown, as well as the headline following |
564 the match. | 569 the match. Each match is also highlighted, the highlights disappear |
570 when the buffer is changed with an editing command. | |
565 @end table | 571 @end table |
566 | 572 |
567 Other commands are using this feature as well. For example @kbd{C-c | 573 Other commands are using this feature as well. For example @kbd{C-c |
568 C-v} creates a sparse TODO tree (@pxref{TODO basics}). | 574 C-v} creates a sparse TODO tree (@pxref{TODO basics}). |
569 | 575 |
581 @node Plain Lists, , Sparse trees, Document Structure | 587 @node Plain Lists, , Sparse trees, Document Structure |
582 @section Plain Lists | 588 @section Plain Lists |
583 @cindex plain lists | 589 @cindex plain lists |
584 @cindex lists, plain | 590 @cindex lists, plain |
585 | 591 |
586 Headlines define the entire structure of the Org-mode file, and also | 592 Headlines define the structure of the Org-mode file, and also lists |
587 lists (for example TODO items (@pxref{TODO items}) should be created | 593 (for example TODO items (@pxref{TODO items}) should be created using |
588 using headline levels. However, when taking notes, the plain text is | 594 headline levels. However, when taking notes, the plain text is |
589 sometimes easier to read with hand-formatted lists. Org-mode supports | 595 sometimes easier to read with hand-formatted lists. Org-mode supports |
590 editing such lists, and the HTML exporter (@pxref{Exporting}) does | 596 editing such lists, and the HTML exporter (@pxref{Exporting}) does |
591 parse and format them. | 597 parse and format them. |
592 | 598 |
593 Org-mode knows ordered and unordered lists. Unordered list items | 599 Org-mode knows ordered and unordered lists. Unordered list items |
602 that is indented like the bullet/number, or less. For example: | 608 that is indented like the bullet/number, or less. For example: |
603 | 609 |
604 @example | 610 @example |
605 ** Lord of the Rings | 611 ** Lord of the Rings |
606 My favorite scenes are (in this order) | 612 My favorite scenes are (in this order) |
607 1. Eowyns fight with the witch-king | 613 1. Eowyns fight with the witch king |
608 + this was already my favorite scene in the book | 614 + this was already my favorite scene in the book |
609 + I really like Miranda Otto. | 615 + I really like Miranda Otto. |
610 2. The attack of the Rohirrim | 616 2. The attack of the Rohirrim |
611 3. Peter Jackson being shot by Legolas | 617 3. Peter Jackson being shot by Legolas |
612 - on DVD only | 618 - on DVD only |
613 He makes a really funny face when it happens. | 619 He makes a really funny face when it happens. |
614 @end example | 620 @end example |
615 | 621 |
616 Org-mode supports these lists by tuning filling and wrapping commands | 622 Org-mode supports these lists by tuning filling and wrapping commands |
617 to correctly deal with them. Futhermore, the following commands act | 623 to correctly deal with them. Futhermore, the following commands act |
618 on items when the cursor is in the first line of an item (the line | 624 on items when the cursor is in the first line of an item (the line |
619 with the bullet or number). | 625 with the bullet or number). |
620 | 626 |
621 @table @kbd | 627 @table @kbd |
628 @kindex @key{TAB} | |
629 @item @key{TAB} | |
630 Items can be folded just like headline levels if you set the variable | |
631 @code{org-cycle-include-plain-lists}. The level of an item is then | |
632 given by the indentation of the bullet/number. However, items are | |
633 always subortinate to real headlines, the hierarchies remain | |
634 completely separated. | |
622 @kindex M-S-@key{up} | 635 @kindex M-S-@key{up} |
623 @kindex M-S-@key{down} | 636 @kindex M-S-@key{down} |
624 @item M-S-@key{up} | 637 @item M-S-@key{up} |
625 @itemx M-S-@key{down} | 638 @itemx M-S-@key{down} |
626 Move the item including subitems up/down (swap with previous/next item | 639 Move the item including subitems up/down (swap with previous/next item |
769 @kindex C-c ^ | 782 @kindex C-c ^ |
770 @item C-c ^ | 783 @item C-c ^ |
771 Sort the table lines in the region. Point and mark must be in the first | 784 Sort the table lines in the region. Point and mark must be in the first |
772 and last line to be included, and must be in the column that should be | 785 and last line to be included, and must be in the column that should be |
773 used for sorting. The command prompts for numerical versus | 786 used for sorting. The command prompts for numerical versus |
774 alphnumerical sorting. | 787 alphanumerical sorting. |
775 | 788 |
776 @tsubheading{Regions} | 789 @tsubheading{Regions} |
777 @kindex C-c C-x M-w | 790 @kindex C-c C-x M-w |
778 @item C-c C-x M-w | 791 @item C-c C-x M-w |
779 Copy a rectangular region from a table to a special clipboard. Point | 792 Copy a rectangular region from a table to a special clipboard. Point |
1195 | 1208 |
1196 @node Hyperlinks, TODO items, Tables, Top | 1209 @node Hyperlinks, TODO items, Tables, Top |
1197 @chapter Hyperlinks | 1210 @chapter Hyperlinks |
1198 @cindex hyperlinks | 1211 @cindex hyperlinks |
1199 | 1212 |
1200 Just like HMTL, Org-mode provides links to other files, Usenet | 1213 Just like HMTL, Org-mode provides links inside a file, and external |
1201 articles, emails and much more. | 1214 links to other files, Usenet articles, emails and much more. |
1202 | 1215 |
1203 @menu | 1216 @menu |
1204 * Links:: URL-like links to the world | 1217 * Internal Links:: CamelCaseWords as internal links |
1218 * External Links:: URL-like links to the world | |
1219 * Managing links:: Creating, inserting and following | |
1220 * Search Options:: Linking to a specific location | |
1205 * Remember:: Org-trees store quick notes | 1221 * Remember:: Org-trees store quick notes |
1206 @end menu | 1222 @end menu |
1207 | 1223 |
1208 @node Links, Remember, Hyperlinks, Hyperlinks | 1224 @node Internal Links, External Links, Hyperlinks, Hyperlinks |
1209 @section Links | 1225 @section Internal Links |
1226 @cindex internal links | |
1227 @cindex links, internal | |
1228 @cindex CamelCase links | |
1229 | |
1230 Similar to Wiki implementations, Org-mode interprets words spelled in | |
1231 CamelCase (i.e. mixed case with at least one capital letter following | |
1232 on a small letter inside the word) as links. While in Wiki | |
1233 implementations these links usually point to another file, in Org-mode | |
1234 they point to a target in the current file. Targets are CamelCased | |
1235 words in double angular brackets, and may be located anywhere, also in | |
1236 a comment line. For example | |
1237 @example | |
1238 # <<MyTarget>> | |
1239 @end example | |
1240 | |
1241 Each occurence of @samp{MyTarget} in the file is an active link that | |
1242 can be followed with @kbd{C-c C-o} or with a mouse click | |
1243 (@pxref{Managing links}). If no dedicated target exists, org-mode will | |
1244 search for the words in the link separated by white space, in the | |
1245 above example for @samp{my target}. If the link starts with a star | |
1246 like @samp{*MyTarget}, the search is restricted to headlines. | |
1247 Org-mode will first try an exact match of a full headline, but then | |
1248 move on to more and more lenient searches. The link @samp{*MyTargets} | |
1249 will find any of the following | |
1250 @example | |
1251 ** My targets | |
1252 ** TODO my targets are bright | |
1253 ** my 20 targets are | |
1254 @end example | |
1255 @cindex completion, of CamelCase links | |
1256 @cindex CamelCase links, completion of | |
1257 It is therefore often not even necessary to set a dedicated target. | |
1258 The link will automatically find a target. If you want to see what | |
1259 lines in the current buffer are matched by a given CamelCase link, | |
1260 open the link with @kbd{C-u C-c C-o}. Even if there are several | |
1261 matches, org-mode will usually find the right one since it tries | |
1262 targets and exact matches first. To insert links targeting a | |
1263 headline, in-buffer completion can be used. Just type a star followed | |
1264 by a few optional letters into the buffer and press @kbd{M-@key{TAB}}. | |
1265 CamelCased versions of all headlines in the current buffer will be | |
1266 offered as completions. @xref{Managing links} for more commands | |
1267 creating links. | |
1268 | |
1269 @node External Links, Managing links, Internal Links, Hyperlinks | |
1270 @section External Links | |
1210 @cindex links | 1271 @cindex links |
1272 @cindex external links | |
1273 @cindex links, external | |
1211 @cindex GNUS links | 1274 @cindex GNUS links |
1212 @cindex BBDB links | 1275 @cindex BBDB links |
1213 @cindex URL links | 1276 @cindex URL links |
1214 @cindex file links | 1277 @cindex file links |
1215 @cindex VM links | 1278 @cindex VM links |
1225 | 1288 |
1226 @example | 1289 @example |
1227 <http://www.astro.uva.nl/~dominik> @r{on the web} | 1290 <http://www.astro.uva.nl/~dominik> @r{on the web} |
1228 <file:/home/dominik/images/jupiter.jpg> @r{file, absolute path} | 1291 <file:/home/dominik/images/jupiter.jpg> @r{file, absolute path} |
1229 <file:papers/last.pdf> @r{file, relative path} | 1292 <file:papers/last.pdf> @r{file, relative path} |
1230 <file:~/code/main.c:255> @r{file, with line number} | |
1231 <news:comp.emacs> @r{Usenet link} | 1293 <news:comp.emacs> @r{Usenet link} |
1232 <mailto:adent@@galaxy.net> @r{Mail link} | 1294 <mailto:adent@@galaxy.net> @r{Mail link} |
1233 <vm:folder> @r{VM folder link} | 1295 <vm:folder> @r{VM folder link} |
1234 <vm:folder#id> @r{VM message link} | 1296 <vm:folder#id> @r{VM message link} |
1235 <vm://myself@@some.where.org/folder#id> @r{VM on remote machine} | 1297 <vm://myself@@some.where.org/folder#id> @r{VM on remote machine} |
1247 the end of a line. In tables, the end of a table field also terminates | 1309 the end of a line. In tables, the end of a table field also terminates |
1248 a link. Angle brackets around a link are not required, but are | 1310 a link. Angle brackets around a link are not required, but are |
1249 recommended to avoid problems with punctuation and other text following | 1311 recommended to avoid problems with punctuation and other text following |
1250 the link. See also the variable @code{org-allow-space-in-links}. | 1312 the link. See also the variable @code{org-allow-space-in-links}. |
1251 | 1313 |
1252 @cindex storing links | 1314 |
1315 @node Managing links, Search Options, External Links, Hyperlinks | |
1316 @section Managing links | |
1317 | |
1318 Org-mode provides methods to create a link in the correct syntax, to | |
1319 insert it into an org-mode file, and to follow the link. | |
1320 | |
1253 @table @kbd | 1321 @table @kbd |
1254 @kindex C-c l | 1322 @kindex C-c l |
1323 @cindex storing links | |
1255 @item C-c l | 1324 @item C-c l |
1256 Store a link to the current location. This is a @emph{global} command | 1325 Store a link to the current location. This is a @emph{global} command |
1257 which can be used in any buffer to create a link. The link will be | 1326 which can be used in any buffer to create a link. The link will be |
1258 stored for later insertion into an Org-mode buffer (see below). For VM, | 1327 stored for later insertion into an Org-mode buffer (see below). For |
1259 RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to the | 1328 VM, RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to |
1260 current article/entry. For W3 and W3M buffer, the link goes to the | 1329 the current article/entry. For W3 and W3M buffer, the link goes to |
1261 current URL. For any other files, the link will just point to the file. | 1330 the current URL. For Org-mode files, the current headline is |
1262 The key binding @kbd{C-c l} is only a suggestion - see | 1331 targeted. For any other files, the link will point to the file, with |
1263 @ref{Installation and Activation}. | 1332 a CamelCase (@pxref{Search Options}) search string pointing to the |
1333 contents of the current line. If there is an active region, the | |
1334 selected words will form the basis of the search string. The key | |
1335 binding @kbd{C-c l} is only a suggestion - see @ref{Installation and | |
1336 Activation}. | |
1264 | 1337 |
1265 @kindex C-c C-l | 1338 @kindex C-c C-l |
1266 @cindex completion, of links | 1339 @cindex completion, of links |
1267 @cindex completion, of file names | 1340 @cindex completion, of file names |
1268 @item C-c C-l | 1341 @item C-c C-l |
1299 @kindex mouse-3 | 1372 @kindex mouse-3 |
1300 @item mouse-3 | 1373 @item mouse-3 |
1301 Like @kbd{mouse-2}, but force file links to be opened with Emacs. | 1374 Like @kbd{mouse-2}, but force file links to be opened with Emacs. |
1302 @end table | 1375 @end table |
1303 | 1376 |
1304 @node Remember, , Links, Hyperlinks | 1377 |
1378 @node Search Options, Remember, Managing links, Hyperlinks | |
1379 @section Search options in file links | |
1380 | |
1381 File links can contain additional information to make Emacs jump to a | |
1382 particular location in the file when following a link. This can be a | |
1383 line number or a search option after a double@footnote{For backward | |
1384 compatibility, line numbers can also follow a single colon.} colon. | |
1385 For example: | |
1386 @example | |
1387 <file:~/code/main.c::255> | |
1388 <file:~/xx.org::MyTarget> | |
1389 <file:~/xx.org::find me> | |
1390 <file:~/xx.org::/regexp/> | |
1391 @end example | |
1392 @noindent Here is what these options do. | |
1393 | |
1394 @table @code | |
1395 @item 255 | |
1396 Jump to line 255. | |
1397 @item MyGoal | |
1398 Search for a link target with name MyGoal, or do a text search for | |
1399 @samp{my target}, similar to the CamelCase search in internal links, | |
1400 see @ref{Internal Links}. | |
1401 @item find me | |
1402 Do a normal text search for the text @samp{find me}. | |
1403 @item /regexp/ | |
1404 Do a regular expression search for @code{regexp}. This uses the Emacs | |
1405 command @code{occur} to list all matches in a separate window. If the | |
1406 target file is in Org-mode, @code{org-occur} is used to create a | |
1407 sparse tree with the matches. | |
1408 @c If the target file is a directory, | |
1409 @c @code{grep} will be used to search all files in the directory. | |
1410 @end table | |
1411 | |
1412 To use the search options also for a search in the current file, a | |
1413 file link with an empty file name can be used. For example, | |
1414 @code{<file:::find me>} does a search for @samp{find me} in the | |
1415 current file. | |
1416 | |
1417 @node Remember, , Search Options, Hyperlinks | |
1305 @section Remember | 1418 @section Remember |
1306 @cindex @file{remember.el} | 1419 @cindex @file{remember.el} |
1307 | 1420 |
1308 Another way to create org entries with links to other files is through | 1421 Another way to create org entries with links to other files is through |
1309 the @emph{Remember} package by John Wiegley. @emph{Remember} lets you | 1422 the @emph{Remember} package by John Wiegley. @emph{Remember} lets you |
1312 information. The notes produced by @emph{Remember} can be stored in | 1425 information. The notes produced by @emph{Remember} can be stored in |
1313 different ways, and Org-mode files are a good target. Org-mode allows | 1426 different ways, and Org-mode files are a good target. Org-mode allows |
1314 to file away notes either to a default file, or directly to the | 1427 to file away notes either to a default file, or directly to the |
1315 correct location in your Org-mode outline tree. The following | 1428 correct location in your Org-mode outline tree. The following |
1316 customization@footnote{The two autoload forms are only necessary if | 1429 customization@footnote{The two autoload forms are only necessary if |
1317 @file{org.el} is not part of the Emacs distribution or and XEmacs | 1430 @file{org.el} is not part of the Emacs distribution or an XEmacs |
1318 package.} will tell @emph{Remember} to use org files as target, and to | 1431 package.} will tell @emph{Remember} to use org files as target, and to |
1319 create annotations compatible with Org-mode links. | 1432 create annotations compatible with Org-mode links. |
1320 | 1433 |
1321 @example | 1434 @example |
1322 (autoload 'org-remember-annotation "org") | 1435 (autoload 'org-remember-annotation "org") |
1408 @kindex C-c C-v | 1521 @kindex C-c C-v |
1409 @cindex sparse tree, for TODO | 1522 @cindex sparse tree, for TODO |
1410 @item C-c C-v | 1523 @item C-c C-v |
1411 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds | 1524 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
1412 the entire buffer, but shows all TODO items and the headings hierarchy | 1525 the entire buffer, but shows all TODO items and the headings hierarchy |
1413 above them. With prefix arg, show also the DONE entries. | 1526 above them. With prefix arg, show also the DONE entries. With |
1527 numerical prefix N, show the tree for the Nth keyword in the variable | |
1528 @code{org-todo-keywords}. | |
1529 @kindex C-c t | |
1530 @item C-c t | |
1531 Show the global TODO list. This collects the TODO items from all | |
1532 agenda files (@pxref{Agenda}) into a single buffer. The buffer is in | |
1533 @code{agenda-mode}, so there are commands to examine and manipulate | |
1534 the TODO entries directly from that buffer (@pxref{Agenda commands}). | |
1535 A prefix argument can be used to collect only TODO entries of a | |
1536 particular type. With a C-u prefix you are prompted for a keyword. | |
1537 With a numeric prefix, the Nth keyword in @code{org-todo-keywords} is | |
1538 selected. | |
1539 @kindex r | |
1540 The @kbd{r} key in the agenda | |
1541 buffer regenerates it, and you can give a prefix argument to this | |
1542 command to change the selected TODO keyword, for example @kbd{3 r}. | |
1543 The key binding @kbd{C-c t} is only a suggestion - see | |
1544 @ref{Installation and Activation}. | |
1545 @kindex C-u C-c a | |
1414 @item C-u C-c a | 1546 @item C-u C-c a |
1415 A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) | 1547 A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) |
1416 collects all unfinished TODO items into a single place. | 1548 includes all unfinished TODO items at the beginning of todays agenda. |
1417 @end table | 1549 @end table |
1418 | 1550 |
1419 @node TODO extensions, Priorities, TODO basics, TODO items | 1551 @node TODO extensions, Priorities, TODO basics, TODO items |
1420 @section Extended use of TODO keywords | 1552 @section Extended use of TODO keywords |
1421 @cindex extended TODO keywords | 1553 @cindex extended TODO keywords |
1461 @cindex names as TODO keywords | 1593 @cindex names as TODO keywords |
1462 @cindex types as TODO keywords | 1594 @cindex types as TODO keywords |
1463 | 1595 |
1464 The second possibility is to use TODO keywords to indicate different | 1596 The second possibility is to use TODO keywords to indicate different |
1465 types of action items. For example, you might want to indicate that | 1597 types of action items. For example, you might want to indicate that |
1466 items are for ``work'' or ``home''. Or, when you work with several | 1598 items are for ``work'' or ``home''. If you are into David Allen's |
1467 people on a single project, you might want to assign action items | 1599 @emph{Getting Things DONE}, you might want to use todo types |
1468 directly to persons, by using their names as TODO keywords. This | 1600 @samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. Or, when you work |
1469 would be set up like this: | 1601 with several people on a single project, you might want to assign |
1602 action items directly to persons, by using their names as TODO | |
1603 keywords. This would be set up like this: | |
1470 | 1604 |
1471 @lisp | 1605 @lisp |
1472 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") | 1606 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
1473 org-todo-interpretation 'type) | 1607 org-todo-interpretation 'type) |
1474 @end lisp | 1608 @end lisp |
1477 rather different types. So it is normally not useful to change from | 1611 rather different types. So it is normally not useful to change from |
1478 one type to another. Therefore, in this case the behavior of the | 1612 one type to another. Therefore, in this case the behavior of the |
1479 command @kbd{C-c C-t} is changed slightly@footnote{This is also true | 1613 command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
1480 for the @kbd{t} command in the timeline and agenda buffers.}. When | 1614 for the @kbd{t} command in the timeline and agenda buffers.}. When |
1481 used several times in succession, it will still cycle through all | 1615 used several times in succession, it will still cycle through all |
1482 names. But when you return to the item after some time and | 1616 names. But when you return to the item after some time and execute |
1483 execute @kbd{C-c C-t} again, it will switch from each name directly to | 1617 @kbd{C-c C-t} again, it will switch from each name directly to DONE. |
1484 DONE. Use prefix arguments or completion to quickly select a specific | 1618 Use prefix arguments or completion to quickly select a specific name. |
1485 name. | 1619 You can also review the items of a specific TODO type in a sparse tree |
1620 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all | |
1621 things Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect | |
1622 collect Lucy's items from all agenda files into a single buffer, you | |
1623 would use the prefix arg as well when creating the global todo list: | |
1624 @kbd{C-3 C-c t}. | |
1486 | 1625 |
1487 @node Per file keywords, , TODO types, TODO extensions | 1626 @node Per file keywords, , TODO types, TODO extensions |
1488 @subsection Setting up TODO keywords for individual files | 1627 @subsection Setting up TODO keywords for individual files |
1489 @cindex keyword options | 1628 @cindex keyword options |
1490 @cindex per file keywords | 1629 @cindex per file keywords |
1563 Increase/decrease priority of current item. Note that these keys are | 1702 Increase/decrease priority of current item. Note that these keys are |
1564 also used to modify time stamps (@pxref{Creating timestamps}). | 1703 also used to modify time stamps (@pxref{Creating timestamps}). |
1565 Furthermore, these keys are also used by CUA-mode | 1704 Furthermore, these keys are also used by CUA-mode |
1566 (@pxref{Interaction}). | 1705 (@pxref{Interaction}). |
1567 @end table | 1706 @end table |
1568 | |
1569 | |
1570 | 1707 |
1571 @node Timestamps, Timeline and Agenda, TODO items, Top | 1708 @node Timestamps, Timeline and Agenda, TODO items, Top |
1572 @chapter Timestamps | 1709 @chapter Timestamps |
1573 | 1710 |
1574 Items can be labeled with timestamps to make them useful for project | 1711 Items can be labeled with timestamps to make them useful for project |
1877 which is derived from the file name. The category can also be set | 2014 which is derived from the file name. The category can also be set |
1878 with a special line anywhere in the buffer, looking like this: | 2015 with a special line anywhere in the buffer, looking like this: |
1879 @example | 2016 @example |
1880 #+CATEGORY: Thesis | 2017 #+CATEGORY: Thesis |
1881 @end example | 2018 @end example |
1882 @noindent | 2019 If there are several such lines in a file, each specifies the category |
1883 After changing this line, press @kbd{C-c C-c} with the cursor still in | 2020 for the text below it. The display in the agenda buffer looks best if |
1884 the line, to make the changes known to org-mode. Otherwise, the | 2021 the category is not longer than 10 characters. |
1885 change will only be active the next time you visit this file with | |
1886 Emacs. | |
1887 | |
1888 The display in the agenda buffer looks best if the category is not | |
1889 longer than 10 characters. | |
1890 | 2022 |
1891 @subsection Time-of-Day Specifications | 2023 @subsection Time-of-Day Specifications |
1892 | 2024 |
1893 Org-mode checks each agenda item for a time-of-day specification. The | 2025 Org-mode checks each agenda item for a time-of-day specification. The |
1894 time can be part of the time stamp that triggered inclusion into the | 2026 time can be part of the time stamp that triggered inclusion into the |
2026 | 2158 |
2027 @kindex r | 2159 @kindex r |
2028 @item r | 2160 @item r |
2029 Recreate the agenda buffer, for example to reflect the changes | 2161 Recreate the agenda buffer, for example to reflect the changes |
2030 after modification of the time stamps of items with S-@key{left} and | 2162 after modification of the time stamps of items with S-@key{left} and |
2031 S-@key{right}. | 2163 S-@key{right}. When the buffer is the global todo list, a prefix |
2164 argument is interpreted to create a selective list for a specific TODO | |
2165 keyword. | |
2032 | 2166 |
2033 @kindex @key{right} | 2167 @kindex @key{right} |
2034 @item @key{right} | 2168 @item @key{right} |
2035 Display the following @code{org-agenda-ndays} days. For example, if | 2169 Display the following @code{org-agenda-ndays} days. For example, if |
2036 the display covers a week, switch to the following week. With prefix | 2170 the display covers a week, switch to the following week. With prefix |
2273 @example | 2407 @example |
2274 @kbd{C-1 C-c C-x a org-export-as-ascii} | 2408 @kbd{C-1 C-c C-x a org-export-as-ascii} |
2275 @end example | 2409 @end example |
2276 @noindent | 2410 @noindent |
2277 creates only top level headlines and does the rest as items. Lines | 2411 creates only top level headlines and does the rest as items. Lines |
2278 starting with @samp{#} and subtree starting with the word @samp{COMMENT} | 2412 starting with @samp{#} and subtrees starting with the word @samp{COMMENT} |
2279 will not be exported. | 2413 will not be exported. |
2280 | 2414 |
2281 @node HTML export, iCalendar export, ASCII export, Exporting | 2415 @node HTML export, iCalendar export, ASCII export, Exporting |
2282 @section HTML export | 2416 @section HTML export |
2283 @cindex HTML export | 2417 @cindex HTML export |
2489 Create a single large iCalendar file from all files in | 2623 Create a single large iCalendar file from all files in |
2490 @code{org-agenda-files} and write it to the file given by | 2624 @code{org-agenda-files} and write it to the file given by |
2491 @code{org-combined-agenda-icalendar-file}. | 2625 @code{org-combined-agenda-icalendar-file}. |
2492 @end table | 2626 @end table |
2493 | 2627 |
2494 How this calendar is best read and updated, depends on the on the | 2628 How this calendar is best read and updated, depends on the application |
2495 application you are using. For example, when using iCal under Apple | 2629 you are using. For example, when using iCal under Apple MacOS X, you |
2496 MacOS X, you could create a new calendar @samp{OrgMode} (the default | 2630 could create a new calendar @samp{OrgMode} (the default name for the |
2497 name for the calendar created by @kbd{C-c C-x c}, see the variables | 2631 calendar created by @kbd{C-c C-x c}, see the variables |
2498 @code{org-icalendar-combined-name} and | 2632 @code{org-icalendar-combined-name} and |
2499 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to | 2633 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to |
2500 overwrite the corresponding file | 2634 overwrite the corresponding file |
2501 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript | 2635 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript |
2502 to make iCal re-read the calendar files each time a new version of | 2636 to make iCal re-read the calendar files each time a new version of |
2528 @section Completion | 2662 @section Completion |
2529 @cindex completion, of @TeX{} symbols | 2663 @cindex completion, of @TeX{} symbols |
2530 @cindex completion, of TODO keywords | 2664 @cindex completion, of TODO keywords |
2531 @cindex completion, of dictionary words | 2665 @cindex completion, of dictionary words |
2532 @cindex completion, of option keywords | 2666 @cindex completion, of option keywords |
2667 @cindex completion, of CamelCase links | |
2533 | 2668 |
2534 Org-mode supports in-buffer completion. This type of completion does | 2669 Org-mode supports in-buffer completion. This type of completion does |
2535 not make use of the minibuffer. You simply type a few letters into | 2670 not make use of the minibuffer. You simply type a few letters into |
2536 the buffer and use the key to complete text right there. | 2671 the buffer and use the key to complete text right there. |
2537 | 2672 |
2542 @itemize @bullet | 2677 @itemize @bullet |
2543 @item | 2678 @item |
2544 At the beginning of a headline, complete TODO keywords. | 2679 At the beginning of a headline, complete TODO keywords. |
2545 @item | 2680 @item |
2546 After @samp{\}, complete @TeX{} symbols supported by the exporter. | 2681 After @samp{\}, complete @TeX{} symbols supported by the exporter. |
2682 @item | |
2683 After @samp{*}, complete CamelCase versions of all headlines in the | |
2684 buffer. | |
2547 @item | 2685 @item |
2548 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | 2686 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or |
2549 @samp{OPTIONS} which set file-specific options for Org-mode. When the | 2687 @samp{OPTIONS} which set file-specific options for Org-mode. When the |
2550 option keyword is already complete, pressing @kbd{M-@key{TAB}} again | 2688 option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
2551 will insert example settings for this keyword. | 2689 will insert example settings for this keyword. |
2855 Kai Grossjohann pointed out that a number of key bindings in Org-mode | 2993 Kai Grossjohann pointed out that a number of key bindings in Org-mode |
2856 conflict with other packages. | 2994 conflict with other packages. |
2857 @item | 2995 @item |
2858 Roland Winkler pointed out that additional keybindings are needed to | 2996 Roland Winkler pointed out that additional keybindings are needed to |
2859 use Org-mode on a tty. | 2997 use Org-mode on a tty. |
2998 @item | |
2999 Tim O'Callaghan suggested in-file links, and search options for | |
3000 general file links. | |
3001 @c @item | |
3002 @c Nic Ferrier and Christian Egli implemented XML export. | |
2860 @end itemize | 3003 @end itemize |
2861 | 3004 |
2862 @node Index, Key Index, Miscellaneous, Top | 3005 @node Index, Key Index, Miscellaneous, Top |
2863 @chapter Index | 3006 @chapter Index |
2864 | 3007 |