diff options
| author | Carsten Dominik | 2005-03-30 12:42:09 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2005-03-30 12:42:09 +0000 |
| commit | 525f4f90f4bc5ecb480722d6ecfaaffd76400187 (patch) | |
| tree | b9d134fec645c61d58b34d57e86b2950a8fbba21 | |
| parent | ef943dbafe50f9e3ade231d5da47311aead345cc (diff) | |
| download | emacs-525f4f90f4bc5ecb480722d6ecfaaffd76400187.tar.gz emacs-525f4f90f4bc5ecb480722d6ecfaaffd76400187.zip | |
updated to org-mode version 3.05
| -rw-r--r-- | man/org.texi | 107 |
1 files changed, 83 insertions, 24 deletions
diff --git a/man/org.texi b/man/org.texi index d461e9c1020..d1a388f958a 100644 --- a/man/org.texi +++ b/man/org.texi | |||
| @@ -3,8 +3,8 @@ | |||
| 3 | @setfilename ../info/org | 3 | @setfilename ../info/org |
| 4 | @settitle Org Mode Manual | 4 | @settitle Org Mode Manual |
| 5 | 5 | ||
| 6 | @set VERSION 3.04 | 6 | @set VERSION 3.05 |
| 7 | @set DATE December 2004 | 7 | @set DATE April 2005 |
| 8 | 8 | ||
| 9 | @dircategory Emacs | 9 | @dircategory Emacs |
| 10 | @direntry | 10 | @direntry |
| @@ -34,7 +34,7 @@ | |||
| 34 | @copying | 34 | @copying |
| 35 | This manual is for Org-mode (version @value{VERSION}). | 35 | This manual is for Org-mode (version @value{VERSION}). |
| 36 | 36 | ||
| 37 | Copyright @copyright{} 2004 Free Software Foundation | 37 | Copyright @copyright{} 2004, 2005 Free Software Foundation |
| 38 | 38 | ||
| 39 | @quotation | 39 | @quotation |
| 40 | Permission is granted to copy, distribute and/or modify this document | 40 | Permission is granted to copy, distribute and/or modify this document |
| @@ -184,7 +184,8 @@ top of outline-mode, which makes it possible to keep the content of | |||
| 184 | large files well structured. Visibility cycling and structure editing | 184 | large files well structured. Visibility cycling and structure editing |
| 185 | help to work with the tree. Tables are easily created with a built-in | 185 | help to work with the tree. Tables are easily created with a built-in |
| 186 | table editor. Org-mode supports ToDo items, deadlines, time stamps, | 186 | table editor. Org-mode supports ToDo items, deadlines, time stamps, |
| 187 | and scheduling. It dynamically compiles entries into an agenda. | 187 | and scheduling. It dynamically compiles entries into an agenda that |
| 188 | utilizes and smoothly integrates much of the Emacs calendar and diary. | ||
| 188 | Plain text URL-like links connect to websites, emails, usenet | 189 | Plain text URL-like links connect to websites, emails, usenet |
| 189 | messages, BBDB entries, and any files related to the projects. For | 190 | messages, BBDB entries, and any files related to the projects. For |
| 190 | printing and sharing of notes, an Org-mode file can be exported as a | 191 | printing and sharing of notes, an Org-mode file can be exported as a |
| @@ -203,15 +204,14 @@ different levels and in different ways, for example | |||
| 203 | @r{@bullet{} as a full agenda and planner with deadlines and work scheduling} | 204 | @r{@bullet{} as a full agenda and planner with deadlines and work scheduling} |
| 204 | @end example | 205 | @end example |
| 205 | 206 | ||
| 206 | The Org-mode table editor can be used integrated into any major mode | 207 | The Org-mode table editor can be integrated into any major mode by |
| 207 | by activating the minor Ortbl-mode. | 208 | activating the minor Orgtbl-mode. |
| 208 | 209 | ||
| 209 | There is a website for Org-mode which provides links to the newest | 210 | There is a website for Org-mode which provides links to the newest |
| 210 | version of Org-mode, as well as additional information, screen shots | 211 | version of Org-mode, as well as additional information, screen shots |
| 211 | and example files. This page is located at | 212 | and example files. This page is located at |
| 212 | @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. | 213 | @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
| 213 | 214 | ||
| 214 | |||
| 215 | @page | 215 | @page |
| 216 | 216 | ||
| 217 | @node Installation, , Summary, Introduction | 217 | @node Installation, , Summary, Introduction |
| @@ -352,6 +352,18 @@ Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field. | |||
| 352 | Show all. | 352 | Show all. |
| 353 | @end table | 353 | @end table |
| 354 | 354 | ||
| 355 | When Emacs firsts visits a Org-mode file, the global state is set to | ||
| 356 | OVERVIEW, i.e. only the top level headlines are visible. This can be | ||
| 357 | configured through the variable @code{org-startup-folded}, or on a | ||
| 358 | per-file basis by adding one of the following lines anywhere in the | ||
| 359 | buffer: | ||
| 360 | |||
| 361 | @example | ||
| 362 | #+STARTUP: fold | ||
| 363 | #+STARTUP: nofold | ||
| 364 | @end example | ||
| 365 | |||
| 366 | |||
| 355 | @node Motion, Structure editing, Visibility cycling, Document Structure | 367 | @node Motion, Structure editing, Visibility cycling, Document Structure |
| 356 | @section Motion | 368 | @section Motion |
| 357 | @cindex motion, between headlines | 369 | @cindex motion, between headlines |
| @@ -473,6 +485,17 @@ the match. | |||
| 473 | Other commands are using this feature as well. For example @kbd{C-c | 485 | Other commands are using this feature as well. For example @kbd{C-c |
| 474 | C-v} creates a sparse TODO tree (@pxref{TODO basics}). | 486 | C-v} creates a sparse TODO tree (@pxref{TODO basics}). |
| 475 | 487 | ||
| 488 | @kindex C-c C-x v | ||
| 489 | @cindex printing sparse trees | ||
| 490 | @cindex visible text, printing | ||
| 491 | To print a sparse tree, you can use the Emacs command | ||
| 492 | @code{ps-print-buffer-with-faces} which does not print invisible parts | ||
| 493 | of the document @footnote{this does not work under XEmacs, because | ||
| 494 | XEmacs uses selective display for outlining, not text properties}. | ||
| 495 | Or you can use the command @kbd{C-c C-x v} to copy the visible part of | ||
| 496 | the document to another file (extension @file{.txt}) which then can be | ||
| 497 | printed in any desired way. | ||
| 498 | |||
| 476 | @node TODO items, Tables, Document Structure, Top | 499 | @node TODO items, Tables, Document Structure, Top |
| 477 | @chapter TODO items | 500 | @chapter TODO items |
| 478 | @cindex TODO items | 501 | @cindex TODO items |
| @@ -611,7 +634,7 @@ persons. | |||
| 611 | @end lisp | 634 | @end lisp |
| 612 | 635 | ||
| 613 | In this case, different keywords do not indicate a sequence, but | 636 | In this case, different keywords do not indicate a sequence, but |
| 614 | rather different levels. This changes the behavior of the command | 637 | rather different types. This changes the behavior of the command |
| 615 | @kbd{C-c C-t} slightly. When used several times in succession, it | 638 | @kbd{C-c C-t} slightly. When used several times in succession, it |
| 616 | will still cycle through all names. But when when you return to the | 639 | will still cycle through all names. But when when you return to the |
| 617 | item after some time and execute @kbd{C-c C-t} again, it will switch | 640 | item after some time and execute @kbd{C-c C-t} again, it will switch |
| @@ -745,11 +768,6 @@ Re-align the table and move down to next row. Creates a new row if | |||
| 745 | necessary. At the beginning or end of a line, @key{RET} still does | 768 | necessary. At the beginning or end of a line, @key{RET} still does |
| 746 | NEWLINE, so it can be used to split a table. | 769 | NEWLINE, so it can be used to split a table. |
| 747 | 770 | ||
| 748 | @kindex S-@key{RET} | ||
| 749 | @item S-@key{RET} | ||
| 750 | Copy from first non-empty | ||
| 751 | field above current field. | ||
| 752 | |||
| 753 | @tsubheading{Column and row editing} | 771 | @tsubheading{Column and row editing} |
| 754 | @kindex M-@key{left} | 772 | @kindex M-@key{left} |
| 755 | @kindex M-@key{right} | 773 | @kindex M-@key{right} |
| @@ -796,7 +814,7 @@ Copy an rectangular region from a table to a special clipboard, and | |||
| 796 | blank all fields in the rectangle. | 814 | blank all fields in the rectangle. |
| 797 | @kindex C-c C-h C-y | 815 | @kindex C-c C-h C-y |
| 798 | @item C-c C-h C-y | 816 | @item C-c C-h C-y |
| 799 | Paste a rectangluar region into a table. | 817 | Paste a rectangular region into a table. |
| 800 | The upper right corner ends up in the current field. All involved fields | 818 | The upper right corner ends up in the current field. All involved fields |
| 801 | will be overwritten. If the rectangle does not fit into the present table, | 819 | will be overwritten. If the rectangle does not fit into the present table, |
| 802 | the table is enlarged as needed. The process ignores horizontal separator | 820 | the table is enlarged as needed. The process ignores horizontal separator |
| @@ -828,6 +846,14 @@ Sum the numbers in the current column, or in the rectangle defined by | |||
| 828 | the active region. The result is displayed in the echo area and can | 846 | the active region. The result is displayed in the echo area and can |
| 829 | be inserted with @kbd{C-y}. | 847 | be inserted with @kbd{C-y}. |
| 830 | 848 | ||
| 849 | @kindex S-@key{RET} | ||
| 850 | @item S-@key{RET} | ||
| 851 | When current field is empty, copy from first non-empty field above. | ||
| 852 | When not empty, copy current field down to next row and move cursor | ||
| 853 | along with it. Depending on the variable | ||
| 854 | @code{org-table-copy-increment}, integer field values will be | ||
| 855 | incremented during copy. | ||
| 856 | |||
| 831 | @cindex formula, in tables | 857 | @cindex formula, in tables |
| 832 | @cindex calculations, in tables | 858 | @cindex calculations, in tables |
| 833 | @kindex C-c = | 859 | @kindex C-c = |
| @@ -1063,7 +1089,7 @@ text has a headline, i.e. a first line that starts with a @samp{*}. | |||
| 1063 | If not, a headline is constructed from the current date and some | 1089 | If not, a headline is constructed from the current date and some |
| 1064 | additional data. If the variable @code{org-adapt-indentation} is | 1090 | additional data. If the variable @code{org-adapt-indentation} is |
| 1065 | non-nil, the entire text is also indented so that it starts in the | 1091 | non-nil, the entire text is also indented so that it starts in the |
| 1066 | same column as the headline (after the asterixes). | 1092 | same column as the headline (after the asterisks). |
| 1067 | 1093 | ||
| 1068 | @node Timestamps, Timeline and Agenda, Hyperlinks, Top | 1094 | @node Timestamps, Timeline and Agenda, Hyperlinks, Top |
| 1069 | @chapter Timestamps | 1095 | @chapter Timestamps |
| @@ -1404,11 +1430,12 @@ Sorting can be customized using the variable | |||
| 1404 | @node Agenda commands, Calendar/Diary integration, Agenda (multiple files), Timeline and Agenda | 1430 | @node Agenda commands, Calendar/Diary integration, Agenda (multiple files), Timeline and Agenda |
| 1405 | @section Commands in the agenda buffer | 1431 | @section Commands in the agenda buffer |
| 1406 | 1432 | ||
| 1407 | Entries in the agenda buffer are linked back to the org file. You are | 1433 | Entries in the agenda buffer are linked back to the org file or diary |
| 1408 | not allowed to edit the agenda buffer itself, but commands are provided | 1434 | file where they originate. You are not allowed to edit the agenda |
| 1409 | to edit the org-files ``remotely'' from the agenda buffer. In this | 1435 | buffer itself, but commands are provided to show and jump to the |
| 1410 | way, all information is stored only once, and you don't risk that your | 1436 | original entry location, and to edit the org-files ``remotely'' from |
| 1411 | agenda and note files diverge. | 1437 | the agenda buffer. In this way, all information is stored only once, |
| 1438 | and you don't risk that your agenda and note files diverge. | ||
| 1412 | 1439 | ||
| 1413 | Some commands can be executed with mouse clicks on agenda lines. For | 1440 | Some commands can be executed with mouse clicks on agenda lines. For |
| 1414 | the other commands, the cursor needs to be in the desired line. Most | 1441 | the other commands, the cursor needs to be in the desired line. Most |
| @@ -1468,7 +1495,7 @@ S-@key{right}. | |||
| 1468 | Display the following @code{org-agenda-ndays} days. For example, if | 1495 | Display the following @code{org-agenda-ndays} days. For example, if |
| 1469 | the display covers a week, switch to the following week. With prefix | 1496 | the display covers a week, switch to the following week. With prefix |
| 1470 | arg, go forward that many times @code{org-agenda-ndays} days. Not | 1497 | arg, go forward that many times @code{org-agenda-ndays} days. Not |
| 1471 | available in timlines. | 1498 | available in timelines. |
| 1472 | 1499 | ||
| 1473 | @kindex @key{left} | 1500 | @kindex @key{left} |
| 1474 | @item @key{left} | 1501 | @item @key{left} |
| @@ -1536,6 +1563,29 @@ Insert a new entry into the diary. Prompts for the type of entry | |||
| 1536 | entry in the diary, just like @kbd{i d} etc. would do in the calendar. | 1563 | entry in the diary, just like @kbd{i d} etc. would do in the calendar. |
| 1537 | The date is taken from the cursor position. | 1564 | The date is taken from the cursor position. |
| 1538 | 1565 | ||
| 1566 | @tsubheading{Calendar commands} | ||
| 1567 | @kindex c | ||
| 1568 | @item c | ||
| 1569 | Open the Emacs calendar and move to the date at the agenda cursor. | ||
| 1570 | |||
| 1571 | @kindex C | ||
| 1572 | @item C | ||
| 1573 | Convert the date at cursor into many other cultural and historic | ||
| 1574 | calendars. | ||
| 1575 | |||
| 1576 | @kindex M | ||
| 1577 | @item M | ||
| 1578 | Show the phases of the moon for three month around current date. | ||
| 1579 | |||
| 1580 | @kindex S | ||
| 1581 | @item S | ||
| 1582 | Show sunrise and sunset times. The location must be set with calendar | ||
| 1583 | variables, see documentation of the Emacs calendar. | ||
| 1584 | |||
| 1585 | @kindex H | ||
| 1586 | @item H | ||
| 1587 | Show holidays for three month around the cursor date. | ||
| 1588 | |||
| 1539 | @tsubheading{Quit and Exit} | 1589 | @tsubheading{Quit and Exit} |
| 1540 | @kindex q | 1590 | @kindex q |
| 1541 | @item q | 1591 | @item q |
| @@ -1564,8 +1614,9 @@ Org-mode. It can be very useful to combine output from Org-mode with | |||
| 1564 | the diary. | 1614 | the diary. |
| 1565 | 1615 | ||
| 1566 | The interaction between Org-mode and diary works both ways: You can | 1616 | The interaction between Org-mode and diary works both ways: You can |
| 1567 | list entries from the diary in the Org-mode agenda, or you can display | 1617 | list entries from the diary in the Org-mode agenda, from which many |
| 1568 | entries from the org agenda in the Emacs diary. | 1618 | calendar and diary commands are directly accessible. Or you can |
| 1619 | display entries from the org agenda in the Emacs diary. | ||
| 1569 | 1620 | ||
| 1570 | @menu | 1621 | @menu |
| 1571 | * Diary to agenda:: Agenda incorporates the diary | 1622 | * Diary to agenda:: Agenda incorporates the diary |
| @@ -1584,7 +1635,15 @@ agenda, you only need to customize the variable | |||
| 1584 | @end lisp | 1635 | @end lisp |
| 1585 | @noindent | 1636 | @noindent |
| 1586 | 1637 | ||
| 1587 | @noindent After that, everything will happen automatically. | 1638 | @noindent After that, everything will happen automatically. All diary |
| 1639 | entries including holidays, anniversaries etc will be included in the | ||
| 1640 | agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and | ||
| 1641 | @key{RET} can be used from the agenda buffer to jump to the diary | ||
| 1642 | file, in order to edit existing diary entries. Also the @kbd{i} | ||
| 1643 | command to insert new entries for the current date works in the agenda | ||
| 1644 | buffer, as well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to | ||
| 1645 | display Sunrise/Sunset times, show lunar phases and to convert to | ||
| 1646 | other calendars, respectively. | ||
| 1588 | 1647 | ||
| 1589 | @node Agenda to diary, , Diary to agenda, Calendar/Diary integration | 1648 | @node Agenda to diary, , Diary to agenda, Calendar/Diary integration |
| 1590 | @subsection Including the agenda into the diary | 1649 | @subsection Including the agenda into the diary |