diff options
Diffstat (limited to 'doc')
41 files changed, 3082 insertions, 1699 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 794771e24d3..2407d7dd18f 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,67 @@ +2011-08-29 Chong Yidong <cyd@stupidchicken.com> + + * modes.texi (Choosing Modes): auto-mode-case-fold is now t. + +2011-08-28 Chong Yidong <cyd@stupidchicken.com> + + * files.texi (File Archives): + * cal-xtra.texi (Diary Display): + * help.texi (Help Mode): Add xref to View Mode. + +2011-08-28 Chong Yidong <cyd@stupidchicken.com> + + * display.texi (View Mode): New node. Move view-file here from + Misc File Ops. Move view-buffer here from Misc Buffer. + + * buffers.texi (Misc Buffer): Move view-buffer to View Mode. + + * files.texi (Misc File Ops): Document new + delete-by-moving-to-trash behavior. Remove view-file. + + * dired.texi (Dired Deletion): Shorten description of Trash. + + * misc.texi (emacsclient Options): Document server-port. + +2011-08-27 Eli Zaretskii <eliz@gnu.org> + + * frames.texi (Frame Commands): Advise setting focus-follows-mouse + even on MS-Windows. Fix a typo. + +2011-08-26 Chong Yidong <cyd@stupidchicken.com> + + * package.texi: New file, documenting the package manager. + + * emacs.texi: Include it. + + * help.texi (Help Summary): Add describe-package. + +2011-08-25 Chong Yidong <cyd@stupidchicken.com> + + * misc.texi (Printing): Convert subnodes into subsections. + + * text.texi (Two-Column): Move into Text chapter. + + * picture-xtra.texi (Picture Mode): Group with Editing Binary + Files section. Convert from chapter into section. + + * display.texi (Narrowing): Move into display chapter. + + * sending.texi (Sending Mail): + * rmail.texi (Rmail): + * misc.texi (Gnus, Document View): + * dired.texi (Dired): + * emacs.texi: Group the mail, rmail, and gnus chapters together. + +2011-08-07 Juri Linkov <juri@jurta.org> + + * dired.texi (Operating on Files): Rewrite according to the fact + that `dired-do-chmod' doesn't use the `chmod' program anymore. + +2011-07-30 Michael Albinus <michael.albinus@gmx.de> + + * mini.texi (Minibuffer File): Insert a reference to Tramp for + remote file name completion. (Bug#9197) + 2011-07-28 Eli Zaretskii <eliz@gnu.org> * mule.texi (Bidirectional Editing): Document the fact that diff --git a/doc/emacs/Makefile.in b/doc/emacs/Makefile.in index 9465c726eba..66cd7f1d92e 100644 --- a/doc/emacs/Makefile.in +++ b/doc/emacs/Makefile.in @@ -96,6 +96,7 @@ EMACSSOURCES= \ ${srcdir}/dired.texi \ ${srcdir}/calendar.texi \ ${srcdir}/misc.texi \ + ${srcdir}/package.texi \ ${srcdir}/custom.texi \ ${srcdir}/trouble.texi \ ${srcdir}/cmdargs.texi \ diff --git a/doc/emacs/buffers.texi b/doc/emacs/buffers.texi index d4cc4f7bb6a..c4880af2b5d 100644 --- a/doc/emacs/buffers.texi +++ b/doc/emacs/buffers.texi @@ -285,16 +285,6 @@ buffers with particular names. (With some of these features, such as switch to some other buffer before using the command, in order for it to make a different buffer.) -@findex view-buffer - @kbd{M-x view-buffer} is much like @kbd{M-x view-file} (@pxref{Misc -File Ops}) except that it examines an already existing Emacs buffer. -View mode provides commands for scrolling through the buffer -conveniently but not for changing it. When you exit View mode with -@kbd{q}, that switches back to the buffer (and the position) which was -previously displayed in the window. Alternatively, if you exit View -mode with @kbd{e}, the buffer and the value of point that resulted from -your perusal remain in effect. - The commands @kbd{M-x append-to-buffer} and @kbd{M-x insert-buffer} can be used to copy text from one buffer to another. @xref{Accumulating Text}. diff --git a/doc/emacs/cal-xtra.texi b/doc/emacs/cal-xtra.texi index 52898efc268..6d20c92a6d9 100644 --- a/doc/emacs/cal-xtra.texi +++ b/doc/emacs/cal-xtra.texi @@ -538,13 +538,7 @@ are no diary entries, even if that day is a holiday. If you want such days to be shown in the fancy diary buffer, set the variable @code{diary-list-include-blanks} to @code{t}.@refill -@c View mode does not seem to be described in the manual. -@c buffers.texi has a brief mention. - The fancy diary buffer enables View mode, a minor mode that provides -commands for scrolling and searching the text. For example, @key{SPC} -and @key{DEL} scroll forward and backward, and @key{s} starts an -incremental search. See the documentation of the function -@code{view-mode} for more information. + The fancy diary buffer enables View mode (@pxref{View Mode}). The alternative display method @code{diary-simple-display} shows the actual diary buffer, and uses invisible text to hide entries that don't diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 9de223854c1..71a2dba7d08 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi @@ -2,7 +2,7 @@ @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2011 @c Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. -@node Calendar/Diary, Document View, Dired, Top +@node Calendar/Diary @chapter The Calendar and the Diary @cindex calendar @findex calendar diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index 6a6d465438d..a22d6c1f5dd 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi @@ -2,7 +2,7 @@ @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2011 @c Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. -@node Customization, Quitting, Amusements, Top +@node Customization @chapter Customization @cindex customization diff --git a/doc/emacs/dired.texi b/doc/emacs/dired.texi index 501c4152e6a..eb2bcc109e8 100644 --- a/doc/emacs/dired.texi +++ b/doc/emacs/dired.texi @@ -2,7 +2,7 @@ @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2011 @c Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. -@node Dired, Calendar/Diary, Rmail, Top +@node Dired @chapter Dired, the Directory Editor @c This node is referenced in the tutorial. When renaming or deleting @c it, the tutorial needs to be adjusted. @@ -201,12 +201,10 @@ delete nonempty directories including all their contents. That can be somewhat risky. @vindex delete-by-moving-to-trash - On some systems, there is a facility called the ``Trash'' or -``Recycle Bin'', but Emacs does @emph{not} use it by default. Thus, -when you delete a file in Dired, it is gone forever. However, you can -tell Emacs to use the Trash for file deletion, by changing the -variable @code{delete-by-moving-to-trash} to @code{t}. @xref{Misc -File Ops}, for more information about the Trash. + If you change the variable @code{delete-by-moving-to-trash} to +@code{t}, the above deletion commands will move the affected files or +directories into the operating system's Trash, instead of deleting +them outright. @xref{Misc File Ops}. @node Flagging Many Files @section Flagging Many Files at Once @@ -645,8 +643,8 @@ link. @cindex changing file permissions (in Dired) @item M @var{modespec} @key{RET} Change the mode (also called ``permission bits'') of the specified files -(@code{dired-do-chmod}). This uses the @code{chmod} program, so -@var{modespec} can be any argument that @code{chmod} can handle. +(@code{dired-do-chmod}). @var{modespec} can be in octal or symbolic +notation like arguments handled by the @code{chmod} program. @findex dired-do-chgrp @kindex G @r{(Dired)} diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index bfbfb355c9c..09e365d9d5f 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -15,6 +15,9 @@ want to see, and how to display it. * Scrolling:: Commands to move text up and down in a window. * Auto Scrolling:: Redisplay scrolls text automatically when needed. * Horizontal Scrolling:: Moving text left and right in a window. +* Narrowing:: Restricting display and editing to a portion + of the buffer. +* View Mode:: Viewing read-only buffers. * Follow Mode:: Follow mode lets two windows scroll as one. * Faces:: How to change the display style using faces. * Standard Faces:: Emacs' predefined faces. @@ -300,6 +303,94 @@ a lower bound for automatic horizontal scrolling. Automatic scrolling will continue to scroll the window, but never farther to the right than the amount you previously set by @code{scroll-left}. +@node Narrowing +@section Narrowing +@cindex widening +@cindex restriction +@cindex narrowing +@cindex accessible portion + + @dfn{Narrowing} means focusing in on some portion of the buffer, +making the rest temporarily inaccessible. The portion which you can +still get to is called the @dfn{accessible portion}. Canceling the +narrowing, which makes the entire buffer once again accessible, is +called @dfn{widening}. The bounds of narrowing in effect in a buffer +are called the buffer's @dfn{restriction}. + + Narrowing can make it easier to concentrate on a single subroutine or +paragraph by eliminating clutter. It can also be used to limit the +range of operation of a replace command or repeating keyboard macro. + +@table @kbd +@item C-x n n +Narrow down to between point and mark (@code{narrow-to-region}). +@item C-x n w +Widen to make the entire buffer accessible again (@code{widen}). +@item C-x n p +Narrow down to the current page (@code{narrow-to-page}). +@item C-x n d +Narrow down to the current defun (@code{narrow-to-defun}). +@end table + + When you have narrowed down to a part of the buffer, that part appears +to be all there is. You can't see the rest, you can't move into it +(motion commands won't go outside the accessible part), you can't change +it in any way. However, it is not gone, and if you save the file all +the inaccessible text will be saved. The word @samp{Narrow} appears in +the mode line whenever narrowing is in effect. + +@kindex C-x n n +@findex narrow-to-region + The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}). +It sets the current buffer's restrictions so that the text in the current +region remains accessible, but all text before the region or after the +region is inaccessible. Point and mark do not change. + +@kindex C-x n p +@findex narrow-to-page +@kindex C-x n d +@findex narrow-to-defun + Alternatively, use @kbd{C-x n p} (@code{narrow-to-page}) to narrow +down to the current page. @xref{Pages}, for the definition of a page. +@kbd{C-x n d} (@code{narrow-to-defun}) narrows down to the defun +containing point (@pxref{Defuns}). + +@kindex C-x n w +@findex widen + The way to cancel narrowing is to widen with @kbd{C-x n w} +(@code{widen}). This makes all text in the buffer accessible again. + + You can get information on what part of the buffer you are narrowed down +to using the @kbd{C-x =} command. @xref{Position Info}. + + Because narrowing can easily confuse users who do not understand it, +@code{narrow-to-region} is normally a disabled command. Attempting to use +this command asks for confirmation and gives you the option of enabling it; +if you enable the command, confirmation will no longer be required for +it. @xref{Disabling}. + +@node View Mode +@section View Mode +@cindex View mode +@cindex mode, View + + View mode is a minor mode that lets you scan a buffer by sequential +screenfuls. It provides commands for scrolling through the buffer +conveniently but not for changing it. Apart from the usual Emacs +cursor motion commands, you can type @key{SPC} to scroll forward one +windowful, @key{DEL} to scroll backward, and @kbd{s} to start an +incremental search. + + Typing @kbd{q} disables View mode, and switches back to the buffer +and position before View mode was enabled. Alternatively, typing +@kbd{e} disables View mode, keeping the current buffer and position. + +@findex view-buffer +@findex view-file + @kbd{M-x view-buffer} prompts for an existing Emacs buffer, switches +to it, and enables View mode. @kbd{M-x view-file} prompts for a file +and visits it with View mode enabled. + @node Follow Mode @section Follow Mode @cindex Follow mode diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index e8fb42db0bb..2ba4af712af 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -187,39 +187,32 @@ Major Structures of Emacs Advanced Features * Modes:: Major and minor modes alter Emacs' basic behavior. * Indentation:: Editing the white space at the beginnings of lines. -* Text:: Commands and modes for editing English. +* Text:: Commands and modes for editing human languages. * Programs:: Commands and modes for editing programs. * Building:: Compiling, running and debugging programs. * Maintaining:: Features for maintaining large programs. * Abbrevs:: Defining text abbreviations to reduce the number of characters you must type. -@c AFAICS, the tex stuff generates its own index and does not use this one. -@ifnottex -* Picture Mode:: Editing pictures made up of characters using - the quarter-plane screen model. -@end ifnottex +* Dired:: Directory and file manager. +* Calendar/Diary:: Calendar and diary facilities. * Sending Mail:: Sending mail in Emacs. * Rmail:: Reading mail in Emacs. -* Dired:: You can "edit" a directory to manage files in it. -* Calendar/Diary:: The calendar and diary facilities. -* Document View:: Viewing PDF, PS and DVI files. * Gnus:: A flexible mail and news reader. +* Document View:: Viewing PDF, PS and DVI files. * Shell:: Executing shell commands from Emacs. * Emacs Server:: Using Emacs as an editing server. * Printing:: Printing hardcopies of buffers or regions. * Sorting:: Sorting lines, paragraphs or pages within Emacs. -* Narrowing:: Restricting display and editing to a portion - of the buffer. -* Two-Column:: Splitting apart columns to edit them - in side-by-side windows. -* Editing Binary Files::Using Hexl mode to edit binary files. +@ifnottex +* Picture Mode:: Editing pictures made up of text characters. +@end ifnottex +* Editing Binary Files:: Editing binary files with Hexl mode. * Saving Emacs Sessions:: Saving Emacs state from one session to the next. -* Recursive Edit:: A command can allow you to do editing - "within the command". This is called a - "recursive editing level". +* Recursive Edit:: Performing edits while "within another command". * Emulation:: Emulating some other editors with Emacs. * Hyperlinking:: Following links in buffers. * Amusements:: Various games and hacks. +* Packages:: Installing additional features. * Customization:: Modifying the behavior of Emacs. Recovery from Problems @@ -350,6 +343,9 @@ Controlling the Display * Scrolling:: Commands to move text up and down in a window. * Auto Scrolling:: Redisplay scrolls text automatically when needed. * Horizontal Scrolling:: Moving text left and right in a window. +* Narrowing:: Restricting display and editing to a portion + of the buffer. +* View Mode:: Viewing read-only buffers. * Follow Mode:: Follow mode lets two windows scroll as one. * Faces:: How to change the display style using faces. * Standard Faces:: Emacs' predefined faces. @@ -577,6 +573,7 @@ Commands for Human Languages * Nroff Mode:: Editing input to the formatter nroff. * Formatted Text:: Editing formatted text directly in WYSIWYG fashion. * Text Based Tables:: Editing text-based tables in WYSIWYG fashion. +* Two-Column:: Splitting text columns into separate windows. Filling Text @@ -885,52 +882,6 @@ Editing Pictures * Rectangles in Picture:: Clearing and superimposing rectangles. @end ifnottex -Sending Mail - -* Mail Format:: Format of the mail being composed. -* Mail Headers:: Details of some standard mail header fields. -* Mail Aliases:: Abbreviating and grouping mail addresses. -* Mail Commands:: Special commands for editing mail being composed. -* Mail Signature:: Adding a signature to every message. -* Mail Amusements:: Distracting the NSA; adding fortune messages. -* Mail Methods:: Using alternative mail-composition methods. - -Mail Commands - -* Mail Sending:: Commands to send the message. -* Header Editing:: Commands to move to header fields and edit them. -* Citing Mail:: Quoting a message you are replying to. -* Mail Misc:: Attachments, spell checking, etc. - -Reading Mail with Rmail - -* Rmail Basics:: Basic concepts of Rmail, and simple use. -* Rmail Scrolling:: Scrolling through a message. -* Rmail Motion:: Moving to another message. -* Rmail Deletion:: Deleting and expunging messages. -* Rmail Inbox:: How mail gets into the Rmail file. -* Rmail Files:: Using multiple Rmail files. -* Rmail Output:: Copying message out to files. -* Rmail Labels:: Classifying messages by labeling them. -* Rmail Attributes:: Certain standard labels, called attributes. -* Rmail Reply:: Sending replies to messages you are viewing. -* Rmail Summary:: Summaries show brief info on many messages. -* Rmail Sorting:: Sorting messages in Rmail. -* Rmail Display:: How Rmail displays a message; customization. -* Rmail Coding:: How Rmail handles decoding character sets. -* Rmail Editing:: Editing message text and headers in Rmail. -* Rmail Digest:: Extracting the messages from a digest message. -* Rmail Rot13:: Reading messages encoded in the rot13 code. -* Movemail:: More details of fetching new mail. -* Remote Mailboxes:: Retrieving mail from remote mailboxes. -* Other Mailbox Formats:: Retrieving mail from local mailboxes in - various formats. - -Summaries - -* Rmail Make Summary:: Making various sorts of summaries. -* Rmail Summary Edit:: Manipulating messages from the summary. - Dired, the Directory Editor * Dired Enter:: How to invoke Dired. @@ -1014,6 +965,52 @@ Document Viewing * Slicing:: Specifying which part of pages should be displayed. * Conversion:: Influencing and triggering conversion. +Sending Mail + +* Mail Format:: Format of the mail being composed. +* Mail Headers:: Details of some standard mail header fields. +* Mail Aliases:: Abbreviating and grouping mail addresses. +* Mail Commands:: Special commands for editing mail being composed. +* Mail Signature:: Adding a signature to every message. +* Mail Amusements:: Distracting the NSA; adding fortune messages. +* Mail Methods:: Using alternative mail-composition methods. + +Mail Commands + +* Mail Sending:: Commands to send the message. +* Header Editing:: Commands to move to header fields and edit them. +* Citing Mail:: Quoting a message you are replying to. +* Mail Misc:: Attachments, spell checking, etc. + +Reading Mail with Rmail + +* Rmail Basics:: Basic concepts of Rmail, and simple use. +* Rmail Scrolling:: Scrolling through a message. +* Rmail Motion:: Moving to another message. +* Rmail Deletion:: Deleting and expunging messages. +* Rmail Inbox:: How mail gets into the Rmail file. +* Rmail Files:: Using multiple Rmail files. +* Rmail Output:: Copying message out to files. +* Rmail Labels:: Classifying messages by labeling them. +* Rmail Attributes:: Certain standard labels, called attributes. +* Rmail Reply:: Sending replies to messages you are viewing. +* Rmail Summary:: Summaries show brief info on many messages. +* Rmail Sorting:: Sorting messages in Rmail. +* Rmail Display:: How Rmail displays a message; customization. +* Rmail Coding:: How Rmail handles decoding character sets. +* Rmail Editing:: Editing message text and headers in Rmail. +* Rmail Digest:: Extracting the messages from a digest message. +* Rmail Rot13:: Reading messages encoded in the rot13 code. +* Movemail:: More details of fetching new mail. +* Remote Mailboxes:: Retrieving mail from remote mailboxes. +* Other Mailbox Formats:: Retrieving mail from local mailboxes in + various formats. + +Rmail Summaries + +* Rmail Make Summary:: Making various sorts of summaries. +* Rmail Summary Edit:: Manipulating messages from the summary. + Gnus * Buffers of Gnus:: The group, summary, and article buffers. @@ -1058,6 +1055,12 @@ Hyperlinking and Navigation Features * Goto Address mode:: Activating URLs. * FFAP:: Finding files etc. at point. +Emacs Lisp Packages + +* Package Menu:: Buffer for viewing and managing packages. +* Package Installation:: Options for package installation. +* Package Files:: Where packages are installed. + Customization * Easy Customization:: Convenient way to browse and change settings. @@ -1494,16 +1497,15 @@ Lisp programming. @c Includes vc1-xtra, emerge-xtra. @include maintaining.texi @include abbrevs.texi -@ifnottex -@include picture-xtra.texi -@end ifnottex -@include sending.texi -@include rmail.texi @c Includes dired-xtra. @include dired.texi @c Includes cal-xtra. @include calendar.texi +@include sending.texi +@include rmail.texi +@c Includes picture-xtra.texi @include misc.texi +@include package.texi @include custom.texi @include trouble.texi diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index 793a11e62ed..2672c30363b 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi @@ -1272,11 +1272,11 @@ this, it runs the program specified by The command @kbd{M-x delete-directory} prompts for a directory name using the minibuffer, and deletes the directory if it is empty. If the directory is not empty, you will be asked whether you want to -delete it recursively. On systems that have a ``Trash'' or ``Recycle -Bin'' feature, you can make this command move the specified directory -to the Trash or Recycle Bin, instead of deleting it outright, by -changing the variable @code{delete-by-moving-to-trash} to @code{t}. -@xref{Misc File Ops}, for more information about using the Trash. +delete it recursively. On systems that have a ``Trash'' (or ``Recycle +Bin'') feature, you can make this command move the specified directory +to the Trash instead of deleting it outright, by changing the variable +@code{delete-by-moving-to-trash} to @code{t}. @xref{Misc File Ops}, +for more information about using the Trash. @node Comparing Files @section Comparing Files @@ -1503,23 +1503,78 @@ patch syntax (@pxref{Useless Whitespace}). Emacs has commands for performing many other operations on files. All operate on one file; they do not accept wildcard file names. -@findex view-file -@cindex viewing -@cindex View mode -@cindex mode, View - @kbd{M-x view-file} allows you to scan or read a file by sequential -screenfuls. It reads a file name argument using the minibuffer. After -reading the file into an Emacs buffer, @code{view-file} displays the -beginning. You can then type @key{SPC} to scroll forward one windowful, -or @key{DEL} to scroll backward. Various other commands are provided -for moving around in the file, but none for changing it; type @kbd{?} -while viewing for a list of them. They are mostly the same as normal -Emacs cursor motion commands. To exit from viewing, type @kbd{q}. -The commands for viewing are defined by a special minor mode called View -mode. - - A related command, @kbd{M-x view-buffer}, views a buffer already present -in Emacs. @xref{Misc Buffer}. +@findex delete-file +@cindex deletion (of files) + @kbd{M-x delete-file} prompts for a file and deletes it. If you are +deleting many files in one directory, it may be more convenient to use +Dired rather than @code{delete-file}. @xref{Dired Deletion}. + +@cindex trash +@cindex recycle bin + @kbd{M-x move-file-to-trash} moves a file into the system +@dfn{Trash} (or @dfn{Recycle Bin}). This is a facility available on +most operating systems; files that are moved into the Trash can be +brought back later if you change your mind. + +@vindex delete-by-moving-to-trash + By default, Emacs deletion commands do @emph{not} use the Trash. To +use the Trash (when it is available) for common deletion commands, +change the variable @code{delete-by-moving-to-trash} to @code{t}. +This affects the commands @kbd{M-x delete-file} and @kbd{M-x +delete-directory} (@pxref{Directories}), as well as the deletion +commands in Dired (@pxref{Dired Deletion}). Supplying a prefix +argument to @kbd{M-x delete-file} or @kbd{M-x delete-directory} makes +them delete outright, instead of using the Trash, regardless of +@code{delete-by-moving-to-trash}. + +@findex copy-file +@cindex copying files + @kbd{M-x copy-file} reads the file @var{old} and writes a new file +named @var{new} with the same contents. + +@findex copy-directory + @kbd{M-x copy-directory} copies directories, similar to the +@command{cp -r} shell command. It prompts for a directory @var{old} +and a destination @var{new}. If @var{new} is an existing directory, +it creates a copy of the @var{old} directory and puts it in @var{new}. +If @var{new} is not an existing directory, it copies all the contents +of @var{old} into a new directory named @var{new}. + +@findex rename-file + @kbd{M-x rename-file} reads two file names @var{old} and @var{new} +using the minibuffer, then renames file @var{old} as @var{new}. If +the file name @var{new} already exists, you must confirm with +@kbd{yes} or renaming is not done; this is because renaming causes the +old meaning of the name @var{new} to be lost. If @var{old} and +@var{new} are on different file systems, the file @var{old} is copied +and deleted. If the argument @var{new} is just a directory name, the +real new name is in that directory, with the same non-directory +component as @var{old}. For example, @kbd{M-x rename-file RET ~/foo +RET /tmp RET} renames @file{~/foo} to @file{/tmp/foo}. The same rule +applies to all the remaining commands in this section. All of them +ask for confirmation when the new file name already exists, too. + +@findex add-name-to-file +@cindex hard links (creation) + @kbd{M-x add-name-to-file} adds an additional name to an existing +file without removing its old name. The new name is created as a +``hard link'' to the existing file. The new name must belong on the +same file system that the file is on. On MS-Windows, this command +works only if the file resides in an NTFS file system. On MS-DOS, it +works by copying the file. + +@findex make-symbolic-link +@cindex symbolic links (creation) + @kbd{M-x make-symbolic-link} reads two file names @var{target} and +@var{linkname}, then creates a symbolic link named @var{linkname}, +which points at @var{target}. The effect is that future attempts to +open file @var{linkname} will refer to whatever file is named +@var{target} at the time the opening is done, or will get an error if +the name @var{target} is nonexistent at that time. This command does +not expand the argument @var{target}, so that it allows you to specify +a relative name as the target of the link. Not all systems support +symbolic links; on systems that don't support them, this command is +not defined. @kindex C-x i @findex insert-file @@ -1544,74 +1599,6 @@ specified file. @xref{Accumulating Text}. The variable @code{write-region-inhibit-fsync} applies to these commands, as well as saving files; see @ref{Customize Save}. -@findex delete-file -@cindex deletion (of files) -@vindex delete-by-moving-to-trash - @kbd{M-x delete-file} deletes the specified file, like the @code{rm} -command in the shell. If you are deleting many files in one -directory, it may be more convenient to use Dired rather than -@code{delete-file}. @xref{Dired}. - -@cindex trash -@cindex recycle bin - On some systems, there is a facility called the ``Trash'' (or -``Recycle Bin''); ``deleting'' a file normally means moving it into -the Trash, and you can bring the file back from the Trash if you later -change your mind. By default, Emacs does @emph{not} use the Trash for -file deletion---when Emacs deletes a file, it is gone forever. You -can tell Emacs to use the Trash by changing the variable -@code{delete-by-moving-to-trash} to @code{t}. This applies to file -deletion via @kbd{M-x delete-file}, as well as @kbd{M-x -delete-directory} (@pxref{Directories}) and file deletion in Dired -(@pxref{Dired Deletion}). In addition, you can explicitly move a file -into the Trash with the command @kbd{M-x move-file-to-trash}. - -@findex rename-file - @kbd{M-x rename-file} reads two file names @var{old} and @var{new} using -the minibuffer, then renames file @var{old} as @var{new}. If the file name -@var{new} already exists, you must confirm with @kbd{yes} or renaming is not -done; this is because renaming causes the old meaning of the name @var{new} -to be lost. If @var{old} and @var{new} are on different file systems, the -file @var{old} is copied and deleted. - - If the argument @var{new} is just a directory name, the real new -name is in that directory, with the same non-directory component as -@var{old}. For example, @kbd{M-x rename-file RET ~/foo RET /tmp RET} -renames @file{~/foo} to @file{/tmp/foo}. The same rule applies to all -the remaining commands in this section. All of them ask for -confirmation when the new file name already exists, too. - -@findex add-name-to-file -@cindex hard links (creation) - The similar command @kbd{M-x add-name-to-file} is used to add an -additional name to an existing file without removing its old name. -The new name is created as a ``hard link'' to the existing file. -The new name must belong on the same file system that the file is on. -On MS-Windows, this command works only if the file resides in an NTFS -file system. On MS-DOS, it works by copying the file. - -@findex copy-file -@findex copy-directory -@cindex copying files - @kbd{M-x copy-file} reads the file @var{old} and writes a new file -named @var{new} with the same contents. @kbd{M-x copy-directory} does -the same for directories, by recursive copying all files and -subdirectories. - -@findex make-symbolic-link -@cindex symbolic links (creation) - @kbd{M-x make-symbolic-link} reads two file names @var{target} and -@var{linkname}, then creates a symbolic link named @var{linkname}, -which points at @var{target}. The effect is that future attempts to -open file @var{linkname} will refer to whatever file is named -@var{target} at the time the opening is done, or will get an error if -the name @var{target} is nonexistent at that time. This command does -not expand the argument @var{target}, so that it allows you to specify -a relative name as the target of the link. - - Not all systems support symbolic links; on systems that don't -support them, this command is not defined. - @findex set-file-modes @cindex file modes @cindex file permissions @@ -1670,13 +1657,13 @@ Tar mode is used also for compressed archives---files with extensions The keys @kbd{e}, @kbd{f} and @key{RET} all extract a component file into its own buffer. You can edit it there, and if you save the buffer, the edited version will replace the version in the Tar buffer. -@kbd{v} extracts a file into a buffer in View mode. @kbd{o} extracts -the file and displays it in another window, so you could edit the file -and operate on the archive simultaneously. @kbd{d} marks a file for -deletion when you later use @kbd{x}, and @kbd{u} unmarks a file, as in -Dired. @kbd{C} copies a file from the archive to disk and @kbd{R} -renames a file within the archive. @kbd{g} reverts the buffer from -the archive on disk. +@kbd{v} extracts a file into a buffer in View mode (@pxref{View +Mode}). @kbd{o} extracts the file and displays it in another window, +so you could edit the file and operate on the archive simultaneously. +@kbd{d} marks a file for deletion when you later use @kbd{x}, and +@kbd{u} unmarks a file, as in Dired. @kbd{C} copies a file from the +archive to disk and @kbd{R} renames a file within the archive. +@kbd{g} reverts the buffer from the archive on disk. The keys @kbd{M}, @kbd{G}, and @kbd{O} change the file's permission bits, group, and owner, respectively. diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index b9b56670988..328deaec357 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi @@ -467,12 +467,14 @@ for Emacs to detect this automatically, so you should set the variable @code{focus-follows-mouse}. The default is @code{nil}, meaning you have to click on the window to select it (the default for most modern window managers). You should change it to @code{t} if your window -manager selects and window and gives it focus anytime you move the -mouse onto the window. +manager selects a window and gives it focus anytime you move the mouse +onto the window. The window manager that is part of MS-Windows always gives focus to a frame that raises, so this variable has no effect in the native -MS-Windows build of Emacs. +MS-Windows build of Emacs. However, you may still wish to set this +variable to @code{t} to have Emacs automatically move the mouse +pointer to the raised frame. @node Fonts @section Fonts diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 9a75bfb1887..9ff995138f5 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -126,16 +126,20 @@ The complete Emacs manual is available on-line in Info. Display the name and documentation of the command that @var{key} runs (@code{describe-key}). @item C-h l -Display a description of your last 300 keystrokes +Display a description of your last 300 keystrokes (@code{view-lossage}). @item C-h m Display documentation of the current major mode (@code{describe-mode}). @item C-h n Display news of recent Emacs changes (@code{view-emacs-news}). @item C-h p -Find packages by topic keyword (@code{finder-by-keyword}). For an -alternative interface to the same information, try the @code{info-finder} -command. +Find packages by topic keyword (@code{finder-by-keyword}). This lists +packages using a package menu buffer (@pxref{Package Menu}); for an +alternative interface to the same information, try the +@code{info-finder} command. +@item C-h P @var{package} @key{RET} +Display documentation about the package named @var{package} +(@code{describe-package}; @pxref{Packages}). @item C-h r Display the Emacs manual in Info (@code{info-emacs-manual}). @item C-h s @@ -401,8 +405,8 @@ the variable @code{apropos-documentation-sort-by-scores} is @node Help Mode @section Help Mode Commands - Help buffers provide the same commands as View mode (@pxref{Misc File -Ops}), plus a few special commands of their own. + Help buffers provide the same commands as View mode (@pxref{View +Mode}), plus a few special commands of their own. @table @kbd @item @key{SPC} diff --git a/doc/emacs/makefile.w32-in b/doc/emacs/makefile.w32-in index 4064f4ef6a3..e128a50ebd3 100644 --- a/doc/emacs/makefile.w32-in +++ b/doc/emacs/makefile.w32-in @@ -88,6 +88,7 @@ EMACSSOURCES= \ $(srcdir)/dired.texi \ $(srcdir)/calendar.texi \ $(srcdir)/misc.texi \ + $(srcdir)/package.texi \ $(srcdir)/custom.texi \ $(srcdir)/trouble.texi \ $(srcdir)/cmdargs.texi \ diff --git a/doc/emacs/mini.texi b/doc/emacs/mini.texi index ce0d396fd0d..da1e88ab331 100644 --- a/doc/emacs/mini.texi +++ b/doc/emacs/mini.texi @@ -125,6 +125,10 @@ file names, change the variable @code{insert-default-directory} to Nonetheless, relative file name arguments are still interpreted based on the same default directory. + For rules how to read remote file names in the minibuffer, see +@ref{Filename completion, file name completion,, tramp}, in the Tramp +manual. + @node Minibuffer Edit @section Editing in the Minibuffer @@ -491,7 +495,7 @@ argument (@code{previous-history-element}). Move to the next item in the minibuffer history (@code{next-history-element}). @item M-r @var{regexp} @key{RET} -Move to an earlier item in the minibuffer history that +Move to an earlier item in the minibuffer history that matches @var{regexp} (@code{previous-matching-history-element}). @item M-s @var{regexp} @key{RET} Move to a later item in the minibuffer history that matches diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 426610e65b9..598f495784f 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -10,9 +10,9 @@ else: viewing ``document files'', reading netnews, running shell commands and shell subprocesses, using a single shared Emacs for utilities that expect to run an editor as a subprocess, printing hardcopy, sorting text, narrowing display to part of the buffer, -editing double-column files and binary files, saving an Emacs session -for later resumption, following hyperlinks, browsing images, emulating -other editors, and various diversions and amusements. +editing binary files, saving an Emacs session for later resumption, +following hyperlinks, browsing images, emulating other editors, and +various diversions and amusements. @end iftex @@ -20,187 +20,7 @@ other editors, and various diversions and amusements. @raisesections @end ifnottex -@node Document View, Gnus, Calendar/Diary, Top -@section Document Viewing -@cindex DVI file -@cindex PDF file -@cindex PS file -@cindex Postscript file -@cindex OpenDocument file -@cindex Microsoft Office file -@cindex DocView mode -@cindex mode, DocView -@cindex document viewer (DocView) -@findex doc-view-mode - -DocView mode (@code{doc-view-mode}) is a viewer for DVI, Postscript -(PS), PDF, OpenDocument, and Microsoft Office documents. It provides -features such as slicing, zooming, and searching inside documents. It -works by converting the document to a set of images using the -@command{gs} (GhostScript) command and other external tools -@footnote{@code{gs} is a hard requirement. For DVI files, -@code{dvipdf} or @code{dvipdfm} is needed. For OpenDocument and -Microsoft Office documents, the @code{unoconv} tool is needed.}, and -displaying those images. - -@findex doc-view-toggle-display -@findex doc-view-toggle-display -@cindex doc-view-minor-mode - When you visit a document file with the exception of Postscript -files, Emacs automatically switches to DocView mode if possible -@footnote{The needed external tools for this document type have to be -available, emacs needs to run in a graphical frame, and PNG image -support has to be compiled into emacs. If any of these requirements -is not fulfilled, DocView falls back to an appropriate mode.}. When -you visit a Postscript file, Emacs switches to PS mode, a major mode -for editing Postscript files as text; however, it also enables DocView -minor mode, so you can type @kbd{C-c C-c} to view the document with -DocView. (PDF and DVI files, unlike Postscript files, are not usually -human-editable.) In either case, repeating @kbd{C-c C-c} -(@code{doc-view-toggle-display}) toggles between DocView and the file -text. - - You can explicitly toggle DocView mode with the command @code{M-x -doc-view-mode}, and DocView minor mode with the command @code{M-x -doc-view-minor-mode}. - - When DocView mode starts, it displays a welcome screen and begins -formatting the file, page by page. It displays the first page once -that has been formatted. - -@findex doc-view-enlarge -@findex doc-view-shrink -@vindex doc-view-resolution - When in DocView mode, you can enlarge or shrink the document with -@kbd{+} (@code{doc-view-enlarge}) and @kbd{-} -(@code{doc-view-shrink}). To specify the default size for DocView, -set or customize the variable @code{doc-view-resolution}. - - To kill the DocView buffer, type @kbd{k} -(@code{doc-view-kill-proc-and-buffer}). To bury it, type @kbd{q} -(@code{quit-window}). - -@menu -* Navigation:: Navigation inside DocView buffers. -* Searching:: Searching inside documents. -* Slicing:: Specifying which part of pages should be displayed. -* Conversion:: Influencing and triggering conversion. -@end menu - -@node Navigation -@subsection Navigation - -When in DocView mode, you can scroll the current page using the usual -Emacs movement keys: @kbd{C-p}, @kbd{C-n}, @kbd{C-b}, @kbd{C-f}, and -the arrow keys. - -@vindex doc-view-continuous - By default, the line-motion keys @kbd{C-p} and @kbd{C-n} stop -scrolling at the beginning and end of the current page, respectively. -However, if you change the variable @code{doc-view-continuous} to a -non-@code{nil} value, then @kbd{C-p} displays the previous page if you -are already at the beginning of the current page, and @kbd{C-n} -displays the next page if you are at the end of the current page. - -@findex doc-view-next-page -@findex doc-view-previous-page - You can also display the next page by typing @kbd{n}, @key{next} or -@kbd{C-x ]} (@code{doc-view-next-page}). To display the previous -page, type @kbd{p}, @key{prior} or @kbd{C-x [} -(@code{doc-view-previous-page}). - -@findex doc-view-scroll-up-or-next-page -@findex doc-view-scroll-down-or-previous-page - The @key{SPC} (@code{doc-view-scroll-up-or-next-page}) key is a -convenient way to advance through the document. It scrolls within the -current page or advances to the next. @key{DEL} moves backwards in a -similar way (@code{doc-view-scroll-down-or-previous-page}). - -@findex doc-view-first-page -@findex doc-view-last-page -@findex doc-view-goto-page - To go to the first page, type @kbd{M-<} -(@code{doc-view-first-page}); to go to the last one, type @kbd{M->} -(@code{doc-view-last-page}). To jump to a page by its number, type -@kbd{M-g M-g} or @kbd{M-g g} (@code{doc-view-goto-page}). - -@node Searching -@subsection Searching - -While in DocView mode, you can search the file's text for a regular -expression (@pxref{Regexps}). The interface for searching is inspired -by @code{isearch} (@pxref{Incremental Search}). - -@findex doc-view-search -@findex doc-view-search-backward -@findex doc-view-show-tooltip - To begin a search, type @kbd{C-s} (@code{doc-view-search}) or -@kbd{C-r} (@code{doc-view-search-backward}). This reads a regular -expression using a minibuffer, then echoes the number of matches found -within the document. You can move forward and back among the matches -by typing @kbd{C-s} and @kbd{C-r}. DocView mode has no way to show -the match inside the page image; instead, it displays a tooltip (at -the mouse position) listing all matching lines in the current page. -To force display of this tooltip, type @kbd{C-t} -(@code{doc-view-show-tooltip}). - - To start a new search, use the search command with a prefix -argument; i.e., @kbd{C-u C-s} for a forward search or @kbd{C-u C-r} -for a backward search. - -@node Slicing -@subsection Slicing - -Documents often have wide margins for printing. They are annoying -when reading the document on the screen, because they use up screen -space and can cause inconvenient scrolling. - -@findex doc-view-set-slice -@findex doc-view-set-slice-using-mouse - With DocView you can hide these margins by selecting a @dfn{slice} -of pages to display. A slice is a rectangle within the page area; -once you specify a slice in DocView, it applies to whichever page you -look at. - - To specify the slice numerically, type @kbd{s s} -(@code{doc-view-set-slice}); then enter the top left pixel position -and the slice's width and height. -@c ??? how does this work? - - A more convenient graphical way to specify the slice is with @kbd{s -m} (@code{doc-view-set-slice-using-mouse}), where you use the mouse to -select the slice. -@c ??? How does this work? - -@findex doc-view-reset-slice - To cancel the selected slice, type @kbd{s r} -(@code{doc-view-reset-slice}). Then DocView shows the entire page -including its entire margins. - -@node Conversion -@subsection Conversion - -@vindex doc-view-cache-directory -@findex doc-view-clear-cache -For efficiency, DocView caches the images produced by @command{gs}. -The name of this directory is given by the variable -@code{doc-view-cache-directory}. You can clear the cache directory by -typing @code{M-x doc-view-clear-cache}. - -@findex doc-view-kill-proc -@findex doc-view-kill-proc-and-buffer - To force a reconversion of the currently viewed document, type -@kbd{r} or @kbd{g} (@code{revert-buffer}). To kill the converter -process associated with the current buffer, type @kbd{K} -(@code{doc-view-kill-proc}). The command @kbd{k} -(@code{doc-view-kill-proc-and-buffer}) kills the converter process and -the DocView buffer. - - The zoom commands @kbd{+} (@code{doc-view-enlarge}) and @kbd{-} -(@code{doc-view-shrink}) need to reconvert the document at the new -size. The current page is converted first. - -@node Gnus, Shell, Document View, Top +@node Gnus @section Gnus @cindex Gnus @cindex reading netnews @@ -411,82 +231,187 @@ for @var{regexp}. @end table -@ignore -@node Where to Look -@subsection Where to Look Further +@node Document View +@section Document Viewing +@cindex DVI file +@cindex PDF file +@cindex PS file +@cindex Postscript file +@cindex OpenDocument file +@cindex Microsoft Office file +@cindex DocView mode +@cindex mode, DocView +@cindex document viewer (DocView) +@findex doc-view-mode -@c Too many references to the name of the manual if done with xref in TeX! -Gnus is powerful and customizable. Here are references to a few -@ifnottex -additional topics: +DocView mode (@code{doc-view-mode}) is a viewer for DVI, Postscript +(PS), PDF, OpenDocument, and Microsoft Office documents. It provides +features such as slicing, zooming, and searching inside documents. It +works by converting the document to a set of images using the +@command{gs} (GhostScript) command and other external tools +@footnote{@code{gs} is a hard requirement. For DVI files, +@code{dvipdf} or @code{dvipdfm} is needed. For OpenDocument and +Microsoft Office documents, the @code{unoconv} tool is needed.}, and +displaying those images. -@end ifnottex -@iftex -additional topics in @cite{The Gnus Manual}: +@findex doc-view-toggle-display +@findex doc-view-toggle-display +@cindex doc-view-minor-mode + When you visit a document file with the exception of Postscript +files, Emacs automatically switches to DocView mode if possible +@footnote{The needed external tools for this document type have to be +available, emacs needs to run in a graphical frame, and PNG image +support has to be compiled into emacs. If any of these requirements +is not fulfilled, DocView falls back to an appropriate mode.}. When +you visit a Postscript file, Emacs switches to PS mode, a major mode +for editing Postscript files as text; however, it also enables DocView +minor mode, so you can type @kbd{C-c C-c} to view the document with +DocView. (PDF and DVI files, unlike Postscript files, are not usually +human-editable.) In either case, repeating @kbd{C-c C-c} +(@code{doc-view-toggle-display}) toggles between DocView and the file +text. -@itemize @bullet -@item -Follow discussions on specific topics.@* -See section ``Threading.'' + You can explicitly toggle DocView mode with the command @code{M-x +doc-view-mode}, and DocView minor mode with the command @code{M-x +doc-view-minor-mode}. -@item -Read digests. See section ``Document Groups.'' + When DocView mode starts, it displays a welcome screen and begins +formatting the file, page by page. It displays the first page once +that has been formatted. -@item -Refer to and jump to the parent of the current article.@* -See section ``Finding the Parent.'' +@findex doc-view-enlarge +@findex doc-view-shrink +@vindex doc-view-resolution + When in DocView mode, you can enlarge or shrink the document with +@kbd{+} (@code{doc-view-enlarge}) and @kbd{-} +(@code{doc-view-shrink}). To specify the default size for DocView, +set or customize the variable @code{doc-view-resolution}. -@item -Refer to articles by using Message-IDs included in the messages.@* -See section ``Article Keymap.'' + To kill the DocView buffer, type @kbd{k} +(@code{doc-view-kill-proc-and-buffer}). To bury it, type @kbd{q} +(@code{quit-window}). -@item -Save articles. See section ``Saving Articles.'' +@menu +* Navigation:: Navigation inside DocView buffers. +* Searching:: Searching inside documents. +* Slicing:: Specifying which part of pages should be displayed. +* Conversion:: Influencing and triggering conversion. +@end menu -@item -Have Gnus score articles according to various criteria, like author -name, subject, or string in the body of the articles.@* -See section ``Scoring.'' +@node Navigation +@subsection Navigation -@item -Send an article to a newsgroup.@* -See section ``Composing Messages.'' -@end itemize -@end iftex -@ifnottex -@itemize @bullet -@item -Follow discussions on specific topics.@* -@xref{Threading, , Reading Based on Conversation Threads, -gnus, The Gnus Manual}. +When in DocView mode, you can scroll the current page using the usual +Emacs movement keys: @kbd{C-p}, @kbd{C-n}, @kbd{C-b}, @kbd{C-f}, and +the arrow keys. -@item -Read digests. @xref{Document Groups, , , gnus, The Gnus Manual}. +@vindex doc-view-continuous + By default, the line-motion keys @kbd{C-p} and @kbd{C-n} stop +scrolling at the beginning and end of the current page, respectively. +However, if you change the variable @code{doc-view-continuous} to a +non-@code{nil} value, then @kbd{C-p} displays the previous page if you +are already at the beginning of the current page, and @kbd{C-n} +displays the next page if you are at the end of the current page. -@item -Refer to and jump to the parent of the current article.@* -@xref{Finding the Parent, , , gnus, The Gnus Manual}. +@findex doc-view-next-page +@findex doc-view-previous-page + You can also display the next page by typing @kbd{n}, @key{next} or +@kbd{C-x ]} (@code{doc-view-next-page}). To display the previous +page, type @kbd{p}, @key{prior} or @kbd{C-x [} +(@code{doc-view-previous-page}). -@item -Refer to articles by using Message-IDs included in the messages.@* -@xref{Article Keymap, , , gnus, The Gnus Manual}. +@findex doc-view-scroll-up-or-next-page +@findex doc-view-scroll-down-or-previous-page + The @key{SPC} (@code{doc-view-scroll-up-or-next-page}) key is a +convenient way to advance through the document. It scrolls within the +current page or advances to the next. @key{DEL} moves backwards in a +similar way (@code{doc-view-scroll-down-or-previous-page}). -@item -Save articles. @xref{Saving Articles, , , gnus, The Gnus Manual}. +@findex doc-view-first-page +@findex doc-view-last-page +@findex doc-view-goto-page + To go to the first page, type @kbd{M-<} +(@code{doc-view-first-page}); to go to the last one, type @kbd{M->} +(@code{doc-view-last-page}). To jump to a page by its number, type +@kbd{M-g M-g} or @kbd{M-g g} (@code{doc-view-goto-page}). -@item -Have Gnus score articles according to various criteria, like author -name, subject, or string in the body of the articles.@* -@xref{Scoring, , , gnus, The Gnus Manual}. +@node Searching +@subsection Searching -@item -Send an article to a newsgroup.@* -@xref{Composing Messages, , , gnus, The Gnus Manual}. -@end itemize -@end ifnottex -@end ignore +While in DocView mode, you can search the file's text for a regular +expression (@pxref{Regexps}). The interface for searching is inspired +by @code{isearch} (@pxref{Incremental Search}). + +@findex doc-view-search +@findex doc-view-search-backward +@findex doc-view-show-tooltip + To begin a search, type @kbd{C-s} (@code{doc-view-search}) or +@kbd{C-r} (@code{doc-view-search-backward}). This reads a regular +expression using a minibuffer, then echoes the number of matches found +within the document. You can move forward and back among the matches +by typing @kbd{C-s} and @kbd{C-r}. DocView mode has no way to show +the match inside the page image; instead, it displays a tooltip (at +the mouse position) listing all matching lines in the current page. +To force display of this tooltip, type @kbd{C-t} +(@code{doc-view-show-tooltip}). + + To start a new search, use the search command with a prefix +argument; i.e., @kbd{C-u C-s} for a forward search or @kbd{C-u C-r} +for a backward search. + +@node Slicing +@subsection Slicing + +Documents often have wide margins for printing. They are annoying +when reading the document on the screen, because they use up screen +space and can cause inconvenient scrolling. + +@findex doc-view-set-slice +@findex doc-view-set-slice-using-mouse + With DocView you can hide these margins by selecting a @dfn{slice} +of pages to display. A slice is a rectangle within the page area; +once you specify a slice in DocView, it applies to whichever page you +look at. + + To specify the slice numerically, type @kbd{s s} +(@code{doc-view-set-slice}); then enter the top left pixel position +and the slice's width and height. +@c ??? how does this work? + + A more convenient graphical way to specify the slice is with @kbd{s +m} (@code{doc-view-set-slice-using-mouse}), where you use the mouse to +select the slice. +@c ??? How does this work? + +@findex doc-view-reset-slice + To cancel the selected slice, type @kbd{s r} +(@code{doc-view-reset-slice}). Then DocView shows the entire page +including its entire margins. + +@node Conversion +@subsection Conversion + +@vindex doc-view-cache-directory +@findex doc-view-clear-cache +For efficiency, DocView caches the images produced by @command{gs}. +The name of this directory is given by the variable +@code{doc-view-cache-directory}. You can clear the cache directory by +typing @code{M-x doc-view-clear-cache}. -@node Shell, Emacs Server, Gnus, Top +@findex doc-view-kill-proc +@findex doc-view-kill-proc-and-buffer + To force a reconversion of the currently viewed document, type +@kbd{r} or @kbd{g} (@code{revert-buffer}). To kill the converter +process associated with the current buffer, type @kbd{K} +(@code{doc-view-kill-proc}). The command @kbd{k} +(@code{doc-view-kill-proc-and-buffer}) kills the converter process and +the DocView buffer. + + The zoom commands @kbd{+} (@code{doc-view-enlarge}) and @kbd{-} +(@code{doc-view-shrink}) need to reconvert the document at the new +size. The current page is converted first. + +@node Shell @section Running Shell Commands from Emacs @cindex subshell @cindex shell commands @@ -1671,6 +1596,11 @@ runs, and (ii) provide @command{emacsclient} with the server file. (One convenient way to do the latter is to put the server file on a networked file system such as NFS.) +@vindex server-port + When the Emacs server is using TCP, the variable @code{server-port} +determines the port number to listen on; the default value, +@code{nil}, means to choose a random port when the server starts. + @item -n @itemx --no-wait Let @command{emacsclient} exit immediately, instead of waiting until @@ -1788,7 +1718,7 @@ not compatible with @code{lpr}. @end menu @node PostScript, PostScript Variables,, Printing -@section PostScript Hardcopy +@subsection PostScript Hardcopy These commands convert buffer contents to PostScript, either printing it or leaving it in another Emacs buffer. @@ -1878,7 +1808,7 @@ supports ISO 8859-1 characters. @end ifnottex @node PostScript Variables, Printing Package, PostScript, Printing -@section Variables for PostScript Hardcopy +@subsection Variables for PostScript Hardcopy @vindex ps-lpr-command @vindex ps-lpr-switches @@ -1973,7 +1903,7 @@ includes a single directory @file{/usr/local/share/emacs/fonts/bdf}. described in the Lisp files @file{ps-print.el} and @file{ps-mule.el}. @node Printing Package,, PostScript Variables, Printing -@section Printing Package +@subsection Printing Package @cindex Printing package The basic Emacs facilities for printing hardcopy can be extended @@ -1999,7 +1929,7 @@ to print, you start the print job using the @samp{Print} button (click further information on the various options, use the @samp{Interface Help} button. -@node Sorting, Narrowing, Printing, Top +@node Sorting @section Sorting Text @cindex sorting @@ -2134,163 +2064,13 @@ rectangle moves along with the text inside the rectangle. Many of the sort commands ignore case differences when comparing, if @code{sort-fold-case} is non-@code{nil}. -@node Narrowing, Two-Column, Sorting, Top -@section Narrowing -@cindex widening -@cindex restriction -@cindex narrowing -@cindex accessible portion - - @dfn{Narrowing} means focusing in on some portion of the buffer, -making the rest temporarily inaccessible. The portion which you can -still get to is called the @dfn{accessible portion}. Canceling the -narrowing, which makes the entire buffer once again accessible, is -called @dfn{widening}. The bounds of narrowing in effect in a buffer -are called the buffer's @dfn{restriction}. - - Narrowing can make it easier to concentrate on a single subroutine or -paragraph by eliminating clutter. It can also be used to limit the -range of operation of a replace command or repeating keyboard macro. - -@table @kbd -@item C-x n n -Narrow down to between point and mark (@code{narrow-to-region}). -@item C-x n w -Widen to make the entire buffer accessible again (@code{widen}). -@item C-x n p -Narrow down to the current page (@code{narrow-to-page}). -@item C-x n d -Narrow down to the current defun (@code{narrow-to-defun}). -@end table - - When you have narrowed down to a part of the buffer, that part appears -to be all there is. You can't see the rest, you can't move into it -(motion commands won't go outside the accessible part), you can't change -it in any way. However, it is not gone, and if you save the file all -the inaccessible text will be saved. The word @samp{Narrow} appears in -the mode line whenever narrowing is in effect. - -@kindex C-x n n -@findex narrow-to-region - The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}). -It sets the current buffer's restrictions so that the text in the current -region remains accessible, but all text before the region or after the -region is inaccessible. Point and mark do not change. - -@kindex C-x n p -@findex narrow-to-page -@kindex C-x n d -@findex narrow-to-defun - Alternatively, use @kbd{C-x n p} (@code{narrow-to-page}) to narrow -down to the current page. @xref{Pages}, for the definition of a page. -@kbd{C-x n d} (@code{narrow-to-defun}) narrows down to the defun -containing point (@pxref{Defuns}). - -@kindex C-x n w -@findex widen - The way to cancel narrowing is to widen with @kbd{C-x n w} -(@code{widen}). This makes all text in the buffer accessible again. - - You can get information on what part of the buffer you are narrowed down -to using the @kbd{C-x =} command. @xref{Position Info}. - - Because narrowing can easily confuse users who do not understand it, -@code{narrow-to-region} is normally a disabled command. Attempting to use -this command asks for confirmation and gives you the option of enabling it; -if you enable the command, confirmation will no longer be required for -it. @xref{Disabling}. - -@node Two-Column, Editing Binary Files, Narrowing, Top -@section Two-Column Editing -@cindex two-column editing -@cindex splitting columns -@cindex columns, splitting - - Two-column mode lets you conveniently edit two side-by-side columns of -text. It uses two side-by-side windows, each showing its own -buffer. - - There are three ways to enter two-column mode: +@c Picture Mode documentation +@ifnottex +@include picture-xtra.texi +@end ifnottex -@table @asis -@item @kbd{@key{F2} 2} or @kbd{C-x 6 2} -@kindex F2 2 -@kindex C-x 6 2 -@findex 2C-two-columns -Enter two-column mode with the current buffer on the left, and on the -right, a buffer whose name is based on the current buffer's name -(@code{2C-two-columns}). If the right-hand buffer doesn't already -exist, it starts out empty; the current buffer's contents are not -changed. - -This command is appropriate when the current buffer is empty or contains -just one column and you want to add another column. - -@item @kbd{@key{F2} s} or @kbd{C-x 6 s} -@kindex F2 s -@kindex C-x 6 s -@findex 2C-split -Split the current buffer, which contains two-column text, into two -buffers, and display them side by side (@code{2C-split}). The current -buffer becomes the left-hand buffer, but the text in the right-hand -column is moved into the right-hand buffer. The current column -specifies the split point. Splitting starts with the current line and -continues to the end of the buffer. - -This command is appropriate when you have a buffer that already contains -two-column text, and you wish to separate the columns temporarily. - -@item @kbd{@key{F2} b @var{buffer} @key{RET}} -@itemx @kbd{C-x 6 b @var{buffer} @key{RET}} -@kindex F2 b -@kindex C-x 6 b -@findex 2C-associate-buffer -Enter two-column mode using the current buffer as the left-hand buffer, -and using buffer @var{buffer} as the right-hand buffer -(@code{2C-associate-buffer}). -@end table - @kbd{@key{F2} s} or @kbd{C-x 6 s} looks for a column separator, which -is a string that appears on each line between the two columns. You can -specify the width of the separator with a numeric argument to -@kbd{@key{F2} s}; that many characters, before point, constitute the -separator string. By default, the width is 1, so the column separator -is the character before point. - - When a line has the separator at the proper place, @kbd{@key{F2} s} -puts the text after the separator into the right-hand buffer, and -deletes the separator. Lines that don't have the column separator at -the proper place remain unsplit; they stay in the left-hand buffer, and -the right-hand buffer gets an empty line to correspond. (This is the -way to write a line that ``spans both columns while in two-column -mode'': write it in the left-hand buffer, and put an empty line in the -right-hand buffer.) - -@kindex F2 RET -@kindex C-x 6 RET -@findex 2C-newline - The command @kbd{C-x 6 @key{RET}} or @kbd{@key{F2} @key{RET}} -(@code{2C-newline}) inserts a newline in each of the two buffers at -corresponding positions. This is the easiest way to add a new line to -the two-column text while editing it in split buffers. - -@kindex F2 1 -@kindex C-x 6 1 -@findex 2C-merge - When you have edited both buffers as you wish, merge them with -@kbd{@key{F2} 1} or @kbd{C-x 6 1} (@code{2C-merge}). This copies the -text from the right-hand buffer as a second column in the other buffer. -To go back to two-column editing, use @kbd{@key{F2} s}. - -@kindex F2 d -@kindex C-x 6 d -@findex 2C-dissociate - Use @kbd{@key{F2} d} or @kbd{C-x 6 d} to dissociate the two buffers, -leaving each as it stands (@code{2C-dissociate}). If the other buffer, -the one not current when you type @kbd{@key{F2} d}, is empty, -@kbd{@key{F2} d} kills it. - -@node Editing Binary Files, Saving Emacs Sessions, Two-Column, Top +@node Editing Binary Files @section Editing Binary Files @cindex Hexl mode @@ -2738,7 +2518,7 @@ Display a menu of files and URLs mentioned in current buffer, then find the one you select (@code{ffap-menu}). @end table -@node Amusements, Customization, Hyperlinking, Top +@node Amusements, Packages, Hyperlinking, Top @section Other Amusements @cindex boredom diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi index 314d5d4347e..d82423a73b4 100644 --- a/doc/emacs/modes.texi +++ b/doc/emacs/modes.texi @@ -353,12 +353,13 @@ the element has the form @code{(@var{regexp} @var{mode-function} @var{regexp} and searches the list again for another match. @vindex auto-mode-case-fold - On systems with case-insensitive file names, such as Microsoft -Windows, Emacs performs a single case-insensitive search through -@code{auto-mode-alist}. On other systems, Emacs normally performs a -single case-sensitive search through the alist. However, if you -change the variable @code{auto-mode-case-fold} to @code{t}, Emacs -performs a second case-insensitive search if the first search fails. + On GNU/Linux and other systems with case-sensitive file names, Emacs +performs a case-sensitive search through @code{auto-mode-alist}; if +this search fails, it performs a second case-insensitive search +through the alist. To suppress the second search, change the variable +@code{auto-mode-case-fold} to @code{nil}. On systems with +case-insensitive file names, such as Microsoft Windows, Emacs performs +a single case-insensitive search through @code{auto-mode-alist}. @vindex magic-fallback-mode-alist Finally, if Emacs @emph{still} hasn't found a major mode to use, it diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi new file mode 100644 index 00000000000..739a8ce6c65 --- /dev/null +++ b/doc/emacs/package.texi @@ -0,0 +1,230 @@ +@c This is part of the Emacs manual. +@c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2011 +@c Free Software Foundation, Inc. +@c See file emacs.texi for copying conditions. +@node Packages +@chapter Emacs Lisp Packages +@cindex Package +@cindex Emacs Lisp package archive +@cindex Package archive +@cindex Emacs Lisp package + +Emacs includes a facility that lets you easily download and install +@dfn{packages} that implement additional features. Each package is a +separate Emacs Lisp program, sometimes including other components such +as an Info manual. + + @kbd{M-x list-packages} brings up a buffer named @samp{*Packages*} +with a list of all packages. You can install or uninstall packages +via this buffer. @xref{Package Menu}. + +@findex describe-package + The command @kbd{C-h P} (@code{describe-package}) prompts for the +name of a package, and displays a help buffer describing that +attributes of the package and the features that it implements. + + By default, Emacs downloads packages from a @dfn{package archive} +maintained by the Emacs developers and hosted by the GNU project. +Optionally, you can also download packages from archives maintained by +third parties. @xref{Package Installation}. + + For information about turning an Emacs Lisp program into an +installable package, @xref{Packaging,,,elisp, The Emacs Lisp Reference +Manual}. For information about finding third-party packages and other +Emacs Lisp extensions, @xref{Packages that do not come with +Emacs,,,efaq, GNU Emacs FAQ}. + +@menu +* Package Menu:: Buffer for viewing and managing packages. +* Package Installation:: Options for package installation. +* Package Files:: Where packages are installed. +@end menu + +@node Package Menu +@section The Package Menu Buffer +@cindex package menu +@cindex built-in package +@findex list-packages + +The command @kbd{M-x list-packages} brings up the @dfn{package menu}. +This is a buffer listing all the packages that Emacs knows about, one +on each line, with the following information: + +@itemize @bullet +@item +The package name (e.g. @samp{auctex}). + +@item +The package's version number (e.g. @samp{11.86}). + +@item +The package's status---normally one of @samp{available} (can be +downloaded from the package archive), @samp{installed}, or +@samp{built-in} (included in Emacs by default). + +In some instances, the status can be @samp{held}, @samp{disabled}, or +@samp{obsolete}. @xref{Package Installation}. + +@item +A short description of the package. +@end itemize + +@noindent +The @code{list-packages} command accesses the network, to retrieve the +list of available packages from the package archive server. If the +network is unavailable, it falls back on the most recently retrieved +list. + +The following commands are available in the package menu: + +@table @kbd +@item h +Print a short message summarizing how to use the package menu +(@code{package-menu-quick-help}). + +@item ? +@itemx @key{RET} +Display a help buffer for the package on the current line +(@code{package-menu-describe-package}), similar to the help window +displayed by the @kbd{C-h P} command (@pxref{Packages}). + +@item i +Mark the package on the current line for installation +(@code{package-menu-mark-install}). If the package status is +@samp{available}, this adds an @samp{I} character to the start of the +line; typing @kbd{x} (see below) will download and install the +package. + +@item d +Mark the package on the current line for deletion +(@code{package-menu-mark-delete}). If the package status is +@samp{installed}, this adds a @samp{D} character to the start of the +line; typing @kbd{x} (see below) will delete the package. +@xref{Package Files}, for information about what package deletion +entails. + +@item u +Remove any installation or deletion mark previously added to the +current line by an @kbd{i} or @kbd{d} command. + +@item x +Download and install all packages marked with @kbd{i}, and their +dependencies; also, delete all packages marked with @kbd{d} +(@code{package-menu-execute}). This also removes the marks. + +@item r +Refresh the package list (@code{package-menu-refresh}). This also +retrieves the list of available packages from the package archive +again. +@end table + +@noindent +For example, you can install a package by typing @kbd{i} on the line +listing that package, followed by @kbd{x}. + +@node Package Installation +@section Package Installation + +@findex package-install + Packages are most conveniently installed using the package menu +(@pxref{Package Menu}), but you can also use the command @kbd{M-x +package-install}. This prompts for the name of a package with the +@samp{available} status, then downloads and installs it. + +@cindex package requirements + A package may @dfn{require} certain other packages to be installed, +because it relies on functionality provided by them. When Emacs +installs such a package, it also automatically downloads and installs +any required package that is not already installed. (If a required +package is somehow unavailable, Emacs signals an error and stops +installation.) A package's requirements list is shown in its help +buffer. + +@vindex package-archives + By default, packages are downloaded from a single package archive +maintained by the Emacs developers. This is controlled by the +variable @code{package-archives}, whose value is a list of package +archives known to Emacs. Each list element must have the form +@code{(@var{id} . @var{location})}, where @var{id} is the name of a +package archive and @var{location} is the @acronym{HTTP} address or +directory name of the package archive. You can alter this list if you +wish to use third party package archives---but do so at your own risk, +and use only third parties that you think you can trust! + + Once a package is downloaded and installed, it takes effect in the +current Emacs session. What ``taking effect'' means depends on the +package; most packages just make some new commands available, while +others have more wide-ranging effects on the Emacs session. For such +information, consult the package's help buffer. + + By default, Emacs also automatically loads all installed packages +(causing them to ``take effect'') in subsequent Emacs sessions. This +happens at startup, after processing the init file (@pxref{Init +File}). As an exception, Emacs does not load packages at startup if +invoked with the @samp{-q} or @samp{--no-init-file} options +(@pxref{Initial Options}). + +@vindex package-enable-at-startup +@findex package-initialize + To disable automatic package loading, change the variable +@code{package-enable-at-startup} to @code{nil}. If you do this, you +can use the command @kbd{M-x package-initialize} to load your +packages. + +@vindex package-load-list + For finer control over package loading, you can use the variable +@code{package-load-list}. Its value should be a list. A list element +of the form @code{(@var{name} @var{version})} tells Emacs to load +version @var{version} of the package named @var{name}. Here, +@var{version} should be a version string (corresponding to a specific +version of the package), or @code{t} (which means to load any +installed version), or @code{nil} (which means no version; this +``disables'' the package, preventing it from being loaded). A list +element can also be the symbol @code{all}, which means to load the +latest installed version of any package not named by the other list +elements. The default value is just @code{'(all)}. + + For example, if you set @code{package-load-list} to @code{'((muse +"3.20") all)}, then Emacs only loads version 3.20 of the @samp{muse} +package, plus any installed version of packages other than +@samp{muse}. Any other version of @samp{muse} that happens to be +installed will be ignored. The @samp{muse} package will be listed in +the package menu with the @samp{held} status. + +@node Package Files +@section Package Files and Directory Layout +@cindex package directory + +@cindex package file +@findex package-install-file + Each package is downloaded from the package archive in the form of a +single @dfn{package file}---either an Emacs Lisp source file, or a tar +file containing multiple Emacs Lisp source and other files. Package +files are automatically retrieved, processed, and disposed of by the +Emacs commands that install packages. Normally, you will not need to +deal directly with them, unless you are making a package +(@pxref{Packaging,,,elisp, The Emacs Lisp Reference Manual}). Should +you ever need to install a package directly from a package file, use +the command @kbd{M-x package-install-file}. + +@vindex package-user-dir + Once installed, the contents of a package are placed in a +subdirectory of @file{~/.emacs.d/elpa/} (you can change the name of +that directory by changing the variable @code{package-user-dir}). The +package subdirectory is named @file{@var{name}-@var{version}}, where +@var{name} is the package name and @var{version} is its version +string. + +@cindex system-wide packages +@vindex package-directory-list + In addition to @code{package-user-dir}, Emacs looks for installed +packages in the directories listed in @code{package-directory-list}. +These directories are meant for system administrators to make Emacs +packages available system-wide; Emacs itself never installs packages +there. The package subdirectories for @code{package-directory-list} +are laid out in the same way as in @code{package-user-dir}. + + Deleting a package (@pxref{Package Menu}) involves deleting the +corresponding package subdirectory. This only works for packages +installed in @code{package-user-dir}; if told to act on a package in a +system-wide package directory, the deletion command signals an error. diff --git a/doc/emacs/picture-xtra.texi b/doc/emacs/picture-xtra.texi index 0dcfc7a9627..43a2dbc4704 100644 --- a/doc/emacs/picture-xtra.texi +++ b/doc/emacs/picture-xtra.texi @@ -5,7 +5,7 @@ @c This file is included either in emacs-xtra.texi (when producing the @c printed version) or in the main Emacs manual (for the on-line version). @node Picture Mode -@chapter Editing Pictures +@section Editing Pictures @cindex pictures @cindex making pictures out of text characters @findex picture-mode @@ -59,7 +59,7 @@ Additional extensions to Picture mode can be found in @end menu @node Basic Picture -@section Basic Editing in Picture Mode +@subsection Basic Editing in Picture Mode @findex picture-forward-column @findex picture-backward-column @@ -124,7 +124,7 @@ modes), or one of the picture rectangle commands (@pxref{Rectangles in Picture}). @node Insert in Picture -@section Controlling Motion after Insert +@subsection Controlling Motion after Insert @findex picture-movement-up @findex picture-movement-down @@ -188,7 +188,7 @@ same direction as motion after ``insertion'' currently does, while @kbd{C-c C-b} (@code{picture-motion-reverse}) moves in the opposite direction. @node Tabs in Picture -@section Picture Mode Tabs +@subsection Picture Mode Tabs @kindex M-TAB @r{(Picture mode)} @findex picture-tab-search @@ -228,7 +228,7 @@ up the picture. You can do this by setting the variable @code{indent-tabs-mode} to @code{nil}. @node Rectangles in Picture -@section Picture Mode Rectangle Commands +@subsection Picture Mode Rectangle Commands @cindex rectangles and Picture mode @cindex Picture mode and rectangles diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index ad22ae921e0..0a9594d3798 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi @@ -2,7 +2,7 @@ @c Copyright (C) 1985-1987, 1993-1995, 1997, 2001-2011 @c Free Software Foundation, Inc. @c See file emacs.texi for copying conditions. -@node Rmail, Dired, Sending Mail, Top +@node Rmail @chapter Reading Mail with Rmail @cindex Rmail @cindex reading mail diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi index e3f5c05d8da..0b0e4867ae5 100644 --- a/doc/emacs/text.texi +++ b/doc/emacs/text.texi @@ -70,6 +70,7 @@ for editing such pictures. * Nroff Mode:: Editing input to the formatter nroff. * Formatted Text:: Editing formatted text directly in WYSIWYG fashion. * Text Based Tables:: Editing text-based tables in WYSIWYG fashion. +* Two-Column:: Splitting text columns into separate windows. @end menu @node Words @@ -2837,3 +2838,93 @@ then inserts the generated table in the proper syntax into the destination buffer. The default destination buffer is @code{table.@var{lang}}, where @var{lang} is the language you specified. + +@node Two-Column +@section Two-Column Editing +@cindex two-column editing +@cindex splitting columns +@cindex columns, splitting + + Two-column mode lets you conveniently edit two side-by-side columns of +text. It uses two side-by-side windows, each showing its own +buffer. + + There are three ways to enter two-column mode: + +@table @asis +@item @kbd{@key{F2} 2} or @kbd{C-x 6 2} +@kindex F2 2 +@kindex C-x 6 2 +@findex 2C-two-columns +Enter two-column mode with the current buffer on the left, and on the +right, a buffer whose name is based on the current buffer's name +(@code{2C-two-columns}). If the right-hand buffer doesn't already +exist, it starts out empty; the current buffer's contents are not +changed. + +This command is appropriate when the current buffer is empty or contains +just one column and you want to add another column. + +@item @kbd{@key{F2} s} or @kbd{C-x 6 s} +@kindex F2 s +@kindex C-x 6 s +@findex 2C-split +Split the current buffer, which contains two-column text, into two +buffers, and display them side by side (@code{2C-split}). The current +buffer becomes the left-hand buffer, but the text in the right-hand +column is moved into the right-hand buffer. The current column +specifies the split point. Splitting starts with the current line and +continues to the end of the buffer. + +This command is appropriate when you have a buffer that already contains +two-column text, and you wish to separate the columns temporarily. + +@item @kbd{@key{F2} b @var{buffer} @key{RET}} +@itemx @kbd{C-x 6 b @var{buffer} @key{RET}} +@kindex F2 b +@kindex C-x 6 b +@findex 2C-associate-buffer +Enter two-column mode using the current buffer as the left-hand buffer, +and using buffer @var{buffer} as the right-hand buffer +(@code{2C-associate-buffer}). +@end table + + @kbd{@key{F2} s} or @kbd{C-x 6 s} looks for a column separator, which +is a string that appears on each line between the two columns. You can +specify the width of the separator with a numeric argument to +@kbd{@key{F2} s}; that many characters, before point, constitute the +separator string. By default, the width is 1, so the column separator +is the character before point. + + When a line has the separator at the proper place, @kbd{@key{F2} s} +puts the text after the separator into the right-hand buffer, and +deletes the separator. Lines that don't have the column separator at +the proper place remain unsplit; they stay in the left-hand buffer, and +the right-hand buffer gets an empty line to correspond. (This is the +way to write a line that ``spans both columns while in two-column +mode'': write it in the left-hand buffer, and put an empty line in the +right-hand buffer.) + +@kindex F2 RET +@kindex C-x 6 RET +@findex 2C-newline + The command @kbd{C-x 6 @key{RET}} or @kbd{@key{F2} @key{RET}} +(@code{2C-newline}) inserts a newline in each of the two buffers at +corresponding positions. This is the easiest way to add a new line to +the two-column text while editing it in split buffers. + +@kindex F2 1 +@kindex C-x 6 1 +@findex 2C-merge + When you have edited both buffers as you wish, merge them with +@kbd{@key{F2} 1} or @kbd{C-x 6 1} (@code{2C-merge}). This copies the +text from the right-hand buffer as a second column in the other buffer. +To go back to two-column editing, use @kbd{@key{F2} s}. + +@kindex F2 d +@kindex C-x 6 d +@findex 2C-dissociate + Use @kbd{@key{F2} d} or @kbd{C-x 6 d} to dissociate the two buffers, +leaving each as it stands (@code{2C-dissociate}). If the other buffer, +the one not current when you type @kbd{@key{F2} d}, is empty, +@kbd{@key{F2} d} kills it. diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index 4be892639fc..fd06dde5174 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi @@ -15,7 +15,7 @@ also considered. @raisesections @end ifnottex -@node Quitting, Lossage, Customization, Top +@node Quitting @section Quitting and Aborting @cindex quitting diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index f08ee3a227c..3f52d684683 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,97 @@ +2011-08-30 Dani Moncayo <dmoncayo@gmail.com> (tiny change) + + * lists.texi (Building Lists): Fix typo. + +2011-08-30 Chong Yidong <cyd@stupidchicken.com> + + * display.texi (Basic Faces): New node. Document new faces. + + * modes.texi (Major Mode Conventions): Move some text there. + (Mode Help): Remove major-mode var, duplicated in Major Modes. + +2011-08-29 Chong Yidong <cyd@stupidchicken.com> + + * modes.texi (Basic Major Modes): New node. Callers updated. + (Major Modes): Document fundamental-mode and major-mode. + (Major Mode Basics): Node deleted; text moved to Major Modes. + (Derived Modes): Document derived-mode-p. + +2011-08-28 Chong Yidong <cyd@stupidchicken.com> + + * files.texi (Changing Files, Create/Delete Dirs): Document new + arguments for delete-file, delete-directory, and copy-directory. + (Visiting Functions): Remove view-file; it is documented in the + Emacs manual. + + * frames.texi (Layout Parameters): The defaults for the + menu-bar-lines and tool-bar-lines parameters depend on the mode. + + * display.texi (Progress): Document spinner functionality. + + * os.texi (Killing Emacs): Note that kill-emacs can be called by + operating system signals. Refer to save-buffers-kill-terminal + instead of save-buffers-kill-emacs. + + * objects.texi (Symbol Type): Document ## print representation. + +2011-08-25 Eli Zaretskii <eliz@gnu.org> + + * display.texi (Specified Space): Mention that `space' specs + influence bidi reordering. + (Bidirectional Display): Explain how to use `(space . PROPS)' for + separating fields with bidirectional content. + +2011-08-24 Eli Zaretskii <eliz@gnu.org> + + * display.texi (Bidirectional Display): Document return value in + buffers that are not bidi-reordered for display, and in unibyte + buffers. + +2011-08-23 Eli Zaretskii <eliz@gnu.org> + + * nonascii.texi (Character Properties): Document the values for + unassigned codepoints. + +2011-08-18 Eli Zaretskii <eliz@gnu.org> + + * nonascii.texi (Character Properties): Document use of + `bidi-class' and `mirroring' properties as part of reordering. + Provide cross-references to "Bidirectional Display". + + * display.texi (Bidirectional Display): Document the pitfalls of + concatenating strings with bidirectional content, with possible + solutions. Document bidi-string-mark-left-to-right. Mention + paragraph direction in modes that inherit from prog-mode. + Document use of `bidi-class' and `mirroring' properties as part of + reordering. + +2011-08-16 Eli Zaretskii <eliz@gnu.org> + + * modes.texi (Major Mode Conventions): Improve the documentation + of `mode-class' `special' modes. + + * nonascii.texi (Character Properties): Document the `mirroring' + property. Add index entries. + + * syntax.texi (Categories): Add an example of defining a new + category and category table. + + * searching.texi (Regexp Backslash): Document how to display + existing categories. Mention the possibility of adding + categories, and add an xref to where this is described. Add an + index entry. + +2011-08-09 Chong Yidong <cyd@stupidchicken.com> + + * text.texi (Special Properties): + * display.texi (Overlay Properties): Note that mouse-face cannot + change the text size (Bug#8530). + +2011-08-08 Chong Yidong <cyd@stupidchicken.com> + + * os.texi (Time of Day): Remove set-time-zone-rule, and recommend + using setenv instead. + 2011-07-28 Eli Zaretskii <eliz@gnu.org> * display.texi (Bidirectional Display): Document the fact that diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index d9e807afb88..757906f286e 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi @@ -596,25 +596,6 @@ forms are elided. @end smallexample @end deffn -@ignore @c Not worth mentioning -@defopt stack-trace-on-error -@cindex stack trace -This variable controls whether Lisp automatically displays a -backtrace buffer after every error that is not handled. A quit signal -counts as an error for this variable. If it is non-@code{nil} then a -backtrace is shown in a pop-up buffer named @samp{*Backtrace*} on every -error. If it is @code{nil}, then a backtrace is not shown. - -When a backtrace is shown, that buffer is not selected. If either -@code{debug-on-quit} or @code{debug-on-error} is also non-@code{nil}, then -a backtrace is shown in one buffer, and the debugger is popped up in -another buffer with its own backtrace. - -We consider this feature to be obsolete and superseded by the debugger -itself. -@end defopt -@end ignore - @defvar debug-on-next-call @cindex @code{eval}, and debugging @cindex @code{apply}, and debugging diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 077d0992232..68291319ef1 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -367,10 +367,9 @@ echo area, or @code{nil} if there is none. When an operation can take a while to finish, you should inform the user about the progress it makes. This way the user can estimate remaining time and clearly see that Emacs is busy working, not hung. +A convenient way to do this is to use a @dfn{progress reporter}. - Functions listed in this section provide simple and efficient way of -reporting operation progress. Here is a working example that does -nothing useful: + Here is a working example that does nothing useful: @smallexample (let ((progress-reporter @@ -382,11 +381,11 @@ nothing useful: (progress-reporter-done progress-reporter)) @end smallexample -@defun make-progress-reporter message min-value max-value &optional current-value min-change min-time -This function creates and returns a @dfn{progress reporter}---an -object you will use as an argument for all other functions listed -here. The idea is to precompute as much data as possible to make -progress reporting very fast. +@defun make-progress-reporter message &optional min-value max-value current-value min-change min-time +This function creates and returns a progress reporter object, which +you will use as an argument for the other functions listed below. The +idea is to precompute as much data as possible to make progress +reporting very fast. When this progress reporter is subsequently used, it will display @var{message} in the echo area, followed by progress percentage. @@ -394,24 +393,28 @@ When this progress reporter is subsequently used, it will display on a filename, for instance, use @code{format} before calling this function. -@var{min-value} and @var{max-value} arguments stand for starting and -final states of your operation. For instance, if you scan a buffer, -they should be the results of @code{point-min} and @code{point-max} -correspondingly. It is required that @var{max-value} is greater than -@var{min-value}. If you create progress reporter when some part of -the operation has already been completed, then specify -@var{current-value} argument. But normally you should omit it or set -it to @code{nil}---it will default to @var{min-value} then. - -Remaining arguments control the rate of echo area updates. Progress -reporter will wait for at least @var{min-change} more percents of the -operation to be completed before printing next message. -@var{min-time} specifies the minimum time in seconds to pass between -successive prints. It can be fractional. Depending on Emacs and -system capabilities, progress reporter may or may not respect this -last argument or do it with varying precision. Default value for -@var{min-change} is 1 (one percent), for @var{min-time}---0.2 -(seconds.) +The arguments @var{min-value} and @var{max-value} should be numbers +standing for the starting and final states of the operation. For +instance, an operation that ``scans'' a buffer should set these to the +results of @code{point-min} and @code{point-max} correspondingly. +@var{max-value} should be greater than @var{min-value}. + +Alternatively, you can set @var{min-value} and @var{max-value} to +@code{nil}. In that case, the progress reporter does not report +process percentages; it instead displays a ``spinner'' that rotates a +notch each time you update the progress reporter. + +If @var{min-value} and @var{max-value} are numbers, you can give the +argument @var{current-value} a numerical value specifying the initial +progress; if omitted, this defaults to @var{min-value}. + +The remaining arguments control the rate of echo area updates. The +progress reporter will wait for at least @var{min-change} more +percents of the operation to be completed before printing next +message; the default is one percent. @var{min-time} specifies the +minimum time in seconds to pass between successive prints; the default +is 0.2 seconds. (On some operating systems, the progress reporter may +handle fractions of seconds with varying precision). This function calls @code{progress-reporter-update}, so the first message is printed immediately. @@ -1454,7 +1457,10 @@ specify just the foreground color or just the background color. @item mouse-face @kindex mouse-face @r{(overlay property)} This property is used instead of @code{face} when the mouse is within -the range of the overlay. +the range of the overlay. However, Emacs ignores all face attributes +from this property that alter the text size (e.g. @code{:height}, +@code{:weight}, and @code{:slant}). Those attributes are always the +same as in the unhighlighted text. @item display @kindex display @r{(overlay property)} @@ -1827,9 +1833,10 @@ particular face name a special meaning in one frame if you wish. * Face Attributes:: What is in a face? * Attribute Functions:: Functions to examine and set face attributes. * Displaying Faces:: How Emacs combines the faces specified for a character. -* Face Remapping:: Remapping faces to alternative definitions. +* Face Remapping:: Remapping faces to alternative definitions. * Face Functions:: How to define and examine faces. * Auto Faces:: Hook for automatic face assignment. +* Basic Faces:: Faces that are defined by default. * Font Selection:: Finding the best available font for a face. * Font Lookup:: Looking up the names of available fonts and information about them. @@ -2681,6 +2688,62 @@ For efficiency, we recommend writing these functions so that they usually assign faces to around 400 to 600 characters at each call. @end defvar +@node Basic Faces +@subsection Basic Faces + +If your Emacs Lisp program needs to assign some faces to text, it is +often a good idea to use certain existing faces or inherit from them, +rather than defining entirely new faces. This way, if other users +have customized the basic faces to give Emacs a certain look, your +program will ``fit in'' without additional customization. + + Some of the basic faces defined in Emacs are listed below. In +addition to these, you might want to make use of the Font Lock faces +for syntactic highlighting, if highlighting is not already handled by +Font Lock mode, or if some Font Lock faces are not in use. +@xref{Faces for Font Lock}. + +@table @code +@item default +The default face, whose attributes are all specified. All other faces +implicitly inherit from it: any unspecified attribute defaults to the +attribute on this face (@pxref{Face Attributes}). + +@item bold +@itemx italic +@itemx bold-italic +@itemx underline +@itemx fixed-pitch +@itemx variable-pitch +These have the attributes indicated by their names (e.g. @code{bold} +has a bold @code{:weight} attribute), with all other attributes +unspecified (and so given by @code{default}). + +@item shadow +For ``dimmed out'' text. For example, it is used for the ignored +part of a filename in the minibuffer (@pxref{Minibuffer File,, +Minibuffers for File Names, emacs, The GNU Emacs Manual}). + +@item link +@itemx link-visited +For clickable text buttons that send the user to a different +buffer or ``location''. + +@item highlight +For stretches of text that should temporarily stand out. For example, +it is commonly assigned to the @code{mouse-face} property for cursor +highlighting (@pxref{Special Properties}). + +@item match +For text matching a search command. + +@item error +@itemx warning +@itemx success +For text concerning errors, warnings, or successes. For example, +these are used for messages in @samp{*Compilation*} buffers. +@end table + @node Font Selection @subsection Font Selection @@ -3791,6 +3854,10 @@ with a @dfn{pixel ascent} specification (@pxref{Pixel Specification}). non-graphic terminals, but the other space properties in this section are not. + Note that space properties are treated as paragraph separators for +the purposes of reordering bidirectional text for display. +@xref{Bidirectional Display}, for the details. + @node Pixel Specification @subsection Pixel Specification for Spaces @cindex spaces, pixel specification @@ -5989,6 +6056,7 @@ left-to-right and right-to-left characters. for editing and displaying bidirectional text. @cindex logical order +@cindex reading order @cindex visual order @cindex unicode bidirectional algorithm Emacs stores right-to-left and bidirectional text in the so-called @@ -6003,17 +6071,16 @@ for display. Reordering of bidirectional text for display in Emacs is a ``Full bidirectionality'' class implementation of the @acronym{UBA}. @defvar bidi-display-reordering - The buffer-local variable @code{bidi-display-reordering} controls -whether text in the buffer is reordered for display. If its value is -non-@code{nil}, Emacs reorders characters that have right-to-left -directionality when they are displayed. The default value is -@code{t}. Text in overlay strings (@pxref{Overlay -Properties,,before-string}), display strings (@pxref{Overlay -Properties,,display}), and @code{display} text properties -(@pxref{Display Property}) is also reordered if the buffer whose text -includes these strings is reordered for display. Turning off -@code{bidi-display-reordering} for a buffer turns off reordering of -all the overlay and display strings in that buffer. + This buffer-local variable controls whether text in the buffer is +reordered for display. If its value is non-@code{nil}, Emacs reorders +characters that have right-to-left directionality when they are +displayed. The default value is @code{t}. Text in overlay strings +(@pxref{Overlay Properties,,before-string}), display strings +(@pxref{Overlay Properties,,display}), and @code{display} text +properties (@pxref{Display Property}) is also reordered for display if +the buffer whose text includes these strings is reordered. Turning +off @code{bidi-display-reordering} for a buffer turns off reordering +of all the overlay and display strings in that buffer. Reordering of strings that are unrelated to any buffer, such as text displayed on the mode line (@pxref{Mode Line Format}) or header line @@ -6053,7 +6120,7 @@ it is reordered for display. That is, the entire chunk of text covered by these properties is reordered together. Moreover, the bidirectional properties of the characters in this chunk of text are ignored, and Emacs reorders them as if they were replaced with a -single character @code{u+FFFC}, known as the @dfn{Object Replacement +single character @code{U+FFFC}, known as the @dfn{Object Replacement Character}. This means that placing a display property over a portion of text may change the way that the surrounding text is reordered for display. To prevent this unexpected effect, always place such @@ -6070,9 +6137,9 @@ begins at the right margin and is continued or truncated at the left margin. @defvar bidi-paragraph-direction - Emacs determines the base direction of each paragraph dynamically, -based on the text at the beginning of the paragraph. The precise -method of determining the base direction is specified by the + By default, Emacs determines the base direction of each paragraph +dynamically, based on the text at the beginning of the paragraph. The +precise method of determining the base direction is specified by the @acronym{UBA}; in a nutshell, the first character in a paragraph that has an explicit directionality determines the base direction of the paragraph. However, sometimes a buffer may need to force a certain @@ -6084,6 +6151,13 @@ dynamic determination of the base direction, and instead forces all paragraphs in the buffer to have the direction specified by its buffer-local value. The value can be either @code{right-to-left} or @code{left-to-right}. Any other value is interpreted as @code{nil}. +The default is @code{nil}. + +@cindex @code{prog-mode}, and @code{bidi-paragraph-direction} +Modes that are meant to display program source code should force a +@code{left-to-right} paragraph direction. The easiest way of doing so +is to derive the mode from Prog Mode, which already sets +@code{bidi-paragraph-direction} to that value. @end defvar @defun current-bidi-paragraph-direction &optional buffer @@ -6094,5 +6168,83 @@ omitted or @code{nil}, it defaults to the current buffer. If the buffer-local value of the variable @code{bidi-paragraph-direction} is non-@code{nil}, the returned value will be identical to that value; otherwise, the returned value reflects the paragraph direction -determined dynamically by Emacs. -@end defun +determined dynamically by Emacs. For buffers whose value of +@code{bidi-display-reordering} is @code{nil} as well as unibyte +buffers, this function always returns @code{left-to-right}. +@end defun + +@cindex layout on display, and bidirectional text +@cindex jumbled display of bidirectional text +@cindex concatenating bidirectional strings + Reordering of bidirectional text for display can have surprising and +unpleasant effects when two strings with bidirectional content are +juxtaposed in a buffer, or otherwise programmatically concatenated +into a string of text. A typical example is a buffer whose lines are +actually sequences of items, or fields, separated by whitespace or +punctuation characters. This is used in specialized modes such as +Buffer-menu Mode or various email summary modes, like Rmail Summary +Mode. Because these separator characters are @dfn{weak}, i.e.@: have +no strong directionality, they take on the directionality of +surrounding text. As result, a numeric field that follows a field +with bidirectional content can be displayed @emph{to the left} of the +preceding field, producing a jumbled display and messing up the +expected layout. + + To countermand this, we recommend that you use one of the following +techniques for forcing correct order of fields on display: + +@itemize @minus +@item +Append the special character @code{U+200E}, LEFT-TO-RIGHT MARK, or +@acronym{LRM}, to the end of each field that may have bidirectional +content, or prepend it to the beginning of the following field. The +function @code{bidi-string-mark-left-to-right}, described below, comes +in handy for this purpose. (In a right-to-left paragraph, use +@code{U+200F}, RIGHT-TO-LEFT MARK, or @acronym{RLM}, instead.) This +is one of the solutions recommended by +@uref{http://www.unicode.org/reports/tr9/#Separators, the +@acronym{UBA}}. + +@item +Include the tab character in the field separator. The tab character +plays the role of @dfn{segment separator} in the @acronym{UBA} +reordering, whose effect is to make each field a separate segment, and +thus reorder them separately. + +@cindex @code{space} display spec, and bidirectional text +@item +Separate fields with a @code{display} property or overlay with the +property value of the form @code{(space . PROPS)} (@pxref{Specified +Space}). This display specification is treated by Emacs as a +@dfn{paragraph separator}; the text before and after the separator is +reordered separately, which avoids the influence of any field on its +neighboring fields. +@end itemize + +@defun bidi-string-mark-left-to-right string +This subroutine returns its argument @var{string}, possibly modified, +such that the result can be safely concatenated with another string, +or juxtaposed with another string in a buffer, without disrupting the +relative layout of this string and the next one on display. If the +string returned by this function is displayed as part of a +left-to-right paragraph, it will always appear on display to the left +of the text that follows it. The function works by examining the +characters of its argument, and if any of those characters could cause +reordering on display, the function appends the @acronym{LRM} +character to the string. The appended @acronym{LRM} character is made +@emph{invisible} (@pxref{Invisible Text}), to hide it on display. +@end defun + + The reordering algorithm uses the bidirectional properties of the +characters stored as their @code{bidi-class} property +(@pxref{Character Properties}). Lisp programs can change these +properties by calling the @code{put-char-code-property} function. +However, doing this requires a thorough understanding of the +@acronym{UBA}, and is therefore not recommended. Any changes to the +bidirectional properties of a character have global effect: they +affect all Emacs frames and windows. + + Similarly, the @code{mirroring} property is used to display the +appropriate mirrored character in the reordered text. Lisp programs +can affect the mirrored display by changing this property. Again, any +such changes affect all of Emacs display. diff --git a/doc/lispref/elisp.texi b/doc/lispref/elisp.texi index bb05f1b4a0b..bcf6d3318ef 100644 --- a/doc/lispref/elisp.texi +++ b/doc/lispref/elisp.texi @@ -765,8 +765,7 @@ Major and Minor Modes * Major Modes:: Defining major modes. * Minor Modes:: Defining minor modes. * Mode Line Format:: Customizing the text that appears in the mode line. -* Imenu:: How a mode can provide a menu - of definitions in the buffer. +* Imenu:: Providing a menu of definitions made in a buffer. * Font Lock Mode:: How modes can highlight text according to syntax. * Desktop Save Mode:: How modes can have buffer state saved between Emacs sessions. @@ -778,12 +777,12 @@ Hooks Major Modes -* Major Mode Basics:: * Major Mode Conventions:: Coding conventions for keymaps, etc. * Auto Major Mode:: How Emacs chooses the major mode automatically. * Mode Help:: Finding out how to use a mode. * Derived Modes:: Defining a new major mode based on another major mode. +* Basic Major Modes:: Modes that other modes are often derived from. * Generic Modes:: Defining a simple major mode that supports comment syntax and Font Lock mode. * Mode Hooks:: Hooks run at the end of major mode functions. @@ -1309,6 +1308,7 @@ Faces * Face Remapping:: Remapping faces to alternative definitions. * Face Functions:: How to define and examine faces. * Auto Faces:: Hook for automatic face assignment. +* Basic Faces:: Faces that are defined by default. * Font Selection:: Finding the best available font for a face. * Font Lookup:: Looking up the names of available fonts and information about them. diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index 4d992bd2c51..bd904bf49c0 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -203,17 +203,6 @@ When this command is called interactively, it prompts for @var{filename}. @end deffn -@deffn Command view-file filename -This command visits @var{filename} using View mode, returning to the -previous buffer when you exit View mode. View mode is a minor mode that -provides commands to skim rapidly through the file, but does not let you -modify the text. Entering View mode runs the normal hook -@code{view-mode-hook}. @xref{Hooks}. - -When @code{view-file} is called interactively, it prompts for -@var{filename}. -@end deffn - @defopt find-file-wildcards If this variable is non-@code{nil}, then the various @code{find-file} commands check for wildcard characters and visit all the files that @@ -1529,19 +1518,26 @@ This function is not available on systems that don't support symbolic links. @end deffn -@deffn Command delete-file filename +@cindex trash +@vindex delete-by-moving-to-trash +@deffn Command delete-file filename &optional trash @pindex rm -This command deletes the file @var{filename}, like the shell command -@samp{rm @var{filename}}. If the file has multiple names, it continues -to exist under the other names. - -A suitable kind of @code{file-error} error is signaled if the file does -not exist, or is not deletable. (On Unix and GNU/Linux, a file is -deletable if its directory is writable.) - -If @var{filename} is a symbolic link, @code{delete-file} does not -replace it with its target, but it does follow symbolic links at all -levels of parent directories. +This command deletes the file @var{filename}. If the file has +multiple names, it continues to exist under the other names. If +@var{filename} is a symbolic link, @code{delete-file} deletes only the +symbolic link and not its target (though it does follow symbolic links +at all levels of parent directories). + +A suitable kind of @code{file-error} error is signaled if the file +does not exist, or is not deletable. (On Unix and GNU/Linux, a file +is deletable if its directory is writable.) + +If the optional argument @var{trash} is non-@code{nil} and the +variable @code{delete-by-moving-to-trash} is non-@code{nil}, this +command moves the file into the system Trash instead of deleting it. +@xref{Misc File Ops,,Miscellaneous File Operations, emacs, The GNU +Emacs Manual}. When called interactively, @var{trash} is @code{t} if +no prefix argument is given, and @code{nil} otherwise. See also @code{delete-directory} in @ref{Create/Delete Dirs}. @end deffn @@ -2507,7 +2503,7 @@ if they don't already exist. @code{mkdir} is an alias for this. @end deffn -@deffn Command copy-directory dirname newname &optional keep-time parents +@deffn Command copy-directory dirname newname &optional keep-time parents copy-contents This command copies the directory named @var{dirname} to @var{newname}. If @var{newname} names an existing directory, @var{dirname} will be copied to a subdirectory there. @@ -2515,16 +2511,23 @@ This command copies the directory named @var{dirname} to It always sets the file modes of the copied files to match the corresponding original file. -The third arg @var{keep-time} non-@code{nil} means to preserve the +The third argument @var{keep-time} non-@code{nil} means to preserve the modification time of the copied files. A prefix arg makes @var{keep-time} non-@code{nil}. -Noninteractively, the last argument @var{parents} says whether to +The fourth argument @var{parents} says whether to create parent directories if they don't exist. Interactively, this happens by default. + +The fifth argument @var{copy-contents}, if non-@code{nil}, means to +copy the contents of @var{dirname} directly into @var{newname} if the +latter is an existing directory, instead of copying @var{dirname} into +it as a subdirectory. @end deffn -@deffn Command delete-directory dirname &optional recursive +@cindex trash +@vindex delete-by-moving-to-trash +@deffn Command delete-directory dirname &optional recursive trash This command deletes the directory named @var{dirname}. The function @code{delete-file} does not work for files that are directories; you must use @code{delete-directory} for them. If @var{recursive} is @@ -2533,6 +2536,13 @@ must use @code{delete-directory} for them. If @var{recursive} is @code{delete-directory} only follows symbolic links at the level of parent directories. + +If the optional argument @var{trash} is non-@code{nil} and the +variable @code{delete-by-moving-to-trash} is non-@code{nil}, this +command moves the file into the system Trash instead of deleting it. +@xref{Misc File Ops,,Miscellaneous File Operations, emacs, The GNU +Emacs Manual}. When called interactively, @var{trash} is @code{t} if +no prefix argument is given, and @code{nil} otherwise. @end deffn @node Magic File Names diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index b6012a4dd53..e799cfa6b7f 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -695,20 +695,19 @@ right fringe. However, you can force one fringe or the other to a precise width by specifying that width as a negative integer. If both widths are negative, only the left fringe gets the specified width. -@vindex menu-bar-lines, a frame parameter +@vindex menu-bar-lines frame parameter @item menu-bar-lines The number of lines to allocate at the top of the frame for a menu -bar. The default is 1. A value of @code{nil} means don't display a -menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one -menu bar line; they treat larger values as 1.) +bar. The default is 1 if Menu Bar mode is enabled, and 0 otherwise. +@xref{Menu Bars,,,emacs, The GNU Emacs Manual}. -@vindex tool-bar-lines, a frame parameter +@vindex tool-bar-lines frame parameter @item tool-bar-lines -The number of lines to use for the tool bar. A value of @code{nil} -means don't display a tool bar. (GTK and Nextstep allow at most one -tool bar line; they treat larger values as 1.) +The number of lines to use for the tool bar. The default is 1 if Tool +Bar mode is enabled, and 0 otherwise. @xref{Tool Bars,,,emacs, The +GNU Emacs Manual}. -@vindex tool-bar-position, a frame parameter +@vindex tool-bar-position frame parameter @item tool-bar-position The position of the tool bar. Currently only for the GTK tool bar. Value can be one of @code{top}, @code{bottom} @code{left}, @code{right}. diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi index 064be89632f..7a530b602e0 100644 --- a/doc/lispref/lists.texi +++ b/doc/lispref/lists.texi @@ -462,7 +462,7 @@ element is @var{object}. Compare @code{make-list} with @result{} nil @end group @group -(setq l (make-list 3 '(a b)) +(setq l (make-list 3 '(a b))) @result{} ((a b) (a b) (a b)) (eq (car l) (cadr l)) @result{} t diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index dd3b2e3038f..eb81ebc4acb 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -19,16 +19,15 @@ user. For related topics such as keymaps and syntax tables, see @ref{Keymaps}, and @ref{Syntax Tables}. @menu -* Hooks:: How to use hooks; how to write code that provides hooks. -* Major Modes:: Defining major modes. -* Minor Modes:: Defining minor modes. -* Mode Line Format:: Customizing the text that appears in the mode line. -* Imenu:: How a mode can provide a menu - of definitions in the buffer. -* Font Lock Mode:: How modes can highlight text according to syntax. -* Auto-Indentation:: How to teach Emacs to indent for a major mode. -* Desktop Save Mode:: How modes can have buffer state saved between - Emacs sessions. +* Hooks:: How to use hooks; how to write code that provides hooks. +* Major Modes:: Defining major modes. +* Minor Modes:: Defining minor modes. +* Mode Line Format:: Customizing the text that appears in the mode line. +* Imenu:: Providing a menu of definitions made in a buffer. +* Font Lock Mode:: How modes can highlight text according to syntax. +* Auto-Indentation:: How to teach Emacs to indent for a major mode. +* Desktop Save Mode:: How modes can have buffer state saved between + Emacs sessions. @end menu @node Hooks @@ -48,12 +47,12 @@ convention, whenever the hook name ends in @samp{-hook}, that tells you it is normal. We try to make all hooks normal, as much as possible, so that you can use them in a uniform way. - Every major mode function is supposed to run a normal hook called -the @dfn{mode hook} as the one of the last steps of initialization. -This makes it easy for a user to customize the behavior of the mode, -by overriding the buffer-local variable assignments already made by -the mode. Most minor mode functions also run a mode hook at the end. -But hooks are used in other contexts too. For example, the hook + Every major mode command is supposed to run a normal hook called the +@dfn{mode hook} as the one of the last steps of initialization. This +makes it easy for a user to customize the behavior of the mode, by +overriding the buffer-local variable assignments already made by the +mode. Most minor mode functions also run a mode hook at the end. But +hooks are used in other contexts too. For example, the hook @code{suspend-hook} runs just before Emacs suspends itself (@pxref{Suspending Emacs}). @@ -78,8 +77,8 @@ convention. its value is just a single function, not a list of functions. @menu -* Running Hooks:: How to run a hook. -* Setting Hooks:: How to put functions on a hook, or remove them. +* Running Hooks:: How to run a hook. +* Setting Hooks:: How to put functions on a hook, or remove them. @end menu @node Running Hooks @@ -195,115 +194,98 @@ from the buffer-local hook list instead of from the global hook list. @section Major Modes @cindex major mode +@cindex major mode command Major modes specialize Emacs for editing particular kinds of text. -Each buffer has only one major mode at a time. For each major mode -there is a function to switch to that mode in the current buffer; its -name should end in @samp{-mode}. These functions work by setting -buffer-local variable bindings and other data associated with the -buffer, such as a local keymap. The effect lasts until you switch -to another major mode in the same buffer. +Each buffer has one major mode at a time. Every major mode is +associated with a @dfn{major mode command}, whose name should end in +@samp{-mode}. This command takes care of switching to that mode in the +current buffer, by setting various buffer-local variables such as a +local keymap. @xref{Major Mode Conventions}. + + The least specialized major mode is called @dfn{Fundamental mode}, +which has no mode-specific definitions or variable settings. + +@deffn Command fundamental-mode +This is the major mode command for Fundamental mode. Unlike other mode +commands, it does @emph{not} run any mode hooks (@pxref{Major Mode +Conventions}), since you are not supposed to customize this mode. +@end deffn + + The easiest way to write a major mode is to use the macro +@code{define-derived-mode}, which sets up the new mode as a variant of +an existing major mode. @xref{Derived Modes}. We recommend using +@code{define-derived-mode} even if the new mode is not an obvious +derivative of another mode, as it automatically enforces many coding +conventions for you. @xref{Basic Major Modes}, for common modes to +derive from. + + The standard GNU Emacs Lisp directory tree contains the code for +several major modes, in files such as @file{text-mode.el}, +@file{texinfo.el}, @file{lisp-mode.el}, and @file{rmail.el}. You can +study these libraries to see how modes are written. + +@defopt major-mode +The buffer-local value of this variable holds the symbol for the current +major mode. Its default value holds the default major mode for new +buffers. The standard default value is @code{fundamental-mode}. + +If the default value is @code{nil}, then whenever Emacs creates a new +buffer via a command such as @kbd{C-x b} (@code{switch-to-buffer}), the +new buffer is put in the major mode of the previously current buffer. +As an exception, if the major mode of the previous buffer has a +@code{mode-class} symbol property with value @code{special}, the new +buffer is put in Fundamental mode (@pxref{Major Mode Conventions}). +@end defopt @menu -* Major Mode Basics:: -* Major Mode Conventions:: Coding conventions for keymaps, etc. -* Auto Major Mode:: How Emacs chooses the major mode automatically. -* Mode Help:: Finding out how to use a mode. -* Derived Modes:: Defining a new major mode based on another major +* Major Mode Conventions:: Coding conventions for keymaps, etc. +* Auto Major Mode:: How Emacs chooses the major mode automatically. +* Mode Help:: Finding out how to use a mode. +* Derived Modes:: Defining a new major mode based on another major mode. -* Generic Modes:: Defining a simple major mode that supports +* Basic Major Modes:: Modes that other modes are often derived from. +* Generic Modes:: Defining a simple major mode that supports comment syntax and Font Lock mode. -* Mode Hooks:: Hooks run at the end of major mode functions. -* Example Major Modes:: Text mode and Lisp modes. +* Mode Hooks:: Hooks run at the end of major mode commands. +* Example Major Modes:: Text mode and Lisp modes. @end menu -@node Major Mode Basics -@subsection Major Mode Basics -@cindex Fundamental mode - - The least specialized major mode is called @dfn{Fundamental mode}. -This mode has no mode-specific definitions or variable settings, so each -Emacs command behaves in its default manner, and each option is in its -default state. All other major modes redefine various keys and options. -For example, Lisp Interaction mode provides special key bindings for -@kbd{C-j} (@code{eval-print-last-sexp}), @key{TAB} -(@code{lisp-indent-line}), and other keys. - - When you need to write several editing commands to help you perform a -specialized editing task, creating a new major mode is usually a good -idea. In practice, writing a major mode is easy (in contrast to -writing a minor mode, which is often difficult). - - If the new mode is similar to an old one, it is often unwise to -modify the old one to serve two purposes, since it may become harder -to use and maintain. Instead, copy and rename an existing major mode -definition and alter the copy---or use the @code{define-derived-mode} -macro to define a @dfn{derived mode} (@pxref{Derived Modes}). For -example, Rmail Edit mode is a major mode that is very similar to Text -mode except that it provides two additional commands. Its definition -is distinct from that of Text mode, but uses that of Text mode. - - Even if the new mode is not an obvious derivative of any other mode, -we recommend to use @code{define-derived-mode}, since it automatically -enforces the most important coding conventions for you. - - For a very simple programming language major mode that handles -comments and fontification, you can use @code{define-generic-mode}. -@xref{Generic Modes}. - - Rmail Edit mode offers an example of changing the major mode -temporarily for a buffer, so it can be edited in a different way (with -ordinary Emacs commands rather than Rmail commands). In such cases, the -temporary major mode usually provides a command to switch back to the -buffer's usual mode (Rmail mode, in this case). You might be tempted to -present the temporary redefinitions inside a recursive edit and restore -the usual ones when the user exits; but this is a bad idea because it -constrains the user's options when it is done in more than one buffer: -recursive edits must be exited most-recently-entered first. Using an -alternative major mode avoids this limitation. @xref{Recursive -Editing}. - - The standard GNU Emacs Lisp library directory tree contains the code -for several major modes, in files such as @file{text-mode.el}, -@file{texinfo.el}, @file{lisp-mode.el}, @file{c-mode.el}, and -@file{rmail.el}. They are found in various subdirectories of the -@file{lisp} directory. You can study these libraries to see how modes -are written. Text mode is perhaps the simplest major mode aside from -Fundamental mode. Rmail mode is a complicated and specialized mode. - @node Major Mode Conventions @subsection Major Mode Conventions @cindex major mode conventions @cindex conventions for writing major modes - The code for existing major modes follows various coding conventions, -including conventions for local keymap and syntax table initialization, -global names, and hooks. Please follow these conventions when you -define a new major mode. (Fundamental mode is an exception to many -of these conventions, because its definition is to present the global -state of Emacs.) + The code for every major mode should follow various coding +conventions, including conventions for local keymap and syntax table +initialization, function and variable names, and hooks. + + If you use the @code{define-derived-mode} macro, it will take care of +many of these conventions automatically. @xref{Derived Modes}. Note +also that fundamental mode is an exception to many of these conventions, +because its definition is to present the global state of Emacs. - This list of conventions is only partial, because each major mode -should aim for consistency in general with other Emacs major modes. -This makes Emacs as a whole more coherent. It is impossible to list + The following list of conventions is only partial. Each major mode +should aim for consistency in general with other Emacs major modes, as +this makes Emacs as a whole more coherent. It is impossible to list here all the possible points where this issue might come up; if the Emacs developers point out an area where your major mode deviates from the usual conventions, please make it compatible. @itemize @bullet @item -Define a command whose name ends in @samp{-mode}, with no arguments, -that switches to the new mode in the current buffer. This command -should set up the keymap, syntax table, and buffer-local variables in an -existing buffer, without changing the buffer's contents. +Define a major mode command whose name ends in @samp{-mode}. When +called with no arguments, this command should switch to the new mode in +the current buffer by setting up the keymap, syntax table, and +buffer-local variables in an existing buffer. It should not change the +buffer's contents. @item -Write a documentation string for this command that describes the -special commands available in this mode. @kbd{C-h m} -(@code{describe-mode}) in your mode will display this string. +Write a documentation string for this command that describes the special +commands available in this mode. @xref{Mode Help}. The documentation string may include the special documentation substrings, @samp{\[@var{command}]}, @samp{\@{@var{keymap}@}}, and -@samp{\<@var{keymap}>}, which enable the documentation to adapt +@samp{\<@var{keymap}>}, which allow the help display to adapt automatically to the user's own key bindings. @xref{Keys in Documentation}. @@ -421,28 +403,7 @@ setting up a buffer-local value for the variable @item Each face that the mode defines should, if possible, inherit from an -existing Emacs face. This reduces the chance of conflicting with a -user's face customizations. Useful faces include: - -@table @asis -@item @code{highlight} -for stretches of text that should temporarily stand out. - -@item @code{match} -for text matching a search command. - -@item @code{link} and @code{link-visited} -for clickable text buttons that send the user to a different buffer or -``location''. - -@item @code{button} -for clickable text buttons that perform other actions. - -@item @asis{Font Lock faces} -for other kinds of syntactic highlighting, if highlighting is not -handled by Font Lock mode or some Font Lock faces are not in use. -@xref{Faces for Font Lock}, for how to assign Font Lock faces. -@end table +existing Emacs face. @xref{Basic Faces}, and @ref{Faces for Font Lock}. @item The mode should specify how Imenu should find the definitions or @@ -505,27 +466,31 @@ this mode to any other major mode, this mode can set up a buffer-local value for @code{change-major-mode-hook} (@pxref{Creating Buffer-Local}). @item -If this mode is appropriate only for specially-prepared text, then the -major mode command symbol should have a property named @code{mode-class} -with value @code{special}, put on as follows: +If this mode is appropriate only for specially-prepared text produced by +the mode itself (rather than by the user typing at the keyboard or by an +external file), then the major mode command symbol should have a +property named @code{mode-class} with value @code{special}, put on as +follows: @kindex mode-class @r{(property)} -@cindex @code{special} +@cindex @code{special} modes @example (put 'funny-mode 'mode-class 'special) @end example @noindent -This tells Emacs that new buffers created while the current buffer is -in Funny mode should not inherit Funny mode, in case the default value -of @code{major-mode} is @code{nil}. Modes such as Dired, Rmail, -and Buffer List use this feature. +This tells Emacs that new buffers created while the current buffer is in +Funny mode should not be put in Funny mode, even though the default +value of @code{major-mode} is @code{nil}. By default, the value of +@code{nil} for @code{major-mode} means to use the current buffer's major +mode when creating new buffers (@pxref{Auto Major Mode}), but with such +@code{special} modes, Fundamental mode is used instead. Modes such as +Dired, Rmail, and Buffer List use this feature. The @code{define-derived-mode} macro automatically marks the derived -mode as special if the parent mode is special. The special mode -@code{special-mode} provides a convenient parent for other special -modes to inherit from; it sets @code{buffer-read-only} to @code{t}, -and does little else. +mode as special if the parent mode is special. Special mode is a +convenient parent for such modes to inherit from; @xref{Basic Major +Modes}. @item If you want to make the new mode the default for files with certain @@ -559,16 +524,6 @@ Even if you never load the file more than once, someone else will. automatically selects a major mode for the new buffer when a file is visited. It also processes local variables specified in the file text. -@deffn Command fundamental-mode - Fundamental mode is a major mode that is not specialized for anything -in particular. Other major modes are defined in effect by comparison -with this one---their definitions say what to change, starting from -Fundamental mode. The @code{fundamental-mode} function does @emph{not} -run any mode hooks; you're not supposed to customize it. (If you want Emacs -to behave differently in Fundamental mode, change the @emph{global} -state of Emacs.) -@end deffn - @deffn Command normal-mode &optional find-file This function establishes the proper major mode and buffer-local variable bindings for the current buffer. First it calls @code{set-auto-mode} @@ -594,23 +549,22 @@ by the default value of @code{major-mode} (see below). @cindex file mode specification error @code{normal-mode} uses @code{condition-case} around the call to the -major mode function, so errors are caught and reported as a @samp{File -mode specification error}, followed by the original error message. +major mode command, so errors are caught and reported as a @samp{File +mode specification error}, followed by the original error message. @end deffn @defun set-auto-mode &optional keep-mode-if-same @cindex visited file mode This function selects the major mode that is appropriate for the -current buffer. It bases its decision (in order of precedence) on -the @w{@samp{-*-}} line, on any @samp{mode:} local variable near the -end of a file, on the @w{@samp{#!}} line (using -@code{interpreter-mode-alist}), on the text at the beginning of the -buffer (using @code{magic-mode-alist}), and finally on the visited -file name (using @code{auto-mode-alist}). @xref{Choosing Modes, , How -Major Modes are Chosen, emacs, The GNU Emacs Manual}. -If @code{enable-local-variables} is @code{nil}, @code{set-auto-mode} -does not check the @w{@samp{-*-}} line, or near the end of the file, -for any mode tag. +current buffer. It bases its decision (in order of precedence) on the +@w{@samp{-*-}} line, on any @samp{mode:} local variable near the end of +a file, on the @w{@samp{#!}} line (using @code{interpreter-mode-alist}), +on the text at the beginning of the buffer (using +@code{magic-mode-alist}), and finally on the visited file name (using +@code{auto-mode-alist}). @xref{Choosing Modes, , How Major Modes are +Chosen, emacs, The GNU Emacs Manual}. If @code{enable-local-variables} +is @code{nil}, @code{set-auto-mode} does not check the @w{@samp{-*-}} +line, or near the end of the file, for any mode tag. If @var{keep-mode-if-same} is non-@code{nil}, this function does not call the mode command if the buffer is already in the proper major @@ -619,21 +573,6 @@ mode. For instance, @code{set-visited-file-name} sets this to have set. @end defun -@defopt major-mode -The buffer-local value of this variable holds the major mode -currently active. The default value of this variable holds the -default major mode for new buffers. The standard default value is -@code{fundamental-mode}. - -If the default value of @code{major-mode} is @code{nil}, Emacs uses -the (previously) current buffer's major mode as the default major mode -of a new buffer. However, if that major mode symbol has a @code{mode-class} -property with value @code{special}, then it is not used for new buffers; -Fundamental mode is used instead. The modes that have this property are -those such as Dired and Rmail that are useful only with text that has -been specially prepared. -@end defopt - @defun set-buffer-major-mode buffer This function sets the major mode of @var{buffer} to the default value of @code{major-mode}; if that is @code{nil}, it uses the @@ -740,38 +679,30 @@ init file.) @cindex help for major mode @cindex documentation for major mode - The @code{describe-mode} function is used to provide information -about major modes. It is normally called with @kbd{C-h m}. The -@code{describe-mode} function uses the value of @code{major-mode}, -which is why every major mode function needs to set the -@code{major-mode} variable. + The @code{describe-mode} function is provides information about major +modes. It is normally bound to @kbd{C-h m}. It uses the value of the +variable @code{major-mode} (@pxref{Major Modes}), which is why every +major mode command needs to set that variable. @deffn Command describe-mode This function displays the documentation of the current major mode. The @code{describe-mode} function calls the @code{documentation} function using the value of @code{major-mode} as an argument. Thus, it -displays the documentation string of the major mode function. +displays the documentation string of the major mode command. (@xref{Accessing Documentation}.) @end deffn -@defvar major-mode -This buffer-local variable holds the symbol for the current buffer's -major mode. This symbol should have a function definition that is the -command to switch to that major mode. The @code{describe-mode} -function uses the documentation string of the function as the -documentation of the major mode. -@end defvar - @node Derived Modes @subsection Defining Derived Modes @cindex derived mode - The recommended way to define a new major mode is to derive it -from an existing one using @code{define-derived-mode}. If there is no -closely related mode, you can inherit from @code{text-mode}, -@code{special-mode}, @code{prog-mode}, or in the worst case -@code{fundamental-mode}. + The recommended way to define a new major mode is to derive it from an +existing one using @code{define-derived-mode}. If there is no closely +related mode, you should inherit from either @code{text-mode}, +@code{special-mode}, or @code{prog-mode}. @xref{Basic Major Modes}. If +none of these are suitable, you can inherit from @code{fundamental-mode} +(@pxref{Major Modes}). @defmac define-derived-mode variant parent name docstring keyword-args@dots{} body@dots{} This macro defines @var{variant} as a major mode command, using @@ -872,6 +803,64 @@ Do not write an @code{interactive} spec in the definition; @code{define-derived-mode} does that automatically. @end defmac +@defun derived-mode-p &rest modes +This function returns non-@code{nil} if the current major mode is +derived from any of the major modes given by the symbols @var{modes}. +@end defun + +@node Basic Major Modes +@subsection Basic Major Modes + + Apart from Fundamental mode, there are three major modes that other +major modes commonly derive from: Text mode, Prog mode, and Special +mode. While Text mode is useful in its own right (e.g. for editing +files ending in @file{.txt}), Prog mode and Special mode exist mainly to +let other modes derive from them. + +@vindex prog-mode-hook + As far as possible, new major modes should be derived, either directly +or indirectly, from one of these three modes. One reason is that this +allows users to customize a single mode hook +(e.g. @code{prog-mode-hook}) for an entire family of relevant modes +(e.g. all programming language modes). + +@deffn Command text-mode +Text mode is a major mode for editing human languages. It defines the +@samp{"} and @samp{\} characters as having punctuation syntax +(@pxref{Syntax Class Table}), and binds @kbd{M-@key{TAB}} to +@code{ispell-complete-word} (@pxref{Spelling,,, emacs, The GNU Emacs +Manual}). + +An example of a major mode derived from Text mode is HTML mode. +@xref{HTML Mode,,SGML and HTML Modes, emacs, The GNU Emacs Manual}. +@end deffn + +@deffn Command prog-mode +Prog mode is a basic major mode for buffers containing programming +language source code. Most of the programming language major modes +built into Emacs are derived from it. + +Prog mode binds @code{parse-sexp-ignore-comments} to @code{t} +(@pxref{Motion via Parsing}) and @code{bidi-paragraph-direction} to +@code{left-to-right} (@pxref{Bidirectional Display}). +@end deffn + +@deffn Command special-mode +Special mode is a basic major mode for buffers containing text that is +produced specially by Emacs, rather than from a file. Major modes +derived from Special mode are given a @code{mode-class} property of +@code{special} (@pxref{Major Mode Conventions}). + +Special mode sets the buffer to read-only. Its keymap defines several +common bindings, including @kbd{q} for @code{quit-window}, @kbd{z} for +@code{kill-this-buffer}, and @kbd{g} for @code{revert-buffer} +(@pxref{Reverting}). + +An example of a major mode derived from Special mode is Buffer Menu +mode, which is used by the @samp{*Buffer List*} buffer. @xref{List +Buffers,,Listing Existing Buffers, emacs, The GNU Emacs Manual}. +@end deffn + @node Generic Modes @subsection Generic Modes @cindex generic mode @@ -916,7 +905,7 @@ before it runs the mode hook variable @code{@var{mode}-hook}. @node Mode Hooks @subsection Mode Hooks - Every major mode function should finish by running its mode hook and + Every major mode command should finish by running its mode hook and the mode-independent normal hook @code{after-change-major-mode-hook}. It does this by calling @code{run-mode-hooks}. If the major mode is a derived mode, that is if it calls another major mode (the parent mode) @@ -961,7 +950,7 @@ construct. @defvar after-change-major-mode-hook This is a normal hook run by @code{run-mode-hooks}. It is run at the -very end of every properly-written major mode function. +very end of every properly-written major mode command. @end defvar @node Example Major Modes @@ -1189,8 +1178,8 @@ And here is the code to set up the keymap for Lisp mode: @end group @end smallexample - Finally, here is the complete major mode function definition for -Lisp mode. + Finally, here is the complete major mode command definition for Lisp +mode. @smallexample @group @@ -2747,10 +2736,10 @@ highlighting patterns. See the variables @code{c-font-lock-extra-types}, @code{c++-font-lock-extra-types}, and @code{java-font-lock-extra-types}, for example. -@strong{Warning:} major mode functions must not call +@strong{Warning:} major mode commands must not call @code{font-lock-add-keywords} under any circumstances, either directly -or indirectly, except through their mode hooks. (Doing so would lead -to incorrect behavior for some minor modes.) They should set up their +or indirectly, except through their mode hooks. (Doing so would lead to +incorrect behavior for some minor modes.) They should set up their rules for search-based fontification by setting @code{font-lock-keywords}. @end defun diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 77337899923..298c7c3d1a8 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi @@ -369,6 +369,12 @@ replacing each @samp{_} character with a dash @samp{-}. For example, @code{canonical-combining-class}. However, sometimes we shorten the names to make their use easier. +@cindex unassigned character codepoints + Some codepoints are left @dfn{unassigned} by the +@acronym{UCD}---they don't correspond to any character. The Unicode +Standard defines default values of properties for such codepoints; +they are mentioned below for each property. + Here is the full list of value types for all the character properties that Emacs knows about: @@ -376,22 +382,31 @@ properties that Emacs knows about: @item name Corresponds to the @code{Name} Unicode property. The value is a string consisting of upper-case Latin letters A to Z, digits, spaces, -and hyphen @samp{-} characters. +and hyphen @samp{-} characters. For unassigned codepoints, the value +is an empty string. @cindex unicode general category @item general-category Corresponds to the @code{General_Category} Unicode property. The value is a symbol whose name is a 2-letter abbreviation of the -character's classification. +character's classification. For unassigned codepoints, the value +is @code{Cn}. @item canonical-combining-class Corresponds to the @code{Canonical_Combining_Class} Unicode property. -The value is an integer number. +The value is an integer number. For unassigned codepoints, the value +is zero. +@cindex bidirectional class of characters @item bidi-class Corresponds to the Unicode @code{Bidi_Class} property. The value is a symbol whose name is the Unicode @dfn{directional type} of the -character. +character. Emacs uses this property when it reorders bidirectional +text for display (@pxref{Bidirectional Display}). For unassigned +codepoints, the value depends on the code blocks to which the +codepoint belongs: most unassigned codepoints get the value of +@code{L} (strong L), but some get values of @code{AL} (Arabic letter) +or @code{R} (strong R). @item decomposition Corresponds to the Unicode @code{Decomposition_Type} and @@ -403,19 +418,22 @@ Note that the Unicode spec writes these tag names inside brackets; e.g., Unicode specifies @samp{<small>} where Emacs uses @samp{small}. }; the other elements are characters that give the compatibility -decomposition sequence of this character. +decomposition sequence of this character. For unassigned codepoints, +the value is the character itself. @item decimal-digit-value Corresponds to the Unicode @code{Numeric_Value} property for characters whose @code{Numeric_Type} is @samp{Digit}. The value is an -integer number. +integer number. For unassigned codepoints, the value is @code{nil}, +which means @acronym{NaN}, or ``not-a-number''. @item digit-value Corresponds to the Unicode @code{Numeric_Value} property for characters whose @code{Numeric_Type} is @samp{Decimal}. The value is an integer number. Examples of such characters include compatibility subscript and superscript digits, for which the value is the -corresponding number. +corresponding number. For unassigned codepoints, the value is +@code{nil}, which means @acronym{NaN}. @item numeric-value Corresponds to the Unicode @code{Numeric_Value} property for @@ -424,33 +442,53 @@ this property is an integer or a floating-point number. Examples of characters that have this property include fractions, subscripts, superscripts, Roman numerals, currency numerators, and encircled numbers. For example, the value of this property for the character -@code{U+2155} (@sc{vulgar fraction one fifth}) is @code{0.2}. +@code{U+2155} (@sc{vulgar fraction one fifth}) is @code{0.2}. For +unassigned codepoints, the value is @code{nil}, which means +@acronym{NaN}. +@cindex mirroring of characters @item mirrored Corresponds to the Unicode @code{Bidi_Mirrored} property. The value -of this property is a symbol, either @code{Y} or @code{N}. +of this property is a symbol, either @code{Y} or @code{N}. For +unassigned codepoints, the value is @code{N}. + +@item mirroring +Corresponds to the Unicode @code{Bidi_Mirroring_Glyph} property. The +value of this property is a character whose glyph represents the +mirror image of the character's glyph, or @code{nil} if there's no +defined mirroring glyph. All the characters whose @code{mirrored} +property is @code{N} have @code{nil} as their @code{mirroring} +property; however, some characters whose @code{mirrored} property is +@code{Y} also have @code{nil} for @code{mirroring}, because no +appropriate characters exist with mirrored glyphs. Emacs uses this +property to display mirror images of characters when appropriate +(@pxref{Bidirectional Display}). For unassigned codepoints, the value +is @code{nil}. @item old-name Corresponds to the Unicode @code{Unicode_1_Name} property. The value -is a string. +is a string. For unassigned codepoints, the value is an empty string. @item iso-10646-comment Corresponds to the Unicode @code{ISO_Comment} property. The value is -a string. +a string. For unassigned codepoints, the value is an empty string. @item uppercase Corresponds to the Unicode @code{Simple_Uppercase_Mapping} property. -The value of this property is a single character. +The value of this property is a single character. For unassigned +codepoints, the value is @code{nil}, which means the character itself. @item lowercase Corresponds to the Unicode @code{Simple_Lowercase_Mapping} property. -The value of this property is a single character. +The value of this property is a single character. For unassigned +codepoints, the value is @code{nil}, which means the character itself. @item titlecase Corresponds to the Unicode @code{Simple_Titlecase_Mapping} property. @dfn{Title case} is a special form of a character used when the first character of a word needs to be capitalized. The value of this -property is a single character. +property is a single character. For unassigned codepoints, the value +is @code{nil}, which means the character itself. @end table @defun get-char-code-property char propname diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi index 6d63bb7b750..26def7858b7 100644 --- a/doc/lispref/objects.texi +++ b/doc/lispref/objects.texi @@ -597,6 +597,7 @@ FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} @end group @end example +@cindex @samp{##} read syntax @ifinfo @c This uses ``colon'' instead of a literal `:' because Info cannot @c cope with a `:' in a menu @@ -605,9 +606,12 @@ FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} @ifnotinfo @cindex @samp{#:} read syntax @end ifnotinfo - Normally the Lisp reader interns all symbols (@pxref{Creating -Symbols}). To prevent interning, you can write @samp{#:} before the -name of the symbol. + As an exception to the rule that a symbol's name serves as its +printed representation, @samp{##} is the printed representation for an +interned symbol whose name is an empty string. Furthermore, +@samp{#:@var{foo}} is the printed representation for an uninterned +symbol whose name is @var{foo}. (Normally, the Lisp reader interns +all symbols; @pxref{Creating Symbols}.) @node Sequence Type @subsection Sequence Types diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 5f422065c5b..7d05f8f3468 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -544,10 +544,11 @@ parent process normally resumes control. The low-level primitive for killing Emacs is @code{kill-emacs}. @deffn Command kill-emacs &optional exit-data -This command exits the Emacs process and kills it. +This command calls the hook @code{kill-emacs-hook}, then exits the +Emacs process and kills it. -If @var{exit-data} is an integer, then it is used as the exit status -of the Emacs process. (This is useful primarily in batch operation; see +If @var{exit-data} is an integer, that is used as the exit status of +the Emacs process. (This is useful primarily in batch operation; see @ref{Batch Mode}.) If @var{exit-data} is a string, its contents are stuffed into the @@ -555,35 +556,44 @@ terminal input buffer so that the shell (or whatever program next reads input) can read them. @end deffn - All the information in the Emacs process, aside from files that have -been saved, is lost when the Emacs process is killed. Because killing -Emacs inadvertently can lose a lot of work, Emacs queries for -confirmation before actually terminating if you have buffers that need -saving or subprocesses that are running. This is done in the function -@code{save-buffers-kill-emacs}, the higher level function from which -@code{kill-emacs} is usually called. +@cindex SIGTERM +@cindex SIGHUP +@cindex SIGINT +@cindex operating system signal + The @code{kill-emacs} function is normally called via the +higher-level command @kbd{C-x C-c} +(@code{save-buffers-kill-terminal}). @xref{Exiting,,, emacs, The GNU +Emacs Manual}. It is also called automatically if Emacs receives a +@code{SIGTERM} or @code{SIGHUP} operating system signal (e.g. when the +controlling terminal is disconnected), or if it receives a +@code{SIGINT} signal while running in batch mode (@pxref{Batch Mode}). -@defvar kill-emacs-query-functions -After asking the standard questions, @code{save-buffers-kill-emacs} -calls the functions in the list @code{kill-emacs-query-functions}, in -order of appearance, with no arguments. These functions can ask for -additional confirmation from the user. If any of them returns -@code{nil}, @code{save-buffers-kill-emacs} does not kill Emacs, and -does not run the remaining functions in this hook. Calling -@code{kill-emacs} directly does not run this hook. +@defvar kill-emacs-hook +This normal hook is run by @code{kill-emacs}, before it kills Emacs. + +Because @code{kill-emacs} can be called in situations where user +interaction is impossible (e.g. when the terminal is disconnected), +functions on this hook should not attempt to interact with the user. +If you want to interact with the user when Emacs is shutting down, use +@code{kill-emacs-query-functions}, described below. @end defvar -@defvar kill-emacs-hook -This variable is a normal hook; once @code{save-buffers-kill-emacs} is -finished with all file saving and confirmation, it calls -@code{kill-emacs} which runs the functions in this hook. - -@code{kill-emacs} may be invoked directly (that is not via -@code{save-buffers-kill-emacs}) if the terminal is disconnected, or in -similar situations where interaction with the user is not possible. -Thus, if your hook needs to interact with the user, put it on -@code{kill-emacs-query-functions}; if it needs to run regardless of -how Emacs is killed, put it on @code{kill-emacs-hook}. + When Emacs is killed, all the information in the Emacs process, +aside from files that have been saved, is lost. Because killing Emacs +inadvertently can lose a lot of work, the +@code{save-buffers-kill-terminal} command queries for confirmation if +you have buffers that need saving or subprocesses that are running. +It also runs the abnormal hook @code{kill-emacs-query-functions}: + +@defvar kill-emacs-query-functions +When @code{save-buffers-kill-terminal} is killing Emacs, it calls the +functions in this hook, after asking the standard questions and before +calling @code{kill-emacs}. The functions are called in order of +appearance, with no arguments. Each function can ask for additional +confirmation from the user. If any of them returns @code{nil}, +@code{save-buffers-kill-emacs} does not kill Emacs, and does not run +the remaining functions in this hook. Calling @code{kill-emacs} +directly does not run this hook. @end defvar @node Suspending Emacs @@ -1143,6 +1153,18 @@ get with the function @code{file-attributes}. @xref{Definition of file-attributes}. @end defun +@defun float-time &optional time-value +This function returns the current time as a floating-point number of +seconds since the epoch. The argument @var{time-value}, if given, +specifies a time to convert instead of the current time. The argument +should have the same form as for @code{current-time-string} (see +above). Thus, it accepts the output of @code{current-time} and +@code{file-attributes} (@pxref{Definition of file-attributes}). + +@emph{Warning}: Since the result is floating point, it may not be +exact. Do not use this function if precise time stamps are required. +@end defun + @defun current-time-zone &optional time-value This function returns a list describing the time zone that the user is in. @@ -1165,25 +1187,11 @@ times obtained from @code{current-time} (see above) and from @code{file-attributes}. @xref{Definition of file-attributes}. @end defun -@defun set-time-zone-rule tz -This function specifies the local time zone according to @var{tz}. If -@var{tz} is @code{nil}, that means to use an implementation-defined -default time zone. If @var{tz} is @code{t}, that means to use -Universal Time. Otherwise, @var{tz} should be a string specifying a -time zone rule. -@end defun - -@defun float-time &optional time-value -This function returns the current time as a floating-point number of -seconds since the epoch. The argument @var{time-value}, if given, -specifies a time to convert instead of the current time. The argument -should have the same form as for @code{current-time-string} (see -above). Thus, it accepts the output of @code{current-time} and -@code{file-attributes} (@pxref{Definition of file-attributes}). - -@emph{Warning}: Since the result is floating point, it may not be -exact. Do not use this function if precise time stamps are required. -@end defun +The current time zone is determined by the @samp{TZ} environment +variable. @xref{System Environment}. For example, you can tell Emacs +to use universal time with @code{(setenv "TZ" "UTC0")}. If @samp{TZ} +is not in the environment, Emacs uses a platform-dependent default +time zone. @node Time Conversion @section Time Conversion diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi index 6272301dbb4..fe7c805c6f7 100644 --- a/doc/lispref/searching.texi +++ b/doc/lispref/searching.texi @@ -717,11 +717,15 @@ the characters that stand for them. @cindex @samp{\S} in regexp matches any character whose syntax is not @var{code}. +@cindex category, regexp search for @item \c@var{c} matches any character whose category is @var{c}. Here @var{c} is a character that represents a category: thus, @samp{c} for Chinese characters or @samp{g} for Greek characters in the standard category -table. +table. You can see the list of all the currently defined categories +with @kbd{M-x describe-categories @key{RET}}. You can also define +your own categories in addition to the standard ones using the +@code{define-category} function (@pxref{Categories}). @item \C@var{c} matches any character whose category is not @var{c}. diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index 31ee7eb4e7d..0d7a0c0bed4 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi @@ -1084,6 +1084,24 @@ defaults to the current buffer's category table. @defun define-category char docstring &optional table This function defines a new category, with name @var{char} and documentation @var{docstring}, for the category table @var{table}. + +Here's an example of defining a new category for characters that have +strong right-to-left directionality (@pxref{Bidirectional Display}) +and using it in a special category table: + +@example +(defvar special-category-table-for-bidi + (let ((category-table (make-category-table)) + (uniprop-table (unicode-property-table-internal 'bidi-class))) + (define-category ?R "Characters of bidi-class R, AL, or RLO" + category-table) + (map-char-table + #'(lambda (key val) + (if (memq val '(R AL RLO)) + (modify-category-entry key ?R category-table))) + uniprop-table) + category-table)) +@end example @end defun @defun category-docstring category &optional table diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index b91afb044f0..2348e3706dc 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -3015,6 +3015,11 @@ near the character. For this purpose, ``near'' means that all text between the character and where the mouse is have the same @code{mouse-face} property value. +Emacs ignores all face attributes from the @code{mouse-face} property +that alter the text size (e.g. @code{:height}, @code{:weight}, and +@code{:slant}). Those attributes are always the same as for the +unhighlighted text. + @item fontified @kindex fontified @r{(text property)} This property says whether the text is ready for display. If diff --git a/doc/lispref/vol1.texi b/doc/lispref/vol1.texi index 3b7718814b5..1275628cc94 100644 --- a/doc/lispref/vol1.texi +++ b/doc/lispref/vol1.texi @@ -786,8 +786,7 @@ Major and Minor Modes * Major Modes:: Defining major modes. * Minor Modes:: Defining minor modes. * Mode Line Format:: Customizing the text that appears in the mode line. -* Imenu:: How a mode can provide a menu - of definitions in the buffer. +* Imenu:: Providing a menu of definitions made in a buffer. * Font Lock Mode:: How modes can highlight text according to syntax. * Desktop Save Mode:: How modes can have buffer state saved between Emacs sessions. @@ -799,15 +798,15 @@ Hooks Major Modes -* Major Mode Basics:: * Major Mode Conventions:: Coding conventions for keymaps, etc. * Auto Major Mode:: How Emacs chooses the major mode automatically. * Mode Help:: Finding out how to use a mode. * Derived Modes:: Defining a new major mode based on another major mode. +* Basic Major Modes:: Modes that other modes are often derived from. * Generic Modes:: Defining a simple major mode that supports comment syntax and Font Lock mode. -* Mode Hooks:: Hooks run at the end of major mode functions. +* Mode Hooks:: Hooks run at the end of major mode commands. * Example Major Modes:: Text mode and Lisp modes. Minor Modes @@ -1330,6 +1329,7 @@ Faces * Face Remapping:: Remapping faces to alternative definitions. * Face Functions:: How to define and examine faces. * Auto Faces:: Hook for automatic face assignment. +* Basic Faces:: Faces that are defined by default. * Font Selection:: Finding the best available font for a face. * Font Lookup:: Looking up the names of available fonts and information about them. diff --git a/doc/lispref/vol2.texi b/doc/lispref/vol2.texi index 22a51d3235c..3d849fa2dcf 100644 --- a/doc/lispref/vol2.texi +++ b/doc/lispref/vol2.texi @@ -785,8 +785,7 @@ Major and Minor Modes * Major Modes:: Defining major modes. * Minor Modes:: Defining minor modes. * Mode Line Format:: Customizing the text that appears in the mode line. -* Imenu:: How a mode can provide a menu - of definitions in the buffer. +* Imenu:: Providing a menu of definitions made in a buffer. * Font Lock Mode:: How modes can highlight text according to syntax. * Desktop Save Mode:: How modes can have buffer state saved between Emacs sessions. @@ -798,15 +797,15 @@ Hooks Major Modes -* Major Mode Basics:: * Major Mode Conventions:: Coding conventions for keymaps, etc. * Auto Major Mode:: How Emacs chooses the major mode automatically. * Mode Help:: Finding out how to use a mode. * Derived Modes:: Defining a new major mode based on another major mode. +* Basic Major Modes:: Modes that other modes are often derived from. * Generic Modes:: Defining a simple major mode that supports comment syntax and Font Lock mode. -* Mode Hooks:: Hooks run at the end of major mode functions. +* Mode Hooks:: Hooks run at the end of major mode commands. * Example Major Modes:: Text mode and Lisp modes. Minor Modes @@ -1329,6 +1328,7 @@ Faces * Face Remapping:: Remapping faces to alternative definitions. * Face Functions:: How to define and examine faces. * Auto Faces:: Hook for automatic face assignment. +* Basic Faces:: Faces that are defined by default. * Font Selection:: Finding the best available font for a face. * Font Lookup:: Looking up the names of available fonts and information about them. diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 75e39104dcb..8260df911a8 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,27 +1,31 @@ -2011-07-28 Bastien Guerry <bzg@gnu.org> +2011-08-15 Suvayu Ali <fatkasuvayu+linux@gmail.com> (tiny change) + + * org.texi (Images in LaTeX export): rewrite. + +2011-08-15 Bastien Guerry <bzg@gnu.org> * org.texi (Using the mapping API): mention 'region as a possible scope for `org-map-entries'. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Visibility cycling): Document `org-copy-visible'. -2011-07-28 Bastien Guerry <bzg@gnu.org> +2011-08-15 Bastien Guerry <bzg@gnu.org> * org.texi (Template expansion): order template sequences in the proper order. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (eval): Expand discussion of the :eval header argument. -2011-07-28 Bastien Guerry <bzg@gnu.org> +2011-08-15 Bastien Guerry <bzg@gnu.org> * org.texi (Languages): Add Lilypond and Awk as supported languages. -2011-07-28 Achim Gratz <stromeko@nexgo.de> +2011-08-15 Achim Gratz <stromeko@nexgo.de> * org.texi: document that both CLOCK_INTO_DRAWER and LOG_INTO_DRAWER can be used to override the contents of variable @@ -29,240 +33,250 @@ * org.texi: replace @xref->@pxref. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Evaluating code blocks): Documenting the new option for inline call lines. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Results of evaluation): More explicit about the mechanism through which interactive evaluation of code is performed. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (noweb-ref): New header argument documentation. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Extracting source code): Documentation of the new org-babel-tangle-named-block-combination variable. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Structure of code blocks): explicitly state that the behavior of multiple blocks of the same name is undefined -2011-07-28 Christian Egli <christian.egli@sbszh.ch> +2011-08-15 Christian Egli <christian.egli@sbszh.ch> * org.texi (TaskJuggler export): Modify the example to reflect the new effort durations. -2011-07-28 David Maus <dmaus@ictsoc.de> +2011-08-15 David Maus <dmaus@ictsoc.de> * org.texi (Images in LaTeX export): Escape curly brackets in LaTeX example. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (The clock table): Document the :properties and :inherit-props arguments for the clocktable. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Tables in LaTeX export): Document specifying placement options for tables. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Evaluating code blocks): More specific documentation about the different types of header arguments. -2011-07-28 Manuel Giraud <manuel.giraud@univ-nantes.fr> +2011-08-15 Manuel Giraud <manuel.giraud@univ-nantes.fr> * org.texi (Sitemap): Document `:sitemap-sans-extension' property. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Built-in table editor): Document the table field follow mode. -2011-07-28 Robert P. Goldman <rpgoldman@real-time.com> +2011-08-15 Robert P. Goldman <rpgoldman@real-time.com> * org.texi (Easy Templates): Document new template. -2011-07-28 Robert P. Goldman <rpgoldman@real-time.com> +2011-08-15 Robert P. Goldman <rpgoldman@real-time.com> * org.texi (Literal examples): Add a cross-reference from "Literal Examples" to "Easy Templates." -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (The clock table): Add link to match syntax. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Agenda commands): Document clock consistency checks. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Built-in table editor): Document that \vert represents a vertical bar in a table field. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Literal examples): Link from "Markup" > "Literate Examples" to "Working with Source Code". -2011-07-28 Puneeth Chaganti <punchagan@gmail.com> +2011-08-15 Puneeth Chaganti <punchagan@gmail.com> * org.texi (Agenda commands): Doc for function option to bulk action. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Template expansion): Document new %<...> template escape. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Selective export): Document exclusion of any tasks from export. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Selective export): Document how to exclude DONE tasks from export. (Publishing options): Document the properties to be used to turn off export of DONE tasks. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (The date/time prompt): Document date range protection. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (padline): Documentation of the new padline header argument. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (var): Adding "[" to list of characters triggering elisp evaluation. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (var): Documentation of Emacs Lisp evaluation during variable assignment. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (colnames): Reference indexing into variables, and note that colnames are *not* removed before indexing occurs. (rownames): Reference indexing into variables, and note that rownames are *not* removed before indexing occurs. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (var): Clarification of indexing into tabular variables. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (results): Documentation of the `:results wrap' header argument. -2011-07-28 Bastien Guerry <bzg@gnu.org> +2011-08-15 Bastien Guerry <bzg@gnu.org> * org.texi (LaTeX and PDF export): add a note about a limitation of the LaTeX export: the org file has to be properly structured. -2011-07-28 Bastien Guerry <bzg@gnu.org> +2011-08-15 Bastien Guerry <bzg@gnu.org> * org.texi (Dynamic blocks, Structure editing): Mention the function `org-narrow-to-block'. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Languages): Updating list of code block supported languages. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Special properties): CATEGORY is a special property, but it may also used in the drawer. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (mkdirp): Documentation of the :mkdirp header argument. -2011-07-28 Puneeth Chaganti <punchagan@gmail.com> +2011-08-15 Puneeth Chaganti <punchagan@gmail.com> * org.texi (Include files): Document :lines. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (comments): Documentation of the ":comments noweb" code block header argument. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Conflicts): Changed "yasnippets" to "yasnippet" and added extra whitespace around functions to be consistent with the rest of the section. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Evaluating code blocks): Expanded discussion of #+call: line syntax. (Header arguments in function calls): Expanded discussion of #+call: line syntax. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Evaluating code blocks): More explicit about how to pass variables to #+call lines. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Results of evaluation): Link to the :results header argument list from the "Results of evaluation" section. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Conflicts): Adding additional information about resolving org/yasnippet conflicts. -2011-07-28 David Maus <dmaus@ictsoc.de> +2011-08-15 David Maus <dmaus@ictsoc.de> * org.texi (Publishing options): Document style-include-scripts publishing project property. -2011-07-28 Carsten Dominik <carsten.dominik@gmail.com> +2011-08-15 Carsten Dominik <carsten.dominik@gmail.com> * org.texi (Sparse trees): Document the next-error / previous-error functionality. -2011-07-28 Tom Dye <tsd@tsdye.com> +2011-08-15 Tom Dye <tsd@tsdye.com> * org.texi (cache): Improved documentation of code block caches. -2011-07-28 Tom Dye <tsd@tsdye.com> +2011-08-15 Tom Dye <tsd@tsdye.com> * org.texi (Code block specific header arguments): Documentation of multi-line header arguments. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Code evaluation security): Add example for using a function. -2011-07-28 Eric Schulte <schulte.eric@gmail.com> +2011-08-15 Eric Schulte <schulte.eric@gmail.com> * org.texi (Tables in LaTeX export): Documentation of new attr_latex options for tables. +2011-08-03 Michael Albinus <michael.albinus@gmx.de> + + * trampver.texi: Update release number. + +2011-07-30 Michael Albinus <michael.albinus@gmx.de> + + Sync with Tramp 2.2.2. + + * trampver.texi: Update release number. + 2011-07-15 Lars Magne Ingebrigtsen <larsi@gnus.org> * flymake.texi (Example -- Configuring a tool called via make): @@ -274,15 +288,15 @@ global keymap parent, which doesn't seem to be accurate (bug#7045). +2011-07-12 Lars Magne Ingebrigtsen <larsi@gnus.org> + + * org.texi (Special agenda views): Fix double quoting (bug#3509). + 2010-07-10 Kevin Ryde <user42@zip.com.au> * cl.texi (For Clauses): Add destructuring example processing an alist (bug#6596). -2011-07-12 Lars Magne Ingebrigtsen <larsi@gnus.org> - - * org.texi (Special agenda views): Fix double quoting (bug#3509). - 2011-07-07 Lars Magne Ingebrigtsen <larsi@gnus.org> * ediff.texi (Major Entry Points): Remove mention of `require', diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 8e01a10bde3..2a3d99ca7f4 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi @@ -4,8 +4,8 @@ @setfilename ../../info/org @settitle The Org Manual -@set VERSION 7.4 -@set DATE December 2010 +@set VERSION 7.7 +@set DATE July 2011 @c Use proper quote and backtick for code sections in PDF output @c Cf. Texinfo manual 14.2 @@ -34,7 +34,7 @@ @c Below we define the following macros for Org key tables: -@c orgkey{key} A key item +@c orgkey{key} A key item @c orgcmd{key,cmd} Key with command name @c xorgcmd{key,cmmand} Key with command name as @itemx @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key @@ -286,7 +286,7 @@ license to the document, as described in section 6 of the license. @end quotation @end copying -@dircategory Emacs editing modes +@dircategory Emacs @direntry * Org Mode: (org). Outline-based notes management and organizer @end direntry @@ -377,7 +377,8 @@ The spreadsheet * References:: How to refer to another field or range * Formula syntax for Calc:: Using Calc to compute stuff * Formula syntax for Lisp:: Writing formulas in Emacs Lisp -* Field formulas:: Formulas valid for a single field +* Durations and time values:: How to compute durations and time values +* Field and range formulas:: Formula for specific (ranges of) fields * Column formulas:: Formulas valid for an entire column * Editing and debugging formulas:: Fixing formulas * Updating the table:: Recomputing all dependent fields @@ -480,7 +481,7 @@ Capture - Refile - Archive * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds -* Protocols:: External (e.g. Browser) access to Emacs and Org +* Protocols:: External (e.g.@: Browser) access to Emacs and Org * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects @@ -572,6 +573,7 @@ Exporting * HTML export:: Exporting to HTML * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF * DocBook export:: Exporting to DocBook +* OpenDocumentText export:: Exporting to OpenDocumentText * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps * XOXO export:: Exporting to XOXO @@ -580,6 +582,7 @@ Exporting HTML export * HTML Export commands:: How to invoke HTML export +* HTML preamble and postamble:: How to insert a preamble and a postamble * Quoting HTML tags:: Using direct HTML in Org-mode * Links in HTML export:: How links will be interpreted and formatted * Tables in HTML export:: How to modify the formatting of tables @@ -607,6 +610,16 @@ DocBook export * Images in DocBook export:: How to insert figures into DocBook output * Special characters:: How to handle special characters +OpenDocument export + +* OpenDocumentText export commands:: How to invoke OpenDocumentText export +* Applying Custom Styles:: How to apply custom styles to the output +* Converting to Other formats:: How to convert to formats like doc, docx etc +* Links in OpenDocumentText export:: How links will be interpreted and formatted +* Tables in OpenDocumentText export:: How Tables are handled +* Images in OpenDocumentText export:: How to insert figures +* Additional Documentation:: How to handle special characters + Publishing * Configuration:: Defining projects @@ -620,7 +633,7 @@ Configuration * Sources and destinations:: From here to there * Selecting files:: What files are part of the project? * Publishing action:: Setting the function doing the publishing -* Publishing options:: Tweaking HTML export +* Publishing options:: Tweaking HTML/@LaTeX{} export * Publishing links:: Which links keep working after publishing? * Sitemap:: Generating a list of all pages * Generating an index:: An index that reaches across pages @@ -669,13 +682,19 @@ Specific header arguments directory for code block execution * exports:: Export code and/or results * tangle:: Toggle tangling and specify file name +* mkdirp:: Toggle creation of parent directories of target + files during tangling * comments:: Toggle insertion of comments in tangled code files +* padline:: Control insertion of padding lines in tangled + code files * no-expand:: Turn off variable assignment and noweb expansion during tangling * session:: Preserve the state of code evaluation * noweb:: Toggle expansion of noweb references +* noweb-ref:: Specify block's noweb reference resolution target * cache:: Avoid re-evaluating unchanged code blocks +* sep:: Delimiter for writing tabular results outside Org * hlines:: Handle horizontal lines in tables * colnames:: Handle column names in tables * rownames:: Handle row names in tables @@ -694,6 +713,7 @@ Miscellaneous * Clean view:: Getting rid of leading stars in the outline * TTY keys:: Using Org on a tty * Interaction:: Other Emacs packages +* org-crypt.el:: Encrypting Org files Interaction with other packages @@ -769,7 +789,7 @@ create dynamic @i{agenda views}. Org mode contains the Org Babel environment which allows you to work with embedded source code blocks in a file, to facilitate code evaluation, -documentation, and tangling. +documentation, and literate programming techniques. Org's automatic, context-sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the @@ -803,6 +823,11 @@ version of Org, as well as additional information, frequently asked questions (FAQ), links to tutorials, etc@. This page is located at @uref{http://orgmode.org}. +@cindex print edition +The version 7.3 of this manual is available as a +@uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network +Theory Ltd.} + @page @@ -813,7 +838,9 @@ questions (FAQ), links to tutorials, etc@. This page is located at @b{Important:} @i{If you are using a version of Org that is part of the Emacs distribution or an XEmacs package, please skip this section and go directly -to @ref{Activation}.} +to @ref{Activation}. To see what version of Org (if any) is part of your +Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x +org-version}.} If you have downloaded Org from the Web, either as a distribution @file{.zip} or @file{.tar} file, or as a Git archive, you must take the following steps @@ -852,15 +879,21 @@ make install @end example Installing Info files is system dependent, because of differences in the -@file{install-info} program. In Debian it copies the info files into the -correct directory and modifies the info directory file. In many other -systems, the files need to be copied to the correct directory separately, and -@file{install-info} then only modifies the directory file. Check your system -documentation to find out which of the following commands you need: +@file{install-info} program. The following should correctly install the Info +files on most systems, please send a bug report if not@footnote{The output +from install-info (if any) is also system dependent. In particular Debian +and its derivatives use two different versions of install-info and you may +see the message: + +@example +This is not dpkg install-info anymore, but GNU install-info +See the man page for ginstall-info for command line arguments +@end example + +@noindent which can be safely ignored.}. @example make install-info -make install-info-debian @end example Then add the following line to @file{.emacs}. It is needed so that @@ -880,28 +913,27 @@ Do not forget to activate Org as described in the following section. @cindex global key bindings @cindex key bindings, global -Add the following lines to your @file{.emacs} file. The last three lines -define @emph{global} keys for the commands @command{org-store-link}, -@command{org-agenda}, and @command{org-iswitchb}---please choose suitable -keys yourself. - +To make sure files with extension @file{.org} use Org mode, add the following +line to your @file{.emacs} file. @lisp -;; The following lines are always needed. Choose your own keys. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) +@end lisp +@noindent Org mode buffers need font-lock to be turned on - this is the +default in Emacs@footnote{If you don't use font-lock globally, turn it on in +Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}. + +The four Org commands @command{org-store-link}, @command{org-capture}, +@command{org-agenda}, and @command{org-iswitchb} should be accessible through +global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are +suggested bindings for these keys, please modify the keys to your own +liking. +@lisp (global-set-key "\C-cl" 'org-store-link) +(global-set-key "\C-cc" 'org-capture) (global-set-key "\C-ca" 'org-agenda) (global-set-key "\C-cb" 'org-iswitchb) @end lisp -Furthermore, you must activate @code{font-lock-mode} in Org -buffers, because significant functionality depends on font-locking being -active. You can do this with either one of the following two lines -(XEmacs users must use the second option): -@lisp -(global-font-lock-mode 1) ; for all buffers -(add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only -@end lisp - @cindex Org-mode, turning on With this setup, all files with extension @samp{.org} will be put into Org-mode. As an alternative, make the first line of a file look @@ -1183,6 +1215,8 @@ but without affecting visibility in that buffer.}. With a numeric prefix argument N, go up to level N and then take that tree. If N is negative then go up that many levels. With a @kbd{C-u} prefix, do not remove the previously used indirect buffer. +@orgcmd{C-c C-x v,org-copy-visible} +Copy the @i{visible} text in the region into the kill ring. @end table @vindex org-startup-folded @@ -1192,7 +1226,7 @@ the previously used indirect buffer. @cindex @code{showeverything}, STARTUP keyword When Emacs first visits an Org file, the global state is set to -OVERVIEW, i.e. only the top level headlines are visible. This can be +OVERVIEW, i.e.@: only the top level headlines are visible. This can be configured through the variable @code{org-startup-folded}, or on a per-file basis by adding one of the following lines anywhere in the buffer: @@ -1212,7 +1246,7 @@ for this property are @code{folded}, @code{children}, @code{content}, and @code{all}. @table @asis @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} -Switch back to the startup visibility of the buffer, i.e. whatever is +Switch back to the startup visibility of the buffer, i.e.@: whatever is requested by startup options and @samp{VISIBILITY} properties in individual entries. @end table @@ -1273,19 +1307,17 @@ See also the variable @code{org-goto-interface}. @table @asis @orgcmd{M-@key{RET},org-insert-heading} @vindex org-M-RET-may-split-line -Insert new heading with same level as current. If the cursor is in a -plain list item, a new item is created (@pxref{Plain lists}). To force -creation of a new headline, use a prefix argument, or first press @key{RET} -to get to the beginning of the next line. When this command is used in -the middle of a line, the line is split and the rest of the line becomes -the new headline@footnote{If you do not want the line to be split, -customize the variable @code{org-M-RET-may-split-line}.}. If the -command is used at the beginning of a headline, the new headline is -created before the current line. If at the beginning of any other line, -the content of that line is made the new heading. If the command is -used at the end of a folded subtree (i.e. behind the ellipses at the end -of a headline), then a headline like the current one will be inserted -after the end of the subtree. +Insert new heading with same level as current. If the cursor is in a plain +list item, a new item is created (@pxref{Plain lists}). To force creation of +a new headline, use a prefix argument. When this command is used in the +middle of a line, the line is split and the rest of the line becomes the new +headline@footnote{If you do not want the line to be split, customize the +variable @code{org-M-RET-may-split-line}.}. If the command is used at the +beginning of a headline, the new headline is created before the current line. +If at the beginning of any other line, the content of that line is made the +new heading. If the command is used at the end of a folded subtree (i.e.@: +behind the ellipses at the end of a headline), then a headline like the +current one will be inserted after the end of the subtree. @orgcmd{C-@key{RET},org-insert-heading-respect-content} Just like @kbd{M-@key{RET}}, except when adding a new heading below the current heading, the new heading is placed after the body instead of before @@ -1317,7 +1349,7 @@ level). @orgcmd{M-S-@key{down},org-move-subtree-down} Move subtree down (swap with next subtree of same level). @orgcmd{C-c C-x C-w,org-cut-subtree} -Kill subtree, i.e. remove it from buffer but save in kill ring. +Kill subtree, i.e.@: remove it from buffer but save in kill ring. With a numeric prefix argument N, kill N sequential subtrees. @orgcmd{C-c C-x M-w,org-copy-subtree} Copy subtree to kill ring. With a numeric prefix argument N, copy the N @@ -1362,6 +1394,8 @@ sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate entries will also be removed. @orgcmd{C-x n s,org-narrow-to-subtree} Narrow buffer to current subtree. +@orgcmd{C-x n b,org-narrow-to-block} +Narrow buffer to current block. @orgcmd{C-x n w,widen} Widen buffer to remove narrowing. @orgcmd{C-c *,org-toggle-heading} @@ -1413,7 +1447,7 @@ commands can be accessed through a dispatcher: This prompts for an extra key to select a sparse-tree creating command. @orgcmd{C-c / r,org-occur} @vindex org-remove-highlights-with-change -Occur. Prompts for a regexp and shows a sparse tree with all matches. If +Prompts for a regexp and shows a sparse tree with all matches. If the match is in a headline, the headline is made visible. If the match is in the body of an entry, headline and body are made visible. In order to provide minimal context, also the full hierarchy of headlines above the match @@ -1423,8 +1457,13 @@ editing command@footnote{This depends on the option @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}. When called with a @kbd{C-u} prefix argument, previous highlights are kept, so several calls to this command can be stacked. +@orgcmdkkc{M-g n,M-g M-n,next-error} +Jump to the next sparse tree match in this buffer. +@orgcmdkkc{M-g p,M-g M-p,previous-error} +Jump to the previous sparse tree match in this buffer. @end table + @noindent @vindex org-agenda-custom-commands For frequently used sparse trees of specific search strings, you can @@ -1472,44 +1511,47 @@ Org knows ordered lists, unordered lists, and description lists. @emph{Unordered} list items start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or they will be seen as top-level headlines. Also, when you are hiding leading -stars to get a clean outline view, plain list items starting with a star are -visually indistinguishable from true headlines. In short: even though -@samp{*} is supported, it may be better to not use it for plain list items.} -as bullets. +stars to get a clean outline view, plain list items starting with a star may +be hard to distinguish from true headlines. In short: even though @samp{*} +is supported, it may be better to not use it for plain list items.} as +bullets. @item @vindex org-plain-list-ordered-item-terminator +@vindex org-alphabetical-lists @emph{Ordered} list items start with a numeral followed by either a period or a right parenthesis@footnote{You can filter out any of them by configuring @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or -@samp{1)}. If you want a list to start with a different value (e.g. 20), start -the text of the item with @code{[@@20]}@footnote{If there's a checkbox in the -item, the cookie must be put @emph{before} the checkbox.}. Those constructs -can be used in any item of the list in order to enforce a particular -numbering. +@samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and +@samp{A)} by configuring @code{org-alphabetical-lists}. To minimize +confusion with normal text, those are limited to one character only. Beyond +that limit, bullets will automatically fallback to numbers.}. If you want a +list to start with a different value (e.g.@: 20), start the text of the item +with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie +must be put @emph{before} the checkbox. If you have activated alphabetical +lists, you can also use counters like @code{[@@b]}.}. Those constructs can +be used in any item of the list in order to enforce a particular numbering. @item @emph{Description} list items are unordered list items, and contain the -separator @samp{ :: } to separate the description @emph{term} from the +separator @samp{ :: } to distinguish the description @emph{term} from the description. @end itemize Items belonging to the same list must have the same indentation on the first line. In particular, if an ordered list reaches number @samp{10.}, then the 2--digit numbers must be written left-aligned with the other numbers in the -list. +list. An item ends before the next line that is less or equally indented +than its bullet/number. @vindex org-list-ending-method @vindex org-list-end-regexp @vindex org-empty-line-terminates-plain-lists Two methods@footnote{To disable either of them, configure @code{org-list-ending-method}.} are provided to terminate lists. A list ends -before the next line that is indented like the bullet/number or less, or it -ends before two blank lines@footnote{See also -@code{org-empty-line-terminates-plain-lists}.}. In both cases, all levels of -the list are closed@footnote{So you cannot have a sublist, some text and then -another sublist while still in the same top-level list item. This used to be -possible, but it was only supported in the HTML exporter and difficult to -manage with automatic indentation.}. For finer control, you can end lists -with any pattern set in @code{org-list-end-regexp}. Here is an example: +whenever every item has ended, which means before any line less or equally +indented than items at top level. It also ends before two blank +lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In +that case, all items are closed. For finer control, you can end lists with +any pattern set in @code{org-list-end-regexp}. Here is an example: @example @group @@ -1520,8 +1562,8 @@ with any pattern set in @code{org-list-end-regexp}. Here is an example: + this was already my favorite scene in the book + I really like Miranda Otto. 3. Peter Jackson being shot by Legolas - He makes a really funny face when it happens. - on DVD only + He makes a really funny face when it happens. But in the end, no individual scenes matter but the film as a whole. Important actors in this film are: - @b{Elijah Wood} :: He plays Frodo @@ -1536,13 +1578,15 @@ XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on, put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them properly (@pxref{Exporting}). Since indentation is what governs the structure of these lists, many structural constructs like @code{#+BEGIN_...} -blocks can be indented to signal that they should be considered as a list -item. +blocks can be indented to signal that they belong to a particular item. @vindex org-list-demote-modify-bullet +@vindex org-list-indent-offset If you find that using a different bullet for a sub-list (than that used for the current list-level) improves readability, customize the variable -@code{org-list-demote-modify-bullet}. +@code{org-list-demote-modify-bullet}. To get a greater difference of +indentation between items and theirs sub-items, customize +@code{org-list-indent-offset}. @vindex org-list-automatic-rules The following commands act on items when the cursor is in the first line of @@ -1566,16 +1610,11 @@ headlines, however; the hierarchies remain completely separated. @vindex org-list-automatic-rules Insert new item at current level. With a prefix argument, force a new heading (@pxref{Structure editing}). If this command is used in the middle -of a line, the line is @emph{split} and the rest of the line becomes the new -item@footnote{If you do not want the line to be split, customize the variable -@code{org-M-RET-may-split-line}.}. If this command is executed @emph{before -an item's body}, the new item is created @emph{before} the current item. If the -command is executed in the white space before the text that is part of an -item but does not contain the bullet, a bullet is added to the current line. - -As a new item cannot be inserted in a structural construct (like an example -or source code block) within a list, Org will instead insert it right before -the structure, or return an error. +of an item, that item is @emph{split} in two, and the second part becomes the +new item@footnote{If you do not want the item to be split, customize the +variable @code{org-M-RET-may-split-line}.}. If this command is executed +@emph{before item's body}, the new item is created @emph{before} the current +one. @kindex M-S-@key{RET} @item M-S-@key{RET} Insert a new item with a checkbox (@pxref{Checkboxes}). @@ -1589,17 +1628,21 @@ position. @itemx S-@key{down} @cindex shift-selection-mode @vindex org-support-shift-select -Jump to the previous/next item in the current list, but only if +@vindex org-list-use-circular-motion +Jump to the previous/next item in the current list@footnote{If you want to +cycle around items that way, you may customize +@code{org-list-use-circular-motion}.}, but only if @code{org-support-shift-select} is off. If not, you can still use paragraph jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite similar effect. -@kindex M-S-@key{up} -@kindex M-S-@key{down} -@item M-S-@key{up} -@itemx M-S-@key{down} -Move the item including subitems up/down (swap with previous/next item -of same indentation). If the list is ordered, renumbering is -automatic. +@kindex M-@key{up} +@kindex M-@key{down} +@item M-@key{up} +@itemx M-@key{down} +Move the item including subitems up/down@footnote{See +@code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with +previous/next item of same indentation). If the list is ordered, renumbering +is automatic. @kindex M-@key{left} @kindex M-@key{right} @item M-@key{left} @@ -1623,9 +1666,8 @@ influence on the text @emph{after} the list. @kindex C-c C-c @item C-c C-c If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the -state of the checkbox. Also, makes sure that all the -items on this list level use the same bullet and that the numbering of list -items (if applicable) is correct. +state of the checkbox. In any case, verify bullets and indentation +consistency in the whole list. @kindex C-c - @vindex org-plain-list-ordered-item-terminator @vindex org-list-automatic-rules @@ -1636,14 +1678,20 @@ depending on @code{org-plain-list-ordered-item-terminator}, the type of list, and its position@footnote{See @code{bullet} rule in @code{org-list-automatic-rules} for more information.}. With a numeric prefix argument N, select the Nth bullet from this list. If there is an -active region when calling this, all lines will be converted to list items. -If the first line already was a list item, any item markers will be removed -from the list. Finally, even without an active region, a normal line will be +active region when calling this, selected text will be changed into an item. +With a prefix argument, all lines will be converted to list items. If the +first line already was a list item, any item marker will be removed from the +list. Finally, even without an active region, a normal line will be converted into a list item. @kindex C-c * @item C-c * Turn a plain list item into a headline (so that it becomes a subheading at -its location). @xref{Structure editing}, for a detailed explanation. +its location). @xref{Structure editing}, for a detailed explanation. +@kindex C-c C-* +@item C-c C-* +Turn the whole plain list into a subtree of the current heading. Checkboxes +(@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked +(resp. checked). @kindex S-@key{left} @kindex S-@key{right} @item S-@key{left}/@key{right} @@ -1675,7 +1723,7 @@ look like this: ** This is a headline Still outside the drawer :DRAWERNAME: - This is inside the drawer. + This is inside the drawer. :END: After the drawer. @end example @@ -1721,7 +1769,7 @@ or on a per-file basis by using Org-mode supports the creation of footnotes. In contrast to the @file{footnote.el} package, Org-mode's footnotes are designed for work on a larger document, not only for one-off documents like emails. The basic -syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is +syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is defined in a paragraph that is started by a footnote marker in square brackets in column 0, no indentation allowed. If you need a paragraph break inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference @@ -1798,7 +1846,7 @@ S @r{Short for first @code{r}, then @code{s} action.} n @r{Normalize the footnotes by collecting all definitions (including} @r{inline definitions) into a special section, and then numbering them} @r{in sequence. The references will then also be numbers. This is} - @r{meant to be the final step before finishing a document (e.g. sending} + @r{meant to be the final step before finishing a document (e.g.@: sending} @r{off an email). The exporters do this automatically, and so could} @r{something like @code{message-send-hook}.} d @r{Delete the footnote at point, and all definitions of and references} @@ -1831,11 +1879,11 @@ If you like the intuitive way the Org-mode structure editing and list formatting works, you might want to use these commands in other modes like Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or -turn it on by default, for example in Mail mode, with one of: +turn it on by default, for example in Message mode, with one of: @lisp -(add-hook 'mail-mode-hook 'turn-on-orgstruct) -(add-hook 'mail-mode-hook 'turn-on-orgstruct++) +(add-hook 'message-mode-hook 'turn-on-orgstruct) +(add-hook 'message-mode-hook 'turn-on-orgstruct++) @end lisp When this mode is active and the cursor is on a line that looks to Org like a @@ -1875,10 +1923,11 @@ calculator). @section The built-in table editor @cindex table editor, built-in -Org makes it easy to format tables in plain ASCII. Any line with -@samp{|} as the first non-whitespace character is considered part of a -table. @samp{|} is also the column separator. A table might look like -this: +Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as +the first non-whitespace character is considered part of a table. @samp{|} +is also the column separator@footnote{To insert a vertical bar into a table +field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table +might look like this: @example | Name | Phone | Age | @@ -1919,7 +1968,7 @@ unpredictable for you, configure the variables @table @kbd @tsubheading{Creation and conversion} @orgcmd{C-c |,org-table-create-or-convert-from-region} -Convert the active region to table. If every line contains at least one +Convert the active region to table. If every line contains at least one TAB character, the function assumes that the material is tab separated. If every line contains a comma, comma-separated values (CSV) are assumed. If not, lines are split at whitespace into fields. You can use a prefix @@ -1928,7 +1977,7 @@ C-u} forces TAB, and a numeric argument N indicates that at least N consecutive spaces, or alternatively a TAB will be the separator. @* If there is no active region, this command creates an empty Org -table. But it's easier just to start typing, like +table. But it is easier just to start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. @tsubheading{Re-aligning and field motion} @@ -2043,7 +2092,10 @@ increment. This key is also used by shift-selection and related modes Edit the current field in a separate window. This is useful for fields that are not fully visible (@pxref{Column width and alignment}). When called with a @kbd{C-u} prefix, just make the full field visible, so that it can be -edited in place. +edited in place. When called with two @kbd{C-u} prefixes, make the editor +window follow the cursor through the table and always show the current +field. The follow mode exits automatically when the cursor leaves the table, +or when you repeat this command with @kbd{C-u C-u C-c `}. @c @item M-x org-table-import Import a file as a table. The table should be TAB or whitespace @@ -2187,10 +2239,10 @@ If you like the intuitive way the Org table editor works, you might also want to use it in other modes like Text mode or Mail mode. The minor mode Orgtbl mode makes this possible. You can always toggle the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for -example in mail mode, use +example in Message mode, use @lisp -(add-hook 'mail-mode-hook 'turn-on-orgtbl) +(add-hook 'message-mode-hook 'turn-on-orgtbl) @end lisp Furthermore, with some special setup, it is possible to maintain tables @@ -2219,7 +2271,8 @@ formula, moving these references by arrow keys * References:: How to refer to another field or range * Formula syntax for Calc:: Using Calc to compute stuff * Formula syntax for Lisp:: Writing formulas in Emacs Lisp -* Field formulas:: Formulas valid for a single field +* Durations and time values:: How to compute durations and time values +* Field and range formulas:: Formula for specific (ranges of) fields * Column formulas:: Formulas valid for an entire column * Editing and debugging formulas:: Fixing formulas * Updating the table:: Recomputing all dependent fields @@ -2243,35 +2296,42 @@ field, or press @kbd{C-c @}} to toggle the display of a grid. Formulas can reference the value of another field in two ways. Like in any other spreadsheet, you may reference fields with a letter/number combination like @code{B3}, meaning the 2nd field in the 3rd row. -@c Such references are always fixed to that field, they don't change -@c when you copy and paste a formula to a different field. So -@c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. - -@noindent -Org also uses another, more general operator that looks like this: +@vindex org-table-use-standard-references +However, Org prefers@footnote{Org will understand references typed by the +user as @samp{B4}, but it will not use this syntax when offering a formula +for editing. You can customize this behavior using the variable +@code{org-table-use-standard-references}.} to use another, more general +representation that looks like this: @example @@@var{row}$@var{column} @end example -@noindent -Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}}, -or relative to the current column like @samp{+1} or @samp{-2}. - -The row specification only counts data lines and ignores horizontal -separator lines (hlines). You can use absolute row numbers -@samp{1}...@samp{@var{N}}, and row numbers relative to the current row like -@samp{+3} or @samp{-1}. Or specify the row relative to one of the -hlines: @samp{I} refers to the first hline@footnote{Note that only -hlines are counted that @emph{separate} table lines. If the table -starts with a hline above the header, it does not count.}, @samp{II} to -the second, etc@. @samp{-I} refers to the first such line above the -current line, @samp{+I} to the first such line below the current line. -You can also write @samp{III+2} which is the second data line after the -third hline in the table. - -@samp{0} refers to the current row and column. Also, if you omit -either the column or the row part of the reference, the current -row/column is implied. +Column specifications can be absolute like @code{$1}, +@code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the +column of the field which is being computed) like @code{$+1} or @code{$-2}. +@code{$<} and @code{$>} are immutable references to the first and last +column, respectively, and you can use @code{$>>>} to indicate the third +column from the right. + +The row specification only counts data lines and ignores horizontal separator +lines (hlines). Like with columns, you can use absolute row numbers +@code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the +current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are +immutable references the first and last@footnote{For backward compatibility +you can also use special names like @code{$LR5} and @code{$LR12} to refer in +a stable way to the 5th and 12th field in the last row of the table. +However, this syntax is deprecated, it should not be used for new documents. +Use @code{@@>$} instead.} row in the table, respectively. You may also +specify the row relative to one of the hlines: @code{@@I} refers to the first +hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such +line above the current line, @code{@@+I} to the first such line below the +current line. You can also write @code{@@III+2} which is the second data line +after the third hline in the table. + +@code{@@0} and @code{$0} refer to the current row and column, respectively, +i.e. to the row/column for the field being computed. Also, if you omit +either the column or the row part of the reference, the current row/column is +implied. Org's references with @emph{unsigned} numbers are fixed references in the sense that if you use the same reference in the formula for two @@ -2280,20 +2340,15 @@ Org's references with @emph{signed} numbers are floating references because the same reference operator can reference different fields depending on the field being calculated by the formula. -As a special case, references like @samp{$LR5} and @samp{$LR12} can be used -to refer in a stable way to the 5th and 12th field in the last row of the -table. - Here are a few examples: @example -@@2$3 @r{2nd row, 3rd column} -C2 @r{same as previous} -$5 @r{column 5 in the current row} -E& @r{same as previous} +@@2$3 @r{2nd row, 3rd column (same as @code{C2})} +$5 @r{column 5 in the current row (same as @code{E&})} @@2 @r{current column, row 2} @@-1$-3 @r{the field one row up, three columns to the left} @@-I$2 @r{field just under hline above current row, column 2} +@@>$5 @r{field in the last row, in column 5} @end example @subsubheading Range references @@ -2308,11 +2363,12 @@ format at least for the first field (i.e the reference must start with @samp{@@} in order to be interpreted correctly). Examples: @example -$1..$3 @r{First three fields in the current row.} -$P..$Q @r{Range, using column names (see under Advanced)} -@@2$1..@@4$3 @r{6 fields between these two fields.} -A2..C4 @r{Same as above.} +$1..$3 @r{first three fields in the current row} +$P..$Q @r{range, using column names (see under Advanced)} +$<<<..$>> @r{start in third column, continue to the one but last} +@@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})} @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} +@@I..II @r{between first and second hline, short for @code{@@I..@@II}} @end example @noindent Range references return a vector of values that can be fed @@ -2339,7 +2395,7 @@ $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into} @end example @noindent For the second example, table FOO must have at least as many rows -as the current table. Inefficient@footnote{The computation time scales as +as the current table. Note that this is inefficient@footnote{The computation time scales as O(N^2) because table FOO is parsed for each field to be copied.} for large number of rows. @@ -2440,7 +2496,6 @@ n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed} D R @r{angle modes: degrees, radians} F S @r{fraction and symbolic modes} N @r{interpret all fields as numbers, use 0 for non-numbers} -T @r{force text interpretation} E @r{keep empty fields in ranges} L @r{literal} @end example @@ -2474,10 +2529,13 @@ taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree} Calc also contains a complete set of logical operations. For example @example -if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} +if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty} @end example -@node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet +Note that you can also use two org-specific flags @code{T} and @code{t} for +durations computations @ref{Durations and time values}. + +@node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet @subsection Emacs Lisp forms as formulas @cindex Lisp forms, as table formulas @@ -2496,7 +2554,7 @@ you provide the @samp{L} flag, all fields will be interpolated literally, without quotes. I.e., if you want a reference to be interpreted as a string by the Lisp form, enclose the reference operator itself in double-quotes, like @code{"$3"}. Ranges are inserted as space-separated fields, so you can -+embed them in list or vector syntax. Here are a few examples---note how the +embed them in list or vector syntax. Here are a few examples---note how the @samp{N} mode is used when we do computations in Lisp: @example @@ -2508,31 +2566,64 @@ like @code{"$3"}. Ranges are inserted as space-separated fields, so you can '(apply '+ '($1..$4));N @end example -@node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet -@subsection Field formulas +@node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet +@subsection Durations and time values +@cindex Duration, computing +@cindex Time, computing +@vindex org-table-duration-custom-format + +If you want to compute time values use the @code{T} flag, either in Calc +formulas or Elisp formulas: + +@example +@group + | Task 1 | Task 2 | Total | + |---------+----------+----------| + | 2:12 | 1:47 | 03:59:00 | + | 3:02:20 | -2:07:00 | 0.92 | + #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t +@end group +@end example + +Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds +are optional. With the @code{T} flag, computed durations will be displayed +as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag, +computed durations will be displayed according to the value of the variable +@code{org-table-duration-custom-format}, which defaults to @code{'hours} and +will display the result as a fraction of hours (see the second formula in the +example above). + +Negative duration values can be manipulated as well, and integers will be +considered as seconds in addition and subtraction. + +@node Field and range formulas, Column formulas, Durations and time values, The spreadsheet +@subsection Field and range formulas @cindex field formula +@cindex range formula @cindex formula, for individual table field +@cindex formula, for range of fields -To assign a formula to a particular field, type it directly into the -field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you -press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in -the field, the formula will be stored as the formula for this field, -evaluated, and the current field replaced with the result. +To assign a formula to a particular field, type it directly into the field, +preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press +@key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field, +the formula will be stored as the formula for this field, evaluated, and the +current field will be replaced with the result. @cindex #+TBLFM -Formulas are stored in a special line starting with @samp{#+TBLFM:} -directly below the table. If you type the equation in the 4th field of -the 3rd data line in the table, the formula will look like -@samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows -with the appropriate commands, @i{absolute references} (but not relative -ones) in stored formulas are modified in order to still reference the -same field. Of course this is not true if you edit the table structure -with normal editing commands---then you must fix the equations yourself. -The left-hand side of a formula may also be a named field (@pxref{Advanced -features}), or a last-row reference like @samp{$LR3}. - -Instead of typing an equation into the field, you may also use the -following command +Formulas are stored in a special line starting with @samp{#+TBLFM:} directly +below the table. If you type the equation in the 4th field of the 3rd data +line in the table, the formula will look like @samp{@@3$4=$1+$2}. When +inserting/deleting/swapping column and rows with the appropriate commands, +@i{absolute references} (but not relative ones) in stored formulas are +modified in order to still reference the same field. To avoid this from +happening, in particular in range references, anchor ranges at the table +borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines +using the @code{@@I} notation. Automatic adaptation of field references does +of cause not happen if you edit the table structure with normal editing +commands---then you must fix the equations yourself. + +Instead of typing an equation into the field, you may also use the following +command @table @kbd @orgcmd{C-u C-c =,org-table-eval-formula} @@ -2541,17 +2632,38 @@ formula with default taken from the @samp{#+TBLFM:} line, applies it to the current field, and stores it. @end table -@node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet +The left-hand side of a formula can also be a special expression in order to +assign the formula to a number of different fields. There is no keyboard +shortcut to enter such range formulas. To add them, use the formula editor +(@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line +directly. + +@table @code +@item $2= +Column formula, valid for the entire column. This is so common that Org +treats these formulas in a special way, see @ref{Column formulas}. +@item @@3= +Row formula, applies to all fields in the specified row. @code{@@>=} means +the last row. +@item @@1$2..@@4$3= +Range formula, applies to all fields in the given rectangular range. This +can also be used to assign a formula to some but not all fields in a row. +@item $name= +Named field, see @ref{Advanced features}. +@end table + +@node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet @subsection Column formulas @cindex column formula @cindex formula, for table column -Often in a table, the same formula should be used for all fields in a -particular column. Instead of having to copy the formula to all fields -in that column, Org allows you to assign a single formula to an entire -column. If the table contains horizontal separator hlines, everything -before the first such line is considered part of the table @emph{header} -and will not be modified by column formulas. +When you assign a formula to a simple column reference like @code{$3=}, the +same formula will be used in all fields of that column, with the following +very convenient exceptions: (i) If the table contains horizontal separator +hlines, everything before the first such line is considered part of the table +@emph{header} and will not be modified by column formulas. (ii) Fields that +already get a value from a field/range formula will be left alone by column +formulas. These conditions make column formulas very easy to use. To assign a formula to a column, type it directly into any field in the column, preceded by an equal sign, like @samp{=$1+$2}. When you press @@ -2560,9 +2672,9 @@ the formula will be stored as the formula for the current column, evaluated and the current field replaced with the result. If the field contains only @samp{=}, the previously stored formula for this column is used. For each column, Org will only remember the most recently used formula. In the -@samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand -side of a column formula cannot currently be the name of column, it -must be the numeric column reference. +@samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The +left-hand side of a column formula can not be the name of column, it must be +the numeric column reference or @code{$>}. Instead of typing an equation into the field, you may also use the following command: @@ -2572,7 +2684,7 @@ following command: Install a new formula for the current column and replace current field with the result of the formula. The command prompts for a formula, with default taken from the @samp{#+TBLFM} line, applies it to the current field and -stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command +stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command will apply it to that many consecutive fields in the current column. @end table @@ -2593,7 +2705,7 @@ if possible. If you prefer to only work with the internal format (like @table @kbd @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula} Edit the formula associated with the current column/field in the -minibuffer. See @ref{Column formulas}, and @ref{Field formulas}. +minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}. @orgcmd{C-u C-u C-c =,org-table-eval-formula} Re-insert the active formula (either a field formula, or a column formula) into the current field, so that you @@ -2696,7 +2808,7 @@ following commands: @table @kbd @orgcmd{C-c *,org-table-recalculate} Recalculate the current row by first applying the stored column formulas -from left to right, and all field formulas in the current row. +from left to right, and all field/range formulas in the current row. @c @kindex C-u C-c * @item C-u C-c * @@ -2724,6 +2836,7 @@ dependencies. If you want the recalculation of fields to happen automatically, or if you want to be able to assign @i{names} to fields and columns, you need to reserve the first column of the table for special marking characters. + @table @kbd @orgcmd{C-#,org-table-rotate-recalc-marks} Rotate the calculation mark in first column through the states @samp{ }, @@ -2849,7 +2962,7 @@ Further control over the labels, type, content, and appearance of plots can be exercised through the @code{#+PLOT:} lines preceding a table. See below for a complete list of Org-plot options. For more information and examples see the Org-plot tutorial at -@uref{http://orgmode.org/worg/org-tutorials/org-plot.php}. +@uref{http://orgmode.org/worg/org-tutorials/org-plot.html}. @subsubheading Plot Options @@ -2874,7 +2987,7 @@ Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. @item with Specify a @code{with} option to be inserted for every col being plotted -(e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). +(e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). Defaults to @code{lines}. @item file @@ -2976,7 +3089,7 @@ or with a mouse click (@pxref{Handling links}). Links to custom IDs will point to the corresponding headline. The preferred match for a text link is a @i{dedicated target}: the same string in double angular brackets. Targets may be located anywhere; sometimes it is convenient to put them into a -comment line. For example +comment line. For example @example # <<My Target>> @@ -3076,12 +3189,14 @@ gnus:group @r{Gnus group link} gnus:group#id @r{Gnus article link} bbdb:R.*Stallman @r{BBDB link (with regexp)} irc:/irc.com/#emacs/bob @r{IRC link} -info:org:External%20links @r{Info node link (with encoded space)} +info:org#External%20links @r{Info node link (with encoded space)} shell:ls *.org @r{A shell command} elisp:org-agenda @r{Interactive Elisp command} elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} @end example +For customizing Org to add new link types @ref{Adding hyperlink types}. + A link should be enclosed in double brackets and may contain a descriptive text to be displayed instead of the URL (@pxref{Link format}), for example: @@ -3123,7 +3238,9 @@ buffer: @b{Org-mode buffers}@* For Org files, if there is a @samp{<<target>>} at the cursor, the link points to the target. Otherwise it points to the current headline, which will also -be the description. +be the description@footnote{If the headline contains a timestamp, it will be +removed from the link and result in a wrong link -- you should avoid putting +timestamp in the headline.}. @vindex org-link-to-org-use-id @cindex property, CUSTOM_ID @@ -3261,7 +3378,7 @@ variable @code{org-display-internal-link-with-indirect-buffer}}. @cindex @code{inlineimages}, STARTUP keyword @cindex @code{noinlineimages}, STARTUP keyword Toggle the inline display of linked images. Normally this will only inline -images that have no description part in the link, i.e. images that will also +images that have no description part in the link, i.e.@: images that will also be inlined during export. When called with a prefix argument, also display images that do have a link description. You can ask for inline images to be displayed at startup by configuring the variable @@ -3270,7 +3387,7 @@ displayed at startup by configuring the variable @orgcmd{C-c %,org-mark-ring-push} @cindex mark ring Push the current position onto the mark ring, to be able to return -easily. Commands following an internal link do this automatically. +easily. Commands following an internal link do this automatically. @c @orgcmd{C-c &,org-mark-ring-goto} @cindex links, returning to @@ -3288,8 +3405,8 @@ to @kbd{C-n} and @kbd{C-p} @lisp (add-hook 'org-load-hook (lambda () - (define-key 'org-mode-map "\C-n" 'org-next-link) - (define-key 'org-mode-map "\C-p" 'org-previous-link))) + (define-key org-mode-map "\C-n" 'org-next-link) + (define-key org-mode-map "\C-p" 'org-previous-link))) @end lisp @end table @@ -3363,7 +3480,7 @@ can define them in the file with @noindent In-buffer completion (@pxref{Completion}) can be used after @samp{[} to complete link abbreviations. You may also define a function -@code{org-PREFIX-complete-link} that implements special (e.g. completion) +@code{org-PREFIX-complete-link} that implements special (e.g.@: completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -3375,7 +3492,7 @@ not accept any arguments, and return the full link with prefix. File links can contain additional information to make Emacs jump to a particular location in the file when following a link. This can be a line number or a search option after a double@footnote{For backward -compatibility, line numbers can also follow a single colon.} colon. For +compatibility, line numbers can also follow a single colon.} colon. For example, when the command @kbd{C-c l} creates a link (@pxref{Handling links}) to a file, it encodes the words in the current line as a search string that can be used to find this line back later when following the @@ -3517,7 +3634,7 @@ entire buffer, but shows all TODO items (with not-DONE state) and the headings hierarchy above them. With a prefix argument (or by using @kbd{C-c / T}), search for a specific TODO. You will be prompted for the keyword, and you can also give a list of keywords like @code{KWD1|KWD2|...} to list -entries that match any one of these keywords. With numeric prefix argument +entries that match any one of these keywords. With a numeric prefix argument N, show the tree for the Nth keyword in the variable @code{org-todo-keywords}. With two prefix arguments, find all TODO states, both un-done and done. @@ -3688,8 +3805,8 @@ key after each keyword, in parentheses. For example: @end lisp @vindex org-fast-tag-selection-include-todo -If you then press @code{C-c C-t} followed by the selection key, the entry -will be switched to this state. @key{SPC} can be used to remove any TODO +If you then press @kbd{C-c C-t} followed by the selection key, the entry +will be switched to this state. @kbd{SPC} can be used to remove any TODO keyword from an entry.@footnote{Check also the variable @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO state through the tags interface (@pxref{Setting tags}), in case you like to @@ -3796,7 +3913,7 @@ example: * Parent :PROPERTIES: - :ORDERED: t + :ORDERED: t :END: ** TODO a ** TODO b, needs to wait for (a) @@ -3972,7 +4089,7 @@ called ``habits''. A habit has the following properties: You have enabled the @code{habits} module by customizing the variable @code{org-modules}. @item -The habit is a TODO, with a TODO keyword representing an open state. +The habit is a TODO item, with a TODO keyword representing an open state. @item The property @code{STYLE} is set to the value @code{habit}. @item @@ -3986,8 +4103,8 @@ syntax @samp{.+2d/3d}, which says that you want to do the task at least every three days, but at most every two days. @item You must also have state logging for the @code{DONE} state enabled, in order -for historical data to be represented in the consistency graph. If it's not -enabled it's not an error, but the consistency graphs will be largely +for historical data to be represented in the consistency graph. If it is not +enabled it is not an error, but the consistency graphs will be largely meaningless. @end enumerate @@ -4045,7 +4162,7 @@ habits are displayed in the agenda. @table @code @item org-habit-graph-column The buffer column at which the consistency graph should be drawn. This will -overwrite any text in that column, so it's a good idea to keep your habits' +overwrite any text in that column, so it is a good idea to keep your habits' titles brief and to the point. @item org-habit-preceding-days The amount of history, in days before today, to appear in consistency graphs. @@ -4186,7 +4303,7 @@ large number of subtasks (@pxref{Checkboxes}). @vindex org-list-automatic-rules Every item in a plain list@footnote{With the exception of description -lists. But you can allow it by modifying @code{org-list-automatic-rules} +lists. But you can allow it by modifying @code{org-list-automatic-rules} accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting it with the string @samp{[ ]}. This feature is similar to TODO items (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included @@ -4225,7 +4342,7 @@ be placed into a headline or into (the first line of) a plain list item. Each cookie covers checkboxes of direct children structurally below the headline/item on which the cookie appears@footnote{Set the variable @code{org-hierarchical-checkbox-statistics} if you want such cookies to -represent the all checkboxes below the cookie, not just the direct +count all checkboxes below the cookie, not just those belonging to direct children.}. You have to insert the cookie yourself by typing either @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in the examples above. With @samp{[%]} you get information about @@ -4265,9 +4382,8 @@ this headline and the next (so @emph{not} the entire subtree). If there is no active region, just toggle the checkbox at point. @end itemize @orgcmd{M-S-@key{RET},org-insert-todo-heading} -Insert a new item with a checkbox. -This works only if the cursor is already in a plain list item -(@pxref{Plain lists}). +Insert a new item with a checkbox. This works only if the cursor is already +in a plain list item (@pxref{Plain lists}). @orgcmd{C-c C-x o,org-toggle-ordered-property} @vindex org-track-ordered-property-with-tag @cindex property, ORDERED @@ -4283,8 +4399,7 @@ a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when changing TODO states. If you delete boxes/entries or add/change them by -hand, use this command to get things back into sync. Or simply toggle any -entry twice (checkboxes with @kbd{C-c C-c}). +hand, use this command to get things back into sync. @end table @node Tags, Properties and Columns, TODO Items, Top @@ -4386,7 +4501,7 @@ When the cursor is in a headline, this does the same as @kbd{C-c C-q}. @end table @vindex org-tag-alist -Org will support tag insertion based on a @emph{list of tags}. By +Org supports tag insertion based on a @emph{list of tags}. By default this list is constructed dynamically, containing all tags currently used in the buffer. You may also globally specify a hard list of tags with the variable @code{org-tag-alist}. Finally you can set @@ -4498,6 +4613,8 @@ exclusive tags will turn off any other tags from that group. @item @key{TAB} Enter a tag in the minibuffer, even if the tag is not in the predefined list. You will be able to complete on all tags present in the buffer. +You can also add several tags: just separate them with a comma. + @kindex @key{SPC} @item @key{SPC} Clear all tags for this line. @@ -4548,7 +4665,7 @@ Once a system of tags has been set up, it can be used to collect related information into special lists. @table @kbd -@orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree} +@orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree} Create a sparse tree with all headlines matching a tags search. With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. @orgcmd{C-c a m,org-tags-view} @@ -4655,7 +4772,7 @@ Org files. The following commands help to work with properties: @table @kbd -@orgcmd{M-@key{TAB},org-complete} +@orgcmd{M-@key{TAB},pcomplete} After an initial colon in a line, complete property keys. All keys used in the current file will be offered as possible completions. @orgcmd{C-c C-x p,org-set-property} @@ -4686,11 +4803,11 @@ nearest column format definition. @section Special properties @cindex properties, special -Special properties provide an alternative access method to Org-mode -features, like the TODO state or the priority of an entry, discussed in the -previous chapters. This interface exists so that you can include -these states in a column view (@pxref{Column view}), or to use them in -queries. The following property names are special and should not be +Special properties provide an alternative access method to Org-mode features, +like the TODO state or the priority of an entry, discussed in the previous +chapters. This interface exists so that you can include these states in a +column view (@pxref{Column view}), or to use them in queries. The following +property names are special and (except for @code{:CATEGORY:}) should not be used as keys in the properties drawer: @cindex property, special, TODO @@ -4707,6 +4824,7 @@ used as keys in the properties drawer: @cindex property, special, BLOCKED @c guessing that ITEM is needed in this area; also, should this list be sorted? @cindex property, special, ITEM +@cindex property, special, FILE @example TODO @r{The TODO keyword of the entry.} TAGS @r{The tags defined directly in the headline.} @@ -4719,9 +4837,10 @@ CLOSED @r{When was this entry closed?} TIMESTAMP @r{The first keyword-less timestamp in the entry.} TIMESTAMP_IA @r{The first inactive timestamp in the entry.} CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} - @r{must be run first to compute the values.} + @r{must be run first to compute the values in the current buffer.} BLOCKED @r{"t" if task is currently blocked by children or siblings} ITEM @r{The content of the entry.} +FILE @r{The filename the entry is located in.} @end example @node Property searches, Property inheritance, Special properties, Properties and Columns @@ -4886,7 +5005,7 @@ optional. The individual parts have the following meaning: @var{property} @r{The property that should be edited in this column.} @r{Special properties representing meta data are allowed here} @r{as well (@pxref{Special properties})} -@var{title} @r{The header text for the column. If omitted, the property} +@var{title} @r{The header text for the column. If omitted, the property} @r{name is used.} @{@var{summary-type}@} @r{The summary type. If specified, the column values for} @r{parent nodes are computed from the children.} @@ -4912,7 +5031,7 @@ optional. The individual parts have the following meaning: @noindent Be aware that you can only have one summary type for any property you -include. Subsequent columns referencing the same property will all display the +include. Subsequent columns referencing the same property will all display the same summary information. The @code{est+} summary type requires further explanation. It is used for @@ -4923,12 +5042,12 @@ of estimating a particular task will take 5 days, you might estimate it as average at 5.5 days, but the first represents a more predictable delivery. When combining a set of such estimates, simply adding the lows and highs -produces an unrealistically wide result. Instead, @code{est+} adds the +produces an unrealistically wide result. Instead, @code{est+} adds the statistical mean and variance of the sub-tasks, generating a final estimate from the sum. For example, suppose you had ten tasks, each of which was estimated at 0.5 to 2 days of work. Straight addition produces an estimate of 5 to 20 days, representing what to expect if everything goes either -extremely well or extremely poorly. In contrast, @code{est+} estimates the +extremely well or extremely poorly. In contrast, @code{est+} estimates the full job more realistically, at 10-15 days. Here is an example for a complete columns definition, along with allowed @@ -4944,7 +5063,7 @@ values. @noindent The first column, @samp{%25ITEM}, means the first 25 characters of the -item itself, i.e. of the headline. You probably always should start the +item itself, i.e.@: of the headline. You probably always should start the column definition with the @samp{ITEM} specifier. The other specifiers create columns @samp{Owner} with a list of names as allowed values, for @samp{Status} with four different possible values, and for a checkbox @@ -5170,13 +5289,23 @@ following will show up in the agenda every Wednesday: @end example @item Diary-style sexp entries -For more complex date specifications, Org-mode supports using the -special sexp diary entries implemented in the Emacs calendar/diary -package. For example +For more complex date specifications, Org-mode supports using the special +sexp diary entries implemented in the Emacs calendar/diary +package@footnote{When working with the standard diary sexp functions, you +need to be very careful with the order of the arguments. That order depend +evilly on the variable @code{calendar-date-style} (or, for older Emacs +versions, @code{european-calendar-style}). For example, to specify a date +December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or +@code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on +the settings. This has been the source of much confusion. Org-mode users +can resort to special versions of these functions like @code{org-date} or +@code{org-anniversary}. These work just like the corresponding @code{diary-} +functions, but with stable ISO order of arguments (year, month, day) wherever +applicable, independent of the value of @code{calendar-date-style}.}. For example @example * The nerd meeting on every 2nd Thursday of the month - <%%(diary-float t 4 2)> + <%%(org-float t 4 2)> @end example @item Time/Date range @@ -5256,7 +5385,7 @@ like @samp{15:30-16:30}, modifying the first time will also shift the second, shifting the time block with constant length. To change the length, modify the second time. Note that if the cursor is in a headline and not at a timestamp, these same keys modify the priority of an item. -(@pxref{Priorities}). The key bindings also conflict with shift-selection and +(@pxref{Priorities}). The key bindings also conflict with shift-selection and related modes (@pxref{Conflicts}). @c @orgcmd{C-c C-y,org-evaluate-time-range} @@ -5301,20 +5430,20 @@ various inputs will be interpreted, the items filled in by Org-mode are in @b{bold}. @example -3-2-5 --> 2003-02-05 -2/5/3 --> 2003-02-05 -14 --> @b{2006}-@b{06}-14 -12 --> @b{2006}-@b{07}-12 -2/5 --> @b{2007}-02-05 -Fri --> nearest Friday (default date or later) -sep 15 --> @b{2006}-09-15 -feb 15 --> @b{2007}-02-15 -sep 12 9 --> 2009-09-12 -12:45 --> @b{2006}-@b{06}-@b{13} 12:45 -22 sept 0:34 --> @b{2006}-09-22 0:34 -w4 --> ISO week for of the current year @b{2006} -2012 w4 fri --> Friday of ISO week 4 in 2012 -2012-w04-5 --> Same as above +3-2-5 @result{} 2003-02-05 +2/5/3 @result{} 2003-02-05 +14 @result{} @b{2006}-@b{06}-14 +12 @result{} @b{2006}-@b{07}-12 +2/5 @result{} @b{2007}-02-05 +Fri @result{} nearest Friday (default date or later) +sep 15 @result{} @b{2006}-09-15 +feb 15 @result{} @b{2007}-02-15 +sep 12 9 @result{} 2009-09-12 +12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45 +22 sept 0:34 @result{} @b{2006}-09-22 0:34 +w4 @result{} ISO week for of the current year @b{2006} +2012 w4 fri @result{} Friday of ISO week 4 in 2012 +2012-w04-5 @result{} Same as above @end example Furthermore you can specify a relative date by giving, as the @@ -5323,16 +5452,16 @@ letter ([dwmy]) to indicate change in days, weeks, months, or years. With a single plus or minus, the date is always relative to today. With a double plus or minus, it is relative to the default date. If instead of a single letter, you use the abbreviation of day name, the date will be -the Nth such day. E.g. +the Nth such day, e.g.@: @example -+0 --> today -. --> today -+4d --> four days from today -+4 --> same as above -+2w --> two weeks from today -++5 --> five days from default date -+2tue --> second Tuesday from now. ++0 @result{} today +. @result{} today ++4d @result{} four days from today ++4 @result{} same as above ++2w @result{} two weeks from today +++5 @result{} five days from default date ++2tue @result{} second Tuesday from now. @end example @vindex parse-time-months @@ -5341,14 +5470,22 @@ The function understands English month and weekday abbreviations. If you want to use unabbreviated names and/or other languages, configure the variables @code{parse-time-months} and @code{parse-time-weekdays}. +@vindex org-read-date-force-compatible-dates +Not all dates can be represented in a given Emacs implementation. By default +Org mode forces dates into the compatibility range 1970--2037 which works on +all Emacs implementations. If you want to use dates outside of this range, +read the docstring of the variable +@code{org-read-date-force-compatible-dates}. + You can specify a time range by giving start and end times or by giving a -start time and a duration (in HH:MM format). Use `-' or `-@{@}-' as the separator -in the former case and use '+' as the separator in the latter case. E.g. +start time and a duration (in HH:MM format). Use one or two dash(es) as the +separator in the former case and use '+' as the separator in the latter +case, e.g.@: @example -11am-1:15pm --> 11:00-13:15 -11am--1:15pm --> same as above -11am+2:15 --> same as above +11am-1:15pm @result{} 11:00-13:15 +11am--1:15pm @result{} same as above +11am+2:15 @result{} same as above @end example @cindex calendar, for selecting date @@ -5479,7 +5616,7 @@ The headline will be listed under the given date@footnote{It will still be listed on that date after it has been marked DONE. If you don't like this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In addition, a reminder that the scheduled date has passed will be present -in the compilation for @emph{today}, until the entry is marked DONE, i.e. +in the compilation for @emph{today}, until the entry is marked DONE, i.e.@: the task will automatically be forwarded until completed. @example @@ -5502,7 +5639,7 @@ entries. Org-mode will issue early and late warnings based on the assumption that the timestamp represents the @i{nearest instance} of the repeater. However, the use of diary sexp entries like @c -@code{<%%(diary-float t 42)>} +@code{<%%(org-float t 42)>} @c in scheduling and deadline timestamps is limited. Org-mode does not know enough about the internals of each sexp function to issue early and @@ -5517,29 +5654,30 @@ sexp entry matches. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling @subsection Inserting deadlines or schedules -The following commands allow you to quickly insert a deadline or to schedule +The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and +@samp{DEADLINE} dates are inserted on the line right below the headline. Don't put +any text between this line and the headline.} a deadline or to schedule an item: @table @kbd @c @orgcmd{C-c C-d,org-deadline} Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen -in the line directly following the headline. When called with a prefix arg, -an existing deadline will be removed from the entry. Depending on the -variable @code{org-log-redeadline}@footnote{with corresponding +in the line directly following the headline. Any CLOSED timestamp will be +removed. When called with a prefix arg, an existing deadline will be removed +from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline}, and @code{nologredeadline}}, a note will be taken when changing an existing deadline. -@c FIXME Any CLOSED timestamp will be removed.???????? -@c + @orgcmd{C-c C-s,org-schedule} Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will happen in the line directly following the headline. Any CLOSED timestamp will be removed. When called with a prefix argument, remove the scheduling date from the entry. Depending on the variable @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP} -keywords @code{logredeadline}, @code{lognoteredeadline}, and -@code{nologredeadline}}, a note will be taken when changing an existing +keywords @code{logreschedule}, @code{lognotereschedule}, and +@code{nologreschedule}}, a note will be taken when changing an existing scheduling time. @c @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action} @@ -5566,6 +5704,11 @@ Sparse tree for deadlines and scheduled items before a given date. Sparse tree for deadlines and scheduled items after a given date. @end table +Note that @code{org-schedule} and @code{org-deadline} supports +setting the date by indicating a relative time: e.g. +1d will set +the date to the next day after today, and --1w will set the date +to the previous week before any current timestamp. + @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling @subsection Repeated tasks @cindex tasks, repeated @@ -5684,11 +5827,15 @@ what to do with it. @table @kbd @orgcmd{C-c C-x C-i,org-clock-in} @vindex org-clock-into-drawer +@cindex property, LOG_INTO_DRAWER Start the clock on the current item (clock-in). This inserts the CLOCK keyword together with a timestamp. If this is not the first clocking of this item, the multiple CLOCK lines will be wrapped into a @code{:LOGBOOK:} drawer (see also the variable -@code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument, +@code{org-clock-into-drawer}). You can also overrule +the setting of this variable for a subtree by setting a +@code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property. +When called with a @kbd{C-u} prefix argument, select the task from a list of recently clocked tasks. With two @kbd{C-u C-u} prefixes, clock into the task at point and mark it as the default task. The default task will always be available when selecting a clocking task, @@ -5730,6 +5877,9 @@ Update the effort estimate for the current clock task. Recompute the time interval after changing one of the timestamps. This is only necessary if you edit the timestamps directly. If you change them with @kbd{S-@key{cursor}} keys, the update is automatic. +@orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down} +On @code{CLOCK} log lines, increase/decrease both timestamps at the same +time so that duration keeps the same. @orgcmd{C-c C-t,org-todo} Changing the TODO state of an item to DONE automatically stops the clock if it is running in this same item. @@ -5741,12 +5891,12 @@ Jump to the headline of the currently clocked in task. With a @kbd{C-u} prefix arg, select the target task from a list of recently clocked tasks. @orgcmd{C-c C-x C-d,org-clock-display} @vindex org-remove-highlights-with-change -Display time summaries for each subtree in the current buffer. This -puts overlays at the end of each headline, showing the total time -recorded under that heading, including the time of any subheadings. You -can use visibility cycling to study the tree, but the overlays disappear -when you change the buffer (see variable -@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. +Display time summaries for each subtree in the current buffer. This puts +overlays at the end of each headline, showing the total time recorded under +that heading, including the time of any subheadings. You can use visibility +cycling to study the tree, but the overlays disappear when you change the +buffer (see variable @code{org-remove-highlights-with-change}) or press +@kbd{C-c C-c}. @end table The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in @@ -5830,7 +5980,8 @@ be selected: @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} :stepskip0 @r{Do not show steps that have zero time.} :fileskip0 @r{Do not show table sections from files which did not contribute.} -:tags @r{A tags match to select entries that should contribute}. +:tags @r{A tags match to select entries that should contribute. See} + @r{@ref{Matching tags and properties} for the match syntax.} @end example Then there are options which determine the formatting of the table. There @@ -5838,6 +5989,7 @@ options are interpreted by the function @code{org-clocktable-write-default}, but you can specify your own function using the @code{:formatter} parameter. @example :emphasize @r{When @code{t}, emphasize level one and level two items.} +:lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".} :link @r{Link the item headlines in the table to their origins.} :narrow @r{An integer to limit the width of the headline column in} @r{the org table. If you write it like @samp{50!}, then the} @@ -5850,6 +6002,9 @@ but you can specify your own function using the @code{:formatter} parameter. @r{All are overwritten except if there is an explicit @code{:narrow}} :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} +:properties @r{List of properties that should be shown in the table. Each} + @r{property will get its own column.} +:inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.} :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} @r{As a special case, @samp{:formula %} adds a column with % time.} @r{If you do not specify a formula here, any existing formula} @@ -5945,7 +6100,7 @@ If you restart Emacs and clock into any task, Org will notice that you have a dangling clock which was never clocked out from your last session. Using that clock's starting time as the beginning of the unaccounted-for period, Org will ask how you want to resolve that time. The logic and behavior is -identical to dealing with away time due to idleness; it's just happening due +identical to dealing with away time due to idleness; it is just happening due to a recovery event rather than a set amount of idle time. You can also check all the files visited by your Org agenda for dangling @@ -5982,7 +6137,7 @@ together with clock sums (if you want to clock your time). For a specific buffer you can use @example -#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00 +#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM @end example @@ -6061,7 +6216,7 @@ not started at exactly the right moment. @kindex ; Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown -timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else. +timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everwhere else. @code{org-timer-set-timer} prompts the user for a duration and displays a countdown timer in the modeline. @code{org-timer-default-timer} sets the @@ -6083,7 +6238,7 @@ trees to an archive file keeps the system compact and fast. * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds -* Protocols:: External (e.g. Browser) access to Emacs and Org +* Protocols:: External (e.g.@: Browser) access to Emacs and Org * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects @end menu @@ -6138,6 +6293,7 @@ suggestion.} for capturing new material. @orgcmd{C-c c,org-capture} Call the command @code{org-capture}. Note that this keybinding is global and not active by default - you need to install it. If you have templates +@cindex date tree defined @pxref{Capture templates}, it will offer these templates for selection or use a new Org outline node as the default template. It will insert the template into the target file and switch to an indirect buffer @@ -6172,7 +6328,7 @@ prefix commands: @table @kbd @orgkey{C-u C-c c} -Visit the target location of a cpature template. You get to select the +Visit the target location of a capture template. You get to select the template in the usual way. @orgkey{C-u C-u C-c c} Visit the last stored capture item in its buffer. @@ -6220,6 +6376,14 @@ extremely useful for deriving tasks from emails, for example. You fill in the task definition, press @code{C-c C-c} and Org returns you to the same place where you started the capture process. +To define special keys to capture to a particular template without going +through the interactive template selection, you can create your key binding +like this: + +@lisp +(define-key global-map "\C-cx" + (lambda () (interactive) (org-capture nil "x"))) +@end lisp @menu * Template elements:: What is needed for a complete template entry @@ -6230,14 +6394,14 @@ place where you started the capture process. @subsubsection Template elements Now lets look at the elements of a template definition. Each entry in -@code{org-capture-templates} is a list with the following items: +@code{org-capture-templates} is a list with the following items: @table @var @item keys The keys that will select the template, as a string, characters only, for example @code{"a"} for a template to be selected with a single key, or @code{"bt"} for selection with two keys. When using -several keys, keys using the same prefix key must be sequential +several keys, keys using the same prefix key must be sequential in the list and preceded by a 2-element entry explaining the prefix key, for example @example @@ -6254,9 +6418,8 @@ selection. The type of entry, a symbol. Valid values are: @table @code @item entry -An Org-mode node, with a headline. Will be filed as the child of the -target entry or as a top-level entry. The target file should be an Org-mode -file. +An Org-mode node, with a headline. Will be filed as the child of the target +entry or as a top-level entry. The target file should be an Org-mode file. @item item A plain list item, placed in the first plain list at the target location. Again the target file should be an Org file. @@ -6277,7 +6440,8 @@ Specification of where the captured item should be placed. In Org-mode files, targets usually define a node. Entries will become children of this node. Other types will be added to the table or list in the body of this node. Most target specifications contain a file name. If that file name is -the empty string, it defaults to @code{org-default-notes-file}. +the empty string, it defaults to @code{org-default-notes-file}. A file can +also be given as a variable, function, or Emacs Lisp form. Valid values are: @table @code @@ -6342,14 +6506,25 @@ before and after the new item. Default 0, only common other value is 1. @item :clock-in Start the clock in this item. +@item :clock-keep +Keep the clock running when filing the captured entry. + @item :clock-resume If starting the capture interrupted a clock, restart that clock when finished -with the capture. +with the capture. Note that @code{:clock-keep} has precedence over +@code{:clock-resume}. When setting both to @code{t}, the current clock will +run and the previous one will not be resumed. @item :unnarrowed Do not narrow the target buffer, simply show the full buffer. Default is to narrow it so that you only see the new material. +@item :table-line-pos +Specification of the location in the table where the new line should be +inserted. It should be a string like @code{"II-3"} meaning that the new +line should become the third line before the second horizontal separator +line. + @item :kill-buffer If the target file was not yet visited when capture was invoked, kill the buffer again after capture is completed. @@ -6361,37 +6536,39 @@ buffer again after capture is completed. In the template itself, special @kbd{%}-escapes@footnote{If you need one of these sequences literally, escape the @kbd{%} with a backslash.} allow -dynamic insertion of content: +dynamic insertion of content. The templates are expanded in the order given here: -@comment SJE: should these sentences terminate in period? @smallexample -%^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.} - @r{You may specify a default value and a completion table with} - @r{%^@{prompt|default|completion2|completion3...@}} - @r{The arrow keys access a prompt-specific history.} -%a @r{annotation, normally the link created with @code{org-store-link}} -%A @r{like @code{%a}, but prompt for the description part} +%[@var{file}] @r{insert the contents of the file given by @var{file}.} +%(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result.} +%<...> @r{the result of format-time-string on the ... format specification.} +%t @r{timestamp, date only.} +%T @r{timestamp with date and time.} +%u, %U @r{like the above, but inactive timestamps.} +%a @r{annotation, normally the link created with @code{org-store-link}.} %i @r{initial content, the region when capture is called while the} @r{region is active.} @r{The entire text will be indented like @code{%i} itself.} -%t @r{timestamp, date only} -%T @r{timestamp with date and time} -%u, %U @r{like the above, but inactive timestamps} -%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}} - @r{You may define a prompt like @code{%^@{Birthday@}t}} -%n @r{user name (taken from @code{user-full-name})} +%A @r{like @code{%a}, but prompt for the description part.} %c @r{Current kill ring head.} %x @r{Content of the X clipboard.} -%^C @r{Interactive selection of which kill or clip to use.} -%^L @r{Like @code{%^C}, but insert as link.} -%k @r{title of the currently clocked task} -%K @r{link to the currently clocked task} +%k @r{title of the currently clocked task.} +%K @r{link to the currently clocked task.} +%n @r{user name (taken from @code{user-full-name}).} +%f @r{file visited by current buffer when org-capture was called.} +%F @r{full path of the file or directory visited by current buffer.} +%:keyword @r{specific information for certain link types, see below.} %^g @r{prompt for tags, with completion on tags in target file.} %^G @r{prompt for tags, with completion all tags in all agenda files.} -%^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}} -%:keyword @r{specific information for certain link types, see below} -%[@var{file}] @r{insert the contents of the file given by @var{file}} -%(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result} +%^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.} + @r{You may define a prompt like @code{%^@{Birthday@}t}.} +%^C @r{Interactive selection of which kill or clip to use.} +%^L @r{Like @code{%^C}, but insert as link.} +%^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.} +%^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.} + @r{You may specify a default value and a completion table with} + @r{%^@{prompt|default|completion2|completion3...@}.} + @r{The arrow keys access a prompt-specific history.} @end smallexample @noindent @@ -6403,8 +6580,8 @@ similar way.}: @vindex org-from-is-user-regexp @smallexample -Link type | Available keywords --------------------+---------------------------------------------- +Link type | Available keywords +------------------------+---------------------------------------------- bbdb | %:name %:company irc | %:server %:port %:nick vm, wl, mh, mew, rmail | %:type %:subject %:message-id @@ -6482,7 +6659,7 @@ Create a new attachment as an Emacs buffer. Synchronize the current task with its attachment directory, in case you added attachments yourself. -@orgcmdtkc{p,C-c C-a o,org-attach-open} +@orgcmdtkc{o,C-c C-a o,org-attach-open} @vindex org-file-apps Open current task's attachment. If there is more than one, prompt for a file name first. Opening will follow the rules set by @code{org-file-apps}. @@ -6610,7 +6787,7 @@ create new nodes as new parents for refiling on the fly, check the variable @code{org-refile-allow-creating-parent-nodes}. When the variable @code{org-log-refile}@footnote{with corresponding @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile}, -and @code{nologrefile}} is set, a time stamp or a note will be +and @code{nologrefile}} is set, a timestamp or a note will be recorded when an entry has been refiled. @orgkey{C-u C-c C-w} Use the refile interface to jump to a heading. @@ -6835,7 +7012,7 @@ The information to be shown is normally collected from all @emph{agenda files}, the files listed in the variable @code{org-agenda-files}@footnote{If the value of that variable is not a list, but a single file name, then the list of agenda files will be -maintained in that external file.}. If a directory is part of this list, +maintained in that external file.}. If a directory is part of this list, all files with the extension @file{.org} in this directory will be part of the list. @@ -6848,7 +7025,7 @@ the easiest way to maintain it is through the following commands @cindex files, adding to agenda list @table @kbd -@orgcmd{C-c [,org-agenda-to-front} +@orgcmd{C-c [,org-agenda-file-to-front} Add current file to the list of agenda files. The file is added to the front of the list. If it was already in the list, it is moved to the front. With a prefix argument, file is added/moved to the end. @@ -6905,7 +7082,7 @@ Lift the restriction. @cindex agenda dispatcher @cindex dispatching agenda commands The views are created through a dispatcher, which should be bound to a -global key---for example @kbd{C-c a} (@pxref{Installation}). In the +global key---for example @kbd{C-c a} (@pxref{Activation}). In the following we will assume that @kbd{C-c a} is indeed how the dispatcher is accessed and list keyboard access to commands accordingly. After pressing @kbd{C-c a}, an additional letter is required to execute a @@ -7030,7 +7207,7 @@ between calendar and agenda. If you are using the diary only for sexp entries and holidays, it is faster to not use the above setting, but instead to copy or even move -the entries into an Org file. Org-mode evaluates diary-style sexp +the entries into an Org file. Org-mode evaluates diary-style sexp entries, and does it faster because there is no overhead for first creating the diary display. Note that the sexp entries must start at the left margin, no whitespace is allowed before them. For example, @@ -7042,8 +7219,8 @@ will be made in the agenda: #+CATEGORY: Holiday %%(org-calendar-holiday) ; special function for holiday names #+CATEGORY: Ann -%%(diary-anniversary 5 14 1956)@footnote{Note that the order of the arguments (month, day, year) depends on the setting of @code{calendar-date-style}.} Arthur Dent is %d years old -%%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old +%%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is allways according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old +%%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old @end example @subsubheading Anniversaries from BBDB @@ -7066,14 +7243,15 @@ following to one your your agenda files: You can then go ahead and define anniversaries for a BBDB record. Basically, you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB -record and then add the date in the format @code{YYYY-MM-DD}, followed by a -space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or -a format string). If you omit the class, it will default to @samp{birthday}. -Here are a few examples, the header for the file @file{org-bbdb.el} contains -more detailed information. +record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD}, +followed by a space and the class of the anniversary (@samp{birthday} or +@samp{wedding}, or a format string). If you omit the class, it will default to +@samp{birthday}. Here are a few examples, the header for the file +@file{org-bbdb.el} contains more detailed information. @example 1973-06-22 +06-22 1955-08-02 wedding 2008-04-14 %s released version 6.01 of org-mode, %d years ago @end example @@ -7092,7 +7270,7 @@ Org can interact with Emacs appointments notification facility. To add all the appointments of your agenda files, use the command @code{org-agenda-to-appt}. This command also lets you filter through the list of your appointments and add only those belonging to a specific category -or matching a regular expression. See the docstring for details. +or matching a regular expression. See the docstring for details. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views @subsection The global TODO list @@ -7265,7 +7443,7 @@ brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are assumed to be date/time specifications in the standard Org way, and the comparison will be done accordingly. Special values that will be recognized are @code{"<now>"} for now (including time), and @code{"<today>"}, and -@code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time +@code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, respectively, can be used. @@ -7368,6 +7546,7 @@ the files listed in @code{org-agenda-text-search-extra-files}. @node Stuck projects, , Search view, Built-in agenda views @subsection Stuck projects +@pindex GTD, Getting Things Done If you are following a system like David Allen's GTD to organize your work, one of the ``duties'' you have is a regular review to make sure @@ -7418,12 +7597,14 @@ will still be searched for stuck projects. @cindex presentation, of agenda items @vindex org-agenda-prefix-format -Before displaying items in an agenda view, Org-mode visually prepares -the items and sorts them. Each item occupies a single line. The line -starts with a @emph{prefix} that contains the @emph{category} -(@pxref{Categories}) of the item and other important information. You can -customize the prefix using the option @code{org-agenda-prefix-format}. -The prefix is followed by a cleaned-up version of the outline headline +@vindex org-agenda-tags-column +Before displaying items in an agenda view, Org-mode visually prepares the +items and sorts them. Each item occupies a single line. The line starts +with a @emph{prefix} that contains the @emph{category} (@pxref{Categories}) +of the item and other important information. You can customize in which +column tags will be displayed through @code{org-agenda-tags-column}. You can +also customize the prefix using the option @code{org-agenda-prefix-format}. +This prefix is followed by a cleaned-up version of the outline headline associated with the item. @menu @@ -7608,34 +7789,31 @@ will be followed without a selection prompt. @tsubheading{Change display} @cindex display changing, in agenda +@kindex A +@item A +Interactively select another agenda view and append it to the current view. +@c @kindex o @item o Delete other windows. @c -@c @kindex v d -@c @kindex d -@c @kindex v w -@c @kindex w -@c @kindex v m -@c @kindex v y -@c @item v d @ @r{or short} @ d -@c @itemx v w @ @r{or short} @ w -@c @itemx v m -@c @itemx v y @orgcmdkskc{v d,d,org-aganda-day-view} @xorgcmdkskc{v w,w,org-aganda-day-view} @xorgcmd{v m,org-agenda-month-view} @xorgcmd{v y,org-agenda-month-year} -Switch to day/week/month/year view. When switching to day or week view, -this setting becomes the default for subsequent agenda commands. Since -month and year views are slow to create, they do not become the default. -A numeric prefix argument may be used to jump directly to a specific day -of the year, ISO week, month, or year, respectively. For example, -@kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When -setting day, week, or month view, a year may be encoded in the prefix -argument as well. For example, @kbd{200712 w} will jump to week 12 in -2007. If such a year specification has only one or two digits, it will -be mapped to the interval 1938-2037. +@xorgcmd{v SPC,org-agenda-reset-view} +@vindex org-agenda-span +Switch to day/week/month/year view. When switching to day or week view, this +setting becomes the default for subsequent agenda refreshes. Since month and +year views are slow to create, they do not become the default. A numeric +prefix argument may be used to jump directly to a specific day of the year, +ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to +February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or +month view, a year may be encoded in the prefix argument as well. For +example, @kbd{200712 w} will jump to week 12 in 2007. If such a year +specification has only one or two digits, it will be mapped to the interval +1938-2037. @kbd{v @key{SPC}} will reset to what is set in +@code{org-agenda-span}. @c @orgcmd{f,org-agenda-later} Go forward in time to display the following @code{org-agenda-current-span} days. @@ -7688,10 +7866,19 @@ always show a table with the clocked times for the timespan and file scope covered by the current agenda view. The initial setting for this mode in new agenda buffers can be set with the variable @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument -when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show +when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show contributions from entries that are hidden by agenda filtering@footnote{Only tags filtering will be respected here, effort filtering is ignored.}. @c +@orgkey{v c} +@vindex org-agenda-clock-consistency-checks +Show overlapping clock entries, clocking gaps, and other clocking problems in +the current agenda range. You can then visit clocking lines and fix them +manually. See the variable @code{org-agenda-clock-consistency-checks} for +information on how to customize the definition of what constituted a clocking +problem. To return to normal agenda display, press @kbd{l} to exit Logbook +mode. +@c @orgcmdkskc{v E,E,org-agenda-entry-text-mode} @vindex org-agenda-start-with-entry-text-mode @vindex org-agenda-entry-text-maxlines @@ -7707,13 +7894,13 @@ prefix argument will temporarily modify that number to the prefix value. Toggle the time grid on and off. See also the variables @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. @c -@orgcmd{r,org-agenda-rodo} +@orgcmd{r,org-agenda-redo} Recreate the agenda buffer, for example to reflect the changes after modification of the timestamps of items with @kbd{S-@key{left}} and @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix argument is interpreted to create a selective list for a specific TODO keyword. -@orgcmd{g,org-agenda-rodo} +@orgcmd{g,org-agenda-redo} Same as @kbd{r}. @c @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers} @@ -7806,7 +7993,7 @@ Internet, and outside of business hours, with something like this: @end group @end lisp -@orgcmd{\,org-agenda-filter-by-tag-refine} +@orgcmd{\\,org-agenda-filter-by-tag-refine} Narrow the current agenda filter by an additional condition. When called with prefix arg, remove the entries that @emph{do} have the tag, or that do match the effort criterion. You can achieve the same effect by pressing @kbd{+} or @@ -7889,8 +8076,8 @@ agenda, change a tag for all headings in the region. @kindex , @item , Set the priority for the current item (@command{org-agenda-priority}). -Org-mode prompts for the priority character. If you reply with @key{SPC}, the -priority cookie is removed from the entry. +Org-mode prompts for the priority character. If you reply with @key{SPC}, +the priority cookie is removed from the entry. @c @orgcmd{P,org-agenda-show-priority} Display weighted priority of current item. @@ -7971,6 +8158,9 @@ Jump to the running clock in another window. Mark the entry at point for bulk action. With prefix arg, mark that many successive entries. @c +@orgcmd{%,org-agenda-bulk-mark-regexp} +Mark entries matching a regular expression for bulk action. +@c @orgcmd{u,org-agenda-bulk-unmark} Unmark entry for bulk action. @c @@ -7989,15 +8179,30 @@ $ @r{Archive all selected entries.} A @r{Archive entries by moving them to their respective archive siblings.} t @r{Change TODO state. This prompts for a single TODO keyword and} @r{changes the state of all selected entries, bypassing blocking and} - @r{suppressing logging notes (but not time stamps).} + @r{suppressing logging notes (but not timestamps).} + @r{Add a tag to all selected entries.} - @r{Remove a tag from all selected entries.} s @r{Schedule all items to a new date. To shift existing schedule dates} @r{by a fixed number of days, use something starting with double plus} @r{at the prompt, for example @samp{++8d} or @samp{++2w}.} -S @r{Reschedule randomly by N days. N will be prompted for. With prefix} - @r{arg (@kbd{C-u B S}), scatter only accross weekdays.} +S @r{Reschedule randomly into the coming N days. N will be prompted for.} + @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.} d @r{Set deadline to a specific date.} +f @r{Apply a function to marked entries.} + @r{For example, the function below sets the CATEGORY property of the} + @r{entries to web.} + @r{(defun set-category ()} + @r{ (interactive "P")} + @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)} + @r{ (org-agenda-error)))} + @r{ (buffer (marker-buffer marker)))} + @r{ (with-current-buffer buffer} + @r{ (save-excursion} + @r{ (save-restriction} + @r{ (widen)} + @r{ (goto-char marker)} + @r{ (org-back-to-heading t)} + @r{ (org-set-property "CATEGORY" "web"))))))} @end example @@ -8274,7 +8479,7 @@ version of some agenda views to carry around. Org-mode can export custom agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the ghostscript @file{ps2pdf} utility must be installed on the system. Selecting -a PDF file with also create the postscript file.}, and iCalendar files. If +a PDF file will also create the postscript file.}, and iCalendar files. If you want to do this only occasionally, use the command @table @kbd @@ -8430,7 +8635,7 @@ This causes the following issues: Org needs to make a decision which @code{COLUMNS} format to use. Since the entries in the agenda are collected from different files, and different files may have different @code{COLUMNS} formats, this is a non-trivial problem. -Org first checks if the variable @code{org-overriding-columns-format} is +Org first checks if the variable @code{org-agenda-overriding-columns-format} is currently set, and if so, takes the format from there. Otherwise it takes the format associated with the first item in the agenda, or, if that item does not have a specific format (defined in a property, or in its file), it @@ -8579,7 +8784,7 @@ If you still want to have some text before the first headline, use the #+OPTIONS: skip:t #+TEXT: This text will go before the *first* headline. #+TEXT: [TABLE-OF-CONTENTS] -#+TEXT: This goes between the table of contents and the first headline +#+TEXT: This goes between the table of contents and the *first* headline @end example @node Lists, Paragraphs, Initial text, Structural markup elements @@ -8638,9 +8843,9 @@ but not any simpler @cindex footnotes, markup rules @cindex @file{footnote.el} -Footnotes defined in the way described in @ref{Footnotes}, will be exported by -all backends. Org allows multiple references to the same note, and -different backends support this to varying degrees. +Footnotes defined in the way described in @ref{Footnotes}, will be exported +by all backends. Org allows multiple references to the same note, and +multiple footnotes side by side. @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements @subheading Emphasis and monospace @@ -8659,8 +8864,8 @@ syntax; it is exported verbatim. @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements @subheading Horizontal rules @cindex horizontal rules, markup rules -A line consisting of only dashes, and at least 5 of them, will be -exported as a horizontal line (@samp{<hr/>} in HTML). +A line consisting of only dashes, and at least 5 of them, will be exported as +a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}). @node Comment lines, , Horizontal rules, Structural markup elements @subheading Comment lines @@ -8669,7 +8874,7 @@ exported as a horizontal line (@samp{<hr/>} in HTML). @cindex #+BEGIN_COMMENT Lines starting with @samp{#} in column zero are treated as comments and will -never be exported. If you want an indented line to be treated as a comment, +never be exported. If you want an indented line to be treated as a comment, start it with @samp{#+ }. Also entire subtrees starting with the word @samp{COMMENT} will never be exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported. @@ -8701,6 +8906,11 @@ the object with @code{\ref@{tab:basic-data@}}: |-----|----| @end example +Optionally, the caption can take the form: +@example +#+CAPTION: [Caption for list of figures]@{Caption for table (or link).@} +@end example + @cindex inlined images, markup rules Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include images into the exported document. Org does this, if a link to an image @@ -8755,20 +8965,22 @@ look like the fontified Emacs buffer@footnote{This works automatically for the HTML backend (it requires version 1.34 of the @file{htmlize.el} package, which is distributed with Org). Fontified code chunks in LaTeX can be achieved using either the listings or the -@url{http://code.google.com/p/minted, minted,} package. To use listings, turn +@url{http://code.google.com/p/minted, minted,} package. To use listings, turn on the variable @code{org-export-latex-listings} and ensure that the listings -package is included by the LaTeX header (e.g. by configuring -@code{org-export-latex-packages-alist}). See the listings documentation for +package is included by the LaTeX header (e.g.@: by configuring +@code{org-export-latex-packages-alist}). See the listings documentation for configuration options, including obtaining colored output. For minted it is necessary to install the program @url{http://pygments.org, pygments}, in addition to setting @code{org-export-latex-minted}, ensuring that the minted package is included by the LaTeX header, and ensuring that the @code{-shell-escape} option is passed to @file{pdflatex} (see -@code{org-latex-to-pdf-process}). See the documentation of the variables +@code{org-latex-to-pdf-process}). See the documentation of the variables @code{org-export-latex-listings} and @code{org-export-latex-minted} for further details.}. This is done with the @samp{src} block, where you also need to specify the name of the major mode that should be used to fontify the -example: +example@footnote{Code in @samp{src} blocks may also be evaluated either +interactively or on export. See @pxref{Working With Source Code} for more +information on evaluating code blocks.}: @cindex #+BEGIN_SRC @example @@ -8784,7 +8996,7 @@ switch to the end of the @code{BEGIN} line, to get the lines of the example numbered. If you use a @code{+n} switch, the numbering from the previous numbered snippet will be continued in the current one. In literal examples, Org will interpret strings like @samp{(ref:name)} as labels, and use them as -targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name +targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name enclosed in single parenthesis). In HTML, hovering the mouse over such a link will remote-highlight the corresponding code line, which is kind of cool. @@ -8811,8 +9023,12 @@ If the syntax for the label format conflicts with the language syntax, use a @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}. -HTML export also allows examples to be published as text areas, @xref{Text -areas in HTML export}. +HTML export also allows examples to be published as text areas (@pxref{Text +areas in HTML export}). + +Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added +so often, shortcuts are provided using the Easy Templates facility +(@pxref{Easy Templates}). @table @kbd @kindex C-c ' @@ -8851,7 +9067,7 @@ include your @file{.emacs} file, you could use: #+INCLUDE: "~/.emacs" src emacs-lisp @end example @noindent -The optional second and third parameter are the markup (e.g. @samp{quote}, +The optional second and third parameter are the markup (e.g.@: @samp{quote}, @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the language for formatting the contents. The markup is optional; if it is not given, the text will be assumed to be in Org-mode format and will be @@ -8866,6 +9082,17 @@ use #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " @end example +You can also include a portion of a file by specifying a lines range using +the @code{:lines} parameter. The line at the upper end of the range will not +be included. The start and/or the end of the range may be omitted to use the +obvious defaults. + +@example +#+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded} +#+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded} +#+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF} +@end example + @table @kbd @kindex C-c ' @item C-c ' @@ -8925,7 +9152,7 @@ include scientific notes, which often require mathematical symbols and the occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on Donald E. Knuth's @TeX{} system. Many of the features described here as ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this -distinction.} is widely used to typeset scientific documents. Org-mode +distinction.} is widely used to typeset scientific documents. Org-mode supports embedding @LaTeX{} code into its files, because many academics are used to writing and reading @LaTeX{} source code, and because it can be readily processed to produce pretty output for a number of export backends. @@ -9038,7 +9265,7 @@ this regularly or on pages with significant page views, you should install @file{MathJax} on your own server in order to limit the load of our server.}. Finally, it can also process the mathematical expressions into images@footnote{For this to work -you need to be on a system with a working @LaTeX{} installation. You also +you need to be on a system with a working @LaTeX{} installation. You also need the @file{dvipng} program, available at @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will be used when processing a fragment can be configured with the variable @@ -9118,7 +9345,7 @@ Remove the overlay preview images. @vindex org-format-latex-options You can customize the variable @code{org-format-latex-options} to influence -some aspects of the preview. In particular, the @code{:scale} (and for HTML +some aspects of the preview. In particular, the @code{:scale} (and for HTML export, @code{:html-scale}) property can be used to adjust the size of the preview images. @@ -9191,14 +9418,16 @@ Org-mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable and simple version of an Org file. HTML export allows you to publish a notes file on the web, while the XOXO format provides a solid base for exchange with a -broad range of other applications. @LaTeX{} export lets you use Org-mode and +broad range of other applications. @LaTeX{} export lets you use Org-mode and its structured editing functions to easily create @LaTeX{} files. DocBook export makes it possible to convert Org files to many other formats using -DocBook tools. For project management you can create gantt and resource -charts by using TaskJuggler export. To incorporate entries with associated -times like deadlines or appointments into a desktop calendar program like -iCal, Org-mode can also produce extracts in the iCalendar format. Currently -Org-mode only supports export, not import of these different formats. +DocBook tools. OpenDocumentText export allows seamless colloboration across +organizational boundaries. For project management you can create gantt and +resource charts by using TaskJuggler export. To incorporate entries with +associated times like deadlines or appointments into a desktop calendar +program like iCal, Org-mode can also produce extracts in the iCalendar +format. Currently Org-mode only supports export, not import of these +different formats. Org supports export of selected regions when @code{transient-mark-mode} is enabled (default in Emacs 23). @@ -9211,6 +9440,7 @@ enabled (default in Emacs 23). * HTML export:: Exporting to HTML * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF * DocBook export:: Exporting to DocBook +* OpenDocumentText export:: Exporting to OpenDocumentText * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps * XOXO export:: Exporting to XOXO @@ -9219,26 +9449,34 @@ enabled (default in Emacs 23). @node Selective export, Export options, Exporting, Exporting @section Selective export -@cindex export, selective by tags +@cindex export, selective by tags or TODO keyword @vindex org-export-select-tags @vindex org-export-exclude-tags +@cindex org-export-with-tasks You may use tags to select the parts of a document that should be exported, or to exclude parts from export. This behavior is governed by two variables: @code{org-export-select-tags} and @code{org-export-exclude-tags}. -Org first checks if any of the @emph{select} tags is present in the buffer. -If yes, all trees that do not carry one of these tags will be excluded. If a -selected tree is a subtree, the heading hierarchy above it will also be -selected for export, but not the text below those headings. +@enumerate +@item +Org first checks if any of the @emph{select} tags is present in the +buffer. If yes, all trees that do not carry one of these tags will be +excluded. If a selected tree is a subtree, the heading hierarchy above it +will also be selected for export, but not the text below those headings. -@noindent +@item If none of the select tags is found, the whole buffer will be selected for export. -@noindent +@item Finally, all subtrees that are marked by any of the @emph{exclude} tags will be removed from the export buffer. +@end enumerate + +The variable @code{org-export-with-tasks} can be configured to select which +kind of tasks should be included for export. See the docstring of the +variable for more information. @node Export options, The export dispatcher, Selective export, Exporting @section Export options @@ -9284,13 +9522,13 @@ Insert template with export options, see example below. #+AUTHOR: the author (default taken from @code{user-full-name}) #+DATE: a date, fixed, or a format string for @code{format-time-string} #+EMAIL: his/her email address (default from @code{user-mail-address}) -#+DESCRIPTION: the page description, e.g. for the XHTML meta tag -#+KEYWORDS: the page keywords, e.g. for the XHTML meta tag -#+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) +#+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag +#+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag +#+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language}) #+TEXT: Some descriptive text to be inserted at the beginning. #+TEXT: Several lines may be given. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... -#+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize +#+BIND: lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize @r{You need to confirm using these, or configure @code{org-export-allow-BIND}} #+LINK_UP: the ``up'' link of an exported page #+LINK_HOME: the ``home'' link of an exported page @@ -9319,6 +9557,11 @@ settings. Here you can: @cindex @LaTeX{} fragments @cindex author info, in export @cindex time info, in export +@vindex org-export-plist-vars +@vindex org-export-author-info +@vindex org-export-creator-info +@vindex org-export-email-info +@vindex org-export-time-stamp-file @example H: @r{set the number of headline levels for export} num: @r{turn on/off section-numbers} @@ -9333,6 +9576,8 @@ toc: @r{turn on/off table of contents, or set level limit (integer)} -: @r{turn on/off conversion of special strings.} f: @r{turn on/off footnotes like this[1].} todo: @r{turn on/off inclusion of TODO keywords into exported text} +tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove} + @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep} pri: @r{turn on/off priority cookies} tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}} <: @r{turn on/off inclusion of any time/date stamps like DEADLINES} @@ -9348,11 +9593,13 @@ d: @r{turn on/off inclusion of drawers} @end example @noindent These options take effect in both the HTML and @LaTeX{} export, except for -@code{TeX} and @code{LaTeX}, which are respectively @code{t} and @code{nil} -for the @LaTeX{} export. The default values for these and many other options -are given by a set of variables. For a list of such variables, the -corresponding OPTIONS keys and also the publishing keys (@pxref{Project -alist}), see the constant @code{org-export-plist-vars}. +@code{TeX} and @code{LaTeX} options, which are respectively @code{t} and +@code{nil} for the @LaTeX{} export. + +The default values for these and many other options are given by a set of +variables. For a list of such variables, the corresponding OPTIONS keys and +also the publishing keys (@pxref{Project alist}), see the constant +@code{org-export-plist-vars}. When exporting only a single subtree by selecting it with @kbd{C-c @@} before calling an export command, the subtree can overrule some of the file's export @@ -9381,11 +9628,11 @@ separate Emacs process@footnote{To make this behavior the default, customize the variable @code{org-export-run-in-background}.}. @orgcmd{C-c C-e v,org-export-visible} Like @kbd{C-c C-e}, but only export the text that is currently visible -(i.e. not hidden by outline visibility). +(i.e.@: not hidden by outline visibility). @orgcmd{C-u C-u C-c C-e,org-export} @vindex org-export-run-in-background Call the exporter, but reverse the setting of -@code{org-export-run-in-background}, i.e. request background processing if +@code{org-export-run-in-background}, i.e.@: request background processing if not set, or force processing in the current Emacs process if set. @end table @@ -9409,7 +9656,7 @@ Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file will be @file{myfile.txt}. The file will be overwritten without warning. If there is an active region@footnote{This requires @code{transient-mark-mode} be turned on.}, only the region will be -exported. If the selected region is a single tree@footnote{To select the +exported. If the selected region is a single tree@footnote{To select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the @@ -9460,6 +9707,7 @@ language, but with additional support for tables. @menu * HTML Export commands:: How to invoke HTML export +* HTML preamble and postamble:: How to insert a preamble and a postamble * Quoting HTML tags:: Using direct HTML in Org-mode * Links in HTML export:: How links will be interpreted and formatted * Tables in HTML export:: How to modify the formatting of tables @@ -9470,7 +9718,7 @@ language, but with additional support for tables. * JavaScript support:: Info and Folding in a web browser @end menu -@node HTML Export commands, Quoting HTML tags, HTML export, HTML export +@node HTML Export commands, HTML preamble and postamble, HTML export, HTML export @subsection HTML export commands @cindex region, active @@ -9479,11 +9727,11 @@ language, but with additional support for tables. @table @kbd @orgcmd{C-c C-e h,org-export-as-html} @cindex property, EXPORT_FILE_NAME -Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org}, -the ASCII file will be @file{myfile.html}. The file will be overwritten +Export as HTML file. For an Org file @file{myfile.org}, +the HTML file will be @file{myfile.html}. The file will be overwritten without warning. If there is an active region@footnote{This requires @code{transient-mark-mode} be turned on.}, only the region will be -exported. If the selected region is a single tree@footnote{To select the +exported. If the selected region is a single tree@footnote{To select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the export. @@ -9519,7 +9767,43 @@ specify it with a numeric prefix argument. For example, @noindent creates two levels of headings and does the rest as items. -@node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export + +@node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export +@subsection HTML preamble and postamble +@vindex org-export-html-preamble +@vindex org-export-html-postamble +@vindex org-export-html-preamble-format +@vindex org-export-html-postamble-format +@vindex org-export-html-validation-link +@vindex org-export-author-info +@vindex org-export-email-info +@vindex org-export-creator-info +@vindex org-export-time-stamp-file + +The HTML exporter lets you define a preamble and a postamble. + +The default value for @code{org-export-html-preamble} is @code{t}, which +means that the preamble is inserted depending on the relevant formatting +string in @code{org-export-html-preamble-format}. + +Setting @code{org-export-html-preamble} to a string will override the default +formatting string. Setting it to a function, will insert the output of the +function, which must be a string; such a function takes no argument but you +can check against the value of @code{opt-plist}, which contains the list of +publishing properties for the current file. Setting to @code{nil} will not +insert any preamble. + +The default value for @code{org-export-html-postamble} is @code{'auto}, which +means that the HTML exporter will look for the value of +@code{org-export-author-info}, @code{org-export-email-info}, +@code{org-export-creator-info} and @code{org-export-time-stamp-file}, +@code{org-export-html-validation-link} and build the postamble from these +values. Setting @code{org-export-html-postamble} to @code{t} will insert the +postamble from the relevant formatting string found in +@code{org-export-html-postamble-format}. Setting it to @code{nil} will not +insert any postamble. + +@node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export @subsection Quoting HTML tags Plain @samp{<} and @samp{>} are always transformed to @samp{<} and @@ -9624,7 +9908,7 @@ support text viewers and accessibility, and align it to the right. @end example @noindent -and you could use @code{http} addresses just as well. +You could use @code{http} addresses just as well. @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export @subsection Math formatting in HTML export @@ -9704,7 +9988,7 @@ p.date @r{publishing date} p.creator @r{creator info, about org-mode version} .title @r{document title} .todo @r{TODO keywords, all not-done states} -.done @r{the DONE keywords, all stated the count as done} +.done @r{the DONE keywords, all states that count as done} .WAITING @r{each TODO keyword also uses a class named after itself} .timestamp @r{timestamp} .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} @@ -9841,7 +10125,9 @@ compatible with xetex and possibly luatex. See the variables @code{org-export-latex-packages-alist}.}, this backend is also used to produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to implement links and cross references, the PDF output file will be fully -linked. +linked. Beware of the fact that your @code{org} file has to be properly +structured in order to be correctly exported: respect the hierarchy of +sections. @menu * LaTeX/PDF export commands:: Which key invokes which commands @@ -9861,17 +10147,17 @@ linked. @table @kbd @orgcmd{C-c C-e l,org-export-as-latex} @cindex property EXPORT_FILE_NAME -Export as @LaTeX{} file @file{myfile.tex}. For an Org file -@file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will +Export as @LaTeX{} file. For an Org file +@file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will be overwritten without warning. If there is an active region@footnote{This requires @code{transient-mark-mode} be turned on.}, only the region will be -exported. If the selected region is a single tree@footnote{To select the +exported. If the selected region is a single tree@footnote{To select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. @orgcmd{C-c C-e L,org-export-as-latex-to-buffer} Export to a temporary buffer. Do not create a file. -@item C-c C-e v l/L +@item C-c C-e v l/L Export only the visible part of the document. @item M-x org-export-region-as-latex Convert the region to @LaTeX{} under the assumption that it was Org-mode @@ -9895,7 +10181,7 @@ convert them to a custom string depending on @code{org-latex-low-levels}. If you want that transition to occur at a different level, specify it -with a numeric prefix argument. For example, +with a numeric prefix argument. For example, @example @kbd{C-2 C-c C-e l} @@ -9967,12 +10253,14 @@ All lines between these markers are exported literally @subsection Tables in @LaTeX{} export @cindex tables, in @LaTeX{} export -For @LaTeX{} export of a table, you can specify a label and a caption -(@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to -request a @code{longtable} environment for the table, so that it may span -several pages, or provide the @code{multicolumn} keyword that will make the -table span the page in a multicolumn environment (@code{table*} environment). -Finally, you can set the alignment string: +For @LaTeX{} export of a table, you can specify a label, a caption and +placement options (@pxref{Images and tables}). You can also use the +@code{ATTR_LaTeX} line to request a @code{longtable} environment for the +table, so that it may span several pages, or to change the default table +environment from @code{table} to @code{table*} or to change the default inner +tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can +set the alignment string, and (with @code{tabularx} or @code{tabulary}) the +width: @cindex #+CAPTION @cindex #+LABEL @@ -9985,6 +10273,18 @@ Finally, you can set the alignment string: | ..... | ..... | @end example +or to specify a multicolumn table with @code{tabulary} + +@cindex #+CAPTION +@cindex #+LABEL +@cindex #+ATTR_LaTeX +@example +#+CAPTION: A wide table with tabulary +#+LABEL: tbl:wide +#+ATTR_LaTeX: table* tabulary width=\textwidth +| ..... | ..... | +| ..... | ..... | +@end example @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export @subsection Images in @LaTeX{} export @@ -9997,11 +10297,18 @@ output file resulting from @LaTeX{} processing. Org will use an @code{\includegraphics} macro to insert the image. If you have specified a caption and/or a label as described in @ref{Images and tables}, the figure will be wrapped into a @code{figure} environment and thus become a floating -element. You can use an @code{#+ATTR_LaTeX:} line to specify the various -options that can be used in the optional argument of the -@code{\includegraphics} macro. To modify the placement option of the -@code{figure} environment, add something like @samp{placement=[h!]} to the -Attributes. +element. You can use an @code{#+ATTR_LaTeX:} line to specify various other +options. You can ask org to export an image as a float without specifying +a label or a caption by using the keyword @code{float} in this line. Various +optional arguments to the @code{\includegraphics} macro can also be specified +in this fashion. To modify the placement option of the floating environment, +add something like @samp{placement=[h!]} to the attributes. It is to be noted +this option can be used with tables as well@footnote{One can also take +advantage of this option to pass other, unrelated options into the figure or +table environment. For an example see the section ``Exporting org files'' in +@url{http://orgmode.org/worg/org-hacks.html}}. For example the +@code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment +below it. If you would like to let text flow around the image, add the word @samp{wrap} to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left @@ -10023,6 +10330,10 @@ for @code{\includegraphics} and @code{wrapfigure}. [[./img/hst.png]] @end example +If you wish to include an image which spans multiple columns in a page, you +can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This +will export the image wrapped in a @code{figure*} environment. + If you need references to a label created in this way, write @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}. @@ -10153,7 +10464,7 @@ Here is a simple example Org document that is intended for beamer export. For more information, see the documentation on Worg. -@node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting +@node DocBook export, OpenDocumentText export, LaTeX and PDF export, Exporting @section DocBook export @cindex DocBook export @cindex PDF export @@ -10255,7 +10566,7 @@ exported DocBook XML files invalid by not quoting DocBook code correctly. @cindex DocBook recursive sections DocBook exporter exports Org files as articles using the @code{article} -element in DocBook. Recursive sections, i.e. @code{section} elements, are +element in DocBook. Recursive sections, i.e.@: @code{section} elements, are used in exported articles. Top level headlines in Org files are exported as top level sections, and lower level headlines are exported as nested sections. The entire structure of Org files will be exported completely, no @@ -10350,7 +10661,155 @@ special characters included in XHTML entities: " @end example -@node TaskJuggler export, Freemind export, DocBook export, Exporting +@c begin opendocument + +@node OpenDocumentText export, TaskJuggler export, DocBook export, Exporting +@section OpenDocumentText export +@cindex OpenDocumentText export +@cindex K, Jambunathan + +Org-mode 7.6 supports export to OpenDocumentText format using +@file{org-odt.el} module contributed by Jambunathan K. This module can be +enabled in one of the following ways based on your mode of installation. + +@enumerate +@item +If you have downloaded the Org from the Web, either as a distribution +@file{.zip} or @file{.tar} file, or as a Git archive, enable the @code{odt} +option in variable @code{org-modules}. +@item +If you are using Org that comes bundled with Emacs, then you can install the +OpenDocumentText exporter using the package manager. To do this, customize +the variable @code{package-archives} to include +@uref{http://orgmode.org/pkg/releases/} as one of the package archives. +@end enumerate + +@menu +* OpenDocumentText export commands::How to invoke OpenDocumentText export +* Applying Custom Styles:: How to apply custom styles to the output +* Converting to Other formats:: How to convert to formats like doc, docx etc +* Links in OpenDocumentText export:: How links will be interpreted and formatted +* Tables in OpenDocumentText export:: Tables are exported as HTML tables +* Images in OpenDocumentText export:: How to insert figures into DocBook output +* Additional Documentation:: Where to find more information +@end menu + +@node OpenDocumentText export commands, Applying Custom Styles, OpenDocumentText export, OpenDocumentText export +@subsection OpenDocumentText export commands + +@cindex region, active +@cindex active region +@cindex transient-mark-mode +@table @kbd +@orgcmd{C-c C-e o,org-export-as-odt} +@cindex property EXPORT_FILE_NAME +Export as OpenDocumentText file. For an Org file, @file{myfile.org}, the +OpenDocumentText file will be @file{myfile.odt}. The file will be +overwritten without warning. If there is an active region@footnote{This +requires @code{transient-mark-mode} to be turned on}, only the region will be +exported. If the selected region is a single tree@footnote{To select the +current subtree, use @kbd{C-c @@}.}, the tree head will become the document +title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} +property, that name will be used for the export. +@orgcmd{C-c C-e O,org-export-as-odt-and-open} +Export as OpenDocumentText file and open the resulting file. +@end table + +@node Applying Custom Styles, Converting to Other formats, OpenDocumentText export commands, OpenDocumentText export +@subsection Applying Custom Styles +@cindex styles, custom +@cindex template, custom + +@vindex org-export-odt-styles-file + +OpenDocumentExporter ships with a custom @file{styles.xml} for formatting of +the exported file. To customize the output to suit your needs you can use +one of the following methods: + +@enumerate +@item +Customize the variable @code{org-export-odt-styles-file} to point to either a +@file{styles.xml} file, a OpenDocument Text Template file @code{.ott} or a +combination of Text or Template Document together with a set of member files. +Use the first two options if the styles.xml has no references to additional +set of files and use the last option if the @file{styles.xml} references +additional files like header and footer images. +@item +Use an external tool like unoconv to apply custom templates. +@end enumerate + +For best results, it is necessary that the style names used by +OpenDocumentText exporter match that used in the @file{styles.xml}. + +@node Converting to Other formats, Links in OpenDocumentText export, Applying Custom Styles, OpenDocumentText export +@subsection Converting to Other formats + +@cindex convert +@cindex doc, docx + +@vindex org-export-odt-styles-file + +Often times there is a need to convert OpenDocumentText files to other +formats like doc, docx or pdf. You can accomplish this by one of the +following methods: + +@table @kbd +@item M-x org-lparse +Export the outline first to one of the native formats (like OpenDocumentText) +and immediately post-process it to other formats using an external converter. + +@item M-x org-lparse-convert +Export an existing document to other formats using an external converter. +@end table + +You can choose the converter used for conversion by customizing the variable +@code{org-lparse-convert-process}. + +@node Links in OpenDocumentText export, Tables in OpenDocumentText export, Converting to Other formats, OpenDocumentText export +@subsection Links in OpenDocumentText export +@cindex tables, in DocBook export + +OpenDocumentExporter creates cross-references (aka bookmarks) for links that +are destined locally. It creates internet style links for all other links. + +@node Tables in OpenDocumentText export, Images in OpenDocumentText export, Links in OpenDocumentText export, OpenDocumentText export +@subsection Tables in OpenDocumentText export +@cindex tables, in DocBook export + +Export of @file{table.el} tables with row or column spanning is not +supported. Such tables are stripped from the exported document. + +@node Images in OpenDocumentText export, Additional Documentation, Tables in OpenDocumentText export, OpenDocumentText export +@subsection Images in OpenDocumentText export +@cindex images, embedding in OpenDocumentText +@cindex embedding images in OpenDocumentText + +OpenDocumentText exporter can embed images within the exported document. To +embed images, provide a link to the desired image file with no link +description. For example, the following links @samp{[[file:img.jpg]]} or +@samp{[[./img.jpg]]}, will result in embedding of @samp{img.jpg} in the +exported file. + +The exporter can also embed scaled and explicitly sized images within the +exported document. The markup of the scale and size specifications has not +been standardized yet and is hence conveniently skipped in this document. + +The exporter can also make an image the clickable part of a link. To create +clickable images, provide a link whose description is a link to an image +file. For example, the following link +@samp{[[http://orgmode.org][./img.jpg]]}, will result in a clickable image +that links to @uref{http://Orgmode.org} website. + +@node Additional Documentation, , Images in OpenDocumentText export, OpenDocumentText export +@subsection Additional documentation + +The OpenDocumentText exporter is still in development. For up to date +information, please follow Org mailing list @email{emacs-orgmode@@gnu.org} +closely. + +@c end opendocument + +@node TaskJuggler export, Freemind export, OpenDocumentText export, Exporting @section TaskJuggler export @cindex TaskJuggler export @cindex Project management @@ -10366,7 +10825,7 @@ nodes of a document or strictly follow the order of the nodes in the document. Instead the TaskJuggler exporter looks for a tree that defines the tasks and -a optionally tree that defines the resources for this project. It then +a optionally tree that defines the resources for this project. It then creates a TaskJuggler file based on these trees and the attributes defined in all the nodes. @@ -10383,30 +10842,30 @@ Export as TaskJuggler file and then open the file with TaskJugglerUI. @subsection Tasks @vindex org-export-taskjuggler-project-tag -Create your tasks as you usually do with Org-mode. Assign efforts to each -task using properties (it's easiest to do this in the column view). You +Create your tasks as you usually do with Org-mode. Assign efforts to each +task using properties (it is easiest to do this in the column view). You should end up with something similar to the example by Peter Jones in @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}. Now mark the top node of your tasks with a tag named @code{:taskjuggler_project:} (or whatever you customized -@code{org-export-taskjuggler-project-tag} to). You are now ready to export +@code{org-export-taskjuggler-project-tag} to). You are now ready to export the project plan with @kbd{C-c C-e J} which will export the project plan and open a gantt chart in TaskJugglerUI. @subsection Resources @vindex org-export-taskjuggler-resource-tag -Next you can define resources and assign those to work on specific tasks. You -can group your resources hierarchically. Tag the top node of the resources +Next you can define resources and assign those to work on specific tasks. You +can group your resources hierarchically. Tag the top node of the resources with @code{:taskjuggler_resource:} (or whatever you customized -@code{org-export-taskjuggler-resource-tag} to). You can optionally assign an +@code{org-export-taskjuggler-resource-tag} to). You can optionally assign an identifier (named @samp{resource_id}) to the resources (using the standard Org properties commands, @pxref{Property syntax}) or you can let the exporter generate identifiers automatically (the exporter picks the first word of the headline as the identifier as long as it is unique---see the documentation of -@code{org-taskjuggler-get-unique-id}). Using that identifier you can then -allocate resources to tasks. This is again done with the @samp{allocate} -property on the tasks. Do this in column view or when on the task type +@code{org-taskjuggler-get-unique-id}). Using that identifier you can then +allocate resources to tasks. This is again done with the @samp{allocate} +property on the tasks. Do this in column view or when on the task type @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}. Once the allocations are done you can again export to TaskJuggler and check @@ -10415,9 +10874,9 @@ time. @subsection Export of properties -The exporter also takes TODO state information into consideration, i.e. if a +The exporter also takes TODO state information into consideration, i.e.@: if a task is marked as done it will have the corresponding attribute in -TaskJuggler (@samp{complete 100}). Also it will export any property on a task +TaskJuggler (@samp{complete 100}). Also it will export any property on a task resource or resource node which is known to TaskJuggler, such as @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking}, @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or @@ -10430,12 +10889,12 @@ resource or resource node which is known to TaskJuggler, such as The exporter will handle dependencies that are defined in the tasks either with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a -@samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends} +@samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends} attribute can be either @samp{previous-sibling} or a reference to an identifier (named @samp{task_id}) which is defined for another task in the -project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple -dependencies separated by either space or comma. You can also specify -optional attributes on the dependency by simply appending it. The following +project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple +dependencies separated by either space or comma. You can also specify +optional attributes on the dependency by simply appending it. The following examples should illustrate this: @example @@ -10451,15 +10910,15 @@ examples should illustrate this: :END: ** Markup Guidelines :PROPERTIES: - :Effort: 2.0 + :Effort: 2d :END: ** Workflow Guidelines :PROPERTIES: - :Effort: 2.0 + :Effort: 2d :END: * Presentation :PROPERTIES: - :Effort: 2.0 + :Effort: 2d :BLOCKER: training_material @{ gapduration 1d @} preparation :END: @end example @@ -10467,16 +10926,16 @@ examples should illustrate this: @subsection Reports @vindex org-export-taskjuggler-default-reports -TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource -allocation, etc). The user defines what kind of reports should be generated -for a project in the TaskJuggler file. The exporter will automatically insert -some default reports in the file. These defaults are defined in -@code{org-export-taskjuggler-default-reports}. They can be modified using -customize along with a number of other options. For a more complete list, see +TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource +allocation, etc). The user defines what kind of reports should be generated +for a project in the TaskJuggler file. The exporter will automatically insert +some default reports in the file. These defaults are defined in +@code{org-export-taskjuggler-default-reports}. They can be modified using +customize along with a number of other options. For a more complete list, see @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}. For more information and examples see the Org-taskjuggler tutorial at -@uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.php}. +@uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}. @node Freemind export, XOXO export, TaskJuggler export, Exporting @section Freemind export @@ -10487,7 +10946,8 @@ The Freemind exporter was written by Lennart Borgman. @table @kbd @orgcmd{C-c C-e m,org-export-as-freemind} -Export as Freemind mind map @file{myfile.mm}. +Export as Freemind mind map. For an Org file @file{myfile.org}, the Freemind +file will be @file{myfile.mm}. @end table @node XOXO export, iCalendar export, Freemind export, Exporting @@ -10500,7 +10960,8 @@ does not interpret any additional Org-mode features. @table @kbd @orgcmd{C-c C-e x,org-export-as-xoxo} -Export as XOXO file @file{myfile.html}. +Export as XOXO file. For an Org file @file{myfile.org}, the XOXO file will be +@file{myfile.html}. @orgkey{C-c C-e v x} Export only the visible part of the document. @end table @@ -10607,7 +11068,7 @@ and many other properties of a project. * Sources and destinations:: From here to there * Selecting files:: What files are part of the project? * Publishing action:: Setting the function doing the publishing -* Publishing options:: Tweaking HTML export +* Publishing options:: Tweaking HTML/@LaTeX{} export * Publishing links:: Which links keep working after publishing? * Sitemap:: Generating a list of all pages * Generating an index:: An index that reaches across pages @@ -10624,8 +11085,8 @@ variable, called @code{org-publish-project-alist}. Each element of the list configures one project, and may be in one of the two following forms: @lisp - ("project-name" :property value :property value ...) - @r{i.e. a well-formed property list with alternating keys and values} + ("project-name" :property value :property value ...) + @r{i.e.@: a well-formed property list with alternating keys and values} @r{or} ("project-name" :components ("project-name" "project-name" ...)) @@ -10762,6 +11223,8 @@ respective variable for details. @vindex org-export-with-drawers @vindex org-export-with-tags @vindex org-export-with-todo-keywords +@vindex org-export-with-tasks +@vindex org-export-with-done-tasks @vindex org-export-with-priority @vindex org-export-with-TeX-macros @vindex org-export-with-LaTeX-fragments @@ -10769,11 +11232,13 @@ respective variable for details. @vindex org-export-with-fixed-width @vindex org-export-with-timestamps @vindex org-export-author-info -@vindex org-export-email +@vindex org-export-email-info @vindex org-export-creator-info +@vindex org-export-time-stamp-file @vindex org-export-with-tables @vindex org-export-highlight-first-table-line @vindex org-export-html-style-include-default +@vindex org-export-html-style-include-scripts @vindex org-export-html-style @vindex org-export-html-style-extra @vindex org-export-html-link-org-files-as-html @@ -10785,8 +11250,6 @@ respective variable for details. @vindex org-export-publishing-directory @vindex org-export-html-preamble @vindex org-export-html-postamble -@vindex org-export-html-auto-preamble -@vindex org-export-html-auto-postamble @vindex user-full-name @vindex user-mail-address @vindex org-export-select-tags @@ -10810,6 +11273,7 @@ respective variable for details. @item @code{:drawers} @tab @code{org-export-with-drawers} @item @code{:tags} @tab @code{org-export-with-tags} @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords} +@item @code{:tasks} @tab @code{org-export-with-tasks} @item @code{:priority} @tab @code{org-export-with-priority} @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} @@ -10817,28 +11281,27 @@ respective variable for details. @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading} @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} @item @code{:timestamps} @tab @code{org-export-with-timestamps} +@item @code{:author} @tab @code{user-full-name} +@item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..} @item @code{:author-info} @tab @code{org-export-author-info} @item @code{:email-info} @tab @code{org-export-email-info} @item @code{:creator-info} @tab @code{org-export-creator-info} @item @code{:tables} @tab @code{org-export-with-tables} @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} @item @code{:style-include-default} @tab @code{org-export-html-style-include-default} +@item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts} @item @code{:style} @tab @code{org-export-html-style} @item @code{:style-extra} @tab @code{org-export-html-style-extra} @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} @item @code{:inline-images} @tab @code{org-export-html-inline-images} @item @code{:html-extension} @tab @code{org-export-html-extension} +@item @code{:html-preamble} @tab @code{org-export-html-preamble} +@item @code{:html-postamble} @tab @code{org-export-html-postamble} @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration} @item @code{:html-table-tag} @tab @code{org-export-html-table-tag} @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} -@item @code{:preamble} @tab @code{org-export-html-preamble} -@item @code{:postamble} @tab @code{org-export-html-postamble} -@item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} -@item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} -@item @code{:author} @tab @code{user-full-name} -@item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..} @item @code{:select-tags} @tab @code{org-export-select-tags} @item @code{:exclude-tags} @tab @code{org-export-exclude-tags} @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option} @@ -10846,8 +11309,11 @@ respective variable for details. Most of the @code{org-export-with-*} variables have the same effect in both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and -@code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the -@LaTeX{} export. +@code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the +@LaTeX{} export. See @code{org-export-plist-vars} to check this list of +options. + + @vindex org-publish-project-alist When a property is given a value in @code{org-publish-project-alist}, @@ -10869,9 +11335,9 @@ to link to that, use an @code{http:} link instead of a @code{file:} link, because @code{file:} links are converted to link to the corresponding @file{html} file. -You may also link to related files, such as images. Provided you are careful +You may also link to related files, such as images. Provided you are careful with relative file names, and provided you have also configured Org to upload -the related files, these links will work too. See @ref{Complex example}, for +the related files, these links will work too. See @ref{Complex example}, for an example of this usage. Sometimes an Org file to be published may contain links that are @@ -10905,11 +11371,11 @@ a map of files for a given project. or @code{org-publish-all}. @item @code{:sitemap-filename} -@tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which +@tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which becomes @file{sitemap.html}). @item @code{:sitemap-title} -@tab Title of sitemap page. Defaults to name of file. +@tab Title of sitemap page. Defaults to name of file. @item @code{:sitemap-function} @tab Plug-in function to use for generation of the sitemap. @@ -10921,13 +11387,35 @@ of links to all files in the project. (default) or @code{last} to display folders first or last, respectively. Any other value will mix files and folders. -@item @code{:sitemap-alphabetically} -@tab The site map is normally sorted alphabetically. Set this explicitly to -@code{nil} to turn off sorting. +@item @code{:sitemap-sort-files} +@tab How the files are sorted in the site map. Set this to +@code{alphabetically} (default), @code{chronologically} or +@code{anti-chronologically}. @code{chronologically} sorts the files with +older date first while @code{anti-chronologically} sorts the files with newer +date first. @code{alphabetically} sorts the files alphabetically. The date of +a file is retrieved with @code{org-publish-find-date}. @item @code{:sitemap-ignore-case} @tab Should sorting be case-sensitive? Default @code{nil}. +@item @code{:sitemap-file-entry-format} +@tab With this option one can tell how a sitemap's entry is formated in the +sitemap. This is a format string with some escape sequences: @code{%t} stands +for the title of the file, @code{%a} stands for the author of the file and +@code{%d} stands for the date of the file. The date is retrieved with the +@code{org-publish-find-date} function and formated with +@code{org-publish-sitemap-date-format}. Default @code{%t}. + +@item @code{:sitemap-date-format} +@tab Format string for the @code{format-time-string} function that tells how +a sitemap entry's date is to be formated. This property bypasses +@code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}. + +@item @code{:sitemap-sans-extension} +@tab When non-nil, remove filenames' extensions from the generated sitemap. +Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}). +Defaults to @code{nil}. + @end multitable @node Generating an index, , Sitemap, Configuration @@ -10942,10 +11430,10 @@ Org-mode can generate an index across the files of a publishing project. publish it as @file{theindex.html}. @end multitable -The file will be create when first publishing a project with the +The file will be created when first publishing a project with the @code{:makeindex} set. The file only contains a statement @code{#+include: -"theindex.inc"}. You can then built around this include statement by adding -a title, style information etc. +"theindex.inc"}. You can then build around this include statement by adding +a title, style information, etc. @node Uploading files, Sample configuration, Configuration, Publishing @section Uploading files @@ -11015,12 +11503,12 @@ directory on the local machine. This more complicated example publishes an entire website, including Org files converted to HTML, image files, Emacs Lisp source code, and -style sheets. The publishing directory is remote and private files are +style sheets. The publishing directory is remote and private files are excluded. To ensure that links are preserved, care should be taken to replicate your directory structure on the web server, and to use relative file -paths. For example, if your Org files are kept in @file{~/org} and your +paths. For example, if your Org files are kept in @file{~/org} and your publishable images in @file{~/images}, you would link to an image with @c @example @@ -11028,7 +11516,7 @@ file:../images/myimage.png @end example @c On the web server, the relative path to the image should be the -same. You can accomplish this by setting up an "images" folder in the +same. You can accomplish this by setting up an "images" folder in the right place on the web server, and publishing images to it. @lisp @@ -11044,8 +11532,7 @@ right place on the web server, and publishing images to it. :table-of-contents nil :style "<link rel=\"stylesheet\" href=\"../other/mystyle.css\" type=\"text/css\"/>" - :auto-preamble t - :auto-postamble nil) + :html-preamble t) ("images" :base-directory "~/images/" @@ -11078,8 +11565,8 @@ Publish every project. @end table @vindex org-publish-use-timestamps-flag -Org uses timestamps to track when a file has changed. The above functions -normally only publish changed files. You can override this and force +Org uses timestamps to track when a file has changed. The above functions +normally only publish changed files. You can override this and force publishing of all files by giving a prefix argument to any of the commands above, or by customizing the variable @code{org-publish-use-timestamps-flag}. This may be necessary in particular if files include other files via @@ -11095,7 +11582,7 @@ This may be necessary in particular if files include other files via @cindex source code, working with Source code can be included in Org-mode documents using a @samp{src} block, -e.g. +e.g.@: @example #+BEGIN_SRC emacs-lisp @@ -11107,7 +11594,8 @@ e.g. Org-mode provides a number of features for working with live source code, including editing of code blocks in their native major-mode, evaluation of -code blocks, tangling of code blocks, and exporting code blocks and their +code blocks, converting code blocks into source files (known as @dfn{tangling} +in literate programming), and exporting code blocks and their results in several formats. This functionality was contributed by Eric Schulte and Dan Davison, and was originally named Org-babel. @@ -11145,7 +11633,8 @@ The structure of code blocks is as follows: #+end_src @end example -code blocks can also be embedded in text as so called inline code blocks as +Switches and header arguments are optional. Code can also be embedded in text +inline using @example src_<language>@{<body>@} @@ -11163,16 +11652,18 @@ This name is associated with the code block. This is similar to the @samp{#+tblname} lines that can be used to name tables in Org-mode files. Referencing the name of a code block makes it possible to evaluate the block from other places in the file, other files, or from Org-mode table -formulas (see @ref{The spreadsheet}). +formulas (see @ref{The spreadsheet}). Names are assumed to be unique by +evaluation functions and the behavior of multiple blocks of the same name is +undefined. @item <language> The language of the code in the block. @item <switches> -Switches controlling exportation of the code block (see switches discussion in +Optional switches controlling exportation of the code block (see switches discussion in @ref{Literal examples}) @item <header arguments> Optional header arguments control many aspects of evaluation, export and -tangling of code blocks. See the @ref{Header arguments} -section. Header arguments can also be set on a per-buffer or per-subtree +tangling of code blocks. See the @ref{Header arguments}. +Header arguments can also be set on a per-buffer or per-subtree basis using properties. @item <body> The source code. @@ -11187,21 +11678,21 @@ The source code. @cindex source code, editing @kindex C-c ' -Use @kbd{C-c '} to edit the current code block. This brings up +Use @kbd{C-c '} to edit the current code block. This brings up a language major-mode edit buffer containing the body of the code -block. Saving this buffer will write the new contents back to the Org -buffer. Use @kbd{C-c '} again to exit. +block. Saving this buffer will write the new contents back to the Org +buffer. Use @kbd{C-c '} again to exit. -The @code{org-src-mode} minor mode will be active in the edit buffer. The +The @code{org-src-mode} minor mode will be active in the edit buffer. The following variables can be used to configure the behavior of the edit -buffer. See also the customization group @code{org-edit-structure} for +buffer. See also the customization group @code{org-edit-structure} for further configuration options. @table @code @item org-src-lang-modes If an Emacs major-mode named @code{<lang>-mode} exists, where @code{<lang>} is the language named in the header line of the code block, -then the edit buffer will be placed in that major-mode. This variable +then the edit buffer will be placed in that major-mode. This variable can be used to map arbitrary language names to existing major modes. @item org-src-window-setup Controls the way Emacs windows are rearranged when the edit buffer is created. @@ -11209,10 +11700,13 @@ Controls the way Emacs windows are rearranged when the edit buffer is created. This variable is especially useful for tangling languages such as Python, in which whitespace indentation in the output is critical. @item org-src-ask-before-returning-to-edit-buffer -By default, Org will ask before returning to an open edit buffer. Set -this variable to nil to switch without asking. +By default, Org will ask before returning to an open edit buffer. Set this +variable to nil to switch without asking. @end table +To turn on native code fontification in the @emph{Org} buffer, configure the +variable @code{org-src-fontify-natively}. + @comment node-name, next, previous, up @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code @@ -11223,8 +11717,8 @@ this variable to nil to switch without asking. It is possible to export the @emph{contents} of code blocks, the @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For -most languages, the default exports the contents of code blocks. However, for -some languages (e.g. @code{ditaa}) the default exports the results of code +most languages, the default exports the contents of code blocks. However, for +some languages (e.g.@: @code{ditaa}) the default exports the results of code block evaluation. For information on exporting code block bodies, see @ref{Literal examples}. @@ -11234,7 +11728,7 @@ behavior: @subsubheading Header arguments: @table @code @item :exports code -The default in most languages. The body of the code block is exported, as +The default in most languages. The body of the code block is exported, as described in @ref{Literal examples}. @item :exports results The code block will be evaluated and the results will be placed in the @@ -11259,6 +11753,7 @@ markup language for a wiki. @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code @section Extracting source code +@cindex tangling @cindex source code, extracting @cindex code block, extracting source code @@ -11273,7 +11768,7 @@ using @code{org-babel-expand-src-block} which can expand both variable and @item :tangle no The default. The code block is not included in the tangled output. @item :tangle yes -Include the code block in the tangled output. The output file name is the +Include the code block in the tangled output. The output file name is the name of the org file with the extension @samp{.org} replaced by the extension for the block language. @item :tangle filename @@ -11283,10 +11778,10 @@ Include the code block in the tangled output to file @samp{filename}. @kindex C-c C-v t @subsubheading Functions @table @code -@item org-babel-tangle +@item org-babel-tangle Tangle the current file. Bound to @kbd{C-c C-v t}. @item org-babel-tangle-file -Choose a file to tangle. Bound to @kbd{C-c C-v f}. +Choose a file to tangle. Bound to @kbd{C-c C-v f}. @end table @subsubheading Hooks @@ -11324,24 +11819,60 @@ It is also possible to evaluate named code blocks from anywhere in an Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously @code{#+function} or @code{#+lob}) lines can be used to remotely execute code blocks located in the current Org-mode buffer or in the ``Library of Babel'' -(see @ref{Library of Babel}). These lines use the following syntax. +(see @ref{Library of Babel}). These lines use the following syntax to place +a call on a line by itself. @example -#+call: <name>(<arguments>) <header arguments> -#+function: <name>(<arguments>) <header arguments> -#+lob: <name>(<arguments>) <header arguments> +#+call: <name>(<arguments>) +#+call: <name>[<header args>](<arguments>) <header args> +@end example + +The following syntax can be used to place these calls within a block of +prose. + +@example +...prose... call_<name>(<arguments>) ...prose... +...prose... call_<name>[<header args>](<arguments>)[<header args>] ...prose... @end example @table @code @item <name> The name of the code block to be evaluated. @item <arguments> -Arguments specified in this section will be passed to the code block. -@item <header arguments> -Header arguments can be placed after the function invocation. See -@ref{Header arguments} for more information on header arguments. +Arguments specified in this section will be passed to the code block. These +arguments should relate to @code{:var} header arguments in the called code +block expressed using standard function call syntax. For example if the +original code block named @code{double} has the header argument @code{:var +n=2}, then the call line passing the number four to that block would be +written as @code{#+call: double(n=2)}. +@item <header args> +Header arguments can be placed either inside the call to the code block or at +the end of the line as shown below. + +@example +#+call: code_bloc_name[XXXX](arguments) YYYY +@end example + +Header arguments located in these two locations are treated differently. + +@table @code +@item XXXX +Those placed in the @code{XXXX} location are passed through and applied to +the code block being called. These header arguments affect how the code +block is evaluated, for example @code{[:results output]} will collect the +results from @code{STDOUT} of the called code block. +@item YYYY +Those placed in the @code{YYYY} location are applied to the call line and do +not affect the code block being called. These header arguments affect how +the results are incorporated into the Org-mode buffer when the call line is +evaluated, and how the call line is exported. For example @code{:results +org} at the end of the call line will insert the results of the call line +inside of an Org-mode block. @end table +For more examples of passing header arguments to @code{#+call:} lines see +@ref{Header arguments in function calls}. +@end table @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code @section Library of Babel @@ -11374,19 +11905,24 @@ Code blocks in the following languages are supported. @multitable @columnfractions 0.28 0.3 0.22 0.2 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier} -@item Asymptote @tab asymptote @tab C @tab C +@item Asymptote @tab asymptote @tab Awk @tab awk +@item Emacs Calc @tab calc @tab C @tab C @item C++ @tab C++ @tab Clojure @tab clojure @item CSS @tab css @tab ditaa @tab ditaa @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp @item gnuplot @tab gnuplot @tab Haskell @tab haskell -@item LaTeX @tab latex @tab MATLAB @tab matlab +@item Java @tab java @tab @tab +@item Javascript @tab js @tab LaTeX @tab latex +@item Ledger @tab ledger @tab Lisp @tab lisp +@item Lilypond @tab lilypond @tab MATLAB @tab matlab @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml -@item Octave @tab octave @tab Oz @tab oz -@item Perl @tab perl @tab Python @tab python +@item Octave @tab octave @tab Org-mode @tab org +@item Oz @tab oz @tab Perl @tab perl +@item Plantuml @tab plantuml @tab Python @tab python @item R @tab R @tab Ruby @tab ruby -@item Sass @tab sass @tab GNU Screen @tab screen -@item shell @tab sh @tab SQL @tab sql -@item SQLite @tab sqlite +@item Sass @tab sass @tab Scheme @tab scheme +@item GNU Screen @tab screen @tab shell @tab sh +@item SQL @tab sql @tab SQLite @tab sqlite @end multitable Language-specific documentation is available for some languages. If @@ -11515,7 +12051,7 @@ inserted into the buffer. @subsubheading Header arguments in Org-mode properties Header arguments are also read from Org-mode properties (see @ref{Property -syntax}), which can be set on a buffer-wide or per-heading basis. An example +syntax}), which can be set on a buffer-wide or per-heading basis. An example of setting a header argument for all code blocks in a buffer is @example @@ -11568,17 +12104,54 @@ Similarly, it is possible to set header arguments for inline code blocks: src_haskell[:exports both]@{fac 5@} @end example +Code block header arguments can span multiple lines using =#+header:= or +=#+headers:= lines preceding a code block or nested in between the name and +body of a named code block. + +Multi-line header arguments on an un-named code block: +@example + #+headers: :var data1=1 + #+begin_src emacs-lisp :var data2=2 + (message "data1:%S, data2:%S" data1 data2) + #+end_src + + #+results: + : data1:1, data2:2 +@end example + +Multi-line header arguments on a named code block: +@example + #+source: named-block + #+header: :var data=2 + #+begin_src emacs-lisp + (message "data:%S" data) + #+end_src + + #+results: named-block + : data:2 +@end example + @node Header arguments in function calls, , Code block specific header arguments, Using header arguments @comment node-name, next, previous, up @subsubheading Header arguments in function calls At the most specific level, header arguments for ``Library of Babel'' or -function call lines can be set as shown below: +function call lines can be set as shown in the two examples below. For more +information on the structure of @code{#+call:} lines see @ref{Evaluating code +blocks}. +The following will apply the @code{:exports results} header argument to the +evaluation of the @code{#+call:} line. @example #+call: factorial(n=5) :exports results @end example +The following will apply the @code{:session special} header argument to the +evaluation of the @code{factorial} code block. +@example +#+call: factorial[:session special](n=5) +@end example + @node Specific header arguments, , Using header arguments, Header arguments @subsection Specific header arguments The following header arguments are defined: @@ -11592,13 +12165,19 @@ The following header arguments are defined: directory for code block execution * exports:: Export code and/or results * tangle:: Toggle tangling and specify file name +* mkdirp:: Toggle creation of parent directories of target + files during tangling * comments:: Toggle insertion of comments in tangled code files +* padline:: Control insertion of padding lines in tangled + code files * no-expand:: Turn off variable assignment and noweb expansion during tangling * session:: Preserve the state of code evaluation * noweb:: Toggle expansion of noweb references +* noweb-ref:: Specify block's noweb reference resolution target * cache:: Avoid re-evaluating unchanged code blocks +* sep:: Delimiter for writing tabular results outside Org * hlines:: Handle horizontal lines in tables * colnames:: Handle column names in tables * rownames:: Handle row names in tables @@ -11606,14 +12185,18 @@ The following header arguments are defined: * eval:: Limit evaluation of specific code blocks @end menu +Additional header arguments are defined on a language-specific basis, see +@ref{Languages}. + @node var, results, Specific header arguments, Specific header arguments @subsubsection @code{:var} The @code{:var} header argument is used to pass arguments to code blocks. The specifics of how arguments are included in a code block vary by language; -these are addressed in the language-specific documentation. However, the +these are addressed in the language-specific documentation. However, the syntax used to specify arguments is the same across all languages. The values passed to arguments can be literal values, values from org-mode tables -and literal example blocks, or the results of other code blocks. +and literal example blocks, the results of other code blocks, or Emacs Lisp +code---see the ``Emacs Lisp evaluation of variables'' heading below. These values can be indexed in a manner similar to arrays---see the ``indexable variable values'' heading below. @@ -11701,7 +12284,9 @@ following the source name. It is possible to reference portions of variable values by ``indexing'' into the variables. Indexes are 0 based with negative values counting back from the end. If an index is separated by @code{,}s then each subsequent section -will index into the next deepest nesting or dimension of the value. The +will index into the next deepest nesting or dimension of the value. Note +that this indexing occurs @emph{before} other table related header arguments +like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The following example assigns the last cell of the first row the table @code{example-table} to the variable @code{data}: @@ -11783,6 +12368,39 @@ another by commas, as shown in the following example. | 11 | 14 | 17 | @end example +@subsubheading Emacs Lisp evaluation of variables + +Emacs lisp code can be used to initialize variable values. When a variable +value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be evaluated as +Emacs Lisp and the result of the evaluation will be assigned as the variable +value. The following example demonstrates use of this evaluation to reliably +pass the file-name of the org-mode buffer to a code block---note that +evaluation of header arguments is guaranteed to take place in the original +org-mode file, while there is no such guarantee for evaluation of the code +block body. + +@example +#+begin_src sh :var filename=(buffer-file-name) :exports both + wc -w $filename +#+end_src +@end example + +Note that values read from tables and lists will not be evaluated as +Emacs Lisp, as shown in the following example. + +@example +#+results: table +| (a b c) | + +#+headers: :var data=table[0,0] +#+begin_src perl + $data +#+end_src + +#+results: +: (a b c) +@end example + @node results, file, var, Specific header arguments @subsubsection @code{:results} @@ -11812,7 +12430,7 @@ This is the default. The result is the value of the last statement in the code block. This header argument places the evaluation in functional mode. Note that in some languages, e.g., Python, use of this result type requires that a @code{return} statement be included in the body of the source -code block. E.g., @code{:results value}. +code block. E.g., @code{:results value}. @item @code{output} The result is the collection of everything printed to STDOUT during the execution of the code block. This header argument places the @@ -11857,6 +12475,10 @@ E.g., @code{:results value code}. The result is converted to pretty-printed code and is enclosed in a code block. This option currently supports Emacs Lisp, Python, and Ruby. E.g., @code{:results value pp}. +@item @code{wrap} +The result is wrapped in a @code{begin_result} block. This can be useful for +inserting @code{raw} or @code{org} syntax results in such a way that their +extend is known and they can be automatically removed or replaced. @end itemize @subsubheading Handling @@ -11884,32 +12506,32 @@ inserted as with @code{replace}. @node file, dir, results, Specific header arguments @subsubsection @code{:file} -The header argument @code{:file} is used to specify a path for file output. -An Org-mode style @code{file:} link is inserted into the buffer as the result -(see @ref{Link format}). Common examples are graphical output from R, -gnuplot, ditaa and LaTeX code blocks. - -Note that for some languages, including R, gnuplot, LaTeX and ditaa, -graphical output is sent to the specified file without the file being -referenced explicitly in the code block. See the documentation for the -individual languages for details. In contrast, general purpose languages such -as Python and Ruby require that the code explicitly create output -corresponding to the path indicated by @code{:file}. +The header argument @code{:file} is used to specify an external file in which +to save code block results. After code block evaluation an Org-mode style +@code{[[file:]]} link (see @ref{Link format}) to the file will be inserted +into the Org-mode buffer. Some languages including R, gnuplot, dot, and +ditaa provide special handling of the @code{:file} header argument +automatically wrapping the code block body in the boilerplate code required +to save output to the specified file. This is often useful for saving +graphical output of a code block to the specified file. +The argument to @code{:file} should be either a string specifying the path to +a file, or a list of two strings in which case the first element of the list +should be the path to a file and the second a description for the link. @node dir, exports, file, Specific header arguments @subsubsection @code{:dir} and remote execution While the @code{:file} header argument can be used to specify the path to the output file, @code{:dir} specifies the default directory during code block -execution. If it is absent, then the directory associated with the current -buffer is used. In other words, supplying @code{:dir path} temporarily has +execution. If it is absent, then the directory associated with the current +buffer is used. In other words, supplying @code{:dir path} temporarily has the same effect as changing the current directory with @kbd{M-x cd path}, and -then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets +then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets the value of the Emacs variable @code{default-directory}. When using @code{:dir}, you should supply a relative path for file output -(e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which +(e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which case that path will be interpreted relative to the default directory. In other words, if you want your plot to go into a folder called @file{Work} @@ -11923,7 +12545,7 @@ matplot(matrix(rnorm(100), 10), type="l") @subsubheading Remote execution A directory on a remote machine can be specified using tramp file syntax, in -which case the code will be evaluated on the remote machine. An example is +which case the code will be evaluated on the remote machine. An example is @example #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu: @@ -11933,7 +12555,7 @@ plot(1:10, main=system("hostname", intern=TRUE)) Text results will be returned to the local Org-mode buffer as usual, and file output will be created on the remote machine with relative paths interpreted -relative to the remote directory. An Org-mode link to the remote file will be +relative to the remote directory. An Org-mode link to the remote file will be created. So, in the above example a plot will be created on the remote machine, @@ -11945,7 +12567,7 @@ and a link of the following form will be inserted in the org buffer: Most of this functionality follows immediately from the fact that @code{:dir} sets the value of the Emacs variable @code{default-directory}, thanks to -tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to +tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to install tramp separately in order for these features to work correctly. @subsubheading Further points @@ -11957,10 +12579,10 @@ determine the starting directory for a new session as expected, no attempt is currently made to alter the directory associated with an existing session. @item @code{:dir} should typically not be used to create files during export with -@code{:exports results} or @code{:exports both}. The reason is that, in order +@code{:exports results} or @code{:exports both}. The reason is that, in order to retain portability of exported material between machines, during export links inserted into the buffer will *not* be expanded against @code{default -directory}. Therefore, if @code{default-directory} is altered using +directory}. Therefore, if @code{default-directory} is altered using @code{:dir}, it is probable that the file will be created in a location to which the link does not point. @end itemize @@ -11976,16 +12598,16 @@ or LaTeX exports of the Org-mode file. The default. The body of code is included into the exported file. E.g., @code{:exports code}. @item @code{results} -The result of evaluating the code is included in the exported file. E.g., +The result of evaluating the code is included in the exported file. E.g., @code{:exports results}. @item @code{both} -Both the code and results are included in the exported file. E.g., +Both the code and results are included in the exported file. E.g., @code{:exports both}. @item @code{none} Nothing is included in the exported file. E.g., @code{:exports none}. @end itemize -@node tangle, comments, exports, Specific header arguments +@node tangle, mkdirp, exports, Specific header arguments @subsubsection @code{:tangle} The @code{:tangle} header argument specifies whether or not the code @@ -11993,19 +12615,26 @@ block should be included in tangled extraction of source code files. @itemize @bullet @item @code{tangle} -The code block is exported to a source code file named after the -basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle -yes}. +The code block is exported to a source code file named after the full path +(including the directory) and file name (w/o extension) of the Org-mode file. +E.g., @code{:tangle yes}. @item @code{no} The default. The code block is not exported to a source code file. E.g., @code{:tangle no}. @item other Any other string passed to the @code{:tangle} header argument is interpreted -as a file basename to which the block will be exported. E.g., @code{:tangle -basename}. +as a path (directory and file name relative to the directory of the Org-mode +file) to which the block will be exported. E.g., @code{:tangle path}. @end itemize -@node comments, no-expand, tangle, Specific header arguments +@node mkdirp, comments, tangle, Specific header arguments +@subsubsection @code{:mkdirp} + +The @code{:mkdirp} header argument can be used to create parent directories +of tangled files when missing. This can be set to @code{yes} to enable +directory creation or to @code{no} to inhibit directory creation. + +@node comments, padline, mkdirp, Specific header arguments @subsubsection @code{:comments} By default code blocks are tangled to source-code files without any insertion of comments beyond those which may already exist in the body of the code @@ -12027,9 +12656,26 @@ The text is picked from the leading context of the tangled code and is limited by the nearest headline or source block as the case may be. @item @code{both} Turns on both the ``link'' and ``org'' comment options. +@item @code{noweb} +Turns on the ``link'' comment option, and additionally wraps expanded noweb +references in the code block body in link comments. @end itemize -@node no-expand, session, comments, Specific header arguments +@node padline, no-expand, comments, Specific header arguments +@subsubsection @code{:padline} +Control in insertion of padding lines around code block bodies in tangled +code files. The default value is @code{yes} which results in insertion of +newlines before and after each tangled code block. The following arguments +are accepted. + +@itemize @bullet +@item @code{yes} +Insert newlines before and after each code block body in tangled code files. +@item @code{no} +Do not insert any newline padding in tangled output. +@end itemize + +@node no-expand, session, padline, Specific header arguments @subsubsection @code{:no-expand} By default, code blocks are expanded with @code{org-babel-expand-src-block} @@ -12050,12 +12696,12 @@ A string passed to the @code{:session} header argument will give the session a name. This makes it possible to run concurrent sessions for each interpreted language. -@node noweb, cache, session, Specific header arguments +@node noweb, noweb-ref, session, Specific header arguments @subsubsection @code{:noweb} The @code{:noweb} header argument controls expansion of ``noweb'' style (see @ref{Noweb reference syntax}) references in a code block. This header -argument can have one of three values: @code{yes} @code{no} or @code{tangle}. +argument can have one of three values: @code{yes}, @code{no}, or @code{tangle}. @itemize @bullet @item @code{yes} @@ -12096,7 +12742,49 @@ Note that noweb replacement text that does not contain any newlines will not be affected by this change, so it is still possible to use inline noweb references. -@node cache, hlines, noweb, Specific header arguments +@node noweb-ref, cache, noweb, Specific header arguments +@subsubsection @code{:noweb-ref} +When expanding ``noweb'' style references the bodies of all code block with +@emph{either} a block name matching the reference name @emph{or} a +@code{:noweb-ref} header argument matching the reference name will be +concatenated together to form the replacement text. + +By setting this header argument at the sub-tree or file level, simple code +block concatenation may be achieved. For example, when tangling the +following Org-mode file, the bodies of code blocks will be concatenated into +the resulting pure code file. + +@example + #+begin_src sh :tangle yes :noweb yes :shebang #!/bin/sh + <<fullest-disk>> + #+end_src + * the mount point of the fullest disk + :PROPERTIES: + :noweb-ref: fullest-disk + :END: + + ** query all mounted disks + #+begin_src sh + df \ + #+end_src + + ** strip the header row + #+begin_src sh + |sed '1d' \ + #+end_src + + ** sort by the percent full + #+begin_src sh + |awk '@{print $5 " " $6@}'|sort -n |tail -1 \ + #+end_src + + ** extract the mount point + #+begin_src sh + |awk '@{print $2@}' + #+end_src +@end example + +@node cache, sep, noweb-ref, Specific header arguments @subsubsection @code{:cache} The @code{:cache} header argument controls the use of in-buffer caching of @@ -12116,7 +12804,44 @@ executions of the code block. If the code block has not changed since the last time it was evaluated, it will not be re-evaluated. @end itemize -@node hlines, colnames, cache, Specific header arguments +Code block caches notice if the value of a variable argument +to the code block has changed. If this is the case, the cache is +invalidated and the code block is re-run. In the following example, +@code{caller} will not be re-run unless the results of @code{random} have +changed since it was last run. + +@example + #+srcname: random + #+begin_src R :cache yes + runif(1) + #+end_src + + #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random + 0.4659510825295 + + #+srcname: caller + #+begin_src emacs-lisp :var x=random :cache yes + x + #+end_src + + #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller + 0.254227238707244 +@end example + +@node sep, hlines, cache, Specific header arguments +@subsubsection @code{:sep} + +The @code{:sep} header argument can be used to control the delimiter used +when writing tabular results out to files external to Org-mode. This is used +either when opening tabular results of a code block by calling the +@code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block, +or when writing code block results to an external file (see @ref{file}) +header argument. + +By default, when @code{:sep} is not specified output tables are tab +delimited. + +@node hlines, colnames, sep, Specific header arguments @subsubsection @code{:hlines} Tables are frequently represented with one or more horizontal lines, or @@ -12150,7 +12875,7 @@ default value yields the following results. @end example @item @code{yes} -Leaves hlines in the table. Setting @code{:hlines yes} has this effect. +Leaves hlines in the table. Setting @code{:hlines yes} has this effect. @example #+tblname: many-cols @@ -12206,12 +12931,15 @@ processing, then reapplied to the results. | c* | @end example +Please note that column names are not removed before the table is indexed +using variable indexing @xref{var, Indexable variable values}. + @item @code{no} No column name pre-processing takes place @item @code{yes} Column names are removed and reapplied as with @code{nil} even if the table -does not ``look like'' it has column names (i.e. the second row is not an +does not ``look like'' it has column names (i.e.@: the second row is not an hline) @end itemize @@ -12243,13 +12971,17 @@ and is then reapplied to the results. | one | 11 | 12 | 13 | 14 | 15 | | two | 16 | 17 | 18 | 19 | 20 | @end example + +Please note that row names are not removed before the table is indexed using +variable indexing @xref{var, Indexable variable values}. + @end itemize @node shebang, eval, rownames, Specific header arguments @subsubsection @code{:shebang} Setting the @code{:shebang} header argument to a string value -(e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the +(e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the first line of any tangled file holding the code block, and the file permissions of the tangled file are set to make it executable. @@ -12263,6 +12995,10 @@ dangerous code blocks. @code{:eval query} will require a query for every execution of a code block regardless of the value of the @code{org-confirm-babel-evaluate} variable. +If this header argument is not set then evaluation is determined by the value +of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation +security}. + @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code @section Results of evaluation @cindex code block, results of evaluation @@ -12270,7 +13006,8 @@ execution of a code block regardless of the value of the The way in which results are handled depends on whether a session is invoked, as well as on whether @code{:results value} or @code{:results output} is -used. The following table shows the possibilities: +used. The following table shows the table possibilities. For a full listing +of the possible results header arguments see @ref{results}. @multitable @columnfractions 0.26 0.33 0.41 @item @tab @b{Non-session} @tab @b{Session} @@ -12284,10 +13021,10 @@ vector of strings or numbers) when appropriate. @subsection Non-session @subsubsection @code{:results value} -This is the default. Internally, the value is obtained by wrapping the code +This is the default. Internally, the value is obtained by wrapping the code in a function definition in the external language, and evaluating that -function. Therefore, code should be written as if it were the body of such a -function. In particular, note that Python does not automatically return a +function. Therefore, code should be written as if it were the body of such a +function. In particular, note that Python does not automatically return a value from a function unless a @code{return} statement is present, and so a @samp{return} statement will usually be required in Python. @@ -12296,25 +13033,33 @@ automatically wrapped in a function definition. @subsubsection @code{:results output} The code is passed to the interpreter as an external process, and the -contents of the standard output stream are returned as text. (In certain +contents of the standard output stream are returned as text. (In certain languages this also contains the error output stream; this is an area for future work.) @subsection Session @subsubsection @code{:results value} -The code is passed to the interpreter running as an interactive Emacs -inferior process. The result returned is the result of the last evaluation -performed by the interpreter. (This is obtained in a language-specific -manner: the value of the variable @code{_} in Python and Ruby, and the value -of @code{.Last.value} in R). +The code is passed to an interpreter running as an interactive Emacs inferior +process. Only languages which provide tools for interactive evaluation of +code have session support, so some language (e.g., C and ditaa) do not +support the @code{:session} header argument, and in other languages (e.g., +Python and Haskell) which have limitations on the code which may be entered +into interactive sessions, those limitations apply to the code in code blocks +using the @code{:session} header argument as well. + +Unless the @code{:results output} option is supplied (see below) the result +returned is the result of the last evaluation performed by the +interpreter. (This is obtained in a language-specific manner: the value of +the variable @code{_} in Python and Ruby, and the value of @code{.Last.value} +in R). @subsubsection @code{:results output} The code is passed to the interpreter running as an interactive Emacs -inferior process. The result returned is the concatenation of the sequence of -(text) output from the interactive interpreter. Notice that this is not +inferior process. The result returned is the concatenation of the sequence of +(text) output from the interactive interpreter. Notice that this is not necessarily the same as what would be sent to @code{STDOUT} if the same code were passed to a non-interactive interpreter running as an external -process. For example, compare the following two blocks: +process. For example, compare the following two blocks: @example #+begin_src python :results output @@ -12343,7 +13088,7 @@ In non-session mode, the `2' is not printed and does not appear. @end example But in @code{:session} mode, the interactive interpreter receives input `2' -and prints out its value, `2'. (Indeed, the other print statements are +and prints out its value, `2'. (Indeed, the other print statements are unnecessary here). @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code @@ -12384,13 +13129,13 @@ are active: @multitable @columnfractions 0.25 0.75 @kindex C-c C-c -@item @kbd{C-c C-c} @tab org-babel-execute-src-block +@item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block} @kindex C-c C-o -@item @kbd{C-c C-o} @tab org-babel-open-src-block-result +@item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result} @kindex C-up -@item @kbd{C-@key{up}} @tab org-babel-load-in-session +@item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session} @kindex M-down -@item @kbd{M-@key{down}} @tab org-babel-pop-to-session +@item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session} @end multitable In an Org-mode buffer, the following key bindings are active: @@ -12398,46 +13143,46 @@ In an Org-mode buffer, the following key bindings are active: @multitable @columnfractions 0.45 0.55 @kindex C-c C-v a @kindex C-c C-v C-a -@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash +@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} @kindex C-c C-v b @kindex C-c C-v C-b -@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer +@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} @kindex C-c C-v f @kindex C-c C-v C-f -@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file +@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} @kindex C-c C-v g -@item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block +@item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block} @kindex C-c C-v h -@item @kbd{C-c C-v h} @tab org-babel-describe-bindings +@item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings} @kindex C-c C-v l @kindex C-c C-v C-l -@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest +@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} @kindex C-c C-v p @kindex C-c C-v C-p -@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block +@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} @kindex C-c C-v s @kindex C-c C-v C-s -@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree +@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} @kindex C-c C-v t @kindex C-c C-v C-t -@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle +@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} @kindex C-c C-v z @kindex C-c C-v C-z -@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session +@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} @end multitable @c When possible these keybindings were extended to work when the control key is @c kept pressed, resulting in the following additional keybindings. @c @multitable @columnfractions 0.25 0.75 -@c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash -@c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer -@c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file -@c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest -@c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block -@c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree -@c @item @kbd{C-c C-v C-t} @tab org-babel-tangle -@c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session +@c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} +@c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} +@c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} +@c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} +@c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} +@c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} +@c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} +@c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} @c @end multitable @node Batch execution, , Key bindings and useful functions, Working With Source Code @@ -12490,6 +13235,7 @@ emacs -Q --batch -l $ORGINSTALL \ * Clean view:: Getting rid of leading stars in the outline * TTY keys:: Using Org on a tty * Interaction:: Other Emacs packages +* org-crypt.el:: Encrypting Org files @end menu @@ -12549,7 +13295,7 @@ option keyword is already complete, pressing @kbd{M-@key{TAB}} again will insert example settings for this keyword. @item In the line after @samp{#+STARTUP: }, complete startup keywords, -i.e. valid keys for this line. +i.e.@: valid keys for this line. @item Elsewhere, complete dictionary words using Ispell. @end itemize @@ -12584,14 +13330,15 @@ The following template selectors are currently supported. @item @kbd{H} @tab @code{#+html:} @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii} @item @kbd{A} @tab @code{#+ascii:} -@item @kbd{i} @tab @code{#+include:} line +@item @kbd{i} @tab @code{#+index:} line +@item @kbd{I} @tab @code{#+include:} line @end multitable For example, on an empty line, typing "<e" and then pressing TAB, will expand into a complete EXAMPLE template. You can install additional templates by customizing the variable -@code{org-structure-template-alist}. See the docstring of the variable for +@code{org-structure-template-alist}. See the docstring of the variable for additional details. @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous @@ -12601,7 +13348,7 @@ additional details. @vindex org-speed-commands-user Single keys can be made to execute commands when the cursor is at the -beginning of a headline, i.e. before the first star. Configure the variable +beginning of a headline, i.e.@: before the first star. Configure the variable @code{org-use-speed-commands} to activate this feature. There is a pre-defined list of commands, and you can add more such commands using the variable @code{org-speed-commands-user}. Speed keys do not only speed up @@ -12641,9 +13388,20 @@ Make sure you know what you are doing before customizing the variables which take off the default security brakes. @defopt org-confirm-babel-evaluate -When set to t user is queried before code block evaluation +When t (the default), the user is asked before every code block evaluation. +When nil, the user is not asked. When set to a function, it is called with +two arguments (language and body of the code block) and should return t to +ask and nil not to ask. @end defopt +For example, here is how to execute "ditaa" code (which is considered safe) +without asking: +@example +(defun my-org-confirm-babel-evaluate (lang body) + (not (string= lang "ditaa"))) ; don't ask for ditaa +(setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate) +@end example + @item Following @code{shell} and @code{elisp} links Org has two link types that can directly evaluate code (@pxref{External links}). These links can be problematic because the code to be evaluated is @@ -12739,7 +13497,7 @@ buffer, most useful for specifying the allowed values of a property. @item #+SETUPFILE: file This line defines a file that holds more in-buffer setup. Normally this is entirely ignored. Only when the buffer is parsed for option-setting lines -(i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a +(i.e.@: when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a settings line, or when exporting), then the contents of this file are parsed as if they had been included in the buffer. In particular, the file can be any other Org-mode file with internal setup. You can visit the file the @@ -12896,14 +13654,14 @@ fninline @r{define footnotes inline} fnnoinline @r{define footnotes in separate section} fnlocal @r{define footnotes near first reference, but not inline} fnprompt @r{prompt for footnote labels} -fnauto @r{create [fn:1]-like labels automatically (default)} +fnauto @r{create @code{[fn:1]}-like labels automatically (default)} fnconfirm @r{offer automatic label for editing or confirmation} -fnplain @r{create [1]-like labels automatically} +fnplain @r{create @code{[1]}-like labels automatically} fnadjust @r{automatically renumber and sort footnotes} nofnadjust @r{do not renumber and sort automatically} @end example @cindex org-hide-block-startup -To hide blocks on startup, use these keywords. The corresponding variable is +To hide blocks on startup, use these keywords. The corresponding variable is @code{org-hide-block-startup}. @cindex @code{hideblocks}, STARTUP keyword @cindex @code{nohideblocks}, STARTUP keyword @@ -13155,7 +13913,7 @@ tty you would rather use @kbd{C-c .} to re-insert the timestamp. @end multitable -@node Interaction, , TTY keys, Miscellaneous +@node Interaction, org-crypt.el, TTY keys, Miscellaneous @section Interaction with other packages @cindex packages, interaction with other Org lives in the world of GNU Emacs and interacts in various ways @@ -13179,7 +13937,7 @@ checks for the availability of Calc by looking for the function @code{calc-eval} which will have been autoloaded during setup if Calc has been installed properly. As of Emacs 22, Calc is part of the Emacs distribution. Another possibility for interaction between the two -packages is using Calc for embedded calculations. @xref{Embedded Mode, +packages is using Calc for embedded calculations. @xref{Embedded Mode, , Embedded Mode, Calc, GNU Emacs Calc Manual}. @item @file{constants.el} by Carsten Dominik @cindex @file{constants.el} @@ -13191,7 +13949,7 @@ constants in the variable @code{org-table-formula-constants}, install the @file{constants} package which defines a large number of constants and units, and lets you use unit prefixes like @samp{M} for @samp{Mega}, etc@. You will need version 2.0 of this package, available -at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for +at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for the function @code{constants-get}, which has to be autoloaded in your setup. See the installation instructions in the file @file{constants.el}. @@ -13291,9 +14049,9 @@ Org will move the following key bindings in Org files, and in the agenda buffer (but not during date selection). @example -S-UP -> M-p S-DOWN -> M-n -S-LEFT -> M-- S-RIGHT -> M-+ -C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+ +S-UP @result{} M-p S-DOWN @result{} M-n +S-LEFT @result{} M-- S-RIGHT @result{} M-+ +C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+ @end example @vindex org-disputed-keys @@ -13303,7 +14061,7 @@ to have other replacement keys, look at the variable @item @file{yasnippet.el} @cindex @file{yasnippet.el} -The way Org-mode binds the TAB key (binding to @code{[tab]} instead of +The way Org mode binds the TAB key (binding to @code{[tab]} instead of @code{"\t"}) overrules YASnippet's access to this key. The following code fixed this problem: @@ -13314,6 +14072,26 @@ fixed this problem: (define-key yas/keymap [tab] 'yas/next-field-group))) @end lisp +The latest version of yasnippet doesn't play well with Org mode. If the +above code does not fix the conflict, start by defining the following +function: + +@lisp +(defun yas/org-very-safe-expand () + (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) +@end lisp + +Then, tell Org mode what to do with the new function: + +@lisp +(add-hook 'org-mode-hook + (lambda () + (make-variable-buffer-local 'yas/trigger-key) + (setq yas/trigger-key [tab]) + (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand) + (define-key yas/keymap [tab] 'yas/next-field))) +@end lisp + @item @file{windmove.el} by Hovav Shacham @cindex @file{windmove.el} This package also uses the @kbd{S-<cursor>} keys, so everything written @@ -13344,6 +14122,44 @@ another key for this command, or override the key in @end table +@node org-crypt.el, , Interaction, Miscellaneous +@section org-crypt.el +@cindex @file{org-crypt.el} +@cindex @code{org-decrypt-entry} + +Org-crypt will encrypt the text of an entry, but not the headline, or +properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt +files. + +Any text below a headline that has a @samp{:crypt:} tag will be automatically +be encrypted when the file is saved. If you want to use a different tag just +customize the @code{org-crypt-tag-matcher} setting. + +To use org-crypt it is suggested that you have the following in your +@file{.emacs}: + +@example +(require 'org-crypt) +(org-crypt-use-before-save-magic) +(setq org-tags-exclude-from-inheritance (quote ("crypt"))) + +(setq org-crypt-key nil) + ;; GPG key to use for encryption + ;; Either the Key ID or set to nil to use symmetric encryption. + +(setq auto-save-default nil) + ;; Auto-saving does not cooperate with org-crypt.el: so you need + ;; to turn it off if you plan to use org-crypt.el quite often. + ;; Otherwise, you'll get an (annoying) message each time you + ;; start Org. + + ;; To turn it off only locally, you can insert this: + ;; + ;; # -*- buffer-auto-save-file-name: nil; -*- +@end example + +Excluding the crypt tag from inheritance prevents already encrypted text +being encrypted again. @node Hacking, MobileOrg, Miscellaneous, Top @appendix Hacking @@ -13487,7 +14303,7 @@ the link description when the link is later inserted into an Org buffer with @kbd{C-c C-l}. When it makes sense for your new link type, you may also define a function -@code{org-PREFIX-complete-link} that implements special (e.g. completion) +@code{org-PREFIX-complete-link} that implements special (e.g.@: completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -13526,7 +14342,8 @@ package, special contexts are lines that start with @code{#+R:} or The function first checks if the cursor is in such a line. If that is the case, @code{org-R-apply} is called and the function returns @code{t} to signal that action was taken, and @kbd{C-c C-c} will stop looking for other -contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try. +contexts. If the function finds it should do nothing locally, it returns +@code{nil} so that other, similar functions can have a try. @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking @@ -13539,7 +14356,7 @@ Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a frequent feature request has been to make it work with native tables in specific languages, for example @LaTeX{}. However, this is extremely hard to do in a general way, would lead to a customization nightmare, -and would take away much of the simplicity of the Orgtbl-mode table +and would take away much of the simplicity of the Orgtbl mode table editor. This appendix describes a different approach. We keep the Orgtbl mode @@ -13587,7 +14404,7 @@ example: @noindent @code{table_name} is the reference name for the table that is also used -in the receiver lines. @code{translation_function} is the Lisp function +in the receiver lines. @code{translation_function} is the Lisp function that does the translation. Furthermore, the line can contain a list of arguments (alternating key and value) at the end. The arguments will be passed as a property list to the translation function for @@ -13690,7 +14507,7 @@ table inserted between the two marker lines. Now let's assume you want to make the table header by hand, because you want to control how columns are aligned, etc@. In this case we make sure that the table translator skips the first 2 lines of the source -table, and tell the command to work as a @i{splice}, i.e. to not produce +table, and tell the command to work as a @i{splice}, i.e.@: to not produce header and footer commands of the target table: @example @@ -13725,7 +14542,7 @@ tabular environment. Default is nil. A format to be used to wrap each field, it should contain @code{%s} for the original field value. For example, to wrap each field value in dollars, you could use @code{:fmt "$%s$"}. This may also be a property list with -column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. +column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. A function of one argument can be used in place of the strings; the function must return a formatted string. @@ -13773,7 +14590,7 @@ hands processing over to the generic translator. Here is the entire code: As you can see, the properties passed into the function (variable @var{PARAMS}) are combined with the ones newly defined in the function -(variable @var{PARAMS2}). The ones passed into the function (i.e. the +(variable @var{PARAMS2}). The ones passed into the function (i.e.@: the ones set by the @samp{ORGTBL SEND} line) take precedence. So if you would like to use the @LaTeX{} translator, but wanted the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you could just @@ -13920,15 +14737,24 @@ example @code{before-save-hook}. @code{org-update-all-dblocks} is written in a way such that it does nothing in buffers that are not in @code{org-mode}. +You can narrow the current buffer to the current dynamic block (like any +other block) with @code{org-narrow-to-block}. + @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking @section Special agenda views @cindex agenda views, user-defined +@vindex org-agenda-skip-function +@vindex org-agenda-skip-function-global Org provides a special hook that can be used to narrow down the selection -made by these agenda views: @code{todo}, @code{alltodo}, @code{tags}, @code{tags-todo}, -@code{tags-tree}. You may specify a function that is used at each match to verify -if the match should indeed be part of the agenda view, and if not, how -much should be skipped. +made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo}, +@code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function +that is used at each match to verify if the match should indeed be part of +the agenda view, and if not, how much should be skipped. You can specify a +global condition that will be applied to all agenda views, this condition +would be stored in the variable @code{org-agenda-skip-function-global}. More +commonly, such a definition is applied only to specific custom searches, +using @code{org-agenda-skip-function}. Let's say you want to produce a list of projects that contain a WAITING tag anywhere in the project tree. Let's further assume that you have @@ -14219,7 +15045,7 @@ does not need to preserve point. After evaluation, the cursor will be moved to the end of the line (presumably of the headline of the processed entry) and search continues from there. Under some circumstances, this may not produce the wanted results. For example, -if you have removed (e.g. archived) the current (sub)tree it could +if you have removed (e.g.@: archived) the current (sub)tree it could mean that the next entry will be skipped entirely. In such cases, you can specify the position from where search should continue by making FUNC set the variable `org-map-continue-from' to the desired buffer @@ -14235,6 +15061,7 @@ SCOPE determines the scope of this command. It can be any of: @example nil @r{the current buffer, respecting the restriction if any} tree @r{the subtree started with the entry at point} +region @r{The entries within the active region, if any} file @r{the current buffer, without restriction} file-with-archives @r{the current buffer, and any archives associated with it} @@ -14355,7 +15182,7 @@ The easiest way to create that directory is to use a free @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use Dropbox, or if your version of MobileOrg does not support it, you can use a webdav server. For more information, check out the documentation of MobileOrg and also this -@uref{http://orgmode.org/worg/org-faq.php#mobileorg_webdav, FAQ entry}.}. +@uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}. When MobileOrg first connects to your Dropbox, it will create a directory @i{MobileOrg} inside the Dropbox. After the directory has been created, tell Emacs about it: @@ -14373,7 +15200,7 @@ and to read captured notes from there. This operation copies all files currently listed in @code{org-mobile-files} to the directory @code{org-mobile-directory}. By default this list contains all agenda files (as listed in @code{org-agenda-files}), but additional files -can be included by customizing @code{org-mobiles-files}. File names will be +can be included by customizing @code{org-mobile-files}. File names will be staged with paths relative to @code{org-directory}, so all files should be inside this directory. The push operation also creates a special Org file @file{agendas.org} with all custom agenda view defined by the @@ -14703,6 +15530,8 @@ with links transformation to Org syntax. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual chapter about publishing. @item +@i{Jambunathan K} contributed the OpenDocumentText exporter. +@item @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and enabled source code highlighling in Gnus. @item @@ -14729,6 +15558,7 @@ work on a tty. @item @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks and contributed various ideas and code snippets. +@item @end itemize diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex index fd22fd68567..6f593d76639 100644 --- a/doc/misc/texinfo.tex +++ b/doc/misc/texinfo.tex @@ -3,7 +3,7 @@ % Load plain if necessary, i.e., if running under initex. \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi % -\def\texinfoversion{2011-05-23.16} +\def\texinfoversion{2011-08-15.20} % % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, @@ -9620,6 +9620,3 @@ directory should work if nowhere else does.} @c vim:sw=2: -@ignore - arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 -@end ignore diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 6a245f9c28d..31d3ac0204f 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi @@ -8,7 +8,7 @@ @c In the Tramp CVS, the version number is auto-frobbed from @c configure.ac, so you should edit that file and run @c "autoconf && ./configure" to change the version number. -@set trampver 2.2.2-pre +@set trampver 2.2.3-pre @c Other flags from configuration @set instprefix /usr/local |