diff options
| author | Carsten Dominik | 2006-06-06 08:26:54 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2006-06-06 08:26:54 +0000 |
| commit | 2dcffa1c625d0513c8e49a253ad7f7100aeb3231 (patch) | |
| tree | be42b9778cffcb1b4478667aaf4b8771632cab69 | |
| parent | 98a5380242a43b639fe383fc59106d40d7ff5eeb (diff) | |
| download | emacs-2dcffa1c625d0513c8e49a253ad7f7100aeb3231.tar.gz emacs-2dcffa1c625d0513c8e49a253ad7f7100aeb3231.zip | |
(ASCII export): Document indentation adaptation.
(Setting tags): Document mutually-exclusive tags.
| -rw-r--r-- | man/org.texi | 84 |
1 files changed, 52 insertions, 32 deletions
diff --git a/man/org.texi b/man/org.texi index c6b9f39e5f9..27970a1aea8 100644 --- a/man/org.texi +++ b/man/org.texi | |||
| @@ -4,8 +4,8 @@ | |||
| 4 | @setfilename ../info/org | 4 | @setfilename ../info/org |
| 5 | @settitle Org Mode Manual | 5 | @settitle Org Mode Manual |
| 6 | 6 | ||
| 7 | @set VERSION 4.35 | 7 | @set VERSION 4.36 |
| 8 | @set DATE May 2006 | 8 | @set DATE June 2006 |
| 9 | 9 | ||
| 10 | @dircategory Emacs | 10 | @dircategory Emacs |
| 11 | @direntry | 11 | @direntry |
| @@ -1242,7 +1242,7 @@ Instead of typing an equation into the field, you may also use the | |||
| 1242 | command @kbd{C-c =}. It prompts for a formula (with default taken | 1242 | command @kbd{C-c =}. It prompts for a formula (with default taken |
| 1243 | from the @samp{#+TBLFM:} line) and applies it to the current field. A | 1243 | from the @samp{#+TBLFM:} line) and applies it to the current field. A |
| 1244 | numerical prefix (e.g. @kbd{C-5 C-c =}) will apply it to that many | 1244 | numerical prefix (e.g. @kbd{C-5 C-c =}) will apply it to that many |
| 1245 | subsequent fields in the current column. | 1245 | consecutive fields in the current column. |
| 1246 | 1246 | ||
| 1247 | @cindex recomputing table fields | 1247 | @cindex recomputing table fields |
| 1248 | To recompute all the fields in a line, use the command @kbd{C-c *}. | 1248 | To recompute all the fields in a line, use the command @kbd{C-c *}. |
| @@ -2336,7 +2336,7 @@ into the following column). | |||
| 2336 | When Org-mode prompts for a date/time, the function reading your input | 2336 | When Org-mode prompts for a date/time, the function reading your input |
| 2337 | will replace anything you choose not to specify with the current date | 2337 | will replace anything you choose not to specify with the current date |
| 2338 | and time. For details, see the documentation string of | 2338 | and time. For details, see the documentation string of |
| 2339 | @command{org-read-date}. Also, a calendar will pop up to allow | 2339 | @command{org-read-date}. Also, a calender will pop up to allow |
| 2340 | selecting a date. The calendar can be fully controlled from the | 2340 | selecting a date. The calendar can be fully controlled from the |
| 2341 | minibuffer, and a date can be selected with the following commands: | 2341 | minibuffer, and a date can be selected with the following commands: |
| 2342 | 2342 | ||
| @@ -2452,11 +2452,11 @@ the allowed tags for a given file with lines like | |||
| 2452 | #+TAGS: Laptop Car PC Sailboat | 2452 | #+TAGS: Laptop Car PC Sailboat |
| 2453 | @end example | 2453 | @end example |
| 2454 | 2454 | ||
| 2455 | The default method Org-mode uses to support setting tags is completion. | 2455 | The default support method is minibuffer completion. However, Org-mode |
| 2456 | However, it also implements a much better method: @emph{fast tag | 2456 | also implements a much better method: @emph{fast tag selection}. This |
| 2457 | selection}. This method allows to select and deselect tags with a | 2457 | method allows to select and deselect tags with a single key per tag. To |
| 2458 | single key per tag. To function efficiently, you need to assign unique | 2458 | function efficiently, you should assign unique keys to all tags. This |
| 2459 | keys to all tags. This can be done globally with | 2459 | can be done globally with |
| 2460 | 2460 | ||
| 2461 | @lisp | 2461 | @lisp |
| 2462 | (setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l))) | 2462 | (setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l))) |
| @@ -2465,27 +2465,44 @@ keys to all tags. This can be done globally with | |||
| 2465 | @noindent or on a per-file basis with | 2465 | @noindent or on a per-file basis with |
| 2466 | 2466 | ||
| 2467 | @example | 2467 | @example |
| 2468 | #+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) | 2468 | #+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) Laptop(l) PC(p) |
| 2469 | #+TAGS: Laptop(l) Car(c) PC(p) Sailboat(s) | ||
| 2470 | @end example | 2469 | @end example |
| 2471 | 2470 | ||
| 2471 | @noindent | ||
| 2472 | You can also group together tags that are mutually exclusive. With | ||
| 2473 | curly braces@footnote{In @code{org-mode-alist} use | ||
| 2474 | @code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several | ||
| 2475 | groups are allowed.} | ||
| 2476 | |||
| 2477 | @example | ||
| 2478 | #+TAGS: @{ @@WORK(w) @@HOME(h) @@TENNISCLUB(t) @} Laptop(l) PC(p) | ||
| 2479 | @end example | ||
| 2480 | |||
| 2481 | @noindent you indicate that at most one of @samp{@@WORK}, @samp{@@HOME}, | ||
| 2482 | and @samp{@@SAILBOAT} should be selected. | ||
| 2483 | |||
| 2472 | @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | 2484 | @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of |
| 2473 | these lines to activate any changes. | 2485 | these lines to activate any changes. |
| 2474 | 2486 | ||
| 2475 | If selection keys have been configured, pressing @kbd{C-c C-c} will | 2487 | If at least one tag has a selection key, pressing @kbd{C-c C-c} will |
| 2476 | automatically present you with a special interface, listing inherited | 2488 | automatically present you with a special interface, listing inherited |
| 2477 | tags, the tags of the current headline, and a list of all legal tags | 2489 | tags, the tags of the current headline, and a list of all legal tags |
| 2478 | with corresponding keys. Pressing keys for the tags will add or remove | 2490 | with corresponding keys@footnote{Keys will automatically assigned to |
| 2479 | them from the list of tags in the current line. @key{SPC} clears all | 2491 | tags which have no configured keys.}. Pressing keys for the tags will |
| 2480 | tags for this line, @kbd{RET} accepts the modified set, and @kbd{C-g} | 2492 | add or remove them from the list of tags in the current line. Selecting |
| 2481 | aborts without installing changes. This method lets you assign tags to | 2493 | a tag in a group of mutually exclusive tags will turn off any other tags |
| 2482 | a headline with very few keys. With the above setup, you could clear | 2494 | from that group. @key{SPC} clears all tags for this line, @kbd{RET} |
| 2483 | the current tags and set @samp{@@HOME}, @samp{Laptop} and @samp{PC} tags | 2495 | accepts the modified set, and @kbd{C-g} aborts without installing |
| 2484 | with just the following keys: @kbd{C-c C-c @key{SPC} h l p @key{RET}}. | 2496 | changes. This method lets you assign tags to a headline with very few |
| 2497 | keys. With the above setup, you could clear the current tags and set | ||
| 2498 | @samp{@@HOME}, @samp{Laptop} and @samp{PC} tags with just the following | ||
| 2499 | keys: @kbd{C-c C-c @key{SPC} h l p @key{RET}}. Switching from | ||
| 2500 | @samp{@@HOME} to @samp{@@WORK} would be done with @kbd{C-c C-c w | ||
| 2501 | @key{RET}}. | ||
| 2485 | 2502 | ||
| 2486 | What if you have globally defined your preferred set of tags using the | 2503 | What if you have globally defined your preferred set of tags using the |
| 2487 | variable @code{org-tag-alist}, but would like to use a dynamic tag list | 2504 | variable @code{org-tag-alist}, but would like to use a dynamic tag list |
| 2488 | in a specific file? Just add and empty TAGS option line to that file: | 2505 | in a specific file? Just add an empty TAGS option line to that file: |
| 2489 | 2506 | ||
| 2490 | @example | 2507 | @example |
| 2491 | #+TAGS: | 2508 | #+TAGS: |
| @@ -3169,7 +3186,13 @@ at a different level, specify it with a prefix argument. For example, | |||
| 3169 | @end example | 3186 | @end example |
| 3170 | 3187 | ||
| 3171 | @noindent | 3188 | @noindent |
| 3172 | creates only top level headlines and does the rest as items. | 3189 | creates only top level headlines and does the rest as items. When |
| 3190 | headlines are converted to items, the indentation of the text following | ||
| 3191 | the headline is changed to fit nicely under the item. This is done with | ||
| 3192 | the assumption that the first bodyline indicates the base indenation of | ||
| 3193 | the body text. Any indenation larger than this is adjusted to preserve | ||
| 3194 | the layout relative to the first line. Should there be lines with less | ||
| 3195 | indentation than the first, these are left alone. | ||
| 3173 | 3196 | ||
| 3174 | @node HTML export, XOXO export, ASCII export, Exporting | 3197 | @node HTML export, XOXO export, ASCII export, Exporting |
| 3175 | @section HTML export | 3198 | @section HTML export |
| @@ -3357,8 +3380,6 @@ the first headline will not be exported either. | |||
| 3357 | Toggle the COMMENT keyword at the beginning of an entry. | 3380 | Toggle the COMMENT keyword at the beginning of an entry. |
| 3358 | @end table | 3381 | @end table |
| 3359 | 3382 | ||
| 3360 | |||
| 3361 | |||
| 3362 | @node Enhancing text, Export options, Comment lines, Text interpretation | 3383 | @node Enhancing text, Export options, Comment lines, Text interpretation |
| 3363 | @subsection Enhancing text for export | 3384 | @subsection Enhancing text for export |
| 3364 | @cindex enhancing text | 3385 | @cindex enhancing text |
| @@ -3417,6 +3438,11 @@ fixed-width font. | |||
| 3417 | @item C-c : | 3438 | @item C-c : |
| 3418 | Toggle fixed-width for entry (QUOTE) or region, see below. | 3439 | Toggle fixed-width for entry (QUOTE) or region, see below. |
| 3419 | @end table | 3440 | @end table |
| 3441 | |||
| 3442 | @cindex linebreak, forced | ||
| 3443 | @item | ||
| 3444 | A double backslash @emph{at the end of a line} enforces a line break at | ||
| 3445 | this position. | ||
| 3420 | @end itemize | 3446 | @end itemize |
| 3421 | 3447 | ||
| 3422 | If these conversions conflict with your habits of typing ASCII text, | 3448 | If these conversions conflict with your habits of typing ASCII text, |
| @@ -3597,7 +3623,7 @@ specify the publishing function. | |||
| 3597 | 3623 | ||
| 3598 | The function must accept two arguments: a property list containing at | 3624 | The function must accept two arguments: a property list containing at |
| 3599 | least a @code{:publishing-directory} property, and the name of the file | 3625 | least a @code{:publishing-directory} property, and the name of the file |
| 3600 | to be published. I should take the specified file, make the necessary | 3626 | to be published. It should take the specified file, make the necessary |
| 3601 | transformation (if any) and place the result into the destination folder. | 3627 | transformation (if any) and place the result into the destination folder. |
| 3602 | You can write your own publishing function, but @code{org-publish} | 3628 | You can write your own publishing function, but @code{org-publish} |
| 3603 | provides one for attachments (files that only need to be copied): | 3629 | provides one for attachments (files that only need to be copied): |
| @@ -4336,12 +4362,6 @@ with other code out there. | |||
| 4336 | The following extensions for Org-mode have been written by other people: | 4362 | The following extensions for Org-mode have been written by other people: |
| 4337 | 4363 | ||
| 4338 | @table @asis | 4364 | @table @asis |
| 4339 | @cindex @file{org-checklet.el} | ||
| 4340 | @item @file{org-checklet.el} by Frank Ruell | ||
| 4341 | Provides checklist of items which can be either checked or unchecked. | ||
| 4342 | This is similar to the TODO functionality in Org-mode, but never shows | ||
| 4343 | up in the agenda. @file{org-checklet} is freely available at | ||
| 4344 | @url{http://www.emacswiki.org/cgi-bin/emacs/org-checklet.el}. | ||
| 4345 | @cindex @file{org-mouse.el} | 4365 | @cindex @file{org-mouse.el} |
| 4346 | @item @file{org-mouse.el} by Piotr Zielinski | 4366 | @item @file{org-mouse.el} by Piotr Zielinski |
| 4347 | This package implements extended mouse functionality for Org-mode. It | 4367 | This package implements extended mouse functionality for Org-mode. It |
| @@ -4556,8 +4576,8 @@ other things. | |||
| 4556 | Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s | 4576 | Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s |
| 4557 | @file{organizer-mode.el}. | 4577 | @file{organizer-mode.el}. |
| 4558 | @item | 4578 | @item |
| 4559 | @i{David O'Toole} wrote @file{org-publish.el} and came up with lots of | 4579 | @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
| 4560 | ideas for small changes. | 4580 | chapter about publishing. |
| 4561 | @item | 4581 | @item |
| 4562 | @i{J@"urgen Vollmer} contributed code generating the table of contents | 4582 | @i{J@"urgen Vollmer} contributed code generating the table of contents |
| 4563 | in HTML output. | 4583 | in HTML output. |