diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/ChangeLog | 20 | ||||
| -rw-r--r-- | doc/emacs/cal-xtra.texi | 4 | ||||
| -rw-r--r-- | doc/emacs/calendar.texi | 9 | ||||
| -rw-r--r-- | doc/emacs/emacs.texi | 1 | ||||
| -rw-r--r-- | doc/emacs/trouble.texi | 191 | ||||
| -rw-r--r-- | doc/emacs/xresources.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 89 | ||||
| -rw-r--r-- | doc/lispref/syntax.texi | 91 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 44 | ||||
| -rw-r--r-- | doc/misc/ChangeLog | 16 | ||||
| -rw-r--r-- | doc/misc/org.texi | 1001 | ||||
| -rw-r--r-- | doc/misc/tramp.texi | 29 | ||||
| -rw-r--r-- | doc/misc/trampver.texi | 4 |
14 files changed, 831 insertions, 678 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 0be5e5d86bb..80be53432e0 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,23 @@ | |||
| 1 | 2010-09-14 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * cal-xtra.texi (Fancy Diary Display): Emphasize that sort should be | ||
| 4 | the last hook item. | ||
| 5 | |||
| 6 | * calendar.texi (Appointments): Also updated when a diary include file | ||
| 7 | is saved. | ||
| 8 | |||
| 9 | 2010-09-14 Glenn Morris <rgm@gnu.org> | ||
| 10 | |||
| 11 | * trouble.texi (Bugs): Update the section intro. | ||
| 12 | (Known Problems): New section. | ||
| 13 | (Checklist): Misc updates. Prefer M-x report-emacs-bug. | ||
| 14 | (Sending Patches): Bug fixes are best as responses to existing bugs. | ||
| 15 | * emacs.texi (Known Problems): Add menu entry for new section. | ||
| 16 | |||
| 17 | 2010-09-09 Glenn Morris <rgm@gnu.org> | ||
| 18 | |||
| 19 | * xresources.texi: Untabify. | ||
| 20 | |||
| 1 | 2010-09-06 Chong Yidong <cyd@stupidchicken.com> | 21 | 2010-09-06 Chong Yidong <cyd@stupidchicken.com> |
| 2 | 22 | ||
| 3 | * dired.texi (Dired Enter): Minor doc fix (Bug#6982). | 23 | * dired.texi (Dired Enter): Minor doc fix (Bug#6982). |
diff --git a/doc/emacs/cal-xtra.texi b/doc/emacs/cal-xtra.texi index 60588542356..de36ccc4f5f 100644 --- a/doc/emacs/cal-xtra.texi +++ b/doc/emacs/cal-xtra.texi | |||
| @@ -613,7 +613,9 @@ each day's diary entries by their time of day. Here's how: | |||
| 613 | @noindent | 613 | @noindent |
| 614 | For each day, this sorts diary entries that begin with a recognizable | 614 | For each day, this sorts diary entries that begin with a recognizable |
| 615 | time of day according to their times. Diary entries without times come | 615 | time of day according to their times. Diary entries without times come |
| 616 | first within each day. | 616 | first within each day. Note how the sort command is placed at the end |
| 617 | of the hook list, in case earlier members of the list change the order | ||
| 618 | of the diary entries, or add items. | ||
| 617 | 619 | ||
| 618 | @vindex diary-include-string | 620 | @vindex diary-include-string |
| 619 | Your main diary file can include other files. This permits a group of | 621 | Your main diary file can include other files. This permits a group of |
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 5698fd5ff58..89504764d7d 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi | |||
| @@ -1508,7 +1508,14 @@ automatically just after midnight. You can force an update at any | |||
| 1508 | time by re-enabling appointment notification. Both these actions also | 1508 | time by re-enabling appointment notification. Both these actions also |
| 1509 | display the day's diary buffer, unless you set | 1509 | display the day's diary buffer, unless you set |
| 1510 | @code{appt-display-diary} to @code{nil}. The appointments list is | 1510 | @code{appt-display-diary} to @code{nil}. The appointments list is |
| 1511 | also updated whenever the diary file is saved. | 1511 | also updated whenever the diary file (or a file it includes; see |
| 1512 | @iftex | ||
| 1513 | @inforef{Fancy Diary Display,, emacs-xtra}) | ||
| 1514 | @end iftex | ||
| 1515 | @ifnottex | ||
| 1516 | @ref{Fancy Diary Display}) | ||
| 1517 | @end ifnottex | ||
| 1518 | is saved. | ||
| 1512 | 1519 | ||
| 1513 | @findex appt-add | 1520 | @findex appt-add |
| 1514 | @findex appt-delete | 1521 | @findex appt-delete |
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 4de9ee4a57a..17337d2c592 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi | |||
| @@ -1137,6 +1137,7 @@ Dealing with Emacs Trouble | |||
| 1137 | 1137 | ||
| 1138 | Reporting Bugs | 1138 | Reporting Bugs |
| 1139 | 1139 | ||
| 1140 | * Known Problems:: How to read about known problems and bugs. | ||
| 1140 | * Bug Criteria:: Have you really found a bug? | 1141 | * Bug Criteria:: Have you really found a bug? |
| 1141 | * Understanding Bug Reporting:: How to report a bug effectively. | 1142 | * Understanding Bug Reporting:: How to report a bug effectively. |
| 1142 | * Checklist:: Steps to follow for a good bug report. | 1143 | * Checklist:: Steps to follow for a good bug report. |
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index 0390b7da910..2f90b30bf83 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi | |||
| @@ -409,29 +409,76 @@ say something to the psychotherapist, you must end it by typing | |||
| 409 | @section Reporting Bugs | 409 | @section Reporting Bugs |
| 410 | 410 | ||
| 411 | @cindex bugs | 411 | @cindex bugs |
| 412 | Sometimes you will encounter a bug in Emacs. Although we cannot | 412 | If you think you have found a bug in Emacs, please report it. We |
| 413 | promise we can or will fix the bug, and we might not even agree that it | 413 | cannot promise to fix it, or always to agree that it is a bug, but we |
| 414 | is a bug, we want to hear about problems you encounter. Often we agree | 414 | certainly want to hear about it. The same applies for new features |
| 415 | they are bugs and want to fix them. | 415 | you would like to see added. The following sections will help you to |
| 416 | 416 | construct an effective bug report. | |
| 417 | To make it possible for us to fix a bug, you must report it. In order | ||
| 418 | to do so effectively, you must know when and how to do it. | ||
| 419 | |||
| 420 | Before reporting a bug, it is a good idea to see if it is already | ||
| 421 | known. You can find the list of known problems in the file | ||
| 422 | @file{etc/PROBLEMS} in the Emacs distribution; type @kbd{C-h C-p} to read | ||
| 423 | it. Some additional user-level problems can be found in @ref{Bugs and | ||
| 424 | problems, , Bugs and problems, efaq, GNU Emacs FAQ}. Looking up your | ||
| 425 | problem in these two documents might provide you with a solution or a | ||
| 426 | work-around, or give you additional information about related issues. | ||
| 427 | 417 | ||
| 428 | @menu | 418 | @menu |
| 419 | * Known Problems:: How to read about known problems and bugs. | ||
| 429 | * Criteria: Bug Criteria. Have you really found a bug? | 420 | * Criteria: Bug Criteria. Have you really found a bug? |
| 430 | * Understanding Bug Reporting:: How to report a bug effectively. | 421 | * Understanding Bug Reporting:: How to report a bug effectively. |
| 431 | * Checklist:: Steps to follow for a good bug report. | 422 | * Checklist:: Steps to follow for a good bug report. |
| 432 | * Sending Patches:: How to send a patch for GNU Emacs. | 423 | * Sending Patches:: How to send a patch for GNU Emacs. |
| 433 | @end menu | 424 | @end menu |
| 434 | 425 | ||
| 426 | @node Known Problems | ||
| 427 | @subsection Reading Existing Bug Reports and Known Problems | ||
| 428 | |||
| 429 | Before reporting a bug, if at all possible please check to see if it | ||
| 430 | is already known about. Indeed, it may already have been fixed in a | ||
| 431 | later release of Emacs, or in the development version. Here is a list | ||
| 432 | of the main places you can read about known issues: | ||
| 433 | |||
| 434 | @itemize | ||
| 435 | @item | ||
| 436 | The @file{etc/PROBLEMS} file in the Emacs distribution; type @kbd{C-h | ||
| 437 | C-p} to read it. This file contains a list of particularly well-known | ||
| 438 | issues that have been encountered in compiling, installing and running | ||
| 439 | Emacs. Often, there are suggestions for workarounds and solutions. | ||
| 440 | |||
| 441 | @item | ||
| 442 | Some additional user-level problems can be found in @ref{Bugs and | ||
| 443 | problems, , Bugs and problems, efaq, GNU Emacs FAQ}. | ||
| 444 | |||
| 445 | @item | ||
| 446 | The @samp{bug-gnu-emacs} mailing list (also available as the newsgroup | ||
| 447 | @samp{gnu.emacs.bug}). This is where you will find most Emacs bug | ||
| 448 | reports. You can read the list archives at | ||
| 449 | @url{http://lists.gnu.org/mailman/listinfo/bug-gnu-emacs}. If you | ||
| 450 | like, you can also subscribe to the list. Be aware that the sole | ||
| 451 | purpose of this list is to provide the Emacs maintainers with | ||
| 452 | information about bugs and feature requests. Reports may contain | ||
| 453 | fairly large amounts of data; spectators should not complain about | ||
| 454 | this. | ||
| 455 | |||
| 456 | @item | ||
| 457 | The bug tracker at @url{http://debbugs.gnu.org}. From early 2008, | ||
| 458 | reports from the @samp{bug-gnu-emacs} list have been sent here. The | ||
| 459 | tracker contains the same information as the mailing list, just in a | ||
| 460 | different format. You may prefer to browse and read reports using the | ||
| 461 | tracker. | ||
| 462 | |||
| 463 | @item | ||
| 464 | The @samp{emacs-pretest-bug} mailing list. This list is no longer | ||
| 465 | used, and is mainly of historical interest. At one time, it was used | ||
| 466 | for bug reports in development (i.e., not yet released) versions of | ||
| 467 | Emacs. You can read the archives for 2003 to mid 2007 at | ||
| 468 | @url{http://lists.gnu.org/archive/html/emacs-pretest-bug/}. From | ||
| 469 | late 2007 to mid 2008, the address was an alias for the | ||
| 470 | @samp{emacs-devel} mailing list. From mid 2008 onwards, it has been | ||
| 471 | an alias for @samp{bug-gnu-emacs}. | ||
| 472 | |||
| 473 | @item | ||
| 474 | The @samp{emacs-devel} mailing list. Sometimes people report bugs to | ||
| 475 | this mailing list. This is not the main purpose of the list, however, | ||
| 476 | and it is much better to send bug reports to the bug list. You should | ||
| 477 | not feel obliged to read this list before reporting a bug. | ||
| 478 | |||
| 479 | @end itemize | ||
| 480 | |||
| 481 | |||
| 435 | @node Bug Criteria | 482 | @node Bug Criteria |
| 436 | @subsection When Is There a Bug | 483 | @subsection When Is There a Bug |
| 437 | 484 | ||
| @@ -540,56 +587,81 @@ well. | |||
| 540 | @subsection Checklist for Bug Reports | 587 | @subsection Checklist for Bug Reports |
| 541 | 588 | ||
| 542 | @cindex reporting bugs | 589 | @cindex reporting bugs |
| 543 | The best way to send a bug report is to mail it electronically to the | 590 | |
| 544 | Emacs maintainers at @email{bug-gnu-emacs@@gnu.org}. (If you want to | 591 | Before reporting a bug, first try to see if the problem has already |
| 545 | suggest a change as an improvement, use the same address.) | 592 | been reported (@pxref{Known Problems}). |
| 546 | 593 | ||
| 547 | If you'd like to read the bug reports, you can find them on the | 594 | If you are able to, try the latest release of Emacs to see if the |
| 548 | newsgroup @samp{gnu.emacs.bug}; keep in mind, however, that as a | 595 | problem has already been fixed. Even better is to try the latest |
| 549 | spectator you should not criticize anything about what you see there. | 596 | development version. We recognize that this is not easy for some |
| 550 | The purpose of bug reports is to give information to the Emacs | 597 | people, so do not feel that you absolutely must do this before making |
| 551 | maintainers. Spectators are welcome only as long as they do not | 598 | a report. |
| 552 | interfere with this. In particular, some bug reports contain fairly | ||
| 553 | large amounts of data; spectators should not complain about this. | ||
| 554 | |||
| 555 | Please do not post bug reports using netnews; mail is more reliable | ||
| 556 | than netnews about reporting your correct address, which we may need | ||
| 557 | in order to ask you for more information. If your data is more than | ||
| 558 | 500,000 bytes, please don't include it directly in the bug report; | ||
| 559 | instead, offer to send it on request, or make it available by ftp and | ||
| 560 | say where. | ||
| 561 | 599 | ||
| 562 | @findex report-emacs-bug | 600 | @findex report-emacs-bug |
| 563 | A convenient way to send a bug report for Emacs is to use the command | 601 | The best way to write a bug report for Emacs is to use the command |
| 564 | @kbd{M-x report-emacs-bug}. This sets up a mail buffer (@pxref{Sending | 602 | @kbd{M-x report-emacs-bug}. This sets up a mail buffer |
| 565 | Mail}) and automatically inserts @emph{some} of the essential | 603 | (@pxref{Sending Mail}) and automatically inserts @emph{some} of the |
| 566 | information. However, it cannot supply all the necessary information; | 604 | essential information. However, it cannot supply all the necessary |
| 567 | you should still read and follow the guidelines below, so you can enter | 605 | information; you should still read and follow the guidelines below, so |
| 568 | the other crucial information by hand before you send the message. | 606 | you can enter the other crucial information by hand before you send |
| 607 | the message. You may feel that some of the information inserted by | ||
| 608 | @kbd{M-x report-emacs-bug} is not relevant, but unless you are | ||
| 609 | absolutely sure it is best to leave it, so that the developers can | ||
| 610 | decide for themselves. | ||
| 611 | |||
| 612 | When you have finished writing your report, type @kbd{C-c C-c} and it | ||
| 613 | will be sent to the Emacs maintainers at @email{bug-gnu-emacs@@gnu.org}. | ||
| 614 | (If you want to suggest an improvement or new feature, use the same | ||
| 615 | address.) If you cannot send mail from inside Emacs, you can copy the | ||
| 616 | text of your report to your normal mail client and send it to that | ||
| 617 | address. Or you can simply send an email to that address describing | ||
| 618 | the problem. | ||
| 619 | |||
| 620 | Your report will be sent to the @samp{bug-gnu-emacs} mailing list, and | ||
| 621 | stored in the tracker at @url{http://debbugs.gnu.org}. Please try to | ||
| 622 | include a valid reply email address, in case we need to ask you for | ||
| 623 | more information about your report. Submissions are moderated, so | ||
| 624 | there may be a delay before your report appears. | ||
| 625 | |||
| 626 | You do not need to know how the @url{http://debbugs.gnu.org} bug | ||
| 627 | tracker works in order to report a bug, but if you want to, you can | ||
| 628 | read the tracker's online documentation to see the various features | ||
| 629 | you can use. | ||
| 630 | |||
| 631 | All mail sent to the @samp{bug-gnu-emacs} mailing list is also | ||
| 632 | gatewayed to the @samp{bug.gnu.emacs} newsgroup. The reverse is also | ||
| 633 | true, but we ask you not to post bug reports via the newsgroup. It | ||
| 634 | can make it much harder to contact you if we need to ask for more | ||
| 635 | information, and it does not integrate well with the bug tracker. | ||
| 636 | |||
| 637 | If your data is more than 500,000 bytes, please don't include it | ||
| 638 | directly in the bug report; instead, offer to send it on request, or | ||
| 639 | make it available by ftp and say where. | ||
| 569 | 640 | ||
| 570 | To enable maintainers to investigate a bug, your report | 641 | To enable maintainers to investigate a bug, your report |
| 571 | should include all these things: | 642 | should include all these things: |
| 572 | 643 | ||
| 573 | @itemize @bullet | 644 | @itemize @bullet |
| 574 | @item | 645 | @item |
| 575 | The version number of Emacs. Without this, we won't know whether there | 646 | The version number of Emacs. Without this, we won't know whether there is any |
| 576 | is any point in looking for the bug in the current version of GNU | 647 | point in looking for the bug in the current version of GNU Emacs. |
| 577 | Emacs. | ||
| 578 | 648 | ||
| 579 | You can get the version number by typing @kbd{M-x emacs-version | 649 | @kbd{M-x report-emacs-bug} includes this information automatically, |
| 580 | @key{RET}}. If that command does not work, you probably have something | 650 | but if you are not using that command for your report you can get the |
| 581 | other than GNU Emacs, so you will have to report the bug somewhere | 651 | version number by typing @kbd{M-x emacs-version @key{RET}}. If that |
| 582 | else. | 652 | command does not work, you probably have something other than GNU |
| 653 | Emacs, so you will have to report the bug somewhere else. | ||
| 583 | 654 | ||
| 584 | @item | 655 | @item |
| 585 | The type of machine you are using, and the operating system name and | 656 | The type of machine you are using, and the operating system name and |
| 586 | version number. @kbd{M-x emacs-version @key{RET}} provides this | 657 | version number (again, automatically included by @kbd{M-x |
| 587 | information too. Copy its output from the @samp{*Messages*} buffer, so | 658 | report-emacs-bug}). @kbd{M-x emacs-version @key{RET}} provides this |
| 588 | that you get it all and get it accurately. | 659 | information too. Copy its output from the @samp{*Messages*} buffer, |
| 660 | so that you get it all and get it accurately. | ||
| 589 | 661 | ||
| 590 | @item | 662 | @item |
| 591 | The operands given to the @code{configure} command when Emacs was | 663 | The operands given to the @code{configure} command when Emacs was |
| 592 | installed. | 664 | installed (automatically included by @kbd{M-x report-emacs-bug}). |
| 593 | 665 | ||
| 594 | @item | 666 | @item |
| 595 | A complete list of any modifications you have made to the Emacs source. | 667 | A complete list of any modifications you have made to the Emacs source. |
| @@ -619,12 +691,15 @@ the last line is terminated, but try telling the bugs that). | |||
| 619 | 691 | ||
| 620 | @item | 692 | @item |
| 621 | The precise commands we need to type to reproduce the bug. | 693 | The precise commands we need to type to reproduce the bug. |
| 694 | If at all possible, give a full recipe for an Emacs started with the | ||
| 695 | @samp{-Q} option (@pxref{Initial Options}). This bypasses your | ||
| 696 | @file{.emacs} customizations. | ||
| 622 | 697 | ||
| 623 | @findex open-dribble-file | 698 | @findex open-dribble-file |
| 624 | @cindex dribble file | 699 | @cindex dribble file |
| 625 | @cindex logging keystrokes | 700 | @cindex logging keystrokes |
| 626 | The easy way to record the input to Emacs precisely is to write a | 701 | One way to record the input to Emacs precisely is to write a dribble |
| 627 | dribble file. To start the file, execute the Lisp expression | 702 | file. To start the file, execute the Lisp expression |
| 628 | 703 | ||
| 629 | @example | 704 | @example |
| 630 | (open-dribble-file "~/dribble") | 705 | (open-dribble-file "~/dribble") |
| @@ -735,7 +810,7 @@ Check whether any programs you have loaded into the Lisp world, | |||
| 735 | including your @file{.emacs} file, set any variables that may affect the | 810 | including your @file{.emacs} file, set any variables that may affect the |
| 736 | functioning of Emacs. Also, see whether the problem happens in a | 811 | functioning of Emacs. Also, see whether the problem happens in a |
| 737 | freshly started Emacs without loading your @file{.emacs} file (start | 812 | freshly started Emacs without loading your @file{.emacs} file (start |
| 738 | Emacs with the @code{-q} switch to prevent loading the init file). If | 813 | Emacs with the @code{-Q} switch to prevent loading the init files). If |
| 739 | the problem does @emph{not} occur then, you must report the precise | 814 | the problem does @emph{not} occur then, you must report the precise |
| 740 | contents of any programs that you must load into the Lisp world in order | 815 | contents of any programs that you must load into the Lisp world in order |
| 741 | to cause the problem to occur. | 816 | to cause the problem to occur. |
| @@ -907,12 +982,10 @@ your best to help. | |||
| 907 | @itemize @bullet | 982 | @itemize @bullet |
| 908 | @item | 983 | @item |
| 909 | Send an explanation with your changes of what problem they fix or what | 984 | Send an explanation with your changes of what problem they fix or what |
| 910 | improvement they bring about. For a bug fix, just include a copy of the | 985 | improvement they bring about. For a fix for an existing bug, it is |
| 911 | bug report, and explain why the change fixes the bug. | 986 | best to reply to the relevant discussion on the @samp{bug-gnu-emacs} |
| 912 | 987 | list, or item in the @url{http://debbugs.gnu.org} tracker. Explain | |
| 913 | (Referring to a bug report is not as good as including it, because then | 988 | why your change fixes the bug. |
| 914 | we will have to look it up, and we have probably already deleted it if | ||
| 915 | we've already fixed the bug.) | ||
| 916 | 989 | ||
| 917 | @item | 990 | @item |
| 918 | Always include a proper bug report for the problem you think you have | 991 | Always include a proper bug report for the problem you think you have |
diff --git a/doc/emacs/xresources.texi b/doc/emacs/xresources.texi index 2a543eeee08..ecf5c02f32b 100644 --- a/doc/emacs/xresources.texi +++ b/doc/emacs/xresources.texi | |||
| @@ -480,7 +480,7 @@ Emacs.menu*.font: 8x16 | |||
| 480 | For dialog boxes, use @samp{dialog*}: | 480 | For dialog boxes, use @samp{dialog*}: |
| 481 | 481 | ||
| 482 | @example | 482 | @example |
| 483 | Emacs.dialog*.faceName: Sans-12 | 483 | Emacs.dialog*.faceName: Sans-12 |
| 484 | @end example | 484 | @end example |
| 485 | 485 | ||
| 486 | @noindent | 486 | @noindent |
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 5534283ccd1..e3df5fab9e9 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2010-09-11 Stefan Monnier <monnier@iro.umontreal.ca> | ||
| 2 | |||
| 3 | * syntax.texi (Syntax Flags): Document new `c' flag. | ||
| 4 | |||
| 5 | 2010-09-09 Glenn Morris <rgm@gnu.org> | ||
| 6 | |||
| 7 | * display.texi (ImageMagick Images): General cleanup. | ||
| 8 | |||
| 1 | 2010-09-06 Alexander Klimov <alserkli@inbox.ru> (tiny change) | 9 | 2010-09-06 Alexander Klimov <alserkli@inbox.ru> (tiny change) |
| 2 | 10 | ||
| 3 | * files.texi (Directory Names): Use \` rather than ^. | 11 | * files.texi (Directory Names): Use \` rather than ^. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index a565b4dd6ff..037c334ab88 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -4468,47 +4468,56 @@ specifying the bounding box of the PostScript image, analogous to the | |||
| 4468 | 4468 | ||
| 4469 | @node ImageMagick Images | 4469 | @node ImageMagick Images |
| 4470 | @subsection ImageMagick Images | 4470 | @subsection ImageMagick Images |
| 4471 | The Imagemagick library can be used to load many image formats in Emacs. | 4471 | @cindex ImageMagick images |
| 4472 | @cindex images, support for more formats | ||
| 4473 | |||
| 4474 | If you build Emacs with ImageMagick (@url{http://www.imagemagick.org}) | ||
| 4475 | support, you can use the ImageMagick library to load many image formats. | ||
| 4476 | |||
| 4477 | @findex imagemagick-types | ||
| 4478 | The function @code{imagemagick-types} returns a list of image file | ||
| 4479 | extensions that your installation of ImageMagick supports. To enable | ||
| 4480 | support, you must call the function @code{imagemagick-register-types}. | ||
| 4481 | |||
| 4482 | @vindex imagemagick-types-inhibit | ||
| 4483 | The variable @code{imagemagick-types-inhibit} specifies a list of | ||
| 4484 | image types that you do @emph{not} want ImageMagick to handle. There | ||
| 4485 | may be overlap between image loaders in your Emacs installation, and | ||
| 4486 | you may prefer to use a different one for a given image type (which | ||
| 4487 | @c FIXME how is this priority determined? | ||
| 4488 | loader will be used in practice depends on the priority of the loaders). | ||
| 4489 | @c FIXME why are these uppercase when image-types is lower-case? | ||
| 4490 | @c FIXME what are the possibe options? Are these actually file extensions? | ||
| 4491 | For example, if you never want to use the ImageMagick loader to use | ||
| 4492 | JPEG files, add @code{JPG} to this list. | ||
| 4493 | |||
| 4494 | @vindex imagemagick-render-type | ||
| 4495 | You can set the variable @code{imagemagick-render-type} to choose | ||
| 4496 | between screen render methods for the ImageMagick loader. The options | ||
| 4497 | are: @code{0}, a conservative method which works with older | ||
| 4498 | @c FIXME details of this "newer method"? | ||
| 4499 | @c Presumably it is faster but may be less "robust"? | ||
| 4500 | ImageMagick versions (it is a bit slow, but robust); and @code{1}, | ||
| 4501 | a newer ImageMagick method. | ||
| 4502 | |||
| 4503 | Images loaded with ImageMagick support a few new display specifications: | ||
| 4472 | 4504 | ||
| 4473 | The function (imagemagick-types) returns a list of image file | 4505 | @table @code |
| 4474 | extensions that your installation of imagemagick supports. | 4506 | @item :width, :height |
| 4475 | 4507 | The @code{:width} and @code{:height} keywords are used for scaling the | |
| 4476 | The function (imagemagick-register-types) will enable the imagemagick | 4508 | image. If only one of them is specified, the other one will be |
| 4477 | support for the extensions in imagemagick-types minus the types listed | 4509 | calculated so as to preserve the aspect ratio. If both are specified, |
| 4478 | in imagemagick-types-inhibit. | 4510 | aspect ratio may not be preserved. |
| 4479 | 4511 | ||
| 4480 | imagemagick-types-inhibit has the value '(C HTML HTM TXT PDF) by | 4512 | @item :rotation |
| 4481 | default. There can be overlap between image loaders in your Emacs | 4513 | Specifies a rotation angle in degrees. |
| 4482 | installation. If you never want to use the ImageMagick loader to use | 4514 | |
| 4483 | Jpeg files, for instance, add 'JPG to imagemagick-types-inhibit. Which | 4515 | @item :index |
| 4484 | loader that will be used in practice depends on the priority of the | 4516 | Specifies which image to view inside an image bundle file format, such |
| 4485 | loaders. | 4517 | as TIFF or DJVM. You can use the @code{image-metadata} function to |
| 4486 | 4518 | retrieve the total number of images in an image bundle (this is | |
| 4487 | imagemagick-render-type is a new variable which can be set to choose | 4519 | similar to how GIF files work). |
| 4488 | between screen render methods for the ImageMagick loader. | 4520 | @end table |
| 4489 | |||
| 4490 | - 0 is a conservative metod which works with older ImageMagick | ||
| 4491 | versions. It is a bit slow, but robust. | ||
| 4492 | |||
| 4493 | - 1 utilizes a newer ImageMagick method | ||
| 4494 | |||
| 4495 | |||
| 4496 | Images loaded with imagemagick will support a couple of new display | ||
| 4497 | specification behaviours: | ||
| 4498 | |||
| 4499 | - if the :width and :height keywords are specified, these values are | ||
| 4500 | used for scaling the image. If only one of :width or :height is | ||
| 4501 | specified, the other one will be calculated so as to preserve the | ||
| 4502 | aspect ratio.If both :width and :height are specified, aspect ratio | ||
| 4503 | will not be preserved. | ||
| 4504 | |||
| 4505 | - :rotation specifies a rotation angle in degrees. | ||
| 4506 | |||
| 4507 | - :index specifies which image inside an image bundle file format, such | ||
| 4508 | as TIFF or DJVM, to view. | ||
| 4509 | |||
| 4510 | The image-metadata function can be used to retrieve the total number | ||
| 4511 | of images in an image bundle. This is simmilar to how GIF files work. | ||
| 4512 | 4521 | ||
| 4513 | 4522 | ||
| 4514 | @node Other Image Types | 4523 | @node Other Image Types |
diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index 9add9b76e79..a608db16f89 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi | |||
| @@ -292,19 +292,21 @@ identifying them as generic string delimiters. | |||
| 292 | @cindex syntax flags | 292 | @cindex syntax flags |
| 293 | 293 | ||
| 294 | In addition to the classes, entries for characters in a syntax table | 294 | In addition to the classes, entries for characters in a syntax table |
| 295 | can specify flags. There are seven possible flags, represented by the | 295 | can specify flags. There are eight possible flags, represented by the |
| 296 | characters @samp{1}, @samp{2}, @samp{3}, @samp{4}, @samp{b}, @samp{n}, | 296 | characters @samp{1}, @samp{2}, @samp{3}, @samp{4}, @samp{b}, @samp{c}, |
| 297 | and @samp{p}. | 297 | @samp{n}, and @samp{p}. |
| 298 | 298 | ||
| 299 | All the flags except @samp{n} and @samp{p} are used to describe | 299 | All the flags except @samp{p} are used to describe comment |
| 300 | multi-character comment delimiters. The digit flags indicate that a | 300 | delimiters. The digit flags are used for comment delimiters made up |
| 301 | character can @emph{also} be part of a comment sequence, in addition to | 301 | of 2 characters. They indicate that a character can @emph{also} be |
| 302 | the syntactic properties associated with its character class. The flags | 302 | part of a comment sequence, in addition to the syntactic properties |
| 303 | are independent of the class and each other for the sake of characters | 303 | associated with its character class. The flags are independent of the |
| 304 | such as @samp{*} in C mode, which is a punctuation character, @emph{and} | 304 | class and each other for the sake of characters such as @samp{*} in |
| 305 | the second character of a start-of-comment sequence (@samp{/*}), | 305 | C mode, which is a punctuation character, @emph{and} the second |
| 306 | @emph{and} the first character of an end-of-comment sequence | 306 | character of a start-of-comment sequence (@samp{/*}), @emph{and} the |
| 307 | (@samp{*/}). | 307 | first character of an end-of-comment sequence (@samp{*/}). The flags |
| 308 | @samp{b}, @samp{c}, and @samp{n} are used to qualify the corresponding | ||
| 309 | comment delimiter. | ||
| 308 | 310 | ||
| 309 | Here is a table of the possible flags for a character @var{c}, | 311 | Here is a table of the possible flags for a character @var{c}, |
| 310 | and what they mean: | 312 | and what they mean: |
| @@ -325,63 +327,62 @@ sequence. | |||
| 325 | @samp{4} means @var{c} is the second character of such a sequence. | 327 | @samp{4} means @var{c} is the second character of such a sequence. |
| 326 | 328 | ||
| 327 | @item | 329 | @item |
| 328 | @c Emacs 19 feature | ||
| 329 | @samp{b} means that @var{c} as a comment delimiter belongs to the | 330 | @samp{b} means that @var{c} as a comment delimiter belongs to the |
| 330 | alternative ``b'' comment style. | 331 | alternative ``b'' comment style. For a two-character comment starter, |
| 332 | this flag is only significant on the second char, and for a 2-character | ||
| 333 | comment ender it is only significant on the first char. | ||
| 331 | 334 | ||
| 332 | Emacs supports two comment styles simultaneously in any one syntax | 335 | @item |
| 333 | table. This is for the sake of C++. Each style of comment syntax has | 336 | @samp{c} means that @var{c} as a comment delimiter belongs to the |
| 334 | its own comment-start sequence and its own comment-end sequence. Each | 337 | alternative ``c'' comment style. For a two-character comment |
| 335 | comment must stick to one style or the other; thus, if it starts with | 338 | delimiter, @samp{c} on either character makes it of style ``c''. |
| 336 | the comment-start sequence of style ``b,'' it must also end with the | ||
| 337 | comment-end sequence of style ``b.'' | ||
| 338 | 339 | ||
| 339 | The two comment-start sequences must begin with the same character; only | 340 | @item |
| 340 | the second character may differ. Mark the second character of the | 341 | @samp{n} on a comment delimiter character specifies |
| 341 | ``b''-style comment-start sequence with the @samp{b} flag. | 342 | that this kind of comment can be nested. For a two-character |
| 343 | comment delimiter, @samp{n} on either character makes it | ||
| 344 | nestable. | ||
| 342 | 345 | ||
| 343 | A comment-end sequence (one or two characters) applies to the ``b'' | 346 | Emacs supports several comment styles simultaneously in any one syntax |
| 344 | style if its first character has the @samp{b} flag set; otherwise, it | 347 | table. A comment style is a set of flags @samp{b}, @samp{c}, and |
| 345 | applies to the ``a'' style. | 348 | @samp{n}, so there can be up to 8 different comment styles. |
| 349 | Each comment delimiter has a style and only matches comment delimiters | ||
| 350 | of the same style. Thus if a comment starts with the comment-start | ||
| 351 | sequence of style ``bn'', it will extend until the next matching | ||
| 352 | comment-end sequence of style ``bn''. | ||
| 346 | 353 | ||
| 347 | The appropriate comment syntax settings for C++ are as follows: | 354 | The appropriate comment syntax settings for C++ can be as follows: |
| 348 | 355 | ||
| 349 | @table @asis | 356 | @table @asis |
| 350 | @item @samp{/} | 357 | @item @samp{/} |
| 351 | @samp{124b} | 358 | @samp{124} |
| 352 | @item @samp{*} | 359 | @item @samp{*} |
| 353 | @samp{23} | 360 | @samp{23b} |
| 354 | @item newline | 361 | @item newline |
| 355 | @samp{>b} | 362 | @samp{>} |
| 356 | @end table | 363 | @end table |
| 357 | 364 | ||
| 358 | This defines four comment-delimiting sequences: | 365 | This defines four comment-delimiting sequences: |
| 359 | 366 | ||
| 360 | @table @asis | 367 | @table @asis |
| 361 | @item @samp{/*} | 368 | @item @samp{/*} |
| 362 | This is a comment-start sequence for ``a'' style because the | 369 | This is a comment-start sequence for ``b'' style because the |
| 363 | second character, @samp{*}, does not have the @samp{b} flag. | 370 | second character, @samp{*}, has the @samp{b} flag. |
| 364 | 371 | ||
| 365 | @item @samp{//} | 372 | @item @samp{//} |
| 366 | This is a comment-start sequence for ``b'' style because the second | 373 | This is a comment-start sequence for ``a'' style because the second |
| 367 | character, @samp{/}, does have the @samp{b} flag. | 374 | character, @samp{/}, does not have the @samp{b} flag. |
| 368 | 375 | ||
| 369 | @item @samp{*/} | 376 | @item @samp{*/} |
| 370 | This is a comment-end sequence for ``a'' style because the first | 377 | This is a comment-end sequence for ``b'' style because the first |
| 371 | character, @samp{*}, does not have the @samp{b} flag. | 378 | character, @samp{*}, does have the @samp{b} flag. |
| 372 | 379 | ||
| 373 | @item newline | 380 | @item newline |
| 374 | This is a comment-end sequence for ``b'' style, because the newline | 381 | This is a comment-end sequence for ``a'' style, because the newline |
| 375 | character has the @samp{b} flag. | 382 | character does not have the @samp{b} flag. |
| 376 | @end table | 383 | @end table |
| 377 | 384 | ||
| 378 | @item | 385 | @item |
| 379 | @samp{n} on a comment delimiter character specifies | ||
| 380 | that this kind of comment can be nested. For a two-character | ||
| 381 | comment delimiter, @samp{n} on either character makes it | ||
| 382 | nestable. | ||
| 383 | |||
| 384 | @item | ||
| 385 | @c Emacs 19 feature | 386 | @c Emacs 19 feature |
| 386 | @samp{p} identifies an additional ``prefix character'' for Lisp syntax. | 387 | @samp{p} identifies an additional ``prefix character'' for Lisp syntax. |
| 387 | These characters are treated as whitespace when they appear between | 388 | These characters are treated as whitespace when they appear between |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 142a071f494..ff4e65d299f 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -59,6 +59,7 @@ the character after point. | |||
| 59 | position stored in a register. | 59 | position stored in a register. |
| 60 | * Base 64:: Conversion to or from base 64 encoding. | 60 | * Base 64:: Conversion to or from base 64 encoding. |
| 61 | * MD5 Checksum:: Compute the MD5 "message digest"/"checksum". | 61 | * MD5 Checksum:: Compute the MD5 "message digest"/"checksum". |
| 62 | * Parsing HTML:: Parsing HTML and XML. | ||
| 62 | * Atomic Changes:: Installing several buffer changes "atomically". | 63 | * Atomic Changes:: Installing several buffer changes "atomically". |
| 63 | * Change Hooks:: Supplying functions to be run when text is changed. | 64 | * Change Hooks:: Supplying functions to be run when text is changed. |
| 64 | @end menu | 65 | @end menu |
| @@ -4106,6 +4107,49 @@ using the specified or chosen coding system. However, if | |||
| 4106 | coding instead. | 4107 | coding instead. |
| 4107 | @end defun | 4108 | @end defun |
| 4108 | 4109 | ||
| 4110 | @node Parsing HTML | ||
| 4111 | @section Parsing HTML | ||
| 4112 | @cindex parsing html | ||
| 4113 | @cindex parsing xml | ||
| 4114 | |||
| 4115 | Emacs provides an interface to the @code{libxml2} library via two | ||
| 4116 | functions: @code{html-parse-buffer} and @code{xml-parse-buffer}. The | ||
| 4117 | HTML function will parse ``real world'' HTML and try to return a | ||
| 4118 | sensible parse tree, while the XML function is somewhat stricter about | ||
| 4119 | syntax. | ||
| 4120 | |||
| 4121 | They both take a two optional parameter. The first is a buffer, and | ||
| 4122 | the second is a base URL to be used to expand relative URLs in the | ||
| 4123 | document, if any. | ||
| 4124 | |||
| 4125 | Here's an example demonstrating the structure of the parsed data you | ||
| 4126 | get out. Given this HTML document: | ||
| 4127 | |||
| 4128 | @example | ||
| 4129 | <html><hEad></head><body width=101><div class=thing>Foo<div>Yes | ||
| 4130 | @end example | ||
| 4131 | |||
| 4132 | You get this parse tree: | ||
| 4133 | |||
| 4134 | @example | ||
| 4135 | (html | ||
| 4136 | (head) | ||
| 4137 | (body | ||
| 4138 | (:width . "101") | ||
| 4139 | (div | ||
| 4140 | (:class . "thing") | ||
| 4141 | (text . "Foo") | ||
| 4142 | (div | ||
| 4143 | (text . "Yes\n"))))) | ||
| 4144 | @end example | ||
| 4145 | |||
| 4146 | It's a simple tree structure, where the @code{car} for each node is | ||
| 4147 | the name of the node, and the @code{cdr} is the value, or the list of | ||
| 4148 | values. | ||
| 4149 | |||
| 4150 | Attributes are coded the same way as child nodes, but with @samp{:} as | ||
| 4151 | the first character. | ||
| 4152 | |||
| 4109 | @node Atomic Changes | 4153 | @node Atomic Changes |
| 4110 | @section Atomic Change Groups | 4154 | @section Atomic Change Groups |
| 4111 | @cindex atomic changes | 4155 | @cindex atomic changes |
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 3c2a1f4169a..d8346259c6f 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,19 @@ | |||
| 1 | 2010-09-13 Michael Albinus <michael.albinus@gmx.de> | ||
| 2 | |||
| 3 | * tramp.texi (Inline methods): Remove "ssh1_old", "ssh2_old" and | ||
| 4 | "fish" methods. | ||
| 5 | (External methods): Remove "scp1_old" and "scp2_old" methods. | ||
| 6 | |||
| 7 | 2010-09-09 Michael Albinus <michael.albinus@gmx.de> | ||
| 8 | |||
| 9 | * tramp.texi: Remove Japanese manual. Fix typo. | ||
| 10 | |||
| 11 | * trampver.texi: Update release number. Remove japanesemanual. | ||
| 12 | |||
| 13 | 2010-09-09 Glenn Morris <rgm@gnu.org> | ||
| 14 | |||
| 15 | * org.texi: Restore clobbered changes (copyright years, untabify). | ||
| 16 | |||
| 1 | 2010-09-04 Julien Danjou <julien@danjou.info> (tiny change) | 17 | 2010-09-04 Julien Danjou <julien@danjou.info> (tiny change) |
| 2 | 18 | ||
| 3 | * gnus.texi (Adaptive Scoring): Fix typo. | 19 | * gnus.texi (Adaptive Scoring): Fix typo. |
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 9074f171e4b..97b8d3ebc03 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -51,7 +51,8 @@ e.g., | |||
| 51 | @copying | 51 | @copying |
| 52 | This manual is for Org version @value{VERSION}. | 52 | This manual is for Org version @value{VERSION}. |
| 53 | 53 | ||
| 54 | Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation | 54 | Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
| 55 | Free Software Foundation, Inc. | ||
| 55 | 56 | ||
| 56 | @quotation | 57 | @quotation |
| 57 | Permission is granted to copy, distribute and/or modify this document | 58 | Permission is granted to copy, distribute and/or modify this document |
| @@ -101,400 +102,400 @@ with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, | |||
| 101 | @end ifnottex | 102 | @end ifnottex |
| 102 | 103 | ||
| 103 | @menu | 104 | @menu |
| 104 | * Introduction:: Getting started | 105 | * Introduction:: Getting started |
| 105 | * Document Structure:: A tree works like your brain | 106 | * Document Structure:: A tree works like your brain |
| 106 | * Tables:: Pure magic for quick formatting | 107 | * Tables:: Pure magic for quick formatting |
| 107 | * Hyperlinks:: Notes in context | 108 | * Hyperlinks:: Notes in context |
| 108 | * TODO Items:: Every tree branch can be a TODO item | 109 | * TODO Items:: Every tree branch can be a TODO item |
| 109 | * Tags:: Tagging headlines and matching sets of tags | 110 | * Tags:: Tagging headlines and matching sets of tags |
| 110 | * Properties and Columns:: Storing information about an entry | 111 | * Properties and Columns:: Storing information about an entry |
| 111 | * Dates and Times:: Making items useful for planning | 112 | * Dates and Times:: Making items useful for planning |
| 112 | * Capture - Refile - Archive:: The ins and outs for projects | 113 | * Capture - Refile - Archive:: The ins and outs for projects |
| 113 | * Agenda Views:: Collecting information into views | 114 | * Agenda Views:: Collecting information into views |
| 114 | * Markup:: Prepare text for rich export | 115 | * Markup:: Prepare text for rich export |
| 115 | * Exporting:: Sharing and publishing of notes | 116 | * Exporting:: Sharing and publishing of notes |
| 116 | * Publishing:: Create a web site of linked Org files | 117 | * Publishing:: Create a web site of linked Org files |
| 117 | * Working With Source Code:: Export, evaluate, and tangle code blocks | 118 | * Working With Source Code:: Export, evaluate, and tangle code blocks |
| 118 | * Miscellaneous:: All the rest which did not fit elsewhere | 119 | * Miscellaneous:: All the rest which did not fit elsewhere |
| 119 | * Hacking:: How to hack your way around | 120 | * Hacking:: How to hack your way around |
| 120 | * MobileOrg:: Viewing and capture on a mobile device | 121 | * MobileOrg:: Viewing and capture on a mobile device |
| 121 | * History and Acknowledgments:: How Org came into being | 122 | * History and Acknowledgments:: How Org came into being |
| 122 | * Main Index:: An index of Org's concepts and features | 123 | * Main Index:: An index of Org's concepts and features |
| 123 | * Key Index:: Key bindings and where they are described | 124 | * Key Index:: Key bindings and where they are described |
| 124 | * Variable Index:: Variables mentioned in the manual | 125 | * Variable Index:: Variables mentioned in the manual |
| 125 | 126 | ||
| 126 | @detailmenu | 127 | @detailmenu |
| 127 | --- The Detailed Node Listing --- | 128 | --- The Detailed Node Listing --- |
| 128 | 129 | ||
| 129 | Introduction | 130 | Introduction |
| 130 | 131 | ||
| 131 | * Summary:: Brief summary of what Org does | 132 | * Summary:: Brief summary of what Org does |
| 132 | * Installation:: How to install a downloaded version of Org | 133 | * Installation:: How to install a downloaded version of Org |
| 133 | * Activation:: How to activate Org for certain buffers | 134 | * Activation:: How to activate Org for certain buffers |
| 134 | * Feedback:: Bug reports, ideas, patches etc. | 135 | * Feedback:: Bug reports, ideas, patches etc. |
| 135 | * Conventions:: Type-setting conventions in the manual | 136 | * Conventions:: Type-setting conventions in the manual |
| 136 | 137 | ||
| 137 | Document structure | 138 | Document structure |
| 138 | 139 | ||
| 139 | * Outlines:: Org is based on Outline mode | 140 | * Outlines:: Org is based on Outline mode |
| 140 | * Headlines:: How to typeset Org tree headlines | 141 | * Headlines:: How to typeset Org tree headlines |
| 141 | * Visibility cycling:: Show and hide, much simplified | 142 | * Visibility cycling:: Show and hide, much simplified |
| 142 | * Motion:: Jumping to other headlines | 143 | * Motion:: Jumping to other headlines |
| 143 | * Structure editing:: Changing sequence and level of headlines | 144 | * Structure editing:: Changing sequence and level of headlines |
| 144 | * Sparse trees:: Matches embedded in context | 145 | * Sparse trees:: Matches embedded in context |
| 145 | * Plain lists:: Additional structure within an entry | 146 | * Plain lists:: Additional structure within an entry |
| 146 | * Drawers:: Tucking stuff away | 147 | * Drawers:: Tucking stuff away |
| 147 | * Blocks:: Folding blocks | 148 | * Blocks:: Folding blocks |
| 148 | * Footnotes:: How footnotes are defined in Org's syntax | 149 | * Footnotes:: How footnotes are defined in Org's syntax |
| 149 | * Orgstruct mode:: Structure editing outside Org | 150 | * Orgstruct mode:: Structure editing outside Org |
| 150 | 151 | ||
| 151 | Tables | 152 | Tables |
| 152 | 153 | ||
| 153 | * Built-in table editor:: Simple tables | 154 | * Built-in table editor:: Simple tables |
| 154 | * Column width and alignment:: Overrule the automatic settings | 155 | * Column width and alignment:: Overrule the automatic settings |
| 155 | * Column groups:: Grouping to trigger vertical lines | 156 | * Column groups:: Grouping to trigger vertical lines |
| 156 | * Orgtbl mode:: The table editor as minor mode | 157 | * Orgtbl mode:: The table editor as minor mode |
| 157 | * The spreadsheet:: The table editor has spreadsheet capabilities | 158 | * The spreadsheet:: The table editor has spreadsheet capabilities |
| 158 | * Org-Plot:: Plotting from org tables | 159 | * Org-Plot:: Plotting from org tables |
| 159 | 160 | ||
| 160 | The spreadsheet | 161 | The spreadsheet |
| 161 | 162 | ||
| 162 | * References:: How to refer to another field or range | 163 | * References:: How to refer to another field or range |
| 163 | * Formula syntax for Calc:: Using Calc to compute stuff | 164 | * Formula syntax for Calc:: Using Calc to compute stuff |
| 164 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | 165 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp |
| 165 | * Field formulas:: Formulas valid for a single field | 166 | * Field formulas:: Formulas valid for a single field |
| 166 | * Column formulas:: Formulas valid for an entire column | 167 | * Column formulas:: Formulas valid for an entire column |
| 167 | * Editing and debugging formulas:: Fixing formulas | 168 | * Editing and debugging formulas:: Fixing formulas |
| 168 | * Updating the table:: Recomputing all dependent fields | 169 | * Updating the table:: Recomputing all dependent fields |
| 169 | * Advanced features:: Field names, parameters and automatic recalc | 170 | * Advanced features:: Field names, parameters and automatic recalc |
| 170 | 171 | ||
| 171 | Hyperlinks | 172 | Hyperlinks |
| 172 | 173 | ||
| 173 | * Link format:: How links in Org are formatted | 174 | * Link format:: How links in Org are formatted |
| 174 | * Internal links:: Links to other places in the current file | 175 | * Internal links:: Links to other places in the current file |
| 175 | * External links:: URL-like links to the world | 176 | * External links:: URL-like links to the world |
| 176 | * Handling links:: Creating, inserting and following | 177 | * Handling links:: Creating, inserting and following |
| 177 | * Using links outside Org:: Linking from my C source code? | 178 | * Using links outside Org:: Linking from my C source code? |
| 178 | * Link abbreviations:: Shortcuts for writing complex links | 179 | * Link abbreviations:: Shortcuts for writing complex links |
| 179 | * Search options:: Linking to a specific location | 180 | * Search options:: Linking to a specific location |
| 180 | * Custom searches:: When the default search is not enough | 181 | * Custom searches:: When the default search is not enough |
| 181 | 182 | ||
| 182 | Internal links | 183 | Internal links |
| 183 | 184 | ||
| 184 | * Radio targets:: Make targets trigger links in plain text | 185 | * Radio targets:: Make targets trigger links in plain text |
| 185 | 186 | ||
| 186 | TODO items | 187 | TODO items |
| 187 | 188 | ||
| 188 | * TODO basics:: Marking and displaying TODO entries | 189 | * TODO basics:: Marking and displaying TODO entries |
| 189 | * TODO extensions:: Workflow and assignments | 190 | * TODO extensions:: Workflow and assignments |
| 190 | * Progress logging:: Dates and notes for progress | 191 | * Progress logging:: Dates and notes for progress |
| 191 | * Priorities:: Some things are more important than others | 192 | * Priorities:: Some things are more important than others |
| 192 | * Breaking down tasks:: Splitting a task into manageable pieces | 193 | * Breaking down tasks:: Splitting a task into manageable pieces |
| 193 | * Checkboxes:: Tick-off lists | 194 | * Checkboxes:: Tick-off lists |
| 194 | 195 | ||
| 195 | Extended use of TODO keywords | 196 | Extended use of TODO keywords |
| 196 | 197 | ||
| 197 | * Workflow states:: From TODO to DONE in steps | 198 | * Workflow states:: From TODO to DONE in steps |
| 198 | * TODO types:: I do this, Fred does the rest | 199 | * TODO types:: I do this, Fred does the rest |
| 199 | * Multiple sets in one file:: Mixing it all, and still finding your way | 200 | * Multiple sets in one file:: Mixing it all, and still finding your way |
| 200 | * Fast access to TODO states:: Single letter selection of a state | 201 | * Fast access to TODO states:: Single letter selection of a state |
| 201 | * Per-file keywords:: Different files, different requirements | 202 | * Per-file keywords:: Different files, different requirements |
| 202 | * Faces for TODO keywords:: Highlighting states | 203 | * Faces for TODO keywords:: Highlighting states |
| 203 | * TODO dependencies:: When one task needs to wait for others | 204 | * TODO dependencies:: When one task needs to wait for others |
| 204 | 205 | ||
| 205 | Progress logging | 206 | Progress logging |
| 206 | 207 | ||
| 207 | * Closing items:: When was this entry marked DONE? | 208 | * Closing items:: When was this entry marked DONE? |
| 208 | * Tracking TODO state changes:: When did the status change? | 209 | * Tracking TODO state changes:: When did the status change? |
| 209 | * Tracking your habits:: How consistent have you been? | 210 | * Tracking your habits:: How consistent have you been? |
| 210 | 211 | ||
| 211 | Tags | 212 | Tags |
| 212 | 213 | ||
| 213 | * Tag inheritance:: Tags use the tree structure of the outline | 214 | * Tag inheritance:: Tags use the tree structure of the outline |
| 214 | * Setting tags:: How to assign tags to a headline | 215 | * Setting tags:: How to assign tags to a headline |
| 215 | * Tag searches:: Searching for combinations of tags | 216 | * Tag searches:: Searching for combinations of tags |
| 216 | 217 | ||
| 217 | Properties and columns | 218 | Properties and columns |
| 218 | 219 | ||
| 219 | * Property syntax:: How properties are spelled out | 220 | * Property syntax:: How properties are spelled out |
| 220 | * Special properties:: Access to other Org-mode features | 221 | * Special properties:: Access to other Org-mode features |
| 221 | * Property searches:: Matching property values | 222 | * Property searches:: Matching property values |
| 222 | * Property inheritance:: Passing values down the tree | 223 | * Property inheritance:: Passing values down the tree |
| 223 | * Column view:: Tabular viewing and editing | 224 | * Column view:: Tabular viewing and editing |
| 224 | * Property API:: Properties for Lisp programmers | 225 | * Property API:: Properties for Lisp programmers |
| 225 | 226 | ||
| 226 | Column view | 227 | Column view |
| 227 | 228 | ||
| 228 | * Defining columns:: The COLUMNS format property | 229 | * Defining columns:: The COLUMNS format property |
| 229 | * Using column view:: How to create and use column view | 230 | * Using column view:: How to create and use column view |
| 230 | * Capturing column view:: A dynamic block for column view | 231 | * Capturing column view:: A dynamic block for column view |
| 231 | 232 | ||
| 232 | Defining columns | 233 | Defining columns |
| 233 | 234 | ||
| 234 | * Scope of column definitions:: Where defined, where valid? | 235 | * Scope of column definitions:: Where defined, where valid? |
| 235 | * Column attributes:: Appearance and content of a column | 236 | * Column attributes:: Appearance and content of a column |
| 236 | 237 | ||
| 237 | Dates and times | 238 | Dates and times |
| 238 | 239 | ||
| 239 | * Timestamps:: Assigning a time to a tree entry | 240 | * Timestamps:: Assigning a time to a tree entry |
| 240 | * Creating timestamps:: Commands which insert timestamps | 241 | * Creating timestamps:: Commands which insert timestamps |
| 241 | * Deadlines and scheduling:: Planning your work | 242 | * Deadlines and scheduling:: Planning your work |
| 242 | * Clocking work time:: Tracking how long you spend on a task | 243 | * Clocking work time:: Tracking how long you spend on a task |
| 243 | * Resolving idle time:: Resolving time if you've been idle | 244 | * Resolving idle time:: Resolving time if you've been idle |
| 244 | * Effort estimates:: Planning work effort in advance | 245 | * Effort estimates:: Planning work effort in advance |
| 245 | * Relative timer:: Notes with a running timer | 246 | * Relative timer:: Notes with a running timer |
| 246 | 247 | ||
| 247 | Creating timestamps | 248 | Creating timestamps |
| 248 | 249 | ||
| 249 | * The date/time prompt:: How Org-mode helps you entering date and time | 250 | * The date/time prompt:: How Org-mode helps you entering date and time |
| 250 | * Custom time format:: Making dates look different | 251 | * Custom time format:: Making dates look different |
| 251 | 252 | ||
| 252 | Deadlines and scheduling | 253 | Deadlines and scheduling |
| 253 | 254 | ||
| 254 | * Inserting deadline/schedule:: Planning items | 255 | * Inserting deadline/schedule:: Planning items |
| 255 | * Repeated tasks:: Items that show up again and again | 256 | * Repeated tasks:: Items that show up again and again |
| 256 | 257 | ||
| 257 | Capture - Refile - Archive | 258 | Capture - Refile - Archive |
| 258 | 259 | ||
| 259 | * Capture:: Capturing new stuff | 260 | * Capture:: Capturing new stuff |
| 260 | * Attachments:: Add files to tasks | 261 | * Attachments:: Add files to tasks |
| 261 | * RSS Feeds:: Getting input from RSS feeds | 262 | * RSS Feeds:: Getting input from RSS feeds |
| 262 | * Protocols:: External (e.g. Browser) access to Emacs and Org | 263 | * Protocols:: External (e.g. Browser) access to Emacs and Org |
| 263 | * Refiling notes:: Moving a tree from one place to another | 264 | * Refiling notes:: Moving a tree from one place to another |
| 264 | * Archiving:: What to do with finished projects | 265 | * Archiving:: What to do with finished projects |
| 265 | 266 | ||
| 266 | Capture | 267 | Capture |
| 267 | 268 | ||
| 268 | * Setting up capture:: Where notes will be stored | 269 | * Setting up capture:: Where notes will be stored |
| 269 | * Using capture:: Commands to invoke and terminate capture | 270 | * Using capture:: Commands to invoke and terminate capture |
| 270 | * Capture templates:: Define the outline of different note types | 271 | * Capture templates:: Define the outline of different note types |
| 271 | 272 | ||
| 272 | Capture templates | 273 | Capture templates |
| 273 | 274 | ||
| 274 | * Template elements:: What is needed for a complete template entry | 275 | * Template elements:: What is needed for a complete template entry |
| 275 | * Template expansion:: Filling in information about time and context | 276 | * Template expansion:: Filling in information about time and context |
| 276 | 277 | ||
| 277 | Archiving | 278 | Archiving |
| 278 | 279 | ||
| 279 | * Moving subtrees:: Moving a tree to an archive file | 280 | * Moving subtrees:: Moving a tree to an archive file |
| 280 | * Internal archiving:: Switch off a tree but keep it in the file | 281 | * Internal archiving:: Switch off a tree but keep it in the file |
| 281 | 282 | ||
| 282 | Agenda views | 283 | Agenda views |
| 283 | 284 | ||
| 284 | * Agenda files:: Files being searched for agenda information | 285 | * Agenda files:: Files being searched for agenda information |
| 285 | * Agenda dispatcher:: Keyboard access to agenda views | 286 | * Agenda dispatcher:: Keyboard access to agenda views |
| 286 | * Built-in agenda views:: What is available out of the box? | 287 | * Built-in agenda views:: What is available out of the box? |
| 287 | * Presentation and sorting:: How agenda items are prepared for display | 288 | * Presentation and sorting:: How agenda items are prepared for display |
| 288 | * Agenda commands:: Remote editing of Org trees | 289 | * Agenda commands:: Remote editing of Org trees |
| 289 | * Custom agenda views:: Defining special searches and views | 290 | * Custom agenda views:: Defining special searches and views |
| 290 | * Exporting Agenda Views:: Writing a view to a file | 291 | * Exporting Agenda Views:: Writing a view to a file |
| 291 | * Agenda column view:: Using column view for collected entries | 292 | * Agenda column view:: Using column view for collected entries |
| 292 | 293 | ||
| 293 | The built-in agenda views | 294 | The built-in agenda views |
| 294 | 295 | ||
| 295 | * Weekly/daily agenda:: The calendar page with current tasks | 296 | * Weekly/daily agenda:: The calendar page with current tasks |
| 296 | * Global TODO list:: All unfinished action items | 297 | * Global TODO list:: All unfinished action items |
| 297 | * Matching tags and properties:: Structured information with fine-tuned search | 298 | * Matching tags and properties:: Structured information with fine-tuned search |
| 298 | * Timeline:: Time-sorted view for single file | 299 | * Timeline:: Time-sorted view for single file |
| 299 | * Search view:: Find entries by searching for text | 300 | * Search view:: Find entries by searching for text |
| 300 | * Stuck projects:: Find projects you need to review | 301 | * Stuck projects:: Find projects you need to review |
| 301 | 302 | ||
| 302 | Presentation and sorting | 303 | Presentation and sorting |
| 303 | 304 | ||
| 304 | * Categories:: Not all tasks are equal | 305 | * Categories:: Not all tasks are equal |
| 305 | * Time-of-day specifications:: How the agenda knows the time | 306 | * Time-of-day specifications:: How the agenda knows the time |
| 306 | * Sorting of agenda items:: The order of things | 307 | * Sorting of agenda items:: The order of things |
| 307 | 308 | ||
| 308 | Custom agenda views | 309 | Custom agenda views |
| 309 | 310 | ||
| 310 | * Storing searches:: Type once, use often | 311 | * Storing searches:: Type once, use often |
| 311 | * Block agenda:: All the stuff you need in a single buffer | 312 | * Block agenda:: All the stuff you need in a single buffer |
| 312 | * Setting Options:: Changing the rules | 313 | * Setting Options:: Changing the rules |
| 313 | 314 | ||
| 314 | Markup for rich export | 315 | Markup for rich export |
| 315 | 316 | ||
| 316 | * Structural markup elements:: The basic structure as seen by the exporter | 317 | * Structural markup elements:: The basic structure as seen by the exporter |
| 317 | * Images and tables:: Tables and Images will be included | 318 | * Images and tables:: Tables and Images will be included |
| 318 | * Literal examples:: Source code examples with special formatting | 319 | * Literal examples:: Source code examples with special formatting |
| 319 | * Include files:: Include additional files into a document | 320 | * Include files:: Include additional files into a document |
| 320 | * Index entries:: Making an index | 321 | * Index entries:: Making an index |
| 321 | * Macro replacement:: Use macros to create complex output | 322 | * Macro replacement:: Use macros to create complex output |
| 322 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents | 323 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents |
| 323 | 324 | ||
| 324 | Structural markup elements | 325 | Structural markup elements |
| 325 | 326 | ||
| 326 | * Document title:: Where the title is taken from | 327 | * Document title:: Where the title is taken from |
| 327 | * Headings and sections:: The document structure as seen by the exporter | 328 | * Headings and sections:: The document structure as seen by the exporter |
| 328 | * Table of contents:: The if and where of the table of contents | 329 | * Table of contents:: The if and where of the table of contents |
| 329 | * Initial text:: Text before the first heading? | 330 | * Initial text:: Text before the first heading? |
| 330 | * Lists:: Lists | 331 | * Lists:: Lists |
| 331 | * Paragraphs:: Paragraphs | 332 | * Paragraphs:: Paragraphs |
| 332 | * Footnote markup:: Footnotes | 333 | * Footnote markup:: Footnotes |
| 333 | * Emphasis and monospace:: Bold, italic, etc. | 334 | * Emphasis and monospace:: Bold, italic, etc. |
| 334 | * Horizontal rules:: Make a line | 335 | * Horizontal rules:: Make a line |
| 335 | * Comment lines:: What will *not* be exported | 336 | * Comment lines:: What will *not* be exported |
| 336 | 337 | ||
| 337 | Embedded La@TeX{} | 338 | Embedded La@TeX{} |
| 338 | 339 | ||
| 339 | * Special symbols:: Greek letters and other symbols | 340 | * Special symbols:: Greek letters and other symbols |
| 340 | * Subscripts and superscripts:: Simple syntax for raising/lowering text | 341 | * Subscripts and superscripts:: Simple syntax for raising/lowering text |
| 341 | * LaTeX fragments:: Complex formulas made easy | 342 | * LaTeX fragments:: Complex formulas made easy |
| 342 | * Previewing LaTeX fragments:: What will this snippet look like? | 343 | * Previewing LaTeX fragments:: What will this snippet look like? |
| 343 | * CDLaTeX mode:: Speed up entering of formulas | 344 | * CDLaTeX mode:: Speed up entering of formulas |
| 344 | 345 | ||
| 345 | Exporting | 346 | Exporting |
| 346 | 347 | ||
| 347 | * Selective export:: Using tags to select and exclude trees | 348 | * Selective export:: Using tags to select and exclude trees |
| 348 | * Export options:: Per-file export settings | 349 | * Export options:: Per-file export settings |
| 349 | * The export dispatcher:: How to access exporter commands | 350 | * The export dispatcher:: How to access exporter commands |
| 350 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding | 351 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding |
| 351 | * HTML export:: Exporting to HTML | 352 | * HTML export:: Exporting to HTML |
| 352 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF | 353 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF |
| 353 | * DocBook export:: Exporting to DocBook | 354 | * DocBook export:: Exporting to DocBook |
| 354 | * TaskJuggler export:: Exporting to TaskJuggler | 355 | * TaskJuggler export:: Exporting to TaskJuggler |
| 355 | * Freemind export:: Exporting to Freemind mind maps | 356 | * Freemind export:: Exporting to Freemind mind maps |
| 356 | * XOXO export:: Exporting to XOXO | 357 | * XOXO export:: Exporting to XOXO |
| 357 | * iCalendar export:: Exporting in iCalendar format | 358 | * iCalendar export:: Exporting in iCalendar format |
| 358 | 359 | ||
| 359 | HTML export | 360 | HTML export |
| 360 | 361 | ||
| 361 | * HTML Export commands:: How to invoke HTML export | 362 | * HTML Export commands:: How to invoke HTML export |
| 362 | * Quoting HTML tags:: Using direct HTML in Org-mode | 363 | * Quoting HTML tags:: Using direct HTML in Org-mode |
| 363 | * Links in HTML export:: How links will be interpreted and formatted | 364 | * Links in HTML export:: How links will be interpreted and formatted |
| 364 | * Tables in HTML export:: How to modify the formatting of tables | 365 | * Tables in HTML export:: How to modify the formatting of tables |
| 365 | * Images in HTML export:: How to insert figures into HTML output | 366 | * Images in HTML export:: How to insert figures into HTML output |
| 366 | * Text areas in HTML export:: An alternative way to show an example | 367 | * Text areas in HTML export:: An alternative way to show an example |
| 367 | * CSS support:: Changing the appearance of the output | 368 | * CSS support:: Changing the appearance of the output |
| 368 | * JavaScript support:: Info and Folding in a web browser | 369 | * JavaScript support:: Info and Folding in a web browser |
| 369 | 370 | ||
| 370 | La@TeX{} and PDF export | 371 | La@TeX{} and PDF export |
| 371 | 372 | ||
| 372 | * LaTeX/PDF export commands:: Which key invokes which commands | 373 | * LaTeX/PDF export commands:: Which key invokes which commands |
| 373 | * Header and sectioning:: Setting up the export file structure | 374 | * Header and sectioning:: Setting up the export file structure |
| 374 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code | 375 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code |
| 375 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} | 376 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} |
| 376 | * Images in LaTeX export:: How to insert figures into La@TeX{} output | 377 | * Images in LaTeX export:: How to insert figures into La@TeX{} output |
| 377 | * Beamer class export:: Turning the file into a presentation | 378 | * Beamer class export:: Turning the file into a presentation |
| 378 | 379 | ||
| 379 | DocBook export | 380 | DocBook export |
| 380 | 381 | ||
| 381 | * DocBook export commands:: How to invoke DocBook export | 382 | * DocBook export commands:: How to invoke DocBook export |
| 382 | * Quoting DocBook code:: Incorporating DocBook code in Org files | 383 | * Quoting DocBook code:: Incorporating DocBook code in Org files |
| 383 | * Recursive sections:: Recursive sections in DocBook | 384 | * Recursive sections:: Recursive sections in DocBook |
| 384 | * Tables in DocBook export:: Tables are exported as HTML tables | 385 | * Tables in DocBook export:: Tables are exported as HTML tables |
| 385 | * Images in DocBook export:: How to insert figures into DocBook output | 386 | * Images in DocBook export:: How to insert figures into DocBook output |
| 386 | * Special characters:: How to handle special characters | 387 | * Special characters:: How to handle special characters |
| 387 | 388 | ||
| 388 | Publishing | 389 | Publishing |
| 389 | 390 | ||
| 390 | * Configuration:: Defining projects | 391 | * Configuration:: Defining projects |
| 391 | * Uploading files:: How to get files up on the server | 392 | * Uploading files:: How to get files up on the server |
| 392 | * Sample configuration:: Example projects | 393 | * Sample configuration:: Example projects |
| 393 | * Triggering publication:: Publication commands | 394 | * Triggering publication:: Publication commands |
| 394 | 395 | ||
| 395 | Configuration | 396 | Configuration |
| 396 | 397 | ||
| 397 | * Project alist:: The central configuration variable | 398 | * Project alist:: The central configuration variable |
| 398 | * Sources and destinations:: From here to there | 399 | * Sources and destinations:: From here to there |
| 399 | * Selecting files:: What files are part of the project? | 400 | * Selecting files:: What files are part of the project? |
| 400 | * Publishing action:: Setting the function doing the publishing | 401 | * Publishing action:: Setting the function doing the publishing |
| 401 | * Publishing options:: Tweaking HTML export | 402 | * Publishing options:: Tweaking HTML export |
| 402 | * Publishing links:: Which links keep working after publishing? | 403 | * Publishing links:: Which links keep working after publishing? |
| 403 | * Sitemap:: Generating a list of all pages | 404 | * Sitemap:: Generating a list of all pages |
| 404 | * Generating an index:: An index that reaches across pages | 405 | * Generating an index:: An index that reaches across pages |
| 405 | 406 | ||
| 406 | Sample configuration | 407 | Sample configuration |
| 407 | 408 | ||
| 408 | * Simple example:: One-component publishing | 409 | * Simple example:: One-component publishing |
| 409 | * Complex example:: A multi-component publishing example | 410 | * Complex example:: A multi-component publishing example |
| 410 | 411 | ||
| 411 | Working with source code | 412 | Working with source code |
| 412 | 413 | ||
| 413 | * Structure of code blocks:: Code block syntax described | 414 | * Structure of code blocks:: Code block syntax described |
| 414 | * Editing source code:: Language major-mode editing | 415 | * Editing source code:: Language major-mode editing |
| 415 | * Exporting code blocks:: Export contents and/or results | 416 | * Exporting code blocks:: Export contents and/or results |
| 416 | * Extracting source code:: Create pure source code files | 417 | * Extracting source code:: Create pure source code files |
| 417 | * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer | 418 | * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer |
| 418 | * Library of Babel:: Use and contribute to a library of useful code blocks | 419 | * Library of Babel:: Use and contribute to a library of useful code blocks |
| 419 | * Languages:: List of supported code block languages | 420 | * Languages:: List of supported code block languages |
| 420 | * Header arguments:: Configure code block functionality | 421 | * Header arguments:: Configure code block functionality |
| 421 | * Results of evaluation:: How evaluation results are handled | 422 | * Results of evaluation:: How evaluation results are handled |
| 422 | * Noweb reference syntax:: Literate programming in Org-mode | 423 | * Noweb reference syntax:: Literate programming in Org-mode |
| 423 | * Key bindings and useful functions:: Work quickly with code blocks | 424 | * Key bindings and useful functions:: Work quickly with code blocks |
| 424 | * Batch execution:: Call functions from the command line | 425 | * Batch execution:: Call functions from the command line |
| 425 | 426 | ||
| 426 | Header arguments | 427 | Header arguments |
| 427 | 428 | ||
| 428 | * Using header arguments:: Different ways to set header arguments | 429 | * Using header arguments:: Different ways to set header arguments |
| 429 | * Specific header arguments:: List of header arguments | 430 | * Specific header arguments:: List of header arguments |
| 430 | 431 | ||
| 431 | Using header arguments | 432 | Using header arguments |
| 432 | 433 | ||
| 433 | * System-wide header arguments:: Set global default values | 434 | * System-wide header arguments:: Set global default values |
| 434 | * Language-specific header arguments:: Set default values by language | 435 | * Language-specific header arguments:: Set default values by language |
| 435 | * Buffer-wide header arguments:: Set default values for a specific buffer | 436 | * Buffer-wide header arguments:: Set default values for a specific buffer |
| 436 | * Header arguments in Org-mode properties:: Set default values for a buffer or heading | 437 | * Header arguments in Org-mode properties:: Set default values for a buffer or heading |
| 437 | * Code block specific header arguments:: The most common way to set values | 438 | * Code block specific header arguments:: The most common way to set values |
| 438 | 439 | ||
| 439 | Specific header arguments | 440 | Specific header arguments |
| 440 | 441 | ||
| 441 | * var:: Pass arguments to code blocks | 442 | * var:: Pass arguments to code blocks |
| 442 | * results:: Specify the type of results and how they will be collected and handled | 443 | * results:: Specify the type of results and how they will be collected and handled |
| 443 | * file:: Specify a path for file output | 444 | * file:: Specify a path for file output |
| 444 | * dir:: Specify the default directory for code block execution | 445 | * dir:: Specify the default directory for code block execution |
| 445 | * exports:: Export code and/or results | 446 | * exports:: Export code and/or results |
| 446 | * tangle:: Toggle tangling and specify file name | 447 | * tangle:: Toggle tangling and specify file name |
| 447 | * no-expand:: Turn off variable assignment and noweb expansion during tangling | 448 | * no-expand:: Turn off variable assignment and noweb expansion during tangling |
| 448 | * session:: Preserve the state of code evaluation | 449 | * session:: Preserve the state of code evaluation |
| 449 | * noweb:: Toggle expansion of noweb references | 450 | * noweb:: Toggle expansion of noweb references |
| 450 | * cache:: Avoid re-evaluating unchanged code blocks | 451 | * cache:: Avoid re-evaluating unchanged code blocks |
| 451 | * hlines:: Handle horizontal lines in tables | 452 | * hlines:: Handle horizontal lines in tables |
| 452 | * colnames:: Handle column names in tables | 453 | * colnames:: Handle column names in tables |
| 453 | * rownames:: Handle row names in tables | 454 | * rownames:: Handle row names in tables |
| 454 | * shebang:: Make tangled files executable | 455 | * shebang:: Make tangled files executable |
| 455 | 456 | ||
| 456 | Miscellaneous | 457 | Miscellaneous |
| 457 | 458 | ||
| 458 | * Completion:: M-TAB knows what you need | 459 | * Completion:: M-TAB knows what you need |
| 459 | * Speed keys:: Electric commands at the beginning of a headline | 460 | * Speed keys:: Electric commands at the beginning of a headline |
| 460 | * Code evaluation security:: Org mode files evaluate inline code | 461 | * Code evaluation security:: Org mode files evaluate inline code |
| 461 | * Customization:: Adapting Org to your taste | 462 | * Customization:: Adapting Org to your taste |
| 462 | * In-buffer settings:: Overview of the #+KEYWORDS | 463 | * In-buffer settings:: Overview of the #+KEYWORDS |
| 463 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | 464 | * The very busy C-c C-c key:: When in doubt, press C-c C-c |
| 464 | * Clean view:: Getting rid of leading stars in the outline | 465 | * Clean view:: Getting rid of leading stars in the outline |
| 465 | * TTY keys:: Using Org on a tty | 466 | * TTY keys:: Using Org on a tty |
| 466 | * Interaction:: Other Emacs packages | 467 | * Interaction:: Other Emacs packages |
| 467 | 468 | ||
| 468 | Interaction with other packages | 469 | Interaction with other packages |
| 469 | 470 | ||
| 470 | * Cooperation:: Packages Org cooperates with | 471 | * Cooperation:: Packages Org cooperates with |
| 471 | * Conflicts:: Packages that lead to conflicts | 472 | * Conflicts:: Packages that lead to conflicts |
| 472 | 473 | ||
| 473 | Hacking | 474 | Hacking |
| 474 | 475 | ||
| 475 | * Hooks:: Who to reach into Org's internals | 476 | * Hooks:: Who to reach into Org's internals |
| 476 | * Add-on packages:: Available extensions | 477 | * Add-on packages:: Available extensions |
| 477 | * Adding hyperlink types:: New custom link types | 478 | * Adding hyperlink types:: New custom link types |
| 478 | * Context-sensitive commands:: How to add functionality to such commands | 479 | * Context-sensitive commands:: How to add functionality to such commands |
| 479 | * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs | 480 | * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs |
| 480 | * Dynamic blocks:: Automatically filled blocks | 481 | * Dynamic blocks:: Automatically filled blocks |
| 481 | * Special agenda views:: Customized views | 482 | * Special agenda views:: Customized views |
| 482 | * Extracting agenda information:: Postprocessing of agenda information | 483 | * Extracting agenda information:: Postprocessing of agenda information |
| 483 | * Using the property API:: Writing programs that use entry properties | 484 | * Using the property API:: Writing programs that use entry properties |
| 484 | * Using the mapping API:: Mapping over all or selected entries | 485 | * Using the mapping API:: Mapping over all or selected entries |
| 485 | 486 | ||
| 486 | Tables and lists in arbitrary syntax | 487 | Tables and lists in arbitrary syntax |
| 487 | 488 | ||
| 488 | * Radio tables:: Sending and receiving radio tables | 489 | * Radio tables:: Sending and receiving radio tables |
| 489 | * A LaTeX example:: Step by step, almost a tutorial | 490 | * A LaTeX example:: Step by step, almost a tutorial |
| 490 | * Translator functions:: Copy and modify | 491 | * Translator functions:: Copy and modify |
| 491 | * Radio lists:: Doing the same for lists | 492 | * Radio lists:: Doing the same for lists |
| 492 | 493 | ||
| 493 | MobileOrg | 494 | MobileOrg |
| 494 | 495 | ||
| 495 | * Setting up the staging area:: Where to interact with the mobile device | 496 | * Setting up the staging area:: Where to interact with the mobile device |
| 496 | * Pushing to MobileOrg:: Uploading Org files and agendas | 497 | * Pushing to MobileOrg:: Uploading Org files and agendas |
| 497 | * Pulling from MobileOrg:: Integrating captured and flagged items | 498 | * Pulling from MobileOrg:: Integrating captured and flagged items |
| 498 | 499 | ||
| 499 | @end detailmenu | 500 | @end detailmenu |
| 500 | @end menu | 501 | @end menu |
| @@ -504,11 +505,11 @@ MobileOrg | |||
| 504 | @cindex introduction | 505 | @cindex introduction |
| 505 | 506 | ||
| 506 | @menu | 507 | @menu |
| 507 | * Summary:: Brief summary of what Org does | 508 | * Summary:: Brief summary of what Org does |
| 508 | * Installation:: How to install a downloaded version of Org | 509 | * Installation:: How to install a downloaded version of Org |
| 509 | * Activation:: How to activate Org for certain buffers | 510 | * Activation:: How to activate Org for certain buffers |
| 510 | * Feedback:: Bug reports, ideas, patches etc. | 511 | * Feedback:: Bug reports, ideas, patches etc. |
| 511 | * Conventions:: Type-setting conventions in the manual | 512 | * Conventions:: Type-setting conventions in the manual |
| 512 | @end menu | 513 | @end menu |
| 513 | 514 | ||
| 514 | @node Summary, Installation, Introduction, Introduction | 515 | @node Summary, Installation, Introduction, Introduction |
| @@ -805,17 +806,17 @@ Org is based on Outline mode and provides flexible commands to | |||
| 805 | edit the structure of the document. | 806 | edit the structure of the document. |
| 806 | 807 | ||
| 807 | @menu | 808 | @menu |
| 808 | * Outlines:: Org is based on Outline mode | 809 | * Outlines:: Org is based on Outline mode |
| 809 | * Headlines:: How to typeset Org tree headlines | 810 | * Headlines:: How to typeset Org tree headlines |
| 810 | * Visibility cycling:: Show and hide, much simplified | 811 | * Visibility cycling:: Show and hide, much simplified |
| 811 | * Motion:: Jumping to other headlines | 812 | * Motion:: Jumping to other headlines |
| 812 | * Structure editing:: Changing sequence and level of headlines | 813 | * Structure editing:: Changing sequence and level of headlines |
| 813 | * Sparse trees:: Matches embedded in context | 814 | * Sparse trees:: Matches embedded in context |
| 814 | * Plain lists:: Additional structure within an entry | 815 | * Plain lists:: Additional structure within an entry |
| 815 | * Drawers:: Tucking stuff away | 816 | * Drawers:: Tucking stuff away |
| 816 | * Blocks:: Folding blocks | 817 | * Blocks:: Folding blocks |
| 817 | * Footnotes:: How footnotes are defined in Org's syntax | 818 | * Footnotes:: How footnotes are defined in Org's syntax |
| 818 | * Orgstruct mode:: Structure editing outside Org | 819 | * Orgstruct mode:: Structure editing outside Org |
| 819 | @end menu | 820 | @end menu |
| 820 | 821 | ||
| 821 | @node Outlines, Headlines, Document Structure, Document Structure | 822 | @node Outlines, Headlines, Document Structure, Document Structure |
| @@ -1640,12 +1641,12 @@ calculator). | |||
| 1640 | @end ifnotinfo | 1641 | @end ifnotinfo |
| 1641 | 1642 | ||
| 1642 | @menu | 1643 | @menu |
| 1643 | * Built-in table editor:: Simple tables | 1644 | * Built-in table editor:: Simple tables |
| 1644 | * Column width and alignment:: Overrule the automatic settings | 1645 | * Column width and alignment:: Overrule the automatic settings |
| 1645 | * Column groups:: Grouping to trigger vertical lines | 1646 | * Column groups:: Grouping to trigger vertical lines |
| 1646 | * Orgtbl mode:: The table editor as minor mode | 1647 | * Orgtbl mode:: The table editor as minor mode |
| 1647 | * The spreadsheet:: The table editor has spreadsheet capabilities | 1648 | * The spreadsheet:: The table editor has spreadsheet capabilities |
| 1648 | * Org-Plot:: Plotting from org tables | 1649 | * Org-Plot:: Plotting from org tables |
| 1649 | @end menu | 1650 | @end menu |
| 1650 | 1651 | ||
| 1651 | @node Built-in table editor, Column width and alignment, Tables, Tables | 1652 | @node Built-in table editor, Column width and alignment, Tables, Tables |
| @@ -2019,14 +2020,14 @@ fields in the table corresponding to the references at the point in the | |||
| 2019 | formula, moving these references by arrow keys | 2020 | formula, moving these references by arrow keys |
| 2020 | 2021 | ||
| 2021 | @menu | 2022 | @menu |
| 2022 | * References:: How to refer to another field or range | 2023 | * References:: How to refer to another field or range |
| 2023 | * Formula syntax for Calc:: Using Calc to compute stuff | 2024 | * Formula syntax for Calc:: Using Calc to compute stuff |
| 2024 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | 2025 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp |
| 2025 | * Field formulas:: Formulas valid for a single field | 2026 | * Field formulas:: Formulas valid for a single field |
| 2026 | * Column formulas:: Formulas valid for an entire column | 2027 | * Column formulas:: Formulas valid for an entire column |
| 2027 | * Editing and debugging formulas:: Fixing formulas | 2028 | * Editing and debugging formulas:: Fixing formulas |
| 2028 | * Updating the table:: Recomputing all dependent fields | 2029 | * Updating the table:: Recomputing all dependent fields |
| 2029 | * Advanced features:: Field names, parameters and automatic recalc | 2030 | * Advanced features:: Field names, parameters and automatic recalc |
| 2030 | @end menu | 2031 | @end menu |
| 2031 | 2032 | ||
| 2032 | @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | 2033 | @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet |
| @@ -2730,14 +2731,14 @@ Like HTML, Org provides links inside a file, external links to | |||
| 2730 | other files, Usenet articles, emails, and much more. | 2731 | other files, Usenet articles, emails, and much more. |
| 2731 | 2732 | ||
| 2732 | @menu | 2733 | @menu |
| 2733 | * Link format:: How links in Org are formatted | 2734 | * Link format:: How links in Org are formatted |
| 2734 | * Internal links:: Links to other places in the current file | 2735 | * Internal links:: Links to other places in the current file |
| 2735 | * External links:: URL-like links to the world | 2736 | * External links:: URL-like links to the world |
| 2736 | * Handling links:: Creating, inserting and following | 2737 | * Handling links:: Creating, inserting and following |
| 2737 | * Using links outside Org:: Linking from my C source code? | 2738 | * Using links outside Org:: Linking from my C source code? |
| 2738 | * Link abbreviations:: Shortcuts for writing complex links | 2739 | * Link abbreviations:: Shortcuts for writing complex links |
| 2739 | * Search options:: Linking to a specific location | 2740 | * Search options:: Linking to a specific location |
| 2740 | * Custom searches:: When the default search is not enough | 2741 | * Custom searches:: When the default search is not enough |
| 2741 | @end menu | 2742 | @end menu |
| 2742 | 2743 | ||
| 2743 | @node Link format, Internal links, Hyperlinks, Hyperlinks | 2744 | @node Link format, Internal links, Hyperlinks, Hyperlinks |
| @@ -2830,7 +2831,7 @@ several times in direct succession goes back to positions recorded | |||
| 2830 | earlier. | 2831 | earlier. |
| 2831 | 2832 | ||
| 2832 | @menu | 2833 | @menu |
| 2833 | * Radio targets:: Make targets trigger links in plain text | 2834 | * Radio targets:: Make targets trigger links in plain text |
| 2834 | @end menu | 2835 | @end menu |
| 2835 | 2836 | ||
| 2836 | @node Radio targets, , Internal links, Internal links | 2837 | @node Radio targets, , Internal links, Internal links |
| @@ -3285,12 +3286,12 @@ throughout your notes file. Org-mode compensates for this by providing | |||
| 3285 | methods to give you an overview of all the things that you have to do. | 3286 | methods to give you an overview of all the things that you have to do. |
| 3286 | 3287 | ||
| 3287 | @menu | 3288 | @menu |
| 3288 | * TODO basics:: Marking and displaying TODO entries | 3289 | * TODO basics:: Marking and displaying TODO entries |
| 3289 | * TODO extensions:: Workflow and assignments | 3290 | * TODO extensions:: Workflow and assignments |
| 3290 | * Progress logging:: Dates and notes for progress | 3291 | * Progress logging:: Dates and notes for progress |
| 3291 | * Priorities:: Some things are more important than others | 3292 | * Priorities:: Some things are more important than others |
| 3292 | * Breaking down tasks:: Splitting a task into manageable pieces | 3293 | * Breaking down tasks:: Splitting a task into manageable pieces |
| 3293 | * Checkboxes:: Tick-off lists | 3294 | * Checkboxes:: Tick-off lists |
| 3294 | @end menu | 3295 | @end menu |
| 3295 | 3296 | ||
| 3296 | @node TODO basics, TODO extensions, TODO Items, TODO Items | 3297 | @node TODO basics, TODO extensions, TODO Items, TODO Items |
| @@ -3382,13 +3383,13 @@ Note that @i{tags} are another way to classify headlines in general and | |||
| 3382 | TODO items in particular (@pxref{Tags}). | 3383 | TODO items in particular (@pxref{Tags}). |
| 3383 | 3384 | ||
| 3384 | @menu | 3385 | @menu |
| 3385 | * Workflow states:: From TODO to DONE in steps | 3386 | * Workflow states:: From TODO to DONE in steps |
| 3386 | * TODO types:: I do this, Fred does the rest | 3387 | * TODO types:: I do this, Fred does the rest |
| 3387 | * Multiple sets in one file:: Mixing it all, and still finding your way | 3388 | * Multiple sets in one file:: Mixing it all, and still finding your way |
| 3388 | * Fast access to TODO states:: Single letter selection of a state | 3389 | * Fast access to TODO states:: Single letter selection of a state |
| 3389 | * Per-file keywords:: Different files, different requirements | 3390 | * Per-file keywords:: Different files, different requirements |
| 3390 | * Faces for TODO keywords:: Highlighting states | 3391 | * Faces for TODO keywords:: Highlighting states |
| 3391 | * TODO dependencies:: When one task needs to wait for others | 3392 | * TODO dependencies:: When one task needs to wait for others |
| 3392 | @end menu | 3393 | @end menu |
| 3393 | 3394 | ||
| 3394 | @node Workflow states, TODO types, TODO extensions, TODO extensions | 3395 | @node Workflow states, TODO types, TODO extensions, TODO extensions |
| @@ -3679,9 +3680,9 @@ information on how to clock working time for a task, see @ref{Clocking | |||
| 3679 | work time}. | 3680 | work time}. |
| 3680 | 3681 | ||
| 3681 | @menu | 3682 | @menu |
| 3682 | * Closing items:: When was this entry marked DONE? | 3683 | * Closing items:: When was this entry marked DONE? |
| 3683 | * Tracking TODO state changes:: When did the status change? | 3684 | * Tracking TODO state changes:: When did the status change? |
| 3684 | * Tracking your habits:: How consistent have you been? | 3685 | * Tracking your habits:: How consistent have you been? |
| 3685 | @end menu | 3686 | @end menu |
| 3686 | 3687 | ||
| 3687 | @node Closing items, Tracking TODO state changes, Progress logging, Progress logging | 3688 | @node Closing items, Tracking TODO state changes, Progress logging, Progress logging |
| @@ -4143,9 +4144,9 @@ You may specify special faces for specific tags using the variable | |||
| 4143 | (@pxref{Faces for TODO keywords}). | 4144 | (@pxref{Faces for TODO keywords}). |
| 4144 | 4145 | ||
| 4145 | @menu | 4146 | @menu |
| 4146 | * Tag inheritance:: Tags use the tree structure of the outline | 4147 | * Tag inheritance:: Tags use the tree structure of the outline |
| 4147 | * Setting tags:: How to assign tags to a headline | 4148 | * Setting tags:: How to assign tags to a headline |
| 4148 | * Tag searches:: Searching for combinations of tags | 4149 | * Tag searches:: Searching for combinations of tags |
| 4149 | @end menu | 4150 | @end menu |
| 4150 | 4151 | ||
| 4151 | @node Tag inheritance, Setting tags, Tags, Tags | 4152 | @node Tag inheritance, Setting tags, Tags, Tags |
| @@ -4432,12 +4433,12 @@ Properties can be conveniently edited and viewed in column view | |||
| 4432 | (@pxref{Column view}). | 4433 | (@pxref{Column view}). |
| 4433 | 4434 | ||
| 4434 | @menu | 4435 | @menu |
| 4435 | * Property syntax:: How properties are spelled out | 4436 | * Property syntax:: How properties are spelled out |
| 4436 | * Special properties:: Access to other Org-mode features | 4437 | * Special properties:: Access to other Org-mode features |
| 4437 | * Property searches:: Matching property values | 4438 | * Property searches:: Matching property values |
| 4438 | * Property inheritance:: Passing values down the tree | 4439 | * Property inheritance:: Passing values down the tree |
| 4439 | * Column view:: Tabular viewing and editing | 4440 | * Column view:: Tabular viewing and editing |
| 4440 | * Property API:: Properties for Lisp programmers | 4441 | * Property API:: Properties for Lisp programmers |
| 4441 | @end menu | 4442 | @end menu |
| 4442 | 4443 | ||
| 4443 | @node Property syntax, Special properties, Properties and Columns, Properties and Columns | 4444 | @node Property syntax, Special properties, Properties and Columns, Properties and Columns |
| @@ -4673,9 +4674,9 @@ Column view also works in agenda buffers (@pxref{Agenda Views}) where | |||
| 4673 | queries have collected selected items, possibly from a number of files. | 4674 | queries have collected selected items, possibly from a number of files. |
| 4674 | 4675 | ||
| 4675 | @menu | 4676 | @menu |
| 4676 | * Defining columns:: The COLUMNS format property | 4677 | * Defining columns:: The COLUMNS format property |
| 4677 | * Using column view:: How to create and use column view | 4678 | * Using column view:: How to create and use column view |
| 4678 | * Capturing column view:: A dynamic block for column view | 4679 | * Capturing column view:: A dynamic block for column view |
| 4679 | @end menu | 4680 | @end menu |
| 4680 | 4681 | ||
| 4681 | @node Defining columns, Using column view, Column view, Column view | 4682 | @node Defining columns, Using column view, Column view, Column view |
| @@ -4687,8 +4688,8 @@ Setting up a column view first requires defining the columns. This is | |||
| 4687 | done by defining a column format line. | 4688 | done by defining a column format line. |
| 4688 | 4689 | ||
| 4689 | @menu | 4690 | @menu |
| 4690 | * Scope of column definitions:: Where defined, where valid? | 4691 | * Scope of column definitions:: Where defined, where valid? |
| 4691 | * Column attributes:: Appearance and content of a column | 4692 | * Column attributes:: Appearance and content of a column |
| 4692 | @end menu | 4693 | @end menu |
| 4693 | 4694 | ||
| 4694 | @node Scope of column definitions, Column attributes, Defining columns, Defining columns | 4695 | @node Scope of column definitions, Column attributes, Defining columns, Defining columns |
| @@ -4770,7 +4771,7 @@ values. | |||
| 4770 | 4771 | ||
| 4771 | @example | 4772 | @example |
| 4772 | :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.} | 4773 | :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.} |
| 4773 | %10Time_Estimate@{:@} %CLOCKSUM | 4774 | %10Time_Estimate@{:@} %CLOCKSUM |
| 4774 | :Owner_ALL: Tammy Mark Karl Lisa Don | 4775 | :Owner_ALL: Tammy Mark Karl Lisa Don |
| 4775 | :Status_ALL: "In progress" "Not started yet" "Finished" "" | 4776 | :Status_ALL: "In progress" "Not started yet" "Finished" "" |
| 4776 | :Approved_ALL: "[ ]" "[X]" | 4777 | :Approved_ALL: "[ ]" "[X]" |
| @@ -4970,13 +4971,13 @@ something was created or last changed. However, in Org-mode this term | |||
| 4970 | is used in a much wider sense. | 4971 | is used in a much wider sense. |
| 4971 | 4972 | ||
| 4972 | @menu | 4973 | @menu |
| 4973 | * Timestamps:: Assigning a time to a tree entry | 4974 | * Timestamps:: Assigning a time to a tree entry |
| 4974 | * Creating timestamps:: Commands which insert timestamps | 4975 | * Creating timestamps:: Commands which insert timestamps |
| 4975 | * Deadlines and scheduling:: Planning your work | 4976 | * Deadlines and scheduling:: Planning your work |
| 4976 | * Clocking work time:: Tracking how long you spend on a task | 4977 | * Clocking work time:: Tracking how long you spend on a task |
| 4977 | * Resolving idle time:: Resolving time if you've been idle | 4978 | * Resolving idle time:: Resolving time if you've been idle |
| 4978 | * Effort estimates:: Planning work effort in advance | 4979 | * Effort estimates:: Planning work effort in advance |
| 4979 | * Relative timer:: Notes with a running timer | 4980 | * Relative timer:: Notes with a running timer |
| 4980 | @end menu | 4981 | @end menu |
| 4981 | 4982 | ||
| 4982 | 4983 | ||
| @@ -5132,8 +5133,8 @@ the following column). | |||
| 5132 | 5133 | ||
| 5133 | 5134 | ||
| 5134 | @menu | 5135 | @menu |
| 5135 | * The date/time prompt:: How Org-mode helps you entering date and time | 5136 | * The date/time prompt:: How Org-mode helps you entering date and time |
| 5136 | * Custom time format:: Making dates look different | 5137 | * Custom time format:: Making dates look different |
| 5137 | @end menu | 5138 | @end menu |
| 5138 | 5139 | ||
| 5139 | @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | 5140 | @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps |
| @@ -5365,8 +5366,8 @@ late warnings. However, it will show the item on each day where the | |||
| 5365 | sexp entry matches. | 5366 | sexp entry matches. |
| 5366 | 5367 | ||
| 5367 | @menu | 5368 | @menu |
| 5368 | * Inserting deadline/schedule:: Planning items | 5369 | * Inserting deadline/schedule:: Planning items |
| 5369 | * Repeated tasks:: Items that show up again and again | 5370 | * Repeated tasks:: Items that show up again and again |
| 5370 | @end menu | 5371 | @end menu |
| 5371 | 5372 | ||
| 5372 | @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling | 5373 | @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling |
| @@ -5888,12 +5889,12 @@ system, tasks and projects need to be moved around. Moving completed project | |||
| 5888 | trees to an archive file keeps the system compact and fast. | 5889 | trees to an archive file keeps the system compact and fast. |
| 5889 | 5890 | ||
| 5890 | @menu | 5891 | @menu |
| 5891 | * Capture:: Capturing new stuff | 5892 | * Capture:: Capturing new stuff |
| 5892 | * Attachments:: Add files to tasks | 5893 | * Attachments:: Add files to tasks |
| 5893 | * RSS Feeds:: Getting input from RSS feeds | 5894 | * RSS Feeds:: Getting input from RSS feeds |
| 5894 | * Protocols:: External (e.g. Browser) access to Emacs and Org | 5895 | * Protocols:: External (e.g. Browser) access to Emacs and Org |
| 5895 | * Refiling notes:: Moving a tree from one place to another | 5896 | * Refiling notes:: Moving a tree from one place to another |
| 5896 | * Archiving:: What to do with finished projects | 5897 | * Archiving:: What to do with finished projects |
| 5897 | @end menu | 5898 | @end menu |
| 5898 | 5899 | ||
| 5899 | @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive | 5900 | @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive |
| @@ -5921,9 +5922,9 @@ flow. The basic process of capturing is very similar to remember, but Org | |||
| 5921 | does enhance it with templates and more. | 5922 | does enhance it with templates and more. |
| 5922 | 5923 | ||
| 5923 | @menu | 5924 | @menu |
| 5924 | * Setting up capture:: Where notes will be stored | 5925 | * Setting up capture:: Where notes will be stored |
| 5925 | * Using capture:: Commands to invoke and terminate capture | 5926 | * Using capture:: Commands to invoke and terminate capture |
| 5926 | * Capture templates:: Define the outline of different note types | 5927 | * Capture templates:: Define the outline of different note types |
| 5927 | @end menu | 5928 | @end menu |
| 5928 | 5929 | ||
| 5929 | @node Setting up capture, Using capture, Capture, Capture | 5930 | @node Setting up capture, Using capture, Capture, Capture |
| @@ -6016,8 +6017,8 @@ place where you started the capture process. | |||
| 6016 | 6017 | ||
| 6017 | 6018 | ||
| 6018 | @menu | 6019 | @menu |
| 6019 | * Template elements:: What is needed for a complete template entry | 6020 | * Template elements:: What is needed for a complete template entry |
| 6020 | * Template expansion:: Filling in information about time and context | 6021 | * Template expansion:: Filling in information about time and context |
| 6021 | @end menu | 6022 | @end menu |
| 6022 | 6023 | ||
| 6023 | @node Template elements, Template expansion, Capture templates, Capture templates | 6024 | @node Template elements, Template expansion, Capture templates, Capture templates |
| @@ -6326,8 +6327,8 @@ information. Here is just an example: | |||
| 6326 | @example | 6327 | @example |
| 6327 | (setq org-feed-alist | 6328 | (setq org-feed-alist |
| 6328 | '(("Slashdot" | 6329 | '(("Slashdot" |
| 6329 | "http://rss.slashdot.org/Slashdot/slashdot" | 6330 | "http://rss.slashdot.org/Slashdot/slashdot" |
| 6330 | "~/txt/org/feeds.org" "Slashdot Entries"))) | 6331 | "~/txt/org/feeds.org" "Slashdot Entries"))) |
| 6331 | @end example | 6332 | @end example |
| 6332 | 6333 | ||
| 6333 | @noindent | 6334 | @noindent |
| @@ -6440,8 +6441,8 @@ Archive the current entry using the command specified in the variable | |||
| 6440 | @end table | 6441 | @end table |
| 6441 | 6442 | ||
| 6442 | @menu | 6443 | @menu |
| 6443 | * Moving subtrees:: Moving a tree to an archive file | 6444 | * Moving subtrees:: Moving a tree to an archive file |
| 6444 | * Internal archiving:: Switch off a tree but keep it in the file | 6445 | * Internal archiving:: Switch off a tree but keep it in the file |
| 6445 | @end menu | 6446 | @end menu |
| 6446 | 6447 | ||
| 6447 | @node Moving subtrees, Internal archiving, Archiving, Archiving | 6448 | @node Moving subtrees, Internal archiving, Archiving, Archiving |
| @@ -6618,14 +6619,14 @@ window configuration is restored when the agenda exits: | |||
| 6618 | @code{org-agenda-restore-windows-after-quit}. | 6619 | @code{org-agenda-restore-windows-after-quit}. |
| 6619 | 6620 | ||
| 6620 | @menu | 6621 | @menu |
| 6621 | * Agenda files:: Files being searched for agenda information | 6622 | * Agenda files:: Files being searched for agenda information |
| 6622 | * Agenda dispatcher:: Keyboard access to agenda views | 6623 | * Agenda dispatcher:: Keyboard access to agenda views |
| 6623 | * Built-in agenda views:: What is available out of the box? | 6624 | * Built-in agenda views:: What is available out of the box? |
| 6624 | * Presentation and sorting:: How agenda items are prepared for display | 6625 | * Presentation and sorting:: How agenda items are prepared for display |
| 6625 | * Agenda commands:: Remote editing of Org trees | 6626 | * Agenda commands:: Remote editing of Org trees |
| 6626 | * Custom agenda views:: Defining special searches and views | 6627 | * Custom agenda views:: Defining special searches and views |
| 6627 | * Exporting Agenda Views:: Writing a view to a file | 6628 | * Exporting Agenda Views:: Writing a view to a file |
| 6628 | * Agenda column view:: Using column view for collected entries | 6629 | * Agenda column view:: Using column view for collected entries |
| 6629 | @end menu | 6630 | @end menu |
| 6630 | 6631 | ||
| 6631 | @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views | 6632 | @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
| @@ -6767,12 +6768,12 @@ a number of special tags matches. @xref{Custom agenda views}. | |||
| 6767 | In this section we describe the built-in views. | 6768 | In this section we describe the built-in views. |
| 6768 | 6769 | ||
| 6769 | @menu | 6770 | @menu |
| 6770 | * Weekly/daily agenda:: The calendar page with current tasks | 6771 | * Weekly/daily agenda:: The calendar page with current tasks |
| 6771 | * Global TODO list:: All unfinished action items | 6772 | * Global TODO list:: All unfinished action items |
| 6772 | * Matching tags and properties:: Structured information with fine-tuned search | 6773 | * Matching tags and properties:: Structured information with fine-tuned search |
| 6773 | * Timeline:: Time-sorted view for single file | 6774 | * Timeline:: Time-sorted view for single file |
| 6774 | * Search view:: Find entries by searching for text | 6775 | * Search view:: Find entries by searching for text |
| 6775 | * Stuck projects:: Find projects you need to review | 6776 | * Stuck projects:: Find projects you need to review |
| 6776 | @end menu | 6777 | @end menu |
| 6777 | 6778 | ||
| 6778 | @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views | 6779 | @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
| @@ -7237,9 +7238,9 @@ The prefix is followed by a cleaned-up version of the outline headline | |||
| 7237 | associated with the item. | 7238 | associated with the item. |
| 7238 | 7239 | ||
| 7239 | @menu | 7240 | @menu |
| 7240 | * Categories:: Not all tasks are equal | 7241 | * Categories:: Not all tasks are equal |
| 7241 | * Time-of-day specifications:: How the agenda knows the time | 7242 | * Time-of-day specifications:: How the agenda knows the time |
| 7242 | * Sorting of agenda items:: The order of things | 7243 | * Sorting of agenda items:: The order of things |
| 7243 | @end menu | 7244 | @end menu |
| 7244 | 7245 | ||
| 7245 | @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | 7246 | @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting |
| @@ -7628,12 +7629,12 @@ Internet, and outside of business hours, with something like this: | |||
| 7628 | @group | 7629 | @group |
| 7629 | (defun org-my-auto-exclude-function (tag) | 7630 | (defun org-my-auto-exclude-function (tag) |
| 7630 | (and (cond | 7631 | (and (cond |
| 7631 | ((string= tag "Net") | 7632 | ((string= tag "Net") |
| 7632 | (/= 0 (call-process "/sbin/ping" nil nil nil | 7633 | (/= 0 (call-process "/sbin/ping" nil nil nil |
| 7633 | "-c1" "-q" "-t1" "mail.gnu.org"))) | 7634 | "-c1" "-q" "-t1" "mail.gnu.org"))) |
| 7634 | ((or (string= tag "Errand") (string= tag "Call")) | 7635 | ((or (string= tag "Errand") (string= tag "Call")) |
| 7635 | (let ((hour (nth 2 (decode-time)))) | 7636 | (let ((hour (nth 2 (decode-time)))) |
| 7636 | (or (< hour 8) (> hour 21))))) | 7637 | (or (< hour 8) (> hour 21))))) |
| 7637 | (concat "-" tag))) | 7638 | (concat "-" tag))) |
| 7638 | 7639 | ||
| 7639 | (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function) | 7640 | (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function) |
| @@ -7963,9 +7964,9 @@ agenda buffers. Custom agenda commands will be accessible through the | |||
| 7963 | dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | 7964 | dispatcher (@pxref{Agenda dispatcher}), just like the default commands. |
| 7964 | 7965 | ||
| 7965 | @menu | 7966 | @menu |
| 7966 | * Storing searches:: Type once, use often | 7967 | * Storing searches:: Type once, use often |
| 7967 | * Block agenda:: All the stuff you need in a single buffer | 7968 | * Block agenda:: All the stuff you need in a single buffer |
| 7968 | * Setting Options:: Changing the rules | 7969 | * Setting Options:: Changing the rules |
| 7969 | @end menu | 7970 | @end menu |
| 7970 | 7971 | ||
| 7971 | @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | 7972 | @node Storing searches, Block agenda, Custom agenda views, Custom agenda views |
| @@ -8350,29 +8351,29 @@ Org-mode has rules on how to prepare text for rich export. This section | |||
| 8350 | summarizes the markup rules used in an Org-mode buffer. | 8351 | summarizes the markup rules used in an Org-mode buffer. |
| 8351 | 8352 | ||
| 8352 | @menu | 8353 | @menu |
| 8353 | * Structural markup elements:: The basic structure as seen by the exporter | 8354 | * Structural markup elements:: The basic structure as seen by the exporter |
| 8354 | * Images and tables:: Tables and Images will be included | 8355 | * Images and tables:: Tables and Images will be included |
| 8355 | * Literal examples:: Source code examples with special formatting | 8356 | * Literal examples:: Source code examples with special formatting |
| 8356 | * Include files:: Include additional files into a document | 8357 | * Include files:: Include additional files into a document |
| 8357 | * Index entries:: Making an index | 8358 | * Index entries:: Making an index |
| 8358 | * Macro replacement:: Use macros to create complex output | 8359 | * Macro replacement:: Use macros to create complex output |
| 8359 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents | 8360 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents |
| 8360 | @end menu | 8361 | @end menu |
| 8361 | 8362 | ||
| 8362 | @node Structural markup elements, Images and tables, Markup, Markup | 8363 | @node Structural markup elements, Images and tables, Markup, Markup |
| 8363 | @section Structural markup elements | 8364 | @section Structural markup elements |
| 8364 | 8365 | ||
| 8365 | @menu | 8366 | @menu |
| 8366 | * Document title:: Where the title is taken from | 8367 | * Document title:: Where the title is taken from |
| 8367 | * Headings and sections:: The document structure as seen by the exporter | 8368 | * Headings and sections:: The document structure as seen by the exporter |
| 8368 | * Table of contents:: The if and where of the table of contents | 8369 | * Table of contents:: The if and where of the table of contents |
| 8369 | * Initial text:: Text before the first heading? | 8370 | * Initial text:: Text before the first heading? |
| 8370 | * Lists:: Lists | 8371 | * Lists:: Lists |
| 8371 | * Paragraphs:: Paragraphs | 8372 | * Paragraphs:: Paragraphs |
| 8372 | * Footnote markup:: Footnotes | 8373 | * Footnote markup:: Footnotes |
| 8373 | * Emphasis and monospace:: Bold, italic, etc. | 8374 | * Emphasis and monospace:: Bold, italic, etc. |
| 8374 | * Horizontal rules:: Make a line | 8375 | * Horizontal rules:: Make a line |
| 8375 | * Comment lines:: What will *not* be exported | 8376 | * Comment lines:: What will *not* be exported |
| 8376 | @end menu | 8377 | @end menu |
| 8377 | 8378 | ||
| 8378 | @node Document title, Headings and sections, Structural markup elements, Structural markup elements | 8379 | @node Document title, Headings and sections, Structural markup elements, Structural markup elements |
| @@ -8801,11 +8802,11 @@ If you observe a few conventions, Org-mode knows how to find it and what | |||
| 8801 | to do with it. | 8802 | to do with it. |
| 8802 | 8803 | ||
| 8803 | @menu | 8804 | @menu |
| 8804 | * Special symbols:: Greek letters and other symbols | 8805 | * Special symbols:: Greek letters and other symbols |
| 8805 | * Subscripts and superscripts:: Simple syntax for raising/lowering text | 8806 | * Subscripts and superscripts:: Simple syntax for raising/lowering text |
| 8806 | * LaTeX fragments:: Complex formulas made easy | 8807 | * LaTeX fragments:: Complex formulas made easy |
| 8807 | * Previewing LaTeX fragments:: What will this snippet look like? | 8808 | * Previewing LaTeX fragments:: What will this snippet look like? |
| 8808 | * CDLaTeX mode:: Speed up entering of formulas | 8809 | * CDLaTeX mode:: Speed up entering of formulas |
| 8809 | @end menu | 8810 | @end menu |
| 8810 | 8811 | ||
| 8811 | @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX | 8812 | @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX |
| @@ -9064,17 +9065,17 @@ Org supports export of selected regions when @code{transient-mark-mode} is | |||
| 9064 | enabled (default in Emacs 23). | 9065 | enabled (default in Emacs 23). |
| 9065 | 9066 | ||
| 9066 | @menu | 9067 | @menu |
| 9067 | * Selective export:: Using tags to select and exclude trees | 9068 | * Selective export:: Using tags to select and exclude trees |
| 9068 | * Export options:: Per-file export settings | 9069 | * Export options:: Per-file export settings |
| 9069 | * The export dispatcher:: How to access exporter commands | 9070 | * The export dispatcher:: How to access exporter commands |
| 9070 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding | 9071 | * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding |
| 9071 | * HTML export:: Exporting to HTML | 9072 | * HTML export:: Exporting to HTML |
| 9072 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF | 9073 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF |
| 9073 | * DocBook export:: Exporting to DocBook | 9074 | * DocBook export:: Exporting to DocBook |
| 9074 | * TaskJuggler export:: Exporting to TaskJuggler | 9075 | * TaskJuggler export:: Exporting to TaskJuggler |
| 9075 | * Freemind export:: Exporting to Freemind mind maps | 9076 | * Freemind export:: Exporting to Freemind mind maps |
| 9076 | * XOXO export:: Exporting to XOXO | 9077 | * XOXO export:: Exporting to XOXO |
| 9077 | * iCalendar export:: Exporting in iCalendar format | 9078 | * iCalendar export:: Exporting in iCalendar format |
| 9078 | @end menu | 9079 | @end menu |
| 9079 | 9080 | ||
| 9080 | @node Selective export, Export options, Exporting, Exporting | 9081 | @node Selective export, Export options, Exporting, Exporting |
| @@ -9327,14 +9328,14 @@ HTML formatting, in ways similar to John Gruber's @emph{markdown} | |||
| 9327 | language, but with additional support for tables. | 9328 | language, but with additional support for tables. |
| 9328 | 9329 | ||
| 9329 | @menu | 9330 | @menu |
| 9330 | * HTML Export commands:: How to invoke HTML export | 9331 | * HTML Export commands:: How to invoke HTML export |
| 9331 | * Quoting HTML tags:: Using direct HTML in Org-mode | 9332 | * Quoting HTML tags:: Using direct HTML in Org-mode |
| 9332 | * Links in HTML export:: How links will be interpreted and formatted | 9333 | * Links in HTML export:: How links will be interpreted and formatted |
| 9333 | * Tables in HTML export:: How to modify the formatting of tables | 9334 | * Tables in HTML export:: How to modify the formatting of tables |
| 9334 | * Images in HTML export:: How to insert figures into HTML output | 9335 | * Images in HTML export:: How to insert figures into HTML output |
| 9335 | * Text areas in HTML export:: An alternative way to show an example | 9336 | * Text areas in HTML export:: An alternative way to show an example |
| 9336 | * CSS support:: Changing the appearance of the output | 9337 | * CSS support:: Changing the appearance of the output |
| 9337 | * JavaScript support:: Info and Folding in a web browser | 9338 | * JavaScript support:: Info and Folding in a web browser |
| 9338 | @end menu | 9339 | @end menu |
| 9339 | 9340 | ||
| 9340 | @node HTML Export commands, Quoting HTML tags, HTML export, HTML export | 9341 | @node HTML Export commands, Quoting HTML tags, HTML export, HTML export |
| @@ -9681,12 +9682,12 @@ implement links and cross references, the PDF output file will be fully | |||
| 9681 | linked. | 9682 | linked. |
| 9682 | 9683 | ||
| 9683 | @menu | 9684 | @menu |
| 9684 | * LaTeX/PDF export commands:: Which key invokes which commands | 9685 | * LaTeX/PDF export commands:: Which key invokes which commands |
| 9685 | * Header and sectioning:: Setting up the export file structure | 9686 | * Header and sectioning:: Setting up the export file structure |
| 9686 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code | 9687 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code |
| 9687 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} | 9688 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} |
| 9688 | * Images in LaTeX export:: How to insert figures into La@TeX{} output | 9689 | * Images in LaTeX export:: How to insert figures into La@TeX{} output |
| 9689 | * Beamer class export:: Turning the file into a presentation | 9690 | * Beamer class export:: Turning the file into a presentation |
| 9690 | @end menu | 9691 | @end menu |
| 9691 | 9692 | ||
| 9692 | @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export | 9693 | @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export |
| @@ -10011,12 +10012,12 @@ tools and stylesheets. | |||
| 10011 | Currently DocBook exporter only supports DocBook V5.0. | 10012 | Currently DocBook exporter only supports DocBook V5.0. |
| 10012 | 10013 | ||
| 10013 | @menu | 10014 | @menu |
| 10014 | * DocBook export commands:: How to invoke DocBook export | 10015 | * DocBook export commands:: How to invoke DocBook export |
| 10015 | * Quoting DocBook code:: Incorporating DocBook code in Org files | 10016 | * Quoting DocBook code:: Incorporating DocBook code in Org files |
| 10016 | * Recursive sections:: Recursive sections in DocBook | 10017 | * Recursive sections:: Recursive sections in DocBook |
| 10017 | * Tables in DocBook export:: Tables are exported as HTML tables | 10018 | * Tables in DocBook export:: Tables are exported as HTML tables |
| 10018 | * Images in DocBook export:: How to insert figures into DocBook output | 10019 | * Images in DocBook export:: How to insert figures into DocBook output |
| 10019 | * Special characters:: How to handle special characters | 10020 | * Special characters:: How to handle special characters |
| 10020 | @end menu | 10021 | @end menu |
| 10021 | 10022 | ||
| 10022 | @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export | 10023 | @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export |
| @@ -10442,10 +10443,10 @@ conversion so that files are available in both formats on the server. | |||
| 10442 | Publishing has been contributed to Org by David O'Toole. | 10443 | Publishing has been contributed to Org by David O'Toole. |
| 10443 | 10444 | ||
| 10444 | @menu | 10445 | @menu |
| 10445 | * Configuration:: Defining projects | 10446 | * Configuration:: Defining projects |
| 10446 | * Uploading files:: How to get files up on the server | 10447 | * Uploading files:: How to get files up on the server |
| 10447 | * Sample configuration:: Example projects | 10448 | * Sample configuration:: Example projects |
| 10448 | * Triggering publication:: Publication commands | 10449 | * Triggering publication:: Publication commands |
| 10449 | @end menu | 10450 | @end menu |
| 10450 | 10451 | ||
| 10451 | @node Configuration, Uploading files, Publishing, Publishing | 10452 | @node Configuration, Uploading files, Publishing, Publishing |
| @@ -10455,14 +10456,14 @@ Publishing needs significant configuration to specify files, destination | |||
| 10455 | and many other properties of a project. | 10456 | and many other properties of a project. |
| 10456 | 10457 | ||
| 10457 | @menu | 10458 | @menu |
| 10458 | * Project alist:: The central configuration variable | 10459 | * Project alist:: The central configuration variable |
| 10459 | * Sources and destinations:: From here to there | 10460 | * Sources and destinations:: From here to there |
| 10460 | * Selecting files:: What files are part of the project? | 10461 | * Selecting files:: What files are part of the project? |
| 10461 | * Publishing action:: Setting the function doing the publishing | 10462 | * Publishing action:: Setting the function doing the publishing |
| 10462 | * Publishing options:: Tweaking HTML export | 10463 | * Publishing options:: Tweaking HTML export |
| 10463 | * Publishing links:: Which links keep working after publishing? | 10464 | * Publishing links:: Which links keep working after publishing? |
| 10464 | * Sitemap:: Generating a list of all pages | 10465 | * Sitemap:: Generating a list of all pages |
| 10465 | * Generating an index:: An index that reaches across pages | 10466 | * Generating an index:: An index that reaches across pages |
| 10466 | @end menu | 10467 | @end menu |
| 10467 | 10468 | ||
| 10468 | @node Project alist, Sources and destinations, Configuration, Configuration | 10469 | @node Project alist, Sources and destinations, Configuration, Configuration |
| @@ -10836,8 +10837,8 @@ project publishing only a set of Org files. The second example is | |||
| 10836 | more complex, with a multi-component project. | 10837 | more complex, with a multi-component project. |
| 10837 | 10838 | ||
| 10838 | @menu | 10839 | @menu |
| 10839 | * Simple example:: One-component publishing | 10840 | * Simple example:: One-component publishing |
| 10840 | * Complex example:: A multi-component publishing example | 10841 | * Complex example:: A multi-component publishing example |
| 10841 | @end menu | 10842 | @end menu |
| 10842 | 10843 | ||
| 10843 | @node Simple example, Complex example, Sample configuration, Sample configuration | 10844 | @node Simple example, Complex example, Sample configuration, Sample configuration |
| @@ -10966,18 +10967,18 @@ Davison and Eric Schulte, and was originally named Org-babel. | |||
| 10966 | The following sections describe Org-mode's code block handling facilities. | 10967 | The following sections describe Org-mode's code block handling facilities. |
| 10967 | 10968 | ||
| 10968 | @menu | 10969 | @menu |
| 10969 | * Structure of code blocks:: Code block syntax described | 10970 | * Structure of code blocks:: Code block syntax described |
| 10970 | * Editing source code:: Language major-mode editing | 10971 | * Editing source code:: Language major-mode editing |
| 10971 | * Exporting code blocks:: Export contents and/or results | 10972 | * Exporting code blocks:: Export contents and/or results |
| 10972 | * Extracting source code:: Create pure source code files | 10973 | * Extracting source code:: Create pure source code files |
| 10973 | * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer | 10974 | * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer |
| 10974 | * Library of Babel:: Use and contribute to a library of useful code blocks | 10975 | * Library of Babel:: Use and contribute to a library of useful code blocks |
| 10975 | * Languages:: List of supported code block languages | 10976 | * Languages:: List of supported code block languages |
| 10976 | * Header arguments:: Configure code block functionality | 10977 | * Header arguments:: Configure code block functionality |
| 10977 | * Results of evaluation:: How evaluation results are handled | 10978 | * Results of evaluation:: How evaluation results are handled |
| 10978 | * Noweb reference syntax:: Literate programming in Org-mode | 10979 | * Noweb reference syntax:: Literate programming in Org-mode |
| 10979 | * Key bindings and useful functions:: Work quickly with code blocks | 10980 | * Key bindings and useful functions:: Work quickly with code blocks |
| 10980 | * Batch execution:: Call functions from the command line | 10981 | * Batch execution:: Call functions from the command line |
| 10981 | @end menu | 10982 | @end menu |
| 10982 | 10983 | ||
| 10983 | @comment node-name, next, previous, up | 10984 | @comment node-name, next, previous, up |
| @@ -11271,8 +11272,8 @@ section provides an overview of the use of header arguments, and then | |||
| 11271 | describes each header argument in detail. | 11272 | describes each header argument in detail. |
| 11272 | 11273 | ||
| 11273 | @menu | 11274 | @menu |
| 11274 | * Using header arguments:: Different ways to set header arguments | 11275 | * Using header arguments:: Different ways to set header arguments |
| 11275 | * Specific header arguments:: List of header arguments | 11276 | * Specific header arguments:: List of header arguments |
| 11276 | @end menu | 11277 | @end menu |
| 11277 | 11278 | ||
| 11278 | @node Using header arguments, Specific header arguments, Header arguments, Header arguments | 11279 | @node Using header arguments, Specific header arguments, Header arguments, Header arguments |
| @@ -11282,7 +11283,7 @@ The values of header arguments can be set in five different ways, each more | |||
| 11282 | specific (and having higher priority) than the last. | 11283 | specific (and having higher priority) than the last. |
| 11283 | @menu | 11284 | @menu |
| 11284 | * System-wide header arguments:: Set global default values | 11285 | * System-wide header arguments:: Set global default values |
| 11285 | * Language-specific header arguments:: Set default values by language | 11286 | * Language-specific header arguments:: Set default values by language |
| 11286 | * Buffer-wide header arguments:: Set default values for a specific buffer | 11287 | * Buffer-wide header arguments:: Set default values for a specific buffer |
| 11287 | * Header arguments in Org-mode properties:: Set default values for a buffer or heading | 11288 | * Header arguments in Org-mode properties:: Set default values for a buffer or heading |
| 11288 | * Code block specific header arguments:: The most common way to set values | 11289 | * Code block specific header arguments:: The most common way to set values |
| @@ -11419,25 +11420,25 @@ Header arguments for ``Library of Babel'' or function call lines can be set as s | |||
| 11419 | The following header arguments are defined: | 11420 | The following header arguments are defined: |
| 11420 | 11421 | ||
| 11421 | @menu | 11422 | @menu |
| 11422 | * var:: Pass arguments to code blocks | 11423 | * var:: Pass arguments to code blocks |
| 11423 | * results:: Specify the type of results and how they will | 11424 | * results:: Specify the type of results and how they will |
| 11424 | be collected and handled | 11425 | be collected and handled |
| 11425 | * file:: Specify a path for file output | 11426 | * file:: Specify a path for file output |
| 11426 | * dir:: Specify the default (possibly remote) | 11427 | * dir:: Specify the default (possibly remote) |
| 11427 | directory for code block execution | 11428 | directory for code block execution |
| 11428 | * exports:: Export code and/or results | 11429 | * exports:: Export code and/or results |
| 11429 | * tangle:: Toggle tangling and specify file name | 11430 | * tangle:: Toggle tangling and specify file name |
| 11430 | * no-expand:: Turn off variable assignment and noweb | 11431 | * no-expand:: Turn off variable assignment and noweb |
| 11431 | expansion during tangling | 11432 | expansion during tangling |
| 11432 | * comments:: Toggle insertion of comments in tangled | 11433 | * comments:: Toggle insertion of comments in tangled |
| 11433 | code files | 11434 | code files |
| 11434 | * session:: Preserve the state of code evaluation | 11435 | * session:: Preserve the state of code evaluation |
| 11435 | * noweb:: Toggle expansion of noweb references | 11436 | * noweb:: Toggle expansion of noweb references |
| 11436 | * cache:: Avoid re-evaluating unchanged code blocks | 11437 | * cache:: Avoid re-evaluating unchanged code blocks |
| 11437 | * hlines:: Handle horizontal lines in tables | 11438 | * hlines:: Handle horizontal lines in tables |
| 11438 | * colnames:: Handle column names in tables | 11439 | * colnames:: Handle column names in tables |
| 11439 | * rownames:: Handle row names in tables | 11440 | * rownames:: Handle row names in tables |
| 11440 | * shebang:: Make tangled files executable | 11441 | * shebang:: Make tangled files executable |
| 11441 | * eval:: Limit evaluation of specific code blocks | 11442 | * eval:: Limit evaluation of specific code blocks |
| 11442 | @end menu | 11443 | @end menu |
| 11443 | 11444 | ||
| @@ -12292,15 +12293,15 @@ emacsclient \ | |||
| 12292 | @chapter Miscellaneous | 12293 | @chapter Miscellaneous |
| 12293 | 12294 | ||
| 12294 | @menu | 12295 | @menu |
| 12295 | * Completion:: M-TAB knows what you need | 12296 | * Completion:: M-TAB knows what you need |
| 12296 | * Speed keys:: Electric commands at the beginning of a headline | 12297 | * Speed keys:: Electric commands at the beginning of a headline |
| 12297 | * Code evaluation security:: Org mode files evaluate inline code | 12298 | * Code evaluation security:: Org mode files evaluate inline code |
| 12298 | * Customization:: Adapting Org to your taste | 12299 | * Customization:: Adapting Org to your taste |
| 12299 | * In-buffer settings:: Overview of the #+KEYWORDS | 12300 | * In-buffer settings:: Overview of the #+KEYWORDS |
| 12300 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | 12301 | * The very busy C-c C-c key:: When in doubt, press C-c C-c |
| 12301 | * Clean view:: Getting rid of leading stars in the outline | 12302 | * Clean view:: Getting rid of leading stars in the outline |
| 12302 | * TTY keys:: Using Org on a tty | 12303 | * TTY keys:: Using Org on a tty |
| 12303 | * Interaction:: Other Emacs packages | 12304 | * Interaction:: Other Emacs packages |
| 12304 | @end menu | 12305 | @end menu |
| 12305 | 12306 | ||
| 12306 | 12307 | ||
| @@ -12928,8 +12929,8 @@ Org lives in the world of GNU Emacs and interacts in various ways | |||
| 12928 | with other code out there. | 12929 | with other code out there. |
| 12929 | 12930 | ||
| 12930 | @menu | 12931 | @menu |
| 12931 | * Cooperation:: Packages Org cooperates with | 12932 | * Cooperation:: Packages Org cooperates with |
| 12932 | * Conflicts:: Packages that lead to conflicts | 12933 | * Conflicts:: Packages that lead to conflicts |
| 12933 | @end menu | 12934 | @end menu |
| 12934 | 12935 | ||
| 12935 | @node Cooperation, Conflicts, Interaction, Interaction | 12936 | @node Cooperation, Conflicts, Interaction, Interaction |
| @@ -13077,9 +13078,9 @@ fixed this problem: | |||
| 13077 | 13078 | ||
| 13078 | @lisp | 13079 | @lisp |
| 13079 | (add-hook 'org-mode-hook | 13080 | (add-hook 'org-mode-hook |
| 13080 | (lambda () | 13081 | (lambda () |
| 13081 | (org-set-local 'yas/trigger-key [tab]) | 13082 | (org-set-local 'yas/trigger-key [tab]) |
| 13082 | (define-key yas/keymap [tab] 'yas/next-field-group))) | 13083 | (define-key yas/keymap [tab] 'yas/next-field-group))) |
| 13083 | @end lisp | 13084 | @end lisp |
| 13084 | 13085 | ||
| 13085 | @item @file{windmove.el} by Hovav Shacham | 13086 | @item @file{windmove.el} by Hovav Shacham |
| @@ -13121,16 +13122,16 @@ This appendix covers some aspects where users can extend the functionality of | |||
| 13121 | Org. | 13122 | Org. |
| 13122 | 13123 | ||
| 13123 | @menu | 13124 | @menu |
| 13124 | * Hooks:: Who to reach into Org's internals | 13125 | * Hooks:: Who to reach into Org's internals |
| 13125 | * Add-on packages:: Available extensions | 13126 | * Add-on packages:: Available extensions |
| 13126 | * Adding hyperlink types:: New custom link types | 13127 | * Adding hyperlink types:: New custom link types |
| 13127 | * Context-sensitive commands:: How to add functionality to such commands | 13128 | * Context-sensitive commands:: How to add functionality to such commands |
| 13128 | * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs | 13129 | * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs |
| 13129 | * Dynamic blocks:: Automatically filled blocks | 13130 | * Dynamic blocks:: Automatically filled blocks |
| 13130 | * Special agenda views:: Customized views | 13131 | * Special agenda views:: Customized views |
| 13131 | * Extracting agenda information:: Postprocessing of agenda information | 13132 | * Extracting agenda information:: Postprocessing of agenda information |
| 13132 | * Using the property API:: Writing programs that use entry properties | 13133 | * Using the property API:: Writing programs that use entry properties |
| 13133 | * Using the mapping API:: Mapping over all or selected entries | 13134 | * Using the mapping API:: Mapping over all or selected entries |
| 13134 | @end menu | 13135 | @end menu |
| 13135 | 13136 | ||
| 13136 | @node Hooks, Add-on packages, Hacking, Hacking | 13137 | @node Hooks, Add-on packages, Hacking, Hacking |
| @@ -13322,10 +13323,10 @@ can use Org's facilities to edit and structure lists by turning | |||
| 13322 | 13323 | ||
| 13323 | 13324 | ||
| 13324 | @menu | 13325 | @menu |
| 13325 | * Radio tables:: Sending and receiving radio tables | 13326 | * Radio tables:: Sending and receiving radio tables |
| 13326 | * A LaTeX example:: Step by step, almost a tutorial | 13327 | * A LaTeX example:: Step by step, almost a tutorial |
| 13327 | * Translator functions:: Copy and modify | 13328 | * Translator functions:: Copy and modify |
| 13328 | * Radio lists:: Doing the same for lists | 13329 | * Radio lists:: Doing the same for lists |
| 13329 | @end menu | 13330 | @end menu |
| 13330 | 13331 | ||
| 13331 | @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax | 13332 | @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax |
| @@ -14098,9 +14099,9 @@ in-buffer settings, but it will understand the logistics of TODO state | |||
| 14098 | (@pxref{Setting tags}) only for those set in these variables. | 14099 | (@pxref{Setting tags}) only for those set in these variables. |
| 14099 | 14100 | ||
| 14100 | @menu | 14101 | @menu |
| 14101 | * Setting up the staging area:: Where to interact with the mobile device | 14102 | * Setting up the staging area:: Where to interact with the mobile device |
| 14102 | * Pushing to MobileOrg:: Uploading Org files and agendas | 14103 | * Pushing to MobileOrg:: Uploading Org files and agendas |
| 14103 | * Pulling from MobileOrg:: Integrating captured and flagged items | 14104 | * Pulling from MobileOrg:: Integrating captured and flagged items |
| 14104 | @end menu | 14105 | @end menu |
| 14105 | 14106 | ||
| 14106 | @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg | 14107 | @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg |
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index b9c83be457e..775e4788de0 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi | |||
| @@ -16,7 +16,7 @@ | |||
| 16 | 16 | ||
| 17 | @include trampver.texi | 17 | @include trampver.texi |
| 18 | 18 | ||
| 19 | @c Macro for formatting a filename according to the repective syntax. | 19 | @c Macro for formatting a filename according to the respective syntax. |
| 20 | @c xxx and yyy are auxiliary macros in order to omit leading and | 20 | @c xxx and yyy are auxiliary macros in order to omit leading and |
| 21 | @c trailing whitespace. Not very elegant, but I don't know it better. | 21 | @c trailing whitespace. Not very elegant, but I don't know it better. |
| 22 | 22 | ||
| @@ -105,11 +105,6 @@ If you're using the other Emacs flavor, you should read the | |||
| 105 | @end ifset | 105 | @end ifset |
| 106 | 106 | ||
| 107 | @ifhtml | 107 | @ifhtml |
| 108 | @ifset jamanual | ||
| 109 | This manual is also available as a @uref{@value{japanesemanual}, | ||
| 110 | Japanese translation}. | ||
| 111 | @end ifset | ||
| 112 | |||
| 113 | The latest release of @value{tramp} is available for | 108 | The latest release of @value{tramp} is available for |
| 114 | @uref{ftp://ftp.gnu.org/gnu/tramp/, download}, or you may see | 109 | @uref{ftp://ftp.gnu.org/gnu/tramp/, download}, or you may see |
| 115 | @ref{Obtaining Tramp} for more details, including the CVS server | 110 | @ref{Obtaining Tramp} for more details, including the CVS server |
| @@ -171,7 +166,6 @@ Installing @value{tramp} with your @value{emacsname} | |||
| 171 | 166 | ||
| 172 | * Installation parameters:: Parameters in order to control installation. | 167 | * Installation parameters:: Parameters in order to control installation. |
| 173 | * Load paths:: How to plug-in @value{tramp} into your environment. | 168 | * Load paths:: How to plug-in @value{tramp} into your environment. |
| 174 | * Japanese manual:: Japanese manual. | ||
| 175 | 169 | ||
| 176 | @end ifset | 170 | @end ifset |
| 177 | 171 | ||
| @@ -625,10 +619,6 @@ or 2 to connect to the remote host. (You can also specify in | |||
| 625 | @file{~/.ssh/config}, the SSH configuration file, which protocol | 619 | @file{~/.ssh/config}, the SSH configuration file, which protocol |
| 626 | should be used, and use the regular @option{ssh} method.) | 620 | should be used, and use the regular @option{ssh} method.) |
| 627 | 621 | ||
| 628 | Two other variants, @option{ssh1_old} and @option{ssh2_old}, use the | ||
| 629 | @command{ssh1} and @command{ssh2} commands explicitly. If you don't | ||
| 630 | know what these are, you do not need these options. | ||
| 631 | |||
| 632 | All the methods based on @command{ssh} have an additional feature: you | 622 | All the methods based on @command{ssh} have an additional feature: you |
| 633 | can specify a host name which looks like @file{host#42} (the real host | 623 | can specify a host name which looks like @file{host#42} (the real host |
| 634 | name, then a hash sign, then a port number). This means to connect to | 624 | name, then a hash sign, then a port number). This means to connect to |
| @@ -737,19 +727,6 @@ expects PuTTY session names, calling @samp{plink -load @var{session} | |||
| 737 | hasn't defined a user name. Different port numbers must be defined in | 727 | hasn't defined a user name. Different port numbers must be defined in |
| 738 | the session. | 728 | the session. |
| 739 | 729 | ||
| 740 | |||
| 741 | @item @option{fish} | ||
| 742 | @cindex method fish | ||
| 743 | @cindex fish method | ||
| 744 | |||
| 745 | This is an experimental implementation of the fish protocol, known from | ||
| 746 | the GNU Midnight Commander or the KDE Konqueror. @value{tramp} expects | ||
| 747 | the fish server implementation from the KDE kioslave. That means, the | ||
| 748 | file @file{~/.fishsrv.pl} is expected to reside on the remote host. | ||
| 749 | |||
| 750 | The implementation lacks good performance. The code is offered anyway, | ||
| 751 | maybe somebody can improve the performance. | ||
| 752 | |||
| 753 | @end table | 730 | @end table |
| 754 | 731 | ||
| 755 | 732 | ||
| @@ -809,10 +786,6 @@ or 2 to connect to the remote host. (You can also specify in | |||
| 809 | @file{~/.ssh/config}, the SSH configuration file, which protocol | 786 | @file{~/.ssh/config}, the SSH configuration file, which protocol |
| 810 | should be used, and use the regular @option{scp} method.) | 787 | should be used, and use the regular @option{scp} method.) |
| 811 | 788 | ||
| 812 | Two other variants, @option{scp1_old} and @option{scp2_old}, use the | ||
| 813 | @command{ssh1} and @command{ssh2} commands explicitly. If you don't | ||
| 814 | know what these are, you do not need these options. | ||
| 815 | |||
| 816 | All the @command{ssh} based methods support the @samp{-p} feature | 789 | All the @command{ssh} based methods support the @samp{-p} feature |
| 817 | where you can specify a port number to connect to in the host name. | 790 | where you can specify a port number to connect to in the host name. |
| 818 | For example, the host name @file{host#42} tells @value{tramp} to | 791 | For example, the host name @file{host#42} tells @value{tramp} to |
diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 25fa4908143..107e4d70aa3 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi | |||
| @@ -9,7 +9,7 @@ | |||
| 9 | @c In the Tramp CVS, the version number is auto-frobbed from | 9 | @c In the Tramp CVS, the version number is auto-frobbed from |
| 10 | @c configure.ac, so you should edit that file and run | 10 | @c configure.ac, so you should edit that file and run |
| 11 | @c "autoconf && ./configure" to change the version number. | 11 | @c "autoconf && ./configure" to change the version number. |
| 12 | @set trampver 2.1.19 | 12 | @set trampver 2.2.0-pre |
| 13 | 13 | ||
| 14 | @c Other flags from configuration | 14 | @c Other flags from configuration |
| 15 | @set instprefix /usr/local | 15 | @set instprefix /usr/local |
| @@ -56,7 +56,6 @@ | |||
| 56 | @set emacsothername XEmacs | 56 | @set emacsothername XEmacs |
| 57 | @set emacsotherdir xemacs | 57 | @set emacsotherdir xemacs |
| 58 | @set emacsotherfilename tramp-xemacs.html | 58 | @set emacsotherfilename tramp-xemacs.html |
| 59 | @set japanesemanual tramp_ja-emacs.html | ||
| 60 | @end ifset | 59 | @end ifset |
| 61 | 60 | ||
| 62 | @c XEmacs counterparts. | 61 | @c XEmacs counterparts. |
| @@ -73,7 +72,6 @@ | |||
| 73 | @set emacsothername GNU Emacs | 72 | @set emacsothername GNU Emacs |
| 74 | @set emacsotherdir emacs | 73 | @set emacsotherdir emacs |
| 75 | @set emacsotherfilename tramp-emacs.html | 74 | @set emacsotherfilename tramp-emacs.html |
| 76 | @set japanesemanual tramp_ja-xemacs.html | ||
| 77 | @end ifset | 75 | @end ifset |
| 78 | 76 | ||
| 79 | @ignore | 77 | @ignore |