+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.texi (Publishing action): Improve documentation of file
+ names when publishing to the source directory.
+ (Clean view): Document `org-indent-mode'.
+ (Clocking work time): Add documentation for the
+ new :timetamp option when creating a clock report.
+ (Paragraphs): Fix many typos.
+ (Plain lists): Remove duplicate explanation about the
+ `C-c *' command.
+ (Literal examples): Update to reflect the new behavior
+ of the -n -r -k switches when exporting source code examples.
+ (Structure editing): Add information about `C-c *',
+ converting a plain list into a list of Org items.
+ (Remember): Small rephrasing of the paragraph
+ describing remember.el. Also mentioned that remember.el is part
+ of Emacs 23, not Emacs 22.
+ (Clocking work time): Add documentation about
+ displaying the current clocking time against the effort estimate.
+ Also add a footnote about using `org-clock-in-prepare-hook' to add
+ an effort estimate on the fly, just before clocking it.
+ (Footnotes): Document automatic renumbering and
+ sorting.
+ (Agenda commands): Document new bulk commands.
+ (Plain lists): Document new behavior of
+ `org-cycle-include-plain-lists'.
+ Hyphenation only in TeX.
+ (Clocking work time): Document the key to update effort
+ estimates.
+ (Clocking work time): Document the clock time display.
+ (Structure editing, TODO basics): Document new
+ variables.
+ (Column attributes): Document new colciew operators.
+ (Publishing options): Document :xml-declaration.
+ (Tracking TODO state changes): Document the
+ LOG_INTO_DRAWER property.
+ (Literal examples): Document the new implementation for
+ editing source code.
+ (Publishing action): Mention the new publishing
+ function, to publish an Org source file.
+ (Publishing links): Mention how to link to an Org source file.
+ (Macro replacement): Document new macros.
+ (Handling links): Document type-specific completion
+ when inserting links.
+ (Structure editing, Plain lists): Improve documentation
+ on sorting.
+ (Internal links): Document custom ids for links.
+ (Handling links): Document custom ids for links.
+ (CSS support): Document new class.
+ (Refiling notes): Document the possibility to create new nodes
+ during refiling.
+ (Agenda commands): Document the "?" operator to find
+ tasks without effort setting.
+ (Exporting agenda information): Section moved.
+ (RSS Feeds): New section.
+ (Built-in table editor): Document M-e and M-a navigate
+ inside table field.
+ (Stuck projects): Docment that projects identified as
+ un-stuck will still be searchd for stuck sub-projects.
+ (Paragraphs): Document centering.
+ (Creating timestamps, Agenda commands): Document new
+ behavior when changing time stamps.
+ (Structure editing): Document the new command
+ `org-clone-subtree-with-time-shift'.
+ (Publishing): Refresh this chapter.
+ (Export options, Export options, In-buffer settings):
+ Document the new keywords.
+ (Matching tags and properties): Collect all
+ documentation about tags/property matches here.
+ (Setting tags): Document `org-tag-persistent-alist'.
+ (Weekly/daily agenda): New section.
+ (Orgstruct mode): Describe `orgstruct++-mode'.
+ (Drawers): Mention the LOGBOOK drawer.
+ (Export options, Sectioning structure): Document the
+ #+LEATEX_HEADER in-buffer setting.
+ (Bugs): Section removed.
+ (Hooks): New section.
+ (Add-on packages): Moved here from old location.
+ (Context-sensitive commands): New section.
+ (Setting tags): Document newline option.
+ (Global TODO list, Matching tags and properties):
+ Mention more variables.
+ (Checkboxes): Update to changed command behavior.
2009-08-02 Eric Yu <sucode@gmail.com> (tiny change)
* speedbar.texi (Basic Key Bindings): Fix typo.
@setfilename ../../info/org
@settitle The Org Manual
-@set VERSION 6.21b
-@set DATE February 2009
+@set VERSION 6.29c
+@set DATE August 2009
@c Version and Contact Info
@set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
@finalout
@c Macro definitions
+@iftex
+@c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
+@end iftex
+@macro Ie {}
+I.e.,
+@end macro
+@macro ie {}
+i.e.,
+@end macro
+@macro Eg {}
+E.g.,
+@end macro
+@macro eg {}
+e.g.,
+@end macro
@c Subheadings inside a table.
@macro tsubheading{text}
@end macro
@copying
-This manual is for Org (version @value{VERSION}).
+This manual is for Org version @value{VERSION}.
Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
* Exporting:: Sharing and publishing of notes
* Publishing:: Create a web site of linked Org files
* Miscellaneous:: All the rest which did not fit elsewhere
-* Extensions:: Add-ons for Org mode
* Hacking:: How to hack your way around
* History and Acknowledgments:: How Org came into being
* Main Index:: An index of Org's concepts and features
* Key Index:: Key bindings and where they are described
+* Variable Index:: Variables mentioned in the manual
@detailmenu
--- The Detailed Node Listing ---
* Sparse trees:: Matches embedded in context
* Plain lists:: Additional structure within an entry
* Drawers:: Tucking stuff away
+* Blocks:: Folding blocks
* Footnotes:: How footnotes are defined in Org's syntax
* Orgstruct mode:: Structure editing outside Org
Tables
* Built-in table editor:: Simple tables
-* Narrow columns:: Stop wasting space in tables
+* Column width and alignment:: Overrule the automatic settings
* Column groups:: Grouping to trigger vertical lines
* Orgtbl mode:: The table editor as minor mode
* The spreadsheet:: The table editor has spreadsheet capabilities
-* Org Plot:: Plotting from org tables
+* Org-Plot:: Plotting from org tables
The spreadsheet
* Remember:: Capture new tasks/ideas with little interruption
* Attachments:: Add files to tasks.
+* RSS Feeds:: Getting input from RSS feeds
+* Protocols:: External (@eg Browser) access to Emacs and Org
Remember
-* Setting up Remember:: Some code for .emacs to get things going
+* Setting up Remember for Org:: Some code for .emacs to get things going
* Remember templates:: Define the outline of different note types
* Storing notes:: Directly get the note to where it belongs
* Refiling notes:: Moving a note or task to a project
* Presentation and sorting:: How agenda items are prepared for display
* Agenda commands:: Remote editing of Org trees
* Custom agenda views:: Defining special searches and views
+* Exporting Agenda Views::
* Agenda column view:: Using column view for collected entries
The built-in agenda views
* Storing searches:: Type once, use often
* Block agenda:: All the stuff you need in a single buffer
* Setting Options:: Changing the rules
-* Exporting Agenda Views:: Writing agendas to files
-* Using the agenda elsewhere:: Using agenda information in other programs
-Embedded LaTeX
+Embedded La@TeX{}
-* Math symbols:: TeX macros for symbols and Greek letters
+* Math symbols:: @TeX{} macros for symbols and Greek letters
* Subscripts and superscripts:: Simple syntax for raising/lowering text
* LaTeX fragments:: Complex formulas made easy
-* Processing LaTeX fragments:: Previewing LaTeX processing
+* Processing LaTeX fragments:: Previewing La@TeX{} processing
* CDLaTeX mode:: Speed up entering of formulas
Exporting
* The export dispatcher:: How to access exporter commands
* ASCII export:: Exporting to plain ASCII
* HTML export:: Exporting to HTML
-* LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
+* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
+* DocBook export:: Exporting to DocBook
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
* Include files:: Include the contents of a file during export
* Tables exported:: Tables are exported richly
* Inlined images:: How to inline images during export
-* Footnote markup::
+* Footnote markup:: ASCII representation of footnotes
* Emphasis and monospace:: To bold or not to bold
* TeX macros and LaTeX fragments:: Create special, rich export.
* Horizontal rules:: A line across the page
* Comment lines:: Some lines will not be exported
+* Macro replacement:: Global replacement of place holders
HTML export
* HTML Export commands:: How to invoke HTML export
* Quoting HTML tags:: Using direct HTML in Org mode
* Links:: Transformation of links for HTML
+* Tables in HTML export:: How to modify the formatting of tables
* Images in HTML export:: How to insert figures into HTML output
* Text areas in HTML export:: An alternative way to show an example
* CSS support:: Changing the appearance of the output
* Javascript support:: Info and Folding in a web browser
-LaTeX and PDF export
+La@TeX{} and PDF export
* LaTeX/PDF export commands:: Which key invokes which commands
-* Quoting LaTeX code:: Incorporating literal LaTeX code
-* Sectioning structure:: Changing sectioning in LaTeX output
-* Tables in LaTeX export:: Options for exporting tables to LaTeX
-* Images in LaTeX export:: How to insert figures into LaTeX output
+* Quoting LaTeX code:: Incorporating literal La@TeX{} code
+* Sectioning structure:: Changing sectioning in La@TeX{} output
+* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
+* Images in LaTeX export:: How to insert figures into La@TeX{} output
+
+DocBook export
+
+* DocBook export commands:: How to invoke DocBook export
+* Quoting DocBook code:: Incorporating DocBook code in Org files
+* Recursive sections:: Recursive sections in DocBook
+* Tables in DocBook export:: Tables are exported as HTML tables
+* Images in DocBook export:: How to insert figures into DocBook output
+* Special characters:: How to handle special characters
Publishing
* Configuration:: Defining projects
+* Uploading files:: How to get files up on the server
* Sample configuration:: Example projects
* Triggering publication:: Publication commands
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org on a tty
* Interaction:: Other Emacs packages
-* Bugs:: Things which do not work perfectly
Interaction with other packages
* Cooperation:: Packages Org cooperates with
* Conflicts:: Packages that lead to conflicts
-Extensions
-
-* Extensions in the contrib directory:: These come with the Org distro
-* Other extensions:: These you have to find on the web.
-
Hacking
+* Hooks:: Who to reach into Org's internals
+* Add-on packages:: Available extensions
* Adding hyperlink types:: New custom link types
-* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
+* Context-sensitive commands:: How to add functionality to such commands
+* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
+* Extracting agenda information:: Postprocessing of agenda information
* Using the property API:: Writing programs that use entry properties
* Using the mapping API:: Mapping over all or selected entries
content of large files well structured. Visibility cycling and
structure editing help to work with the tree. Tables are easily created
with a built-in table editor. Org supports TODO items, deadlines,
-time stamps, and scheduling. It dynamically compiles entries into an
+timestamps, and scheduling. It dynamically compiles entries into an
agenda that utilizes and smoothly integrates much of the Emacs calendar
and diary. Plain text URL-like links connect to websites, emails,
Usenet messages, BBDB entries, and any files related to the projects.
iCalendar file. It can also serve as a publishing tool for a set of
linked web pages.
-An important design aspect that distinguishes Org from for example
-Planner/Muse is that it encourages to store every piece of information
+An important design aspect that distinguishes Org from, for example,
+Planner/Muse is that it encourages you to store every piece of information
only once. In Planner, you have project pages, day pages and possibly
other files, duplicating some information such as tasks. In Org,
-you only have notes files. In your notes you mark entries as tasks,
-label them with tags and timestamps. All necessary lists like a
+you only have notes files. In your notes you mark entries as tasks, and
+label them with tags and timestamps. All necessary lists, like a
schedule for the day, the agenda for a meeting, tasks lists selected by
-tags etc are created dynamically when you need them.
+tags, etc., are created dynamically when you need them.
Org keeps simple things simple. When first fired up, it should
feel like a straightforward, easy to use outliner. Complexity is not
example as:
@example
-@r{@bullet{} outline extension with visibility cycling and structure editing}
-@r{@bullet{} ASCII system and table editor for taking structured notes}
-@r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
-@r{@bullet{} TODO list editor}
-@r{@bullet{} full agenda and planner with deadlines and work scheduling}
-@r{@bullet{} environment to implement David Allen's GTD system}
+@r{@bullet{} an outline extension with visibility cycling and structure editing}
+@r{@bullet{} an ASCII system and table editor for taking structured notes}
+@r{@bullet{} an ASCII table editor with spreadsheet-like capabilities}
+@r{@bullet{} a TODO list editor}
+@r{@bullet{} a full agenda and planner with deadlines and work scheduling}
+@pindex GTD, Getting Things Done
+@r{@bullet{} an environment to implement David Allen's GTD system}
@r{@bullet{} a basic database application}
-@r{@bullet{} simple hypertext system, with HTML and LaTeX export}
-@r{@bullet{} publishing tool to create a set of interlinked webpages}
+@r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export}
+@r{@bullet{} a publishing tool to create a set of interlinked webpages}
@end example
-Org's automatic, context sensitive table editor with spreadsheet
+Org's automatic, context-sensitive table editor with spreadsheet
capabilities can be integrated into any major mode by activating the
minor Orgtbl mode. Using a translation step, it can be used to maintain
tables in arbitrary file types, for example in La@TeX{}. The structure
@cindex FAQ
There is a website for Org which provides links to the newest
version of Org, as well as additional information, frequently asked
-questions (FAQ), links to tutorials etc. This page is located at
+questions (FAQ), links to tutorials, etc@. This page is located at
@uref{http://orgmode.org}.
@page
@ref{Activation}.}
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
-to install it: Go into the unpacked Org distribution directory and edit the
+or @file{.tar} file, or as a Git archive, you must take the following steps
+to install it: go into the unpacked Org distribution directory and edit the
top section of the file @file{Makefile}. You must set the name of the Emacs
binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
directories where local Lisp and Info files are kept. If you don't have
@end example
@noindent If you are running Org from the distribution directory, this is
-all. If you want to install into the system directories, use
+all. If you want to install Org into the system directories, use (as
+administrator)
@example
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:
+
+@example
make install-info
+make install-info-debian
@end example
@noindent Then add to @file{.emacs}:
@cindex key bindings, global
@iftex
-@b{Important:} @i{If you use copy-and-paste to copy lisp code from the
-PDF documentation as viewed by some PDF viewers to your .emacs file, the
-single quote character comes out incorrectly and the code will not work.
-You need to fix the single quotes by hand, or copy from Info
+@b{Important:} @i{If you use copy-and-paste to copy Lisp code from the
+PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the
+single-quote character comes out incorrectly and the code will not work.
+You need to fix the single-quotes by hand, or copy from Info
documentation.}
@end iftex
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
+@command{org-agenda}, and @command{org-iswitchb}---please choose suitable
keys yourself.
@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 user must use the second option):
+(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
MY PROJECTS -*- mode: org; -*-
@end example
+@vindex org-insert-mode-line-in-empty-file
@noindent which will select Org mode for this buffer no matter what
the file's name is. See also the variable
@code{org-insert-mode-line-in-empty-file}.
-Many commands in Org work on the region if the region is active. To make use
-of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in
-XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to
-do this yourself with
-
+Many commands in Org work on the region if the region is @i{active}. To make
+use of this, you need to have @code{transient-mark-mode}
+(@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
+in Emacs 22 you need to do this yourself with
@lisp
(transient-mark-mode 1)
@end lisp
+@noindent If you do not like @code{transient-mark-mode}, you can create an
+active region by using the mouse to select a region, or pressing
+@kbd{C-@key{SPC}} twice before moving the cursor.
@node Feedback, Conventions, Activation, Introduction
@section Feedback
@cindex author
If you find problems with Org, or if you have questions, remarks, or ideas
-about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
+about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
If you are not a member of the mailing list, your mail will be reviewed by a
moderator and then passed through to the list.
@cindex backtrace of an error
If working with Org produces an error with a message you don't
understand, you may have hit a bug. The best way to report this is by
-providing, in addition to what was mentioned above, a @emph{Backtrace}.
+providing, in addition to what was mentioned above, a @emph{backtrace}.
This is information from the built-in debugger about where and how the
error occurred. Here is how to produce a useful backtrace:
@enumerate
@item
-Start a fresh Emacs or XEmacs, and make sure that it will load the
-original Lisp code in @file{org.el} instead of the compiled version in
-@file{org.elc}. The backtrace contains much more information if it is
-produced with uncompiled code. To do this, either rename @file{org.elc}
-to something else before starting Emacs, or ask Emacs explicitly to load
-@file{org.el} by using the command line
+Reload uncompiled versions of all Org-mode Lisp files. The backtrace
+contains much more information if it is produced with uncompiled code.
+To do this, use
@example
-emacs -l /path/to/org.el
+C-u M-x org-reload RET
@end example
+@noindent
+or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
+menu.
@item
Go to the @code{Options} menu and select @code{Enter Debugger on Error}
(XEmacs has this option in the @code{Troubleshooting} sub-menu).
@cindex document structure
@cindex structure of document
-Org is based on outline mode and provides flexible commands to
+Org is based on Outline mode and provides flexible commands to
edit the structure of the document.
@menu
* Sparse trees:: Matches embedded in context
* Plain lists:: Additional structure within an entry
* Drawers:: Tucking stuff away
+* Blocks:: Folding blocks
* Footnotes:: How footnotes are defined in Org's syntax
* Orgstruct mode:: Structure editing outside Org
@end menu
document to show only the general document structure and the parts
currently being worked on. Org greatly simplifies the use of
outlines by compressing the entire show/hide functionality into a single
-command @command{org-cycle}, which is bound to the @key{TAB} key.
+command, @command{org-cycle}, which is bound to the @key{TAB} key.
@node Headlines, Visibility cycling, Outlines, Document Structure
@section Headlines
@cindex headlines
@cindex outline tree
+@vindex org-special-ctrl-a/e
Headlines define the structure of an outline tree. The headlines in
Org start with one or more stars, on the left margin@footnote{See
@noindent Some people find the many stars too noisy and would prefer an
outline that has whitespace followed by a single star as headline
-starters. @ref{Clean view} describes a setup to realize this.
+starters. @ref{Clean view}, describes a setup to realize this.
+@vindex org-cycle-separator-lines
An empty line after the end of a subtree is considered part of it and
will be hidden when the subtree is folded. However, if you leave at
least two empty lines, one empty line will remain visible after folding
'-----------------------------------'
@end example
+@vindex org-cycle-emulate-tab
+@vindex org-cycle-global-at-bob
The cursor must be on a headline for this to work@footnote{see, however,
the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
beginning of the buffer and the first line is not a headline, then
the previously used indirect buffer.
@end table
+@vindex org-startup-folded
+@cindex @code{overview}, STARTUP keyword
+@cindex @code{content}, STARTUP keyword
+@cindex @code{showall}, 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, @ie 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:
#+STARTUP: showall
@end example
+@cindex property, VISIBILITY
@noindent
Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
and Columns}) will get their visibility adapted accordingly. Allowed values
@table @kbd
@kindex C-u C-u @key{TAB}
@item C-u C-u @key{TAB}
-Switch back to the startup visibility of the buffer, i.e. whatever is
+Switch back to the startup visibility of the buffer, @ie whatever is
requested by startup options and @samp{VISIBILITY} properties in individual
entries.
@end table
Jump to a different place without changing the current outline
visibility. Shows the document structure in a temporary buffer, where
you can use the following keys to find your destination:
+@vindex org-goto-auto-isearch
@example
@key{TAB} @r{Cycle visibility.}
@key{down} / @key{up} @r{Next/previous visible headline.}
0-9 @r{Digit argument.}
q @r{Quit}
@end example
-See also the variable@code{org-goto-interface}.
+@vindex org-goto-interface
+@noindent
+See also the variable @code{org-goto-interface}.
@end table
@node Structure editing, Archiving, Motion, Document Structure
@table @kbd
@kindex M-@key{RET}
@item M-@key{RET}
+@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}
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
+used at the end of a folded subtree (@ie 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.
@kindex C-@key{RET}
it. This command works from anywhere in the entry.
@kindex M-S-@key{RET}
@item M-S-@key{RET}
-Insert new TODO entry with same level as current heading.
+@vindex org-treat-insert-todo-heading-as-state-change
+Insert new TODO entry with same level as current heading. See also the
+variable @code{org-treat-insert-todo-heading-as-state-change}.
@kindex C-S-@key{RET}
@item C-S-@key{RET}
Insert new TODO entry with same level as current heading. Like
Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@item C-c C-x C-w
-Kill subtree, i.e. remove it from buffer but save in kill ring.
+Kill subtree, @ie remove it from buffer but save in kill ring.
With a numeric prefix argument N, kill N sequential subtrees.
@kindex C-c C-x M-w
@item C-c C-x M-w
headline marker like @samp{****}.
@kindex C-y
@item C-y
+@vindex org-yank-adjusted-subtrees
+@vindex org-yank-folded-subtrees
Depending on the variables @code{org-yank-adjusted-subtrees} and
@code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
paste subtrees folded and in a clever way, using the same command as @kbd{C-c
force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
yank, it will yank previous kill items plainly, without adjustment and
folding.
+@kindex C-c C-x c
+@item C-c C-x c
+Clone a subtree by making a number of sibling copies of it. You will be
+prompted for the number of copies to make, and you can also specify if any
+timestamps in the entry should be shifted. This can be useful, for example,
+to create a number of tasks related to a series of lectures to prepare. For
+more details, see the docstring of the command
+@code{org-clone-subtree-with-time-shift}.
@kindex C-c C-w
@item C-c C-w
Refile entry or region to a different location. @xref{Refiling notes}.
Sort same-level entries. When there is an active region, all entries in the
region will be sorted. Otherwise the children of the current headline are
sorted. The command prompts for the sorting method, which can be
-alphabetically, numerically, by time (using the first time stamp in each
-entry), by priority, or by TODO keyword (in the sequence the keywords have
-been defined in the setup). Reverse sorting is possible as well. You can
-also supply your own function to extract the sorting key. With a @kbd{C-u}
-prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
-duplicate entries will also be removed.
+alphabetically, numerically, by time (first timestamp with active preferred,
+creation time, scheduled time, deadline time), by priority, by TODO keyword
+(in the sequence the keywords have been defined in the setup) or by the value
+of a property. Reverse sorting is possible as well. You can also supply
+your own function to extract the sorting key. With a @kbd{C-u} prefix,
+sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
+entries will also be removed.
@kindex C-x n s
@item C-x n s
Narrow buffer to current subtree.
@kindex C-x n w
@item C-x n w
-Widen buffer to remove a narrowing.
+Widen buffer to remove narrowing.
@kindex C-c *
@item C-c *
Turn a normal line or plain list item into a headline (so that it becomes a
@cindex region, active
@cindex active region
-@cindex Transient mark mode
-When there is an active region (Transient mark mode), promotion and
+@cindex transient mark mode
+When there is an active region (Transient Mark mode), promotion and
demotion work on all headlines in the region. To select a region of
headlines, it is best to place both point and mark at the beginning of a
line, mark at the beginning of the first headline, and point at the line
its location in the outline tree, but behaves in the following way:
@itemize @minus
@item
+@vindex org-cycle-open-archived-trees
It does not open when you attempt to do so with a visibility cycling
command (@pxref{Visibility cycling}). You can force cycling archived
subtrees with @kbd{C-@key{TAB}}, or by setting the option
@code{org-cycle-open-archived-trees}. Also normal outline commands like
@code{show-all} will open archived subtrees.
@item
+@vindex org-sparse-tree-open-archived-trees
During sparse tree construction (@pxref{Sparse trees}), matches in
archived subtrees are not exposed, unless you configure the option
@code{org-sparse-tree-open-archived-trees}.
@item
+@vindex org-agenda-skip-archived-trees
During agenda view construction (@pxref{Agenda Views}), the content of
archived trees is ignored unless you configure the option
@code{org-agenda-skip-archived-trees}, in which case these trees will always
be included. In the agenda you can press the @kbd{v} key to get archives
temporarily included.
@item
+@vindex org-export-with-archived-trees
Archived trees are not exported (@pxref{Exporting}), only the headline
is. Configure the details using the variable
@code{org-export-with-archived-trees}.
+@item
+@vindex org-columns-skip-arrchived-trees
+Archived trees are excluded from column view unless the variable
+@code{org-columns-skip-arrchived-trees} is configured to @code{nil}.
@end itemize
The following commands help managing the ARCHIVE tag:
(@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
way retains a lot of its original context, including inherited tags and
approximate position in the outline.
+@kindex C-c $
@kindex C-c C-x C-s
+@itemx C-c $
@item C-c C-x C-s
+@vindex org-archive-location
Archive the subtree starting at the cursor position to the location
given by @code{org-archive-location}. Context information that could be
-lost like the file name, the category, inherited tags, and the TODO
-state will be store as properties in the entry.
+lost, like the file name, the category, inherited tags, and the TODO
+state will be stored as properties in the entry.
@kindex C-u C-c C-x C-s
@item C-u C-c C-x C-s
Check if any direct children of the current headline could be moved to
with the outline structure of the document. The correct method for
setting multiple archive locations in a buffer is using properties.}:
+@cindex #+ARCHIVE
@example
#+ARCHIVE: %s_done::
@end example
+@cindex property, ARCHIVE
@noindent
If you would like to have a special ARCHIVE location for a single entry
or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
location as the value (@pxref{Properties and Columns}).
+@vindex org-archive-save-context-info
When a subtree is moved, it receives a number of special properties that
-record context information like the file from where the entry came, it's
+record context information like the file from where the entry came, its
outline path the archiving time etc. Configure the variable
@code{org-archive-save-context-info} to adjust the amount of information
added.
@cindex folding, sparse trees
@cindex occur, command
+@vindex org-show-hierarchy-above
+@vindex org-show-following-heading
+@vindex org-show-siblings
+@vindex org-show-entry-below
An important feature of Org mode is the ability to construct @emph{sparse
trees} for selected information in an outline tree, so that the entire
document is folded as much as possible, but the selected information is made
This prompts for an extra key to select a sparse-tree creating command.
@kindex C-c / r
@item C-c / r
+@vindex org-remove-highlights-with-change
Occur. 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
is shown, as well as the headline following the match. Each match is also
highlighted; the highlights disappear when the buffer is changed by an
-editing command@footnote{depending on the option
+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.
@end table
@noindent
+@vindex org-agenda-custom-commands
For frequently used sparse trees of specific search strings, you can
use the variable @code{org-agenda-custom-commands} to define fast
keyboard access to specific sparse trees. These commands will then be
description.
@end itemize
+@vindex org-empty-line-terminates-plain-lists
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
Important actors in this film are:
- @b{Elijah Wood} :: He plays Frodo
- @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
- him very well from his role as Mikey Walsh in the Goonies.
+ him very well from his role as Mikey Walsh in @i{The Goonies}.
@end group
@end example
-Org supports these lists by tuning filling and wrapping commands to
-deal with them correctly@footnote{Org only changes the filling
-settings for Emacs. For 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}).
+Org supports these lists by tuning filling and wrapping commands to deal with
+them correctly@footnote{Org only changes the filling settings for Emacs. For
+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 part of a list item.
The following commands act on items when the cursor is in the first line
of an item (the line with the bullet or number).
@table @kbd
@kindex @key{TAB}
@item @key{TAB}
-Items can be folded just like headline levels if you set the variable
-@code{org-cycle-include-plain-lists}. The level of an item is then
-given by the indentation of the bullet/number. Items are always
-subordinate to real headlines, however; the hierarchies remain
-completely separated.
+@vindex org-cycle-include-plain-lists
+Items can be folded just like headline levels. Normally this works only if
+the cursor is on a plain list item. For more details, see the variable
+@code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items
+will be treated like low-level. The level of an item is then given by the
+indentation of the bullet/number. Items are always subordinate to real
+headlines, however; the hierarchies remain completely separated.
If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
fixes the indentation of the current line in a heuristic way.
@kindex M-@key{RET}
@item M-@key{RET}
+@vindex org-M-RET-may-split-line
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 S-@key{up}
@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
@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
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
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.
@kindex S-@key{left}
@kindex S-@key{right}
@item S-@key{left}/@key{right}
+@vindex org-support-shift-select
This command also cycles bullet styles when the cursor in on the bullet or
anywhere in an item line, details depending on
@code{org-support-shift-select}.
+@kindex C-c ^
+@item C-c ^
+Sort the plain list. You will be prompted for the sorting method:
+numerically, alphabetically, by time, or by custom function.
@end table
-@node Drawers, Footnotes, Plain lists, Document Structure
+@node Drawers, Blocks, Plain lists, Document Structure
@section Drawers
@cindex drawers
+@cindex #+DRAWERS
@cindex visibility cycling, drawers
+@vindex org-drawers
Sometimes you want to keep information associated with an entry, but you
normally don't want to see it. For this, Org mode has @emph{drawers}.
Drawers need to be configured with the variable
After the drawer.
@end example
-Visibility cycling (@pxref{Visibility cycling}) on the headline will
-hide and show the entry, but keep the drawer collapsed to a single line.
-In order to look inside the drawer, you need to move the cursor to the
-drawer line and press @key{TAB} there. Org mode uses a drawer for
-storing properties (@pxref{Properties and Columns}), and another one for
-storing clock times (@pxref{Clocking work time}).
+Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
+show the entry, but keep the drawer collapsed to a single line. In order to
+look inside the drawer, you need to move the cursor to the drawer line and
+press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
+storing properties (@pxref{Properties and Columns}), and you can also arrange
+for state change notes (@pxref{Tracking TODO state changes}) and clock times
+(@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}.
+
+@node Blocks, Footnotes, Drawers, Document Structure
+@section Blocks
+
+@vindex org-hide-block-startup
+@cindex blocks, folding
+Org-mode uses begin...end blocks for various purposes from including source
+code examples (@pxref{Literal examples}) to capturing time logging
+information (@pxref{Clocking work time}). These blocks can be folded and
+unfolded by pressing TAB in the begin line. You can also get all blocks
+folded at startup by configuring the variable @code{org-hide-block-startup}
+or on a per-file basis by using
-@node Footnotes, Orgstruct mode, Drawers, Document Structure
+@cindex @code{hideblocks}, STARTUP keyword
+@cindex @code{nohideblocks}, STARTUP keyword
+@example
+#+STARTUP: hideblocks
+#+STARTUP: nohideblocks
+@end example
+
+@node Footnotes, Orgstruct mode, Blocks, Document Structure
@section Footnotes
@cindex footnotes
-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
+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}, @ie 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
+inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference
is simply the marker in square brackets, inside text. For example:
@example
[fn:1] The link is: http://orgmode.org
@end example
-Org-mode extends the number-based syntax to @emph{named} footnotes and
+Org mode extends the number-based syntax to @emph{named} footnotes and
optional inline definition. Using plain numbers as markers (as
@file{footnote.el} does) is supported for backward compatibility, but not
-encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded
-LaTeX}. Here are the valid references:
+encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded
+LaTeX}). Here are the valid references:
@table @code
@item [1]
-A plain numeric footnote marker.
+A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
+recommended because somthing like @samp{[1]} could easily be part of a code
+snippet.
@item [fn:name]
A named footnote reference, where @code{name} is a unique label word, or, for
simplicity of automatic creation, a number.
@item [fn:: This is the inline definition of this footnote]
-A LaTeX-like anonymous footnote where the definition is given directly at the
+A La@TeX{}-like anonymous footnote where the definition is given directly at the
reference point.
@item [fn:name: a definition]
An inline definition of a footnote, which also specifies a name for the note.
@code{[fn:name]} to create additional references.
@end table
-Footnote labels can be created automatically, or you create names yourself.
+@vindex org-footnote-auto-label
+Footnote labels can be created automatically, or you can create names yourself.
This is handled by the variable @code{org-footnote-auto-label} and its
corresponding @code{#+STARTUP} keywords, see the docstring of that variable
for details.
When the cursor is on a footnote reference, jump to the definition. When it
is at a definition, jump to the (first) reference.
+@vindex org-footnote-define-inline
+@vindex org-footnote-section
+@vindex org-footnote-auto-adjust
Otherwise, create a new footnote. Depending on the variable
@code{org-footnote-define-inline}@footnote{The corresponding in-buffer
setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
s @r{Sort the footnote definitions by reference sequence. During editing,}
@r{Org makes no effort to sort footnote definitions into a particular}
@r{sequence. If you want them sorted, use this command, which will}
- @r{also move entries according to @code{org-footnote-section}.}
+ @r{also move entries according to @code{org-footnote-section}. Automatic}
+ @r{sorting after each insertion/deletion can be configured using the}
+ @r{variable @code{org-footnote-auto-adjust}.}
+r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
+ @r{after each insertion/deletion can be configured using the variable}
+ @r{@code{org-footnote-auto-adjust}.}
+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}
d @r{Delete the footnote at point, and all definitions of and references}
@r{to it.}
@end example
+Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
+corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
+renumbering and sorting footnotes can be automatic after each insertion or
+deletion.
+
@kindex C-c C-c
@item C-c C-c
If the cursor is on a footnote reference, jump to the definition. If it is a
@kindex C-c C-o
@kindex mouse-1
@kindex mouse-2
-@item C-c C-c @r{or} mouse-1/2
+@item C-c C-o @r{or} mouse-1/2
Footnote labels are also links to the corresponding definition/reference, and
you can use the usual commands to follow these links.
@end table
@cindex minor mode for structure editing
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 Orgstruct mode
-makes this possible. You can always toggle the mode with @kbd{M-x
-orgstruct-mode}. To turn it on by default, for example in Mail mode,
-use
+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:
@lisp
(add-hook 'mail-mode-hook 'turn-on-orgstruct)
+(add-hook 'mail-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 headline of the first line of a list item, most
-structure editing commands will work, even if the same keys normally
-have different functionality in the major mode you are using. If the
-cursor is not in one of those special lines, Orgstruct mode lurks
-silently in the shadow.
+When this mode is active and the cursor is on a line that looks to Org like a
+headline or the first line of a list item, most structure editing commands
+will work, even if the same keys normally have different functionality in the
+major mode you are using. If the cursor is not in one of those special
+lines, Orgstruct mode lurks silently in the shadow. When you use
+@code{orgstruct++-mode}, Org will also export indentation and autofill
+settings into that mode, and detect item context after the first line of an
+item.
@node Tables, Hyperlinks, Document Structure, Top
@chapter Tables
@menu
* Built-in table editor:: Simple tables
-* Narrow columns:: Stop wasting space in tables
+* Column width and alignment:: Overrule the automatic settings
* Column groups:: Grouping to trigger vertical lines
* Orgtbl mode:: The table editor as minor mode
* The spreadsheet:: The table editor has spreadsheet capabilities
-* Org Plot:: Plotting from org tables
+* Org-Plot:: Plotting from org tables
@end menu
-@node Built-in table editor, Narrow columns, Tables, Tables
+@node Built-in table editor, Column width and alignment, Tables, Tables
@section The built-in table editor
@cindex table editor, built-in
fields. Even faster would be to type @code{|Name|Phone|Age} followed by
@kbd{C-c @key{RET}}.
+@vindex org-enable-table-editor
+@vindex org-table-auto-blank-field
When typing text into a field, Org treats @key{DEL},
@key{Backspace}, and all character keys in a special way, so that
inserting and deleting avoids shifting other fields. Also, when
Re-align the table and move down to next row. Creates a new row if
necessary. At the beginning or end of a line, @key{RET} still does
NEWLINE, so it can be used to split a table.
+@c
+@kindex M-a
+@item M-a
+Move to beginning of the current table field, or on to the previous field.
+@kindex M-e
+@item M-e
+Move to end of the current table field, or on to the next field.
@tsubheading{Column and row editing}
@kindex M-@key{left}
@tsubheading{Regions}
@kindex C-c C-x M-w
@item C-c C-x M-w
-Copy a rectangular region from a table to a special clipboard. Point
-and mark determine edge fields of the rectangle. The process ignores
-horizontal separator lines.
+Copy a rectangular region from a table to a special clipboard. Point and
+mark determine edge fields of the rectangle. If there is no active region,
+copy just the current field. The process ignores horizontal separator lines.
@c
@kindex C-c C-x C-w
@item C-c C-x C-w
@cindex calculations, in tables
@cindex region, active
@cindex active region
-@cindex Transient mark mode
+@cindex transient mark mode
@kindex C-c +
@item C-c +
Sum the numbers in the current column, or in the rectangle defined by
@c
@kindex S-@key{RET}
@item S-@key{RET}
+@vindex org-table-copy-increment
When current field is empty, copy from first non-empty field above. When not
empty, copy current field down to next row and move cursor along with it.
Depending on the variable @code{org-table-copy-increment}, integer field
values will be incremented during copy. Integers that are too large will not
be incremented. Also, a @code{0} prefix argument temporarily disables the
-increment. This key is also used by CUA mode (@pxref{Cooperation}).
+increment. This key is also used by shift-selection and related modes
+(@pxref{Conflicts}).
@tsubheading{Miscellaneous}
@kindex C-c `
@item C-c `
-Edit the current field in a separate window. This is useful for fields
-that are not fully visible (@pxref{Narrow columns}). When called with a
-@kbd{C-u} prefix, just make the full field visible, so that it can be
+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.
@c
@item M-x org-table-import
-Import a file as a table. The table should be TAB- or whitespace
-separated. Useful, for example, to import a spreadsheet table or data
+Import a file as a table. The table should be TAB or whitespace
+separated. Use, for example, to import a spreadsheet table or data
from a database, because these programs generally can write
TAB-separated text files. This command works by inserting the file into
the buffer and then converting the region to a table. Any prefix
@kbd{C-c |} command (see above under @i{Creation and conversion}).
@c
@item M-x org-table-export
-Export the table, by default as a TAB-separated file. Useful for data
+@vindex org-table-export-default-format
+Export the table, by default as a TAB-separated file. Use for data
exchange with, for example, spreadsheet or database programs. The format
used to export the file can be configured in the variable
@code{org-table-export-default-format}. You may also use properties
@code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
name and the format for table export in a subtree. Org supports quite
general formats for exported tables. The exporter format is the same as the
-format used by Orgtbl radio tables, see @ref{Translator functions} for a
+format used by Orgtbl radio tables, see @ref{Translator functions}, for a
detailed description.
@end table
@noindent Then the only table command that still works is
@kbd{C-c C-c} to do a manual re-align.
-@node Narrow columns, Column groups, Built-in table editor, Tables
-@section Narrow columns
+@node Column width and alignment, Column groups, Built-in table editor, Tables
+@section Column width and alignment
@cindex narrow columns in tables
+@cindex alignment in tables
+
+The width of columns is automatically determined by the table editor. And
+also the alignment of a column is determined automatically from the fraction
+of number-like versus non-number fields in the column.
-The width of columns is automatically determined by the table editor.
Sometimes a single field or a few fields need to carry more text,
leading to inconveniently wide columns. To limit@footnote{This feature
does not work on XEmacs.} the width of a column, one field anywhere in
@noindent
Fields that are wider become clipped and end in the string @samp{=>}.
Note that the full text is still in the buffer, it is only invisible.
-To see the full text, hold the mouse over the field - a tool-tip window
+To see the full text, hold the mouse over the field---a tool-tip window
will show the full content. To edit such a field, use the command
@kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
open a new window with the full field. Edit it and finish with @kbd{C-c
C-c}.
+@vindex org-startup-align-all-tables
When visiting a file containing a table with narrowed columns, the
necessary character hiding has not yet happened, and the table needs to
be aligned before it looks nice. Setting the option
#+STARTUP: noalign
@end example
-@node Column groups, Orgtbl mode, Narrow columns, Tables
+If you would like to overrule the automatic alignment of number-rich columns
+to the right and of string-rich column to the left, you and use @samp{<r>} or
+@samp{<l>} in a similar fashion. You may also combine alignment and field
+width like this: @samp{<l10>}.
+
+@node Column groups, Orgtbl mode, Column width and alignment, Tables
@section Column groups
@cindex grouping columns in tables
Orgtbl mode, including spreadsheet capabilities. For details, see
@ref{Tables in arbitrary syntax}.
-@node The spreadsheet, Org Plot, Orgtbl mode, Tables
+@node The spreadsheet, Org-Plot, Orgtbl mode, Tables
@section The spreadsheet
@cindex calculations, in tables
@cindex spreadsheet capabilities
@noindent
Org also uses another, more general operator that looks like this:
@example
-@@row$column
+@@@var{row}$@var{column}
@end example
@noindent
-Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
+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{N}, and row numbers relative to the current row like
+@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
+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. Relative row numbers like @samp{-3} will not
-cross hlines if the current line is too close to the hline. Instead,
-the value directly at the hline is used.
+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
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
+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:
@cindex references, named
@cindex name, of column or field
@cindex constants, in calculations
+@cindex #+CONSTANTS
+@vindex org-table-formula-constants
@samp{$name} is interpreted as the name of a column, parameter or
constant. Constants are defined globally through the variable
@code{org-table-formula-constants}, and locally (for the file) through a
@end example
@noindent
+@vindex constants-unit-system
+@pindex constants.el
Also properties (@pxref{Properties and Columns}) can be used as
-constants in table formulas: For a property @samp{:Xyz:} use the name
+constants in table formulas: for a property @samp{:Xyz:} use the name
@samp{$PROP_Xyz}, and the property will be searched in the current
outline entry and in the hierarchy above it. If you have the
@file{constants.el} package, it will also be used to resolve constants,
including natural constants like @samp{$h} for Planck's constant, and
-units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
+units like @samp{$km} for kilometers@footnote{@file{constants.el} can
supply the values of constants in two different unit systems, @code{SI}
and @code{cgs}. Which one is used depends on the value of the variable
@code{constants-unit-system}. You can use the @code{#+STARTUP} options
@cindex references, to a different table
@cindex name, of column or field
@cindex constants, in calculations
+@cindex #+TBLNAME
You may also reference constants, fields and ranges from a different table,
either in the current file or even in a different file. The syntax is
@code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
entry, even in a different file, and the reference then refers to the first
table in that entry. REF is an absolute field or range reference as
-described above, valid in the referenced table.
+described above for example @code{@@3$3} or @code{$somename}, valid in the
+referenced table.
@node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
@subsection Formula syntax for Calc
@cindex format specifier
@cindex mode, for @file{calc}
+@vindex org-calc-default-modes
A formula can contain an optional mode string after a semicolon. This
string consists of flags to influence Calc and other modes during
execution. By default, Org uses the standard Calc modes (precision
12, angular units degrees, fraction and symbolic modes off). The display
-format, however, has been changed to @code{(float 5)} to keep tables
+format, however, has been changed to @code{(float 8)} to keep tables
compact. The default settings can be configured using the variable
@code{org-calc-default-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
@noindent
It is also possible to write a formula in Emacs Lisp; this can be useful
for string manipulation and control structures, if Calc's
-functionality is not enough. If a formula starts with a single quote
-followed by an opening parenthesis, then it is evaluated as a lisp form.
+functionality is not enough. If a formula starts with a single-quote
+followed by an opening parenthesis, then it is evaluated as a Lisp form.
The evaluation should return either a string or a number. Just as with
@file{calc} formulas, you can specify modes and a printf format after a
semicolon. With Emacs Lisp forms, you need to be conscious about the way
field references are interpolated into the form. By default, a
-reference will be interpolated as a Lisp string (in double quotes)
+reference will be interpolated as a Lisp string (in double-quotes)
containing the field. If you provide the @samp{N} mode switch, all
referenced elements will be numbers (non-number fields will be zero) and
interpolated as Lisp numbers, without quotes. If 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
+@Ie{}, 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. A few examples, note how the
-@samp{N} mode is used when we do computations in lisp.
+@samp{N} mode is used when we do computations in Lisp.
@example
@r{Swap the first two characters of the content of column 1}
the field, the formula will be stored as the formula for this field,
evaluated, and the current field replaced with the result.
+@cindex #+TBLFM
Formulas are stored in a special line starting with @samp{#+TBLFM:}
directly below the table. If you typed 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 cause 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
+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
@kindex C-u C-c =
@item C-u C-c =
Install a new formula for the current field. The command prompts for a
-formula, with default taken from the @samp{#+TBLFM:} line, applies
-it to the current field and stores it.
+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
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 to assign a single formula to an entire
+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.
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
-@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 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}.
+@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 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.
Instead of typing an equation into the field, you may also use the
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(@eg @kbd{C-5 C-c =}) the command
will apply it to that many consecutive fields in the current column.
@end table
@cindex formula editing
@cindex editing, of table formulas
+@vindex org-table-use-standard-references
You can edit individual formulas in the minibuffer or directly in the
field. Org can also prepare a special buffer with all active
formulas of a table. When offering a formula for editing, Org
@item C-c =
@itemx C-u C-c =
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 formulas}.
@kindex C-u C-u C-c =
@item C-u C-u C-c =
Re-insert the active formula (either a
@kindex C-c @}
@item C-c @}
Toggle the display of row and column numbers for a table, using
-overlays. These are updated each time the table is aligned, you can
+overlays. These are updated each time the table is aligned; you can
force it with @kbd{C-c C-c}.
@kindex C-c @{
@item C-c @{
@code{B3}) and internal (like @code{@@3$2}).
@kindex @key{TAB}
@item @key{TAB}
-Pretty-print or indent lisp formula at point. When in a line containing
-a lisp formula, format the formula according to Emacs Lisp rules.
+Pretty-print or indent Lisp formula at point. When in a line containing
+a Lisp formula, format the formula according to Emacs Lisp rules.
Another @key{TAB} collapses the formula back again. In the open
-formula, @key{TAB} re-indents just like in Emacs lisp mode.
+formula, @key{TAB} re-indents just like in Emacs Lisp mode.
@kindex M-@key{TAB}
@item M-@key{TAB}
-Complete Lisp symbols, just like in Emacs lisp mode.
+Complete Lisp symbols, just like in Emacs Lisp mode.
@kindex S-@key{up}
@kindex S-@key{down}
@kindex S-@key{left}
@item S-@key{up}/@key{down}/@key{left}/@key{right}
Shift the reference at point. For example, if the reference is
@code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
-This also works for relative references, and for hline references.
+This also works for relative references and for hline references.
@kindex M-S-@key{up}
@kindex M-S-@key{down}
@item M-S-@key{up}/@key{down}
@end table
Making a table field blank does not remove the formula associated with
-the field, because that is stored in a different line (the @samp{TBLFM}
-line) - during the next recalculation the field will be filled again.
+the field, because that is stored in a different line (the @samp{#+TBLFM}
+line)---during the next recalculation the field will be filled again.
To remove a formula from a field, you have to give an empty reply when
prompted for the formula, or to edit the @samp{#+TBLFM} line.
@kindex C-c C-c
You may edit the @samp{#+TBLFM} directly and re-apply the changed
-equations with @kbd{C-c C-c} in that line, or with the normal
+equations with @kbd{C-c C-c} in that line or with the normal
recalculation commands in the table.
@subsubheading Debugging formulas
@cindex updating, table
Recalculation of a table is normally not automatic, but needs to be
-triggered by a command. See @ref{Advanced features} for a way to make
-recalculation at least semi-automatically.
+triggered by a command. See @ref{Advanced features}, for a way to make
+recalculation at least semi-automatic.
In order to recalculate a line of a table or the entire table, use the
following commands:
@end group
@end example
-@noindent @b{Important}: Please note that for these special tables,
+@noindent @b{Important}: please note that for these special tables,
recalculating the table with @kbd{C-u C-c *} will only affect rows that
are marked @samp{#} or @samp{*}, and fields that have a formula assigned
to the field itself. The column formulas are not applied in rows with
@samp{<N>} markers.
@end table
-Finally, just to whet your appetite on what can be done with the
-fantastic @file{calc} package, here is a table that computes the Taylor
+Finally, just to whet your appetite for what can be done with the
+fantastic @file{calc.el} package, here is a table that computes the Taylor
series of degree @code{n} at location @code{x} for a couple of
functions.
@end group
@end example
-@page
-@node Org Plot, , The spreadsheet, Tables
-@section Org Plot
+@node Org-Plot, , The spreadsheet, Tables
+@section Org-Plot
@cindex graph, in tables
@cindex plot tables using gnuplot
+@cindex #+PLOT
-Org Plot can produce 2D and 3D graphs of information stored in org tables
+Org-Plot can produce 2D and 3D graphs of information stored in org tables
using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
@uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
-this in action ensure that you have both Gnuplot and Gnuplot-mode installed
+this in action, ensure that you have both Gnuplot and Gnuplot mode installed
on your system, then call @code{org-plot/gnuplot} on the following table.
@example
@end group
@end example
-Notice that Org Plot is smart enough to apply the tables headers as labels.
+Notice that Org Plot is smart enough to apply the table's headers as labels.
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
+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}.
@subsubheading Plot Options
@table @code
@item set
-Specify any @file{gnuplot} option to be set when graphing.
+Specify any @command{gnuplot} option to be set when graphing.
@item title
Specify the title of the plot.
Specify which column of the table to use as the @code{x} axis.
@item deps
-Specify the columns to graph as a lisp style list, surrounded by parenthesis
+Specify the columns to graph as a Lisp style list, surrounded by parentheses
and separated by spaces for example @code{dep:(3 4)} to graph the third and
-fourth columns (defaults to graphing all other columns aside from the ind
+fourth columns (defaults to graphing all other columns aside from the @code{ind}
column).
@item type
@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...).
+(@eg @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
Defaults to @code{lines}.
@item file
-If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
+If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
@item labels
-List of labels to be used for the deps (defaults to column headers if they
-exist).
+List of labels to be used for the deps (defaults to the column headers if
+they exist).
@item line
-Specify an entire line to be inserted in the gnuplot script.
+Specify an entire line to be inserted in the Gnuplot script.
@item map
When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
flat mapping rather than a @code{3d} slope.
@item timefmt
-Specify format of org-mode timestamps as they will be parsed by gnuplot.
+Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
@item script
-If you want total control you can specify a script file (place the file name
-between double quotes) which will be used to plot. Before plotting, every
+If you want total control, you can specify a script file (place the file name
+between double-quotes) which will be used to plot. Before plotting, every
instance of @code{$datafile} in the specified script will be replaced with
-the path to the generated data file. Note even if you set this option you
+the path to the generated data file. Note: even if you set this option, you
may still want to specify the plot type, as that can impact the content of
the data file.
@end table
[[link][description]] @r{or alternatively} [[link]]
@end example
+@noindent
Once a link in the buffer is complete (all brackets present), Org
will change the display so that @samp{description} is displayed instead
of @samp{[[link][description]]} and @samp{link} is displayed instead of
@cindex links, internal
@cindex targets, for links
-If the link does not look like a URL, it is considered to be internal in
-the current file. Links such as @samp{[[My Target]]} or @samp{[[My
-Target][Find my target]]} lead to a text search in the current file.
-The link can be followed with @kbd{C-c C-o} when the cursor is on the
-link, or with a mouse click (@pxref{Handling links}). The preferred
-match for such a link is a 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
+@cindex property, CUSTOM_ID
+If the link does not look like a URL, it is considered to be internal in the
+current file. The most important case is a link like
+@samp{[[#my-custom-id]]} which will link to the entry with the
+@code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
+for HTML export (@pxref{HTML export}) where they produce pretty section
+links. You are responsible yourself to make sure these custom IDs are unique
+in a file.
+
+Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
+lead to a text search in the current file.
+
+The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
+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
@example
# <<My Target>>
target should be after the first headline, or in the line directly before the
first headline.}.
-If no dedicated target exists, Org will search for the words in the
-link. In the above example the search would be for @samp{my target}.
-Links starting with a star like @samp{*My Target} restrict the search to
-headlines. When searching, Org mode will first try an exact match, but
-then move on to more and more lenient searches. For example, the link
-@samp{[[*My Targets]]} will find any of the following:
+If no dedicated target exists, Org will search for the words in the link. In
+the above example the search would be for @samp{my target}. Links starting
+with a star like @samp{*My Target} restrict the search to
+headlines@footnote{To insert a link targeting a headline, in-buffer
+completion can be used. Just type a star followed by a few optional letters
+into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current
+buffer will be offered as completions. @xref{Handling links}, for more
+commands creating links.}. When searching, Org mode will first try an
+exact match, but then move on to more and more lenient searches. For
+example, the link @samp{[[*My Targets]]} will find any of the following:
@example
** My targets
** my 20 targets are
@end example
-To insert a link targeting a headline, in-buffer completion can be used.
-Just type a star followed by a few optional letters into the buffer and
-press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
-offered as completions. @xref{Handling links}, for more commands
-creating links.
Following a link pushes a mark onto Org's own mark ring. You can
return to the previous position with @kbd{C-c &}. Using this command
@cindex USENET links
@cindex SHELL links
@cindex Info links
-@cindex elisp links
+@cindex Elisp links
Org supports links to files, websites, Usenet and email messages,
BBDB database entries and links to both IRC conversations and their
/home/dominik/images/jupiter.jpg @r{same as above}
file:papers/last.pdf @r{file, relative path}
./papers/last.pdf @r{same as above}
-file:projects.org @r{another org file}
-file:projects.org::some words @r{text search in org file}
-file:projects.org::*task title @r{heading search in org file}
+file:projects.org @r{another Org file}
+file:projects.org::some words @r{text search in Org file}
+file:projects.org::*task title @r{heading search in Org file}
id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
news:comp.emacs @r{Usenet link}
mailto:adent@@galaxy.net @r{Mail link}
bbdb:R.*Stallman @r{BBDB link (with regexp)}
irc:/irc.com/#emacs/bob @r{IRC link}
shell:ls *.org @r{A shell command}
-elisp:org-agenda @r{Interactive elisp command}
+elisp:org-agenda @r{Interactive Elisp command}
elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
@end example
image,
that image will be inlined into the exported HTML file.
-@cindex angular brackets, around links
+@cindex square brackets, around links
@cindex plain text external links
Org also finds external links in the normal text and activates them
as links. If spaces must be part of the link (for example in
@samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
-about the end of the link, enclose them in angular brackets.
+about the end of the link, enclose them in square brackets.
@node Handling links, Using links outside Org, External links, Hyperlinks
@section Handling links
Store a link to the current location. This is a @emph{global} command (you
must create the key binding yourself) which can be used in any buffer to
create a link. The link will be stored for later insertion into an Org
-buffer (see below).
+buffer (see below). What kind of link will be created depends on the current
+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, either by text
-(unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id}
-is set, by ID property.
-
-For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will
-indicate the current article/entry. For W3 and W3M buffers, the link goes to
-the current URL. For IRC links, if you set the variable
-@code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a
-@samp{file:/} style link to the relevant point in the logs for the current
-conversation. Otherwise an @samp{irc:/} style link to the user/channel/server
-under the point will be stored.
-
+to the target. Otherwise it points to the current headline, which will also
+be the description.
+
+@vindex org-link-to-org-use-id
+@cindex property, CUSTOM_ID
+@cindex property, ID
+If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
+will be stored. In addition or alternatively (depending on the value of
+@code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
+created and/or used to construct a link. So using this command in Org
+buffers will potentially create two links: a human-readable from the custom
+ID, and one that is globally unique and works even if the entry is moved from
+file to file. Later, when inserting the link, you need to decide which one
+to use.
+
+@b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
+Pretty much all Emacs mail clients are supported. The link will point to the
+current article, or, in some GNUS buffers, to the group. The description is
+constructed from the author and the subject.
+
+@b{Web browsers: W3 and W3M}@*
+Here the link will be the current URL, with the page title as description.
+
+@b{Contacts: BBDB}@*
+Links created in a BBDB buffer will point to the current entry.
+
+@b{Chat: IRC}@*
+@vindex org-irc-link-to-logs
+For IRC links, if you set the variable @code{org-irc-link-to-logs} to
+@code{t}, a @samp{file:/} style link to the relevant point in the logs for
+the current conversation is created. Otherwise an @samp{irc:/} style link to
+the user/channel/server under the point will be stored.
+
+@b{Other files}@*
For any other files, the link will point to the file, with a search string
(@pxref{Search options}) pointing to the contents of the current line. If
there is an active region, the selected words will form the basis of the
search string. If the automatically created link is not working correctly or
accurately enough, you can write custom functions to select the search string
-and to do the search for particular file types - see @ref{Custom searches}.
-The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}.
+and to do the search for particular file types---see @ref{Custom searches}.
+The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
@c
@kindex C-c C-l
@cindex link completion
@cindex completion, of links
@cindex inserting links
@item C-c C-l
-Insert a link. This prompts for a link to be inserted into the buffer. You
-can just type a link, using text for an internal link, or one of the link
-type prefixes mentioned in the examples above. All links stored during the
-current session are part of the history for this prompt, so you can access
-them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
-hand, will help you to insert valid link prefixes like @samp{http:} or
-@samp{ftp:}, including the prefixes defined through link abbreviations
-(@pxref{Link abbreviations}). The link will be inserted into the
-buffer@footnote{After insertion of a stored link, the link will be removed
-from the list of stored links. To keep it in the list later use, use a
-triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
+@vindex org-keep-stored-link-after-insertion
+Insert a link@footnote{ Note that you don't have to use this command to
+insert a link. Links in Org are plain text, and you can type or paste them
+straight into the buffer. By using this command, the links are automatically
+enclosed in double brackets, and you will be asked for the optional
+descriptive text.}. This prompts for a link to be inserted into the buffer.
+You can just type a link, using text for an internal link, or one of the link
+type prefixes mentioned in the examples above. The link will be inserted
+into the buffer@footnote{After insertion of a stored link, the link will be
+removed from the list of stored links. To keep it in the list later use, use
+a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
@code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
If some text was selected when this command is called, the selected text
-becomes the default description.@* Note that you don't have to use this
-command to insert a link. Links in Org are plain text, and you can type
-or paste them straight into the buffer. By using this command, the links are
-automatically enclosed in double brackets, and you will be asked for the
-optional descriptive text.
-@c
-@c If the link is a @samp{file:} link and
-@c the linked file is located in the same directory as the current file or
-@c a subdirectory of it, the path of the file will be inserted relative to
-@c the current directory.
-@c
+becomes the default description.
+
+@b{Inserting stored links}@*
+All links stored during the
+current session are part of the history for this prompt, so you can access
+them with @key{up} and @key{down} (or @kbd{M-p/n}).
+
+@b{Completion support}@* Completion with @key{TAB} will help you to insert
+valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
+defined through link abbreviations (@pxref{Link abbreviations}). If you
+press @key{RET} after inserting only the @var{prefix}, Org will offer
+specific completion support for some link types@footnote{This works by
+calling a special function @code{org-PREFIX-complete-link}.} For
+example, if you type @kbd{file @key{RET}}, file name completion (alternative
+access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
+@key{RET}} you can complete contact names.
@kindex C-u C-c C-l
@cindex file name completion
@cindex completion, of file names
When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
a file will be inserted and you may use file name completion to select
the name of the file. The path to the file is inserted relative to the
-directory of the current org file, if the linked file is in the current
+directory of the current Org file, if the linked file is in the current
directory or in a sub-directory of it, or if the path is written relative
to the current directory using @samp{../}. Otherwise an absolute path
is used, if possible with @samp{~/} for your home directory. You can
@cindex following links
@kindex C-c C-o
@kindex RET
-@item C-c C-o
+@item C-c C-o @r{or} @key{RET}
+@vindex org-file-apps
Open link at point. This will launch a web browser for URLs (using
@command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
the corresponding links, and execute the command in a shell link. When the
cursor is on an internal link, this commands runs the corresponding search.
When the cursor is on a TAG list in a headline, it creates the corresponding
-TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
+TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
date. Furthermore, it will visit text and remote files in @samp{file:} links
with Emacs and select a suitable application for local non-text files.
Classification of files is based on file extension only. See option
@item mouse-2
@itemx mouse-1
On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
-would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
+would. Under Emacs 22, @kbd{mouse-1} will also follow a link.
@c
@kindex mouse-3
@item mouse-3
+@vindex org-display-internal-link-with-indirect-buffer
Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
internal links to be displayed in another window@footnote{See the
variable @code{org-display-internal-link-with-indirect-buffer}}.
@end example
@noindent
-where the tag is optional. Such abbreviations are resolved according to
-the information in the variable @code{org-link-abbrev-alist} that
-relates the linkwords to replacement text. Here is an example:
+@vindex org-link-abbrev-alist
+where the tag is optional. The @i{linkword} must be a word; letter, numbers,
+@samp{-}, and @samp{_} are allowed here. Abbreviations are resolved
+according to the information in the variable @code{org-link-abbrev-alist}
+that relates the linkwords to replacement text. Here is an example:
@lisp
@group
If you need special abbreviations just for a single Org buffer, you
can define them in the file with
+@cindex #+LINK
@example
#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
#+LINK: google http://www.google.com/search?q=%s
@end example
@noindent
-In-buffer completion @pxref{Completion} can be used after @samp{[} to
-complete link abbreviations.
+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 (@eg 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.
@node Search options, Custom searches, Link abbreviations, Hyperlinks
@section Search options in file links
The default mechanism for creating search strings and for doing the
actual search related to a file link may not work correctly in all
-cases. For example, BibTeX database files have many entries like
+cases. For example, Bib@TeX{} database files have many entries like
@samp{year="1993"} which would not result in good search strings,
-because the only unique identification for a BibTeX entry is the
+because the only unique identification for a Bib@TeX{} entry is the
citation key.
+@vindex org-create-file-search-functions
+@vindex org-execute-file-search-functions
If you come across such a problem, you can write custom functions to set
the right search string for a particular file type, and to do the search
for the string in the file. Using @code{add-hook}, these functions need
@item C-u C-c C-t
Select a specific keyword using completion or (if it has been set up)
the fast selection interface. For the latter, you need to assign keys
-to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
+to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
more information.
@kindex S-@key{right}
@kindex S-@key{left}
+@vindex org-treat-S-cursor-todo-selection-as-state-change
@item S-@key{right}
@itemx S-@key{left}
Select the following/preceding TODO state, similar to cycling. Useful
mostly if more than two TODO states are possible (@pxref{TODO
-extensions}). See also @ref{Conflicts} for a discussion of the interaction
-with @code{shift-selection-mode}.
+extensions}). See also @ref{Conflicts}, for a discussion of the interaction
+with @code{shift-selection-mode}. See also the variable
+@code{org-treat-S-cursor-todo-selection-as-state-change}.
@kindex C-c C-v
@kindex C-c / t
@cindex sparse tree, for TODO
@item C-c C-v
@itemx C-c / t
-View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
-the entire buffer, but shows all TODO items and the headings hierarchy
-above them. With a prefix argument, search for a specific TODO. You will be
+@vindex org-todo-keywords
+View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
+entire buffer, but shows all TODO items and the headings hierarchy above
+them. With a prefix argument, 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|...}. With 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 and DONE entries.
+@code{KWD1|KWD2|...} to list entries that match any one of these keywords.
+With 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
+and DONE entries.
@kindex C-c a t
@item C-c a t
Show the global TODO list. Collects the TODO items from all agenda
@end table
@noindent
+@vindex org-todo-state-tags-triggers
Changing a TODO state can also trigger tag changes. See the docstring of the
option @code{org-todo-state-tags-triggers} for details.
@section Extended use of TODO keywords
@cindex extended TODO keywords
+@vindex org-todo-keywords
By default, marked TODO entries have one of only two states: TODO and
DONE. Org mode allows you to classify TODO items in more complex ways
with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
(@pxref{Completion}) or even a special one-key selection scheme
(@pxref{Fast access to TODO states}) to insert these words into the
buffer. Changing a TODO state can be logged with a timestamp, see
-@ref{Tracking TODO state changes} for more information.
+@ref{Tracking TODO state changes}, for more information.
@node TODO types, Multiple sets in one file, Workflow states, TODO extensions
@subsection TODO keywords as types
@kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
from @code{DONE} to @code{REPORT} in the example above. See also
-@ref{Conflicts} for a discussion of the interaction with
+@ref{Conflicts}, for a discussion of the interaction with
@code{shift-selection-mode}.
@end table
If you would like to quickly change an entry to an arbitrary TODO state
instead of cycling through the states, you can set up keys for
single-letter access to the states. This is done by adding the section
-key after each keyword, in parenthesis. For example:
+key after each keyword, in parentheses. For example:
@lisp
(setq org-todo-keywords
(sequence "|" "CANCELED(c)")))
@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
keyword from an entry.@footnote{Check also the variable
-@code{org-fast-tag-selection-include-todo}, it allows to change the TODO
+@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
mingle the two concepts. Note that this means you need to come up with
unique keys across both sets of keywords.}
@subsection Setting up keywords for individual files
@cindex keyword options
@cindex per-file keywords
+@cindex #+TODO
+@cindex #+TYP_TODO
+@cindex #+SEQ_TODO
It can be very useful to use different aspects of the TODO mechanism in
different files. For file-local settings, you need to add special lines
file:
@example
-#+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
+#+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
@end example
-or
+@noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
+interpretation, but it means the same as @code{#+TODO}), or
@example
#+TYP_TODO: Fred Sara Lucy Mike | DONE
@end example
A setup for using several sets in parallel would be:
@example
-#+SEQ_TODO: TODO | DONE
-#+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
-#+SEQ_TODO: | CANCELED
+#+TODO: TODO | DONE
+#+TODO: REPORT BUG KNOWNCAUSE | FIXED
+#+TODO: | CANCELED
@end example
@cindex completion, of option keywords
@subsection Faces for TODO keywords
@cindex faces, for TODO keywords
+@vindex org-todo @r{(face)}
+@vindex org-done @r{(face)}
+@vindex org-todo-keyword-faces
Org mode highlights TODO keywords with special faces: @code{org-todo}
for keywords indicating that an item still has to be acted upon, and
@code{org-done} for keywords indicating that an item is finished. If
@cindex TODO dependencies
@cindex dependencies, of TODO states
+@vindex org-enforce-todo-dependencies
+@cindex property, ORDERED
The structure of Org files (hierarchy and lists) makes it easy to define TODO
dependencies. Usually, a parent TODO task should not be marked DONE until
all subtasks (defined as children tasks) are marked as DONE. And sometimes
@table @kbd
@kindex C-c C-x o
@item C-c C-x o
-Toggle the @code{ORDERED} property of the current entry.
+@vindex org-track-ordered-property-with-tag
+@cindex property, ORDERED
+Toggle the @code{ORDERED} property of the current entry. A property is used
+for this behavior because this should be local to the current entry, not
+inherited like a tag. However, if you would like to @i{track} the value of
+this property with a tag for better visibility, customize the variable
+@code{org-track-ordered-property-with-tag}.
@kindex C-u C-u C-u C-c C-t
@item C-u C-u C-u C-c C-t
-Change TODO state, circumventin any state blocking.
+Change TODO state, circumventing any state blocking.
@end table
+@vindex org-agenda-dim-blocked-tasks
If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
that cannot be closed because of such dependencies will be shown in a dimmed
font or even made invisible in agenda views (@pxref{Agenda Views}).
@cindex checkboxes and TODO dependencies
+@vindex org-enforce-todo-dependencies
You can also block changes of TODO states by looking at checkboxes
(@pxref{Checkboxes}). If you set the variable
@code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
@cindex progress logging
@cindex logging, of progress
-Org mode can automatically record a time stamp and possibly a note when
+Org mode can automatically record a timestamp and possibly a note when
you mark a TODO item as DONE, or even each time you change the state of
a TODO item. This system is highly configurable, settings can be on a
per-keyword basis and can be localized to a file or even a subtree. For
@node Tracking TODO state changes, , Closing items, Progress logging
@subsection Tracking TODO state changes
-
-When TODO keywords are used as workflow states (@pxref{Workflow
-states}), you might want to keep track of when a state change occurred
-and maybe take a note about this change. Since it is normally too much
-to record a note for every state, Org mode expects configuration on a
-per-keyword basis for this. This is achieved by adding special markers
-@samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
-after each keyword. For example, with the setting
+@cindex drawer, for state change recording
+
+@vindex org-log-states-order-reversed
+@vindex org-log-into-drawer
+@cindex property, LOG_INTO_DRAWER
+When TODO keywords are used as workflow states (@pxref{Workflow states}), you
+might want to keep track of when a state change occurred and maybe take a
+note about this change. You can either record just a timestamp, or a
+time-stamped note for a change. These records will be inserted after the
+headline as an itemized list, newest first@footnote{See the variable
+@code{org-log-states-order-reversed}}. When taking a lot of notes, you might
+want to get the notes out of the way into a drawer (@pxref{Drawers}).
+Customize the variable @code{org-log-into-drawer} to get this
+behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
+also overrule the setting of this variable for a subtree by setting a
+@code{LOG_INTO_DRAWER} property.
+
+Since it is normally too much to record a note for every state, Org mode
+expects configuration on a per-keyword basis for this. This is achieved by
+adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
+in parentheses after each keyword. For example, with the setting
@lisp
(setq org-todo-keywords
@end lisp
@noindent
+@vindex org-log-done
you not only define global TODO keywords and fast access keys, but also
-request that a time is recorded when the entry is turned into
-DONE@footnote{It is possible that Org mode will record two time stamps
+request that a time is recorded when the entry is set to
+DONE@footnote{It is possible that Org mode will record two timestamps
when you are using both @code{org-log-done} and state change logging.
-However, it will never prompt for two notes - if you have configured
+However, it will never prompt for two notes---if you have configured
both, the state change recording note will take precedence and cancel
the @samp{Closing Note}.}, and that a note is recorded when switching to
-WAIT or CANCELED. The setting for WAIT is even more special: The
+WAIT or CANCELED. The setting for WAIT is even more special: the
@samp{!} after the slash means that in addition to the note taken when
-entering the state, a time stamp should be recorded when @i{leaving} the
+entering the state, a timestamp should be recorded when @i{leaving} the
WAIT state, if and only if the @i{target} state does not configure
logging for entering it. So it has no effect when switching from WAIT
to DONE, because DONE is configured to record a timestamp only. But
You can use the exact same syntax for setting logging preferences local
to a buffer:
@example
-#+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
+#+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
@end example
+@cindex property, LOGGING
In order to define logging settings that are local to a subtree or a
single item, define a LOGGING property in this entry. Any non-empty
LOGGING property resets all logging settings to nil. You may then turn
@kindex S-@key{down}
@item S-@key{up}
@itemx S-@key{down}
+@vindex org-priority-start-cycle-with-default
Increase/decrease priority of current headline@footnote{See also the option
-@code{org-priority-start-cycle-with-default'}.}. Note that these keys are
-also used to modify time stamps (@pxref{Creating timestamps}). See also
-@ref{Conflicts} for a discussion of the interaction with
+@code{org-priority-start-cycle-with-default}.}. Note that these keys are
+also used to modify timestamps (@pxref{Creating timestamps}). See also
+@ref{Conflicts}, for a discussion of the interaction with
@code{shift-selection-mode}.
@end table
+@vindex org-highest-priority
+@vindex org-lowest-priority
+@vindex org-default-priority
You can change the range of allowed priorities by setting the variables
@code{org-highest-priority}, @code{org-lowest-priority}, and
@code{org-default-priority}. For an individual buffer, you may set
the highest priority is earlier in the alphabet than the lowest
priority):
+@cindex #+PRIORITIES
@example
#+PRIORITIES: A C B
@end example
@section Breaking tasks down into subtasks
@cindex tasks, breaking down
+@vindex org-agenda-todo-list-sublevels
It is often advisable to break down large tasks into smaller, manageable
subtasks. You can do this by creating an outline tree below a TODO item,
with detailed subtasks on the tree@footnote{To keep subtasks out of the
** DONE Talk to neighbor
@end example
-If you would like a TODO entry to automatically change to DONE when all
-children are done, you can use the following setup:
+@cindex property, COOKIE_DATA
+If a heading has both checkboxes and TODO children below it, the meaning of
+the statistics cookie become ambiguous. Set the property
+@code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
+this issue.
+
+If you would like a TODO entry to automatically change to DONE
+when all children are done, you can use the following setup:
@example
(defun org-summary-todo (n-done n-not-done)
@cindex statistics, for checkboxes
@cindex checkbox statistics
-The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
-cookies indicating how many checkboxes present in this entry have been
-checked off, and the total number of checkboxes are present. This can
-give you an idea on how many checkboxes remain, even without opening a
-folded entry. The cookies can be placed into a headline or into (the
-first line of) a plain list item. Each cookie covers all checkboxes
-structurally below the headline/item on which the cookie appear. 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 the
-percentage of checkboxes checked (in the above example, this would be
-@samp{[50%]} and @samp{[33%]}, respectively).
+@cindex property, COOKIE_DATA
+The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
+indicating how many checkboxes present in this entry have been checked off,
+and the total number of checkboxes present. This can give you an idea on how
+many checkboxes remain, even without opening a folded entry. The cookies can
+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-recursive-checkbox-statistics} if you want such cookies to
+represent the all checkboxes below the cookie, not just the 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
+the percentage of checkboxes checked (in the above example, this would be
+@samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
+count either checkboxes below the heading or TODO states of children, and it
+will display whatever was changed last. Set the property @code{COOKIE_DATA}
+to either @samp{checkbox} or @samp{todo} to resolve this issue.
+
+@cindex blocking, of checkboxes
+@cindex checkbox blocking
+@cindex property, ORDERED
+If the current outline node has an @code{ORDERED} property, checkboxes must
+be checked off in sequence, and an error will be thrown if you try to check
+off a box while there are unchecked boxes above it.
@noindent The following commands work with checkboxes:
@table @kbd
@kindex C-c C-c
@item C-c C-c
-Toggle checkbox at point. With a prefix argument, set it to @samp{[-]},
-which is considered to be an intermediate state.
+Toggle checkbox status or (with prefix arg) checkbox presence at point. With
+double prefix argument, set it to @samp{[-]}, which is considered to be an
+intermediate state.
@kindex C-c C-x C-b
@item C-c C-x C-b
-Toggle checkbox status or (with prefix arg) checkbox presence at point.
+Toggle checkbox status or (with prefix arg) checkbox presence at point. With
+double prefix argument, set it to @samp{[-]}, which is considered to be an
+intermediate state.
@itemize @minus
@item
If there is an active region, toggle the first checkbox in the region
Insert a new item with a checkbox.
This works only if the cursor is already in a plain list item
(@pxref{Plain lists}).
+@kindex C-c C-x o
+@item C-c C-x o
+@vindex org-track-ordered-property-with-tag
+@cindex property, ORDERED
+Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
+be checked off in sequence. A property is used for this behavior because
+this should be local to the current entry, not inherited like a tag.
+However, if you would like to @i{track} the value of this property with a tag
+for better visibility, customize the variable
+@code{org-track-ordered-property-with-tag}.
@kindex C-c #
@item C-c #
Update the checkbox statistics in the current outline entry. When
information is to assign @i{tags} to headlines. Org mode has extensive
support for tags.
+@vindex org-tag-faces
Every headline can contain a list of tags; they occur at the end of the
headline. Tags are normal words containing letters, numbers, @samp{_}, and
-@samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
+@samp{@@}. Tags must be preceded and followed by a single colon, @eg{},
@samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
-Tags will by default get a bold face with the same color as the headline.
+Tags will by default be in bold face with the same color as the headline.
You may specify special faces for specific tags using the variable
-@code{org-tag-faces}, much in the same way as you can do for TODO keywords
+@code{org-tag-faces}, in much the same way as you can for TODO keywords
(@pxref{Faces for TODO keywords}).
@menu
the final heading will have the tags @samp{:work:}, @samp{:boss:},
@samp{:notes:}, and @samp{:action:} even though the final heading is not
explicitly marked with those tags. You can also set tags that all entries in
-a file should inherit as if these tags would be defined in a hypothetical
+a file should inherit just as if these tags were defined in a hypothetical
level zero that surrounds the entire file.
+@cindex #+FILETAGS
@example
#+FILETAGS: :Peter:Boss:Secret:
@end example
@noindent
+@vindex org-use-tag-inheritance
+@vindex org-tags-exclude-from-inheritance
To limit tag inheritance to specific tags, or to turn it off entirely, use
the variables @code{org-use-tag-inheritance} and
@code{org-tags-exclude-from-inheritance}.
+@vindex org-tags-match-list-sublevels
When a headline matches during a tags search while tag inheritance is turned
on, all the sublevels in the same tree will (for a simple match form) match
as well@footnote{This is only true if the search does not involve more
@kindex C-c C-q
@item C-c C-q
@cindex completion, of tags
+@vindex org-tags-column
Enter new tags for the current headline. Org mode will either offer
completion or a special single-key interface for setting tags, see
below. After pressing @key{RET}, the tags will be inserted and aligned
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
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
the default tags for a given file with lines like
+@cindex #+TAGS
@example
#+TAGS: @@work @@home @@tennisclub
#+TAGS: laptop car pc sailboat
#+TAGS:
@end example
+@vindex org-tag-persistent-alist
+If you have a preferred set of tags that you would like to use in every file,
+in addition to those defined on a per-file basis by TAGS option lines, then
+you may specify a list of tags with the variable
+@code{org-tag-persistent-alist}. You may turn this off on a per-file basis
+by adding a STARTUP option line to that file:
+
+@example
+#+STARTUP: noptag
+@end example
+
By default Org mode uses the standard minibuffer completion facilities for
entering tags. However, it also implements another, quicker, tag selection
method called @emph{fast tag selection}. This allows you to select and
(setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
@end lisp
-@noindent If the tag is only relevant to the file you are working on then you
-can, instead, set the TAGS option line as:
+@noindent If the tag is only relevant to the file you are working on, then you
+can instead set the TAGS option line as:
@example
#+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
@end example
+@noindent The tags interface will show the available tags in a splash
+window. If you want to start a new line after a specific tag, insert
+@samp{\n} into the tag list
+
+@example
+#+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
+@end example
+
+@noindent or write them in two lines:
+
+@example
+#+TAGS: @@work(w) @@home(h) @@tennisclub(t)
+#+TAGS: laptop(l) pc(p)
+@end example
+
@noindent
-You can also group together tags that are mutually exclusive. By using
+You can also group together tags that are mutually exclusive by using
braces, as in:
@example
these lines to activate any changes.
@noindent
-To set these mutually exclusive groups in the variable @code{org-mode-alist}
+To set these mutually exclusive groups in the variable @code{org-tags-alist},
you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
-of the braces. The previous example would be set globally by the following
+of the braces. Similarly, you can use @code{:newline} to indicate a line
+break. The previous example would be set globally by the following
configuration:
@lisp
@samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
@key{RET} @key{RET}}.
-If you find that most of the time, you need only a single key press to
+@vindex org-fast-tag-selection-single-key
+If you find that most of the time you need only a single key press to
modify your list of tags, set the variable
@code{org-fast-tag-selection-single-key}. Then you no longer have to
-press @key{RET} to exit fast tag selection - it will immediately exit
+press @key{RET} to exit fast tag selection---it will immediately exit
after the first change. If you then occasionally need more keys, press
@kbd{C-c} to turn off auto-exit for the current tag selection process
(in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
@table @kbd
@kindex C-c \
-@kindex C-c / T
+@kindex C-c / m
@item C-c \
-@itemx C-c / T
+@itemx C-c / m
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.
@kindex C-c a m
@xref{Matching tags and properties}.
@kindex C-c a M
@item C-c a M
+@vindex org-tags-match-list-sublevels
Create a global list of tag matches from all agenda files, but check
only TODO items and force checking subitems (see variable
@code{org-tags-match-list-sublevels}).
@end table
-@cindex Boolean logic, for tag searches
-A @i{tags} search string can use Boolean operators @samp{&} for AND and
-@samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
-Parenthesis are currently not implemented. A tag may also be preceded
-by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
-positive selection. The AND operator @samp{&} is optional when @samp{+}
-or @samp{-} is present. Examples:
-
-@table @samp
-@item +work-boss
-Select headlines tagged @samp{:work:}, but discard those also tagged
-@samp{:boss:}.
-@item work|laptop
-Selects lines tagged @samp{:work:} or @samp{:laptop:}.
-@item work|laptop&night
-Like before, but require the @samp{:laptop:} lines to be tagged also
-@samp{:night:}.
-@end table
-
-@cindex TODO keyword matching, with tags search
-You may also test for TODO keywords (@pxref{TODO extensions}) and properties
-(@pxref{Properties and Columns}) at the same time as matching tags. For a
-guide on how to match properties, see @ref{Property searches}. To match a
-specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one
-of the terms in a tags search.
-
-There is also the possibility to end the tags part of the match (which may
-include several terms connected with @samp{|}) with a @samp{/} and then
-specify a Boolean expression just for TODO keywords. The syntax is then
-similar to the tag matches, but should be applied with consideration: For
-example, a positive selection on several TODO keywords can not meaningfully
-be combined with boolean AND. However, @emph{negative selection} combined
-with AND can be meaningful. To make sure that only lines are checked that
-actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M},
-or equivalently start the TODO part after the slash with @samp{!}. Examples:
-
-@table @samp
-@item work+TODO="WAITING"
-Select @samp{:work:}-tagged TODO lines with the specific TODO
-keyword @samp{WAITING}.
-@item work+TODO="WAITING"|home+TODO="WAITING"
-Waiting tasks both at work and at home.
-@item work/WAITING
-Same as the first example.
-@item work/!-WAITING-NEXT
-Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
-nor @samp{NEXT}
-@item work/!+WAITING|+NEXT
-Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
-@samp{NEXT}.
-@end table
-
-@cindex regular expressions, with tags search
-Any element of the tag/todo match can be a regular expression - in this
-case it must be enclosed in curly braces. For example,
-@samp{work+@{^boss.*@}} matches headlines that contain the tag
-@samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a
-regular expression in @samp{TODO=@{^W@}} which would match TODO keywords
-starting with the letter @samp{W}.
-
-@cindex level, require for tags/property match
-@cindex category, require for tags/property match
-You can also require a headline to be of a certain level or category, by
-writing instead of any TAG an expression like @samp{LEVEL=3} or
-@samp{CATEGORY="work"}, respectively. For example, a search
-@samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
-tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
+These commands all prompt for a match string which allows basic Boolean logic
+like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
+@samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
+which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
+string is rich and allows also matching against TODO keywords, entry levels
+and properties. For a complete description with many examples, see
+@ref{Matching tags and properties}.
-Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
-other properties will slow down the search.
@node Properties and Columns, Dates and Times, Tags, Top
@chapter Properties and Columns
are like tags, but with a value. Second, you can use properties to
implement (very basic) database capabilities in an Org buffer. For
an example of the first application, imagine maintaining a file where
-you document bugs and plan releases of a piece of software. Instead of
+you document bugs and plan releases for a piece of software. Instead of
using tags like @code{:release_1:}, @code{:release_2:}, one can use a
property, say @code{:Release:}, that in different subtrees has different
values, such as @code{1.0} or @code{2.0}. For an example of the second
application of properties, imagine keeping track of your music CDs,
-where properties could be things such as the album artist, date of
+where properties could be things such as the album, artist, date of
release, number of tracks, and so on.
Properties can be conveniently edited and viewed in column view
:Title: Goldberg Variations
:Composer: J.S. Bach
:Artist: Glen Gould
- :Publisher: Deutsche Grammphon
+ :Publisher: Deutsche Grammophon
:NDisks: 1
:END:
@end example
If you want to set properties that can be inherited by any entry in a
file, use a line like
-
+@cindex property, _ALL
+@cindex #+PROPERTY
@example
#+PROPERTY: NDisks_ALL 1 2 3 4
@end example
+@vindex org-global-properties
Property values set with the global variable
@code{org-global-properties} can be inherited by all entries in all
Org files.
@section Special properties
@cindex properties, special
-Special properties provide alternative access method to Org mode
-features discussed in the previous chapters, like the TODO state or the
-priority of an entry. This interface exists so that you can include
-these states into columns view (@pxref{Column view}), or to use them in
+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
used as keys in the properties drawer:
+@cindex property, special, TODO
+@cindex property, special, TAGS
+@cindex property, special, ALLTAGS
+@cindex property, special, CATEGORY
+@cindex property, special, PRIORITY
+@cindex property, special, DEADLINE
+@cindex property, special, SCHEDULED
+@cindex property, special, CLOSED
+@cindex property, special, TIMESTAMP
+@cindex property, special, TIMESTAMP_IA
+@cindex property, special, CLOCKSUM
+@c guessing that ITEM is needed in this area; also, should this list be sorted?
+@cindex property, special, ITEM
@example
TODO @r{The TODO keyword of the entry.}
TAGS @r{The tags defined directly in the headline.}
ALLTAGS @r{All tags, including inherited ones.}
+CATEGORY @r{The category of an entry.}
PRIORITY @r{The priority of the entry, a string with a single letter.}
DEADLINE @r{The deadline time string, without the angular brackets.}
-SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
-TIMESTAMP @r{The first keyword-less time stamp in the entry.}
-TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
+SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
+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.}
+ITEM @r{The content of the entry.}
@end example
@node Property searches, Property inheritance, Special properties, Properties and Columns
@cindex searching, of properties
To create sparse trees and special lists with selection based on properties,
-the same commands are used as for tag searches (@pxref{Tag searches}), and
-the same logic applies. For example, here is a search string:
-
-@example
-+work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
- +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
-@end example
-
-@noindent
-The type of comparison will depend on how the comparison value is written:
-@itemize @minus
-@item
-If the comparison value is a plain number, a numerical comparison is done,
-and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
-@samp{>=}, and @samp{<>}.
-@item
-If the comparison value is enclosed in double
-quotes, a string comparison is done, and the same operators are allowed.
-@item
-If the comparison value is enclosed in double quotes @emph{and} angular
-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
-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.
-@item
-If the comparison value is enclosed
-in curly braces, a regexp match is performed, with @samp{=} meaning that the
-regexp matches the property value, and @samp{<>} meaning that it does not
-match.
-@end itemize
-
-So the search string in the example finds entries tagged @samp{:work:} but
-not @samp{:boss:}, which also have a priority value @samp{A}, a
-@samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
-property that is numerically smaller than 2, a @samp{:With:} property that is
-matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
-on or after October 11, 2008.
+the same commands are used as for tag searches (@pxref{Tag searches}).
+@table @kbd
+@kindex C-c \
+@kindex C-c / m
+@item C-c \
+@itemx C-c / m
+Create a sparse tree with all matching entries. With a
+@kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
+@kindex C-c a m
+@item C-c a m
+Create a global list of tag/property matches from all agenda files.
+@xref{Matching tags and properties}.
+@kindex C-c a M
+@item C-c a M
+@vindex org-tags-match-list-sublevels
+Create a global list of tag matches from all agenda files, but check
+only TODO items and force checking of subitems (see variable
+@code{org-tags-match-list-sublevels}).
+@end table
-You can configure Org mode to use property inheritance during a search, but
-beware that this can slow down searches considerably. See @ref{Property
-inheritance} for details.
+The syntax for the search string is described in @ref{Matching tags and
+properties}.
There is also a special command for creating sparse trees based on a
single property:
@cindex properties, inheritance
@cindex inheritance, of properties
-The outline structure of Org mode documents lends itself for an
-inheritance model of properties: If the parent in a tree has a certain
+@vindex org-use-property-inheritance
+The outline structure of Org-mode documents lends itself for an
+inheritance model of properties: if the parent in a tree has a certain
property, the children can inherit this property. Org mode does not
turn this on by default, because it can slow down property searches
significantly and is often not needed. However, if you find inheritance
useful, you can turn it on by setting the variable
-@code{org-use-property-inheritance}. It may be set to @code{t}, to make
+@code{org-use-property-inheritance}. It may be set to @code{t} to make
all properties inherited from the parent, to a list of properties
that should be inherited, or to a regular expression that matches
inherited properties.
Org mode has a few properties for which inheritance is hard-coded, at
least for the special applications for which they are used:
+@cindex property, COLUMNS
@table @code
@item COLUMNS
The @code{:COLUMNS:} property defines the format of column view
point for a column view table, independently of the location in the
subtree from where columns view is turned on.
@item CATEGORY
+@cindex property, CATEGORY
For agenda view, a category set through a @code{:CATEGORY:} property
applies to the entire subtree.
@item ARCHIVE
+@cindex property, ARCHIVE
For archiving, the @code{:ARCHIVE:} property may define the archive
location for the entire subtree (@pxref{Moving subtrees}).
@item LOGGING
+@cindex property, LOGGING
The LOGGING property may define logging settings for an entry or a
subtree (@pxref{Tracking TODO state changes}).
@end table
@section Column view
A great way to view and edit properties in an outline tree is
-@emph{column view}. In column view, each outline item is turned into a
+@emph{column view}. In column view, each outline node is turned into a
table row. Columns in this table provide access to properties of the
entries. Org mode implements columns by overlaying a tabular structure
over the headline of each item. While the headlines have been turned
To define a column format for an entire file, use a line like
+@cindex #+COLUMNS
@example
#+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
@end example
definition looks like this:
@example
- %[width]property[(title)][@{summary-type@}]
+ %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
@end example
@noindent
optional. The individual parts have the following meaning:
@example
-width @r{An integer specifying the width of the column in characters.}
+@var{width} @r{An integer specifying the width of the column in characters.}
@r{If omitted, the width will be determined automatically.}
-property @r{The property that should be edited in this column.}
+@var{property} @r{The property that should be edited in this column.}
(title) @r{The header text for the column. If omitted, the}
@r{property name is used.}
-@{summary-type@} @r{The summary type. If specified, the column values for}
+@{@var{summary-type}@} @r{The summary type. If specified, the column values for}
@r{parent nodes are computed from the children.}
@r{Supported summary types are:}
@{+@} @r{Sum numbers in this column.}
@{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
@{$@} @r{Currency, short for @samp{+;%.2f}.}
@{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
- @{X@} @r{Checkbox status, [X] if all children are [X].}
- @{X/@} @r{Checkbox status, [n/m].}
- @{X%@} @r{Checkbox status, [n%].}
+ @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
+ @{X/@} @r{Checkbox status, @samp{[n/m]}.}
+ @{X%@} @r{Checkbox status, @samp{[n%]}.}
+ @{min@} @r{Smallest number in column.}
+ @{max@} @r{Largest number.}
+ @{mean@} @r{Arithmetic mean of numbers.}
+ @{:min@} @r{Smallest time value in column.}
+ @{:max@} @r{Largest time value.}
+ @{:mean@} @r{Arithmetic mean of time values.}
@end example
@noindent
values.
@example
-:COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line - it is wrapped here only because of formatting constraints.}
+:COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
%10Time_Estimate@{:@} %CLOCKSUM
:Owner_ALL: Tammy Mark Karl Lisa Don
:Status_ALL: "In progress" "Not started yet" "Finished" ""
:Approved_ALL: "[ ]" "[X]"
@end example
+@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, @ie 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
@tsubheading{Turning column view on and off}
@kindex C-c C-x C-c
@item C-c C-x C-c
-Create the column view for the local environment. This command searches
-the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
-a format. When one is found, the column view table is established for
-the entire tree, starting from the entry that contains the @code{:COLUMNS:}
-property. If none is found, the format is taken from the @code{#+COLUMNS}
-line or from the variable @code{org-columns-default-format}, and column
-view is established for the current entry and its subtree.
+@vindex org-columns-default-format
+Turn on column view. If the cursor is before the first headline in the file,
+column view is turned on for the entire file, using the @code{#+COLUMNS}
+definition. If the cusor is somewhere inside the outline, this command
+searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
+defines a format. When one is found, the column view table is established
+for the tree starting at the entry that contains the @code{:COLUMNS:}
+property. If no such property is found, the format is taken from the
+@code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
+and column view is established for the current entry and its subtree.
@kindex r
@item r
Recreate the column view, to include recent changes made in the buffer.
Since column view is just an overlay over a buffer, it cannot be
exported or printed directly. If you want to capture a column view, use
-this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
+a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
of this block looks like this:
-@cindex #+BEGIN: columnview
+@cindex #+BEGIN, columnview
@example
* The column view
#+BEGIN: columnview :hlines 1 :id "label"
@table @code
@item :id
-This is most important parameter. Column view is a feature that is
+This is the most important parameter. Column view is a feature that is
often localized to a certain (sub)tree, and the capture block might be
-in a different location in the file. To identify the tree whose view to
-capture, you can use 3 values:
+at a different location in the file. To identify the tree whose view to
+capture, you can use 4 values:
+@cindex property, ID
@example
local @r{use the tree in which the capture block is located}
global @r{make a global view, including all headings in the file}
-"file:path-to-file"
+"file:@var{path-to-file}"
@r{run column view at the top of this file}
-"ID" @r{call column view in the tree that has an @code{:ID:}}
+"@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
@r{property with the value @i{label}. You can use}
@r{@kbd{M-x org-id-copy} to create a globally unique ID for}
@r{the current entry and copy it to the kill-ring.}
@end example
@item :hlines
-When @code{t}, insert a hline after every line. When a number N, insert
-a hline before each headline with level @code{<= N}.
+When @code{t}, insert an hline after every line. When a number @var{N}, insert
+an hline before each headline with level @code{<= @var{N}}.
@item :vlines
-When set to @code{t}, enforce column groups to get vertical lines.
+When set to @code{t}, force column groups to get vertical lines.
@item :maxlevel
When set to a number, don't capture entries below this level.
@item :skip-empty-rows
-When set to @code{t}, skip row where the only non-empty specifier of the
+When set to @code{t}, skip rows where the only non-empty specifier of the
column view is @code{ITEM}.
@end table
@kindex C-c C-x i
@item C-c C-x i
Insert a dynamic block capturing a column view. You will be prompted
-for the scope or id of the view.
+for the scope or ID of the view.
@kindex C-c C-c
@item C-c C-c
@kindex C-c C-x C-u
@itemx C-c C-x C-u
-Update dynamical block at point. The cursor needs to be in the
+Update dynamic block at point. The cursor needs to be in the
@code{#+BEGIN} line of the dynamic block.
@kindex C-u C-c C-x C-u
@item C-u C-c C-x C-u
@end table
You can add formulas to the column view table and you may add plotting
-instructions in front of the table - these will survive an update of the
+instructions in front of the table---these will survive an update of the
block. If there is a @code{#+TBLFM:} after the table, the table will
actually be recalculated automatically after an update.
+An alternative way to capture and process property values into a table is
+provided by Eric Schulte's @file{org-collector.el} which is a contributed
+package@footnote{Contributed packages are not part of Emacs, but are
+distributed with the main distribution of Org (visit
+@uref{http://orgmode.org}).}. It provides a general API to collect
+properties from entries in a certain scope, and arbitrary Lisp expressions to
+process these values before inserting them into a table or a dynamic block.
+
@node Property API, , Column view, Properties and Columns
@section The Property API
@cindex properties, API
@chapter Dates and Times
@cindex dates
@cindex times
-@cindex time stamps
-@cindex date stamps
+@cindex timestamp
+@cindex date stamp
To assist project planning, TODO items can be labeled with a date and/or
a time. The specially formatted string carrying the date and time
@node Timestamps, Creating timestamps, Dates and Times, Dates and Times
-@section Timestamps, deadlines and scheduling
-@cindex time stamps
+@section Timestamps, deadlines, and scheduling
+@cindex timestamps
@cindex ranges, time
@cindex date stamps
@cindex deadlines
@cindex scheduling
-A time stamp is a specification of a date (possibly with time or a range
+A timestamp is a specification of a date (possibly with a time or a range
of times) in a special format, either @samp{<2003-09-16 Tue>} or
@samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
12:00-12:30>}@footnote{This is the standard ISO date/time format. To
-use an alternative format, see @ref{Custom time format}.}. A time stamp
+use an alternative format, see @ref{Custom time format}.}. A timestamp
can appear anywhere in the headline or body of an Org tree entry. Its
presence causes entries to be shown on specific dates in the agenda
(@pxref{Weekly/daily agenda}). We distinguish:
@table @var
-@item Plain time stamp; Event; Appointment
+@item Plain timestamp; Event; Appointment
@cindex timestamp
-A simple time stamp just assigns a date/time to an item. This is just
+A simple timestamp just assigns a date/time to an item. This is just
like writing down an appointment or event in a paper agenda. In the
timeline and agenda displays, the headline of an entry associated with a
-plain time stamp will be shown exactly on that date.
+plain timestamp will be shown exactly on that date.
@example
* Meet Peter at the movies <2006-11-01 Wed 19:15>
* Discussion on climate change <2006-11-02 Thu 20:00-22:00>
@end example
-@item Time stamp with repeater interval
+@item Timestamp with repeater interval
@cindex timestamp, with repeater interval
-A time stamp may contain a @emph{repeater interval}, indicating that it
+A timestamp may contain a @emph{repeater interval}, indicating that it
applies not only on the given date, but again and again after a certain
-interval of N days (d), weeks (w), months(m), or years(y). The
+interval of N days (d), weeks (w), months (m), or years (y). The
following will show up in the agenda every Wednesday:
@example
@item Time/Date range
@cindex timerange
@cindex date range
-Two time stamps connected by @samp{--} denote a range. The headline
+Two timestamps connected by @samp{--} denote a range. The headline
will be shown on the first and last day of the range, and on any dates
that are displayed and fall in the range. Here is an example:
<2004-08-23 Mon>--<2004-08-26 Thu>
@end example
-@item Inactive time stamp
+@item Inactive timestamp
@cindex timestamp, inactive
@cindex inactive timestamp
-Just like a plain time stamp, but with square brackets instead of
-angular ones. These time stamps are inactive in the sense that they do
+Just like a plain timestamp, but with square brackets instead of
+angular ones. These timestamps are inactive in the sense that they do
@emph{not} trigger an entry to show up in the agenda.
@example
@cindex creating timestamps
@cindex timestamps, creating
-For Org mode to recognize time stamps, they need to be in the specific
-format. All commands listed below produce time stamps in the correct
+For Org mode to recognize timestamps, they need to be in the specific
+format. All commands listed below produce timestamps in the correct
format.
@table @kbd
@kindex C-c .
@item C-c .
-Prompt for a date and insert a corresponding time stamp. When the cursor is
-at an existing time stamp in the buffer, the command is used to modify this
+Prompt for a date and insert a corresponding timestamp. When the cursor is
+at an existing timestamp in the buffer, the command is used to modify this
timestamp instead of inserting a new one. When this command is used twice in
succession, a time range is inserted.
@c
-@kindex C-u C-c .
-@item C-u C-c .
-Like @kbd{C-c .}, but use the alternative format which contains date
-and time. The default time can be rounded to multiples of 5 minutes,
-see the option @code{org-time-stamp-rounding-minutes}.
-@c
@kindex C-c !
@item C-c !
-Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
+Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
an agenda entry.
@c
+@kindex C-u C-c .
+@kindex C-u C-c !
+@item C-u C-c .
+@itemx C-u C-c !
+@vindex org-time-stamp-rounding-minutes
+Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
+contains date and time. The default time can be rounded to multiples of 5
+minutes, see the option @code{org-time-stamp-rounding-minutes}.
+@c
@kindex C-c <
@item C-c <
-Insert a time stamp corresponding to the cursor date in the Calendar.
+Insert a timestamp corresponding to the cursor date in the Calendar.
@c
@kindex C-c >
@item C-c >
@c
@kindex C-c C-o
@item C-c C-o
-Access the agenda for the date given by the time stamp or -range at
+Access the agenda for the date given by the timestamp or -range at
point (@pxref{Weekly/daily agenda}).
@c
@kindex S-@key{left}
@item S-@key{left}
@itemx S-@key{right}
Change date at cursor by one day. These key bindings conflict with
-CUA mode (@pxref{Conflicts}).
+shift-selection and related modes (@pxref{Conflicts}).
@c
@kindex S-@key{up}
@kindex S-@key{down}
@item S-@key{up}
@itemx S-@key{down}
Change the item under the cursor in a timestamp. The cursor can be on a
-year, month, day, hour or minute. Note that if the cursor is in a
-headline and not at a time stamp, these same keys modify the priority of
-an item. (@pxref{Priorities}). The key bindings also conflict with
-CUA mode (@pxref{Conflicts}).
+year, month, day, hour or minute. When the timestamp contains a time range
+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
+related modes (@pxref{Conflicts}).
@c
@kindex C-c C-y
@cindex evaluate time range
@cindex date, reading in minibuffer
@cindex time, reading in minibuffer
+@vindex org-read-date-prefer-future
When Org mode prompts for a date/time, the default is shown as an ISO
date, and the prompt therefore seems to ask for an ISO date. But it
will in fact accept any string containing some date and/or time
copied from an email message. Org mode will find whatever information
is in there and derive anything you have not specified from the
@emph{default date and time}. The default is usually the current date
-and time, but when modifying an existing time stamp, or when entering
+and time, but when modifying an existing timestamp, or when entering
the second stamp of a range, it is taken from the stamp in the buffer.
When filling in information, Org mode assumes that most of the time you
-will want to enter a date in the future: If you omit the month/year and
+will want to enter a date in the future: if you omit the month/year and
the given day/month is @i{before} today, it will assume that you mean a
future date@footnote{See the variable
@code{org-read-date-prefer-future}.}.
Furthermore you can specify a relative date by giving, as the
@emph{first} thing in the input: a plus/minus sign, a number and a
-letter [dwmy] to indicate change in days weeks, months, years. With a
+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. @Eg
@example
+0 --> today
+4 --> same as above
+2w --> two weeks from today
++5 --> five days from default date
-+2tue --> second tuesday from now.
++2tue --> second Tuesday from now.
@end example
+@vindex parse-time-months
+@vindex parse-time-weekdays
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}.
@cindex calendar, for selecting date
+@vindex org-popup-calendar-for-date-prompt
Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
you don't need/want the calendar, configure the variable
@code{org-popup-calendar-for-date-prompt}.}. When you exit the date
@key{RET} @r{Choose date in calendar.}
@end example
+@vindex org-read-date-display-live
The actions of the date/time prompt may seem complex, but I assure you they
will grow on you, and you will start getting annoyed by pretty much any other
way of entering a date/time out there. To help you understand what is going
@cindex time format, custom
@cindex date format, custom
+@vindex org-display-custom-times
+@vindex org-time-stamp-custom-formats
Org mode uses the standard ISO notation for dates and times as it is
defined in ISO 8601. If you cannot get used to this and require another
representation of date and time to keep you happy, you can get it by
@noindent
Org mode needs the default format for scanning, so the custom date/time
-format does not @emph{replace} the default format - instead it is put
+format does not @emph{replace} the default format---instead it is put
@emph{over} the default format using text properties. This has the
following consequences:
@itemize @bullet
@item
-You cannot place the cursor onto a time stamp anymore, only before or
+You cannot place the cursor onto a timestamp anymore, only before or
after.
@item
The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
-each component of a time stamp. If the cursor is at the beginning of
+each component of a timestamp. If the cursor is at the beginning of
the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
time will be changed by one minute.
@item
-If the time stamp contains a range of clock times or a repeater, these
+If the timestamp contains a range of clock times or a repeater, these
will not be overlayed, but remain in the buffer as they were.
@item
-When you delete a time stamp character-by-character, it will only
+When you delete a timestamp character-by-character, it will only
disappear from the buffer after @emph{all} (invisible) characters
belonging to the ISO timestamp have been removed.
@item
-If the custom time stamp format is longer than the default and you are
+If the custom timestamp format is longer than the default and you are
using dates in tables, table alignment will be messed up. If the custom
format is shorter, things do work as expected.
@end itemize
@node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
@section Deadlines and scheduling
-A time stamp may be preceded by special keywords to facilitate planning:
+A timestamp may be preceded by special keywords to facilitate planning:
@table @var
@item DEADLINE
Meaning: the task (most likely a TODO item, though not necessarily) is supposed
to be finished on that date.
+@vindex org-deadline-warning-days
On the deadline date, the task will be listed in the agenda. In
addition, the agenda for @emph{today} will carry a warning about the
approaching or missed deadline, starting
Meaning: you are planning to start working on that task on the given
date.
+@vindex org-agenda-skip-scheduled-if-done
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., the task will automatically be forwarded until completed.
+@Ie the task will automatically be forwarded until completed.
@example
*** TODO Call Trillian for a date on New Years Eve.
@b{Important:} Scheduling an item in Org mode should @i{not} be
understood in the same way that we understand @i{scheduling a meeting}.
Setting a date for a meeting is just a simple appointment, you should
-mark this entry with a simple plain time stamp, to get this item shown
-on the date where it applies. This is a frequent mis-understanding from
-Org-users. In Org mode, @i{scheduling} means setting a date when you
+mark this entry with a simple plain timestamp, to get this item shown
+on the date where it applies. This is a frequent misunderstanding by
+Org users. In Org mode, @i{scheduling} means setting a date when you
want to start working on an action item.
@end table
-You may use time stamps with repeaters in scheduling and deadline
+You may use timestamps with repeaters in scheduling and deadline
entries. Org mode will issue early and late warnings based on the
-assumption that the time stamp represents the @i{nearest instance} of
+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)>}
@node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
@subsection Inserting deadlines or schedules
-The following commands allow to quickly insert a deadline or to schedule
+The following commands allow you to quickly insert a deadline or to schedule
an item:
@table @kbd
prefix arg, an existing deadline will be removed from the entry.
@c FIXME Any CLOSED timestamp will be removed.????????
@c
-@kindex C-c / d
-@cindex sparse tree, for deadlines
-@item C-c / d
-Create a sparse tree with all deadlines that are either past-due, or
-which will become due within @code{org-deadline-warning-days}.
-With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
-prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
-all deadlines due tomorrow.
-@c
@kindex C-c C-s
@item C-c C-s
Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
like this, you can open the agenda or the calendar to find an appropriate
date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
schedule the marked item.
+@c
+@kindex C-c / d
+@cindex sparse tree, for deadlines
+@item C-c / d
+@vindex org-deadline-warning-days
+Create a sparse tree with all deadlines that are either past-due, or
+which will become due within @code{org-deadline-warning-days}.
+With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
+prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
+all deadlines due tomorrow.
+@c
+@kindex C-c / b
+@item C-c / b
+Sparse tree for deadlines and scheduled items before a given date.
+@c
+@kindex C-c / a
+@item C-c / a
+Sparse tree for deadlines and scheduled items after a given date.
@end table
@node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
@subsection Repeated tasks
+@cindex tasks, repeated
+@cindex repeated tasks
Some tasks need to be repeated again and again. Org mode helps to
organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
-or plain time stamp. In the following example
+or plain timestamp. In the following example
@example
** TODO Pay the rent
DEADLINE: <2005-10-01 Sat +1m>
@end example
-the @code{+1m} is a repeater; the intended interpretation is that the
-task has a deadline on <2005-10-01> and repeats itself every (one) month
-starting from that time. If you need both a repeater and a special
-warning period in a deadline entry, the repeater comes first and the
-warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
+@noindent
+the @code{+1m} is a repeater; the intended interpretation is that the task
+has a deadline on <2005-10-01> and repeats itself every (one) month starting
+from that time. If you need both a repeater and a special warning period in
+a deadline entry, the repeater should come first and the warning period last:
+@code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
Deadlines and scheduled items produce entries in the agenda when they
are over-due, so it is important to be able to mark such an entry as
@emph{next} instance of the repeated entry will not be active. Org mode
deals with this in the following way: When you try to mark such an entry
DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
-time stamp by the repeater interval, and immediately set the entry state
+timestamp by the repeater interval, and immediately set the entry state
back to TODO. In the example above, setting the state to DONE would
actually switch the date like this:
DEADLINE: <2005-11-01 Tue +1m>
@end example
+@vindex org-log-repeat
A timestamp@footnote{You can change this using the option
@code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
@code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
will be visible.
With the @samp{+1m} cookie, the date shift will always be exactly one
-month. So if you have not payed the rent for three months, marking this
+month. So if you have not paid the rent for three months, marking this
entry DONE will still keep it as an overdue deadline. Depending on the
task, this may not be the best way to handle it. For example, if you
forgot to call you father for 3 weeks, it does not make sense to call
@end example
You may have both scheduling and deadline information for a specific
-task - just make sure that the repeater intervals on both are the same.
+task---just make sure that the repeater intervals on both are the same.
+
+An alternative to using a repeater is to create a number of copies of a task
+subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
+created for this purpose, it is described in @ref{Structure editing}.
+
@node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
@section Clocking work time
-Org mode allows you to clock the time you spent on specific tasks in a
+Org mode allows you to clock the time you spend on specific tasks in a
project. When you start working on an item, you can start the clock.
When you stop working on that task, or when you mark the task done, the
clock is stopped and the corresponding time interval is recorded. It
also computes the total time spent on each subtree of a project.
+Normally, the clock does not survive exiting and re-entering Emacs, but you
+can arrange for the clock information to persist across Emacs sessions with
+
+@lisp
+(setq org-clock-persist t)
+(org-clock-persistence-insinuate)
+@end lisp
+
@table @kbd
@kindex C-c C-x C-i
@item C-c C-x C-i
+@vindex org-clock-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{:CLOCK:} drawer (see also the variable
+@code{:LOGBOOK:} drawer (see also the variable
@code{org-clock-into-drawer}). 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,
-with letter @kbd{d}.
+with letter @kbd{d}.@*
+@cindex property: CLOCK_MODELINE_TOTAL
+@cindex property: LAST_REPEAT
+@vindex org-clock-modeline-total
+While the clock is running, the current clocking time is shown in the mode
+line, along with the title of the task. The clock time shown will be all
+time ever clocked for this task and its children. If the task has an effort
+estimate (@pxref{Effort estimates}), the mode line displays the current
+clocking time against it@footnote{To add an effort estimate ``on the fly'',
+hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
+is a repeating one (@pxref{Repeated tasks}), only the time since the last
+reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
+will be shown. More control over what time is shown can be exercised with
+the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
+@code{current} to show only the current clocking instance, @code{today} to
+show all time clocked on this tasks today (see also the variable
+@code{org-extend-today-until}), @code{all} to include all time, or
+@code{auto} which is the default@footnote{See also the variable
+@code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
+mode line entry will pop up a menu with clocking options.
@kindex C-c C-x C-o
@item C-c C-x C-o
+@vindex org-log-note-clock-out
Stop the clock (clock-out). This inserts another timestamp at the same
location where the clock was last started. It also directly computes
the resulting time in inserts it after the time range as @samp{=>
HH:MM}. See the variable @code{org-log-note-clock-out} for the
possibility to record an additional note together with the clock-out
-time stamp@footnote{The corresponding in-buffer setting is:
+timestamp@footnote{The corresponding in-buffer setting is:
@code{#+STARTUP: lognoteclock-out}}.
+@kindex C-c C-x C-e
+@item C-c C-x C-e
+Update the effort estimate for the current clock task.
@kindex C-c C-y
-@item C-c C-y
-Recompute the time interval after changing one of the time stamps. This
-is only necessary if you edit the time stamps directly. If you change
+@kindex C-c C-c
+@item C-c C-y @ @ @r{or}@ @ C-c C-c
+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.
@kindex C-c C-t
@item C-c C-t
tasks.
@kindex C-c C-x C-d
@item C-c C-x C-d
+@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
@kindex C-c C-x C-r
@item C-c C-x C-r
Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
-report as an Org mode table into the current file. When the cursor is
+report as an Org-mode table into the current file. When the cursor is
at an existing clock table, just update it. When called with a prefix
argument, jump to the first clock report in the current document and
update it.
-@cindex #+BEGIN: clocktable
+@cindex #+BEGIN, clocktable
@example
#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
#+END: clocktable
new table. The @samp{BEGIN} line can specify options:
@example
:maxlevel @r{Maximum level depth to which times are listed in the table.}
-:emphasize @r{When @code{t}, emphasize level one and level two items}
+:emphasize @r{When @code{t}, emphasize level one and level two items.}
:scope @r{The scope to consider. This can be any of the following:}
nil @r{the current buffer or narrowed region}
file @r{the full current buffer}
subtree @r{the subtree where the clocktable is located}
- treeN @r{the surrounding level N tree, for example @code{tree3}}
+ tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
tree @r{the surrounding level 1 tree}
agenda @r{all agenda files}
("file"..) @r{scan these files}
2007-12 @r{December 2007}
2007-W50 @r{ISO-week 50 in 2007}
2007 @r{the year 2007}
- today, yesterday, today-N @r{a relative day}
- thisweek, lastweek, thisweek-N @r{a relative week}
- thismonth, lastmonth, thismonth-N @r{a relative month}
- thisyear, lastyear, thisyear-N @r{a relative year}
+ today, yesterday, today-@var{N} @r{a relative day}
+ thisweek, lastweek, thisweek-@var{N} @r{a relative week}
+ thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
+ thisyear, lastyear, thisyear-@var{N} @r{a relative year}
@r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
-:tstart @r{A time string specifying when to start considering times}
-:tend @r{A time string specifying when to stop considering times}
+:tstart @r{A time string specifying when to start considering times.}
+:tend @r{A time string specifying when to stop considering times.}
:step @r{@code{week} or @code{day}, to split the table into chunks.}
@r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
-:link @r{Link the item headlines in the table to their origins}
+:link @r{Link the item headlines in the table to their origins.}
:formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
- @r{As a special case, @samp{:formula %} adds column with % time.}
- @r{If you do not specify a formula here, any existing formula}
+ @r{As a special case, @samp{:formula %} adds a column with % time.}
+ @r{If you do not specify a formula here, any existing formula.}
@r{below the clock table will survive updates and be evaluated.}
+:timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
+ @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
@end example
-So to get a clock summary of the current level 1 tree, for the current
+To get a clock summary of the current level 1 tree, for the current
day, you could write
@example
#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
#+END: clocktable
@end example
+@noindent
and to use a specific time range you could write@footnote{Note that all
-parameters must be specified in a single line - the line is broken here
-only to fit it onto the manual.}
+parameters must be specified in a single line---the line is broken here
+only to fit it into the manual.}
@example
#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
:tend "<2006-08-10 Thu 12:00>"
@item C-c C-c
@kindex C-c C-x C-u
@itemx C-c C-x C-u
-Update dynamical block at point. The cursor needs to be in the
+Update dynamic block at point. The cursor needs to be in the
@code{#+BEGIN} line of the dynamic block.
@kindex C-u C-c C-x C-u
@item C-u C-c C-x C-u
@section Effort estimates
@cindex effort estimates
+@cindex property, Effort
+@vindex org-effort-property
If you want to plan your work in a very detailed way, or if you need to
produce offers with quotations of the estimated work effort, you may want to
assign effort estimates to entries. If you are also clocking your work, you
@end example
@noindent
+@vindex org-global-properties
+@vindex org-columns-default-format
or, even better, you can set up these values globally by customizing the
variables @code{org-global-properties} and @code{org-columns-default-format}.
In particular if you want to use this setup also in the agenda, a global
value. The values you enter will immediately be summed up in the hierarchy.
In the column next to it, any clocked time will be displayed.
+@vindex org-agenda-columns-add-appointments-to-effort-sum
If you switch to column view in the daily/weekly agenda, the effort column
will summarize the estimated work effort for each day@footnote{Please note
the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
new timer items.
@kindex C-c C-x ,
@item C-c C-x ,
-Pause the timer, or continue it if it is already paused. With prefix
-argument, stop it entirely.
+Pause the timer, or continue it if it is already paused.
+@c removed the sentence because it is redundant to the following item
@kindex C-u C-c C-x ,
@item C-u C-c C-x ,
Stop the timer. After this, you can only start a new timer, not continue the
An important part of any organization system is the ability to quickly
capture new ideas and tasks, and to associate reference material with them.
-Org uses the @file{remember} package to create tasks, and stores files
+Org uses the @file{remember.el} package to create tasks, and stores files
related to a task (@i{attachments}) in a special directory.
@menu
* Remember:: Capture new tasks/ideas with little interruption
* Attachments:: Add files to tasks.
+* RSS Feeds:: Getting input from RSS feeds
+* Protocols:: External (@eg Browser) access to Emacs and Org
@end menu
@node Remember, Attachments, Capture, Capture
@section Remember
@cindex @file{remember.el}
-The @i{Remember} package by John Wiegley lets you store quick notes with
-little interruption of your work flow. See
-@uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
-information. It is an excellent way to add new notes and tasks to
-Org files. Org significantly expands the possibilities of
-@i{remember}: You may define templates for different note types, and
-associate target files and headlines with specific templates. It also
-allows you to select the location where a note should be stored
-interactively, on the fly.
+The Remember package by John Wiegley lets you store quick notes with little
+interruption of your work flow. It is an excellent way to add new notes and
+tasks to Org files. The @code{remember.el} package is part of Emacs 23, not
+Emacs 22. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for
+more information.
+
+Org significantly expands the possibilities of Remember: you may define
+templates for different note types, and associate target files and headlines
+with specific templates. It also allows you to select the location where a
+note should be stored interactively, on the fly.
@menu
-* Setting up Remember:: Some code for .emacs to get things going
+* Setting up Remember for Org:: Some code for .emacs to get things going
* Remember templates:: Define the outline of different note types
* Storing notes:: Directly get the note to where it belongs
* Refiling notes:: Moving a note or task to a project
@end menu
-@node Setting up Remember, Remember templates, Remember, Remember
-@subsection Setting up Remember
+@node Setting up Remember for Org, Remember templates, Remember, Remember
+@subsection Setting up Remember for Org
-The following customization will tell @i{remember} to use org files as
+The following customization will tell Remember to use Org files as
target, and to create annotations compatible with Org links.
@example
(define-key global-map "\C-cr" 'org-remember)
@end example
+@noindent
The last line binds the command @code{org-remember} to a global
key@footnote{Please select your own key, @kbd{C-c r} is only a
-suggestion.}. @code{org-remember} basically just calls @code{remember},
-but it makes a few things easier: If there is an active region, it will
-automatically copy the region into the remember buffer. It also allows
-to jump to the buffer and location where remember notes are being
-stored: Just call @code{org-remember} with a prefix argument. If you
+suggestion.}. @code{org-remember} basically just calls Remember,
+but it makes a few things easier: if there is an active region, it will
+automatically copy the region into the Remember buffer. It also allows
+to jump to the buffer and location where Remember notes are being
+stored: just call @code{org-remember} with a prefix argument. If you
use two prefix arguments, Org jumps to the location where the last
remember note was stored.
-The remember buffer will actually use @code{org-mode} as its major mode, so
-that all editing features of Org-mode are available. In addition to this, a
+The Remember buffer will actually use @code{org-mode} as its major mode, so
+that all editing features of Org mode are available. In addition to this, a
minor mode @code{org-remember-mode} is turned on, for the single purpose that
you can use its keymap @code{org-remember-mode-map} to overwrite some of
-Org-mode's key bindings.
+Org mode's key bindings.
You can also call @code{org-remember} in a special way from the agenda,
-using the @kbd{k r} key combination. With this access, any time stamps
-inserted by the selected remember template (see below) will default to
+using the @kbd{k r} key combination. With this access, any timestamps
+inserted by the selected Remember template (see below) will default to
the cursor date in the agenda, rather than to the current date.
-@node Remember templates, Storing notes, Setting up Remember, Remember
+@node Remember templates, Storing notes, Setting up Remember for Org, Remember
@subsection Remember templates
-@cindex templates, for remember
+@cindex templates, for Remember
In combination with Org, you can use templates to generate
-different types of @i{remember} notes. For example, if you would like
+different types of Remember notes. For example, if you would like
to use one template to create general TODO entries, another one for
journal entries, and a third one for collecting random ideas, you could
use:
("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
@end example
+@vindex org-remember-default-headline
+@vindex org-directory
@noindent In these entries, the first string is just a name, and the
character specifies how to select the template. It is useful if the
character is also the first letter of the name. The next string specifies
the template. Two more (optional) strings give the file in which, and the
-headline under which the new note should be stored. The file (if not present
+headline under which, the new note should be stored. The file (if not present
or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
@code{org-remember-default-headline}. If the file name is not an absolute
path, it will be interpreted relative to @code{org-directory}. The heading
-can also be the symbols @code{top} or @code{bottom} to send note as level 1
+can also be the symbols @code{top} or @code{bottom} to send notes as level 1
entries to the beginning or end of the file, respectively.
An optional sixth element specifies the contexts in which the user can select
the template. This element can be a list of major modes or a function.
@code{org-remember} will first check whether the function returns @code{t} or
-if we are in any of the listed major mode, and exclude templates for which
+if we are in any of the listed major modes, and exclude templates for which
this condition is not fulfilled. Templates that do not specify this element
at all, or that use @code{nil} or @code{t} as a value will always be
selectable.
("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
@end example
+@noindent
The first template will only be available when invoking @code{org-remember}
from an buffer in @code{emacs-lisp-mode}. The second template will only be
available when the function @code{my-check} returns @code{t}. The third
more than one template) and then prepare the buffer like
@example
* TODO
- [[file:link to where you called remember]]
+ [[file:@var{link to where you called remember}]]
@end example
@noindent
During expansion of the template, special @kbd{%}-escapes allow dynamic
insertion of content:
@example
-%^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
+%^@{@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{like @code{%a}, but prompt for the description part}
%i @r{initial content, the region when remember is called with C-u.}
@r{The entire text will be indented like @code{%i} itself.}
-%t @r{time stamp, date only}
-%T @r{time stamp with date and time}
-%u, %U @r{like the above, but inactive time stamps}
+%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})}
%k @r{title of currently clocked task}
%K @r{link to currently clocked task}
%^G @r{prompt for tags, with completion all tags in all agenda files.}
-%^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
+%^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
%:keyword @r{specific information for certain link types, see below}
-%[pathname] @r{insert the contents of the file given by @code{pathname}}
-%(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
+%[@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{immediately store note after completing the template}
@r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
%& @r{jump to target location immediately after storing note}
@code{org-store-link-props} can be accessed in remember templates in a
similar way.}:
+@vindex org-from-is-user-regexp
@example
Link type | Available keywords
-------------------+----------------------------------------------
@node Storing notes, Refiling notes, Remember templates, Remember
@subsection Storing notes
-When you are finished preparing a note with @i{remember}, you have to press
+@vindex org-remember-clock-out-on-exit
+When you are finished preparing a note with Remember, you have to press
@kbd{C-c C-c} to file the note away. If you have started the clock in the
-remember buffer, you will first be asked if you want to clock out
+Remember buffer, you will first be asked if you want to clock out
now@footnote{To avoid this query, configure the variable
@code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
will continue to run after the note was filed away.
The handler will then store the note in the file and under the headline
-specified in the template, or it will use the default file and headlines.
+specified in the template, or it will use the default file and headline.
The window configuration will be restored, sending you back to the working
-context before the call to @code{remember}. To re-use the location found
-during the last call to @code{remember}, exit the remember buffer with
-@kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
+context before the call to Remember. To re-use the location found
+during the last call to Remember, exit the Remember buffer with
+@kbd{C-0 C-c C-c}, @ie specify a zero prefix argument to @kbd{C-c C-c}.
Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
the currently clocked item.
+@vindex org-remember-store-without-prompt
If you want to store the note directly to a different place, use
-@kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
+@kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure the
variable @code{org-remember-store-without-prompt} to make this behavior
-the default.}. The handler will then first prompt for a target file -
-if you press @key{RET}, the value specified for the template is used.
+the default.}. The handler will then first prompt for a target file---if
+you press @key{RET}, the value specified for the template is used.
Then the command offers the headings tree of the selected file, with the
-cursor position at the default headline (if you had specified one in the
+cursor position at the default headline (if you specified one in the
template). You can either immediately press @key{RET} to get the note
placed there. Or you can use the following keys to find a different
location:
Pressing @key{RET} or @key{left} or @key{right}
then leads to the following result.
+@vindex org-reverse-note-order
@multitable @columnfractions 0.2 0.15 0.65
@item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
@item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
@end multitable
Before inserting the text into a tree, the function ensures that the text has
-a headline, i.e. a first line that starts with a @samp{*}. If not, a
+a headline, @ie a first line that starts with a @samp{*}. If not, a
headline is constructed from the current date. If you have indented the text
of the note below the headline, the indentation will be adapted if inserting
the note into the tree requires demotion from level 1.
Remember is usually used to quickly capture notes and tasks into one or
a few capture lists. When reviewing the captured data, you may want to
refile some of the entries into a different list, for example into a
-project. Cutting, finding the right location and then pasting the note
+project. Cutting, finding the right location, and then pasting the note
is cumbersome. To simplify this process, you can use the following
special command:
@table @kbd
@kindex C-c C-w
@item C-c C-w
+@vindex org-reverse-note-order
+@vindex org-refile-targets
+@vindex org-refile-use-outline-path
+@vindex org-outline-path-complete-in-steps
+@vindex org-refile-allow-creating-parent-nodes
Refile the entry or region at point. This command offers possible locations
for refiling the entry and lets you select one with completion. The item (or
all items in the region) is filed below the target heading as a subitem.
See the variable @code{org-refile-targets} for details. If you would like to
select a location via a file-path-like completion along the outline path, see
the variables @code{org-refile-use-outline-path} and
-@code{org-outline-path-complete-in-steps}.
+@code{org-outline-path-complete-in-steps}. If you would like to be able to
+create new nodes as new parents for for refiling on the fly, check the
+variable @code{org-refile-allow-creating-parent-nodes}.
@kindex C-u C-c C-w
@item C-u C-c C-w
Use the refile interface to jump to a heading.
Jump to the location where @code{org-refile} last moved a tree to.
@end table
-@node Attachments, , Remember, Capture
+
+@node Attachments, RSS Feeds, Remember, Capture
@section Attachments
@cindex attachments
+@vindex org-attach-directory
It is often useful to associate reference material with an outline node/task.
Small chunks of plain text can simply be stored in the subtree of a project.
Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
which are files located in a directory belonging to an outline node. Org
uses directories named by the unique ID of each entry. These directories are
located in the @file{data} directory which lives in the same directory where
-your org-file lives@footnote{If you move entries or Org-files from one
-directory to the next, you may want to configure @code{org-attach-directory}
+your Org file lives@footnote{If you move entries or Org files from one
+directory to another, you may want to configure @code{org-attach-directory}
to contain an absolute path.}. If you initialize this directory with
-@code{git-init}, Org will automatically commit changes when it sees them.
+@code{git init}, Org will automatically commit changes when it sees them.
The attachment system has been contributed to Org by John Wiegley.
-In cases where this seems better, you can also attach a directory of your
+In cases where it seems better to do so, you can also attach a directory of your
choice to an entry. You can also make children inherit the attachment
directory from a parent, so that an entire subtree uses the same attached
directory.
@table @kbd
@kindex C-c C-a a
@item a
+@vindex org-attach-method
Select a file and move it into the task's attachment directory. The file
will be copied, moved, or linked, depending on @code{org-attach-method}.
Note that hard links are not supported on all systems.
@kindex C-c C-a o
@item o
+@vindex org-file-apps
Open current task's attachment. If there are more than one, prompt for a
file name first. Opening will follow the rules set by @code{org-file-apps}.
For more details, see the information on following hyperlinks
@kindex C-c C-a F
@item F
-Also open the directory, but force using @code{dired} in Emacs.
+Also open the directory, but force using @command{dired} in Emacs.
@kindex C-c C-a d
@item d
@kindex C-c C-a D
@item D
Delete all of a task's attachments. A safer way is to open the directory in
-dired and delete from there.
+@command{dired} and delete from there.
@kindex C-c C-a s
@item C-c C-a s
+@cindex property, ATTACH_DIR
Set a specific directory as the entry's attachment directory. This works by
putting the directory path into the @code{ATTACH_DIR} property.
@kindex C-c C-a i
@item C-c C-a i
+@cindex property, ATTACH_DIR_INHERIT
Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
-same directory for attachments as the parent.
+same directory for attachments as the parent does.
@end table
@end table
+@node RSS Feeds, Protocols, Attachments, Capture
+@section RSS feeds
+@cindex RSS feeds
+
+Org has the capability to add and change entries based on information found in
+RSS feeds. You could use this to make a task out of each new podcast in a
+podcast feed. Or you could use a phone-based note-creating service on the
+web to import tasks into Org. To access feeds, you need to configure the
+variable @code{org-feed-alist}. The docstring of this variable has detailed
+information. Here is just an example:
+
+@example
+(setq org-feed-alist
+ '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....."
+ "~/org/feeds.org" "ReQall Entries")
+@end example
+@noindent
+will configure that new items from the feed provided by @file{reqall.com}
+will result in new entries in the file @file{~/org/feeds.org} under the
+heading @samp{ReQall Entries}, whenever the following command is used:
+
+@table @kbd
+@kindex C-c C-x g
+@item C-c C-x g
+Collect items from the feeds configured in @code{org-feed-alist} and act upon
+them.
+@kindex C-c C-x G
+@item C-c C-x G
+Prompt for a feed name and go to the inbox configured for this feed.
+@end table
+
+Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
+it will store information about the status of items in the feed, to avoid
+adding the same item several times. You should add @samp{FEEDSTATUS} to the
+list of drawers in that file:
+
+@example
+#+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
+@end example
+
+For more information, see @file{org-feed.el} and the docstring of
+@code{org-feed-alist}.
+
+@node Protocols, , RSS Feeds, Capture
+@section Protocols for external access
+@cindex protocols, for external access
+@cindex emacsserver
+
+You can set up Org for handling protocol calls from outside applications that
+are passed to Emacs through the @file{emacsserver}. For example, you can
+configure bookmarks in your web browser to send a link to the current page to
+Org and create a note from it using Remember (@pxref{Remember}). Or you
+could create a bookmark that will tell Emacs to open the local source file of
+a remote website you are looking at with the browser. See
+@uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
+documentation and setup instructions.
+
+
@node Agenda Views, Embedded LaTeX, Capture, Top
@chapter Agenda Views
@cindex agenda views
important for a particular date, this information must be collected,
sorted and displayed in an organized way.
-Org can select items based on various criteria, and display them
+Org can select items based on various criteria and display them
in a separate buffer. Seven different view types are provided:
@itemize @bullet
a @emph{TODO list} that covers all unfinished
action items,
@item
-a @emph{match view}, showings headlines based on the tags, properties and
+a @emph{match view}, showings headlines based on the tags, properties, and
TODO state associated with them,
@item
a @emph{timeline view} that shows all events in a single Org file,
in time-sorted view,
@item
a @emph{keyword search view} that shows all entries from multiple files
-that contain specified keywords.
+that contain specified keywords,
@item
a @emph{stuck projects view} showing projects that currently don't move
along, and
corresponding locations in the original Org files, and even to
edit these files remotely.
+@vindex org-agenda-window-setup
+@vindex org-agenda-restore-windows-after-quit
Two variables control how the agenda buffer is displayed and whether the
window configuration is restored when the agenda exits:
@code{org-agenda-window-setup} and
* Presentation and sorting:: How agenda items are prepared for display
* Agenda commands:: Remote editing of Org trees
* Custom agenda views:: Defining special searches and views
+* Exporting Agenda Views::
* Agenda column view:: Using column view for collected entries
@end menu
@cindex agenda files
@cindex files for agenda
+@vindex org-agenda-files
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
all files with the extension @file{.org} in this directory will be part
of the list.
-Thus even if you only work with a single Org file, this file should
-be put into that list@footnote{When using the dispatcher, pressing
+Thus, even if you only work with a single Org file, that file should
+be put into the list@footnote{When using the dispatcher, pressing
@kbd{<} before selecting a command will actually limit the command to
the current file, and ignore @code{org-agenda-files} until the next
dispatcher command.}. You can customize @code{org-agenda-files}, but
The Org menu contains the current list of files and can be used
to visit any of them.
-If you would like to focus the agenda temporarily onto a file not in
-this list, or onto just one file in the list or even only a subtree in a
-file, this can be done in different ways. For a single agenda command,
+If you would like to focus the agenda temporarily on a file not in
+this list, or on just one file in the list, or even on only a subtree in a
+file, then this can be done in different ways. For a single agenda command,
you may press @kbd{<} once or several times in the dispatcher
(@pxref{Agenda dispatcher}). To restrict the agenda scope for an
extended period, use the following commands:
@end table
@noindent
-When working with @file{Speedbar}, you can use the following commands in
+When working with @file{speedbar.el}, you can use the following commands in
the Speedbar frame:
@table @kbd
@kindex <
@item < @r{in the speedbar frame}
-Permanently restrict the agenda to the item at the cursor in the
-Speedbar frame, either an Org file or a subtree in such a file.
+Permanently restrict the agenda to the item---either an Org file or a subtree
+in such a file---at the cursor in the Speedbar frame.
If there is a window displaying an agenda view, the new restriction takes
effect immediately.
@kindex >
@item > @r{in the speedbar frame}
-Lift the restriction again.
+Lift the restriction.
@end table
@node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
@section The agenda dispatcher
@cindex agenda dispatcher
@cindex dispatching agenda commands
-The views are created through a dispatcher that should be bound to a
-global key, for example @kbd{C-c a} (@pxref{Installation}). In the
+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
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
Create a list of entries selected by a boolean expression of keywords
and/or regular expressions that must or must not occur in the entry.
@item /
+@vindex org-agenda-text-search-extra-files
Search for a regular expression in all agenda files and additionally in
-the files listed in @code{org-agenda-multi-occur-extra-files}. This
+the files listed in @code{org-agenda-text-search-extra-files}. This
uses the Emacs command @code{multi-occur}. A prefix argument can be
used to specify the number of context lines for each match, default is
1.
If there is an active region, restrict the following agenda command to
the region. Otherwise, restrict it to the current subtree@footnote{For
backward compatibility, you can also press @kbd{0} to restrict to the
-current buffer.}. After pressing @kbd{< <}, you still need to press the
+current region/subtree.}. After pressing @kbd{< <}, you still need to press the
character selecting the command.
@end table
@cindex org-agenda, command
@kindex C-c a a
@item C-c a a
-Compile an agenda for the current week from a list of org files. The agenda
+@vindex org-agenda-ndays
+Compile an agenda for the current week from a list of Org files. The agenda
shows the entries for each day. With a numeric prefix@footnote{For backward
compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
listed before the agenda. This feature is deprecated, use the dedicated TODO
@end lisp
@noindent After that, everything will happen automatically. All diary
-entries including holidays, anniversaries etc will be included in the
+entries including holidays, anniversaries, etc., will be included in the
agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
@key{RET} can be used from the agenda buffer to jump to the diary
file in order to edit existing diary entries. The @kbd{i} command to
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 white space is allowed before them. For example,
+the left margin, no whitespace is allowed before them. For example,
the following segment of an Org file will be processed and entries
will be made in the agenda:
%%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
@end example
+@subsubheading Anniversaries from BBDB
+@cindex BBDB, anniversaries
+@cindex anniversaries, from BBDB
+
+If you are using the Big Brothers Database to store your contacts, you will
+very likely prefer to store anniversaries in BBDB rather than in a
+separate Org or diary file. Org supports this and will show BBDB
+anniversaries as part of the agenda. All you need to do is to add the
+following to one your your agenda files:
+
+@example
+* Anniversaries
+ :PROPERTIES:
+ :CATEGORY: Anniv
+ :END
+%%(org-bbdb-anniversaries)
+@end example
+
+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.
+
+@example
+1973-06-22
+1955-08-02 wedding
+2008-04-14 %s released version 6.01 of org-mode, %d years ago
+@end example
+
+After a change to BBDB, or for the first agenda display during an Emacs
+session, the agenda display will suffer a short delay as Org updates its
+hash with anniversaries. However, from then on things will be very fast---much
+faster in fact than a long list of @samp{%%(diary-anniversary)} entries
+in an Org or Diary file.
+
@subsubheading Appointment reminders
@cindex @file{appt.el}
@cindex appointment reminders
-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 commands 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.
+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.
@node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
@subsection The global TODO list
@cindex global TODO list
@cindex TODO list, global
-The global TODO list contains all unfinished TODO items, formatted and
+The global TODO list contains all unfinished TODO items formatted and
collected into a single place.
@table @kbd
@kindex C-c a T
@item C-c a T
@cindex TODO keyword matching
+@vindex org-todo-keywords
Like the above, but allows selection of a specific TODO keyword. You
can also do this by specifying a prefix argument to @kbd{C-c a t}. With
a @kbd{C-u} prefix you are prompted for a keyword, and you may also
-specify several keywords by separating them with @samp{|} as boolean OR
-operator. With a numeric prefix, the Nth keyword in
+specify several keywords by separating them with @samp{|} as the boolean OR
+operator. With a numeric prefix, the nth keyword in
@code{org-todo-keywords} is selected.
@kindex r
The @kbd{r} key in the agenda buffer regenerates it, and you can give
it more compact:
@itemize @minus
@item
-Some people view a TODO item that has been @emph{scheduled} for
-execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the
-variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
-items from the global TODO list.
-@item
+@vindex org-agenda-todo-ignore-scheduled
+@vindex org-agenda-todo-ignore-deadlines
+@vindex org-agenda-todo-ignore-with-date
+Some people view a TODO item that has been @emph{scheduled} for execution or
+have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
+Configure the variables @code{org-agenda-todo-ignore-scheduled},
+@code{org-agenda-todo-ignore-deadlines}, and/or
+@code{org-agenda-todo-ignore-with-date} to exclude such items from the
+global TODO list.
+@item
+@vindex org-agenda-todo-list-sublevels
TODO items may have sublevels to break up the task into subtasks. In
such cases it may be enough to list only the highest level TODO headline
and omit the sublevels from the global list. Configure the variable
@cindex tags view
@cindex match view
-If headlines in the agenda files are marked with @emph{tags}
-(@pxref{Tags}), you can select headlines based on the tags that apply
-to them and collect them into an agenda buffer.
+If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
+or have properties (@pxref{Properties and Columns}), you can select headlines
+based on this metadata and collect them into an agenda buffer. The match
+syntax described here also applies when creating sparse trees with @kbd{C-c /
+m}.
@table @kbd
@kindex C-c a m
define a custom command for it (@pxref{Agenda dispatcher}).
@kindex C-c a M
@item C-c a M
-Like @kbd{C-c a m}, but only select headlines that are also TODO items
-and force checking subitems (see variable
-@code{org-tags-match-list-sublevels}). Matching specific TODO keywords
-together with a tags match is also possible, see @ref{Tag searches}.
+@vindex org-tags-match-list-sublevels
+@vindex org-agenda-tags-todo-honor-ignore-options
+Like @kbd{C-c a m}, but only select headlines that are also TODO items and
+force checking subitems (see variable @code{org-tags-match-list-sublevels}).
+To exclude scheduled/deadline items, see the variable
+@code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO
+keywords together with a tags match is also possible, see @ref{Tag searches}.
@end table
The commands available in the tags list are described in @ref{Agenda
commands}.
-@node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
-@subsection Timeline for a single file
-@cindex timeline, single file
-@cindex time-sorted view
+@subsubheading Match syntax
-The timeline summarizes all time-stamped items from a single Org mode
-file in a @emph{time-sorted view}. The main purpose of this command is
-to give an overview over events in a project.
+@cindex Boolean logic, for tag/property searches
+A search string can use Boolean operators @samp{&} for AND and @samp{|} for
+OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
+not implemented. Each element in the search is either a tag, a regular
+expression matching tags, or an expression like @code{PROPERTY OPERATOR
+VALUE} with a comparison operator, accessing a property value. Each element
+may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
+sugar for positive selection. The AND operator @samp{&} is optional when
+@samp{+} or @samp{-} is present. Here are some examples, using only tags.
-@table @kbd
-@kindex C-c a L
-@item C-c a L
-Show a time-sorted view of the org file, with all time-stamped items.
-When called with a @kbd{C-u} prefix, all unfinished TODO entries
-(scheduled or not) are also listed under the current date.
+@table @samp
+@item +work-boss
+Select headlines tagged @samp{:work:}, but discard those also tagged
+@samp{:boss:}.
+@item work|laptop
+Selects lines tagged @samp{:work:} or @samp{:laptop:}.
+@item work|laptop+night
+Like before, but require the @samp{:laptop:} lines to be tagged also
+@samp{:night:}.
@end table
-@noindent
-The commands available in the timeline buffer are listed in
-@ref{Agenda commands}.
-
-@node Keyword search, Stuck projects, Timeline, Built-in agenda views
-@subsection Keyword search
-@cindex keyword search
-@cindex searching, for keywords
-
-This agenda view is a general text search facility for Org mode entries.
-It is particularly useful to find notes.
+@cindex regular expressions, with tags search
+Instead of a tag, you may also specify a regular expression enclosed in curly
+braces. For example,
+@samp{work+@{^boss.*@}} matches headlines that contain the tag
+@samp{:work:} and any tag @i{starting} with @samp{boss}.
+
+@cindex TODO keyword matching, with tags search
+@cindex level, require for tags/property match
+@cindex category, require for tags/property match
+@vindex org-odd-levels-only
+You may also test for properties (@pxref{Properties and Columns}) at the same
+time as matching tags. The properties may be real properties, or special
+properties that represent other metadata (@pxref{Special properties}). For
+example, the ``property'' @code{TODO} represents the TODO keyword of the
+entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
+So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
+that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
+DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
+count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
+
+Here are more examples:
+@table @samp
+@item work+TODO="WAITING"
+Select @samp{:work:}-tagged TODO lines with the specific TODO
+keyword @samp{WAITING}.
+@item work+TODO="WAITING"|home+TODO="WAITING"
+Waiting tasks both at work and at home.
+@end table
+
+When matching properties, a number of different operators can be used to test
+the value of a property. Here is a complex example:
+
+@example
++work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
+ +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
+@end example
+
+@noindent
+The type of comparison will depend on how the comparison value is written:
+@itemize @minus
+@item
+If the comparison value is a plain number, a numerical comparison is done,
+and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
+@samp{>=}, and @samp{<>}.
+@item
+If the comparison value is enclosed in double-quotes,
+a string comparison is done, and the same operators are allowed.
+@item
+If the comparison value is enclosed in double-quotes @emph{and} angular
+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, @ie 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.
+@item
+If the comparison value is enclosed
+in curly braces, a regexp match is performed, with @samp{=} meaning that the
+regexp matches the property value, and @samp{<>} meaning that it does not
+match.
+@end itemize
+
+So the search string in the example finds entries tagged @samp{:work:} but
+not @samp{:boss:}, which also have a priority value @samp{A}, a
+@samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
+property that is numerically smaller than 2, a @samp{:With:} property that is
+matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
+on or after October 11, 2008.
+
+Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
+other properties will slow down the search. However, once you have paid the
+price by accessing one property, testing additional properties is cheap
+again.
+
+You can configure Org mode to use property inheritance during a search, but
+beware that this can slow down searches considerably. See @ref{Property
+inheritance}, for details.
+
+For backward compatibility, and also for typing speed, there is also a
+different way to test TODO states in a search. For this, terminate the
+tags/property part of the search string (which may include several terms
+connected with @samp{|}) with a @samp{/} and then specify a Boolean
+expression just for TODO keywords. The syntax is then similar to that for
+tags, but should be applied with care: for example, a positive
+selection on several TODO keywords cannot meaningfully be combined with
+boolean AND. However, @emph{negative selection} combined with AND can be
+meaningful. To make sure that only lines are checked that actually have any
+TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently
+start the TODO part after the slash with @samp{!}. Examples:
+
+@table @samp
+@item work/WAITING
+Same as @samp{work+TODO="WAITING"}
+@item work/!-WAITING-NEXT
+Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
+nor @samp{NEXT}
+@item work/!+WAITING|+NEXT
+Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
+@samp{NEXT}.
+@end table
+
+@node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
+@subsection Timeline for a single file
+@cindex timeline, single file
+@cindex time-sorted view
+
+The timeline summarizes all time-stamped items from a single Org mode
+file in a @emph{time-sorted view}. The main purpose of this command is
+to give an overview over events in a project.
+
+@table @kbd
+@kindex C-c a L
+@item C-c a L
+Show a time-sorted view of the Org file, with all time-stamped items.
+When called with a @kbd{C-u} prefix, all unfinished TODO entries
+(scheduled or not) are also listed under the current date.
+@end table
+
+@noindent
+The commands available in the timeline buffer are listed in
+@ref{Agenda commands}.
+
+@node Keyword search, Stuck projects, Timeline, Built-in agenda views
+@subsection Keyword search
+@cindex keyword search
+@cindex searching, for keywords
+
+This agenda view is a general text search facility for Org mode entries.
+It is particularly useful to find notes.
@table @kbd
@kindex C-c a s
not matched by the regular expression @code{8\.11[bg]}, meaning to
exclude both 8.11b and 8.11g.
+@vindex org-agenda-text-search-extra-files
Note that in addition to the agenda files, this command will also search
the files listed in @code{org-agenda-text-search-extra-files}.
@end table
List projects that are stuck.
@kindex C-c a !
@item C-c a !
+@vindex org-stuck-projects
Customize the variable @code{org-stuck-projects} to define what a stuck
project is and how to find it.
@end table
is a next action even without the NEXT tag. Finally, if the project
contains the special word IGNORE anywhere, it should not be listed
either. In this case you would start by identifying eligible projects
-with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
-TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
-are not stuck. The correct customization for this is
+with a tags/todo match@footnote{@xref{Tag searches}.}
+@samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
+IGNORE in the subtree to identify projects that are not stuck. The
+correct customization for this is
@lisp
(setq org-stuck-projects
"\\<IGNORE\\>"))
@end lisp
+Note that if a project is identified as non-stuck, the subtree of this entry
+will still be searched for stuck projects.
@node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
@section Presentation and sorting
@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}
The category is a broad label assigned to each agenda item. By default,
the category is simply derived from the file name, but you can also
specify it with a special line in the buffer, like this@footnote{For
-backward compatibility, the following also works: If there are several
+backward compatibility, the following also works: if there are several
such lines in a file, each specifies the category for the text below it.
The first category also applies to any text before the first CATEGORY
line. However, using this method is @emph{strongly} deprecated as it is
@end example
@noindent
+@cindex property, CATEGORY
If you would like to have a special CATEGORY for a single entry or a
(sub)tree, give the entry a @code{:CATEGORY:} property with the
special category you want to apply as the value.
@cindex time-of-day specification
Org mode checks each agenda item for a time-of-day specification. The
-time can be part of the time stamp that triggered inclusion into the
+time can be part of the timestamp that triggered inclusion into the
agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
-ranges can be specified with two time stamps, like
+ranges can be specified with two timestamps, like
@c
@w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
20:30-22:15 Marvin escorts the Hitchhikers to the bridge
@end example
+@vindex org-agenda-use-time-grid
+@vindex org-agenda-time-grid
The time grid can be turned on and off with the variable
@code{org-agenda-use-time-grid}, and can be configured with
@code{org-agenda-time-grid}.
done depends on the type of view.
@itemize @bullet
@item
+@vindex org-agenda-files
For the daily/weekly agenda, the items for each day are sorted. The
default order is to first collect all items containing an explicit
time-of-day specification. These entries will be shown at the beginning
@item
For the TODO list, items remain in the order of categories, but within
each category, sorting takes place according to priority
-(@pxref{Priorities}).
+(@pxref{Priorities}). The priority used for sorting derives from the
+priority cookie, with additions depending on how close an item is to its due
+or scheduled date.
@item
For tags matches, items are not sorted at all, but just appear in the
sequence in which they are found in the agenda files.
@end itemize
+@vindex org-agenda-sorting-strategy
Sorting can be customized using the variable
@code{org-agenda-sorting-strategy}, and may also include criteria based on
the estimated effort of an entry (@pxref{Effort estimates}).
@section Commands in the agenda buffer
@cindex commands, in agenda buffer
-Entries in the agenda buffer are linked back to the org file or diary
+Entries in the agenda buffer are linked back to the Org file or diary
file where they originate. You are not allowed to edit the agenda
buffer itself, but commands are provided to show and jump to the
-original entry location, and to edit the org-files ``remotely'' from
+original entry location, and to edit the Org files ``remotely'' from
the agenda buffer. In this way, all information is stored only once,
removing the risk that your agenda and note files may diverge.
@kindex p
@item p
Previous line (same as @key{down} and @kbd{C-n}).
-@tsubheading{View/Go to org file}
+@tsubheading{View/Go to Org file}
@kindex mouse-3
@kindex @key{SPC}
@item mouse-3
@c
@kindex f
@item f
+@vindex org-agenda-start-with-follow-mode
Toggle Follow mode. In Follow mode, as you move the cursor through
the agenda buffer, the other window always shows the corresponding
-location in the org file. The initial setting for this mode in new
+location in the Org file. The initial setting for this mode in new
agenda buffers can be set with the variable
@code{org-agenda-start-with-follow-mode}.
@c
negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
previously used indirect buffer.
@c
+@kindex v l
@kindex l
-@item l
+@item v l @ @r{or short} @ l
+@vindex org-log-done
+@vindex org-agenda-log-mode-items
Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
logging was on (variable @code{org-log-done}) are shown in the agenda, as are
entries that have been clocked on that day. You can configure the entry
all possible logbook entries, including state changes. When called with two
prefix args @kbd{C-u C-u}, show only logging information, nothing else.
@c
-@kindex v
-@item v
-Toggle Archives mode. In archives mode, trees that are marked
-@code{ARCHIVED} are also scanned when producing the agenda. When you call
-this command with a @kbd{C-u} prefix argument, even all archive files are
-included. To exit archives mode, press @kbd{v} again.
+@kindex v a
+@kindex v A
+@item v a
+@itemx v A
+Toggle Archives mode. In Archives mode, trees that are marked
+@code{ARCHIVED} are also scanned when producing the agenda. When you use the
+capital @kbd{A}, even all archive files are included. To exit archives mode,
+press @kbd{v a} again.
@c
@kindex R
@item R
-Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
+@vindex org-agenda-start-with-clockreport-mode
+Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
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
@item o
Delete other windows.
@c
+@kindex v d
@kindex d
+@kindex v w
@kindex w
-@kindex m
-@kindex y
-@item d w m y
+@kindex v m
+@kindex v y
+@item v d @ @r{or short} @ d
+@itemx v w @ @r{or short} @ w
+@itemx v m
+@itemx v y
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.
@c
@kindex G
@item G
+@vindex org-agenda-use-time-grid
+@vindex org-agenda-time-grid
Toggle the time grid on and off. See also the variables
@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
@c
@kindex r
@item r
Recreate the agenda buffer, for example to reflect the changes after
-modification of the time stamps of items with @kbd{S-@key{left}} and
+modification of the timestamps of items with 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.
@kindex C-x C-s
@item s
@itemx C-x C-s
-Save all Org buffers in the current Emacs session.
+Save all Org buffers in the current Emacs session, and also the locations of
+IDs.
@c
@kindex @key{right}
@item @key{right}
+@vindex org-agenda-ndays
Display the following @code{org-agenda-ndays} days. For example, if
the display covers a week, switch to the following week. With prefix
arg, go forward that many times @code{org-agenda-ndays} days.
@item .
Go to today.
@c
+@kindex j
+@item j
+Prompt for a date and go there.
+@c
@kindex C-c C-x C-c
@item C-c C-x C-c
+@vindex org-columns-default-format
Invoke column view (@pxref{Column view}) in the agenda buffer. The column
view format is taken from the entry at point, or (if there is no entry at
point), from the first entry in the agenda view. So whatever the format for
@code{#+COLUMNS} line, or from the default variable
@code{org-columns-default-format}), will be used in the agenda.
+@kindex C-c C-x >
+@item C-c C-x >
+Remove the restriction lock on the agenda, if it is currently restricted to a
+file or subtree (@pxref{Agenda files}).
+
@tsubheading{Secondary filtering and query editing}
@cindex filtering, by tag and effort, in agenda
@cindex tag filtering, in agenda
@kindex /
@item /
+@vindex org-agenda-filter-preset
Filter the current agenda view with respect to a tag and/or effort estimates.
-The difference between this and a custom agenda commands is that filtering is
+The difference between this and a custom agenda command is that filtering is
very fast, so that you can switch quickly between different filters without
-having to recreate the agenda.
+having to recreate the agenda@footnote{Custom commands can preset a filter by
+binding the variable @code{org-agenda-filter-preset} as an option. This
+filter will then be applied to the view and persist as a basic filter through
+refreshes and more secondary filtering.}
You will be prompted for a tag selection letter. Pressing @key{TAB} at that
prompt will offer use completion to select a tag (including any tags that do
@kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\}
command.
+@vindex org-sort-agenda-noeffort-is-high
In order to filter for effort estimates, you should set-up allowed
efforts globally, for example
@lisp
(setq org-global-properties
'(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
@end lisp
-You can then filter for an effort by first typing an operator, one of @kbd{<},
-@kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
-your array of allowed values, where @kbd{0} means the 10th value. The filter
-will then restrict to entries with effort smaller-or-equal, equal, or
-larger-or-equal than the selected value. If the digits 0-9 are not used as
-fast access keys to tags, you can also simply press the index digit directly
-without an operator. In this case, @kbd{<} will be assumed.
+You can then filter for an effort by first typing an operator, one of
+@kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
+estimate in your array of allowed values, where @kbd{0} means the 10th value.
+The filter will then restrict to entries with effort smaller-or-equal, equal,
+or larger-or-equal than the selected value. If the digits 0-9 are not used
+as fast access keys to tags, you can also simply press the index digit
+directly without an operator. In this case, @kbd{<} will be assumed. For
+application of the operator, entries without a defined effort will be treated
+according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
+for tasks without effort definition, press @kbd{?} as the operator.
@kindex \
@item \
@c
@kindex C-k
@item C-k
+@vindex org-agenda-confirm-kill
Delete the current agenda item along with the entire subtree belonging
to it in the original Org file. If the text to be deleted remotely
is longer than one line, the kill needs to be confirmed by the user. See
variable @code{org-agenda-confirm-kill}.
@c
+@kindex C-c C-w
+@item C-c C-w
+Refile the entry at point.
+@c
@kindex a
@item a
Toggle the ARCHIVE tag for the current headline.
@c
@kindex A
@item A
-Move the subtree corresponding to the current entry to its @emph{Archive
-Sibling}.
+Move the subtree corresponding to the current entry to its @emph{archive
+sibling}.
@c
@kindex $
@item $
@c
@kindex T
@item T
+@vindex org-agenda-show-inherited-tags
Show all tags associated with the current item. This is useful if you have
turned off @code{org-agenda-show-inherited-tags}, but still want to see all
tags of a headline occasionally.
@itemx S-@key{down}
Decrease the priority of the current item.
@c
+@kindex z
+@item z
+@vindex org-log-into-drawer
+Add a note to the entry. This note will be recorded, and then files to the
+same location where state change notes are put. Depending on
+@code{org-log-into-drawer}, this maybe inside a drawer.
+@c
@kindex C-c C-a
@item C-c C-a
Dispatcher for all command related to attachments.
s @r{Schedule the marked entry at the date at point.}
r @r{Call @code{org-remember} with the cursor date as default date.}
@end example
+@noindent
Press @kbd{r} afterward to refresh the agenda and see the effect of the
command.
@c
@kindex S-@key{right}
@item S-@key{right}
-Change the time stamp associated with the current line by one day into the
+Change the timestamp associated with the current line by one day into the
future. With a numeric prefix argument, change it by that many days. For
-example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is
-changed in the original org file, but the change is not directly reflected in
-the agenda buffer. Use the @kbd{r} key to update the buffer.
+example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
+@kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
+command, it will continue to change hours even without the prefix arg. With
+a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
+is changed in the original Org file, but the change is not directly reflected
+in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
@c
@kindex S-@key{left}
@item S-@key{left}
-Change the time stamp associated with the current line by one day
+Change the timestamp associated with the current line by one day
into the past.
@c
@kindex >
@item >
-Change the time stamp associated with the current line to today.
+Change the timestamp associated with the current line to today.
The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
on my keyboard.
@c
@item J
Jump to the running clock in another window.
+@tsubheading{Bulk remote editing selected entries}
+@cindex remote editing, bulk, from agenda
+
+@kindex m
+@item s
+Mark the entry at point for bulk action.
+
+@kindex u
+@item u
+Unmark entry for bulk action.
+
+@kindex U
+@item U
+Unmark all marked entries for bulk action.
+
+@kindex B
+@item B
+Bulk action: act on all marked entries in the agenda. This will prompt for
+another key to select the action to be applied:
+@example
+r @r{Prompt for a single refile target and move all entries. The entries}
+ @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.}
+$ @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{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}.}
+d @r{Set deadline to a specific date.}
+@end example
+
+
@tsubheading{Calendar commands}
@cindex calendar commands, from agenda
@kindex c
@item i
Insert a new entry into the diary. Prompts for the type of entry
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
-entry in the diary, just as @kbd{i d} etc. would do in the calendar.
+entry in the diary, just as @kbd{i d}, etc., would do in the calendar.
The date is taken from the cursor position.
@c
@kindex M
@kindex S
@item S
Show sunrise and sunset times. The geographical location must be set
-with calendar variables, see documentation of the Emacs calendar.
+with calendar variables, see the documentation for the Emacs calendar.
@c
@kindex C
@item C
@c
@kindex H
@item H
-Show holidays for three month around the cursor date.
+Show holidays for three months around the cursor date.
@item M-x org-export-icalendar-combine-agenda-files
Export a single iCalendar file containing entries from all agenda files.
@item C-x C-w
@cindex exporting agenda views
@cindex agenda views, exporting
-Write the agenda view to a file. Depending on the extension of the
-selected file name, the view will be exported as HTML (extension
-@file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
-plain text (any other extension). Use the variable
-@code{org-agenda-exporter-settings} to set options for @file{ps-print}
-and for @file{htmlize} to be used during export.
+@vindex org-agenda-exporter-settings
+Write the agenda view to a file. Depending on the extension of the selected
+file name, the view will be exported as HTML (extension @file{.html} or
+@file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
+or plain text (any other extension). When called with a @kbd{C-u} prefix
+argument, immediately open the newly created file. Use the variable
+@code{org-agenda-exporter-settings} to set options for @file{ps-print} and
+for @file{htmlize} to be used during export.
@tsubheading{Quit and Exit}
@kindex q
@item x
Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
for the compilation of the agenda. Buffers created by the user to
-visit org files will not be removed.
+visit Org files will not be removed.
@end table
-@node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
+@node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
@section Custom agenda views
@cindex custom agenda views
@cindex agenda views, custom
* Storing searches:: Type once, use often
* Block agenda:: All the stuff you need in a single buffer
* Setting Options:: Changing the rules
-* Exporting Agenda Views:: Writing agendas to files
-* Using the agenda elsewhere:: Using agenda information in other programs
@end menu
@node Storing searches, Block agenda, Custom agenda views, Custom agenda views
buffer, or a sparse tree (the latter covering of course only the current
buffer).
@kindex C-c a C
+@vindex org-agenda-custom-commands
Custom commands are configured in the variable
@code{org-agenda-custom-commands}. You can customize this variable, for
example by pressing @kbd{C-c a C}. You can also directly set it with
@samp{home}, and also all lines tagged with @samp{garden}. Finally the
command @kbd{C-c a o} provides a similar view for office tasks.
-@node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
+@node Setting Options, , Block agenda, Custom agenda views
@subsection Setting options for custom commands
@cindex options, for custom agenda views
+@vindex org-agenda-custom-commands
Org mode contains a number of variables regulating agenda construction
and display. The global variables define the behavior for all agenda
commands, including the custom commands. However, if you want to change
will be shown. The command @kbd{C-c a N} will do a text search limited
to only a single file.
+@vindex org-agenda-custom-commands
For command sets creating a block agenda,
@code{org-agenda-custom-commands} has two separate spots for setting
options. You can add options that should be valid for just a single
@end group
@end lisp
-As you see, the values and parenthesis setting is a little complex.
-When in doubt, use the customize interface to set this variable - it
-fully supports its structure. Just one caveat: When setting options in
-this interface, the @emph{values} are just lisp expressions. So if the
-value is a string, you need to add the double quotes around the value
+As you see, the values and parentheses setting is a little complex.
+When in doubt, use the customize interface to set this variable---it
+fully supports its structure. Just one caveat: when setting options in
+this interface, the @emph{values} are just Lisp expressions. So if the
+value is a string, you need to add the double-quotes around the value
yourself.
-@node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
-@subsection Exporting Agenda Views
+@node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
+@section Exporting Agenda Views
@cindex agenda views, exporting
If you are away from your computer, it can be very useful to have a printed
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, and iCalendar files. If you want to do this
-only occasionally, use the command
+@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
+you want to do this only occasionally, use the command
@table @kbd
@kindex C-x C-w
@item C-x C-w
@cindex exporting agenda views
@cindex agenda views, exporting
+@vindex org-agenda-exporter-settings
Write the agenda view to a file. Depending on the extension of the
selected file name, the view will be exported as HTML (extension
@file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
set options for @file{ps-print} and for @file{htmlize} to be used during
export, for example
+@vindex org-agenda-add-entry-text-maxlines
+@vindex htmlize-output-type
+@vindex ps-number-of-columns
+@vindex ps-landscape-mode
@lisp
(setq org-agenda-exporter-settings
'((ps-number-of-columns 2)
(ps-landscape-mode t)
+ (org-agenda-add-entry-text-maxlines 5)
(htmlize-output-type 'css)))
@end lisp
@end table
@footnote{If you want to store standard views like the weekly agenda
or the global TODO list as well, you need to define custom commands for
them in order to be able to specify file names.}. Here is an example
-that first does define custom commands for the agenda and the global
-todo list, together with a number of files to which to export them.
+that first defines custom commands for the agenda and the global
+TODO list, together with a number of files to which to export them.
Then we define two block agenda commands and specify file names for them
as well. File names can be relative to the current working directory,
or absolute.
@file{.html}, Org mode will use the @file{htmlize.el} package to convert
the buffer to HTML and save it to this file name. If the extension is
@file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
-postscript output. If the extension is @file{.ics}, iCalendar export is
+Postscript output. If the extension is @file{.ics}, iCalendar export is
run export over all files that were used to construct the agenda, and
-limit the export to entries listed in the agenda now. Any other
+limit the export to entries listed in the agenda. Any other
extension produces a plain ASCII file.
The export files are @emph{not} created when you use one of those
@end lisp
@noindent
-This command sets two options for the postscript exporter, to make it
-print in two columns in landscape format - the resulting page can be cut
+This command sets two options for the Postscript exporter, to make it
+print in two columns in landscape format---the resulting page can be cut
in two and then used in a paper agenda. The remaining settings modify
the agenda prefix to omit category and scheduling information, and
instead include a checkbox to check off items. We also remove the tags
emacs -f org-batch-store-agenda-views -kill
@end example
@noindent
-or, if you need to modify some parameters@footnote{Quoting may depend on the
-system you use, please check th FAQ for examples.}
+or, if you need to modify some parameters@footnote{Quoting depends on the
+system you use, please check the FAQ for examples.}
@example
emacs -eval '(org-batch-store-agenda-views \
org-agenda-ndays 30 \
@end example
@noindent
which will create the agenda views restricted to the file
-@file{~/org/project.org}, without diary entries and with 30 days
+@file{~/org/project.org}, without diary entries and with a 30-day
extent.
-@node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
-@subsection Using agenda information outside of Org
-@cindex agenda, pipe
-@cindex Scripts, for agenda processing
-
-Org provides commands to access agenda information for the command
-line in emacs batch mode. This extracted information can be sent
-directly to a printer, or it can be read by a program that does further
-processing of the data. The first of these commands is the function
-@code{org-batch-agenda}, that produces an agenda view and sends it as
-ASCII text to STDOUT. The command takes a single string as parameter.
-If the string has length 1, it is used as a key to one of the commands
-you have configured in @code{org-agenda-custom-commands}, basically any
-key you can use after @kbd{C-c a}. For example, to directly print the
-current TODO list, you could use
-
-@example
-emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
-@end example
-
-If the parameter is a string with 2 or more characters, it is used as a
-tags/todo match string. For example, to print your local shopping list
-(all items with the tag @samp{shop}, but excluding the tag
-@samp{NewYork}), you could use
-
-@example
-emacs -batch -l ~/.emacs \
- -eval '(org-batch-agenda "+shop-NewYork")' | lpr
-@end example
-
-@noindent
-You may also modify parameters on the fly like this:
-
-@example
-emacs -batch -l ~/.emacs \
- -eval '(org-batch-agenda "a" \
- org-agenda-ndays 30 \
- org-agenda-include-diary nil \
- org-agenda-files (quote ("~/org/project.org")))' \
- | lpr
-@end example
-
-@noindent
-which will produce a 30 day agenda, fully restricted to the Org file
-@file{~/org/projects.org}, not even including the diary.
-
-If you want to process the agenda data in more sophisticated ways, you
-can use the command @code{org-batch-agenda-csv} to get a comma-separated
-list of values for each agenda item. Each line in the output will
-contain a number of fields separated by commas. The fields in a line
-are:
-
-@example
-category @r{The category of the item}
-head @r{The headline, without TODO kwd, TAGS and PRIORITY}
-type @r{The type of the agenda entry, can be}
- todo @r{selected in TODO match}
- tagsmatch @r{selected in tags match}
- diary @r{imported from diary}
- deadline @r{a deadline}
- scheduled @r{scheduled}
- timestamp @r{appointment, selected by timestamp}
- closed @r{entry was closed on date}
- upcoming-deadline @r{warning about nearing deadline}
- past-scheduled @r{forwarded scheduled item}
- block @r{entry has date block including date}
-todo @r{The TODO keyword, if any}
-tags @r{All tags including inherited ones, separated by colons}
-date @r{The relevant date, like 2007-2-14}
-time @r{The time, like 15:00-16:50}
-extra @r{String with extra planning info}
-priority-l @r{The priority letter if any was given}
-priority-n @r{The computed numerical priority}
-@end example
-
-@noindent
-Time and date will only be given if a timestamp (or deadline/scheduled)
-lead to the selection of the item.
-
-A CSV list like this is very easy to use in a post processing script.
-For example, here is a Perl program that gets the TODO list from
-Emacs/Org and prints all the items, preceded by a checkbox:
-
-@example
-@group
-#!/usr/bin/perl
-
-# define the Emacs command to run
-$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
-
-# run it and capture the output
-$agenda = qx@{$cmd 2>/dev/null@};
-
-# loop over all lines
-foreach $line (split(/\n/,$agenda)) @{
-
- # get the individual values
- ($category,$head,$type,$todo,$tags,$date,$time,$extra,
- $priority_l,$priority_n) = split(/,/,$line);
+You can also extract agenda information in a way that allows further
+processing by other programs. See @ref{Extracting agenda information}, for
+more information.
- # process and print
- print "[ ] $head\n";
-@}
-@end group
-@end example
-@node Agenda column view, , Custom agenda views, Agenda Views
+@node Agenda column view, , Exporting Agenda Views, Agenda Views
@section Using column view in the agenda
@cindex column view, in agenda
@cindex agenda, column view
@enumerate
@item
+@vindex org-columns-default-format
+@vindex org-overriding-columns-format
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
-currently set, and if yes takes the format from there. Otherwise it takes
+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 it's file), it
+does not have a specific format (defined in a property, or in its file), it
uses @code{org-columns-default-format}.
@item
+@cindex property, special, CLOCKSUM
If any of the columns has a summary type defined (@pxref{Column attributes}),
turning on column view in the agenda will visit all relevant agenda files and
make sure that the computations of this property are up to date. This is
cover a single day, in all other views they cover the entire block. It is
vital to realize that the agenda may show the same entry @emph{twice} (for
example as scheduled and as a deadline), and it may show two entries from the
-same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
+same hierarchy (for example a @emph{parent} and its @emph{child}). In these
cases, the summation in the agenda will lead to incorrect results because
some values will count double.
@item
the entire clocked time for this item. So even in the daily/weekly agenda,
the clocksum listed in column view may originate from times outside the
current view. This has the advantage that you can compare these values with
-a column listing the planned total effort for a task - one of the major
+a column listing the planned total effort for a task---one of the major
applications for column view in the agenda. If you want information about
clocked time in the displayed period use clock table mode (press @kbd{R} in
the agenda).
@node Embedded LaTeX, Exporting, Agenda Views, Top
-@chapter Embedded LaTeX
+@chapter Embedded La@TeX{}
@cindex @TeX{} interpretation
@cindex La@TeX{} interpretation
to do with it.
@menu
-* Math symbols:: TeX macros for symbols and Greek letters
+* Math symbols:: @TeX{} macros for symbols and Greek letters
* Subscripts and superscripts:: Simple syntax for raising/lowering text
* LaTeX fragments:: Complex formulas made easy
-* Processing LaTeX fragments:: Previewing LaTeX processing
+* Processing LaTeX fragments:: Previewing La@TeX{} processing
* CDLaTeX mode:: Speed up entering of formulas
@end menu
@node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
@section Math symbols
@cindex math symbols
-@cindex TeX macros
+@cindex @TeX{} macros
You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to
indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
@example
Angles are written as Greek letters \alpha, \beta and \gamma.
@end example
-
+@noindent
During HTML export (@pxref{HTML export}), these symbols are translated
into the proper syntax for HTML, for the above examples this is
@samp{α} and @samp{→}, respectively. If you need such a symbol
@end example
To avoid interpretation as raised or lowered text, you can quote
-@samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
+@samp{^} and @samp{_} with a backslash: @samp{\^} and @samp{\_}.
During HTML export (@pxref{HTML export}), subscript and superscripts
are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
@node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
-@section LaTeX fragments
-@cindex LaTeX fragments
+@section La@TeX{} fragments
+@cindex La@TeX{} fragments
+@vindex org-format-latex-header
With symbols, sub- and superscripts, HTML is pretty much at its end when
it comes to representing mathematical formulas@footnote{Yes, there is
MathML, but that is not yet fully supported by many browsers, and there
@end example
@noindent
+@vindex org-format-latex-options
If you need any of the delimiter ASCII sequences for other purposes, you
can configure the option @code{org-format-latex-options} to deselect the
ones you do not wish to have interpreted by the La@TeX{} converter.
@section Processing LaTeX fragments
@cindex LaTeX fragments, preview
-La@TeX{} fragments can be processed to produce a preview images of the
+La@TeX{} fragments can be processed to produce preview images of the
typeset expressions:
@table @kbd
@end lisp
@node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
-@section Using CDLaTeX to enter math
-@cindex CDLaTeX
+@section Using CDLa@TeX{} to enter math
+@cindex CDLa@TeX{}
-CDLaTeX mode is a minor mode that is normally used in combination with a
-major La@TeX{} mode like AUCTeX in order to speed-up insertion of
+CDLa@TeX{} mode is a minor mode that is normally used in combination with a
+major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of
environments and math templates. Inside Org mode, you can make use of
-some of the features of CDLaTeX mode. You need to install
+some of the features of CDLa@TeX{} mode. You need to install
@file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
-AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
-Don't use CDLaTeX mode itself under Org mode, but use the light
+AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
+Don't use CDLa@TeX{} mode itself under Org mode, but use the light
version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
Org files with
@end lisp
When this mode is enabled, the following features are present (for more
-details see the documentation of CDLaTeX mode):
+details see the documentation of CDLa@TeX{} mode):
@itemize @bullet
@kindex C-c @{
@item
@item
@kindex _
@kindex ^
+@vindex cdlatex-simplify-sub-super-scripts
Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
characters together with a pair of braces. If you use @key{TAB} to move
out of the braces, and if the braces surround only a single character or
after the backquote, a help window will pop up.
@item
@kindex '
-Pressing the normal quote @kbd{'} followed by another character modifies
+Pressing the single-quote @kbd{'} followed by another character modifies
the symbol before point with an accent or a font. If you wait more than
1.5 seconds after the backquote, a help window will pop up. Character
modification will work only inside La@TeX{} fragments, outside the quote
@chapter Exporting
@cindex exporting
-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. La@TeX{} export lets
-you use Org mode and its structured editing functions to easily create
-La@TeX{} files. 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-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. La@TeX{} export lets you use Org mode and
+its structured editing functions to easily create La@TeX{} files. DocBook
+export makes it possible to convert Org files to many other formats using
+DocBook tools. 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).
* The export dispatcher:: How to access exporter commands
* ASCII export:: Exporting to plain ASCII
* HTML export:: Exporting to HTML
-* LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
+* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF
+* DocBook export:: Exporting to DocBook
* XOXO export:: Exporting to XOXO
* iCalendar export:: Exporting in iCalendar format
@end menu
@node Markup rules, Selective export, Exporting, Exporting
@section Markup rules
-When exporting Org mode documents, the exporter tries to reflect the
-structure of the document as accurately as possible in the back-end. Since
-export targets like HTML or La@TeX{} allow much richer formatting, Org mode
-has rules how to prepare text for rich export. This section summarizes the
-markup rule used in an Org mode buffer.
+When exporting Org-mode documents, the exporter tries to reflect the
+structure of the document as accurately as possible in the backend. Since
+export targets like HTML, La@TeX{}, or DocBook allow much richer formatting,
+Org mode has rules on how to prepare text for rich export. This section
+summarizes the markup rules used in an Org-mode buffer.
@menu
* Document title:: How the document title is determined
* Include files:: Include the contents of a file during export
* Tables exported:: Tables are exported richly
* Inlined images:: How to inline images during export
-* Footnote markup::
+* Footnote markup:: ASCII representation of footnotes
* Emphasis and monospace:: To bold or not to bold
* TeX macros and LaTeX fragments:: Create special, rich export.
* Horizontal rules:: A line across the page
* Comment lines:: Some lines will not be exported
+* Macro replacement:: Global replacement of place holders
@end menu
@node Document title, Headings and sections, Markup rules, Markup rules
@noindent
The title of the exported document is taken from the special line
+@cindex #+TITLE
@example
#+TITLE: This is the title of the document
@end example
turned off exporting of the text before the first headline (see below), the
title will be the file name without extension.
+@cindex property, EXPORT_TITLE
If you are exporting only a subtree by marking is as the region, the heading
of the subtree will become the title of the document. If the subtree has a
property @code{EXPORT_TITLE}, that will take precedence.
@subheading Headings and sections
@cindex headings and sections, markup rules
+@vindex org-headline-levels
The outline structure of the document as described in @ref{Document
-Structure} forms the basis for defining sections of the exported document.
+Structure}, forms the basis for defining sections of the exported document.
However, since the outline structure is also used for (for example) lists of
tasks, only the first three outline levels will be used as headings. Deeper
levels will become itemized lists. You can change the location of this
-switch, globally by setting the variable @code{org-headline-levels}, or on a
-per file basis with a line
+switch globally by setting the variable @code{org-headline-levels}, or on a
+per-file basis with a line
+@cindex #+OPTIONS
@example
#+OPTIONS: H:4
@end example
@subheading Table of contents
@cindex table of contents, markup rules
+@vindex org-export-with-toc
The table of contents is normally inserted directly before the first headline
of the file. If you would like to get it to a different location, insert the
string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
location. The depth of the table of contents is by default the same as the
-number of headline levels, but you can choose a smaller number or turn off
-the table of contents entirely by configuring the variable
+number of headline levels, but you can choose a smaller number, or turn off
+the table of contents entirely, by configuring the variable
@code{org-export-with-toc}, or on a per-file basis with a line like
@example
Org mode normally exports the text before the first headline, and even uses
the first line as the document title. The text will be fully marked up. If
-you need to include literal HTML or La@TeX{} code, use the special constructs
-described below in the sections for the individual exporters.
+you need to include literal HTML, La@TeX{}, or DocBook code, use the special
+constructs described below in the sections for the individual exporters.
+@vindex org-export-skip-text-before-1st-heading
Some people like to use the space before the first headline for setup and
internal links and therefore would like to control the exported text before
the first headline in a different way. You can do so by setting the variable
@subheading Lists
@cindex lists, markup rules
-Plain lists as described in @ref{Plain lists} are translated to the back-ends
-syntax for such lists. Most back-ends support unordered, ordered, and
+Plain lists as described in @ref{Plain lists}, are translated to the backend's
+syntax for such lists. Most backends support unordered, ordered, and
description lists.
@node Paragraphs, Literal examples, Lists, Markup rules
To keep the line breaks in a region, but otherwise use normal formatting, you
can use this construct, which can also be used to format poetry.
+@cindex #+BEGIN_VERSE
@example
#+BEGIN_VERSE
Great clouds overhead
When quoting a passage from another document, it is customary to format this
as a paragraph that is indented on both the left and the right margin. You
-can include quotations in Org mode documents like this:
+can include quotations in Org-mode documents like this:
+@cindex #+BEGIN_QUOTE
@example
#+BEGIN_QUOTE
Everything should be made as simple as possible,
#+END_QUOTE
@end example
+If you would like to center some text, do it like this:
+@cindex #+BEGIN_CENTER
+@example
+#+BEGIN_CENTER
+Everything should be made as simple as possible, \\
+but not any simpler
+#+END_CENTER
+@end example
@node Literal examples, Include files, Paragraphs, Markup rules
@subheading Literal examples
@cindex literal examples, markup rules
-@cindex code line refenences, markup rules
+@cindex code line references, markup rules
You can include literal examples that should not be subjected to
markup. Such examples will be typeset in monospace, so this is well suited
#+END_EXAMPLE
@end example
-For simplicity when using small examples, you can also start the example
-lines with a colon followed by a space. There may also be additional
+Note that such blocks may be @i{indented} in order to align nicely with
+indented text and in particular with plain list structure (@pxref{Plain
+lists}). For simplicity when using small examples, you can also start the
+example lines with a colon followed by a space. There may also be additional
whitespace before the colon:
@example
If the example is source code from a programming language, or any other text
that can be marked up by font-lock in Emacs, you can ask for the example to
look like the fontified Emacs buffer@footnote{Currently this works only for
-the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
+the HTML backend, and requires the @file{htmlize.el} package version 1.34 or
later.}. 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:
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 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. If the example/src snippet is numbered, you can also add a @code{-r}
-switch. Then labels will be @i{removed} from the source code and the links
-will be @i{replaced}@footnote{If you want to explain the use of such labels
-themelves in org-mode example code, you can use the @code{-k} switch to make
-sure they are not touched.} with line numbers from the code listing. Here is
-an example:
+targets for special hyperlinks like @code{[[(name)]]} (@ie 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.
+
+You can also add a @code{-r} switch which @i{removes} the labels from the
+source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
+labels in the source code while using line numbers for the links, which might
+be useful to explain those in an org-mode example code.}. With the @code{-n}
+switch, links to these references will be labeled by the line numbers from
+the code listing, otherwise links will use the labels with no parentheses.
+Here is an example:
@example
#+BEGIN_SRC emacs-lisp -n -r
(save-excursion (ref:sc)
(goto-char (point-min)) (ref:jump)
-#+END SRC
-In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]]
+#+END_SRC
+In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
jumps to point-min.
@end example
+@vindex org-coderef-label-format
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, @pxref{Text
+HTML export also allows examples to be published as text areas, @xref{Text
areas in HTML export}.
@table @kbd
@kindex C-c '
@item C-c '
Edit the source code example at point in its native mode. This works by
-switching to an indirect buffer, narrowing the buffer and switching to the
-other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
-exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
-keep them from being interpreted by Org as outline nodes or special
-comments. These commas will be striped for editing with @kbd{C-c '}, and
-also for export.}. Fixed-width
-regions (where each line starts with a colon followed by a space) will be
-edited using @code{artist-mode}@footnote{You may select a different-mode with
-the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
-ASCII drawings easily. Using this command in an empty line will create a new
+switching to a temporary buffer with the source code. You need to exit by
+pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
+or @samp{#} will get a comma prepended, to keep them from being interpreted
+by Org as outline nodes or special comments. These commas will be striped
+for editing with @kbd{C-c '}, and also for export.}, the edited version will
+then replace the old version in the Org buffer. Fixed-width regions
+(where each line starts with a colon followed by a space) will be edited
+using @code{artist-mode}@footnote{You may select a different-mode with the
+variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
+drawings easily. Using this command in an empty line will create a new
fixed-width region.
@kindex C-c l
@item C-c l
@cindex include files, markup rules
During export, you can include the content of another file. For example, to
-include your .emacs file, you could use:
+include your @file{.emacs} file, you could use:
@cindex #+INCLUDE
@example
#+INCLUDE: "~/.emacs" src emacs-lisp
@end example
-
+@noindent
The optional second and third parameter are the markup (@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
@subheading Inlined Images
@cindex inlined images, markup rules
-Some backends (HTML and LaTeX) allow to directly include images into the
-exported document. Org does this, if a link to an image files does not have
-a description part, for example @code{[[./img/a.jpg]]}. If you wish to
-define a caption for the image and maybe a label for internal cross
+Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include images
+into the exported document. Org does this, if a link to an image files does
+not have a description part, for example @code{[[./img/a.jpg]]}. If you wish
+to define a caption for the image and maybe a label for internal cross
references, you can use (before, but close to the link)
@example
@cindex footnotes, markup rules
@cindex @file{footnote.el}
-Footnotes defined in the way descriped in @ref{Footnotes} will be exported by
-all backends. Org does allow multiple references to the same note, and
-different backends support this to varying degree.
+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.
@node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules
@subheading Emphasis and monospace
@cindex strike-through text, markup rules
You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
-in the code and verbatim string is not processed for Org mode specific
+in the code and verbatim string is not processed for Org-mode specific
syntax, it is exported verbatim.
@node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
@subheading @TeX{} macros and La@TeX{} fragments
-@cindex LaTeX fragments, markup rules
-@cindex TeX macros, markup rules
+@cindex La@TeX{} fragments, markup rules
+@cindex @TeX{} macros, markup rules
@cindex HTML entities
-@cindex LaTeX entities
+@cindex La@TeX{} entities
+@vindex org-html-entities
A @TeX{}-like syntax is used to specify special characters. Where possible,
-these will be transformed into the native format of the exporter back-end.
+these will be transformed into the native format of the exporter backend.
Strings like @code{\alpha} will be exported as @code{α} in the HTML
output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
@code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}.
This applies for a large number of entities, with names taken from both HTML
and La@TeX{}, see the variable @code{org-html-entities} for the complete
list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
-after having typed the backslash and maybe a few characters
+after having typed the backslash and optionally a few characters
(@pxref{Completion}).
La@TeX{} fragments are converted into images for HTML export, and they are
A line consisting of only dashes, and at least 5 of them, will be
exported as a horizontal line (@samp{<hr/>} in HTML).
-@node Comment lines, , Horizontal rules, Markup rules
+@node Comment lines, Macro replacement, Horizontal rules, Markup rules
@subheading Comment lines
@cindex comment lines
@cindex exporting, not
+@cindex #+BEGIN_COMMENT
Lines starting with @samp{#} in column zero are treated as comments and will
never be exported. Also entire subtrees starting with the word
Toggle the COMMENT keyword at the beginning of an entry.
@end table
+@node Macro replacement, , Comment lines, Markup rules
+@subheading Macro replacement
+@cindex macro replacement, during export
+@cindex #+MACRO
+
+You can define text snippets with
+
+@example
+#+MACRO: name replacement text $1, $2 are arguments
+@end example
+
+@noindent which can be referenced anywhere in the document (even in
+code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
+defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
+will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
+similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
+@code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
+and to the modification time of the file being exported, respectively.
+@var{FORMAT} should be a format string understood by
+@code{format-time-string}.
+
@node Selective export, Export options, Markup rules, Exporting
@section Selective export
@cindex export, selective by tags
+@vindex org-export-select-tags
+@vindex org-export-exclude-tags
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}.
The whole set of lines can be inserted into the buffer with @kbd{C-c
C-e t}. For individual lines, a good way to make sure the keyword is
correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
-(@pxref{Completion}).
+(@pxref{Completion}). For a summary of other in-buffer settings not
+specifically related to export, see @ref{In-buffer settings}.
+In particular, note that you can place commonly-used (export) options in
+a separate file which can be included using @code{#+SETUPFILE}.
@table @kbd
@kindex C-c C-e t
Insert template with export options, see example below.
@end table
-@cindex #+TITLE:
-@cindex #+AUTHOR:
-@cindex #+DATE:
-@cindex #+EMAIL:
-@cindex #+LANGUAGE:
-@cindex #+TEXT:
-@cindex #+OPTIONS:
-@cindex #+LINK_UP:
-@cindex #+LINK_HOME:
-@cindex #+EXPORT_SELECT_TAGS:
-@cindex #+EXPORT_EXCLUDE_TAGS:
-@example
-#+TITLE: the title to be shown (default is the buffer name)
-#+AUTHOR: the author (default taken from @code{user-full-name})
-#+DATE: A date, fixed, of a format string for @code{format-time-string}
-#+EMAIL: his/her email address (default from @code{user-mail-address})
-#+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 ...
-#+LINK_UP: the ``up'' link of an exported page
-#+LINK_HOME: the ``home'' link of an exported page
+@cindex #+TITLE
+@cindex #+AUTHOR
+@cindex #+DATE
+@cindex #+EMAIL
+@cindex #+DESCRIPTION
+@cindex #+KEYWORDS
+@cindex #+LANGUAGE
+@cindex #+TEXT
+@cindex #+OPTIONS
+@cindex #+BIND
+@cindex #+LINK_UP
+@cindex #+LINK_HOME
+@cindex #+EXPORT_SELECT_TAGS
+@cindex #+EXPORT_EXCLUDE_TAGS
+@cindex #+LATEX_HEADER
+@vindex user-full-name
+@vindex user-mail-address
+@vindex org-export-default-language
+@example
+#+TITLE: the title to be shown (default is the buffer name)
+#+AUTHOR: the author (default taken from @code{user-full-name})
+#+DATE: a date, fixed, of a format string for @code{format-time-string}
+#+EMAIL: his/her email address (default from @code{user-mail-address})
+#+DESCRIPTION: the page description, @eg for the XHTML meta tag
+#+KEYWORDS: the page keywords, @eg for the XHTML meta tag
+#+LANGUAGE: language for HTML, @eg @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
+ @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
+#+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
#+EXPORT_SELECT_TAGS: Tags that select a tree for export
#+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
@end example
timestamp: @r{turn on/off inclusion creation time into exported file}
d: @r{turn on/off inclusion of drawers}
@end example
-
+@noindent
These options take effect in both the HTML and La@TeX{} export, except
for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
@code{nil} for the La@TeX{} export.
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
settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
-@code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
+@code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
+@code{EXPORT_OPTIONS}.
@node The export dispatcher, ASCII export, Export options, Exporting
@section The export dispatcher
@table @kbd
@kindex C-c C-e
@item C-c C-e
+@vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing
command. The prefix arg is passed through to the exporter. A double prefix
@kbd{C-u C-u} causes most commands to be executed in the background, in a
-separate emacs process@footnote{To make this behavior the default, customize
+separate Emacs process@footnote{To make this behavior the default, customize
the variable @code{org-export-run-in-background}.}.
@kindex C-c C-e v
@item C-c C-e v
Like @kbd{C-c C-e}, but only export the text that is currently visible
-(i.e. not hidden by outline visibility).
+(@ie not hidden by outline visibility).
@kindex C-u C-u C-c C-e
@item C-u C-u C-c C-e
+@vindex org-export-run-in-background
Call an the exporter, but reverse the setting of
-@code{org-export-run-in-background}, i.e. request background processing if
-not set, or force processing in the current Emacs process if st.
+@code{org-export-run-in-background}, @ie request background processing if
+not set, or force processing in the current Emacs process if set.
@end table
@node ASCII export, HTML export, The export dispatcher, Exporting
@section ASCII export
@cindex ASCII export
-ASCII export produces a simple and very readable version of an Org mode
+ASCII export produces a simple and very readable version of an Org-mode
file.
@cindex region, active
@table @kbd
@kindex C-c C-e a
@item C-c C-e a
-Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
+@cindex property, EXPORT_FILE_NAME
+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} to be turned on}, only the region will be
+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
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.
+@kindex C-c C-e A
+@item C-c C-e A
+Export to a temporary buffer, do not create a file.
@kindex C-c C-e v a
@item C-c C-e v a
Export only the visible part of the document.
the layout relative to the first line. Should there be lines with less
indentation than the first, these are left alone.
+@vindex org-export-ascii-links-to-notes
+Links will be exported in a footnote-like style, with the descriptive part in
+the text and the link in a note before the next heading. See the variable
+@code{org-export-ascii-links-to-notes} for details and other options.
+
@node HTML export, LaTeX and PDF export, ASCII export, Exporting
@section HTML export
@cindex HTML export
* HTML Export commands:: How to invoke HTML export
* Quoting HTML tags:: Using direct HTML in Org mode
* Links:: Transformation of links for HTML
+* Tables in HTML export:: How to modify the formatting of tables
* Images in HTML export:: How to insert figures into HTML output
* Text areas in HTML export:: An alternative way to show an example
* CSS support:: Changing the appearance of the output
@table @kbd
@kindex C-c C-e h
@item C-c C-e h
-Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
+@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
-without warning. If there is an active region@footnote{this requires
-@code{transient-mark-mode} to be turned on}, only the region will be
+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
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}
@item C-c C-e v R
Export only the visible part of the document.
@item M-x org-export-region-as-html
-Convert the region to HTML under the assumption that it was Org mode
+Convert the region to HTML under the assumption that it was Org-mode
syntax before. This is a global command that can be invoked in any
buffer.
@item M-x org-replace-region-by-HTML
-Replace the active region (assumed to be in Org mode syntax) by HTML
+Replace the active region (assumed to be in Org-mode syntax) by HTML
code.
@end table
simple tags. For more extensive HTML that should be copied verbatim to
the exported file use either
+@cindex #+HTML
+@cindex #+BEGIN_HTML
@example
#+HTML: Literal HTML code for export
@end example
@end example
-@node Links, Images in HTML export, Quoting HTML tags, HTML export
+@node Links, Tables in HTML export, Quoting HTML tags, HTML export
@subsection Links
@cindex links, in HTML export
@cindex internal links, in HTML export
@cindex external links, in HTML export
Internal links (@pxref{Internal links}) will continue to work in HTML. This
-does include automatic links created by radio targets (@pxref{Radio
+includes automatic links created by radio targets (@pxref{Radio
targets}). Links to external files will still work if the target file is on
the same @i{relative} path as the published Org file. Links to other
@file{.org} files will be translated into HTML links under the assumption
If you want to specify attributes for links, you can do so using a special
@code{#+ATTR_HTML} line to define attributes that will be added to the
-@code{<a>} or @code{<img>} tags. Here is an example that sets @code{alt} and
-@code{title} attributes for an inlined image:
+@code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
+and @code{style} attributes for a link:
+@cindex #+ATTR_HTML
@example
-#+ATTR_HTML: alt="This is image A" title="Image with no action"
-[[./img/a.jpg]]
+#+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
+[[http://orgmode.org]]
+@end example
+
+@node Tables in HTML export, Images in HTML export, Links, HTML export
+@subsection Tables
+@cindex tables, in HTML
+@vindex org-export-html-table-tag
+
+Org-mode tables are exported to HTML using the table tag defined in
+@code{org-export-html-table-tag}. The default setting makes tables without
+cell borders and frame. If you would like to change this for individual
+tables, place somthing like the following before the table:
+
+@cindex #+CAPTION
+@example
+#+CAPTION: This is a table with lines around and between cells
+#+ATTR_HTML: border="2" rules="all" frame="all"
@end example
-@node Images in HTML export, Text areas in HTML export, Links, HTML export
+@node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export
@subsection Images
@cindex images, inline in HTML
@cindex inlining images in HTML
+@vindex org-export-html-inline-images
HTML export can inline images given as links in the Org file, and
it can make an image the clickable part of a link. By
-default@footnote{but see the variable
-@code{org-export-html-inline-images}}, images are inlined if a link does
+default@footnote{But see the variable
+@code{org-export-html-inline-images}.}, images are inlined if a link does
not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
while @samp{[[file:myimg.jpg][the image]]} will just produce a link
@samp{the image} that points to the image. If the description part
[[file:highres.jpg][file:thumb.jpg]]
@end example
+If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
+for example:
+
+@cindex #+CAPTION
+@example
+#+CAPTION: A black cat stalking a spider
+#+ATTR_HTML: alt="cat/spider image" title="one second before action"
+[[./img/a.jpg]]
+@end example
+
@noindent
and you could use @code{http} addresses just as well.
@cindex CSS, for HTML export
@cindex HTML export, CSS
+@vindex org-export-html-todo-kwd-class-prefix
+@vindex org-export-html-tag-class-prefix
You can also give style information for the exported file. The HTML exporter
-assigns the following special CSS classes to appropriate parts of the
-document - your style specifications may change these, in addition to any of
-the standard classes like for headlines, tables etc.
-@example
-.todo @r{TODO keywords}
-.done @r{the DONE keyword}
-.timestamp @r{time stamp}
-.timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
-.tag @r{tag in a headline}
-.target @r{target for links}
-div.figure @r{how to format an inlined image}
-.linenr @r{the line number in a code example}
-.code-highlighted @r{for highlighting referenced code lines}
-@end example
-
-Each exported files contains a compact default style that defines these
+assigns the following special CSS classes@footnote{If the classes on TODO
+keywords and tags lead to conflicts, use the variables
+@code{org-export-html-todo-kwd-class-prefix} and
+@code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
+parts of the document---your style specifications may change these, in
+addition to any of the standard classes like for headlines, tables, etc.
+@example
+p.author @r{author information, including email}
+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}
+.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}
+.timestamp-wrapper @r{span around keyword plus timestamp}
+.tag @r{tag in a headline}
+._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
+.target @r{target for links}
+.linenr @r{the line number in a code example}
+.code-highlighted @r{for highlighting referenced code lines}
+div.outline-N @r{div for outline level N (headline plus text))}
+div.outline-text-N @r{extra div for text at outline level N}
+.section-number-N @r{section number in headlines, different for each level}
+div.figure @r{how to format an inlined image}
+pre.src @r{formatted source code}
+pre.example @r{normal example}
+p.verse @r{verse paragraph}
+div.footnotes @r{footnote section headline}
+p.footnote @r{footnote definition paragraph, containing a footnote}
+.footref @r{a footnote reference number (always a <sup>)}
+.footnum @r{footnote number in footnote definition (always <sup>)}
+@end example
+
+@vindex org-export-html-style-default
+@vindex org-export-html-style-include-default
+@vindex org-export-html-style
+@vindex org-export-html-extra
+@vindex org-export-html-style-default
+Each exported file contains a compact default style that defines these
classes in a basic way@footnote{This style is defined in the constant
@code{org-export-html-style-default}, which you should not modify. To turn
inclusion of these defaults off, customize
granular settings, like file-local settings). To set the latter variable
individually for each file, you can use
+@cindex #+STYLE
@example
#+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
@end example
@node Javascript support, , CSS support, HTML export
@subsection Javascript supported display of web pages
-@emph{Sebastian Rose} has written a JavaScript program especially designed to
+@cindex Rose, Sebastian
+Sebastian Rose has written a JavaScript program especially designed to
enhance the web viewing experience of HTML files created with Org. This
program allows you to view large files in two different ways. The first one
is an @emph{Info}-like mode where each section is displayed separately and
view type is a @emph{folding} view much like Org provides inside Emacs. The
script is available at @url{http://orgmode.org/org-info.js} and you can find
the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
-We are serving the script from our site, but if you use it a lot, you might
+We host the script at our site, but if you use it a lot, you might
not want to be dependent on @url{orgmode.org} and prefer to install a local
copy on your own web server.
this is indeed the case. All it then takes to make use of the program is
adding a single line to the Org file:
+@cindex #+INFOJS_OPT
@example
#+INFOJS_OPT: view:info toc:nil
@end example
@r{section for info and folding modes. The default is taken from}
@r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
@r{If this is smaller than in @code{org-headline-levels}, each}
- @r{info/folding section can still contain children headlines.}
+ @r{info/folding section can still contain child headlines.}
toc: @r{Should the table of content @emph{initially} be visible?}
- @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
+ @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
tdepth: @r{The depth of the table of contents. The defaults are taken from}
@r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
-ftoc: @r{Does the css of the page specify a fixed position for the toc?}
+ftoc: @r{Does the css of the page specify a fixed position for the "toc"?}
@r{If yes, the toc will never be displayed as a section.}
ltoc: @r{Should there be short contents (children) in each section?}
- @r{Make this @code{above} it the section should be above initial text.}
+ @r{Make this @code{above} if the section should be above initial text.}
mouse: @r{Headings are highlighted when the mouse is over them. Should be}
@r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
@r{default), only one such button will be present.}
@end example
-
+@noindent
+@vindex org-infojs-options
+@vindex org-export-html-use-infojs
You can choose default values for these options by customizing the variable
@code{org-infojs-options}. If you always want to apply the script to your
pages, configure the variable @code{org-export-html-use-infojs}.
-@node LaTeX and PDF export, XOXO export, HTML export, Exporting
-@section LaTeX and PDF export
-@cindex LaTeX export
+@node LaTeX and PDF export, DocBook export, HTML export, Exporting
+@section La@TeX{} and PDF export
+@cindex La@TeX{} export
@cindex PDF export
+@cindex Guerry, Bastian
Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
further processing, this backend is also used to produce PDF output. Since
-the LaTeX output uses @file{hyperref} to implement links and cross
+the La@TeX{} output uses @file{hyperref} to implement links and cross
references, the PDF output file will be fully linked.
@menu
* LaTeX/PDF export commands:: Which key invokes which commands
-* Quoting LaTeX code:: Incorporating literal LaTeX code
-* Sectioning structure:: Changing sectioning in LaTeX output
-* Tables in LaTeX export:: Options for exporting tables to LaTeX
-* Images in LaTeX export:: How to insert figures into LaTeX output
+* Quoting LaTeX code:: Incorporating literal La@TeX{} code
+* Sectioning structure:: Changing sectioning in La@TeX{} output
+* Tables in LaTeX export:: Options for exporting tables to La@TeX{}
+* Images in LaTeX export:: How to insert figures into La@TeX{} output
@end menu
@node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
-@subsection LaTeX export commands
+@subsection La@TeX{} export commands
@cindex region, active
@cindex active region
@table @kbd
@kindex C-c C-e l
@item C-c C-e l
-Export as La@TeX{} file @file{myfile.tex}. For an org file
+@cindex property EXPORT_FILE_NAME
+Export as La@TeX{} file @file{myfile.tex}. For an Org file
@file{myfile.org}, the ASCII 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} to be turned on}, only the region will be
+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
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}
code.
@kindex C-c C-e p
@item C-c C-e p
-Export as LaTeX and then process to PDF.
+Export as La@TeX{} and then process to PDF.
@kindex C-c C-e d
@item C-c C-e d
-Export as LaTeX and then process to PDF, then open the resulting PDF file.
+Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
@end table
@cindex headline levels, for exporting
+@vindex org-latex-low-levels
In the exported version, the first 3 outline levels will become
headlines, defining a general document structure. Additional levels
will be exported as description lists. The exporter can ignore them or
creates two levels of headings and does the rest as items.
@node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
-@subsection Quoting LaTeX code
+@subsection Quoting La@TeX{} code
-Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
+Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly
inserted into the La@TeX{} file. This includes simple macros like
@samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
you can add special code that should only be present in La@TeX{} export with
the following constructs:
+@cindex #+LaTeX
+@cindex #+BEGIN_LaTeX
@example
#+LaTeX: Literal LaTeX code for export
@end example
@node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
@subsection Sectioning structure
-@cindex LaTeX class
-@cindex LaTeX sectioning structure
+@cindex La@TeX{} class
+@cindex La@TeX{} sectioning structure
By default, the La@TeX{} output uses the class @code{article}.
+@vindex org-export-latex-default-class
+@vindex org-export-latex-classes
+@cindex #+LATEX_HEADER
+@cindex #+LATEX_CLASS
+@cindex property, LATEX_CLASS
You can change this globally by setting a different value for
@code{org-export-latex-default-class} or locally by adding an option like
@code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
property that applies when exporting a region containing only this (sub)tree.
The class should be listed in @code{org-export-latex-classes}, where you can
also define the sectioning structure for each class, as well as defining
-additional classes.
+additional classes. You can also use @code{#+LATEX_HEADER:
+\usepackage@{xyz@}} to add lines to the header.
@node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export
-@subsection Tables in LaTeX export
-@cindex tables, in LaTeX export
+@subsection Tables in La@TeX{} export
+@cindex tables, in La@TeX{} export
-For LaTeX export of a table, you can specify a label and a caption
+For La@TeX{} export of a table, you can specify a label and a caption
(@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to
request a longtable environment for the table, so that it may span several
-pages:
+pages. Finally, you can set the alignment string:
+@cindex #+CAPTION
+@cindex #+LABEL
+@cindex #+ATTR_LaTeX
@example
#+CAPTION: A long table
#+LABEL: tbl:long
-#+ATTR_LaTeX: longtable
+#+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
| ..... | ..... |
| ..... | ..... |
@end example
@node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export
-@subsection Images in LaTeX export
-@cindex images, inline in LaTeX
-@cindex inlining images in LaTeX
+@subsection Images in La@TeX{} export
+@cindex images, inline in La@TeX{}
+@cindex inlining images in La@TeX{}
Images that are linked to without a description part in the link, like
@samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
-output files resulting from LaTeX output. Org will use an
+output files resulting from La@TeX{} output. 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{Markup rules}, the figure will
be wrapped into a @code{figure} environment and thus become a floating
options that can be used in the optional argument of the
@code{\includegraphics} macro.
+@cindex #+CAPTION
+@cindex #+LABEL
+@cindex #+ATTR_LaTeX
@example
#+CAPTION: The black-body emission of the disk around HR 4049
#+LABEL: fig:SED-HR4049
[[./img/sed-hr4049.pdf]]
@end example
+@vindex org-export-latex-inline-image-extensions
If you need references to a label created in this way, write
-@samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will
+@samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. The default settings will
recognize files types that can be included as images during processing by
-pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
+@command{pdflatex} (@file{png}, @file{jpg}, and @file{pdf} files). If you process your
files in a different way, you may need to customize the variable
@code{org-export-latex-inline-image-extensions}.
-@node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
+@node DocBook export, XOXO export, LaTeX and PDF export, Exporting
+@section DocBook export
+@cindex DocBook export
+@cindex PDF export
+@cindex Cui, Baoqui
+
+Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
+exported to DocBook format, it can be further processed to produce other
+formats, including PDF, HTML, man pages, etc., using many available DocBook
+tools and stylesheets.
+
+Currently DocBook exporter only supports DocBook V5.0.
+
+@menu
+* DocBook export commands:: How to invoke DocBook export
+* Quoting DocBook code:: Incorporating DocBook code in Org files
+* Recursive sections:: Recursive sections in DocBook
+* Tables in DocBook export:: Tables are exported as HTML tables
+* Images in DocBook export:: How to insert figures into DocBook output
+* Special characters:: How to handle special characters
+@end menu
+
+@node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
+@subsection DocBook export commands
+
+@cindex region, active
+@cindex active region
+@cindex transient-mark-mode
+@table @kbd
+@kindex C-c C-e D
+@item C-c C-e D
+@cindex property EXPORT_FILE_NAME
+Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
+file will be @file{myfile.xml}. 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.
+@kindex C-c C-e V
+@item C-c C-e V
+Export as DocBook file, process to PDF, then open the resulting PDF file.
+
+@vindex org-export-docbook-xslt-proc-command
+@vindex org-export-docbook-xsl-fo-proc-command
+Note that, in order to produce PDF output based on exported DocBook file, you
+need to have XSLT processor and XSL-FO processor software installed on your
+system. Check variables @code{org-export-docbook-xslt-proc-command} and
+@code{org-export-docbook-xsl-fo-proc-command}.
+
+@kindex C-c C-e v D
+@item C-c C-e v D
+Export only the visible part of the document.
+@end table
+
+@node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
+@subsection Quoting DocBook code
+
+You can quote DocBook code in Org files and copy it verbatim into exported
+DocBook file with the following constructs:
+
+@cindex #+DOCBOOK
+@cindex #+BEGIN_DOCBOOK
+@example
+#+DOCBOOK: Literal DocBook code for export
+@end example
+
+@noindent or
+@cindex #+BEGIN_DOCBOOK
+
+@example
+#+BEGIN_DOCBOOK
+All lines between these markers are exported by DocBook exporter
+literally.
+#+END_DOCBOOK
+@end example
+
+For example, you can use the following lines to include a DocBook warning
+admonition. As to what this warning says, you should pay attention to the
+document context when quoting DocBook code in Org files. You may make
+exported DocBook XML files invalid by not quoting DocBook code correctly.
+
+@example
+#+BEGIN_DOCBOOK
+<warning>
+ <para>You should know what you are doing when quoting DocBook XML code
+ in your Org file. Invalid DocBook XML file may be generated by
+ DocBook exporter if you are not careful!</para>
+</warning>
+#+END_DOCBOOK
+@end example
+
+@node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
+@subsection Recursive sections
+@cindex DocBook recursive sections
+
+DocBook exporter exports Org files as articles using the @code{article}
+element in DocBook. Recursive sections, @ie @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
+matter how many nested levels of headlines there are.
+
+Using recursive sections makes it easy to port and reuse exported DocBook
+code in other DocBook document types like @code{book} or @code{set}.
+
+@node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
+@subsection Tables in DocBook export
+@cindex tables, in DocBook export
+
+Tables in Org files are exported as HTML tables, which have been supported since
+DocBook V4.3.
+
+If a table does not have a caption, an informal table is generated using the
+@code{informaltable} element; otherwise, a formal table will be generated
+using the @code{table} element.
+
+@node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
+@subsection Images in DocBook export
+@cindex images, inline in DocBook
+@cindex inlining images in DocBook
+
+Images that are linked to without a description part in the link, like
+@samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
+using @code{mediaobject} elements. Each @code{mediaobject} element contains
+an @code{imageobject} that wraps an @code{imagedata} element. If you have
+specified a caption for an image as described in @ref{Markup rules}, a
+@code{caption} element will be added in @code{mediaobject}. If a label is
+also specified, it will be exported as an @code{xml:id} attribute of the
+@code{mediaobject} element.
+
+@vindex org-export-docbook-default-image-attributes
+Image attributes supported by the @code{imagedata} element, like @code{align}
+or @code{width}, can be specified in two ways: you can either customize
+variable @code{org-export-docbook-default-image-attributes} or use the
+@code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
+@code{org-export-docbook-default-image-attributes} are applied to all inline
+images in the Org file to be exported (unless they are overwritten by image
+attributes specified in @code{#+ATTR_DOCBOOK:} lines).
+
+The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
+attributes or overwrite default image attributes for individual images. If
+the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
+variable @code{org-export-docbook-default-image-attributes}, the former
+overwrites the latter. Here is an example about how image attributes can be
+set:
+
+@cindex #+CAPTION
+@cindex #+LABEL
+@cindex #+ATTR_DOCBOOK
+@example
+#+CAPTION: The logo of Org mode
+#+LABEL: unicorn-svg
+#+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
+[[./img/org-mode-unicorn.svg]]
+@end example
+
+@vindex org-export-docbook-inline-image-extensions
+By default, DocBook exporter recognizes the following image file types:
+@file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
+customize variable @code{org-export-docbook-inline-image-extensions} to add
+more types to this list as long as DocBook supports them.
+
+@node Special characters, , Images in DocBook export, DocBook export
+@subsection Special characters in DocBook export
+@cindex Special characters in DocBook export
+
+@vindex org-export-docbook-doctype
+@vindex org-html-entities
+Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
+@code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
+characters are rewritten to XML entities, like @code{α},
+@code{Γ}, and @code{Ζ}, based on the list saved in variable
+@code{org-html-entities}. As long as the generated DocBook file includes the
+corresponding entities, these special characters are recognized.
+
+You can customize variable @code{org-export-docbook-doctype} to include the
+entities you need. For example, you can set variable
+@code{org-export-docbook-doctype} to the following value to recognize all
+special characters included in XHTML entities:
+
+@example
+"<!DOCTYPE article [
+<!ENTITY % xhtml1-symbol PUBLIC
+\"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
+\"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
+>
+%xhtml1-symbol;
+]>
+"
+@end example
+
+@node XOXO export, iCalendar export, DocBook export, Exporting
@section XOXO export
@cindex XOXO export
Org mode contains an exporter that produces XOXO-style output.
Currently, this exporter only handles the general outline structure and
-does not interpret any additional Org mode features.
+does not interpret any additional Org-mode features.
@table @kbd
@kindex C-c C-e x
@section iCalendar export
@cindex iCalendar export
-Some people like to use Org mode for keeping track of projects, but still
-prefer a standard calendar application for anniversaries and appointments.
-In this case it can be useful to have deadlines and other time-stamped items
-in Org files show up in the calendar application. Org mode can export
-calendar information in the standard iCalendar format. If you also want to
-have TODO entries included in the export, configure the variable
-@code{org-icalendar-include-todo}. iCalendar export will export plain time
-stamps as VEVENT, and TODO items as VTODO. It will also create events from
-deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
-items will be used to set the start and due dates for the todo
-entry@footnote{See the variables @code{org-icalendar-use-deadline} and
-@code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
-locally defined in the heading, and the file/tree category@footnote{To add
-inherited tags or the TODO state, configure the variable
-@code{org-icalendar-categories}.}.
-
+@vindex org-icalendar-include-todo
+@vindex org-icalendar-use-deadline
+@vindex org-icalendar-use-scheduled
+@vindex org-icalendar-categories
+Some people use Org mode for keeping track of projects, but still prefer a
+standard calendar application for anniversaries and appointments. In this
+case it can be useful to show deadlines and other time-stamped items in Org
+files in the calendar application. Org mode can export calendar information
+in the standard iCalendar format. If you also want to have TODO entries
+included in the export, configure the variable
+@code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
+and TODO items as VTODO. It will also create events from deadlines that are
+in non-TODO items. Deadlines and scheduling dates in TODO items will be used
+to set the start and due dates for the TODO entry@footnote{See the variables
+@code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
+As categories, it will use the tags locally defined in the heading, and the
+file/tree category@footnote{To add inherited tags or the TODO state,
+configure the variable @code{org-icalendar-categories}.}.
+
+@vindex org-icalendar-store-UID
+@cindex property, ID
The iCalendar standard requires each entry to have a globally unique
identifier (UID). Org creates these identifiers during export. If you set
the variable @code{org-icalendar-store-UID}, the UID will be stored in the
directory, using a file extension @file{.ics}.
@kindex C-c C-e I
@item C-c C-e I
+@vindex org-agenda-files
Like @kbd{C-c C-e i}, but do this for all files in
@code{org-agenda-files}. For each of these files, a separate iCalendar
file will be written.
@kindex C-c C-e c
@item C-c C-e c
+@vindex org-combined-agenda-icalendar-file
Create a single large iCalendar file from all files in
@code{org-agenda-files} and write it to the file given by
@code{org-combined-agenda-icalendar-file}.
@end table
+@vindex org-use-property-inheritance
+@vindex org-icalendar-include-body
+@cindex property, SUMMARY
+@cindex property, DESCRIPTION
+@cindex property, LOCATION
The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
property can be inherited from higher in the hierarchy if you configure
@code{org-use-property-inheritance} accordingly.} properties if the selected
and the description from the body (limited to
@code{org-icalendar-include-body} characters).
-How this calendar is best read and updated, that depends on the application
+How this calendar is best read and updated, depends on the application
you are using. The FAQ covers this issue.
@node Publishing, Miscellaneous, Exporting, Top
@chapter Publishing
@cindex publishing
+@cindex O'Toole, David
-Org includes@footnote{@file{org-publish.el} is not distributed with
-Emacs 21, if you are still using Emacs 21, you need you need to download
-this file separately.} a publishing management system that allows you to
-configure automatic HTML conversion of @emph{projects} composed of
-interlinked org files. This system is called @emph{org-publish}. You can
-also configure org-publish to automatically upload your exported HTML
-pages and related attachments, such as images and source code files, to
-a web server. Org-publish turns Org into a web-site authoring tool.
+Org includes a publishing management system that allows you to configure
+automatic HTML conversion of @emph{projects} composed of interlinked org
+files. You can also configure Org to automatically upload your exported HTML
+pages and related attachments, such as images and source code files, to a web
+server.
-You can also use Org-publish to convert files into La@TeX{}, or even
-combine HTML and La@TeX{} conversion so that files are available in both
-formats on the server@footnote{Since La@TeX{} files on a server are not
-that helpful, you surely want to perform further conversion on them --
-e.g. convert them to @code{PDF} format.}.
+You can also use Org to convert files into PDF, or even combine HTML and PDF
+conversion so that files are available in both formats on the server.
-Org-publish has been contributed to Org by David O'Toole.
+Publishing has been contributed to Org by David O'Toole.
@menu
* Configuration:: Defining projects
+* Uploading files:: How to get files up on the server
* Sample configuration:: Example projects
* Triggering publication:: Publication commands
@end menu
-@node Configuration, Sample configuration, Publishing, Publishing
+@node Configuration, Uploading files, Publishing, Publishing
@section Configuration
Publishing needs significant configuration to specify files, destination
@cindex org-publish-project-alist
@cindex projects, for publishing
-Org-publish is configured almost entirely through setting the value of
-one 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:
+@vindex org-publish-project-alist
+Publishing is configured almost entirely through setting the value of one
+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 ...)
-
+ ("project-name" :property value :property value ...)
@r{or}
-
-("project-name" :components ("project-name" "project-name" ...))
+ ("project-name" :components ("project-name" "project-name" ...))
@end lisp
-In both cases, projects are configured by specifying property values.
-A project defines the set of files that will be published, as well as
-the publishing configuration to use when publishing those files. When
-a project takes the second form listed above, the individual members
-of the ``components'' property are taken to be components of the
-project, which group together files requiring different publishing
-options. When you publish such a ``meta-project'' all the components
-will also publish. The @code{:components} are published in the sequence
-provided.
+In both cases, projects are configured by specifying property values. A
+project defines the set of files that will be published, as well as the
+publishing configuration to use when publishing those files. When a project
+takes the second form listed above, the individual members of the
+@code{:components} property are taken to be sub-projects, which group
+together files requiring different publishing options. When you publish such
+a ``meta-project'', all the components will also be published, in the
+sequence given.
@node Sources and destinations, Selecting files, Project alist, Configuration
@subsection Sources and destinations for files
@cindex directories, for publishing
-Most properties are optional, but some should always be set. In
-particular, org-publish needs to know where to look for source files,
+Most properties are optional, but some should always be set. In
+particular, Org needs to know where to look for source files,
and where to put published files.
@multitable @columnfractions 0.3 0.7
@item @code{:base-directory}
@tab Directory containing publishing source files
@item @code{:publishing-directory}
-@tab Directory (possibly remote) where output files will be published.
+@tab Directory where output files will be published. You can directly
+publish to a webserver using a file name syntax appropriate for
+the Emacs @file{tramp} package. Or you can publish to a local directory and
+use external tools to upload your website (@pxref{Uploading files}).
@item @code{:preparation-function}
-@tab Function called before starting the publishing process, for example to
+@tab Function called before starting the publishing process, for example, to
run @code{make} for updating files to be published.
@item @code{:completion-function}
-@tab Function called after finishing the publishing process, for example to
+@tab Function called after finishing the publishing process, for example, to
change permissions of the resulting files.
@end multitable
@noindent
@multitable @columnfractions 0.25 0.75
@item @code{:base-extension}
@tab Extension (without the dot!) of source files. This actually is a
-regular expression.
+regular expression. Set this to the symbol @code{any} if you want to get all
+files in @code{:base-directory}, even without extension.
@item @code{:exclude}
@tab Regular expression to match file names that should not be
possibly transformed in the process. The default transformation is to export
Org files as HTML files, and this is done by the function
@code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
-export}). But you also can publish your files in La@TeX{} by using the
-function @code{org-publish-org-to-latex} instead, or as PDF files using
-@code{org-publish-org-to-pdf}. Other files like images only need to be
-copied to the publishing destination. For non-Org files, you need to provide
-your own publishing function:
+export}). But you also can publish your content as PDF files using
+@code{org-publish-org-to-pdf}. If you want to publish the Org file itself,
+but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use
+@code{org-publish-org-to-org} and set the parameters @code{:plain-source}
+and/or @code{:htmlized-source}. This will produce @file{file.org} and
+@file{file.org.html} in the publishing
+directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
+source and publishing directories are equal. Note that with this kind of
+setup, you need to add @code{:exclude "-source\\.org"} to the project
+definition in @code{org-publish-project-alist} to avoid that the published
+source files will be considered as new org files the next time the project is
+published.}. Other files like images only
+need to be copied to the publishing destination, for this you may use
+@code{org-publish-attachment}. For non-Org files, you always need to
+specify the publishing function:
@multitable @columnfractions 0.3 0.7
@item @code{:publishing-function}
@tab Function executing the publication of a file. This may also be a
list of functions, which will all be called in turn.
+@item @code{:plain-source}
+@tab Non-nil means, publish plain source.
+@item @code{:htmlized-source}
+@tab Non-nil means, publish htmlized source.
@end multitable
-The function must accept two arguments: a property list containing at
-least a @code{:publishing-directory} property, and the name of the file
-to be published. It should take the specified file, make the necessary
+The function must accept two arguments: a property list containing at least a
+@code{:publishing-directory} property, and the name of the file to be
+published. It should take the specified file, make the necessary
transformation (if any) and place the result into the destination folder.
-You can write your own publishing function, but @code{org-publish}
-provides one for attachments (files that only need to be copied):
-@code{org-publish-attachment}.
@node Publishing options, Publishing links, Publishing action, Configuration
-@subsection Options for the HTML/LaTeX exporters
+@subsection Options for the HTML/La@TeX{} exporters
@cindex options, for publishing
The property list can be used to set many export options for the HTML
with the variable they belong to. See the documentation string for the
respective variable for details.
+@vindex org-export-html-link-up
+@vindex org-export-html-link-home
+@vindex org-export-default-language
+@vindex org-display-custom-times
+@vindex org-export-headline-levels
+@vindex org-export-with-section-numbers
+@vindex org-export-section-number-format
+@vindex org-export-with-toc
+@vindex org-export-preserve-breaks
+@vindex org-export-with-archived-trees
+@vindex org-export-with-emphasize
+@vindex org-export-with-sub-superscripts
+@vindex org-export-with-special-strings
+@vindex org-export-with-footnotes
+@vindex org-export-with-drawers
+@vindex org-export-with-tags
+@vindex org-export-with-todo-keywords
+@vindex org-export-with-priority
+@vindex org-export-with-TeX-macros
+@vindex org-export-with-LaTeX-fragments
+@vindex org-export-skip-text-before-1st-heading
+@vindex org-export-with-fixed-width
+@vindex org-export-with-timestamps
+@vindex org-export-author-info
+@vindex org-export-creator-info
+@vindex org-export-with-tables
+@vindex org-export-highlight-first-table-line
+@vindex org-export-html-style-include-default
+@vindex org-export-html-style
+@vindex org-export-html-style-extra
+@vindex org-export-html-link-org-files-as-html
+@vindex org-export-html-inline-images
+@vindex org-export-html-extension
+@vindex org-export-html-table-tag
+@vindex org-export-html-expand
+@vindex org-export-html-with-timestamp
+@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
+@vindex org-export-exclude-tags
+
@multitable @columnfractions 0.32 0.68
@item @code{:link-up} @tab @code{org-export-html-link-up}
@item @code{:link-home} @tab @code{org-export-html-link-home}
@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{: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{: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}
+@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}
@end multitable
-If you use several email addresses, separate them by a semi-column.
-
Most of the @code{org-export-with-*} variables have the same effect in
both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
@code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
La@TeX{} export.
+@vindex org-publish-project-alist
When a property is given a value in @code{org-publish-project-alist},
its setting overrides the value of the corresponding user variable (if
any) during publishing. Options set within a file (@pxref{Export
To create a link from one Org file to another, you would use
something like @samp{[[file:foo.org][The foo]]} or simply
-@samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
+@samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
becomes a link to @file{foo.html}. In this way, you can interlink the
pages of your "org web" project and the links will work as expected when
-you publish them to HTML.
+you publish them to HTML. If you also publish the Org source file and want
+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 with relative pathnames, and provided you have also configured
-@code{org-publish} to upload the related files, these links will work
-too. See @ref{Complex example} for an example of this usage.
+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
+an example of this usage.
-Sometime an Org file to be published may contain links that are
+Sometimes an Org file to be published may contain links that are
only valid in your production environment, but not in the publishing
location. In this case, use the property
@cindex index, of published pages
The following properties may be used to control publishing of an
-index of files or summary page for a given project.
+index of files or a summary page for a given project.
@multitable @columnfractions 0.25 0.75
@item @code{:auto-index}
-@tab When non-nil, publish an index during org-publish-current-project or
-org-publish-all.
+@tab When non-nil, publish an index during @code{org-publish-current-project}
+or @code{org-publish-all}.
@item @code{:index-filename}
-@tab Filename for output of index. Defaults to @file{index.org} (which
-becomes @file{index.html}).
+@tab Filename for output of index. Defaults to @file{sitemap.org} (which
+becomes @file{sitemap.html}).
@item @code{:index-title}
@tab Title of index page. Defaults to name of file.
of links to all files in the project.
@end multitable
-@node Sample configuration, Triggering publication, Configuration, Publishing
+@node Uploading files, Sample configuration, Configuration, Publishing
+@section Uploading files
+@cindex rsync
+@cindex unison
+
+For those people already utilizing third party sync tools such as
+@command{rsync} or @command{unison}, it might be preferable not to use the built in
+@i{remote} publishing facilities of Org mode which rely heavily on
+Tramp. Tramp, while very useful and powerful, tends not to be
+so efficient for multiple file transfer and has been known to cause problems
+under heavy usage.
+
+Specialized synchronization utilities offer several advantages. In addition
+to timestamp comparison, they also do content and permissions/attribute
+checks. For this reason you might prefer to publish your web to a local
+directory (possibly even @i{in place} with your Org files) and then use
+@file{unison} or @file{rsync} to do the synchronization with the remote host.
+
+Since Unison (for example) can be configured as to which files to transfer to
+a certain remote destination, it can greatly simplify the project publishing
+definition. Simply keep all files in the correct location, process your Org
+files with @code{org-publish} and let the synchronization tool do the rest.
+You do not need, in this scenario, to include attachments such as @file{jpg},
+@file{css} or @file{gif} files in the project definition since the 3rd party
+tool syncs them.
+
+Publishing to a local directory is also much faster than to a remote one, so
+that you can afford more easily to republish entire projects. If you set
+@code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
+benefit of re-including any changed external files such as source example
+files you might include with @code{#+INCLUDE}. The timestamp mechanism in
+Org is not smart enough to detect if included files have been modified.
+
+@node Sample configuration, Triggering publication, Uploading files, Publishing
@section Sample configuration
Below we provide two example configurations. The first one is a simple
:table-of-contents nil
:style "<link rel=\"stylesheet\"
href=\"../other/mystyle.css\"
- type=\"text/css\">")))
+ type=\"text/css\"/>")))
@end lisp
@node Complex example, , Simple example, Sample configuration
@subsection Example: complex publishing configuration
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
+Org files converted to HTML, image files, Emacs Lisp source code, and
+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'd link to an image with
@c
@example
:section-numbers nil
:table-of-contents nil
:style "<link rel=\"stylesheet\"
- href=\"../other/mystyle.css\" type=\"text/css\">"
+ href=\"../other/mystyle.css\" type=\"text/css\"/>"
:auto-preamble t
:auto-postamble nil)
@node Triggering publication, , Sample configuration, Publishing
@section Triggering publication
-Once org-publish is properly configured, you can publish with the
-following functions:
+Once properly configured, Org can publish with the following commands:
@table @kbd
+@kindex C-c C-e C
@item C-c C-e C
Prompt for a specific project and publish all files that belong to it.
+@kindex C-c C-e P
@item C-c C-e P
Publish the project containing the current file.
+@kindex C-c C-e F
@item C-c C-e F
Publish only the current file.
-@item C-c C-e A
-Publish all projects.
+@kindex C-c C-e E
+@item C-c C-e E
+Publish every project.
@end table
-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.
+@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
+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
+@code{#+SETUPFILE:} or @code{#+INCLUDE:}.
-@node Miscellaneous, Extensions, Publishing, Top
+@node Miscellaneous, Hacking, Publishing, Top
@chapter Miscellaneous
@menu
* Clean view:: Getting rid of leading stars in the outline
* TTY keys:: Using Org on a tty
* Interaction:: Other Emacs packages
-* Bugs:: Things which do not work perfectly
@end menu
+
@node Completion, Customization, Miscellaneous, Miscellaneous
@section Completion
@cindex completion, of @TeX{} symbols
will insert example settings for this keyword.
@item
In the line after @samp{#+STARTUP: }, complete startup keywords,
-i.e. valid keys for this line.
+@ie valid keys for this line.
@item
Elsewhere, complete dictionary words using Ispell.
@end itemize
activate the changes immediately. Otherwise they become effective only
when the file is visited again in a new Emacs session.
+@vindex org-archive-location
@table @kbd
@item #+ARCHIVE: %s_done::
This line sets the archive location for the agenda file. It applies for
for all subsequent lines until the next @samp{#+CATEGORY} line, or the
end of the file. The first such line also applies to any entries before it.
@item #+COLUMNS: %25ITEM .....
+@cindex property, COLUMNS
Set the default format for columns view. This format applies when
-columns view is invoked in location where no @code{COLUMNS} property
+columns view is invoked in locations where no @code{COLUMNS} property
applies.
@item #+CONSTANTS: name1=value1 ...
+@vindex org-table-formula-constants
+@vindex org-table-formula
Set file-local values for constants to be used in table formulas. This
line set the local variable @code{org-table-formula-constants-local}.
The global version of this variable is
Set tags that can be inherited by any entry in the file, including the
top-level entries.
@item #+DRAWERS: NAME1 .....
+@vindex org-drawers
Set the file-local set of drawers. The corresponding global variable is
@code{org-drawers}.
@item #+LINK: linkword replace
+@vindex org-link-abbrev-alist
These lines (several are allowed) specify link abbreviations.
@xref{Link abbreviations}. The corresponding variable is
@code{org-link-abbrev-alist}.
@item #+PRIORITIES: highest lowest default
+@vindex org-highest-priority
+@vindex org-lowest-priority
+@vindex org-default-priority
This line sets the limits and the default for the priorities. All three
must be either letters A-Z or numbers 0-9. The highest priority must
have a lower ASCII number that the lowest priority.
@item #+PROPERTY: Property_Name Value
This line sets a default inheritance value for entries in the current
buffer, most useful for specifying the allowed values of a property.
+@cindex #+SETUPFILE
@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
+(@ie 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
cursor is in the line with @kbd{C-c '}.
@item #+STARTUP:
+@cindex #+STARTUP:
This line sets options to be used at startup of Org mode, when an
-Org file is being visited. The first set of options deals with the
-initial visibility of the outline tree. The corresponding variable for
-global default settings is @code{org-startup-folded}, with a default
-value @code{t}, which means @code{overview}.
+Org file is being visited.
+
+The first set of options deals with the initial visibility of the outline
+tree. The corresponding variable for global default settings is
+@code{org-startup-folded}, with a default value @code{t}, which means
+@code{overview}.
+@vindex org-startup-folded
@cindex @code{overview}, STARTUP keyword
@cindex @code{content}, STARTUP keyword
@cindex @code{showall}, STARTUP keyword
content @r{all headlines}
showall @r{no folding at all, show everything}
@end example
+
+@vindex org-startup-indented
+@cindex @code{indent}, STARTUP keyword
+@cindex @code{noindent}, STARTUP keyword
+Dynamic virtual indentation is controlled by the variable
+@code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
+@example
+indent @r{start with @code{org-indent-mode} turned on}
+noindent @r{start with @code{org-indent-mode} turned off}
+@end example
+
+@vindex org-startup-align-all-tables
Then there are options for aligning tables upon visiting a file. This
is useful in files containing narrowed table columns. The corresponding
variable is @code{org-startup-align-all-tables}, with a default value
align @r{align all tables}
noalign @r{don't align tables on startup}
@end example
-Logging closing and reinstating TODO items, and clock intervals
-(variables @code{org-log-done}, @code{org-log-note-clock-out}, and
-@code{org-log-repeat}) can be configured using these options.
+@vindex org-log-done
+@vindex org-log-note-clock-out
+@vindex org-log-repeat
+Logging the closing and reopening of TODO items and clock intervals can be
+configured using these options (see variables @code{org-log-done},
+@code{org-log-note-clock-out} and @code{org-log-repeat})
@cindex @code{logdone}, STARTUP keyword
@cindex @code{lognotedone}, STARTUP keyword
@cindex @code{nologdone}, STARTUP keyword
lognoteclock-out @r{record a note when clocking out}
nolognoteclock-out @r{don't record a note when clocking out}
@end example
+@vindex org-hide-leading-stars
+@vindex org-odd-levels-only
Here are the options for hiding leading stars in outline headings, and for
indenting outlines. The corresponding variables are
@code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
odd @r{allow only odd outline levels (1,3,...)}
oddeven @r{allow all outline levels}
@end example
-To turn on custom format overlays over time stamps (variables
+@vindex org-put-time-stamp-overlays
+@vindex org-time-stamp-overlay-formats
+To turn on custom format overlays over timestamps (variables
@code{org-put-time-stamp-overlays} and
@code{org-time-stamp-overlay-formats}), use
@cindex @code{customtime}, STARTUP keyword
@example
customtime @r{overlay custom time format}
@end example
+@vindex constants-unit-system
The following options influence the table spreadsheet (variable
@code{constants-unit-system}).
@cindex @code{constcgs}, STARTUP keyword
constcgs @r{@file{constants.el} should use the c-g-s unit system}
constSI @r{@file{constants.el} should use the SI unit system}
@end example
+@vindex org-footnote-define-inline
+@vindex org-footnote-auto-label
+@vindex org-footnote-auto-adjust
To influence footnote settings, use the following keywords. The
-corresponding variables are @code{org-footnote-define-inline} and
-@code{org-footnote-auto-label}.
+corresponding variables are @code{org-footnote-define-inline},
+@code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
@cindex @code{fninline}, STARTUP keyword
-@cindex @code{fnnoinline}, STARTUP keyword
+@cindex @code{nofninline}, STARTUP keyword
@cindex @code{fnlocal}, STARTUP keyword
@cindex @code{fnprompt}, STARTUP keyword
@cindex @code{fnauto}, STARTUP keyword
@cindex @code{fnconfirm}, STARTUP keyword
@cindex @code{fnplain}, STARTUP keyword
+@cindex @code{fnadjust}, STARTUP keyword
+@cindex @code{nofnadjust}, STARTUP keyword
@example
fninline @r{define footnotes inline}
fnnoinline @r{define footnotes in separate section}
fnauto @r{create [fn:1]-like labels automatically (default)}
fnconfirm @r{offer automatic label for editing or confirmation}
fnplain @r{create [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
+@code{org-hide-block-startup}.
+@cindex @code{hideblocks}, STARTUP keyword
+@cindex @code{nohideblocks}, STARTUP keyword
+@example
+hideblocks @r{Hide all begin/end blocks on startup}
+nohideblocks @r{Do not hide blocks on startup}
@end example
@item #+TAGS: TAG1(c1) TAG2(c2)
+@vindex org-tag-alist
These lines (several such lines are allowed) specify the valid tags in
this file, and (potentially) the corresponding @emph{fast tag selection}
keys. The corresponding variable is @code{org-tag-alist}.
@item #+TBLFM:
This line contains the formulas for the table directly above the line.
-@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
+@item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
+@itemx #+OPTIONS:, #+BIND:
+@itemx #+DESCRIPTION:, #+KEYWORDS:
+@itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
+@itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
These lines provide settings for exporting files. For more details see
@ref{Export options}.
-@item #+SEQ_TODO: #+TYP_TODO:
+@item #+TODO: #+SEQ_TODO: #+TYP_TODO:
+@vindex org-todo-keywords
These lines set the TODO keywords and their interpretation in the
-current file. The corresponding variables are @code{org-todo-keywords}
-and @code{org-todo-interpretation}.
+current file. The corresponding variable is @code{org-todo-keywords}.
@end table
@node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
The key @kbd{C-c C-c} has many purposes in Org, which are all
mentioned scattered throughout this manual. One specific function of
this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
-other circumstances it means something like @emph{Hey Org, look
-here and update according to what you see here}. Here is a summary of
+other circumstances it means something like @emph{``Hey Org, look
+here and update according to what you see here''}. Here is a summary of
what this means in different contexts.
@itemize @minus
If the cursor is inside a table created by the @file{table.el} package,
activate that table.
@item
-If the current buffer is a remember buffer, close the note and file it.
+If the current buffer is a Remember buffer, close the note and file it.
With a prefix argument, file it, without further interaction, to the
default location.
@item
If the cursor is on a numbered item in a plain list, renumber the
ordered list.
@item
-If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
+If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
block is updated.
@end itemize
@cindex odd-levels-only outlines
@cindex clean outline view
-Some people find it noisy and distracting that the Org headlines are starting
-with a potentially large number of stars, and that text below the headlines
-is not indented. This is not really a problem when you are writing a book
-where the outline headings are really section headlines. However, in a more
-list-oriented outline, it is clear that an indented structure is a lot
-cleaner, as can be seen by comparing the two columns in the following
-example:
+Some people find it noisy and distracting that the Org headlines start with a
+potentially large number of stars, and that text below the headlines is not
+indented. While this is no problem when writing a book where the outline
+headings are really section headlines, in a more list-oriented outline,
+indented structure is a lot cleaner:
@example
@group
@end example
@noindent
-It is non-trivial to make such a look work in Emacs, but Org contains three
-separate features that, combined, achieve just that.
+If you are using Emacs 23 and at least version 6.29 of Org, this kind of view
+can be achieved dynamically at display time using @code{org-indent-mode}. In
+this minor mode, all lines are prefixed for display with the necessary amount
+of space. Also headlines are prefixed with additional stars, so that the
+amount of indentation shifts by two@footnote{See the variable
+@code{org-indent-indentation-per-level}.} spaces per level. All headline
+stars but the last one are made invisible using the @code{org-hide}
+face@footnote{Turning on @code{org-indent-mode} sets
+@code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
+@code{nil}.} - see below under @samp{2.} for more information on how this
+works. You can turn on @code{org-indent-mode} for all files by customizing
+the variable @code{org-startup-indented}, or you can turn it on for
+individual files using
+
+@example
+#+STARTUP: indent
+@end example
+
+If you want a similar effect in earlier version of Emacs and/or Org, or if
+you want the indentation to be hard space characters so that the plain text
+file looks as similar as possible to the Emacs display, Org supports you in
+the following way:
@enumerate
@item
more text, now indented
@end example
-A good way to get this indentation is by hand, and Org supports this with
-paragraph filling, line wrapping, and structure editing@footnote{See also the
-variable @code{org-adapt-indentation}.} preserving or adapting the
-indentation appropriate. A different approach would be to have a way to
-automatically indent lines according to outline structure by adding overlays
-or text properties. But I have not yet found a robust and efficient way to
-do this in large files.
+@vindex org-adapt-indentation
+Org supports this with paragraph filling, line wrapping, and structure
+editing@footnote{See also the variable @code{org-adapt-indentation}.},
+preserving or adapting the indentation as appropriate.
@item
+@vindex org-hide-leading-stars
@emph{Hiding leading stars}@* You can modify the display in such a way that
all leading stars become invisible. To do this in a global way, configure
the variable @code{org-hide-leading-stars} or change this on a per-file basis
@example
#+STARTUP: hidestars
+#+STARTUP: showstars
@end example
-@noindent
-Note that the opposite behavior is selected with @code{showstars}.
-
With hidden stars, the tree becomes:
@example
@end example
@noindent
-Note that the leading stars are not truly replaced by whitespace, they
-are only fontified with the face @code{org-hide} that uses the
-background color as font color. If you are not using either white or
-black background, you may have to customize this face to get the wanted
-effect. Another possibility is to set this font such that the extra
-stars are @i{almost} invisible, for example using the color
-@code{grey90} on a white background.
+@vindex org-hide @r{(face)}
+The leading stars are not truly replaced by whitespace, they are only
+fontified with the face @code{org-hide} that uses the background color as
+font color. If you are not using either white or black background, you may
+have to customize this face to get the wanted effect. Another possibility is
+to set this font such that the extra stars are @i{almost} invisible, for
+example using the color @code{grey90} on a white background.
@item
+@vindex org-odd-levels-only
Things become cleaner still if you skip all the even levels and use only odd
levels 1, 3, 5..., effectively adding two stars to go from one outline level
-to the next. In this way we get the outline view shown at the beginning of
-this section. In order to make the structure editing and export commands
-handle this convention correctly, configure the variable
-@code{org-odd-levels-only}, or set this on a per-file basis with one of the
-following lines:
+to the next@footnote{When you need to specify a level for a property search
+or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
+way we get the outline view shown at the beginning of this section. In order
+to make the structure editing and export commands handle this convention
+correctly, configure the variable @code{org-odd-levels-only}, or set this on
+a per-file basis with one of the following lines:
@example
#+STARTUP: odd
@section Using Org on a tty
@cindex tty key bindings
-Because Org contains a large number of commands, by default much of
+Because Org contains a large number of commands, by default many of
Org's core commands are bound to keys that are generally not
accessible on a tty, such as the cursor keys (@key{left}, @key{right},
@key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
these commands on a tty when special keys are unavailable, the following
alternative bindings can be used. The tty bindings below will likely be
more cumbersome; you may find for some of the bindings below that a
-customized work-around suits you better. For example, changing a time
-stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
+customized workaround suits you better. For example, changing a timestamp
+is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
tty you would rather use @kbd{C-c .} to re-insert the timestamp.
@multitable @columnfractions 0.15 0.2 0.2
@item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
@item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
@item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
-@item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}}
+@item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
@item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
@item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
@item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
@item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
@end multitable
-@node Interaction, Bugs, TTY keys, Miscellaneous
+
+@node Interaction, , 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
@table @asis
@cindex @file{calc.el}
+@cindex Gillespie, Dave
@item @file{calc.el} by Dave Gillespie
Org uses the Calc package for implementing spreadsheet
functionality in its tables (@pxref{The spreadsheet}). Org
checks for the availability of Calc by looking for the function
-@code{calc-eval} which should be autoloaded in your setup if Calc has
+@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,
, Embedded Mode, Calc, GNU Emacs Calc Manual}.
-@cindex @file{constants.el}
@item @file{constants.el} by Carsten Dominik
+@cindex @file{constants.el}
+@cindex Dominik, Carsten
+@vindex org-table-formula-constants
In a table formula (@pxref{The spreadsheet}), it is possible to use
names for natural constants or units. Instead of defining your own
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
+@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
the function @code{constants-get}, which has to be autoloaded in your
setup. See the installation instructions in the file
@file{constants.el}.
@item @file{cdlatex.el} by Carsten Dominik
@cindex @file{cdlatex.el}
-Org mode can make use of the CDLaTeX package to efficiently enter
-La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
+@cindex Dominik, Carsten
+Org mode can make use of the CDLa@TeX{} package to efficiently enter
+La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
@item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
@cindex @file{imenu.el}
Imenu allows menu access to an index of items in a file. Org mode
-supports Imenu - all you need to do to get the index is the following:
+supports Imenu---all you need to do to get the index is the following:
@lisp
(add-hook 'org-mode-hook
(lambda () (imenu-add-to-menubar "Imenu")))
@end lisp
-By default the index is two levels deep - you can modify the depth using
+@vindex org-imenu-depth
+By default the index is two levels deep---you can modify the depth using
the option @code{org-imenu-depth}.
@item @file{remember.el} by John Wiegley
@cindex @file{remember.el}
+@cindex Wiegley, John
Org cooperates with remember, see @ref{Remember}.
@file{Remember.el} is not part of Emacs, find it on the web.
@item @file{speedbar.el} by Eric M. Ludlam
@cindex @file{speedbar.el}
+@cindex Ludlam, Eric M.
Speedbar is a package that creates a special frame displaying files and
index items in files. Org mode supports Speedbar and allows you to
-drill into Org files directly from the Speedbar. It also allows to
+drill into Org files directly from the Speedbar. It also allows you to
restrict the scope of agenda commands to a file or a subtree by using
the command @kbd{<} in the Speedbar frame.
@cindex @file{table.el}
@kindex C-c C-c
@cindex table editor, @file{table.el}
@cindex @file{table.el}
+@cindex Ota, Takaaki
Complex ASCII tables with automatic line wrapping, column- and
row-spanning, and alignment can be created using the Emacs table
@c
@kindex C-c ~
@item C-c ~
-Insert a table.el table. If there is already a table at point, this
-command converts it between the table.el format and the Org mode
+Insert a @file{table.el} table. If there is already a table at point, this
+command converts it between the @file{table.el} format and the Org-mode
format. See the documentation string of the command
@code{org-convert-table} for the restrictions under which this is
possible.
@end table
@file{table.el} is part of Emacs 22.
-@cindex @file{footnote.el}
@item @file{footnote.el} by Steven L. Baur
+@cindex @file{footnote.el}
+@cindex Baur, Steven L.
Org mode recognizes numerical footnotes as provided by this package.
-However, Org-mode also has its own footnote support (@pxref{Footnotes}),
+However, Org mode also has its own footnote support (@pxref{Footnotes}),
which makes using @file{footnote.el} unnecessary.
@end table
@table @asis
@cindex @code{shift-selection-mode}
+@vindex org-support-shift-select
In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
cursor motions combined with the shift key should start or enlarge regions.
This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
timestamps, TODO keywords, priorities, and item bullet types if the cursor is
at such a location. By default, @kbd{S-@key{cursor}} commands outside
special contexts don't do anything, but you can customize the variable
-@code{org-support-shift-select}. Org-mode then tries to accommodate shift
+@code{org-support-shift-select}. Org mode then tries to accommodate shift
selection by (i) using it outside of the special contexts where special
commands apply, and by (ii) extending an existing active region even if the
cursor moves across a special context.
-@cindex @file{CUA.el}
@item @file{CUA.el} by Kim. F. Storm
+@cindex @file{CUA.el}
+@cindex Storm, Kim. F.
+@vindex org-replace-disputed-keys
Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
-(as well as pc-select-mode and s-region-mode) to select and extend the
+(as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
region. In fact, Emacs 23 has this built-in in the form of
@code{shift-selection-mode}, see previous paragraph. If you are using Emacs
-23 you probably don't want to use another package for this purpose. However,
+23, you probably don't want to use another package for this purpose. However,
if you prefer to leave these keys to a different package while working in
-Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
+Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
Org will move the following key bindings in Org files, and in the agenda
buffer (but not during date selection).
C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
@end example
+@vindex org-disputed-keys
Yes, these are unfortunately more difficult to remember. If you want
to have other replacement keys, look at the variable
@code{org-disputed-keys}.
+@item @file{yasnippet.el}
+@cindex @file{yasnippet.el}
+The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
+@code{"\t"}) overrules yasnippets' access to this key. The following code
+fixed this problem:
+
+@lisp
+(add-hook 'org-mode-hook
+ (lambda ()
+ (org-set-local 'yas/trigger-key [tab])
+ (define-key yas/keymap [tab] 'yas/next-field-group)))
+@end lisp
+
@item @file{windmove.el} by Hovav Shacham
@cindex @file{windmove.el}
-Also this package uses the @kbd{S-<cursor>} keys, so everything written
+This package also uses the @kbd{S-<cursor>} keys, so everything written
in the paragraph above about CUA mode also applies here.
@end table
-
-@node Bugs, , Interaction, Miscellaneous
-@section Bugs
-@cindex bugs
-
-Here is a list of things that should work differently, but which I
-have found too hard to fix.
-
-@itemize @bullet
-@item
-If a table field starts with a link, and if the corresponding table
-column is narrowed (@pxref{Narrow columns}) to a width too small to
-display the link, the field would look entirely empty even though it is
-not. To prevent this, Org throws an error. The work-around is to
-make the column wide enough to fit the link, or to add some text (at
-least 2 characters) before the link in the same field.
-@item
-Narrowing table columns does not work on XEmacs, because the
-@code{format} function does not transport text properties.
-@item
-Text in an entry protected with the @samp{QUOTE} keyword should not
-autowrap.
-@item
-When the application called by @kbd{C-c C-o} to open a file link fails
-(for example because the application does not exist or refuses to open
-the file), it does so silently. No error message is displayed.
-@item
-Recalculating a table line applies the formulas from left to right.
-If a formula uses @emph{calculated} fields further down the row,
-multiple recalculation may be needed to get all fields consistent. You
-may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
-recalculate until convergence.
-@item
-The exporters work well, but could be made more efficient.
-@end itemize
-
-
-@node Extensions, Hacking, Miscellaneous, Top
-@appendix Extensions
-
-This appendix lists the extension modules that have been written for Org.
-Many of these extensions live in the @file{contrib} directory of the Org
-distribution, others are available somewhere on the web.
-
-@menu
-* Extensions in the contrib directory:: These come with the Org distro
-* Other extensions:: These you have to find on the web.
-@end menu
-
-@node Extensions in the contrib directory, Other extensions, Extensions, Extensions
-@section Extensions in the @file{contrib} directory
-
-A number of extension are distributed with Org when you download it from its
-homepage. Please note that these extensions are @emph{not} distributed as
-part of Emacs, so if you use Org as delivered with Emacs, you still need to
-go to @url{http://orgmode.org} to get access to these modules.
-
-@table @asis
-@item @file{org-annotate-file.el} by @i{Philip Jackson}
-Annotate a file with org syntax, in a separate file, with links back to the
-annotated file.
-
-@item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
-Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. When
-activating a special link or bookmark, Emacs receives a trigger to create a
-note with a link back to the website. Requires some setup, a detailed
-description is in @file{contrib/packages/org-annotation-helper}.
-
-@item @file{org-bookmark.el} by @i{Tokuya Kameshima}
-Support for links to Emacs bookmarks.
-
-@item @file{org-depend.el} by @i{Carsten Dominik}
-TODO dependencies for Org-mode. Make TODO state changes in one entry trigger
-changes in another, or be blocked by the state of another entry. Also,
-easily create chains of TODO items with exactly one active item at any time.
-
-@item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
-Org links to emacs-lisp symbols. This can create annotated links that
-exactly point to the definition location of a variable of function.
-
-@item @file{org-eval.el} by @i{Carsten Dominik}
-The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows text to
-be included in a document that is the result of evaluating some code. Other
-scripting languages like @code{perl} can be supported with this package as
-well.
-
-@item @file{org-eval-light.el} by @i{Eric Schulte}
-User-controlled evaluation of code in an Org buffer.
-
-@item @file{org-exp-blocks.el} by @i{Eric Schulte}
-Preprocess user-defined blocks for export.
-
-@item @file{org-expiry.el} by @i{Bastien Guerry}
-Expiry mechanism for Org entries.
-
-@item @file{org-indent.el} by @i{Carsten Dominik}
-Dynamic indentation of Org outlines. The plan is to indent an outline
-according to level, but so far this is too hard for a proper and stable
-implementation. Still, it works somewhat.
-
-@item @file{org-interactive-query.el} by @i{Christopher League}
-Interactive modification of tags queries. After running a general query in
-Org, this package allows you to narrow down the results by adding more tags
-or keywords.
-
-@item @file{org-mairix.el} by @i{Georg C. F. Greve}
-Hook mairix search into Org for different MUAs.
-
-@item @file{org-man.el} by @i{Carsten Dominik}
-Support for links to manpages in Org-mode.
-
-@item @file{org-mtags.el} by @i{Carsten Dominik}
-Support for some Muse-like tags in Org-mode. This package allows you to
-write @code{<example>} and @code{<src>} and other syntax copied from Emacs
-Muse, right inside an Org file. The goal here is to make it easy to publish
-the same file using either org-publish or Muse.
-
-@item @file{org-panel.el} by @i{Lennart Borgman}
-Simplified and display-aided access to some Org commands.
-
-@item @file{org-registry.el} by @i{Bastien Guerry}
-A registry for Org links, to find out from where links point to a given file
-or location.
-
-@item @file{org2rem.el} by @i{Bastien Guerry}
-Convert org appointments into reminders for the @file{remind} program.
-
-@item @file{org-screen.el} by @i{Andrew Hyatt}
-Visit screen sessions through Org-mode links.
-
-@item @file{org-toc.el} by @i{Bastien Guerry}
-Table of contents in a separate buffer, with fast access to sections and easy
-visibility cycling.
-
-@item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
-Convert Org-mode tables to SQL insertions. Documentation for this can be
-found on the Worg pages.
-
-@end table
-
-@node Other extensions, , Extensions in the contrib directory, Extensions
-@section Other extensions
-
-@i{TO BE DONE}
-
-@node Hacking, History and Acknowledgments, Extensions, Top
+@node Hacking, History and Acknowledgments, Miscellaneous, Top
@appendix Hacking
+@cindex hacking
This appendix covers some aspects where users can extend the functionality of
Org.
@menu
+* Hooks:: Who to reach into Org's internals
+* Add-on packages:: Available extensions
* Adding hyperlink types:: New custom link types
-* Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
+* Context-sensitive commands:: How to add functionality to such commands
+* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs
* Dynamic blocks:: Automatically filled blocks
* Special agenda views:: Customized views
+* Extracting agenda information:: Postprocessing of agenda information
* Using the property API:: Writing programs that use entry properties
* Using the mapping API:: Mapping over all or selected entries
@end menu
-@node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
+@node Hooks, Add-on packages, Hacking, Hacking
+@section Hooks
+@cindex hooks
+
+Org has a large number of hook variables that can be used to add
+functionality. This appendix about hacking is going to illustrate the
+use of some of them. A complete list of all hooks with documentation is
+maintained by the Worg project and can be found at
+@uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
+
+@node Add-on packages, Adding hyperlink types, Hooks, Hacking
+@section Add-on packages
+@cindex add-on packages
+
+A large number of add-on packages have been written by various authors.
+These packages are not part of Emacs, but they are distributed as contributed
+packages with the separate release available at the Org mode home page at
+@uref{http://orgmode.org}. The list of contributed packages, along with
+documentation about each package, is maintained by the Worg project at
+@uref{http://orgmode.org/worg/org-contrib/}.
+
+
+
+@node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
@section Adding hyperlink types
@cindex hyperlinks, adding new types
Org has a large number of hyperlink types built-in
-(@pxref{Hyperlinks}). If you would like to add new link types, it
-provides an interface for doing so. Let's look at an example file
-@file{org-man.el} that will add support for creating links like
+(@pxref{Hyperlinks}). If you would like to add new link types, Org
+provides an interface for doing so. Let's look at an example file,
+@file{org-man.el}, that will add support for creating links like
@samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
-emacs:
+Emacs:
@lisp
;;; org-man.el - Support for links to manpages in Org
with prefix @samp{man}. The call also contains the name of a function
that will be called to follow such a link.
@item
+@vindex org-store-link-functions
The next line adds a function to @code{org-store-link-functions}, in
order to allow the command @kbd{C-c l} to record a useful link in a
buffer displaying a man page.
@end enumerate
The rest of the file defines the necessary variables and functions.
-First there is a customization variable that determines which emacs
+First there is a customization variable that determines which Emacs
command should be used to display man pages. There are two options,
@code{man} and @code{woman}. Then the function to follow a link is
-defined. It gets the link path as an argument - in this case the link
+defined. It gets the link path as an argument---in this case the link
path is just a topic for the manual command. The function calls the
value of @code{org-man-command} to display the man page.
Finally the function @code{org-man-store-link} is defined. When you try
-to store a link with @kbd{C-c l}, also this function will be called to
+to store a link with @kbd{C-c l}, this function will be called to
try to make a link. The function must first decide if it is supposed to
-create the link for this buffer type, we do this by checking the value
+create the link for this buffer type; we do this by checking the value
of the variable @code{major-mode}. If not, the function must exit and
return the value @code{nil}. If yes, the link is created by getting the
manual topic from the buffer name and prefixing it with the string
the link description when the link is later inserted into an Org
buffer with @kbd{C-c C-l}.
-@node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
+When is makes sense for your new link type, you may also define a function
+@code{org-PREFIX-complete-link} that implements special (@eg 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.
+
+@node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
+@section Context-sensitive commands
+@cindex context-sensitive commands, hooks
+@cindex add-ons, context-sensitive commands
+@vindex org-ctrl-c-ctrl-c-hook
+
+Org has several commands that act differently depending on context. The most
+important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
+Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
+
+Add-ons can tap into this functionality by providing a function that detects
+special context for that add-on and executes functionality appropriate for
+the context. Here is an example from Dan Davison's @file{org-R.el} which
+allows you to evaluate commands based on the @file{R} programming language. For
+this package, special contexts are lines that start with @code{#+R:} or
+@code{#+RR:}.
+
+@lisp
+(defun org-R-apply-maybe ()
+ "Detect if this is context for org-R and execute R commands."
+ (if (save-excursion
+ (beginning-of-line 1)
+ (looking-at "#\\+RR?:"))
+ (progn (call-interactively 'org-R-apply)
+ t) ;; to signal that we took action
+ nil)) ;; to signal that we did not
+
+(add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
+@end lisp
+
+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.
+
+
+@node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
@section Tables and lists in arbitrary syntax
@cindex tables, in other modes
@cindex lists, in other modes
frequent feature request has been to make it work with native tables in
specific languages, for example La@TeX{}. 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.
Just above the source table, we put a special line that tells
Orgtbl mode how to translate this table and where to install it. For
example:
+@cindex #+ORGTBL
@example
#+ORGTBL: SEND table_name translation_function arguments....
@end example
@samp{/*} and @samp{*/} lines.
@item
Sometimes it is possible to put the table after some kind of @i{END}
-statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
+statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
in La@TeX{}.
@item
-You can just comment the table line by line whenever you want to process
+You can just comment the table line-by-line whenever you want to process
the file, and uncomment it whenever you need to edit the table. This
-only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
-make this comment-toggling very easy, in particular if you bind it to a
+only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
+makes this comment-toggling very easy, in particular if you bind it to a
key.
@end itemize
@node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
-@subsection A LaTeX example of radio tables
-@cindex LaTeX, and Orgtbl mode
+@subsection A La@TeX{} example of radio tables
+@cindex La@TeX{}, and Orgtbl mode
The best way to wrap the source table in La@TeX{} is to use the
@code{comment} environment provided by @file{comment.sty}. It has to be
be prompted for a table name, let's say we use @samp{salesfigures}. You
will then get the following template:
-@cindex #+ORGTBL: SEND
+@cindex #+ORGTBL, SEND
@example
% BEGIN RECEIVE ORGTBL salesfigures
% END RECEIVE ORGTBL salesfigures
@end example
@noindent
+@vindex La@TeX{}-verbatim-environments
The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
@code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
into the receiver location with name @code{salesfigures}. You may now
fill in the table, feel free to use the spreadsheet features@footnote{If
the @samp{#+TBLFM} line contains an odd number of dollar characters,
-this may cause problems with font-lock in LaTeX mode. As shown in the
+this may cause problems with font-lock in La@TeX{} mode. As shown in the
example you can fix this by adding an extra line inside the
@code{comment} environment that is used to balance the dollar
-expressions. If you are using AUCTeX with the font-latex library, a
+expressions. If you are using AUC@TeX{} with the font-latex library, a
much better solution is to add the @code{comment} environment to the
variable @code{LaTeX-verbatim-environments}.}:
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 does skip the first 2 lines of the source
-table, and tell the command to work as a @i{splice}, i.e. to not produce
+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}, @ie to not produce
header and footer commands of the target table:
@example
The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
Orgtbl mode. It uses a @code{tabular} environment to typeset the table
and marks horizontal lines with @code{\hline}. Furthermore, it
-interprets the following parameters (see also @ref{Translator functions}):
+interprets the following parameters (see also @pxref{Translator functions}):
@table @code
@item :splice nil/t
tabular environment. Default is nil.
@item :fmt fmt
-A format to be used to wrap each field, should contain @code{%s} for the
+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\\%%")}.
translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
itself is a very short function that computes the column definitions for the
@code{tabular} environment, defines a few field and line separators and then
-hands over to the generic translator. Here is the entire code:
+hands processing over to the generic translator. Here is the entire code:
@lisp
@group
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 (@ie the
ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
would like to use the La@TeX{} translator, but wanted the line endings to
be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
analogy with the La@TeX{} translator, or you can use the generic function
directly. For example, if you have a language where a table is started
with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
-started with @samp{!BL!}, ended with @samp{!EL!} and where the field
+started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
separator is a TAB, you could call the generic translator like this (on
a single line!):
@noindent
Please check the documentation string of the function
@code{orgtbl-to-generic} for a full list of parameters understood by
-that function and remember that you can pass each of them into
+that function, and remember that you can pass each of them into
@code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
using the generic function.
argument is the property list containing all parameters specified in the
@samp{#+ORGTBL: SEND} line. The function must return a single string
containing the formatted table. If you write a generally useful
-translator, please post it on @code{emacs-orgmode@@gnu.org} so that
+translator, please post it on @email{emacs-orgmode@@gnu.org} so that
others can benefit from your work.
@node Radio lists, , Translator functions, Tables in arbitrary syntax
The available translation functions for radio lists don't take
parameters.
@item
-`C-c C-c' will work when pressed on the first item of the list.
+@kbd{C-c C-c} will work when pressed on the first item of the list.
@end itemize
Here is a La@TeX{} example. Let's say that you have this in your
La@TeX{} file:
+@cindex #+ORGLIST
@example
% BEGIN RECEIVE ORGLST to-buy
% END RECEIVE ORGLST to-buy
If you want to make sure that all dynamic blocks are always up-to-date,
you could add the function @code{org-update-all-dblocks} to a hook, for
example @code{before-save-hook}. @code{org-update-all-dblocks} is
-written in a way that is does nothing in buffers that are not in
+written in a way such that it does nothing in buffers that are not in
@code{org-mode}.
-@node Special agenda views, Using the property API, Dynamic blocks, Hacking
+@node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
@section Special agenda views
@cindex agenda views, user-defined
(org-agenda-overriding-header "Projects waiting for something: "))))
@end lisp
+@vindex org-agenda-overriding-header
Note that this also binds @code{org-agenda-overriding-header} to get a
meaningful header in the agenda view.
+@vindex org-odd-levels-only
+@vindex org-agenda-skip-function
A general way to create custom searches is to base them on a search for
entries with a certain level limit. If you want to study all entries with
-your custom search function, simply do a search for @samp{LEVEL>0}, and then
-use @code{org-agenda-skip-function} to select the entries you really want to
-have.
+your custom search function, simply do a search for
+@samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
+level number corresponds to order in the hierarchy, not to the number of
+stars.}, and then use @code{org-agenda-skip-function} to select the entries
+you really want to have.
You may also put a Lisp form into @code{org-agenda-skip-function}. In
particular, you may use the functions @code{org-agenda-skip-entry-if}
Skip current entry if it has a deadline.
@item '(org-agenda-skip-entry-if 'scheduled 'deadline)
Skip current entry if it has a deadline, or if it is scheduled.
+@item '(org-agenda-skip-entry-if 'timestamp)
+Skip current entry if it has any timestamp, may also be deadline or scheduled.
@item '(org-agenda-skip-entry 'regexp "regular expression")
Skip current entry if the regular expression matches in the entry.
@item '(org-agenda-skip-entry 'notregexp "regular expression")
(org-agenda-overriding-header "Projects waiting for something: "))))
@end lisp
-@node Using the property API, Using the mapping API, Special agenda views, Hacking
+@node Extracting agenda information, Using the property API, Special agenda views, Hacking
+@section Extracting agenda information
+@cindex agenda, pipe
+@cindex Scripts, for agenda processing
+
+@vindex org-agenda-custom-commands
+Org provides commands to access agenda information for the command
+line in Emacs batch mode. This extracted information can be sent
+directly to a printer, or it can be read by a program that does further
+processing of the data. The first of these commands is the function
+@code{org-batch-agenda}, that produces an agenda view and sends it as
+ASCII text to STDOUT. The command takes a single string as parameter.
+If the string has length 1, it is used as a key to one of the commands
+you have configured in @code{org-agenda-custom-commands}, basically any
+key you can use after @kbd{C-c a}. For example, to directly print the
+current TODO list, you could use
+
+@example
+emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
+@end example
+
+If the parameter is a string with 2 or more characters, it is used as a
+tags/TODO match string. For example, to print your local shopping list
+(all items with the tag @samp{shop}, but excluding the tag
+@samp{NewYork}), you could use
+
+@example
+emacs -batch -l ~/.emacs \
+ -eval '(org-batch-agenda "+shop-NewYork")' | lpr
+@end example
+
+@noindent
+You may also modify parameters on the fly like this:
+
+@example
+emacs -batch -l ~/.emacs \
+ -eval '(org-batch-agenda "a" \
+ org-agenda-ndays 30 \
+ org-agenda-include-diary nil \
+ org-agenda-files (quote ("~/org/project.org")))' \
+ | lpr
+@end example
+
+@noindent
+which will produce a 30-day agenda, fully restricted to the Org file
+@file{~/org/projects.org}, not even including the diary.
+
+If you want to process the agenda data in more sophisticated ways, you
+can use the command @code{org-batch-agenda-csv} to get a comma-separated
+list of values for each agenda item. Each line in the output will
+contain a number of fields separated by commas. The fields in a line
+are:
+
+@example
+category @r{The category of the item}
+head @r{The headline, without TODO keyword, TAGS and PRIORITY}
+type @r{The type of the agenda entry, can be}
+ todo @r{selected in TODO match}
+ tagsmatch @r{selected in tags match}
+ diary @r{imported from diary}
+ deadline @r{a deadline}
+ scheduled @r{scheduled}
+ timestamp @r{appointment, selected by timestamp}
+ closed @r{entry was closed on date}
+ upcoming-deadline @r{warning about nearing deadline}
+ past-scheduled @r{forwarded scheduled item}
+ block @r{entry has date block including date}
+todo @r{The TODO keyword, if any}
+tags @r{All tags including inherited ones, separated by colons}
+date @r{The relevant date, like 2007-2-14}
+time @r{The time, like 15:00-16:50}
+extra @r{String with extra planning info}
+priority-l @r{The priority letter if any was given}
+priority-n @r{The computed numerical priority}
+@end example
+
+@noindent
+Time and date will only be given if a timestamp (or deadline/scheduled)
+led to the selection of the item.
+
+A CSV list like this is very easy to use in a post-processing script.
+For example, here is a Perl program that gets the TODO list from
+Emacs/Org and prints all the items, preceded by a checkbox:
+
+@example
+#!/usr/bin/perl
+
+# define the Emacs command to run
+$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
+
+# run it and capture the output
+$agenda = qx@{$cmd 2>/dev/null@};
+
+# loop over all lines
+foreach $line (split(/\n/,$agenda)) @{
+ # get the individual values
+ ($category,$head,$type,$todo,$tags,$date,$time,$extra,
+ $priority_l,$priority_n) = split(/,/,$line);
+ # process and print
+ print "[ ] $head\n";
+@}
+@end example
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+@node Using the property API, Using the mapping API, Extracting agenda information, Hacking
@section Using the property API
@cindex API, for properties
@cindex properties, API
properties.
@defun org-entry-properties &optional pom which
-Get all properties of the entry at point-or-marker POM.
+Get all properties of the entry at point-or-marker POM.@*
This includes the TODO keyword, the tags, time strings for deadline,
scheduled, and clocking, and any additional properties defined in the
entry. The return value is an alist, keys may occur multiple times
-if the property key was used several times.
+if the property key was used several times.@*
POM may also be nil, in which case the current entry is used.
If WHICH is nil or `all', get all properties. If WHICH is
`special' or `standard', only get that subclass.
@end defun
+@vindex org-use-property-inheritance
@defun org-entry-get pom property &optional inherit
Get value of PROPERTY for entry at point-or-marker POM. By default,
this only looks at properties defined locally in the entry. If INHERIT
@defun org-map-entries func &optional match scope &rest skip
Call FUNC at each headline selected by MATCH in SCOPE.
-FUNC is a function or a lisp form. The function will be called without
+FUNC is a function or a Lisp form. The function will be called without
arguments, with the cursor positioned at the beginning of the headline.
The return values of all calls to the function will be collected and
returned as a list.
+The call to FUNC will be wrapped into a save-excursion form, so FUNC
+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 (@eg 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
+position.
+
MATCH is a tags/property/todo match as it is used in the agenda match view.
Only headlines that are matched by this query will be considered during
the iteration. When MATCH is nil or t, all headlines will be
(file1 file2 ...)
@r{if this is a list, all files in the list will be scanned}
@end example
-
+@noindent
The remaining args are treated as settings for the skipping facilities of
the scanner. The following items can be given here:
+@vindex org-agenda-skip-function
@example
archive @r{skip trees with the archive tag}
comment @r{skip trees with the COMMENT keyword}
@cindex history
@cindex thanks
-Org was borne in 2003, out of frustration over the user interface
+Org was born in 2003, out of frustration over the user interface
of the Emacs Outline mode. I was trying to organize my notes and
projects, and using Emacs seemed to be the natural way to go. However,
having to remember eleven different commands with two or three keys per
command, only to hide and show parts of the outline tree, that seemed
entirely unacceptable to me. Also, when using outlines to take notes, I
-constantly want to restructure the tree, organizing it parallel to my
+constantly wanted to restructure the tree, organizing it parallel to my
thoughts and plans. @emph{Visibility cycling} and @emph{structure
editing} were originally implemented in the package
@file{outline-magic.el}, but quickly moved to the more general
@file{org.el}. As this environment became comfortable for project
-planning, the next step was adding @emph{TODO entries}, basic @emph{time
-stamps}, and @emph{table support}. These areas highlight the two main
-goals that Org still has today: To create a new, outline-based,
+planning, the next step was adding @emph{TODO entries}, basic
+@emph{timestamps}, and @emph{table support}. These areas highlighted the two main
+goals that Org still has today: to be a new, outline-based,
plain text mode with innovative and intuitive editing features, and to
incorporate project planning functionality directly into a notes file.
A special thanks goes to @i{Bastien Guerry} who has not only written a large
number of extensions to Org (most of them integrated into the core by now),
-but has also helped the development and maintenance of Org so much that he
+but who has also helped in the development and maintenance of Org so much that he
should be considered the main co-contributor to this package.
-Since the first release, literally thousands of emails to me or on
-@code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
+Since the first release, literally thousands of emails to me or to
+@email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
reports, feedback, new ideas, and sometimes patches and add-on code.
Many thanks to everyone who has helped to improve this package. I am
trying to keep here a list of the people who had significant influence
@i{Christophe Bataillon} created the great unicorn logo that we use on the
Org-mode website.
@item
-@i{Alex Bochannek} provided a patch for rounding time stamps.
+@i{Alex Bochannek} provided a patch for rounding timestamps.
+@item
+@i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
+@item
+@i{Tom Breton} wrote @file{org-choose.el}.
@item
@i{Charles Cave}'s suggestion sparked the implementation of templates
for Remember.
@i{Pavel Chalmoviansky} influenced the agenda treatment of items with
specified time.
@item
-@i{Gregory Chernov} patched support for lisp forms into table
+@i{Gregory Chernov} patched support for Lisp forms into table
calculations and improved XEmacs compatibility, in particular by porting
@file{nouline.el} to XEmacs.
@item
-@i{Sacha Chua} suggested to copy some linking code from Planner.
+@i{Sacha Chua} suggested copying some linking code from Planner.
+@item
+@i{Baoqiu Cui} contributed the DocBook exporter.
@item
@i{Eddward DeVilla} proposed and tested checkbox statistics. He also
came up with the idea of properties, and that there should be an API for
them.
@item
+@i{Nick Dokos} tracked down several nasty bugs.
+@item
@i{Kees Dullemond} used to edit projects lists directly in HTML and so
inspired some of the early development, including HTML export. He also
asked for a way to narrow wide table columns.
@item
@i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
task state change logging, and the clocktable. His clear explanations have
-been critical when we started to adopt the GIT version control system.
+been critical when we started to adopt the Git version control system.
@item
-@i{Manuel Hermenegildo} has contributed various ideas, small fixed and
+@i{Manuel Hermenegildo} has contributed various ideas, small fixes and
patches.
@item
@i{Phil Jackson} wrote @file{org-irc.el}.
@i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
happy.
@item
-@i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
-and to be able to quickly restrict the agenda to a subtree.
+@i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
+and being able to quickly restrict the agenda to a subtree.
@item
-@i{Todd Neal} provided patches for links to Info files and elisp forms.
+@i{Todd Neal} provided patches for links to Info files and Elisp forms.
+@item
+@i{Greg Newman} refreshed the unicorn logo into its current form.
@item
@i{Tim O'Callaghan} suggested in-file links, search options for general
file links, and TAGS.
@i{Pete Phillips} helped during the development of the TAGS feature, and
provided frequent feedback.
@item
+@i{Martin Pohlack} provided the code snippet to bundle character insertion
+into bundles of 20 for undo.
+@item
@i{T.V. Raman} reported bugs and suggested improvements.
@item
@i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
@i{Kevin Rogers} contributed code to access VM files on remote hosts.
@item
@i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
-webpages derived from Org using an Info-like, or a folding interface with
-single key navigation.
+webpages derived from Org using an Info-like or a folding interface with
+single-key navigation.
@item
@i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
conflict with @file{allout.el}.
@item
-@i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
+@i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
extensive patches.
@item
@i{Philip Rooke} created the Org reference card, provided lots
@i{Christian Schlauer} proposed angular brackets around links, among
other things.
@item
-@i{Eric Schulte} wrote @file{org-plot.el}.
+@i{Eric Schulte} wrote @file{org-plot.el} and contributed various patches,
+small features and modules.
@item
Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
@file{organizer-mode.el}.
@node Main Index, Key Index, History and Acknowledgments, Top
-@unnumbered The Main Index
+@unnumbered Concept Index
@printindex cp
-@node Key Index, , Main Index, Top
+@node Key Index, Variable Index, Main Index, Top
@unnumbered Key Index
@printindex ky
+@node Variable Index, , Key Index, Top
+@unnumbered Variable Index
+
+This is not a complete index of variables and faces, only the ones that are
+mentioned in the manual. For a more complete list, use @kbd{M-x
+org-customize @key{RET}} and then klick yourself through the tree.
+
+@printindex vr
+
@bye
@ignore
% Reference Card for Org Mode
-\def\orgversionnumber{6.21b}
+\def\orgversionnumber{6.29c}
\def\versionyear{2009} % latest update
\def\year{2009} % latest copyright year
\section{Getting Started}
%
-\vskip -1mm
+\vskip -2mm
\beginexample%
(add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
(define-key global-map "\\C-cl" 'org-store-link)$^1$
(define-key global-map "\\C-ca" 'org-agenda)$^1$
\endexample
%
-\metax{For the many customization options try}{M-x org-customize}
\metax{To read the on-line documentation try}{M-x org-info}
\section{Visibility Cycling}
\metax{promote/demote current subtree}{M-S-LEFT/RIGHT}
\metax{move subtree/list item up/down}{M-S-UP/DOWN}
+\metax{sort subtree/region/plain-list}{C-c \^{}}
+\metax{clone a subtree}{C-c C-x c}
\metax{refile subtree}{C-c C-w}
\metax{kill/copy subtree}{C-c C-x C-w/M-w}
\metax{yank subtree}{C-c C-x C-y or C-y}
\key{re-align the table, move to next field}{TAB}
\key{move to previous field}{S-TAB}
\key{re-align the table, move to next row}{RET}
+\key{move to beginning/end of field}{M-a/e}
{\bf Row and column editing}
\key{iterate table to stability}{C-u C-u C-c *}
\key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
\key{show line, column, formula reference}{C-c ?}
-\key{toggle coordinate grid}{C-c \}}
-\key{toggle formula debugger}{C-c \{}
+\key{toggle grid / debugger}{C-c \}/\{}
\newcolumn
{\it Formula Editor}
\key{find next link}{C-c C-x C-n}
\key{find previous link}{C-c C-x C-p}
\key{edit code snippet of file at point}{C-c '}
+
{\bf Internal Links}
\key{\kbd{<<My Target>>}}{\rm target}
macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS
after ``{\tt :}'', and dictionary words elsewhere.
-\key{Complete word at point}{M-TAB}
+\key{complete word at point}{M-TAB}
\newcolumn
\key{rotate the state of the current item}{C-c C-t}
\metax{select next/previous state}{S-LEFT/RIGHT}
\metax{select next/previous set}{C-S-LEFT/RIGHT}
+\key{toggle ORDERED property}{C-c C-x o}
\key{view TODO items in a sparse tree}{C-c C-v}
\key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
\key{insert new checkbox item in plain list}{M-S-RET}
\key{toggle checkbox(es) in region/entry/at point}{C-c C-x C-b}
\key{toggle checkbox at point}{C-c C-c}
-\metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{}
+%\metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{}
\key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#}
\section{Tags}
\key{capture columns view in dynamic block}{C-c C-x i}
\key{quit column view}{q}
-\key{next/previous allowed value}{S-left/right}
-\key{next/previous allowed value}{n / p}
+\key{show full value}{v}
\key{edit value}{e}
+\metax{next/previous allowed value}{n/p or S-left/right}
\key{edit allowed values list}{a}
-\key{show value}{v}
\key{make column wider/narrower}{> / <}
\key{move column left/right}{M-left/right}
\key{add new column}{M-S-right}
\key{prompt for date and insert timestamp}{C-c .}
\key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
-\key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
+\key{like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
\key{insert DEADLINE timestamp}{C-c C-d}
\key{insert SCHEDULED timestamp}{C-c C-s}
\key{create sparse tree with all deadlines due}{C-c / d}
\key{access the calendar for the current date}{C-c >}
\key{insert timestamp matching date in calendar}{C-c <}
\key{access agenda for current date}{C-c C-o}
-\key{Select date while prompted}{mouse-1/RET}
+\key{select date while prompted}{mouse-1/RET}
%\key{... select date in calendar}{mouse-1/RET}
%\key{... scroll calendar back/forward one month}{< / >}
%\key{... forward/backward one day}{S-LEFT/RIGHT}
%\key{... forward/backward one week}{S-UP/DOWN}
%\key{... forward/backward one month}{M-S-LEFT/RIGT}
-\key{Toggle custom format display for dates/times}{C-c C-x C-t}
+\key{toggle custom format display for dates/times}{C-c C-x C-t}
\newcolumn
{\bf Change display}
\key{delete other windows}{o}
-\key{switch to day/week/month/year view}{d w m y}
+\key{switch to day/week/month/year view}{d w vm vy}
\key{toggle inclusion of diary entries}{D}
\key{toggle time grid for daily schedule}{G}
\key{toggle display of logbook entries}{l}
\key{filter with repect to a tag}{/}
\key{save all org-mode buffers}{s}
\key{display next/previous day,week,...}{RIGHT/LEFT}
-\key{goto today}{.}
+\key{goto today / some date (prompt)}{. / j}
{\bf Remote editing}
\key{change state of current TODO item}{t}
\key{kill item and source}{C-k}
\key{archive the subtree (file/tag/sibling)}{\$ / a / A}
+\key{refile the subtree}{C-c C-w}
\key{show tags of current headline}{T}
\key{set tags for current headline/region}{:}
-\key{set priority of current item}{p}
+\key{set / compute priority of current item}{p / P}
\key{raise/lower priority of current item}{S-UP/DOWN$^3$}
-\key{display weighted priority of current item}{P}
\key{run an attachment command}{C-c C-a}
\key{schedule/set deadline for this item}{C-c C-s/d}
\key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
\key{change timestamp to today}{>}
\key{insert new entry into diary}{i}
-
\newcolumn
\key{start/stop/cancel the clock on current item}{I / O / X}
\key{jump to running clock entry}{J}
+\key{mark / unmark / execute bulk action}{m / u / B}
{\bf Misc}
-\key{Open link in current line}{C-c C-o}
+\key{open link in current line}{C-c C-o}
{\bf Calendar commands}
\key{quit agenda, remove agenda buffer}{q}
\key{exit agenda, remove all agenda buffers}{x}
-\section{Calendar and Diary Integration}
-
-Include Emacs diary entries into Org-mode agenda with:
-\beginexample%
-(setq org-agenda-include-diary t)
-\endexample
-
\section{LaTeX and cdlatex-mode}
\key{preview LaTeX fragment}{C-c C-x C-l}
-\key{Expand abbreviation (cdlatex-mode)}{TAB}
-\key{Insert/modify math symbol (cdlatex-mode)}{` / '}
+\key{expand abbreviation (cdlatex-mode)}{TAB}
+\key{insert/modify math symbol (cdlatex-mode)}{` / '}
+\key{insert citation using RefTeX}{C-c C-x [}
\section{Exporting and Publishing}
\key{export/publish dispatcher}{C-c C-e}
\key{export visible part only}{C-c C-e v}
-\key{insert template of export options}{C-c C-x t}
+\key{insert template of export options}{C-c C-e t}
\key{toggle fixed width for entry or region}{C-c :}
%{\bf HTML formatting}
$^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
press \kbd{C-c C-c} with the cursor still in the line to update.
-$^3$ Keybinding affected by {\tt org-CUA-compatibility}.
+$^3$ Keybinding affected by {\tt org-support-shift-select} and {\tt
+ org-replace-disputed-keys}.
\copyrightnotice
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-create-formula-image): Remove the -E option for
+ dvipng.
+
+ * org-exp.el (org-default-export-plist): Respect #+BIND.
+ (org-export-confirm-letbind): New function.
+
+ * org.el (org-paste-subtree): Test the kill ring entry if it is
+ going to be used.
+ (org-copy-subtree): Use `org-forward-same-level'.
+ (org-forward-same-level): Respect the `invisibe-ok' arg for
+ back-to-heading.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-table-map-tables): Make sure cursor is back at table
+ beginning after funcall.
+
+ * org-agenda.el (org-agenda-bulk-action): Make sure parents are
+ handled before children, and do not error if an entry is not
+ found, probably because it hase been remove when the parent was
+ archived or refiled.
+
+ * org.el (org-ido-completing-read): Accept straight lists for
+ completion as well as alists.
+
+ * org-timer.el (org-timer-cancel-timers): Renamed from
+ `org-timer-cancel-timers'.
+
+ * org.el (org-cycle-internal-local): Fix problem with finding next
+ invisible line.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-list.el (org-list-send-list): Call
+ `org-list-goto-true-beginning' instead of
+ `org-list-find-true-beginning', which does not exist.
+
+ * org-timer.el (org-timer-reset-timers): Use `mapc'.
+ (org-timer-set-timer): Do not assign to heading.
+
+ * org-id.el (org-id-open): Quote function name.
+
+ * org-macs.el (org-unmodified): Turn off recording undo
+ information while running inside the macro.
+
+ * org-table.el (org-table-export): Also work in file-less
+ buffers.
+
+ * org.el (org-startup-indented): New option.
+ (org-startup-options): Add new options indent and noindent.
+ (org-unfontify-region): Remove line-prefix and wrap-prefix
+ properties.
+ (org-after-demote-entry-hook, org-after-promote-entry-hook): New
+ hooks.
+ (org-promote, org-demote): Run the new hooks.
+
+ * org-table.el (org-table-align): Replace leading \n as well.
+
+ * org-exp.el (org-export-push-to-kill-ring): Remove `line-prefix'
+ and `line-wrap' text properties.
+
+ * org-compat.el (org-kill-new): New function.
+
+ * org-agenda.el (org-format-agenda-item): Remove `line-prefix' and
+ `line-wrap' text properties.
+
+ * org-indent.el: New file.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-provide-todo-statistics): Tweak docstring.
+
+ * org-id.el (org-id-open): Honor `org-link-frame-setup'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-as-org): Insert the "-source" string
+ before the extension.
+
+ * org.el (org-read-date): Make sure the calendar is in the current
+ frame.
+ (org-set-emph-re): Remove the ? from the post-match.
+ (org-emphasis-regexp-components): Add backslash to the
+ postmatch class.
+ (org-set-font-lock-defaults): Write \n instead of \xa, and make it
+ optional so that also lines at the end of the buffers will still
+ be matched as headlines.
+
+ * org-table.el (org-table-error-on-row-ref-crossing-hline):
+ Variable made obsolete.
+ (org-table-relative-ref-may-cross-hline): New option.
+ (org-table-find-row-type): Honow the new option
+ `org-table-relative-ref-may-cross-hline'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-table.el (org-table-cut-region, org-table-copy-region): Work
+ on single field if no active region.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-make-header): Only insert title
+ if one is defined.
+
+ * org.el (org-make-options-regexp): Allow empty values.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-cycle-internal-local): Improved version of finding
+ next visible line.
+ (org-cycle-hide-drawers): Only hide drawers if this is really
+ necessary.
+ (outline-end-of-subtree): Make `outline-end-of-subtree' use the
+ org-version of this function in Org-mode. We use advice to
+ implement this change, so that future changes to this function in
+ outline.el wil be handled properly.
+ (org-forward-same-level, org-backward-same-level): New commands.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-remove-empty-overlays-at)
+ (org-clean-visibility-after-subtree-move): New functons.
+ (org-move-subtree-down): Simplify cleanup of display.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-mac-message.el (org-mac-message-get-links): Improve
+ docstring. Make argument SELECT-OR-FLAGGED optional, default to
+ "s". Fix the return value.
+ (org-mac-message-insert-flagged): Simplify.
+
+ * org.el (org-refile-get-location): Tamper with refile history o
+ that history contains compete matches instead of the entered
+ string.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-store-link): Never store a link to an inline task.
+
+ * org-footnote.el (org-footnote-goto-local-insertion-point): Skip
+ inline tasks when positioning footnotes.
+
+ * org.el (org-refile): Remove the END line when archiving an
+ inline task that does have an END line.
+
+ * org-archive.el (org-archive-subtree): Remove the END line when
+ archiving an inline task that does have an END line.
+
+ * org-macs.el (org-with-limited-levels): New macro.
+ (org-get-limited-outline-regexp): New function.
+
+ * org-exp.el (org-export-format-source-code-or-example): Fix bug
+ that did not enumerate first line.
+ (org-export-mark-radio-links): Skip matches in links.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-activate-plain-links): Make single-match.
+ (org-adapt-indentation): Fix docstring.
+
+ * org-macs.el (org-unmodified): Turn of modification hooks while
+ running this macro.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (org-adapt-indentation): Slightly improve the docstring.
+ (org-occur): Sends an error when the user inputs an empty string.
+ (org-priority): Bugfix: the tag alignement should happen within
+ save-excursion.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (org-make-link-regexps): Don't exclude parentheses from
+ `org-plain-link-re'
+ (org-cycle-internal-local): When locally cycling, switch directly
+ from CHILDREN to FOLDED if there is no subtree
+ (org-cycle): Update the docstring to document the new behavior of
+ `org-cycle-internal-local'.
+
+2009-08-06 Nicolas Goaziou <n.goaziou@neuf.fr> (tiny change)
+
+ * org-clock.el (org-clock-in): Bugfix: recognize timestamps with
+ an abbreviated format for days.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org-protocol.el (org-protocol-default-template-key): New
+ option.
+
+ * org.el (org-refile): Bugfix: save-excursion before reading the
+ refile target, otherwise cursor moves might confuse `org-refile'.
+
+ * org.el (org-toggle-heading): Bugfix: correctly convert list
+ items before the first headline.
+
+ * org.el (org-provide-todo-statistics): Allow a list of TODO
+ keywords to compute statistics against headlines containing a
+ keyword from this list.
+ (org-update-parent-todo-statistics): Possibly use the new allowed
+ value of `org-provide-todo-statistics'.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org-timer.el: Add autoload cookie.
+
+ * org.el (org-occur-link-in-agenda-files): New function.
+
+ * org-timer.el (org-timer-last-timer): New variable.
+
+ * org-agenda.el (org-agenda-mode-map): New key for
+ org-timer-set-timer called from the agenda.
+
+ * org.el (org-mode-map): New key for org-timer-set-timer.
+
+ * org-timer.el (org-timer-reset-timers)
+ (org-timer-show-remaining-time, org-timer-set-timer): New
+ functions.
+
+ * org-clock.el (org-show-notification): Update the docstring.
+
+ * org.el (org-provide-todo-statistics): Allow new value
+ 'all-headlines for this option, which includes entries with no
+ TODO keywords in the todo statistics.
+ (org-update-parent-todo-statistics): Possibly use the new
+ 'all-headline value from `org-provide-todo-statistics'.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org-clock.el (org-dblock-write:clocktable): Add a new option
+ :timestamp which allows display of timestamps in clock reports.
+
+ * org.el (org-mode-map): Define new key `C-c C-*': convert a plain
+ list to a subtree, preserving the structure of the list.
+ (org-set-emph-re): Make the last element optional in the regexp.
+ This regexp now matches an emphasized string at the end of a line.
+
+ * org-list.el (org-list-goto-true-beginning)
+ (org-list-make-subtree, org-list-make-subtrees): New functions.
+
+ * org.el (org-eval-in-calendar): Select the right frame.
+ (org-save-frame-excursion): Remove this macro.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org-list.el (org-list-beginning-re): Bugfix: don't use * when
+ trying to find the beginning of a list.
+
+ * org-exp.el (org-get-file-contents): Use a new argument: markup.
+ When present, tell org-get-file-contents not to protect org-like
+ lines.
+
+ * org-id.el (org-id-uuid-program): New option to set the name of
+ the uuidgen program.
+ (org-id-method): Use `org-id-uuid-program'.
+ (org-id-new): Use `org-id-uuid-program'.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org-exp.el (org-export-number-lines): Allow whitespace in code
+ references. Allow the -r switch to remove the references in the
+ source code even when the lines are not numbered: the labels can
+ be explicit enough.
+
+ * org.el (org-fontify-whole-heading-line): New option.
+ (org-set-font-lock-defaults): Use the new option.
+
+ * org-clock.el (org-show-notification-handler): New option.
+ (org-show-notification): Use the new option.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (org-eval-in-calendar): Fix a bug about calendar
+ navigation when `calendar-setup' value is 'calendar-only.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (orgstruct++-mode): Fix typo in docstring.
+ (org-insert-link): Clean up: (or (...)) => (...)
+ (org-insert-link): Use TAB for stored links completion.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (org-get-refile-targets): Fix bug: don't ignore case when
+ building the list of targets.
+
+ * org-remember.el (org-remember-delete-empty-lines-at-end): New
+ option.
+ (org-remember-handler): Use the new option.
+
+2009-08-06 James TD Smith <ahktenzero@mohorovi.cc>
+
+ * org.el (org-tags-sort-function): New option for sorting tags.
+ (org-set-tags): Use the new option to sort tags.
+
+ * org-plot.el (org-plot/gnuplot): Run with an idle timer to avoid
+ premature deletion of the data when using org-plot in a script.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org-clock.el (org-clock-in-prepare-hook): New hook.
+ (org-clock-in): Use this new hook.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (org-special-ctrl-a/e): Explicitely bind the value
+ 'reversed for this option to the "true line boundary first"
+ behavior.
+ (org-tags-match-list-sublevels): Document the 'indented value for
+ this variable.
+
+ * org-latex.el (org-export-latex-first-lines): Fix problem with
+ publishing the region.
+
+ * org-exp.el (org-export-format-source-code-or-example): Fix
+ bad line numbering when exporting examples in HTML.
+
+2009-08-06 James TD Smith <ahktenzero@mohorovi.cc>
+
+ * org-colview.el (org-format-time-period): Formats a time in
+ fractional days as days, hours, mins, seconds.
+ (org-columns-display-here): Add special handling for SINCE and
+ SINCE_IA to format for display.
+
+ * org.el (org-time-since): Add a function to get the time since an
+ org timestamp.
+ (org-entry-properties): Add two new special properties: SINCE and
+ SINCE_IA. These give the time since any active or inactive
+ timestamp in an entry.
+ (org-special-properties): Add SINCE, SINCE_IA.
+ (org-tags-sort-function): Add custom declaration for tags
+ sorting function.
+ (org-set-tags): Sort tags if org-tags-sort-function is set
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-clock.el (org-clock-goto): Find hidden headlines as well.
+
+ * org.el (org-narrow-to-subtree): Find hidden headlines as well.
+
+ * org-plot.el (org-plot/add-options-to-plist): Add timeind
+ option.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-publish.el (org-publish-remove-all-timestamps): New function.
+ (org-publish-all): Remove all timestamp files if `org-publish-all'
+ is called with a prefix argument.
+
+ * org-list.el (org-indent-item): Fix typo.
+ (org-item-indent-positions): Normalize ordered bullet.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-macs.el (org-set-local): Make a local variable, do not make
+ the variable buffer-local!
+
+ * org-latex.el (org-export-as-latex): Call `org-install-letbind'.
+
+ * org-exp.el (org-infile-export-plist): Read BIND lines.
+ (org-install-letbind): New function.
+ (org-export-as-org, org-export-preprocess-string): Call
+ `org-install-letbind'.
+
+ * org-list.el (org-list-demote-modify-bullet): New option.
+ (org-first-list-item-p): Save point.
+ (org-fix-bullet-type): New optional argument FORCE-BULLET.
+ (org-indent-item): Honor `org-list-demote-modify-bullet'.
+ (org-item-indent-positions): Return bullet types along with
+ indentation.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-show-entry): Hide drawers.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-footnote.el (org-footnote-auto-adjust): New option.
+ (org-footnote-auto-adjust-maybe): New function.
+ (org-footnote-new, org-footnote-delete): Call
+ `org-footnote-auto-adjust-maybe'.
+
+ * org.el (org-startup-options): Add new footnote-related
+ keywords.
+
+ * org-publish.el (org-publish-timestamp-filename): Additional
+ arguments PUB-DIR and PUB-FUNC, which are included in the hash.
+ (org-publish-needed-p): Additional arguments PUB-DIR PUB-FUNC
+ TRUE-PUB-DIR. Pass them through to
+ `org-publish-timestamp-filename'.
+ (org-publish-update-timestamp): Additional arguments PUB-DIR and
+ PUB-FUNC, which are included in the hash.
+ (org-publish-file): Delay timestamp test until the publishing
+ function is known.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-bulk-action): Add scheduling and
+ setting the deadline.
+
+ * org.el (org-read-date-final-answer): New variable.
+ (org-read-date): Store the final answer string, including the date
+ from the calendar, for reuse by agenda bulk commands.
+
+ * org-publish.el (org-publish-attachment): Fix publishing of
+ attachments.
+
+ * org-latex.el (org-export-latex-quotation-marks): Fix export of
+ quotation makrs in parenthesis.
+ (org-remove-initial-hash): New function.
+ (org-export-latex-preprocess): Fix bug with infinite loop if
+ environment is not properly closed.
+
+ * org-table.el (org-table-get-remote-range): Find #+TBLNAME also
+ when indented.
+
+ * org.el (org-fontify-meta-lines-and-blocks): Make #+TBLNAME
+ highlight also when indented.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-footnote.el (org-footnote-renumber-fn:N): New command.
+ (org-footnote-action): Offer renumbering.
+
+ * org.el (org-cycle): Honor the `integrate' value of
+ org-cycle-include-plain-lists'.
+
+ * org-list.el (org-cycle-include-plain-lists): New allowed value
+ `internal'. Improve the docstring.
+
+ * org.el (org-set-autofill-regexps): Improve the paragraph-start
+ regexp to work better with LaTeX commands.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-inline-image-extensions): Add ps
+ and eps extensions.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-write-agenda): Make sure org-icalendar is
+ loaded.
+
+ * org.el (org-map-entries): No longer force
+ `org-tags-match-list-sublevels' to t during a todo-only tags
+ search.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-low-levels): Allow user-defined
+ environment.
+ (org-export-latex-subcontent): Handle user-defined environment.
+
+ * org-agenda.el (org-agenda-view-mode-dispatch): Add more keys to
+ the View dispatcher.
+
+ * org.el (org-hide-block-toggle): Use `org-make-overlay' instead of
+ `make-overlay'.
+
+ * org-latex.el (org-export-as-pdf): Protect match data during call
+ to shell-quote-argument.
+
+ * org-agenda.el (org-agenda-mode-map): Modify bulk action keys.
+ (org-agenda-view-mode-dispatch): New function.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-mode): Reset list of marks.
+ (org-agenda-mode-map): Define new keys for refile and bulk action.
+ (org-agenda-menu): Add menu itesm for refile and bulk action.
+ (org-agenda-refile): New function.
+ (org-agenda-set-tags): Optional arguments TAG and ONOFF.
+ (org-agenda-marked-entries): New variable.
+ (org-agenda-bulk-select, org-agenda-remove-bulk-action-overlays)
+ (org-agenda-remove-all-bulk-action-marks)
+ (org-agenda-bulk-action): New functions/commands.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-get-file-contents): Protect org-like lines in
+ included files.
+ (org-export-format-source-code-or-example): Remove newlines.
+
+ * org-latex.el (org-export-latex-links): Check for no-description
+ marking.
+
+ * org-exp.el (org-export-preprocess-apply-macros): Switch macro
+ argument separator back to comma.
+ (org-export-normalize-links): Mark links without description.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-infile-export-plist): Fix bug in macro
+ processing.
+
+ * org-agenda.el (org-agenda-clock-out): Update line after clocking
+ out.
+ (org-agenda-highlight-todo): Fix bug with highlighting.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-set-font-lock-defaults): Adapt formatting to capture
+ new alignment strings.
+
+ * org-table.el (orgtbl-self-insert-command): Add yas/expand to
+ command list.
+ (org-table-align): Check for forced align type.
+
+ * org.el (org-self-insert-command): Add yas/expand to command
+ list.
+
+ * org-clock.el (org-clock-in-hook): New hook.
+ (org-clock-in): Run `org-clock-in-hook.
+ (org-clock-out-hook): New hook.
+ (org-clock-out): Run `org-clock-out-hook.
+ (org-clock-cancel-hook): New hook.
+ (org-clock-cancel): Run `org-clock-cancel-hook.
+ (org-clock-goto-hook): New hook.
+ (org-clock-goto): Run `org-clock-goto-hook.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-store-link): Better default description for link to
+ Org-mode headline.
+
+ * org-exp.el (org-export-generic): Autoload the generic exporter
+ function.
+ (org-export): Implement the `g' key for the generic exporter.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-table.el (orgtbl-setup): Add a binding for `S-iso-lefttab',
+ and for zbacktab'.
+
+ * org-exp.el (org-infile-export-plist): Get macros also from
+ #+SETUPFILE.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-colview.el (org-columns-capture-view): Protect vertical bars
+ in column values.
+ (org-columns-capture-view): Exclude comment and archived trees.
+
+ * org-colview-xemacs.el (org-columns-capture-view): Protect
+ vertical bars in column values.
+ (org-columns-capture-view): Exclude comment and archived trees.
+
+ * org.el (org-quote-vert): New function.
+
+ * org-latex.el (org-export-latex-verbatim-wrap): New option.
+
+ * org-exp.el (org-export-format-source-code-or-example): Use
+ `org-export-latex-verbatim-wrap'.
+
+ * org.el (org-clone-subtree-with-time-shift): Also shift inactive
+ time stamps.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp-blocks.el: New file.
+
+ * org-remember.el (org-remember-templates): Allow the headline
+ element to be a function.
+ (org-remember-apply-template): If the headline is a function, call
+ it to get the true function.
+
+ * org-clock.el (org-clock-menu): New function.
+ (org-clock-update-mode-line): Update help string.
+ (org-clock-modify-effort-estimate): New function.
+ (org-clock-mark-default-task): New function.
+
+ * org.el (org-hh:mm-string-to-minutes): Also take just a number of
+ minutes as input.
+ (org-org-menu): Add new clocking stuff.
+ (org-clock-is-active): New function.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-open-non-existing-files): Improve docstring.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-icalendar.el (org-icalendar-include-bbdb-anniversaries): New
+ option.
+ (org-export-icalendar): Call `org-bbdb-anniv-export-ical'.
+
+ * org-bbdb.el (org-bbdb-anniv-export-ical): New function.
+
+ * org-list.el (org-get-checkbox-statistics-face): Use the new
+ faces.
+
+ * org-faces.el (org-checkbox-statistics-todo)
+ (org-checkbox-statistics-done): New faces.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-use-verb): New variable.
+ (org-export-latex-emph-format): Prefer \texttt over \verb when
+ org-export-latex-use-verb is set.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-remember.el (org-remember-handler): Abort remember if the
+ buffer is empty.
+
+ * org-exp.el (org-export-format-source-code-or-example): Run
+ `org-src-mode-hook'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-indent-line-function): Fix indentation of +#end lines.
+
+2009-08-06 Tassilo Horn <tassilo@member.fsf.org>
+
+ * org-gnus.el (org-gnus-store-link): Require message.el in
+ org-gnus-store-link.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-src.el: New file, split out of org.el
+
+ * org-macs.el (org-replace-match-keep-properties): New function.
+
+ * org-exp.el (org-export-mark-blockquote-verse-center): Better
+ preprocessing of center and quote and verse blocks.
+
+ * org-list.el (org-list-end): Respect the stored "original"
+ indentation when determining the end of the list.
+
+ * org-exp.el (org-export-replace-src-segments-and-examples):
+ Remember indentation correctly.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-clock.el (org-clock-update-mode-line): Apply face
+ org-mode-line-clock.
+
+ * org-faces.el (org-mode-line-clock): New face.
+
+2009-08-06 Tassilo Horn <tassilo@member.fsf.org>
+
+ * org-gnus.el (org-gnus-store-link): Fix bug where
+ `org-gnus-store-link' used wrong subject when called in an article
+ buffer. Patch provided by fengli AT gmail DOT com.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-format-source-code-or-example): Remember
+ the original indentation of source code snippets and examples.
+
+ * org-latex.el (org-export-as-latex): Relocate the table of
+ contents.
+
+ * org.el (org-ctrl-c-ctrl-c): Update clock lines.
+
+ * org-agenda.el (org-run-agenda-series): Scope global options also
+ when creating the agenda buffer.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-adapt-indentation): Improve documentation.
+ (org-insert-property-drawer): Respect org-adapt-indentation when
+ inserting the drawer.
+ (org-remove-flyspell-overlays-in): New function.
+ (org-do-emphasis-faces, org-activate-plain-links)
+ (org-activate-code, org-fontify-meta-lines-and-blocks)
+ (org-activate-angle-links, org-activate-footnote-links)
+ (org-activate-bracket-links, org-activate-dates)
+ (org-activate-target-links, org-activate-tags): Remove flyspell
+ overlays.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-edit-src-save): New function.
+
+ * org-clock.el (org-clock-out-switch-to-state): New option.
+ (org-clock-out): Honor `org-clock-out-switch-to-state'.
+
+ * org-compat.el (org-compatible-face): Improve macro.
+
+ * org.el (org-global-properties-fixed): Add default for
+ CLOCK_MODELINE_TOTAL.
+
+ * org-clock.el (org-clock-sum): Accept lists and strigs as tstart
+ andd tend.
+ (org-clock-sum-current-item): Optional argument TSTART, pass it to
+ org-clock-sum.
+ (org-clock-get-sum-start): New function.
+
+ * org.el (org-startup-options): New keywords blockhide and
+ blockshow.
+ (org-mode): Add new invisibility spec.
+ (org-set-startup-visibility): Hide block on startup if so
+ desired.
+ (org-hide-block-startup): New option.
+ (org-block-regexp): New constant.
+ (org-hide-block-overlays): New variable.
+ (org-block-map, org-hide-block-toggle-all, org-hide-block-all)
+ (org-show-block-all, org-hide-block-toggle-maybe)
+ (org-hide-block-toggle): New functions.
+ (org-edit-src-exit): Do not quote lines starting with # and no +
+ behind it.
+ (org-auto-repeat-maybe): Add LAST_REPEAT properter for a repeating
+ entry.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-buffer-property-keys): Add Effort property for
+ completion.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-clock.el (org-clock-sum-current-item): Fix positioning bug
+ when retrieving total clocked time in the subtree.
+
+ * org.el (org-quoting-blocks): New variable.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-table.el (org-table-store-formulas)
+ (org-table-get-stored-formulas, org-table-fix-formulas)
+ (org-table-edit-formulas, orgtbl-ctrl-c-ctrl-c)
+ (orgtbl-gather-send-defs): Allow indented #+TBLFM line.
+
+ * org.el (org-fontify-meta-lines, org-ctrl-c-ctrl-c): Allow
+ indented #+TBLFM line.
+
+ * org-footnote.el (org-footnote-goto-local-insertion-point): Allow
+ indented #+TBLFM line.
+
+ * org-colview.el (org-dblock-write:columnview): Allow indented
+ #+TBLFM line.
+
+ * org-colview-xemacs.el (org-dblock-write:columnview): Allow
+ indented #+TBLFM line.
+
+ * org-clock.el (org-dblock-write:clocktable): Allow indented
+ #+TBLFM line.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-format-source-code-or-example): Make
+ editing indented blocks work correctly.
+
+ * org.el (org-edit-src-nindent): New variable.
+ (org-edit-src-code, org-edit-fixed-width-region)
+ (org-edit-src-find-region-and-lang, org-edit-src-exit): Make
+ editing indented blocks work correctly.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-replace-src-segments-and-examples): FInd
+ indented blocks.
+ (org-export-format-source-code-or-example): Fix indentation of
+ blocks.
+ (org-export-remove-indentation): New function.
+ (org-export-select-backend-specific-text): Allow backend-specific
+ code to be indented.
+ (org-export-mark-blockquote-verse-center): Allow markers to be
+ indented.
+
+ * org.el (org-fontify-meta-lines): New function.
+ (org-set-font-lock-defaults): Call the new fontification
+ function.
+
+ * org-faces.el (org-meta-line): New face
+ (org-block): New face.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-treat-insert-todo-heading-as-state-change)
+ (org-treat-S-cursor-todo-selection-as-state-change): New
+ variables.
+ (org-insert-todo-heading): Honor
+ `org-treat-insert-todo-heading-as-state-change'.
+ (org-shiftright, org-shiftleft): Honor
+ `org-treat-S-cursor-todo-selection-as-state-change'.
+ (org-inhibit-logging): New variable.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-remove-subtree-entries-from-agenda): Reduce
+ range for marker position checking.
+
+ * org-latex.el (org-export-latex-first-lines): Fix bug when
+ exporting a region.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-push-to-kill-ring): Protect using
+ x-set-selection, because that does not always work.
+
+ * org-agenda.el (org-agenda-list): Apply the new face
+ `org-agenda-date-today'.
+
+ * org-faces.el (org-agenda-date-today): New face.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-to-appt): Turn off restriction when
+ creating appointments.
+
+ * org-latex.el (org-export-latex-low-levels): Fix customization
+ type.
+
+ * org.el (org-priority, org-shiftup, org-shiftdown): Disable
+ priority commands.
+
+ * org-agenda.el (org-agenda-priority): Disable priority commands.
+
+ * org.el (org-enable-priority-commands): New option.
+
+ * org-colview-xemacs.el (org-columns-compute)
+ (org-columns-number-to-string): Fix problems with empty fields.
+
+ * org-colview.el (org-columns-compute)
+ (org-columns-number-to-string): Fix problems with empty fields.
+
+ * org-exp.el (org-export-push-to-kill-ring): New function.
+ (org-export-copy-to-kill-ring): New option.
+
+ * org-latex.el (org-export-as-latex): Call
+ `org-export-push-to-kill-ring'.
+
+ * org-exp.el (org-export-show-temporary-export-buffer): New
+ option.
+
+ * org-latex.el (org-export-as-latex): Use
+ `org-export-show-temporary-export-buffer'.
+
+ * org-exp.el (org-export-show-temporary-export-buffer): New
+ option.
+ (org-export-push-to-kill-ring): New function.
+
+ * org-colview.el (org-columns-compile-map): New variable.
+ (org-columns-new, org-columns-compute)
+ (org-columns-number-to-string, org-columns-uncompile-format)
+ (org-columns-compile-format): Implement new operators.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-plist-vars): Add :xml-declaration.
+
+ * org-list.el (org-update-checkbox-count): Make property
+ dependent.
+
+ * org.el (org-hierarchical-todo-statistics): New option.
+ (org-update-parent-todo-statistics): Modified to handle recursive
+ statistics.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-publish.el (org-publish): Make this function behave
+ correctly in interactive use when called with a prefix argument.
+
+ * org.el (org-todo-statistics-hook): New hook.
+ (org-update-parent-todo-statistics): Use new hook.
+ (org-log-into-drawer): New function.
+ (org-add-log-setup): Use the new `org-log-into-drawer' function to
+ determine if we should be logging into a drawer.
+ (org-log-into-drawer): Update docstring.
+ (org-default-properties): Add LOG_INTO_DRAWER as a property.
+
+ * org-list.el (org-checkbox-statistics-hook): New hook.
+ (org-update-checkbox-count-maybe): Use new hook.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-edit-src-code, org-edit-fixed-width-region): Use a
+ better bufer-generating mechanism.
+ (org-edit-src-find-buffer): New function.
+
+ * org-icalendar.el (org-print-icalendar-entries): Don't check for
+ archive tag, this is already done by `org-agenda-skip'.
+ data while constructing lost of tags.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-preprocess-apply-macros): Use semicolon
+ as argument separator in macros.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-after-sorting-entries-or-items-hook): New hook.
+ (org-sort-entries-or-items): Run the new hook.
+ (org-after-refile-insert-hook): New hook.
+ (org-refile): Run `org-after-refile-insert-hook'.
+
+ * org-agenda.el (org-agenda-get-progress): Never take time of day
+ from headline when displaying progress.
+
+ * org-latex.el (org-export-latex-complex-heading-re): New variable.
+ (org-export-as-latex): Force the correct regexp in the
+ preprocessor buffer.
+ (org-export-latex-set-initial-vars): Set
+ `org-export-latex-complex-heading-re'.
+
+ * org-agenda.el (org-agenda-start-with-log-mode): New option.
+ (org-agenda-mode): Use `org-agenda-start-with-log-mode'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-tables-centered): New option.
+ (org-export-latex-tables): Use `org-export-latex-tables-centered'.
+
+ * org-exp.el (org-export-as-org): New command.
+ (org-export-as-org): New command.
+
+ * org-publish.el (org-publish-org-to-org): New function.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-yank): Just call `org-yank-generic'.
+ (org-yank-generic): New function, containing the formaer
+ functionality of `org-yank'.
+
+ * org-latex.el (org-export-latex-not-done-keywords)
+ (org-export-latex-done-keywords): New variables.
+ (org-export-latex-todo-keyword-markup): New option.
+ (org-export-latex-set-initial-vars): Remember the TODO keywords.
+ (org-export-latex-keywords-maybe): Apply the TODO markup.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-infile-export-plist): Add more default macros.
+ (org-export-preprocess-apply-macros): Process macro arguments.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-icalendar.el (org-icalendar-include-todo): New allowedvalue
+ `unblocked'.
+ (org-print-icalendar-entries): Respect the new value of
+ `org-icalendar-include-todo'.
+
+ * org.el (org-link-try-special-completion)
+ (org-file-complete-link): New functions.
+ (org-insert-link): Add special completion support for some link
+ types.
+
+ * org-bbdb.el (org-bbdb-complete-link): New function.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-list.el (org-update-checkbox-count): Allow recursive
+ statistics.
+ (org-hierarchical-checkbox-statistics): New option.
+
+ * org.el (org-cycle): Remove erraneous space character.
+
+ * org-icalendar.el (org-icalendar-timezone): Initialize from
+ environment.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-autoload): Fix autoloading of ascii export
+ functions.
+ (org-modules): Add org-special-blocks.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-icalendar.el (org-start-icalendar-file): Use the new option.
+ (org-ical-timezone): New option.
+
+ * org-exp.el (org-export-get-coderef-format): Use the description
+ is present.
+
+ * org.el (org-sort-entries-or-items): Improve docstring, and make
+ better implementation for time sorting.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-edit-src-persistent-message): New option.
+ (org-edit-src-code, org-edit-fixed-width-region): Use the new
+ option.
+
+ * org-clock.el (org-clock-insert-selection-line): Fix prefious
+ patch.
+
+ * org.el (org-edit-src-code, org-edit-fixed-width-region): Use
+ separate buffer instead of indirect buffer to edit source code.
+ (org-edit-src-exit): Make this function work with the new setup.
+
+ * org-clock.el (org-clock-insert-selection-line): Make sure tasks
+ are properly fontified before shown in the selection menu.
+
+ * org.el (org-fontify-like-in-org-mode): New function.
+
+ * org-latex.el (org-export-latex-links): Use the property list to
+ retrieve the default image attributes.
+
+ * org-exp.el (org-export-plist-vars): Add a new option.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export, org-export-visible): Support ASCII
+ export to buffer
+ (org-export-normalize-links): Do not protect the description if it
+ is explicitly given.
+
+ * org-list.el (org-reset-checkbox-state-subtree): Moved here from
+ org-checklist.el.
+ (org-reset-checkbox-state-subtree): Call
+ `org-reset-checkbox-state-subtree'.
+
+ * org-remember.el (org-select-remember-template): For the
+ selection of a valid template.
+
+ * org-latex.el (org-export-region-as-latex): Supply the
+ force-no-subtree argument.
+ (org-export-as-latex): Provide better limits when exporting the
+ first line. When exporting to string, we still want the first
+ lines.
+ (org-export-latex-first-lines): New argument END, to force the end
+ of the region.
+ (org-export-region-as-latex): Use the property list.
+ (org-export-as-latex):
+
+ * org-colview-xemacs.el (org-columns-remove-overlays)
+ (org-columns): Fix call to `local-variable-p'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-after-blockquotes-hook): New hook.
+ (org-export-latex-preprocess): Run the new hook.
+
+ * org-exp.el (org-export-preprocess-after-blockquote-hook): New hook.
+ (org-export-preprocess-string): Run the new hook.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-macs.el (org-check-external-command): New defsubst.
+
+ * org.el (org-mode-map): New key for reload.
+ (org-format-latex): Better error message when external programs
+ are not available.
+
+ * org-agenda.el (org-agenda-mode-map): Bind `org-reload'.
+
+ * org.el (org-sort-entries-or-items): Explicit sorting function
+ for priorities, needed for XEmacs compatibility.
+
+ * org-remember.el (org-remember-apply-template): Improve auto-save
+ behavior.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-preprocess): Also protect
+ environments ending in a star.
+
+ * org-list.el (org-at-item-p): Fix regular expression.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-end-of-subtree): Improve speed.
+
+ * org-agenda.el (org-agenda-get-timestamps)
+ (org-agenda-get-progress, org-agenda-get-deadlines)
+ (org-agenda-get-scheduled, org-agenda-get-blocks): Optimizations,
+ in particular, wait as long as possible to collect the tags.
+ (org-stuck-projects): Improve docstring.
+
+ * org.el (org-store-link): No errors when getting custom id before
+ first headline.
+ (org-get-tags-at): Use `org-up-heading-safe' when getting tags.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-prepare-agenda-buffers): Catch a throw to nextfile.
+
+ * org-protocol.el: Remove dependency on url.el.
+ (org-protocol-unhex-compound, org-protocol-open-source): Remove
+ dependency on url.el.
+
+ * org-latex.el (org-export-as-pdf): Use
+ `org-latex-to-pdf-process'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-latex-to-pdf-process): New option.
+
+ * org-agenda.el (org-agenda-skip-additional-timestamps-same-entry):
+ New option.
+ (org-agenda-get-timestamps): Honor
+ `org-agenda-skip-additional-timestamps-same-entry'.
+
+ * org-clock.el (org-clock-goto-may-find-recent-task): New option.
+ (org-clock-goto): Find recent task only if
+ `org-clock-goto-may-find-recent-task' allows it.
+
+ * org-exp.el (org-export-remove-or-extract-drawers): Handle empty
+ drawers, and drawers that are missing the :END: line.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-clock.el (org-clock-goto): Go to recently clocked task if no
+ clock is running.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-update-parent-todo-statistics): Check for
+ STATISTICS_FROM property.
+
+ * org-list.el (org-update-checkbox-count): Check for
+ STATISTICS_FROM property.
+
+ * org.el (org-tab-first-hook)
+ (org-tab-after-check-for-table-hook)
+ (org-tab-after-check-for-cycling-hook): New hooks.
+ (org-cycle-internal-global, org-cycle-internal-local): New
+ functions, split out from `org-cycle'.
+ (org-cycle): Call the new hooks.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-preprocess-string): Reset the list of
+ preferred targets for each run of the preprocessor.
+
+ * org.el (org-refile-target-verify-function): Improve
+ documentation.
+ (org-get-refile-targets): Respect point being moved by the
+ verification function.
+
+ * org-latex.el (org-export-latex-timestamp-keyword-markup): New
+ option.
+ (org-export-latex-keywords): Use new option.
+
+ * org.el (org-rear-nonsticky-at): New defsubst.
+ (org-activate-plain-links, org-activate-angle-links)
+ (org-activate-footnote-links, org-activate-bracket-links)
+ (org-activate-dates, org-activate-target-links)
+ (org-activate-tags): Place the rear-nonsticky properties at the
+ correct location.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-protocol.el (server-edit): Declare `server-edit'.
+ (org-protocol-unhex-string, org-protocol-unhex-compound): New
+ functions.
+ (org-protocol-check-filename-for-protocol): Call `server-edit'.
+
+ * org.el (org-default-properties): New default properteis for
+ completion.
+
+ * org-exp.el (org-export-add-subtree-options): Add new properties
+ for subtree export.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-id.el (org-id-get-with-outline-path-completion): Turn off
+ org-refile-target-verify-function for the duration of the command.
+
+ * org.el (org-link-to-org-use-id): New possible value
+ `create-if-interactive-and-no-custom-id'.
+ (org-store-link): Use custom IDs.
+ (org-link-search): Find custom ID properties from #link.
+ (org-default-properties): Add CUSTOM_ID for property completion.
+ (org-refile-target-verify-function): New option.
+ (org-goto): Turn off org-refile-target-verify-function
+ for the duration of the command.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-preferred-target-alist): New variable.
+ (org-export-define-heading-targets): Find the new CUSTOM_ID
+ property.
+ (org-export-target-internal-links): Target the custom ids when
+ possible.
+
+ * org-latex.el (org-export-latex-preprocess): Better regexp for
+ matching latex macros with arguments.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-remember.el (org-remember-handler): Allow filing to non-org
+ files.
+
+2009-08-06 Magnus Henoch <magnus.henoch@gmail.com>
+
+ * org-table.el (org-table-fix-formulas): Do not change references
+ to remote tables.
+ (org-table-get-remote-range): Convert standard coordinates to RC
+ format.
+
+ * org-latex.el (org-export-latex-keywords): Fix regexp bug.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-compat.el (org-sha1-string): Function removed.
+
+ * org.el (org-refile-allow-creating-parent-nodes): New option.
+ (org-refile-get-location): New argument NEW-NODES.
+ (org-refile): Call `org-refile-get-location' with the new
+ argument.
+ (org-refile-get-location): Arrange for adding a new child.
+ (org-refile-new-child): New function.
+
+ * org-clock.el: Fix a number of docstrings.
+ (org-clock-find-position): New argument
+ FIND-UNCLOSED to make the function find an unclosed clock in the
+ entry.
+ (org-clock-in): Call `org-clock-find-position' with the new
+ argument if we might be resuming a clock.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-display-custom-times): New variable.
+ (org-export-latex-timestamp-markup): New option.
+ (org-export-latex-set-initial-vars): Remember the local value of
+ `org-display-custom-times'.
+ (org-export-latex-content): Process time stamps.
+ (org-export-latex-time-stamps): New function.
+
+ * org-macs.el (org-maybe-intangible): Add intangible property
+ again to invisible text.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-default-export-plist): Handle undefined
+ variables.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-sort-entries-or-items): Match TODO keywrds
+ case-sensitively, when sorting.
+ (org-priority): Do not match TODO keywords with wrong case.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-todo): Honor the NOBLOCKING property.
+
+ * org-agenda.el (org-agenda-dim-blocked-tasks): Honor the
+ NOBLOCKING property.
+
+ * org.el (org-scan-tags): Fix bug in tag scanner
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-modules): Mark obsolete packages.
+
+ * org-html.el: New file, split out from org-exp.el.
+
+ * org-icalendar.el: New file, split out from org-exp.el.
+
+ * org-xoxo.el: New file, split out from org-exp.el.
+
+ * org-ascii.el: New file, split out from org-exp.el.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-compat.el (org-find-library-name): New function.
+
+ * org.el (org-pre-cycle-hook): New hook.
+ (org-cycle): Call the new hook in appropriate places.
+ (org-reload): Only reload files that have been loaded before.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-set-font-lock-defaults): Enforxe space or line end
+ after todo keyword.
+ (org-todo): When changing TODO state, do matching
+ case-sensitively.
+ (org-map-continue-from): New variable.
+ (org-scan-tags): Respect values in `org-map-continue-from'.
+ (org-reload): Make XEmacs compatible.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-protocol.el (org-protocol-flatten-greedy): New function.
+ (org-protocol-flatten): New function.
+
+ * org.el (org-open-link-from-string): Pass reference buffer to
+ `org-open-at-point'.
+ (org-open-at-point): New optional argument `reference-buffer'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-scan-tags): Make tag scan find headline in first
+ line, 2nd attempt.
+ (org-get-refile-targets): Add the naked file name.
+ (org-refile): Store as top-level entry when only file name was
+ given.
+
+ * org-agenda.el (org-agenda-get-progress): Fix regexp bug.
+
+ * org.el (org-block-todo-from-children-or-siblings-or-parent):
+ Renamed from org-block-todo-from-children-or-siblings, and
+ enhanced to look for the parent's status as well.
+
+ * org-agenda.el (org-agenda-log-mode-add-notes): New option.
+ (org-agenda-get-progress): Add first notes line to log entry if so
+ desired.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-cleanup-fancy-diary-hook): New hook.
+ (org-agenda-cleanup-fancy-diary): Call the new hook.
+
+ * org-remember.el (org-remember-apply-template): Take the default
+ for the annotation from the :annotation property.
+
+ * org-mac-message.el (org-mac-message-get-link): Remove the
+ quotes.
+ (org-mac-message-get-link): Return the result.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-refile-get-location): Add file name only if not
+ already included in outline path.
+
+ * org-faces.el (org-n-level-faces): Fix customization type from
+ number to integer.
+
+ * org-exp.el (org-export-headline-levels): Fix customization type
+ from number to integer.
+
+ * org-agenda.el (org-agenda-confirm-kill)
+ (org-agenda-custom-commands-local-options)
+ (org-timeline-show-empty-dates, org-agenda-ndays)
+ (org-agenda-start-on-weekday, org-scheduled-past-days): Fix
+ customization type from number to integer.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-protocol.el: Declare some functions.
+
+ * org-agenda.el (org-agenda-compare-effort): Honor
+ `org-sort-agenda-noeffort-is-high'.
+ (org-agenda-filter-by-tag, org-agenda-filter-make-matcher)
+ (org-agenda-compare-effort): Implement the "?" operator for
+ finding entries without effort setting.
+
+ * org.el (org-extract-attributes-from-string): New function.
+
+ * org-exp.el (org-export-splice-attributes): New function.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-mouse.el: XEmacs compatibility fixes
+
+ * org.el (org-modules): Add org-inlinetasks.el
+ (org-cycle): Implement limiting level on cycling.
+ (org-move-subtree-down): Fix bug with swapping subtrees at end of
+ buffer.
+
+ * org-inlinetask.el: New file.
+
+ * org-protocol.el: New file.
+
+ * org.el (org-emphasis-regexp-components): Allow braces in
+ emphasis pre and post match.
+
+ * org-footnote.el (org-footnote-normalize): When only dorting, do
+ not insert inline notes at the end.
+
+ * org.el (org-require-autoloaded-modules): Add org-docbook.el.
+
+ * org-docbook.el: New file.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-reftex-citation): New command.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-cmp-user-defined): New option.
+ (org-sorting-choice, org-agenda-sorting-strategy): Add the new
+ sorting options.
+ (org-entries-lessp): Apply the new sorting option.
+
+ * org.el (org-block-todo-from-children-or-siblings): Fix bug in
+ blocker code, when an older sibling has children.
+
+ * org-mac-message.el (org-mac-message-get-link): Improve getting
+ links from multiple selected messages.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-remember.el (org-remember-finalize): Do not set buffer file
+ name to nil.
+ (org-remember-handler): Mark buffer as unmodified.
+ (org-remember-handler): Delete backup file and show message about
+ remaining backup files.
+ (org-remember-auto-remove-backup-files): New option.
+
+ * org.el (org-store-link): Use buffer name as link description in
+ w3-mode buffers.
+ (org-ido-switchb): Fix argument bug for completion.
+
+ * org-remember.el (org-remember-apply-template): Set local
+ variable `auto-save-visited-file-name' instead of global one.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-get-todos): Fix bug with match-data.
+ (org-agenda-get-todos): Mark file tags as inherited.
+ (org-agenda-list): Always search diary lines for a time.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-feed.el: New file.
+
+ * org-exp.el (org-export-as-html): Close local lists depending on
+ indentation, also when starting a table.
+
+ * org-remember.el (org-remember-backup-directory)
+ (org-remember-backup-name): New internal variable.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-clock.el (org-clock-out-if-current): Make buffer detection
+ work in indirect buffers as well.
+
+ * org.el (org-emphasis-regexp-components): Add the exxclamation
+ mark to the post-emphasis characters.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-read-date-minibiffer-septup-hook): New hook.
+ (org-read-date): Run the new hook.
+
+ * org-mac-message.el (org-mac-flagged-mail): New group.
+ (org-mac-mail-account): New variable.
+ (org-mac-create-flagged-mail, org-mac-insert-flagged-mail): New
+ commands.
+
+ * org-remember.el (org-remember-backup-directory): New variable.
+ (org-remember-apply-template): Write file to backup directory.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-mouse.el (org-mouse-todo-menu): New function.
+ (org-mouse-todo-keywords): Function removed.
+ (org-mouse-context-menu): Use `org-mouse-todo-menu'.
+
+ * org-table.el (org-table-beginning-of-field)
+ (org-table-end-of-field): New commands
+ (org-table-previous-field, org-table-beginning-of-field): Better
+ error messages.
+ (orgtbl-setup): Include `M-a' and `M-e'.
+
+ * org.el (org-backward-sentence, org-forward-sentence): New
+ commands.
+
+ * org-colview.el (org-colview-initial-truncate-line-value): New
+ variable.
+ (org-columns-remove-overlays): Restore the value of `truncate-lines'.
+ (org-columns): Remember the value of `truncate-lines'.
+
+ * org-colview-xemacs.el (org-colview-initial-truncate-line-value):
+ New variable.
+ (org-columns-remove-overlays): Restore the value of
+ `truncate-lines'.
+ (org-columns): Remember the value of `truncate-lines'.
+
+ * org.el (org-columns-skip-arrchived-trees): New option.
+
+ * org-agenda.el (org-agenda-export-html-style): Define color for
+ org-agenda-done face.
+ (org-search-view, org-agenda-get-todos, org-agenda-get-progress)
+ (org-agenda-get-deadlines, org-agenda-get-scheduled): Use new face.
+
+ * org.el (org-scan-tags): Use the new face.
+
+ * org-faces.el (org-agenda-done): New face.
+
+ * org.el (org-scan-tags): Test the value org
+ `org-tags-match-list-sublevels'.
+ (org-tags-match-list-sublevels): New allowed value: indented.
+
+ * org-latex.el (org-export-latex-make-header): Apply macros
+ in header.
+
+ * org-exp.el (org-export-apply-macros-in-string): New function.
+
+ * org-latex.el (org-export-latex-list-parameters): Fix bug
+ with the definition of a checked box.
+
+ * org-clock.el (org-clock-find-position): Fix drawer indentations.
+
+ * org-latex.el (org-export-latex-low-levels): More options
+ for how to process lower levels in LaTeX.
+ (org-export-latex-subcontent): Better treatment for lists as a
+ means of publishing lower levels.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-set-font-lock-defaults): Use new checkbox face.
+
+ * org-faces.el (org-checkbox): New face.
+
+ * org-exp.el (org-export-html-preprocess): Only create LaTeX
+ fragement images if there is an export file.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-stuck-projects): Document that the subtree of
+ projects that are not stuck will now be searched for stuck
+ sub-projects.
+ (org-agenda-skip-entry-when-regexp-matches)
+ (org-agenda-skip-entry-when-regexp-matches-in-subtree): New functions.
+ (org-agenda-list-stuck-projects): Use
+ `org-agenda-skip-entry-when-regexp-matches-in-subtree'.
+
+ * org-latex.el (org-export-latex-preprocess): Improve
+ export of verses.
+
+ * org-exp.el (org-export-as-html): Implement centering as a div
+ rather than a paragraph. Do a better job with line-end in verse
+ environments.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-open-at-point): Fix tags searches by mouse click.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-preprocess): Implement the
+ centering markup.
+
+ * org-exp.el (org-export-mark-blockquote-verse-center): Renamed
+ from `org-export-mark-blockquote-and-verse'.
+ (org-export-as-html): Implement the centering markup.
+
+ * org-latex.el (org-export-latex-tables): Fix vertical
+ lines in tables.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-read-date-history): New variable.
+ (org-read-date): Use new history variable.
+ (org-toggle-heading): Fix bug when used before first headline.
+ (org-store-log-note): Remove drawer if empty while note is
+ aborted.
+ (org-remove-empty-drawer-at): New function.
+ (org-check-after-date): New command.
+ (org-sparse-tree): New sparse tree command "a".
+
+ * org-exp.el (org-export-as-ascii): Improve export of plain lists.
+
+2009-08-06 Bastien Guerry <bzg@altern.org>
+
+ * org.el (org-toggle-fixed-width-section): Bug fix: insert a
+ column and a space, not only a column.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-latex-emphasis-alist): Better
+ defaults for verbose emphasis.
+ (org-export-latex-emph-format): New function.
+ (org-export-latex-fontify): Call `org-export-latex-emph-format'.
+
+ * org-agenda.el (org-agenda-menu): Add new commands to menu.
+ (org-agenda-do-date-later, org-agenda-do-date-earlier)
+ (org-agenda-date-later-minutes, org-agenda-date-earlier-minutes)
+ (org-agenda-date-later-hours, org-agenda-date-earlier-hours): New
+ commands.
+
+ * org.el (org-timestamp-change): Move end-time along with start
+ time.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-target-internal-links)
+ (org-export-as-html): Protect links specified as #name.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-clone-subtree-with-time-shift): New command.
+
+ * org-latex.el (org-export-latex-special-chars)
+ (org-export-latex-treat-sub-super-char): Fix subscript export.
+
+ * org-exp.el (org-create-multibrace-regexp): Do not add
+ backslashes to the class.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-colview.el (org-columns-map): Better functions for moving up
+ and down a row, even if `truncate-line' is nil.
+
+ * org.el (org-insert-todo-heading): Make sure the keyword is
+ inserted at the correct position.
+
+ * org-publish.el (org-publish-project-alist)
+ (org-publish-projects, org-publish-org-index): Change default anme
+ for the index of file names to "sitemap.org".
+
+ * org-latex.el (org-export-latex-tables): Use
+ `org-split-string', for Emacs 21 compatibility.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-log-mode-items): Improve docstring.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-page-description)
+ (org-export-page-keywords): New variables.
+ (org-export-plist-vars): Add entries for :keywords and
+ :description.
+ (org-infile-export-plist): Parse for new keywords.
+ (org-get-current-options): Add new keywords
+ (org-export-as-html): Publish description and keywords.
+
+ * org-agenda.el (org-agenda-add-entry-text-descriptive-links): New
+ option.
+ (org-agenda-add-entry-text): Honor
+ `org-agenda-add-entry-text-descriptive-links'.
+
+ * org-latex.el (org-export-latex-preprocess): Make all
+ external preprocess functions use a PARAMETER arg.
+
+ * org-exp.el (org-export-preprocess-string)
+ (org-export-select-backend-specific-text)
+ (org-export-format-source-code-or-example)
+ (org-format-org-table-html): Support docbook export.
+ (org-export-preprocess-string): Make all external preprocess
+ functions use a PARAMETER arg.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-html-style-include-scripts): New option.
+ (org-export-plist-vars): Add new option
+ `org-export-html-style-include-scripts'.
+ (org-export-as-html): Honor new option
+ `org-export-html-style-include-scripts'.
+ (org-export-html-scripts, org-export-html-style-default): Fix
+ xml issues with the Safari browser.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-publish.el (org-publish-attachment): Only copy file when the
+ directories differ.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-clock.el (org-clocktable-steps): Use inactive time stamps
+ for clocktable steps.
+
+ * org.el (org-additional-option-like-keywords): Add two more
+ keywords.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-format-source-code-or-example): Mark
+ temporary buffer unmodified, so that it will be killed even if
+ mode like message mode has decided to assign a file name.
+
+ * org.el (org-scan-tags): Improve tag inheritance.
+ (org-scan-tags, org-make-tags-matcher): Make tag comparison
+ case-sensitive.
+ (org-scan-tags): Use the internal tags list instead of creating it
+ from scratch.
+ (org-trust-scanner-tags, org-scanner-tags): New variables.
+ (org-scan-tags): Set `org-scanner-tags'.
+ (org-get-tags-at): Take advantage of `org-trust-scanner-tags'.
+ (org-map-entries): Document the possible speedup using scanner
+ tags.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-add-planning-info): Fix bug with looking for keyword
+ only at column 0.
+
+ * org-agenda.el (org-agenda-custom-commands-local-options): Add
+ option for tags filter preset.
+ (org-prepare-agenda): Store filter preset as a property on the
+ filter variable.
+ (org-finalize-agenda): Call the filter, if there is a preset.
+ (org-agenda-filter-by-tag): Filter again after clearing the
+ filter, when there still is a preset.
+ (org-agenda-filter-make-matcher, org-agenda-set-mode-name):
+ Include the preset filter.
+ (org-agenda-redo): Apply the filter again, also the preset filter.
+
+ * org-exp.el (org-export-as-html): Use IDs in the correct way.
+
+ * org.el (org-uuidgen-p): New funtion.
+
+ * org-agenda.el (org-agenda-fontify-priorities): New default value
+ `cookies'.
+ (org-agenda-fontify-priorities): Renamed from
+ org-fontify-priorities.
+
+ * org.el (org-set-font-lock-defaults): Call
+ `org-font-lock-add-priority-faces'.
+ (org-font-lock-add-priority-faces): New function.
+
+ * org-faces.el: (org-set-tag-faces): New option.
+ (org-priority-faces): New variable.
+
+ * org-exp.el (org-export-as-html): Add a "content" div around the
+ entire content of the body tag.
+ (org-export-html-get-bibliography): New function.
+ (org-export-html-validation-link): New variable.
+ (org-export-as-html): Add validation link to exported page.
+
+ * org.el (org-match-sparse-tree): Renamed from
+ `org-tags-sparse-tree'.
+ (org-tags-sparse-tree): New alias.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-get-valid-level): Catch the case where the level
+ change is nil.
+
+ * org-clock.el (org-clock-find-position): Better indentation of
+ new clock drawers.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda-quit): Delete window only when the
+ frame-setup was not `current-window'.
+
+ * org.el (org-tag-persistent-alist): New option.
+ (org-startup-options): Add keyword `noptag'.
+ (org-fast-todo-selection): Handle :newline correctly.
+ (org-set-tags): Handle :newline correctly.
+ (org-fast-tag-selection): Handle :newline correctly.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-as-ascii): Reverse link buffer before
+ outputting it.
+ (org-export-ascii-push-links): Fix bug with pussing links into the
+ export buffer.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-archive.el (org-archive-subtree): Do not add 1 to level if
+ pasting at top level.
+
+ * org-bbdb.el: Improve documentation.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-list.el (org-insert-item): Only consider insert empty lines
+ is `org-empty-line-terminates-plain-lists' is not nil.
+
+ * org.el (org-blank-before-new-entry): Mention the dependence on
+ `org-empty-line-terminates-plain-lists' in the docstring.
+
+ * org-publish.el (org-publish-get-project-from-filename): New
+ optional argument UP. Only find the top project if UP is set.
+ (org-publish-current-project): Find the top encloding project.
+
+ * org-agenda.el (org-agenda-before-write-hook)
+ (org-agenda-add-entry-text-maxlines): New options.
+ (org-write-agenda): Run the new hook in the temporary buffer.
+ (org-agenda-add-entry-text): New function.
+ (org-write-agenda): Implement PDF export, using ps2pdf.
+
+ * org.el (org-global-properties-fixed, org-global-properties):
+ Improve documentation string.
+
+ * org-exp.el (org-export-ascii-links-to-notes): New option.
+ (org-export-as-ascii): Handle links better.
+ (org-export-ascii-wrap, org-export-ascii-push-links): New
+ functions.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-agenda.el (org-agenda): Make prefix arg optional.
+ (org-agenda-search-headline-for-time): New option.
+ (org-format-agenda-item): Honor
+ `org-agenda-search-headline-for-time'.
+
+ * org-table.el (orgtbl-self-insert-command): Cluster undo for 20
+ characters.
+
+ * org.el (org-self-insert-cluster-for-undo): New option.
+ (org-self-insert-command): Cluster undo for 20 characters.
+ (org-self-insert-command-undo-counter): New variable.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-exp.el (org-export-as-html): Fix problem with closing colone
+ example.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org-latex.el (org-export-as-latex)
+ (org-export-latex-first-lines): Avoid modification flag when
+ adding or removing text properties.
+ (org-export-latex-fontify): Catch error when org-emph-alist has
+ entries that are not defined for LaTeX export.
+
+ * org-export-latex.el: renamed to org-latex.el
+
+ * org-latex.el: renamed from org-export-latex.el
+
+ * org.el (orgstruct++-mode): New function.
+ (turn-on-orgstruct++): Call `orgstruct++-mode'.
+ (org-context-p): Allow detecting item context after the first line
+ of an item.
+ (orgstruct-make-binding): Detect if item-body context should be
+ seen.
+ (orgstruct-is-++): New variable.
+ (org-add-planning-info): Catch the case when there is no planning
+ info yet and the call does not want to add anything, only maybe
+ tries to remove something.
+ (org-special-ctrl-a/e): All value to be a cons cell with separate
+ settings for `C-a. and `C-e'.
+ (org-beginning-of-line, org-end-of-line): Honor separate values
+ for `C-a' and `C-e'.
+
+2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
+
+ * org.el (org-reload): New command.
+
2009-06-05 Tassilo Horn <tassilo@member.fsf.org>
* org-gnus.el (org-gnus-store-link): Fix bug where
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
:type '(choice
(const :tag "Never" nil)
(const :tag "Always" t)
- (number :tag "When more than N lines")))
+ (integer :tag "When more than N lines")))
(defcustom org-agenda-compact-blocks nil
"Non-nil means, make the block agenda more compact.
(defcustom org-agenda-exporter-settings nil
"Alist of variable/value pairs that should be active during agenda export.
-This is a good place to set options for ps-print and for htmlize."
+This is a good place to set options for ps-print and for htmlize.
+Note that the way this is implemented, the values will be evaluated
+before assigned to the variables. So make sure to quote values you do
+*not* want evaluated, for example
+
+ (setq org-agenda-exporter-settings
+ '((ps-print-color-p 'black-white)))"
:group 'org-agenda-export
:type '(repeat
(list
(variable)
(sexp :tag "Value"))))
+(defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
+ "Hook run in temporary buffer before writing it to an export file.
+A useful function is `org-agenda-add-entry-text'."
+ :group 'org-agenda-export
+ :type 'hook
+ :options '(org-agenda-add-entry-text))
+
+(defcustom org-agenda-add-entry-text-maxlines 0
+ "Maximum number of entry text lines to be added to agenda.
+This is only relevant when `org-agenda-add-entry-text' is part of
+`org-agenda-before-write-hook', which it is by default.
+When this is 0, nothing will happen. When it is greater than 0, it
+specifies the maximum number of lines that will be added for each entry
+that is listed in the agenda view."
+ :group 'org-agenda
+ :type 'integer)
+
+(defcustom org-agenda-add-entry-text-descriptive-links t
+ "Non-nil means, export org-links as descriptive links in agenda added text.
+This variable applies to the text added to the agenda when
+`org-agenda-add-entry-text-maxlines' is larger than 0.
+When this variable nil, the URL will (also) be shown."
+ :group 'org-agenda
+ :type 'boolean)
+
(defcustom org-agenda-export-html-style ""
"The style specification for exported HTML Agenda files.
If this variable contains a string, it will replace the default <style>
color: #cc6666;
font-weight: bold;
}
+ .org-agenda-done {
+ color: #339933;
+ }
.org-done {
color: #339933;
}
(const tag-down) (const tag-up)
(const priority-up) (const priority-down)
(const todo-state-up) (const todo-state-down)
- (const effort-up) (const effort-down))
+ (const effort-up) (const effort-down)
+ (const user-defined-up) (const user-defined-down))
"Sorting choices.")
(defconst org-agenda-custom-commands-local-options
`(repeat :tag "Local settings for this command. Remember to quote values"
(choice :tag "Setting"
- (list :tag "Any variable"
- (variable :tag "Variable")
- (sexp :tag "Value"))
+ (list :tag "Heading for this block"
+ (const org-agenda-overriding-header)
+ (string :tag "Headline"))
(list :tag "Files to be searched"
(const org-agenda-files)
(list
(const :format "" quote)
- (repeat
- (file))))
+ (repeat (file))))
(list :tag "Sorting strategy"
(const org-agenda-sorting-strategy)
(list
(const org-agenda-start-on-weekday)
(choice :value 1
(const :tag "Today" nil)
- (number :tag "Weekday No.")))
+ (integer :tag "Weekday No.")))
(list :tag "Include data from diary"
(const org-agenda-include-diary)
(boolean))
(list :tag "Deadline Warning days"
(const org-deadline-warning-days)
(integer :value 1))
+ (list :tag "Tags filter preset"
+ (const org-agenda-filter-preset)
+ (list
+ (const :format "" quote)
+ (repeat
+ (string :tag "+tag or -tag"))))
(list :tag "Standard skipping condition"
:value (org-agenda-skip-function '(org-agenda-skip-entry-if))
(const org-agenda-skip-function)
(const :tag "scheduled" 'scheduled)
(const :tag "not scheduled" 'notscheduled)
(const :tag "deadline" 'deadline)
- (const :tag "no deadline" 'notdeadline))))))
+ (const :tag "no deadline" 'notdeadline)
+ (const :tag "timestamp" 'timestamp)
+ (const :tag "no timestamp" 'nottimestamp))))))
(list :tag "Non-standard skipping condition"
:value (org-agenda-skip-function)
(const org-agenda-skip-function)
- (sexp :tag "Function or form (quoted!)"))))
+ (sexp :tag "Function or form (quoted!)"))
+ (list :tag "Any variable"
+ (variable :tag "Variable")
+ (sexp :tag "Value (sexp)"))))
"Selection of examples for agenda command settings.
This will be spliced into the custom type of
`org-agenda-custom-commands'.")
(const :tag "TODO list" alltodo)
(const :tag "Search words" search)
(const :tag "Stuck projects" stuck)
- (const :tag "Tags search (all agenda files)" tags)
- (const :tag "Tags search of TODO entries (all agenda files)" tags-todo)
+ (const :tag "Tags/Property match (all agenda files)" tags)
+ (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
(const :tag "TODO keyword search (all agenda files)" todo)
(const :tag "Tags sparse tree (current buffer)" tags-tree)
(const :tag "TODO keyword tree (current buffer)" todo-tree)
'("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
"How to identify stuck projects.
This is a list of four items:
-1. A tags/todo matcher string that is used to identify a project.
+1. A tags/todo/property matcher string that is used to identify a project.
+ See the manual for a description of tag and property searches.
The entire tree below a headline matched by this is considered one project.
2. A list of TODO keywords identifying non-stuck projects.
If the project subtree contains any headline with one of these todo
3. A list of tags identifying non-stuck projects.
If the project subtree contains any headline with one of these tags,
the project is considered to be not stuck. If you specify \"*\" as
- a tag, any tag will mark the project unstuck.
+ a tag, any tag will mark the project unstuck. Note that this is about
+ the explicit presence of a tag somewhere in the subtree, inherited
+ tags to not count here. If inherited tags make a project not stuck,
+ use \"-TAG\" in the tags part of the matcher under (1.) above.
4. An arbitrary regular expression matching non-stuck projects.
+If the project turns out to be not stuck, search continues also in the
+subtree to see if any of the subtasks have project status.
+
+See also the variable `org-tags-match-list-sublevels' which applies
+to projects matched by this search as well.
+
After defining this variable, you may use \\[org-agenda-list-stuck-projects]
or `C-c a #' to produce the list."
:group 'org-agenda-custom-commands
(string :tag "Tags/TODO match to identify a project")
(repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
(repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
- (regexp :tag "Projects are *not* stuck if this regexp matches\ninside the subtree")))
+ (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
(defcustom org-agenda-filter-effort-default-operator "<"
"The default operator for effort estimate filtering.
but don't want them to show up in the TODO list.
When this is set, it also covers deadlines and scheduled items, the settings
of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
-will be ignored."
+will be ignored.
+See also the variable `org-agenda-tags-todo-honor-ignore-options'."
:group 'org-agenda-skip
:group 'org-agenda-todo-list
:type 'boolean)
"Non-nil means, don't show scheduled entries in the global todo list.
The idea behind this is that by scheduling it, you have already taken care
of this item.
-See also `org-agenda-todo-ignore-with-date'."
+See also `org-agenda-todo-ignore-with-date'.
+See also the variable `org-agenda-tags-todo-honor-ignore-options'."
:group 'org-agenda-skip
:group 'org-agenda-todo-list
:type 'boolean)
"Non-nil means, don't show near deadline entries in the global todo list.
Near means closer than `org-deadline-warning-days' days.
The idea behind this is that such items will appear in the agenda anyway.
-See also `org-agenda-todo-ignore-with-date'."
+See also `org-agenda-todo-ignore-with-date'.
+See also the variable `org-agenda-tags-todo-honor-ignore-options'."
:group 'org-agenda-skip
:group 'org-agenda-todo-list
:type 'boolean)
"Non-nil means, honor todo-list ...ignore options also in tags-todo search.
The variables
`org-agenda-todo-ignore-with-date',
- `org-agenda-todo-ignore-scheduled'
+ `org-agenda-todo-ignore-scheduled'
`org-agenda-todo-ignore-deadlines'
make the global TODO list skip entries that have time stamps of certain
kinds. If this option is set, the same options will also apply for the
:group 'org-agenda-daily/weekly
:type 'boolean)
+(defcustom org-agenda-skip-additional-timestamps-same-entry t
+ "When nil, multiple same-day timestamps in entry make multiple agenda lines.
+When non-nil, after the search for timestamps has matched once in an
+entry, the rest of the entry will not be searched."
+ :group 'org-agenda-skip
+ :type 'boolean)
+
(defcustom org-agenda-skip-timestamp-if-done nil
"Non-nil means don't select item by timestamp or -range if it is DONE."
:group 'org-agenda-skip
(defcustom org-agenda-dim-blocked-tasks t
"Non-nil means, dim blocked tasks in the agenda display.
-This causes some overhead during agenda construction, but if you have turned
-on `org-enforce-todo-dependencies' or any other blocking mechanism, this
-will create useful feedback in the agenda.
-Instead ot t, this variable can also have the value `invisible'. Then
-blocked tasks will be invisible and only become visible when they
-become unblocked."
+This causes some overhead during agenda construction, but if you
+have turned on `org-enforce-todo-dependencies',
+`org-enforce-todo-checkbox-dependencies', or any other blocking
+mechanism, this will create useful feedback in the agenda.
+
+Instead ot t, this variable can also have the value `invisible'.
+Then blocked tasks will be invisible and only become visible when
+they become unblocked. An exemption to this behavior is when a task is
+blocked because of unchecked checkboxes below it. Since checkboxes do
+not show up in the agenda views, making this task invisible you remove any
+trace from agenda views that there is something to do. Therefore, a task
+that is blocked because of checkboxes will never be made invisible, it
+will only be dimmed."
:group 'org-agenda-daily/weekly
:group 'org-agenda-todo-list
:type '(choice
:type '(choice
(const :tag "None" nil)
(const :tag "All" t)
- (number :tag "at most")))
+ (integer :tag "at most")))
(defgroup org-agenda-startup nil
"Options concerning initial settings in the Agenda in Org Mode."
(defcustom org-agenda-ndays 7
"Number of days to include in overview display.
-Should be 1 or 7."
+Should be 1 or 7.
+Custom commands can set this variable in the options section."
:group 'org-agenda-daily/weekly
- :type 'number)
+ :type 'integer)
(defcustom org-agenda-start-on-weekday 1
"Non-nil means, start the overview always on the specified weekday.
0 denotes Sunday, 1 denotes Monday etc.
-When nil, always start on the current day."
+When nil, always start on the current day.
+Custom commands can set this variable in the options section."
:group 'org-agenda-daily/weekly
:type '(choice (const :tag "Today" nil)
- (number :tag "Weekday No.")))
+ (integer :tag "Weekday No.")))
(defcustom org-agenda-show-all-dates t
"Non-nil means, `org-agenda' shows every day in the selected range.
(const :tag "Sunday" 0)))
(defcustom org-agenda-include-diary nil
- "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
+ "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
+Custom commands can set this variable in the options section."
:group 'org-agenda-daily/weekly
:type 'boolean)
day and will be listed until it is marked done for the number of days
given here."
:group 'org-agenda-daily/weekly
- :type 'number)
+ :type 'integer)
(defcustom org-agenda-log-mode-items '(closed clock)
"List of items that should be shown in agenda log mode.
closed Show entries that have been closed on that day.
clock Show entries that have received clocked time on that day.
- state Show all logged state changes."
+ state Show all logged state changes.
+Note that instead of changing this variable, you can also press `C-u l' in
+the agenda to display all available LOG items temporarily."
:group 'org-agenda-daily/weekly
:type '(set :greedy t (const closed) (const clock) (const state)))
+(defcustom org-agenda-log-mode-add-notes t
+ "Non-nil means, add first line of notes to log entries in agenda views.
+If a log item like a state change or a clock entry is associated with
+notes, the first line of these notes will be added to the entry in the
+agenda display."
+ :group 'org-agenda-daily/weekly
+ :type 'boolean)
+
+(defcustom org-agenda-start-with-log-mode nil
+ "The initial value of log-mode in a newly created agenda window."
+ :group 'org-agenda-startup
+ :group 'org-agenda-daily/weekly
+ :type 'boolean)
+
(defcustom org-agenda-start-with-clockreport-mode nil
"The initial value of clockreport-mode in a newly created agenda window."
:group 'org-agenda-startup
:tag "Org Agenda Time Grid"
:group 'org-agenda)
+(defcustom org-agenda-search-headline-for-time t
+ "Non-nil means, search headline for a time-of-day.
+If the headline contains a time-of-day in one format or another, it will
+be used to sort the entry into the time sequence of items for a day.
+Some people have time stamps in the headline that refer to the creation
+time or so, and then this produces an unwanted side effect. If this is
+the case for your, use this variable to turn off searching the headline
+for a time."
+ :group 'org-agenda-time-grid
+ :type 'boolean)
+
(defcustom org-agenda-use-time-grid t
"Non-nil means, show a time grid in the agenda schedule.
A time grid is a set of lines for specific times (like every two hours between
if an entry should be listed before another entry. The following
symbols are recognized:
-time-up Put entries with time-of-day indications first, early first
-time-down Put entries with time-of-day indications first, late first
-category-keep Keep the default order of categories, corresponding to the
- sequence in `org-agenda-files'.
-category-up Sort alphabetically by category, A-Z.
-category-down Sort alphabetically by category, Z-A.
-tag-up Sort alphabetically by last tag, A-Z.
-tag-down Sort alphabetically by last tag, Z-A.
-priority-up Sort numerically by priority, high priority last.
-priority-down Sort numerically by priority, high priority first.
-todo-state-up Sort by todo state, tasks that are done last.
-todo-state-down Sort by todo state, tasks that are done first.
-effort-up Sort numerically by estimated effort, high effort last.
-effort-down Sort numerically by estimated effort, high effort first.
+time-up Put entries with time-of-day indications first, early first
+time-down Put entries with time-of-day indications first, late first
+category-keep Keep the default order of categories, corresponding to the
+ sequence in `org-agenda-files'.
+category-up Sort alphabetically by category, A-Z.
+category-down Sort alphabetically by category, Z-A.
+tag-up Sort alphabetically by last tag, A-Z.
+tag-down Sort alphabetically by last tag, Z-A.
+priority-up Sort numerically by priority, high priority last.
+priority-down Sort numerically by priority, high priority first.
+todo-state-up Sort by todo state, tasks that are done last.
+todo-state-down Sort by todo state, tasks that are done first.
+effort-up Sort numerically by estimated effort, high effort last.
+effort-down Sort numerically by estimated effort, high effort first.
+user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
+user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
The different possibilities will be tried in sequence, and testing stops
if one comparison returns a \"not-equal\". For example, the default
Instead of a single list, this can also be a set of list for specific
contents, with a context symbol in the car of the list, any of
-`agenda', `todo', `tags' for the corresponding agenda views."
+`agenda', `todo', `tags' for the corresponding agenda views.
+
+Custom commands can bind this variable in the options section."
:group 'org-agenda-sorting
:type `(choice
(repeat :tag "General" ,org-sorting-choice)
(cons (const :tag "Strategy for Tags matches" tags)
(repeat ,org-sorting-choice)))))
+(defcustom org-agenda-cmp-user-defined nil
+ "A function to define the comparison `user-defined'.
+This function must receive two arguments, agenda entry a and b.
+If a>b, return +1. If a<b, return -1. If they are equal as seen by
+the user comparison, return nil.
+When this is defined, you can make `user-defined-up' and `user-defined-down'
+part of an agenda sorting strategy."
+ :group 'org-agenda-sorting
+ :type 'symbol)
+
(defcustom org-sort-agenda-notime-is-late t
"Non-nil means, items without time are considered late.
This is only relevant for sorting. When t, items which have no explicit
(defcustom org-sort-agenda-noeffort-is-high t
"Non-nil means, items without effort estimate are sorted as high effort.
+This also applies when filtering an agenda view with respect to the
+< or > effort operator. Then, tasks with no effort defined will be treated
+as tasks with high effort.
When nil, such items are sorted as 0 minutes effort."
:group 'org-agenda-sorting
:type 'boolean)
(setq org-agenda-prefix-format \" %-11:c% s\")
See also the variables `org-agenda-remove-times-when-in-prefix' and
-`org-agenda-remove-tags'."
+`org-agenda-remove-tags'.
+
+Custom commands can set this variable in the options section."
:type '(choice
(string :tag "General format")
(list :greedy t :tag "View dependent"
(if (fboundp 'defvaralias)
(defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
-(defcustom org-agenda-fontify-priorities t
+(defcustom org-agenda-fontify-priorities 'cookies
"Non-nil means, highlight low and high priorities in agenda.
When t, the highest priority entries are bold, lowest priority italic.
+However, settings in org-priority-faces will overrule these faces.
+When this variable is the symbol `cookies', only fontify the
+cookies, not the entire task.
This may also be an association list of priority faces, whose
keys are the character values of `org-highest-priority',
`org-default-priority', and `org-lowest-priority' (the default values
-are ?A, ?B, and ?C, respectively). The face may be a names face,
+are ?A, ?B, and ?C, respectively). The face may be a named face,
or a list like `(:background \"Red\")'."
:group 'org-agenda-line-format
:type '(choice
(const :tag "Never" nil)
(const :tag "Defaults" t)
+ (const :tag "Cookies only" cookies)
(repeat :tag "Specify"
(list (character :tag "Priority" :value ?A)
(sexp :tag "face")))))
"Keymap for `org-agenda-mode'.")
(defvar org-agenda-menu) ; defined later in this file.
+(defvar org-agenda-restrict) ; defined later in this file.
(defvar org-agenda-follow-mode nil)
(defvar org-agenda-clockreport-mode nil)
(defvar org-agenda-show-log nil)
"Hook for org-agenda-mode, run after the mode is turned on.")
(defvar org-agenda-type nil)
(defvar org-agenda-force-single-file nil)
+(defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
(defun org-agenda-mode ()
"Mode for time-sorted view on action items in Org-mode files.
(interactive)
(kill-all-local-variables)
(setq org-agenda-undo-list nil
- org-agenda-pending-undo-list nil)
+ org-agenda-pending-undo-list nil
+ org-agenda-bulk-marked-entries nil)
(setq major-mode 'org-agenda-mode)
;; Keep global-font-lock-mode from turning on font-lock-mode
(org-set-local 'font-lock-global-modes (list 'not major-mode))
(unless org-agenda-keep-modes
(setq org-agenda-follow-mode org-agenda-start-with-follow-mode
org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
- org-agenda-show-log nil))
+ org-agenda-show-log org-agenda-start-with-log-mode))
+
(easy-menu-change
'("Agenda") "Agenda Files"
(append
(org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
(org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
(org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
+(org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
+(org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
+(org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
+(org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-remove-all-marks)
+(org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
+(org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
(org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
(org-defkey org-agenda-mode-map "A" 'org-agenda-archive-to-archive-sibling)
(org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
(org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
(org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
(org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
-(org-defkey org-agenda-mode-map "m" 'org-agenda-month-view)
(org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
(org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
(org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
(org-defkey org-agenda-mode-map "k" 'org-agenda-action)
(org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
-(org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-date-later)
-(org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-date-earlier)
-(org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-date-later)
-(org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-date-earlier)
+(org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
+(org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
+(org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
+(org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
(org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
(org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
(org-defkey org-agenda-mode-map "f" 'org-agenda-follow-mode)
(org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
(org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
-(org-defkey org-agenda-mode-map "v" 'org-agenda-archives-mode)
+(org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
(org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
(org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
(org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
(org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
(org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
(org-defkey org-agenda-mode-map "\C-x\C-w" 'org-write-agenda)
-(org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
(org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
+(org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
(org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
(org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
(org-defkey org-agenda-mode-map "n" 'next-line)
(org-defkey org-agenda-mode-map [(right)] 'org-agenda-later)
(org-defkey org-agenda-mode-map [(left)] 'org-agenda-earlier)
(org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
+(org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
(org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
(org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
(org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
(org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
(org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
+(org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
(defvar org-agenda-keymap (copy-keymap org-agenda-mode-map)
"Local keymap for agenda entries from Org-mode.")
["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
"--"
["Cycle TODO" org-agenda-todo t]
- ("Archive"
+ ("Archive and Refile"
["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
- ["Archive subtree" org-agenda-archive t])
+ ["Archive subtree" org-agenda-archive t]
+ ["Refile" org-agenda-refile t])
["Delete subtree" org-agenda-kill t]
+ ("Bulk action"
+ ["Toggle mark entry" org-agenda-bulk-mark t]
+ ["Act on all marked" org-agenda-bulk-action t]
+ ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
+ "--"
["Add note" org-agenda-add-note t]
"--"
["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
"--"
["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
+ ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
+ ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
+ ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
("Clock"
["Clock in" org-agenda-clock-in t]
["Create iCalendar file" org-export-icalendar-combine-agenda-files t])
"--"
("View"
- ["Day View" org-agenda-day-view :active (org-agenda-check-type nil 'agenda)
- :style radio :selected (equal org-agenda-ndays 1)]
- ["Week View" org-agenda-week-view :active (org-agenda-check-type nil 'agenda)
- :style radio :selected (equal org-agenda-ndays 7)]
- ["Month View" org-agenda-month-view :active (org-agenda-check-type nil 'agenda)
- :style radio :selected (member org-agenda-ndays '(28 29 30 31))]
- ["Year View" org-agenda-year-view :active (org-agenda-check-type nil 'agenda)
- :style radio :selected (member org-agenda-ndays '(365 366))]
+ ["Day View" org-agenda-day-view
+ :active (org-agenda-check-type nil 'agenda)
+ :style radio :selected (equal org-agenda-ndays 1)
+ :keys "v d (or just d)"]
+ ["Week View" org-agenda-week-view
+ :active (org-agenda-check-type nil 'agenda)
+ :style radio :selected (equal org-agenda-ndays 7)
+ :keys "v w (or just w)"]
+ ["Month View" org-agenda-month-view
+ :active (org-agenda-check-type nil 'agenda)
+ :style radio :selected (member org-agenda-ndays '(28 29 30 31))
+ :keys "v m"]
+ ["Year View" org-agenda-year-view
+ :active (org-agenda-check-type nil 'agenda)
+ :style radio :selected (member org-agenda-ndays '(365 366))
+ :keys "v y"]
"--"
["Include Diary" org-agenda-toggle-diary
:style toggle :selected org-agenda-include-diary
"--"
["Show Logbook entries" org-agenda-log-mode
:style toggle :selected org-agenda-show-log
- :active (org-agenda-check-type nil 'agenda 'timeline)]
+ :active (org-agenda-check-type nil 'agenda 'timeline)
+ :keys "v l (or just l)"]
["Include archived trees" org-agenda-archives-mode
- :style toggle :selected org-agenda-archives-mode :active t]
+ :style toggle :selected org-agenda-archives-mode :active t
+ :keys "v a"]
["Include archive files" (org-agenda-archives-mode t)
:style toggle :selected (eq org-agenda-archives-mode t) :active t
- :keys "C-u v"])
+ :keys "v A"]
+ "--"
+ ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
["Write view to file" org-write-agenda t]
["Rebuild buffer" org-agenda-redo t]
["Save all Org-mode Buffers" org-save-all-org-buffers t]
(defvar org-agenda-overriding-restriction nil)
;;;###autoload
-(defun org-agenda (arg &optional keys restriction)
+(defun org-agenda (&optional arg keys restriction)
"Dispatch agenda commands to collect entries to the agenda buffer.
Prompts for a command to execute. Any prefix arg will be passed
on to the selected command. The default selections are:
M Like `m', but select only TODO entries, no ordinary headlines.
L Create a timeline for the current buffer.
e Export views to associated files.
+s Search entries for keywords.
+/ Multi occur accros all agenda files and also files listed
+ in `org-agenda-text-search-extra-files'.
+< Restrict agenda commands to buffer, subtree, or region.
+ Press several times to get the desired effect.
+> Remove a previous restriction.
+# List \"stuck\" projects.
+! Configure what \"stuck\" means.
+C Configure custom agenda commands.
More commands can be added by configuring the variable
`org-agenda-custom-commands'. In particular, specific tags and TODO keyword
(org-let lprops '(org-todo-list match)))
((eq type 'tags-tree)
(org-check-for-org-mode)
- (org-let lprops '(org-tags-sparse-tree current-prefix-arg match)))
+ (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
((eq type 'todo-tree)
(org-check-for-org-mode)
(org-let lprops
(t (error "Invalid key %c" c))))))))
(defun org-run-agenda-series (name series)
- (org-prepare-agenda name)
+ (org-let (nth 1 series) '(org-prepare-agenda name))
(let* ((org-agenda-multi t)
(redo (list 'org-run-agenda-series name (list 'quote series)))
(cmds (car series))
(widen)
(setq org-agenda-redo-command redo)
(goto-char (point-min)))
+ (org-fit-agenda-window)
(org-let (nth 1 series) '(org-finalize-agenda)))
;;;###autoload
(while files
(eval (list 'let (append org-agenda-exporter-settings opts pars)
(list 'org-write-agenda
- (expand-file-name (pop files) dir) t))))
+ (expand-file-name (pop files) dir) nil t))))
(and (get-buffer org-agenda-buffer-name)
(kill-buffer org-agenda-buffer-name)))))))
-(defun org-write-agenda (file &optional nosettings)
+(defun org-write-agenda (file &optional open nosettings)
"Write the current buffer (an agenda view) as a file.
Depending on the extension of the file name, plain text (.txt),
HTML (.html or .htm) or Postscript (.ps) is produced.
If the extension is .ics, run icalendar export over all files used
to construct the agenda and limit the export to entries listed in the
agenda now.
+With prefic argument OPEN, open the new file immediately.
If NOSETTINGS is given, do not scope the settings of
`org-agenda-exporter-settings' into the export commands. This is used when
the settings have already been scoped and we do not wish to overrule other,
higher priority settings."
- (interactive "FWrite agenda to file: ")
+ (interactive "FWrite agenda to file: \nP")
(if (not (file-writable-p file))
(error "Cannot write agenda to file %s" file))
(cond
(delete-region
beg (or (next-single-property-change beg 'org-filtered)
(point-max))))
+ (run-hooks 'org-agenda-before-write-hook)
(cond
((string-match "\\.html?\\'" file)
(set-buffer (htmlize-buffer (current-buffer)))
(kill-buffer (current-buffer))
(message "HTML written to %s" file))
((string-match "\\.ps\\'" file)
- (ps-print-buffer-with-faces file)
+ (require 'ps-print)
+ (flet ((ps-get-buffer-name () "Agenda View"))
+ (ps-print-buffer-with-faces file))
(message "Postscript written to %s" file))
+ ((string-match "\\.pdf\\'" file)
+ (require 'ps-print)
+ (flet ((ps-get-buffer-name () "Agenda View"))
+ (ps-print-buffer-with-faces
+ (concat (file-name-sans-extension file) ".ps")))
+ (call-process "ps2pdf" nil nil nil
+ (expand-file-name
+ (concat (file-name-sans-extension file) ".ps"))
+ (expand-file-name file))
+ (message "PDF written to %s" file))
((string-match "\\.ics\\'" file)
+ (require 'org-icalendar)
(let ((org-agenda-marker-table
(org-create-marker-find-array
(org-agenda-collect-markers)))
(save-buffer 0)
(kill-buffer (current-buffer))
(message "Plain text written to %s" file))))))))
- (set-buffer org-agenda-buffer-name)))
+ (set-buffer org-agenda-buffer-name))
+ (when open (org-open-file file)))
+
(defvar org-agenda-filter-overlays nil)
(defun org-agenda-mark-filtered-text ()
beg (or (next-single-property-change beg 'org-filtered)
(point-max))))))
+(defun org-agenda-add-entry-text ()
+ "Add entry text to agenda lines.
+This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
+entry text following headings shown in the agenda.
+Drawers will be excluded, also the line with scheduling/deadline info."
+ (when (> org-agenda-add-entry-text-maxlines 0)
+ (let (m txt drawer-re kwd-time-re ind)
+ (goto-char (point-min))
+ (while (not (eobp))
+ (if (not (setq m (get-text-property (point) 'org-hd-marker)))
+ (beginning-of-line 2)
+ (save-excursion
+ (with-current-buffer (marker-buffer m)
+ (if (not (org-mode-p))
+ (setq txt "")
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char m)
+ (beginning-of-line 2)
+ (setq txt (buffer-substring
+ (point)
+ (progn (outline-next-heading) (point)))
+ drawer-re org-drawer-regexp
+ kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
+ ".*\n?"))
+ (with-temp-buffer
+ (insert txt)
+ (when org-agenda-add-entry-text-descriptive-links
+ (goto-char (point-min))
+ (while (org-activate-bracket-links (point-max))
+ (add-text-properties (match-beginning 0) (match-end 0)
+ '(face org-link))))
+ (goto-char (point-min))
+ (while (re-search-forward org-bracket-link-regexp (point-max) t)
+ (set-text-properties (match-beginning 0) (match-end 0)
+ nil))
+ (goto-char (point-min))
+ (while (re-search-forward drawer-re nil t)
+ (delete-region
+ (match-beginning 0)
+ (progn (re-search-forward
+ "^[ \t]*:END:.*\n?" nil 'move)
+ (point))))
+ (goto-char (point-min))
+ (while (re-search-forward kwd-time-re nil t)
+ (replace-match ""))
+ (if (re-search-forward "[ \t\n]+\\'" nil t)
+ (replace-match ""))
+ (goto-char (point-min))
+ ;; find min indentation
+ (goto-char (point-min))
+ (untabify (point-min) (point-max))
+ (setq ind (org-get-indentation))
+ (while (not (eobp))
+ (unless (looking-at "[ \t]*$")
+ (setq ind (min ind (org-get-indentation))))
+ (beginning-of-line 2))
+ (goto-char (point-min))
+ (while (not (eobp))
+ (unless (looking-at "[ \t]*$")
+ (move-to-column ind)
+ (delete-region (point-at-bol) (point)))
+ (beginning-of-line 2))
+ (goto-char (point-min))
+ (while (and (not (eobp)) (re-search-forward "^" nil t))
+ (replace-match " > "))
+ (goto-char (point-min))
+ (while (looking-at "[ \t]*\n") (replace-match ""))
+ (goto-char (point-max))
+ (when (> (org-current-line)
+ (1+ org-agenda-add-entry-text-maxlines))
+ (goto-line (1+ org-agenda-add-entry-text-maxlines))
+ (backward-char 1))
+ (setq txt (buffer-substring (point-min) (point)))))))))
+ (end-of-line 1)
+ (if (string-match "\\S-" txt) (insert "\n" txt)))))))
+
(defun org-agenda-collect-markers ()
"Collect the markers pointing to entries in the agenda buffer."
(let (m markers)
(defvar org-agenda-columns-active nil)
(defvar org-agenda-name nil)
(defvar org-agenda-filter nil)
+(defvar org-agenda-filter-preset nil
+ "A preset of the tags filter used for secondary agenda filtering.
+This must be a list of strings, each string must be a single tag preceeded
+by \"+\" or \"-\".
+This variable should not be set directly, but agenda custom commands can
+bind it in the options section.")
+
(defun org-prepare-agenda (&optional name)
(setq org-todo-keywords-for-agenda nil)
(setq org-done-keywords-for-agenda nil)
(setq org-agenda-filter nil)
+ (put 'org-agenda-filter :preset-filter org-agenda-filter-preset)
(if org-agenda-multi
(progn
(setq buffer-read-only nil)
org-agenda-view-columns-initially)
(org-agenda-columns))
(when org-agenda-fontify-priorities
- (org-fontify-priorities))
+ (org-agenda-fontify-priorities))
(when (and org-agenda-dim-blocked-tasks org-blocker-hook)
(org-agenda-dim-blocked-tasks))
(run-hooks 'org-finalize-agenda-hook)
(setq org-agenda-type (get-text-property (point) 'org-agenda-type))
+ (when (get 'org-agenda-filter :preset-filter)
+ (org-agenda-filter-apply org-agenda-filter))
)))
-(defun org-fontify-priorities ()
+(defun org-agenda-fontify-priorities ()
"Make highest priority lines bold, and lowest italic."
(interactive)
(mapc (lambda (o) (if (eq (org-overlay-get o 'org-type) 'org-priority)
l (or (get-char-property (point) 'org-lowest-priority)
org-lowest-priority)
p (string-to-char (match-string 1))
- b (match-beginning 0) e (point-at-eol)
+ b (match-beginning 0)
+ e (if (eq org-agenda-fontify-priorities 'cookies)
+ (match-end 0)
+ (point-at-eol))
ov (org-make-overlay b e))
(org-overlay-put
ov 'face
- (cond ((listp org-agenda-fontify-priorities)
- (cdr (assoc p org-agenda-fontify-priorities)))
+ (cond ((cdr (assoc p org-priority-faces)))
+ ((and (listp org-agenda-fontify-priorities)
+ (cdr (assoc p org-agenda-fontify-priorities))))
((equal p l) 'italic)
((equal p h) 'bold)))
(org-overlay-put ov 'org-type 'org-priority)))))
(let ((inhibit-read-only t)
(org-depend-tag-blocked nil)
(invis (eq org-agenda-dim-blocked-tasks 'invisible))
- b e p ov h l)
+ org-blocked-by-checkboxes
+ invis1 b e p ov h l)
(goto-char (point-min))
(while (let ((pos (next-single-property-change (point) 'todo-state)))
(and pos (goto-char (1+ pos))))
+ (setq org-blocked-by-checkboxes nil invis1 invis)
(let ((marker (get-text-property (point) 'org-hd-marker)))
(when (and marker
(not (with-current-buffer (marker-buffer marker)
(save-excursion
(goto-char marker)
- (run-hook-with-args-until-failure
- 'org-blocker-hook
- (list :type 'todo-state-change
- :position marker
- :from 'todo
- :to 'done))))))
- (setq b (if invis (max (point-min) (1- (point))) (point))
+ (if (org-entry-get nil "NOBLOCKING")
+ t ;; Never block this entry
+ (run-hook-with-args-until-failure
+ 'org-blocker-hook
+ (list :type 'todo-state-change
+ :position marker
+ :from 'todo
+ :to 'done)))))))
+ (if org-blocked-by-checkboxes (setq invis1 nil))
+ (setq b (if invis1 (max (point-min) (1- (point))) (point))
e (point-at-eol)
ov (org-make-overlay b e))
- (if invis
+ (if invis1
(org-overlay-put ov 'invisible t)
(org-overlay-put ov 'face 'org-agenda-dimmed-todo-face))
(org-overlay-put ov 'org-type 'org-blocked-todo)))))))
;;; Agenda Daily/Weekly
(defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
-(defvar org-agenda-start-day nil) ; dynamically scoped parameter
+(defvar org-agenda-start-day nil ; dynamically scoped parameter
+"Custom commands can set this variable in the options section.")
(defvar org-agenda-last-arguments nil
"The arguments of the previous call to org-agenda")
(defvar org-starting-day nil) ; local variable in the agenda buffer
(w1 (org-days-to-iso-week d1))
(w2 (org-days-to-iso-week d2)))
(setq s (point))
- (insert (capitalize (symbol-name (org-agenda-ndays-to-span nd)))
- "-agenda"
- (if (< (- d2 d1) 350)
- (if (= w1 w2)
- (format " (W%02d)" w1)
- (format " (W%02d-W%02d)" w1 w2))
- "")
- ":\n"))
+ (if org-agenda-overriding-header
+ (insert (org-add-props (copy-sequence org-agenda-overriding-header)
+ nil 'face 'org-agenda-structure) "\n")
+ (insert (capitalize (symbol-name (org-agenda-ndays-to-span nd)))
+ "-agenda"
+ (if (< (- d2 d1) 350)
+ (if (= w1 w2)
+ (format " (W%02d)" w1)
+ (format " (W%02d-W%02d)" w1 w2))
+ "")
+ ":\n")))
(add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
'org-date-line t)))
(while (setq d (pop day-numbers))
:deadline :scheduled :sexp :timestamp))))
(setq rtnall (append rtnall rtn))))
(if org-agenda-include-diary
- (progn
+ (let ((org-agenda-search-headline-for-time t))
(require 'diary-lib)
(setq rtn (org-get-entries-from-diary date))
(setq rtnall (append rtnall rtn))))
'org-agenda-date))
(put-text-property s (1- (point)) 'org-date-line t)
(put-text-property s (1- (point)) 'org-day-cnt day-cnt)
- (if todayp (put-text-property s (1- (point)) 'org-today t))
+ (when todayp
+ (put-text-property s (1- (point)) 'org-today t)
+ (put-text-property s (1- (point)) 'face 'org-agenda-date-today))
(if rtnall (insert
(org-finalize-agenda-entries
(org-agenda-add-time-grid-maybe
(setq tbl (apply 'org-get-clocktable p))
(insert tbl)))
(goto-char (point-min))
- (org-fit-agenda-window)
+ (or org-agenda-multi (org-fit-agenda-window))
(unless (and (pos-visible-in-window-p (point-min))
(pos-visible-in-window-p (point-max)))
(goto-char (1- (point-max)))
(org-set-sorting-strategy 'search)
(org-prepare-agenda "SEARCH")
(let* ((props (list 'face nil
- 'done-face 'org-done
+ 'done-face 'org-agenda-done
'org-not-done-regexp org-not-done-regexp
'org-todo-regexp org-todo-regexp
'org-complex-heading-regexp org-complex-heading-regexp
(when rtnall
(insert (org-finalize-agenda-entries rtnall) "\n"))
(goto-char (point-min))
- (org-fit-agenda-window)
+ (or org-agenda-multi (org-fit-agenda-window))
(add-text-properties (point-min) (point-max) '(org-agenda-type search))
(org-finalize-agenda)
(setq buffer-read-only t)))
(when rtnall
(insert (org-finalize-agenda-entries rtnall) "\n"))
(goto-char (point-min))
- (org-fit-agenda-window)
+ (or org-agenda-multi (org-fit-agenda-window))
(add-text-properties (point-min) (point-max) '(org-agenda-type todo))
(org-finalize-agenda)
(setq buffer-read-only t)))
(org-compile-prefix-format 'tags)
(org-set-sorting-strategy 'tags)
(let* ((org-tags-match-list-sublevels
- (if todo-only t org-tags-match-list-sublevels))
+;?????? (if todo-only t org-tags-match-list-sublevels))
+ org-tags-match-list-sublevels)
(completion-ignore-case t)
rtn rtnall files file pos matcher
buffer)
(when rtnall
(insert (org-finalize-agenda-entries rtnall) "\n"))
(goto-char (point-min))
- (org-fit-agenda-window)
+ (or org-agenda-multi (org-fit-agenda-window))
(add-text-properties (point-min) (point-max) '(org-agenda-type tags))
(org-finalize-agenda)
(setq buffer-read-only t)))
used by user-defined selections using `org-agenda-skip-function'.")
(defvar org-agenda-overriding-header nil
- "When this is set during todo and tags searches, will replace header.")
+ "When this is set during todo and tags searches, will replace header.
+This variable should not be set directly, but custom commands can bind it
+in the options section.")
+
+(defun org-agenda-skip-entry-when-regexp-matches ()
+ "Checks if the current entry contains match for `org-agenda-skip-regexp'.
+If yes, it returns the end position of this entry, causing agenda commands
+to skip the entry but continuing the search in the subtree. This is a
+function that can be put into `org-agenda-skip-function' for the duration
+of a command."
+ (let ((end (save-excursion (org-end-of-subtree t)))
+ skip)
+ (save-excursion
+ (setq skip (re-search-forward org-agenda-skip-regexp end t)))
+ (and skip end)))
(defun org-agenda-skip-subtree-when-regexp-matches ()
"Checks if the current subtree contains match for `org-agenda-skip-regexp'.
(setq skip (re-search-forward org-agenda-skip-regexp end t)))
(and skip end)))
+(defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
+ "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
+If yes, it returns the end position of the current entry (NOT the tree),
+causing agenda commands to skip the entry but continuing the search in
+the subtree. This is a function that can be put into
+`org-agenda-skip-function' for the duration of a command. An important
+use of this function is for the stuck project list."
+ (let ((end (save-excursion (org-end-of-subtree t)))
+ (entry-end (save-excursion (outline-next-heading) (1- (point))))
+ skip)
+ (save-excursion
+ (setq skip (re-search-forward org-agenda-skip-regexp end t)))
+ (and skip entry-end)))
+
(defun org-agenda-skip-entry-if (&rest conditions)
"Skip entry if any of CONDITIONS is true.
See `org-agenda-skip-if' for details."
notscheduled Check if there is no scheduled cookie
deadline Check if there is a deadline
notdeadline Check if there is no deadline
+timestamp Check if there is a timestamp (also deadline or scheduled)
+nottimestamp Check if there is no timestamp (also deadline or scheduled)
regexp Check if regexp matches
notregexp Check if regexp does not match.
(re-search-forward org-deadline-time-regexp end t))
(and (memq 'notdeadline conditions)
(not (re-search-forward org-deadline-time-regexp end t)))
+ (and (memq 'timestamp conditions)
+ (re-search-forward org-ts-regexp end t))
+ (and (memq 'nottimestamp conditions)
+ (not (re-search-forward org-ts-regexp end t)))
(and (setq m (memq 'regexp conditions))
(stringp (nth 1 m))
(re-search-forward (nth 1 m) end t))
`org-stuck-projects'.
MATCH is being ignored."
(interactive)
- (let* ((org-agenda-skip-function 'org-agenda-skip-subtree-when-regexp-matches)
+ (let* ((org-agenda-skip-function
+ 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
;; We could have used org-agenda-skip-if here.
- (org-agenda-overriding-header "List of stuck projects: ")
+ (org-agenda-overriding-header
+ (or org-agenda-overriding-header "List of stuck projects: "))
(matcher (nth 0 org-stuck-projects))
(todo (nth 1 org-stuck-projects))
(todo-wds (if (member "*" todo)
(tags (nth 2 org-stuck-projects))
(tags-re (if (member "*" tags)
(org-re "^\\*+ .*:[[:alnum:]_@]+:[ \t]*$")
- (concat "^\\*+ .*:\\("
- (mapconcat 'identity tags "\\|")
- (org-re "\\):[[:alnum:]_@:]*[ \t]*$"))))
+ (if tags
+ (concat "^\\*+ .*:\\("
+ (mapconcat 'identity tags "\\|")
+ (org-re "\\):[[:alnum:]_@:]*[ \t]*$")))))
(gen-re (nth 3 org-stuck-projects))
(re-list
(delq nil
'type "diary" 'date date))
entries)))))
+(defvar org-agenda-cleanup-fancy-diary-hook nil
+ "Hook run when the fancy diary buffer is cleaned up.")
+
(defun org-agenda-cleanup-fancy-diary ()
"Remove unwanted stuff in buffer created by `fancy-diary-display'.
This gets rid of the date, the underline under the date, and
(replace-match ""))
(goto-char (point-min))
(if (re-search-forward "^Org-mode dummy\n?" nil t)
- (replace-match "")))
+ (replace-match ""))
+ (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
;; Make sure entries from the diary have the right text properties.
(eval-after-load "diary-lib"
(defun org-agenda-get-todos ()
"Return the TODO information for agenda display."
(let* ((props (list 'face nil
- 'done-face 'org-done
+ 'done-face 'org-agenda-done
'org-not-done-regexp org-not-done-regexp
'org-todo-regexp org-todo-regexp
'org-complex-heading-regexp org-complex-heading-regexp
(goto-char (match-beginning 1))
(setq marker (org-agenda-new-marker (match-beginning 0))
category (org-get-category)
+ txt (match-string 1)
tags (org-get-tags-at (point))
- txt (org-format-agenda-item "" (match-string 1) category tags)
+ txt (org-format-agenda-item "" txt category tags)
priority (1+ (org-get-priority txt))
todo-state (org-get-todo-state))
(org-add-props txt props
"\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
marker hdmarker deadlinep scheduledp clockp closedp inactivep
donep tmp priority category ee txt timestr tags b0 b3 e3 head
- todo-state)
+ todo-state end-of-match)
(goto-char (point-min))
- (while (re-search-forward regexp nil t)
+ (while (setq end-of-match (re-search-forward regexp nil t))
(setq b0 (match-beginning 0)
b3 (match-beginning 3) e3 (match-end 3))
(catch :skip
(if (and e3
(not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
(throw :skip nil))
- (setq marker (org-agenda-new-marker b0)
- category (org-get-category b0)
- tmp (buffer-substring (max (point-min)
+ (setq tmp (buffer-substring (max (point-min)
(- b0 org-ds-keyword-length))
b0)
timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
(string-match "]-+\\'" tmp)))
todo-state (org-get-todo-state)
donep (member todo-state org-done-keywords))
- (if (or scheduledp deadlinep closedp clockp)
+ (if (or scheduledp deadlinep closedp clockp
+ (and donep org-agenda-skip-timestamp-if-done))
(throw :skip t))
(if (string-match ">" timestr)
;; substring should only run to end of time stamp
(setq timestr (substring timestr 0 (match-end 0))))
+ (setq marker (org-agenda-new-marker b0)
+ category (org-get-category b0))
(save-excursion
- (if (re-search-backward "^\\*+ " nil t)
- (progn
- (goto-char (match-beginning 0))
- (setq hdmarker (org-agenda-new-marker)
- tags (org-get-tags-at))
- (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
- (setq head (match-string 1))
- (and org-agenda-skip-timestamp-if-done donep (throw :skip t))
- (setq txt (org-format-agenda-item
- (if inactivep "[" nil)
- head category tags timestr nil
- remove-re)))
- (setq txt org-agenda-no-heading-message))
+ (if (not (re-search-backward "^\\*+ " nil t))
+ (setq txt org-agenda-no-heading-message)
+ (goto-char (match-beginning 0))
+ (setq hdmarker (org-agenda-new-marker)
+ tags (org-get-tags-at))
+ (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
+ (setq head (match-string 1))
+ (setq txt (org-format-agenda-item
+ (if inactivep "[" nil)
+ head category tags timestr nil
+ remove-re)))
(setq priority (org-get-priority txt))
(org-add-props txt props
'org-marker marker 'org-hd-marker hdmarker)
'todo-state todo-state
'type "timestamp")
(push txt ee))
- (outline-next-heading)))
+ (if org-agenda-skip-additional-timestamps-same-entry
+ (outline-next-heading)
+ (goto-char end-of-match))))
(nreverse ee)))
(defun org-agenda-get-sexps ()
(format "mouse-2 or RET jump to org file %s"
(abbreviate-file-name buffer-file-name))))
(regexp "^&?%%(")
- marker category ee txt tags entry result beg b sexp sexp-entry)
+ marker category ee txt tags entry result beg b sexp sexp-entry
+ todo-state)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(catch :skip
(setq result (org-diary-sexp-entry sexp sexp-entry date))
(when result
(setq marker (org-agenda-new-marker beg)
- category (org-get-category beg))
+ category (org-get-category beg)
+ todo-state (org-get-todo-state))
(if (string-match "\\S-" result)
(setq txt result)
"" txt category tags 'time))
(org-add-props txt props 'org-marker marker)
(org-add-props txt nil
- 'org-category category 'date date
+ 'org-category category 'date date 'todo-state todo-state
'type "sexp")
(push txt ee))))
(nreverse ee)))
(list
(if (memq 'closed items) (concat "\\<" org-closed-string))
(if (memq 'clock items) (concat "\\<" org-clock-string))
- (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\""))))
+ (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
(parts-re (if parts (mapconcat 'identity parts "\\|")
(error "`org-agenda-log-mode-items' is empty")))
(regexp (concat
(apply 'encode-time ; DATE bound by calendar
(list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
1 11))))
- marker hdmarker priority category tags closedp statep state
- ee txt timestr rest clocked)
+ (org-agenda-search-headline-for-time nil)
+ marker hdmarker priority category tags closedp statep clockp state
+ ee txt extra timestr rest clocked)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(catch :skip
(setq marker (org-agenda-new-marker (match-beginning 0))
closedp (equal (match-string 1) org-closed-string)
statep (equal (string-to-char (match-string 1)) ?-)
+ clockp (not (or closedp statep))
state (and statep (match-string 2))
category (org-get-category (match-beginning 0))
timestr (buffer-substring (match-beginning 0) (point-at-eol))
- ;; donep (org-entry-is-done-p)
)
(when (string-match "\\]" timestr)
;; substring should only run to end of time stamp
(setq rest (substring timestr (match-end 0))
timestr (substring timestr 0 (match-end 0)))
(if (and (not closedp) (not statep)
- (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)" rest))
+ (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)" rest))
(progn (setq timestr (concat (substring timestr 0 -1)
"-" (match-string 1 rest) "]"))
(setq clocked (match-string 2 rest)))
(setq clocked "-")))
(save-excursion
- (if (re-search-backward "^\\*+ " nil t)
- (progn
- (goto-char (match-beginning 0))
- (setq hdmarker (org-agenda-new-marker)
- tags (org-get-tags-at))
- (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
- (setq txt (org-format-agenda-item
- (cond
- (closedp "Closed: ")
+ (cond
+ ((not org-agenda-log-mode-add-notes) (setq extra nil))
+ (statep
+ (and (looking-at ".*\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
+ (setq extra (match-string 1))))
+ (clockp
+ (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
+ (setq extra (match-string 1))))
+ (t (setq extra nil)))
+ (if (not (re-search-backward "^\\*+ " nil t))
+ (setq txt org-agenda-no-heading-message)
+ (goto-char (match-beginning 0))
+ (setq hdmarker (org-agenda-new-marker)
+ tags (org-get-tags-at))
+ (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
+ (setq txt (match-string 1))
+ (when extra
+ (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
+ (setq txt (concat (substring txt 0 (match-beginning 1))
+ " - " extra " " (match-string 2 txt)))
+ (setq txt (concat txt " - " extra))))
+ (setq txt (org-format-agenda-item
+ (cond
+ (closedp "Closed: ")
(statep (concat "State: (" state ")"))
(t (concat "Clocked: (" clocked ")")))
- (match-string 1) category tags timestr)))
- (setq txt org-agenda-no-heading-message))
+ txt category tags timestr)))
(setq priority 100000)
(org-add-props txt props
- 'org-marker marker 'org-hd-marker hdmarker 'face 'org-done
+ 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
'priority priority 'org-category category
'type "closed" 'date date
- 'undone-face 'org-warning 'done-face 'org-done)
+ 'undone-face 'org-warning 'done-face 'org-agenda-done)
(push txt ee))
(goto-char (point-at-eol))))
(nreverse ee)))
(catch :skip
(org-agenda-skip)
(setq s (match-string 1)
+ txt nil
pos (1- (match-beginning 1))
d2 (org-time-string-to-absolute
(match-string 1) d1 'past
(and todayp (not org-agenda-only-exact-dates)))
(= diff 0))
(save-excursion
- (setq category (org-get-category))
(setq todo-state (org-get-todo-state))
- (if (re-search-backward "^\\*+[ \t]+" nil t)
- (progn
- (goto-char (match-end 0))
- (setq pos1 (match-beginning 0))
- (setq tags (org-get-tags-at pos1))
- (setq head (buffer-substring-no-properties
- (point)
- (progn (skip-chars-forward "^\r\n")
- (point))))
- (setq donep (member todo-state org-done-keywords))
- (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
- (setq timestr
- (concat (substring s (match-beginning 1)) " "))
- (setq timestr 'time))
- (if (and donep
- (or org-agenda-skip-deadline-if-done
- (not (= diff 0))))
- (setq txt nil)
- (setq txt (org-format-agenda-item
- (if (= diff 0)
- (car org-agenda-deadline-leaders)
- (if (functionp (nth 1 org-agenda-deadline-leaders))
- (funcall (nth 1 org-agenda-deadline-leaders) diff date)
- (format (nth 1 org-agenda-deadline-leaders)
- diff)))
- head category tags
- (if (not (= diff 0)) nil timestr)))))
- (setq txt org-agenda-no-heading-message))
+ (setq donep (member todo-state org-done-keywords))
+ (if (and donep
+ (or org-agenda-skip-deadline-if-done
+ (not (= diff 0))))
+ (setq txt nil)
+ (setq category (org-get-category))
+ (if (not (re-search-backward "^\\*+[ \t]+" nil t))
+ (setq txt org-agenda-no-heading-message)
+ (goto-char (match-end 0))
+ (setq pos1 (match-beginning 0))
+ (setq tags (org-get-tags-at pos1))
+ (setq head (buffer-substring-no-properties
+ (point)
+ (progn (skip-chars-forward "^\r\n")
+ (point))))
+ (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
+ (setq timestr
+ (concat (substring s (match-beginning 1)) " "))
+ (setq timestr 'time))
+ (setq txt (org-format-agenda-item
+ (if (= diff 0)
+ (car org-agenda-deadline-leaders)
+ (if (functionp
+ (nth 1 org-agenda-deadline-leaders))
+ (funcall
+ (nth 1 org-agenda-deadline-leaders)
+ diff date)
+ (format (nth 1 org-agenda-deadline-leaders)
+ diff)))
+ head category tags
+ (if (not (= diff 0)) nil timestr)))))
(when txt
(setq face (org-agenda-deadline-face dfrac wdays))
(org-add-props txt props
'todo-state todo-state
'type (if upcomingp "upcoming-deadline" "deadline")
'date (if upcomingp date d2)
- 'face (if donep 'org-done face)
- 'undone-face face 'done-face 'org-done)
+ 'face (if donep 'org-agenda-done face)
+ 'undone-face face 'done-face 'org-agenda-done)
(push txt ee))))))
(nreverse ee)))
(let* ((props (list 'org-not-done-regexp org-not-done-regexp
'org-todo-regexp org-todo-regexp
'org-complex-heading-regexp org-complex-heading-regexp
- 'done-face 'org-done
+ 'done-face 'org-agenda-done
'mouse-face 'highlight
'keymap org-agenda-keymap
'help-echo
(catch :skip
(org-agenda-skip)
(setq s (match-string 1)
+ txt nil
pos (1- (match-beginning 1))
d2 (org-time-string-to-absolute
(match-string 1) d1 'past
(and todayp (not org-agenda-only-exact-dates)))
(= diff 0))
(save-excursion
- (setq category (org-get-category))
(setq todo-state (org-get-todo-state))
- (if (re-search-backward "^\\*+[ \t]+" nil t)
- (progn
- (goto-char (match-end 0))
- (setq pos1 (match-beginning 0))
- (setq tags (org-get-tags-at))
- (setq head (buffer-substring-no-properties
- (point)
- (progn (skip-chars-forward "^\r\n") (point))))
- (setq donep (member todo-state org-done-keywords))
- (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
- (setq timestr
- (concat (substring s (match-beginning 1)) " "))
- (setq timestr 'time))
- (if (and donep
- (or org-agenda-skip-scheduled-if-done
- (not (= diff 0))))
- (setq txt nil)
- (setq txt (org-format-agenda-item
- (if (= diff 0)
- (car org-agenda-scheduled-leaders)
- (format (nth 1 org-agenda-scheduled-leaders)
- (- 1 diff)))
- head category tags
- (if (not (= diff 0)) nil timestr)))))
- (setq txt org-agenda-no-heading-message))
+ (setq donep (member todo-state org-done-keywords))
+ (if (and donep
+ (or org-agenda-skip-scheduled-if-done
+ (not (= diff 0))))
+ (setq txt nil)
+ (setq category (org-get-category))
+ (if (not (re-search-backward "^\\*+[ \t]+" nil t))
+ (setq txt org-agenda-no-heading-message)
+ (goto-char (match-end 0))
+ (setq pos1 (match-beginning 0))
+ (setq tags (org-get-tags-at))
+ (setq head (buffer-substring-no-properties
+ (point)
+ (progn (skip-chars-forward "^\r\n") (point))))
+ (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
+ (setq timestr
+ (concat (substring s (match-beginning 1)) " "))
+ (setq timestr 'time))
+ (setq txt (org-format-agenda-item
+ (if (= diff 0)
+ (car org-agenda-scheduled-leaders)
+ (format (nth 1 org-agenda-scheduled-leaders)
+ (- 1 diff)))
+ head category tags
+ (if (not (= diff 0)) nil timestr)))))
(when txt
(setq face
(cond
(t 'org-scheduled)))
(org-add-props txt props
'undone-face face
- 'face (if donep 'org-done face)
+ 'face (if donep 'org-agenda-done face)
'org-marker (org-agenda-new-marker pos)
'org-hd-marker (org-agenda-new-marker pos1)
'type (if pastschedp "past-scheduled" "scheduled")
(regexp org-tr-regexp)
(d0 (calendar-absolute-from-gregorian date))
marker hdmarker ee txt d1 d2 s1 s2 timestr category todo-state tags pos
- head)
+ head donep)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(catch :skip
;; Only allow days between the limits, because the normal
;; date stamps will catch the limits.
(save-excursion
+ (setq todo-state (org-get-todo-state))
+ (setq donep (member todo-state org-done-keywords))
+ (if (and donep org-agenda-skip-timestamp-if-done)
+ (throw :skip t))
(setq marker (org-agenda-new-marker (point)))
(setq category (org-get-category))
- (setq todo-state (org-get-todo-state))
- (if (re-search-backward "^\\*+ " nil t)
- (progn
- (goto-char (match-beginning 0))
- (setq hdmarker (org-agenda-new-marker (point)))
- (setq tags (org-get-tags-at))
- (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
- (setq head (match-string 1))
- (and org-agenda-skip-timestamp-if-done
- (org-entry-is-done-p)
- (throw :skip t))
- (setq txt (org-format-agenda-item
- (format
- (nth (if (= d1 d2) 0 1)
- org-agenda-timerange-leaders)
- (1+ (- d0 d1)) (1+ (- d2 d1)))
- head category tags
- (if (= d0 d1) timestr))))
- (setq txt org-agenda-no-heading-message))
+ (if (not (re-search-backward "^\\*+ " nil t))
+ (setq txt org-agenda-no-heading-message)
+ (goto-char (match-beginning 0))
+ (setq hdmarker (org-agenda-new-marker (point)))
+ (setq tags (org-get-tags-at))
+ (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
+ (setq head (match-string 1))
+ (setq txt (org-format-agenda-item
+ (format
+ (nth (if (= d1 d2) 0 1)
+ org-agenda-timerange-leaders)
+ (1+ (- d0 d1)) (1+ (- d2 d1)))
+ head category tags
+ (if (= d0 d1) timestr))))
(org-add-props txt props
'org-marker marker 'org-hd-marker hdmarker
'type "block" 'date date
;; time, tag, effort are needed for the eval of the prefix format
(tag (if tags (nth (1- (length tags)) tags) ""))
time effort neffort
- (ts (if dotime (concat (if (stringp dotime) dotime "") txt)))
+ (ts (if dotime (concat
+ (if (stringp dotime) dotime "")
+ (and org-agenda-search-headline-for-time txt))))
(time-of-day (and dotime (org-get-time-of-day ts)))
stamp plain s0 s1 s2 t1 t2 rtn srp
duration)
(setq rtn (concat (eval org-prefix-format-compiled) txt)))
;; And finally add the text properties
+ (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
(org-add-props rtn nil
'org-category (downcase category)
'tags (mapcar 'org-downcase-keep-props tags)
(setq re (get-text-property (point) 'org-todo-regexp))
(goto-char (+ (point) (or (get-text-property (point) 'prefix-length) 0)))
(when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
- (add-text-properties (match-beginning 0) (match-end 0)
+ (add-text-properties (match-beginning 0) (match-end 1)
(list 'face (org-get-todo-face 1)))
(let ((s (buffer-substring (match-beginning 1) (match-end 1))))
(delete-region (match-beginning 1) (1- (match-end 0)))
(defsubst org-cmp-todo-state (a b)
"Compare the todo states of strings A and B."
- (let* ((ta (or (get-text-property 1 'todo-state a) ""))
+ (let* ((ma (or (get-text-property 1 'org-marker a)
+ (get-text-property 1 'org-hd-marker a)))
+ (mb (or (get-text-property 1 'org-marker b)
+ (get-text-property 1 'org-hd-marker b)))
+ (fa (and ma (marker-buffer ma)))
+ (fb (and mb (marker-buffer mb)))
+ (todo-kwds
+ (or (and fa (with-current-buffer fa org-todo-keywords-1))
+ (and fb (with-current-buffer fb org-todo-keywords-1))))
+ (ta (or (get-text-property 1 'todo-state a) ""))
(tb (or (get-text-property 1 'todo-state b) ""))
- (la (- (length (member ta org-todo-keywords-for-agenda))))
- (lb (- (length (member tb org-todo-keywords-for-agenda))))
+ (la (- (length (member ta todo-kwds))))
+ (lb (- (length (member tb todo-kwds))))
(donepa (member ta org-done-keywords-for-agenda))
(donepb (member tb org-done-keywords-for-agenda)))
(cond ((and donepa (not donepb)) -1)
(tag-up (org-cmp-tag a b))
(tag-down (if tag-up (- tag-up) nil))
(todo-state-up (org-cmp-todo-state a b))
- (todo-state-down (if todo-state-up (- todo-state-up) nil)))
+ (todo-state-down (if todo-state-up (- todo-state-up) nil))
+ user-defined-up user-defined-down)
+ (if (and org-agenda-cmp-user-defined
+ (functionp org-agenda-cmp-user-defined))
+ (setq user-defined-up
+ (funcall org-agenda-cmp-user-defined a b)
+ user-defined-down (if user-defined-up (- user-defined-up) nil)))
(cdr (assoc
(eval (cons 'or org-agenda-sorting-strategy-selected))
'((-1 . t) (1 . nil) (nil . nil))))))
(if org-agenda-columns-active
(org-columns-quit)
(let ((buf (current-buffer)))
- (if (not (one-window-p)) (delete-window))
+ (and (not (eq org-agenda-window-setup 'current-window))
+ (not (one-window-p))
+ (delete-window))
(kill-buffer buf)
(org-agenda-reset-markers)
(org-columns-remove-overlays)
(let ((org-agenda-window-setup 'current-window))
(org-agenda arg)))
-(defun org-save-all-org-buffers ()
- "Save all Org-mode buffers without user confirmation."
- (interactive)
- (message "Saving all Org-mode buffers...")
- (save-some-buffers t 'org-mode-p)
- (message "Saving all Org-mode buffers... done"))
-
(defun org-agenda-redo ()
"Rebuild Agenda.
When this is the global TODO list, a prefix argument will be interpreted."
(interactive)
(let* ((org-agenda-keep-modes t)
(filter org-agenda-filter)
+ (preset (get 'org-agenda-filter :preset-filter))
(cols org-agenda-columns-active)
(line (org-current-line))
(window-line (- line (org-current-line (window-start))))
(lprops (get 'org-agenda-redo-command 'org-lprops)))
+ (put 'org-agenda-filter :preset-filter nil)
(and cols (org-columns-quit))
(message "Rebuilding agenda buffer...")
(org-let lprops '(eval org-agenda-redo-command))
(setq org-agenda-undo-list nil
org-agenda-pending-undo-list nil)
(message "Rebuilding agenda buffer...done")
- (and filter (org-agenda-filter-apply filter))
+ (put 'org-agenda-filter :preset-filter preset)
+ (and (or filter preset) (org-agenda-filter-apply filter))
(and cols (interactive-p) (org-agenda-columns))
(goto-line line)
(recenter window-line)))
char a n tag)
(unless char
(message
- "%s by tag [%s ], [TAB], [/]:off, [+-]:narrow, [>=<]:effort: "
+ "%s by tag [%s ], [TAB], [/]:off, [+-]:narrow, [>=<?]:effort: "
(if narrow "Narrow" "Filter") tag-chars)
(setq char (read-char)))
(when (member char '(?+ ?-))
(message
"Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
(setq char (read-char)))
- (when (member char '(?< ?> ?=))
+ (when (member char '(?< ?> ?= ??))
;; An effort operator
(setq effort-op (char-to-string char))
- (loop for i from 0 to 9 do
- (setq effort-prompt
- (concat
- effort-prompt " ["
- (if (= i 9) "0" (int-to-string (1+ i)))
- "]" (nth i efforts))))
(setq alist nil) ; to make sure it will be interpreted as effort.
- (message "Effort%s: %s " effort-op effort-prompt)
- (setq char (read-char))
- (when (or (< char ?0) (> char ?9))
- (error "Need 1-9,0 to select effort" )))
+ (unless (equal char ??)
+ (loop for i from 0 to 9 do
+ (setq effort-prompt
+ (concat
+ effort-prompt " ["
+ (if (= i 9) "0" (int-to-string (1+ i)))
+ "]" (nth i efforts))))
+ (message "Effort%s: %s " effort-op effort-prompt)
+ (setq char (read-char))
+ (when (or (< char ?0) (> char ?9))
+ (error "Need 1-9,0 to select effort" ))))
(when (equal char ?\t)
(unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
(org-set-local 'org-global-tags-completion-table
(setq tag (org-ido-completing-read
"Tag: " org-global-tags-completion-table))))
(cond
- ((equal char ?/) (org-agenda-filter-by-tag-show-all))
+ ((equal char ?/)
+ (org-agenda-filter-by-tag-show-all)
+ (when (get 'org-agenda-filter :preset-filter)
+ (org-agenda-filter-apply org-agenda-filter)))
((or (equal char ?\ )
(setq a (rassoc char alist))
(and (>= char ?0) (<= char ?9)
(setq n (if (= char ?0) 9 (- char ?0 1))
tag (concat effort-op (nth n efforts))
a (cons tag nil)))
+ (and (= char ??)
+ (setq tag "?eff")
+ a (cons tag nil))
(and tag (setq a (cons tag nil))))
(org-agenda-filter-by-tag-show-all)
(setq tag (car a))
(defun org-agenda-filter-make-matcher ()
"Create the form that tests a line for the agenda filter."
(let (f f1)
- (dolist (x org-agenda-filter)
+ (dolist (x (append (get 'org-agenda-filter :preset-filter)
+ org-agenda-filter))
(if (member x '("-" "+"))
(setq f1 '(not tags))
- (if (string-match "[<=>]" x)
+ (if (string-match "[<=>?]" x)
(setq f1 (org-agenda-filter-effort-form x))
(setq f1 (list 'member (downcase (substring x 1)) 'tags)))
(if (equal (string-to-char x) ?-)
(let (op)
(setq e (substring e 1))
(setq op (string-to-char e) e (substring e 1))
- (setq op (if (equal op ?<) '<= (if (equal op ?>) '>= '=)))
+ (setq op (cond ((equal op ?<) '<=)
+ ((equal op ?>) '>=)
+ ((equal op ??) op)
+ (t '=)))
(list 'org-agenda-compare-effort (list 'quote op)
(org-hh:mm-string-to-minutes e))))
"Compare the effort of the current line with VALUE, using OP.
If the line does not have an effort defined, return nil."
(let ((eff (get-text-property (point) 'effort-minutes)))
- (if (not eff)
- 0 ; we don't have an effort defined, treat as 0
- (funcall op eff value))))
+ (if (equal op ??)
+ (not eff)
+ (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
+ value))))
(defun org-agenda-filter-apply (filter)
"Set FILTER as the new agenda filter and apply it."
(interactive "p")
(org-agenda-later (- arg)))
+(defun org-agenda-view-mode-dispatch ()
+ "Call one of the view mode commands."
+ (interactive)
+ (message "View: [d]ay [w]eek [m]onth [y]ear [l]og [L]og-all [a]rch-trees [A]rch-files
+ clock[R]eport time[G]rid include[D]iary")
+ (let ((a (read-char-exclusive)))
+ (case a
+ (?d (call-interactively 'org-agenda-day-view))
+ (?w (call-interactively 'org-agenda-week-view))
+ (?m (call-interactively 'org-agenda-month-view))
+ (?y (call-interactively 'org-agenda-year-view))
+ (?l (call-interactively 'org-agenda-log-mode))
+ (?a (call-interactively 'org-agenda-archives-mode))
+ (?A (org-agenda-archives-mode 'files))
+ (?R (call-interactively 'org-agenda-clockreport-mode))
+ (?G (call-interactively 'org-agenda-toggle-time-grid))
+ (?D (call-interactively 'org-agenda-toggle-diary))
+ (?q (message "Abort"))
+ (otherwise (error "Invalid key" )))))
+
(defun org-agenda-day-view (&optional day-of-year)
"Switch to daily view for agenda.
With argument DAY-OF-YEAR, switch to that day of the year."
(if org-agenda-show-log "on" "off")))
(defun org-agenda-archives-mode (&optional with-files)
- "Toggle log mode in an agenda buffer."
+ "Toggle inclusion of items in trees marked with :ARCHIVE:.
+When called with a prefix argument, include all archive files as well."
(interactive "P")
(setq org-agenda-archives-mode
(if with-files t (if org-agenda-archives-mode nil 'trees)))
(if org-agenda-use-time-grid " Grid" "")
(if (consp org-agenda-show-log) " LogAll"
(if org-agenda-show-log " Log" ""))
- (if org-agenda-filter
- (concat " {" (mapconcat 'identity org-agenda-filter "") "}")
+ (if (or org-agenda-filter (get 'org-agenda-filter
+ :preset-filter))
+ (concat " {" (mapconcat
+ 'identity
+ (append (get 'org-agenda-filter
+ :preset-filter)
+ org-agenda-filter) "") "}")
"")
(if org-agenda-archives-mode
(if (eq org-agenda-archives-mode t)
(equal buf (marker-buffer m))
(setq p (marker-position m))
(>= p beg)
- (<= p end))
+ (< p end))
(let ((inhibit-read-only t))
(delete-region (point-at-bol) (1+ (point-at-eol)))))
(beginning-of-line 0))))))
+(defun org-agenda-refile (&optional goto rfloc)
+ "Refile the item at point."
+ (interactive "P")
+ (let* ((marker (or (get-text-property (point) 'org-hd-marker)
+ (org-agenda-error)))
+ (buffer (marker-buffer marker))
+ (pos (marker-position marker))
+ (rfloc (or rfloc
+ (org-refile-get-location
+ (if goto "Goto: " "Refile to: ") buffer
+ org-refile-allow-creating-parent-nodes))))
+ (with-current-buffer buffer
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char marker)
+ (org-remove-subtree-entries-from-agenda)
+ (org-refile goto buffer rfloc))))))
+
+
+
+
(defun org-agenda-open-link ()
"Follow the link in the current line, if any."
(interactive)
(org-agenda-goto t))
(select-window win)))
+(defun org-agenda-show-1 (&optional more)
+ "Display the Org-mode file which contains the item at point.
+The prefix arg causes further revieling:
+
+0 hide the subtree
+1 just show the entry according to defaults.
+2 show the text below the heading
+3 show the entire subtree
+4 show the entire subtree and any LOGBOOK drawers
+5 show the entire subtree and any drawers
+With prefix argument FULL-ENTRY, make the entire entry visible
+if it was hidden in the outline."
+ (interactive "p")
+ (let ((win (selected-window)))
+ (org-agenda-goto t)
+ (org-recenter-heading 1)
+ (cond
+ ((= more 0)
+ (hide-subtree)
+ (message "Remote: hide subtree"))
+ ((and (interactive-p) (= more 1))
+ (message "Remote: show with default settings"))
+ ((= more 2)
+ (show-entry)
+ (save-excursion
+ (org-back-to-heading)
+ (org-cycle-hide-drawers 'children))
+ (message "Remote: show entry"))
+ ((= more 3)
+ (show-subtree)
+ (save-excursion
+ (org-back-to-heading)
+ (org-cycle-hide-drawers 'subtree))
+ (message "Remote: show subtree"))
+ ((= more 4)
+ (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
+ (org-drawer-regexp
+ (concat "^[ \t]*:\\("
+ (mapconcat 'regexp-quote org-drawers "\\|")
+ "\\):[ \t]*$")))
+ (show-subtree)
+ (save-excursion
+ (org-back-to-heading)
+ (org-cycle-hide-drawers 'subtree)))
+ (message "Remote: show subtree and LOGBOOK"))
+ ((> more 4)
+ (show-subtree)
+ (message "Remote: show subtree and LOGBOOK")))
+ (select-window win)))
+
+(defun org-recenter-heading (n)
+ (save-excursion
+ (org-back-to-heading)
+ (recenter n)))
+
+(defvar org-agenda-cycle-counter nil)
+(defun org-agenda-cycle-show (n)
+ "Show the current entry in another window, with default settings.
+Default settings are taken from `org-show-hierarchy-above' and siblings.
+When use repeadedly in immediate succession, the remote entry will cycle
+through visibility
+
+entry -> subtree -> subtree with logbook"
+ (interactive "p")
+ (when (and (= n 1)
+ (not (eq last-command this-command)))
+ (setq org-agenda-cycle-counter 0))
+ (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
+ (if (> org-agenda-cycle-counter 4)
+ (setq org-agenda-cycle-counter 0))
+ (org-agenda-show-1 org-agenda-cycle-counter))
+
(defun org-agenda-recenter (arg)
"Display the Org-mode file which contains the item at point and recenter."
(interactive "P")
This changes the line at point, all other lines in the agenda referring to
the same tree node, and the headline of the tree node in the Org-mode file."
(interactive)
+ (unless org-enable-priority-commands
+ (error "Priority commands are disabled"))
(org-agenda-check-no-diary)
(let* ((marker (or (get-text-property (point) 'org-marker)
(org-agenda-error)))
(beginning-of-line 1))))
;; FIXME: should fix the tags property of the agenda line.
-(defun org-agenda-set-tags ()
+(defun org-agenda-set-tags (&optional tag onoff)
"Set tags for the current headline."
(interactive)
(org-agenda-check-no-diary)
(and (outline-next-heading)
(org-flag-heading nil))) ; show the next heading
(goto-char pos)
- (call-interactively 'org-set-tags)
+ (if tag
+ (org-toggle-tag tag onoff)
+ (call-interactively 'org-set-tags))
(end-of-line 1)
(setq newhead (org-get-heading)))
(org-agenda-change-all-lines newhead hdmarker)
(org-agenda-change-all-lines newhead hdmarker)
(beginning-of-line 1))))
+(defun org-agenda-do-date-later (arg)
+ (interactive "P")
+ (cond
+ ((or (equal arg '(16))
+ (memq last-command
+ '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
+ (setq this-command 'org-agenda-date-later-minutes)
+ (org-agenda-date-later-minutes 1))
+ ((or (equal arg '(4))
+ (memq last-command
+ '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
+ (setq this-command 'org-agenda-date-later-hours)
+ (org-agenda-date-later-hours 1))
+ (t
+ (org-agenda-date-later (prefix-numeric-value arg)))))
+
+(defun org-agenda-do-date-earlier (arg)
+ (interactive "P")
+ (cond
+ ((or (equal arg '(16))
+ (memq last-command
+ '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
+ (setq this-command 'org-agenda-date-earlier-minutes)
+ (org-agenda-date-earlier-minutes 1))
+ ((or (equal arg '(4))
+ (memq last-command
+ '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
+ (setq this-command 'org-agenda-date-earlier-hours)
+ (org-agenda-date-earlier-hours 1))
+ (t
+ (org-agenda-date-earlier (prefix-numeric-value arg)))))
+
(defun org-agenda-date-later (arg &optional what)
"Change the date of this item to one day later."
(interactive "p")
(interactive "p")
(org-agenda-date-later (- arg) what))
+(defun org-agenda-date-later-minutes (arg)
+ "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
+ (interactive "p")
+ (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
+ (org-agenda-date-later arg 'minute))
+
+(defun org-agenda-date-earlier-minutes (arg)
+ "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
+ (interactive "p")
+ (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
+ (org-agenda-date-earlier arg 'minute))
+
+(defun org-agenda-date-later-hours (arg)
+ "Change the time of this item, in hour steps."
+ (interactive "p")
+ (org-agenda-date-later arg 'hour))
+
+(defun org-agenda-date-earlier-hours (arg)
+ "Change the time of this item, in hour steps."
+ (interactive "p")
+ (org-agenda-date-earlier arg 'hour))
+
(defun org-agenda-show-new-time (marker stamp &optional prefix)
"Show new date stamp via text properties."
;; We use text properties to make this undoable
(pos (marker-position marker))
(org-insert-labeled-timestamps-at-point nil)
ts)
- (when type (message "%s" type) (sit-for 3))
(set-marker-insertion-type marker t)
(org-with-remote-undo buffer
(with-current-buffer buffer
(org-cycle-hide-drawers 'children)
(org-clock-in arg)
(setq newhead (org-get-heading)))
- (org-agenda-change-all-lines newhead hdmarker t)))))
+ (org-agenda-change-all-lines newhead hdmarker)))))
(defun org-agenda-clock-out (&optional arg)
"Stop the currently running clock."
(interactive "P")
(unless (marker-buffer org-clock-marker)
(error "No running clock"))
- (org-with-remote-undo (marker-buffer org-clock-marker)
- (org-clock-out)))
+ (let ((marker (make-marker)) newhead)
+ (org-with-remote-undo (marker-buffer org-clock-marker)
+ (with-current-buffer (marker-buffer org-clock-marker)
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char org-clock-marker)
+ (org-back-to-heading t)
+ (move-marker marker (point))
+ (org-clock-out)
+ (setq newhead (org-get-heading))))))
+ (org-agenda-change-all-lines newhead marker)
+ (move-marker marker nil)))
(defun org-agenda-clock-cancel (&optional arg)
"Cancel the currently running clock."
(princ s))
(org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
+;;; Bulk commands
+
+(defvar org-agenda-bulk-marked-entries nil
+ "List of markers that refer to marked entries in the agenda.")
+
+(defun org-agenda-bulk-mark ()
+ "Mark the entry at point for future bulk action."
+ (interactive)
+ (org-agenda-check-no-diary)
+ (let* ((m (get-text-property (point) 'org-hd-marker))
+ ov)
+ (unless (eq (get-char-property (point-at-bol) 'type)
+ 'org-marked-entry-overlay)
+ (unless m (error "Nothing to mark at point"))
+ (push m org-agenda-bulk-marked-entries)
+ (setq ov (org-make-overlay (point-at-bol) (+ 2 (point-at-bol))))
+ (org-overlay-display ov ">>"
+ (org-get-todo-face "TODO")
+ 'evaporate)
+ (org-overlay-put ov 'type 'org-marked-entry-overlay))
+ (beginning-of-line 2)
+ (message "%d entries marked for bulk action"
+ (length org-agenda-bulk-marked-entries))))
+
+(defun org-agenda-bulk-unmark ()
+ "Unmark the entry at point for future bulk action."
+ (interactive)
+ (when (eq (get-char-property (point-at-bol) 'type)
+ 'org-marked-entry-overlay)
+ (org-agenda-bulk-remove-overlays
+ (point-at-bol) (+ 2 (point-at-bol)))
+ (setq org-agenda-bulk-marked-entries
+ (delete (get-text-property (point-at-bol) 'org-hd-marker)
+ org-agenda-bulk-marked-entries)))
+ (beginning-of-line 2)
+ (message "%d entries marked for bulk action"
+ (length org-agenda-bulk-marked-entries)))
+
+
+(defun org-agenda-bulk-remove-overlays (&optional beg end)
+ "Remove the mark overlays between BEG and END in the agenda buffer.
+BEG and END default to the buffer limits.
+
+This only removes the overlays, it does not remove the markers
+from the list in `org-agenda-bulk-marked-entries'."
+ (interactive)
+ (mapc (lambda (ov)
+ (and (eq (org-overlay-get ov 'type) 'org-marked-entry-overlay)
+ (org-delete-overlay ov)))
+ (org-overlays-in (or beg (point-min)) (or end (point-max)))))
+
+(defun org-agenda-bulk-remove-all-marks ()
+ "Remove all marks in the agenda buffer.
+This will remove the markers, and the overlays."
+ (interactive)
+ (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
+ (setq org-agenda-bulk-marked-entries nil)
+ (org-agenda-bulk-remove-overlays (point-min) (point-max)))
+
+(defun org-agenda-bulk-action ()
+ "Execute an remote-editing action on all marked entries."
+ (interactive)
+ (unless org-agenda-bulk-marked-entries
+ (error "No entries are marked"))
+ (message "Bulk: [r]efile [$]archive [A]rch->sib [t]odo [+/-]tag [s]chedule [d]eadline")
+ (let* ((action (read-char-exclusive))
+ (entries (reverse org-agenda-bulk-marked-entries))
+ cmd rfloc state e tag pos (cnt 0) (cntskip 0))
+ (cond
+ ((equal action ?$)
+ (setq cmd '(org-agenda-archive)))
+
+ ((equal action ?A)
+ (setq cmd '(org-agenda-archive-to-archive-sibling)))
+
+ ((member action '(?r ?w))
+ (setq rfloc (org-refile-get-location
+ "Refile to: "
+ (marker-buffer (car org-agenda-bulk-marked-entries))
+ org-refile-allow-creating-parent-nodes))
+ (setcar (nthcdr 3 rfloc)
+ (move-marker (make-marker) (nth 3 rfloc)
+ (or (get-file-buffer (nth 1 rfloc))
+ (find-buffer-visiting (nth 1 rfloc))
+ (error "This should not happen"))))
+
+ (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc))))
+
+ ((equal action ?t)
+ (setq state (org-ido-completing-read
+ "Todo state: "
+ (with-current-buffer (marker-buffer (car entries))
+ (mapcar 'list org-todo-keywords-1))))
+ (setq cmd `(let ((org-inhibit-blocking t)
+ (org-inhibit-logging 'note))
+ (org-agenda-todo ,state))))
+
+ ((memq action '(?- ?+))
+ (setq tag (org-ido-completing-read
+ (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
+ (with-current-buffer (marker-buffer (car entries))
+ (delq nil
+ (mapcar (lambda (x)
+ (if (stringp (car x)) x)) org-tag-alist)))))
+ (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
+
+ ((memq action '(?s ?d))
+ (let* ((date (org-read-date
+ nil nil nil
+ (if (eq action ?s) "(Re)Schedule to" "Set Deadline to")))
+ (ans org-read-date-final-answer)
+ (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
+ (setq cmd `(let* ((bound (fboundp 'read-string))
+ (old (and bound (symbol-function 'read-string))))
+ (unwind-protect
+ (progn
+ (fset 'read-string (lambda (&rest ignore) ,ans))
+ (call-interactively ',c1))
+ (if bound
+ (fset 'read-string old)
+ (fmakunbound 'read-string)))))))
+ (t (error "Invalid bulk action")))
+
+ ;; Sort the markers, to make sure that parents are handled before children
+ (setq entries (sort entries
+ (lambda (a b)
+ (cond
+ ((equal (marker-buffer a) (marker-buffer b))
+ (< (marker-position a) (marker-position b)))
+ (t
+ (string< (buffer-name (marker-buffer a))
+ (buffer-name (marker-buffer b))))))))
+
+ ;; Now loop over all markers and apply cmd
+ (while (setq e (pop entries))
+ (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
+ (if (not pos)
+ (progn (message "Skipping removed entry at %s" e)
+ (setq cntskip (1+ cntskip)))
+ (goto-char pos)
+ (eval cmd)
+ (setq org-agenda-bulk-marked-entries
+ (delete e org-agenda-bulk-marked-entries))
+ (setq cnt (1+ cnt))))
+ (setq org-agenda-bulk-marked-entries nil)
+ (org-agenda-bulk-remove-all-marks)
+ (message "Acted on %d entries%s"
+ cnt
+ (if (= cntskip 0)
+ ""
+ (format ", skipped %d (disappeared before their turn)"
+ cntskip)))))
+
;;; Appointment reminders
(defvar appt-time-msg-list)
(org-deadline-warning-days 0)
(today (org-date-to-gregorian
(time-to-days (current-time))))
+ (org-agenda-restrict nil)
(files (org-agenda-files 'unrestricted)) entries file)
;; Get all entries which may contain an appt
(org-prepare-agenda-buffers files)
;; arch-tag: 77f7565d-7c4b-44af-a2df-9f6f7070cff1
;;; org-agenda.el ends here
-
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(require 'org)
+(declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
+
(defcustom org-archive-sibling-heading "Archive"
"Name of the local archive sibling that is used to archive entries locally.
Locally means: in the tree, under a sibling.
;; No specific heading, just go to end of file.
(goto-char (point-max)) (insert "\n"))
;; Paste
- (org-paste-subtree (org-get-valid-level level 1))
+ (org-paste-subtree (org-get-valid-level level (and heading 1)))
;; Mark the entry as done
(when (and org-archive-mark-done
;; Here we are back in the original buffer. Everything seems to have
;; worked. So now cut the tree and finish up.
(let (this-command) (org-cut-subtree))
+ (when (featurep 'org-inlinetask)
+ (org-inlinetask-remove-END-maybe))
(setq org-markers-to-move nil)
(message "Subtree archived %s"
(if (eq this-buffer buffer)
(concat "under heading: " heading)
(concat "in file: " (abbreviate-file-name afile))))))
- (org-reveal))
+ (org-reveal)
+ (if (looking-at "^[ \t]*$")
+ (outline-next-visible-heading 1)))
(defun org-archive-to-archive-sibling ()
"Archive the current heading by moving it under the archive sibling.
(hide-subtree)
(org-cycle-show-empty-lines 'folded)
(goto-char pos)))
- (org-reveal))
+ (org-reveal)
+ (if (looking-at "^[ \t]*$")
+ (outline-next-visible-heading 1)))
(defun org-archive-all-done (&optional tag)
"Archive sublevels of the current tree without open TODO items.
--- /dev/null
+;;; org-ascii.el --- ASCII export for Org-mode
+
+;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
+;; Free Software Foundation, Inc.
+
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+
+(require 'org-exp)
+
+(defgroup org-export-ascii nil
+ "Options specific for ASCII export of Org-mode files."
+ :tag "Org Export ASCII"
+ :group 'org-export)
+
+(defcustom org-export-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
+ "Characters for underlining headings in ASCII export.
+In the given sequence, these characters will be used for level 1, 2, ..."
+ :group 'org-export-ascii
+ :type '(repeat character))
+
+(defcustom org-export-ascii-bullets '(?* ?+ ?-)
+ "Bullet characters for headlines converted to lists in ASCII export.
+The first character is used for the first lest level generated in this
+way, and so on. If there are more levels than characters given here,
+the list will be repeated.
+Note that plain lists will keep the same bullets as the have in the
+Org-mode file."
+ :group 'org-export-ascii
+ :type '(repeat character))
+
+(defcustom org-export-ascii-links-to-notes t
+ "Non-nil means, convert links to notes before the next headline.
+When nil, the link will be exported in place. If the line becomes long
+in this way, it will be wrapped."
+ :group 'org-export-ascii
+ :type 'boolean)
+
+;;; ASCII export
+
+(defvar org-ascii-current-indentation nil) ; For communication
+
+;;;###autoload
+(defun org-export-as-ascii-to-buffer (arg)
+ "Call `org-export-as-ascii` with output to a temporary buffer.
+No file is created. The prefix ARG is passed through to `org-export-as-ascii'."
+ (interactive "P")
+ (org-export-as-ascii arg nil nil "*Org ASCII Export*")
+ (when org-export-show-temporary-export-buffer
+ (switch-to-buffer-other-window "*Org ASCII Export*")))
+
+;;;###autoload
+(defun org-replace-region-by-ascii (beg end)
+ "Assume the current region has org-mode syntax, and convert it to plain ASCII.
+This can be used in any buffer. For example, you could write an
+itemized list in org-mode syntax in a Mail buffer and then use this
+command to convert it."
+ (interactive "r")
+ (let (reg ascii buf pop-up-frames)
+ (save-window-excursion
+ (if (org-mode-p)
+ (setq ascii (org-export-region-as-ascii
+ beg end t 'string))
+ (setq reg (buffer-substring beg end)
+ buf (get-buffer-create "*Org tmp*"))
+ (with-current-buffer buf
+ (erase-buffer)
+ (insert reg)
+ (org-mode)
+ (setq ascii (org-export-region-as-ascii
+ (point-min) (point-max) t 'string)))
+ (kill-buffer buf)))
+ (delete-region beg end)
+ (insert ascii)))
+
+;;;###autoload
+(defun org-export-region-as-ascii (beg end &optional body-only buffer)
+ "Convert region from BEG to END in org-mode buffer to plain ASCII.
+If prefix arg BODY-ONLY is set, omit file header, footer, and table of
+contents, and only produce the region of converted text, useful for
+cut-and-paste operations.
+If BUFFER is a buffer or a string, use/create that buffer as a target
+of the converted ASCII. If BUFFER is the symbol `string', return the
+produced ASCII as a string and leave not buffer behind. For example,
+a Lisp program could call this function in the following way:
+
+ (setq ascii (org-export-region-as-ascii beg end t 'string))
+
+When called interactively, the output buffer is selected, and shown
+in a window. A non-interactive call will only return the buffer."
+ (interactive "r\nP")
+ (when (interactive-p)
+ (setq buffer "*Org ASCII Export*"))
+ (let ((transient-mark-mode t) (zmacs-regions t)
+ ext-plist rtn)
+ (setq ext-plist (plist-put ext-plist :ignore-subree-p t))
+ (goto-char end)
+ (set-mark (point)) ;; to activate the region
+ (goto-char beg)
+ (setq rtn (org-export-as-ascii
+ nil nil ext-plist
+ buffer body-only))
+ (if (fboundp 'deactivate-mark) (deactivate-mark))
+ (if (and (interactive-p) (bufferp rtn))
+ (switch-to-buffer-other-window rtn)
+ rtn)))
+
+;;;###autoload
+(defun org-export-as-ascii (arg &optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Export the outline as a pretty ASCII file.
+If there is an active region, export only the region.
+The prefix ARG specifies how many levels of the outline should become
+underlined headlines, default is 3. Lower levels will become bulleted
+lists. When HIDDEN is non-nil, don't display the ASCII buffer.
+EXT-PLIST is a property list with external parameters overriding
+org-mode's default settings, but still inferior to file-local
+settings. When TO-BUFFER is non-nil, create a buffer with that
+name and export to that buffer. If TO-BUFFER is the symbol
+`string', don't leave any buffer behind but just return the
+resulting ASCII as a string. When BODY-ONLY is set, don't produce
+the file header and footer. When PUB-DIR is set, use this as the
+publishing directory."
+ (interactive "P")
+ (setq-default org-todo-line-regexp org-todo-line-regexp)
+ (let* ((opt-plist (org-combine-plists (org-default-export-plist)
+ ext-plist
+ (org-infile-export-plist)))
+ (region-p (org-region-active-p))
+ (rbeg (and region-p (region-beginning)))
+ (rend (and region-p (region-end)))
+ (subtree-p
+ (if (plist-get opt-plist :ignore-subree-p)
+ nil
+ (when region-p
+ (save-excursion
+ (goto-char rbeg)
+ (and (org-at-heading-p)
+ (>= (org-end-of-subtree t t) rend))))))
+ (level-offset (if subtree-p
+ (save-excursion
+ (goto-char rbeg)
+ (+ (funcall outline-level)
+ (if org-odd-levels-only 1 0)))
+ 0))
+ (opt-plist (setq org-export-opt-plist
+ (if subtree-p
+ (org-export-add-subtree-options opt-plist rbeg)
+ opt-plist)))
+ (custom-times org-display-custom-times)
+ (org-ascii-current-indentation '(0 . 0))
+ (level 0) line txt
+ (umax nil)
+ (umax-toc nil)
+ (case-fold-search nil)
+ (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
+ (filename (if to-buffer
+ nil
+ (concat (file-name-as-directory
+ (or pub-dir
+ (org-export-directory :ascii opt-plist)))
+ (file-name-sans-extension
+ (or (and subtree-p
+ (org-entry-get (region-beginning)
+ "EXPORT_FILE_NAME" t))
+ (file-name-nondirectory bfname)))
+ ".txt")))
+ (filename (and filename
+ (if (equal (file-truename filename)
+ (file-truename bfname))
+ (concat filename ".txt")
+ filename)))
+ (buffer (if to-buffer
+ (cond
+ ((eq to-buffer 'string)
+ (get-buffer-create "*Org ASCII Export*"))
+ (t (get-buffer-create to-buffer)))
+ (find-file-noselect filename)))
+ (org-levels-open (make-vector org-level-max nil))
+ (odd org-odd-levels-only)
+ (date (plist-get opt-plist :date))
+ (author (plist-get opt-plist :author))
+ (title (or (and subtree-p (org-export-get-title-from-subtree))
+ (plist-get opt-plist :title)
+ (and (not
+ (plist-get opt-plist :skip-before-1st-heading))
+ (org-export-grab-title-from-buffer))
+ (file-name-sans-extension
+ (file-name-nondirectory bfname))))
+ (email (plist-get opt-plist :email))
+ (language (plist-get opt-plist :language))
+ (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
+ (todo nil)
+ (lang-words nil)
+ (region
+ (buffer-substring
+ (if (org-region-active-p) (region-beginning) (point-min))
+ (if (org-region-active-p) (region-end) (point-max))))
+ (lines (org-split-string
+ (org-export-preprocess-string
+ region
+ :for-ascii t
+ :skip-before-1st-heading
+ (plist-get opt-plist :skip-before-1st-heading)
+ :drawers (plist-get opt-plist :drawers)
+ :tags (plist-get opt-plist :tags)
+ :priority (plist-get opt-plist :priority)
+ :footnotes (plist-get opt-plist :footnotes)
+ :timestamps (plist-get opt-plist :timestamps)
+ :todo-keywords (plist-get opt-plist :todo-keywords)
+ :verbatim-multiline t
+ :select-tags (plist-get opt-plist :select-tags)
+ :exclude-tags (plist-get opt-plist :exclude-tags)
+ :archived-trees
+ (plist-get opt-plist :archived-trees)
+ :add-text (plist-get opt-plist :text))
+ "\n"))
+ thetoc have-headings first-heading-pos
+ table-open table-buffer link-buffer link desc desc0 rpl wrap)
+ (let ((inhibit-read-only t))
+ (org-unmodified
+ (remove-text-properties (point-min) (point-max)
+ '(:org-license-to-kill t))))
+
+ (setq org-min-level (org-get-min-level lines level-offset))
+ (setq org-last-level org-min-level)
+ (org-init-section-numbers)
+ (setq lang-words (or (assoc language org-export-language-setup)
+ (assoc "en" org-export-language-setup)))
+ (set-buffer buffer)
+ (erase-buffer)
+ (fundamental-mode)
+ (org-install-letbind)
+ ;; create local variables for all options, to make sure all called
+ ;; functions get the correct information
+ (mapc (lambda (x)
+ (set (make-local-variable (nth 2 x))
+ (plist-get opt-plist (car x))))
+ org-export-plist-vars)
+ (org-set-local 'org-odd-levels-only odd)
+ (setq umax (if arg (prefix-numeric-value arg)
+ org-export-headline-levels))
+ (setq umax-toc (if (integerp org-export-with-toc)
+ (min org-export-with-toc umax)
+ umax))
+
+ ;; File header
+ (unless body-only
+ (if title (org-insert-centered title ?=))
+ (insert "\n")
+ (if (and (or author email)
+ org-export-author-info)
+ (insert (concat (nth 1 lang-words) ": " (or author "")
+ (if email (concat " <" email ">") "")
+ "\n")))
+
+ (cond
+ ((and date (string-match "%" date))
+ (setq date (format-time-string date)))
+ (date)
+ (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
+
+ (if (and date org-export-time-stamp-file)
+ (insert (concat (nth 2 lang-words) ": " date"\n")))
+
+ (insert "\n\n"))
+
+ (if (and org-export-with-toc (not body-only))
+ (progn
+ (push (concat (nth 3 lang-words) "\n") thetoc)
+ (push (concat (make-string (string-width (nth 3 lang-words)) ?=)
+ "\n") thetoc)
+ (mapc '(lambda (line)
+ (if (string-match org-todo-line-regexp
+ line)
+ ;; This is a headline
+ (progn
+ (setq have-headings t)
+ (setq level (- (match-end 1) (match-beginning 1)
+ level-offset)
+ level (org-tr-level level)
+ txt (match-string 3 line)
+ todo
+ (or (and org-export-mark-todo-in-toc
+ (match-beginning 2)
+ (not (member (match-string 2 line)
+ org-done-keywords)))
+ ; TODO, not DONE
+ (and org-export-mark-todo-in-toc
+ (= level umax-toc)
+ (org-search-todo-below
+ line lines level))))
+ (setq txt (org-html-expand-for-ascii txt))
+
+ (while (string-match org-bracket-link-regexp txt)
+ (setq txt
+ (replace-match
+ (match-string (if (match-end 2) 3 1) txt)
+ t t txt)))
+
+ (if (and (memq org-export-with-tags '(not-in-toc nil))
+ (string-match
+ (org-re "[ \t]+:[[:alnum:]_@:]+:[ \t]*$")
+ txt))
+ (setq txt (replace-match "" t t txt)))
+ (if (string-match quote-re0 txt)
+ (setq txt (replace-match "" t t txt)))
+
+ (if org-export-with-section-numbers
+ (setq txt (concat (org-section-number level)
+ " " txt)))
+ (if (<= level umax-toc)
+ (progn
+ (push
+ (concat
+ (make-string
+ (* (max 0 (- level org-min-level)) 4) ?\ )
+ (format (if todo "%s (*)\n" "%s\n") txt))
+ thetoc)
+ (setq org-last-level level))
+ ))))
+ lines)
+ (setq thetoc (if have-headings (nreverse thetoc) nil))))
+
+ (org-init-section-numbers)
+ (while (setq line (pop lines))
+ (when (and link-buffer (string-match "^\\*+ " line))
+ (org-export-ascii-push-links (nreverse link-buffer))
+ (setq link-buffer nil))
+ (setq wrap nil)
+ ;; Remove the quoted HTML tags.
+ (setq line (org-html-expand-for-ascii line))
+ ;; Replace links with the description when possible
+ (while (string-match org-bracket-link-regexp line)
+ (setq link (match-string 1 line)
+ desc0 (match-string 3 line)
+ desc (or desc0 (match-string 1 line)))
+ (if (and (> (length link) 8)
+ (equal (substring link 0 8) "coderef:"))
+ (setq line (replace-match
+ (format (org-export-get-coderef-format (substring link 8) desc)
+ (cdr (assoc
+ (substring link 8)
+ org-export-code-refs)))
+ t t line))
+ (setq rpl (concat "["
+ (or (match-string 3 line) (match-string 1 line))
+ "]"))
+ (when (and desc0 (not (equal desc0 link)))
+ (if org-export-ascii-links-to-notes
+ (push (cons desc0 link) link-buffer)
+ (setq rpl (concat rpl " (" link ")")
+ wrap (+ (length line) (- (length (match-string 0 line)))
+ (length desc)))))
+ (setq line (replace-match rpl t t line))))
+ (when custom-times
+ (setq line (org-translate-time line)))
+ (cond
+ ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
+ ;; a Headline
+ (setq first-heading-pos (or first-heading-pos (point)))
+ (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
+ level-offset))
+ txt (match-string 2 line))
+ (org-ascii-level-start level txt umax lines))
+
+ ((and org-export-with-tables
+ (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
+ (if (not table-open)
+ ;; New table starts
+ (setq table-open t table-buffer nil))
+ ;; Accumulate lines
+ (setq table-buffer (cons line table-buffer))
+ (when (or (not lines)
+ (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
+ (car lines))))
+ (setq table-open nil
+ table-buffer (nreverse table-buffer))
+ (insert (mapconcat
+ (lambda (x)
+ (org-fix-indentation x org-ascii-current-indentation))
+ (org-format-table-ascii table-buffer)
+ "\n") "\n")))
+ (t
+ (if (string-match "^\\([ \t]*\\)\\([-+*][ \t]+\\)\\(.*?\\)\\( ::\\)" line)
+ (setq line (replace-match "\\1\\3:" t nil line)))
+ (setq line (org-fix-indentation line org-ascii-current-indentation))
+ ;; Remove forced line breaks
+ (if (string-match "\\\\\\\\[ \t]*$" line)
+ (setq line (replace-match "" t t line)))
+ (if (and org-export-with-fixed-width
+ (string-match "^\\([ \t]*\\)\\(:\\( \\|$\\)\\)" line))
+ (setq line (replace-match "\\1" nil nil line))
+ (if wrap (setq line (org-export-ascii-wrap line wrap))))
+ (insert line "\n"))))
+
+ (org-export-ascii-push-links (nreverse link-buffer))
+
+ (normal-mode)
+
+ ;; insert the table of contents
+ (when thetoc
+ (goto-char (point-min))
+ (if (re-search-forward "^[ \t]*\\[TABLE-OF-CONTENTS\\][ \t]*$" nil t)
+ (progn
+ (goto-char (match-beginning 0))
+ (replace-match ""))
+ (goto-char first-heading-pos))
+ (mapc 'insert thetoc)
+ (or (looking-at "[ \t]*\n[ \t]*\n")
+ (insert "\n\n")))
+
+ ;; Convert whitespace place holders
+ (goto-char (point-min))
+ (let (beg end)
+ (while (setq beg (next-single-property-change (point) 'org-whitespace))
+ (setq end (next-single-property-change beg 'org-whitespace))
+ (goto-char beg)
+ (delete-region beg end)
+ (insert (make-string (- end beg) ?\ ))))
+
+ ;; remove display and invisible chars
+ (let (beg end)
+ (goto-char (point-min))
+ (while (setq beg (next-single-property-change (point) 'display))
+ (setq end (next-single-property-change beg 'display))
+ (delete-region beg end)
+ (goto-char beg)
+ (insert "=>"))
+ (goto-char (point-min))
+ (while (setq beg (next-single-property-change (point) 'org-cwidth))
+ (setq end (next-single-property-change beg 'org-cwidth))
+ (delete-region beg end)
+ (goto-char beg)))
+ (or to-buffer (save-buffer))
+ (goto-char (point-min))
+ (or (org-export-push-to-kill-ring "ASCII")
+ (message "Exporting... done"))
+ ;; Return the buffer or a string, according to how this function was called
+ (if (eq to-buffer 'string)
+ (prog1 (buffer-substring (point-min) (point-max))
+ (kill-buffer (current-buffer)))
+ (current-buffer))))
+
+(defun org-export-ascii-preprocess (parameters)
+ "Do extra work for ASCII export"
+ ;; Put quotes around verbatim text
+ (goto-char (point-min))
+ (while (re-search-forward org-verbatim-re nil t)
+ (goto-char (match-end 2))
+ (backward-delete-char 1) (insert "'")
+ (goto-char (match-beginning 2))
+ (delete-char 1) (insert "`")
+ (goto-char (match-end 2)))
+ ;; Remove target markers
+ (goto-char (point-min))
+ (while (re-search-forward "<<<?\\([^<>]*\\)>>>?\\([ \t]*\\)" nil t)
+ (replace-match "\\1\\2")))
+
+(defun org-html-expand-for-ascii (line)
+ "Handle quoted HTML for ASCII export."
+ (if org-export-html-expand
+ (while (string-match "@<[^<>\n]*>" line)
+ ;; We just remove the tags for now.
+ (setq line (replace-match "" nil nil line))))
+ line)
+
+(defun org-export-ascii-wrap (line where)
+ "Wrap LINE at or before WHERE."
+ (let ((ind (org-get-indentation line))
+ pos)
+ (catch 'found
+ (loop for i from where downto (/ where 2) do
+ (and (equal (aref line i) ?\ )
+ (setq pos i)
+ (throw 'found t))))
+ (if pos
+ (concat (substring line 0 pos) "\n"
+ (make-string ind ?\ )
+ (substring line (1+ pos)))
+ line)))
+
+(defun org-export-ascii-push-links (link-buffer)
+ "Push out links in the buffer."
+ (when link-buffer
+ ;; We still have links to push out.
+ (insert "\n")
+ (let ((ind ""))
+ (save-match-data
+ (if (save-excursion
+ (re-search-backward
+ "^\\(\\([ \t]*\\)\\|\\(\\*+ \\)\\)[^ \t\n]" nil t))
+ (setq ind (or (match-string 2)
+ (make-string (length (match-string 3)) ?\ )))))
+ (mapc (lambda (x) (insert ind "[" (car x) "]: " (cdr x) "\n"))
+ link-buffer))
+ (insert "\n")))
+
+(defun org-ascii-level-start (level title umax &optional lines)
+ "Insert a new level in ASCII export."
+ (let (char (n (- level umax 1)) (ind 0))
+ (if (> level umax)
+ (progn
+ (insert (make-string (* 2 n) ?\ )
+ (char-to-string (nth (% n (length org-export-ascii-bullets))
+ org-export-ascii-bullets))
+ " " title "\n")
+ ;; find the indentation of the next non-empty line
+ (catch 'stop
+ (while lines
+ (if (string-match "^\\* " (car lines)) (throw 'stop nil))
+ (if (string-match "^\\([ \t]*\\)\\S-" (car lines))
+ (throw 'stop (setq ind (org-get-indentation (car lines)))))
+ (pop lines)))
+ (setq org-ascii-current-indentation (cons (* 2 (1+ n)) ind)))
+ (if (or (not (equal (char-before) ?\n))
+ (not (equal (char-before (1- (point))) ?\n)))
+ (insert "\n"))
+ (setq char (nth (- umax level) (reverse org-export-ascii-underline)))
+ (unless org-export-with-tags
+ (if (string-match (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
+ (setq title (replace-match "" t t title))))
+ (if org-export-with-section-numbers
+ (setq title (concat (org-section-number level) " " title)))
+ (insert title "\n" (make-string (string-width title) char) "\n")
+ (setq org-ascii-current-indentation '(0 . 0)))))
+
+(defun org-insert-centered (s &optional underline)
+ "Insert the string S centered and underline it with character UNDERLINE."
+ (let ((ind (max (/ (- fill-column (string-width s)) 2) 0)))
+ (insert (make-string ind ?\ ) s "\n")
+ (if underline
+ (insert (make-string ind ?\ )
+ (make-string (string-width s) underline)
+ "\n"))))
+
+(defvar org-table-colgroup-info nil)
+(defun org-format-table-ascii (lines)
+ "Format a table for ascii export."
+ (if (stringp lines)
+ (setq lines (org-split-string lines "\n")))
+ (if (not (string-match "^[ \t]*|" (car lines)))
+ ;; Table made by table.el - test for spanning
+ lines
+
+ ;; A normal org table
+ ;; Get rid of hlines at beginning and end
+ (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
+ (setq lines (nreverse lines))
+ (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
+ (setq lines (nreverse lines))
+ (when org-export-table-remove-special-lines
+ ;; Check if the table has a marking column. If yes remove the
+ ;; column and the special lines
+ (setq lines (org-table-clean-before-export lines)))
+ ;; Get rid of the vertical lines except for grouping
+ (let ((vl (org-colgroup-info-to-vline-list org-table-colgroup-info))
+ rtn line vl1 start)
+ (while (setq line (pop lines))
+ (if (string-match org-table-hline-regexp line)
+ (and (string-match "|\\(.*\\)|" line)
+ (setq line (replace-match " \\1" t nil line)))
+ (setq start 0 vl1 vl)
+ (while (string-match "|" line start)
+ (setq start (match-end 0))
+ (or (pop vl1) (setq line (replace-match " " t t line)))))
+ (push line rtn))
+ (nreverse rtn))))
+
+(defun org-colgroup-info-to-vline-list (info)
+ (let (vl new last)
+ (while info
+ (setq last new new (pop info))
+ (if (or (memq last '(:end :startend))
+ (memq new '(:start :startend)))
+ (push t vl)
+ (push nil vl)))
+ (setq vl (nreverse vl))
+ (and vl (setcar vl nil))
+ vl))
+
+(provide 'org-ascii)
+
+;; arch-tag: aa96f882-f477-4e13-86f5-70d43e7adf3c
+
+;;; org-ascii.el ends here
;; Author: John Wiegley <johnw@newartisans.com>
;; Keywords: org data task
-;; Version: 6.21b
+;; Version: 6.29c
;; This file is part of GNU Emacs.
;;
;; See the Org-mode manual for information on how to use it.
;;
;; Attachments are managed in a special directory called "data", which
-;; lives in the directory given by `org-directory'. If this data
+;; lives in the same directory as the org file itself. If this data
;; directory is initialized as a Git repository, then org-attach will
;; automatically commit changes when it sees them.
;;
"Non-nil means, allow attachment directories be inherited."
:group 'org-attach
:type 'boolean)
-
+
(defvar org-attach-inherited nil
"Indicates if the last access to the attachment directory was inherited.")
;; Thomas Baumann <thomas dot baumann at ch dot tum dot de>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;; %%(org-bbdb-anniversaries)
;;
;;
-;; The anniversaries are stored in BBDB in the field `anniversary'
-;; in the format
+;; To add an anniversary to a BBDB record, press `C-o' in the record.
+;; You will be prompted for the field name, in this case it must be
+;; "anniversary". If this is the first time you are using this field,
+;; you need to confirm that it should be created.
;;
-;; YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}*
-;; {\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}*
+;; The format of an anniversary field stored in BBDB is the following
+;; (items in {} are optional):
+;;
+;; YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}
+;; {\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}...
;;
;; CLASS-OR-FORMAT-STRING is one of two things:
;;
-;; * an identifier for a class of anniversaries (eg. birthday or
-;; wedding) from `org-bbdb-anniversary-format-alist'.
-;; * the (format) string displayed in the diary.
+;; - an identifier for a class of anniversaries (eg. birthday or
+;; wedding) from `org-bbdb-anniversary-format-alist' which then
+;; defines the format tring for this class
+;; - the (format) string displayed in the diary.
+;;
+;; You can enter multiple anniversaries for a single BBDB record by
+;; separating them with a newline character. At the BBDB prompt for
+;; the field value, type `C-q C-j' to enter a newline between two
+;; anniversaries.
;;
-;; It defaults to the value of `org-bbdb-default-anniversary-format'
-;; ("birthday" by default).
+;; If you omit the CLASS-OR-FORMAT-STRING entirely, it defaults to the
+;; value of `org-bbdb-default-anniversary-format' ("birthday" by
+;; default).
;;
;; The substitutions in the format string are (in order):
-;; * the name of the record containing this anniversary
-;; * the number of years
-;; * an ordinal suffix (st, nd, rd, th) for the year
+;; - the name of the record containing this anniversary
+;; - the number of years
+;; - an ordinal suffix (st, nd, rd, th) for the year
;;
;; See the documentation of `org-bbdb-anniversary-format-alist' for
;; further options.
(declare-function bbdb-current-record "ext:bbdb-com"
(&optional planning-on-modifying))
(declare-function bbdb-name "ext:bbdb-com" (string elidep))
+(declare-function bbdb-completing-read-record "ext:bbdb-com"
+ (prompt &optional omit-records))
(declare-function bbdb-record-getprop "ext:bbdb" (record property))
(declare-function bbdb-record-name "ext:bbdb" (record))
(declare-function bbdb-records "ext:bbdb"
(&optional dont-check-disk already-in-db-buffer))
(declare-function bbdb-split "ext:bbdb" (string separators))
(declare-function bbdb-string-trim "ext:bbdb" (string))
+
(declare-function calendar-leap-year-p "calendar" (year))
(declare-function diary-ordinal-suffix "diary-lib" (n))
(when text
(mapconcat 'identity text "; "))))
+(defun org-bbdb-complete-link ()
+ "Read a bbdb link with name completion."
+ (require 'bbdb-com)
+ (concat "bbdb:"
+ (bbdb-record-name (car (bbdb-completing-read-record "Name: ")))))
+
+(defun org-bbdb-anniv-export-ical ()
+ "Extract anniversaries from BBDB and convert them to icalendar format."
+ (require 'bbdb)
+ (require 'diary-lib)
+ (unless (hash-table-p org-bbdb-anniv-hash)
+ (setq org-bbdb-anniv-hash
+ (make-hash-table :test 'equal :size 366)))
+ (when (or org-bbdb-updated-p
+ (= 0 (hash-table-count org-bbdb-anniv-hash)))
+ (org-bbdb-make-anniv-hash))
+ (maphash 'org-bbdb-format-vevent org-bbdb-anniv-hash))
+
+(defun org-bbdb-format-vevent (key recs)
+ (let (rec categ)
+ (while (setq rec (pop recs))
+ (setq categ (or (nth 2 rec) org-bbdb-default-anniversary-format))
+ (princ (format "BEGIN:VEVENT
+UID: ANNIV-%4i%02i%02i-%s
+DTSTART:%4i%02i%02i
+SUMMARY:%s
+DESCRIPTION:%s
+CATEGORIES:%s
+RRULE:FREQ=YEARLY
+END:VEVENT\n"
+ (nth 0 rec) (nth 0 key) (nth 1 key)
+ (mapconcat 'identity
+ (org-split-string (nth 1 rec) "[^a-zA-Z0-90]+")
+ "-")
+ (nth 0 rec) (nth 0 key) (nth 1 key)
+ (nth 1 rec)
+ (concat (capitalize categ) " " (nth 1 rec))
+ categ)))))
+
(provide 'org-bbdb)
;; arch-tag: 9e4f275d-d080-48c1-b040-62247f66b5c2
;; Author: Bastien Guerry <bzg at altern dot org>
;; Carsten Dominik <carsten dot dominik at gmail dot com>
;; Keywords: org, wp, remember
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
:tag "Org Clock"
:group 'org-progress)
-(defcustom org-clock-into-drawer 2
+(defcustom org-clock-into-drawer org-log-into-drawer
"Should clocking info be wrapped into a drawer?
-When t, clocking info will always be inserted into a :CLOCK: drawer.
+When t, clocking info will always be inserted into a :LOGBOOK: drawer.
If necessary, the drawer will be created.
When nil, the drawer will not be created, but used when present.
When an integer and the number of clocking entries in an item
-reaches or exceeds this number, a drawer will be created."
+reaches or exceeds this number, a drawer will be created.
+When a string, it names the drawer to be used.
+
+The default for this variable is the value of `org-log-into-drawer',
+which see."
:group 'org-todo
:group 'org-clock
:type '(choice
(const :tag "Always" t)
(const :tag "Only when drawer exists" nil)
- (integer :tag "When at least N clock entries")))
+ (integer :tag "When at least N clock entries")
+ (const :tag "Into LOGBOOK drawer" "LOGBOOK")
+ (string :tag "Into Drawer named...")))
(defcustom org-clock-out-when-done t
- "When non-nil, the clock will be stopped when the relevant entry is marked DONE.
+ "When non-nil, clock will be stopped when the clocked entry is marked DONE.
A nil value means, clock will keep running until stopped explicitly with
`C-c C-x C-o', or until the clock is started in a different item."
:group 'org-clock
(string :tag "State")
(symbol :tag "Function")))
+(defcustom org-clock-out-switch-to-state nil
+ "Set task to a special todo state after clocking out.
+The value should be the state to which the entry should be
+switched. If the value is a function, it must take one
+parameter (the current TODO state of the item) and return the
+state to switch it to."
+ :group 'org-clock
+ :group 'org-todo
+ :type '(choice
+ (const :tag "Don't force a state" nil)
+ (string :tag "State")
+ (symbol :tag "Function")))
+
(defcustom org-clock-history-length 5
"Number of clock tasks to remember in history."
:group 'org-clock
:type 'integer)
+(defcustom org-clock-goto-may-find-recent-task t
+ "Non-nil means, `org-clock-goto' can go to recent task if no active clock."
+ :group 'org-clock
+ :type 'boolean)
+
(defcustom org-clock-heading-function nil
"When non-nil, should be a function to create `org-clock-heading'.
This is the string shown in the mode line when a clock is running.
:type 'function)
(defcustom org-clock-string-limit 0
- "Maximum length of clock strings in the modeline. 0 means no limit"
+ "Maximum length of clock strings in the modeline. 0 means no limit."
:group 'org-clock
:type 'integer)
(defcustom org-clock-in-resume nil
- "If non-nil, when clocking into a task with a clock entry which
-has not been closed, resume the clock from that point"
+ "If non-nil, resume clock when clocking into task with open clock.
+When clocking into a task with a clock entry which has not been closed,
+the clock can be resumed from that point."
:group 'org-clock
:type 'boolean)
(defcustom org-clock-persist nil
- "When non-nil, save the running clock when emacs is closed, and
- resume it next time emacs is started.
+ "When non-nil, save the running clock when emacs is closed.
+The clock is resumed when emacs restarts.
When this is t, both the running clock, and the entire clock
history are saved. When this is the symbol `clock', only the
running clock is saved.
When Emacs restarts with saved clock information, the file containing the
running clock as well as all files mentioned in the clock history will
-be visited."
+be visited.
+All this depends on running `org-clock-persistence-insinuate' in .emacs"
:group 'org-clock
:type '(choice
(const :tag "Just the running clock" clock)
(defcustom org-clock-persist-file (convert-standard-filename
"~/.emacs.d/org-clock-save.el")
- "File to save clock data to"
+ "File to save clock data to."
:group 'org-clock
:type 'string)
(defcustom org-clock-persist-query-save nil
- "When non-nil, ask before saving the current clock on exit"
+ "When non-nil, ask before saving the current clock on exit."
:group 'org-clock
:type 'boolean)
(defcustom org-clock-persist-query-resume t
- "When non-nil, ask before resuming any stored clock during
-load."
+ "When non-nil, ask before resuming any stored clock during load."
:group 'org-clock
:type 'boolean)
+(defcustom org-clock-sound nil
+ "Sound that will used for notifications.
+Possible values:
+
+nil no sound played.
+t standard Emacs beep
+file name play this sound file. If not possible, fall back to beep"
+ :group 'org-clock
+ :type '(choice
+ (const :tag "No sound" nil)
+ (const :tag "Standard beep" t)
+ (file :tag "Play sound file")))
+
+(defcustom org-clock-modeline-total 'auto
+ "Default setting for the time included for the modeline clock.
+This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
+Allowed values are:
+
+current Only the time in the current instance of the clock
+today All time clocked inot this task today
+repeat All time clocked into this task since last repeat
+all All time ever recorded for this task
+auto Automtically, either `all', or `repeat' for repeating tasks"
+ :group 'org-clock
+ :type '(choice
+ (const :tag "Current clock" current)
+ (const :tag "Today's task time" today)
+ (const :tag "Since last repeat" repeat)
+ (const :tag "All task time" all)
+ (const :tag "Automatically, `all' or since `repeat'" auto)))
+
+(defcustom org-show-notification-handler nil
+ "Function or program to send notification with.
+The function or program will be called with the notification
+string as argument."
+ :group 'org-clock
+ :type '(choice
+ (string :tag "Program")
+ (function :tag "Function")))
+
+(defvar org-clock-in-prepare-hook nil
+ "Hook run when preparing the clock.
+This hook is run before anything happens to the task that
+you want to clock in. For example, you can use this hook
+to add an effort property.")
+(defvar org-clock-in-hook nil
+ "Hook run when starting the clock.")
+(defvar org-clock-out-hook nil
+ "Hook run when stopping the current clock.")
+
+(defvar org-clock-cancel-hook nil
+ "Hook run when cancelling the current clock.")
+(defvar org-clock-goto-hook nil
+ "Hook run when selecting the currently clocked-in entry.")
+
;;; The clock for measuring work time.
(defvar org-mode-line-string "")
(defvar org-clock-heading-for-remember "")
(defvar org-clock-start-time "")
+(defvar org-clock-effort ""
+ "Effort estimate of the currently clocking task")
+
+(defvar org-clock-total-time nil
+ "Holds total time, spent previously on currently clocked item.
+This does not include the time in the currently running clock.")
+
(defvar org-clock-history nil
"List of marker pointing to recent clocked tasks.")
(defvar org-clock-mode-line-map (make-sparse-keymap))
(define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
+(define-key org-clock-mode-line-map [mode-line mouse-1] 'org-clock-menu)
+
+(defun org-clock-menu ()
+ (interactive)
+ (popup-menu
+ '("Clock"
+ ["Clock out" org-clock-out t]
+ ["Change effort estimate" org-clock-modify-effort-estimate t]
+ ["Go to clock entry" org-clock-goto t]
+ ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"])))
(defun org-clock-history-push (&optional pos buffer)
"Push a marker to the clock history."
(t (error "Invalid task choice %c" rpl))))))
(defun org-clock-insert-selection-line (i marker)
+ "Insert a line for the clock selection menu.
+And return a cons cell with the selection character integer and the marker
+pointing to it."
(when (marker-buffer marker)
- (let (file cat task)
+ (let (file cat task heading prefix)
(with-current-buffer (org-base-buffer (marker-buffer marker))
(save-excursion
(save-restriction
cat (or (org-get-category)
(progn (org-refresh-category-properties)
(org-get-category)))
- task (org-get-heading 'notags)))))
+ heading (org-get-heading 'notags)
+ prefix (save-excursion
+ (org-back-to-heading t)
+ (looking-at "\\*+ ")
+ (match-string 0))
+ task (substring
+ (org-fontify-like-in-org-mode
+ (concat prefix heading)
+ org-odd-levels-only)
+ (length prefix))))))
(when (and cat task)
(insert (format "[%c] %-15s %s\n" i cat task))
(cons i marker)))))
+(defun org-clock-get-clock-string ()
+ "Form a clock-string, that will be show in the mode line.
+If an effort estimate was defined for current item, use
+01:30/01:50 format (clocked/estimated).
+If not, show simply the clocked time like 01:50."
+ (let* ((clocked-time (org-clock-get-clocked-time))
+ (h (floor clocked-time 60))
+ (m (- clocked-time (* 60 h))))
+ (if (and org-clock-effort)
+ (let* ((effort-in-minutes (org-hh:mm-string-to-minutes org-clock-effort))
+ (effort-h (floor effort-in-minutes 60))
+ (effort-m (- effort-in-minutes (* effort-h 60))))
+ (format (concat "-[" org-time-clocksum-format "/" org-time-clocksum-format " (%s)]")
+ h m effort-h effort-m org-clock-heading))
+ (format (concat "-[" org-time-clocksum-format " (%s)]")
+ h m org-clock-heading))))
+
(defun org-clock-update-mode-line ()
- (let* ((delta (- (time-to-seconds (current-time))
- (time-to-seconds org-clock-start-time)))
- (h (floor delta 3600))
- (m (floor (- delta (* 3600 h)) 60)))
- (setq org-mode-line-string
- (org-propertize
- (let ((clock-string (format (concat "-[" org-time-clocksum-format " (%s)]")
- h m org-clock-heading))
- (help-text "Org-mode clock is running. Mouse-2 to go there."))
- (if (and (> org-clock-string-limit 0)
- (> (length clock-string) org-clock-string-limit))
- (org-propertize (substring clock-string 0 org-clock-string-limit)
- 'help-echo (concat help-text ": " org-clock-heading))
- (org-propertize clock-string 'help-echo help-text)))
- 'local-map org-clock-mode-line-map
- 'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)))
- (force-mode-line-update)))
+ (setq org-mode-line-string
+ (org-propertize
+ (let ((clock-string (org-clock-get-clock-string))
+ (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
+ (if (and (> org-clock-string-limit 0)
+ (> (length clock-string) org-clock-string-limit))
+ (org-propertize (substring clock-string 0 org-clock-string-limit)
+ 'help-echo (concat help-text ": " org-clock-heading))
+ (org-propertize clock-string 'help-echo help-text)))
+ 'local-map org-clock-mode-line-map
+ 'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)
+ 'face 'org-mode-line-clock))
+ (if org-clock-effort (org-clock-notify-once-if-expired))
+ (force-mode-line-update))
+
+(defun org-clock-get-clocked-time ()
+ "Get the clocked time for the current item in minutes.
+The time returned includes the the time spent on this task in
+previous clocking intervals."
+ (let ((currently-clocked-time
+ (floor (- (time-to-seconds (current-time))
+ (time-to-seconds org-clock-start-time)) 60)))
+ (+ currently-clocked-time (or org-clock-total-time 0))))
+
+(defun org-clock-modify-effort-estimate (&optional value)
+ "Add to or set the effort estimate of the item currently being clocked.
+VALUE can be a number of minutes, or a string with forat hh:mm or mm.
+WHen the strig starts with a + or a - sign, the current value of the effort
+property will be changed by that amount.
+This will update the \"Effort\" property of currently clocked item, and
+the mode line."
+ (interactive)
+ (when (org-clock-is-active)
+ (let ((current org-clock-effort) sign)
+ (unless value
+ ;; Prompt user for a value or a change
+ (setq value
+ (read-string
+ (format "Set effort (hh:mm or mm%s): "
+ (if current
+ (format ", prefix + to add to %s" org-clock-effort)
+ "")))))
+ (when (stringp value)
+ ;; A string. See if it is a delta
+ (setq sign (string-to-char value))
+ (if (member sign '(?- ?+))
+ (setq current (org-hh:mm-string-to-minutes (substring current 1)))
+ (setq current 0))
+ (setq value (org-hh:mm-string-to-minutes value))
+ (if (equal ?- sign)
+ (setq value (- current value))
+ (if (equal ?+ sign) (setq value (+ current value)))))
+ (setq value (max 0 value)
+ org-clock-effort (org-minutes-to-hh:mm-string value))
+ (org-entry-put org-clock-marker "Effort" org-clock-effort)
+ (org-clock-update-mode-line))))
+
+(defvar org-clock-notification-was-shown nil
+ "Shows if we have shown notification already.")
+
+(defun org-clock-notify-once-if-expired ()
+ "Show notification if we spent more time than we estimated before.
+Notification is shown only once."
+ (when (marker-buffer org-clock-marker)
+ (let ((effort-in-minutes (org-hh:mm-string-to-minutes org-clock-effort))
+ (clocked-time (org-clock-get-clocked-time)))
+ (if (>= clocked-time effort-in-minutes)
+ (unless org-clock-notification-was-shown
+ (setq org-clock-notification-was-shown t)
+ (org-clock-play-sound)
+ (org-show-notification
+ (format "Task '%s' should be finished by now. (%s)"
+ org-clock-heading org-clock-effort)))
+ (setq org-clock-notification-was-shown nil)))))
+
+(defun org-show-notification (notification)
+ "Show notification.
+Use `org-show-notification-handler' if defined,
+use libnotify if available, or fall back on a message."
+ (cond ((functionp org-show-notification-handler)
+ (funcall org-show-notification-handler notification))
+ ((stringp org-show-notification-handler)
+ (start-process "emacs-timer-notification" nil
+ org-show-notification-handler notification))
+ ((org-program-exists "notify-send")
+ (start-process "emacs-timer-notification" nil
+ "notify-send" notification))
+ ;; Maybe the handler will send a message, so only use message as
+ ;; a fall back option
+ (t (message notification))))
+
+(defun org-clock-play-sound ()
+ "Play sound as configured by `org-clock-sound'.
+Use alsa's aplay tool if available."
+ (cond
+ ((not org-clock-sound))
+ ((eq org-clock-sound t) (beep t) (beep t))
+ ((stringp org-clock-sound)
+ (if (file-exists-p org-clock-sound)
+ (if (org-program-exists "aplay")
+ (start-process "org-clock-play-notification" nil
+ "aplay" org-clock-sound)
+ (condition-case nil
+ (play-sound-file org-clock-sound)
+ (error (beep t) (beep t))))))))
+
+(defun org-program-exists (program-name)
+ "Checks whenever we can locate program and launch it."
+ (if (eq system-type 'gnu/linux)
+ (= 0 (call-process "which" nil nil nil program-name))))
(defvar org-clock-mode-line-entry nil
"Information for the modeline about the running clock.")
is as the default task, a special task that will always be offered in
the clocking selection, associated with the letter `d'."
(interactive "P")
+ (setq org-clock-notification-was-shown nil)
(catch 'abort
(let ((interrupting (marker-buffer org-clock-marker))
- ts selected-task target-pos)
+ ts selected-task target-pos (msg-extra ""))
(when (equal select '(4))
(setq selected-task (org-clock-select-task "Clock-in on task: "))
(if selected-task
(when (equal select '(16))
;; Mark as default clocking task
- (save-excursion
- (org-back-to-heading t)
- (move-marker org-clock-default-task (point))))
+ (org-clock-mark-default-task))
(setq target-pos (point)) ;; we want to clock in at this location
+ (run-hooks 'org-clock-in-prepare-hook)
(save-excursion
(when (and selected-task (marker-buffer selected-task))
;; There is a selected task, move to the correct buffer
(t "???")))
(setq org-clock-heading (org-propertize org-clock-heading
'face nil))
- (org-clock-find-position)
+ (org-clock-find-position org-clock-in-resume)
(cond
((and org-clock-in-resume
(looking-at
- (concat "^[ \\t]* " org-clock-string
+ (concat "^[ \t]* " org-clock-string
" \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
- " +\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
+ " +\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
(message "Matched %s" (match-string 1))
(setq ts (concat "[" (match-string 1) "]"))
(goto-char (match-end 1))
(setq org-clock-start-time
(apply 'encode-time
- (org-parse-time-string (match-string 1)))))
+ (org-parse-time-string (match-string 1))))
+ (setq org-clock-effort (org-get-effort))
+ (setq org-clock-total-time (org-clock-sum-current-item
+ (org-clock-get-sum-start))))
((eq org-clock-in-resume 'auto-restart)
;; called from org-clock-load during startup,
;; do not interrupt, but warn!
(sit-for 2)
(throw 'abort nil))
(t
- (insert "\n") (backward-char 1)
+ (insert-before-markers "\n")
+ (backward-char 1)
(org-indent-line-function)
+ (when (and (save-excursion
+ (end-of-line 0)
+ (org-in-item-p)))
+ (beginning-of-line 1)
+ (org-indent-line-to (- (org-get-indentation) 2)))
(insert org-clock-string " ")
+ (setq org-clock-effort (org-get-effort))
+ (setq org-clock-total-time (org-clock-sum-current-item
+ (org-clock-get-sum-start)))
(setq org-clock-start-time (current-time))
- (setq ts (org-insert-time-stamp org-clock-start-time 'with-hm 'inactive))))
+ (setq ts (org-insert-time-stamp org-clock-start-time
+ 'with-hm 'inactive))))
(move-marker org-clock-marker (point) (buffer-base-buffer))
(or global-mode-string (setq global-mode-string '("")))
(or (memq 'org-mode-line-string global-mode-string)
(org-clock-update-mode-line)
(setq org-clock-mode-line-timer
(run-with-timer 60 60 'org-clock-update-mode-line))
- (message "Clock started at %s" ts)))))))
+ (message "Clock starts at %s - %s" ts msg-extra)
+ (run-hooks 'org-clock-in-hook)))))))
-(defun org-clock-find-position ()
- "Find the location where the next clock line should be inserted."
+(defun org-clock-mark-default-task ()
+ "Mark current task as default task."
+ (interactive)
+ (save-excursion
+ (org-back-to-heading t)
+ (move-marker org-clock-default-task (point))))
+
+(defvar msg-extra)
+(defun org-clock-get-sum-start ()
+ "Return the time from which clock times should be counted.
+This is for the currently running clock as it is displayed
+in the mode line. This function looks at the properties
+LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
+corresponding variable `org-clock-modeline-total' and then
+decides which time to use."
+ (let ((cmt (or (org-entry-get nil "CLOCK_MODELINE_TOTAL")
+ (symbol-name org-clock-modeline-total)))
+ (lr (org-entry-get nil "LAST_REPEAT")))
+ (cond
+ ((equal cmt "current")
+ (setq msg-extra "showing time in current clock instance")
+ (current-time))
+ ((equal cmt "today")
+ (setq msg-extra "showing today's task time.")
+ (let* ((dt (decode-time (current-time))))
+ (setq dt (append (list 0 0 0) (nthcdr 3 dt)))
+ (if org-extend-today-until
+ (setf (nth 2 dt) org-extend-today-until))
+ (apply 'encode-time dt)))
+ ((or (equal cmt "all")
+ (and (or (not cmt) (equal cmt "auto"))
+ (not lr)))
+ (setq msg-extra "showing entire task time.")
+ nil)
+ ((or (equal cmt "repeat")
+ (and (or (not cmt) (equal cmt "auto"))
+ lr))
+ (setq msg-extra "showing task time since last repeat.")
+ (if (not lr)
+ nil
+ (org-time-string-to-time lr)))
+ (t nil))))
+
+(defun org-clock-find-position (find-unclosed)
+ "Find the location where the next clock line should be inserted.
+When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
+line and position cursor in that line."
(org-back-to-heading t)
(catch 'exit
(let ((beg (save-excursion
(end (progn (outline-next-heading) (point)))
(re (concat "^[ \t]*" org-clock-string))
(cnt 0)
- first last)
+ (drawer (if (stringp org-clock-into-drawer)
+ org-clock-into-drawer "LOGBOOK"))
+ first last ind-last)
(goto-char beg)
+ (when (and find-unclosed
+ (re-search-forward
+ (concat "^[ \t]* " org-clock-string
+ " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
+ " +\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
+ end t))
+ (beginning-of-line 1)
+ (throw 'exit t))
(when (eobp) (newline) (setq end (max (point) end)))
- (when (re-search-forward "^[ \t]*:CLOCK:" end t)
+ (when (re-search-forward (concat "^[ \t]*:" drawer ":") end t)
;; we seem to have a CLOCK drawer, so go there.
(beginning-of-line 2)
+ (or org-log-states-order-reversed
+ (and (re-search-forward org-property-end-re nil t)
+ (goto-char (match-beginning 0))))
(throw 'exit t))
;; Lets count the CLOCK lines
(goto-char beg)
last (match-beginning 0)
cnt (1+ cnt)))
(when (and (integerp org-clock-into-drawer)
+ last
(>= (1+ cnt) org-clock-into-drawer))
;; Wrap current entries into a new drawer
(goto-char last)
+ (setq ind-last (org-get-indentation))
(beginning-of-line 2)
- (if (org-at-item-p) (org-end-of-item))
+ (if (and (>= (org-get-indentation) ind-last)
+ (org-at-item-p))
+ (org-end-of-item))
(insert ":END:\n")
(beginning-of-line 0)
- (org-indent-line-function)
+ (org-indent-line-to ind-last)
(goto-char first)
- (insert ":CLOCK:\n")
+ (insert ":" drawer ":\n")
(beginning-of-line 0)
(org-indent-line-function)
(org-flag-drawer t)
(beginning-of-line 2)
+ (or org-log-states-order-reversed
+ (and (re-search-forward org-property-end-re nil t)
+ (goto-char (match-beginning 0))))
(throw 'exit nil))
(goto-char beg)
;; Planning info, skip to after it
(beginning-of-line 2)
(or (bolp) (newline)))
- (when (eq t org-clock-into-drawer)
- (insert ":CLOCK:\n:END:\n")
- (beginning-of-line 0)
+ (when (or (eq org-clock-into-drawer t)
+ (stringp org-clock-into-drawer)
+ (and (integerp org-clock-into-drawer)
+ (< org-clock-into-drawer 2)))
+ (insert ":" drawer ":\n:END:\n")
+ (beginning-of-line -1)
(org-indent-line-function)
- (beginning-of-line 0)
(org-flag-drawer t)
+ (beginning-of-line 2)
(org-indent-line-function)
- (beginning-of-line 2)))))
+ (beginning-of-line)
+ (or org-log-states-order-reversed
+ (and (re-search-forward org-property-end-re nil t)
+ (goto-char (match-beginning 0))))))))
(defun org-clock-out (&optional fail-quietly)
"Stop the currently running clock.
If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
(interactive)
(catch 'exit
- (if (not (marker-buffer org-clock-marker))
- (if fail-quietly (throw 'exit t) (error "No active clock")))
- (let (ts te s h m remove)
- (save-excursion
- (set-buffer (marker-buffer org-clock-marker))
- (save-restriction
- (widen)
- (goto-char org-clock-marker)
- (beginning-of-line 1)
- (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
- (equal (match-string 1) org-clock-string))
- (setq ts (match-string 2))
- (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
- (goto-char (match-end 0))
- (delete-region (point) (point-at-eol))
- (insert "--")
- (setq te (org-insert-time-stamp (current-time) 'with-hm 'inactive))
- (setq s (- (time-to-seconds (apply 'encode-time (org-parse-time-string te)))
- (time-to-seconds (apply 'encode-time (org-parse-time-string ts))))
- h (floor (/ s 3600))
- s (- s (* 3600 h))
- m (floor (/ s 60))
- s (- s (* 60 s)))
- (insert " => " (format "%2d:%02d" h m))
- (when (setq remove (and org-clock-out-remove-zero-time-clocks
- (= (+ h m) 0)))
+ (if (not (marker-buffer org-clock-marker))
+ (if fail-quietly (throw 'exit t) (error "No active clock")))
+ (let (ts te s h m remove)
+ (save-excursion
+ (set-buffer (marker-buffer org-clock-marker))
+ (save-restriction
+ (widen)
+ (goto-char org-clock-marker)
(beginning-of-line 1)
+ (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
+ (equal (match-string 1) org-clock-string))
+ (setq ts (match-string 2))
+ (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
+ (goto-char (match-end 0))
(delete-region (point) (point-at-eol))
- (and (looking-at "\n") (> (point-max) (1+ (point)))
- (delete-char 1)))
- (move-marker org-clock-marker nil)
- (when org-log-note-clock-out
- (org-add-log-setup 'clock-out nil nil nil
- (concat "# Task: " (org-get-heading t) "\n\n")))
- (when org-clock-mode-line-timer
- (cancel-timer org-clock-mode-line-timer)
- (setq org-clock-mode-line-timer nil))
- (setq global-mode-string
- (delq 'org-mode-line-string global-mode-string))
- (force-mode-line-update)
- (message (concat "Clock stopped at %s after HH:MM = " org-time-clocksum-format "%s") te h m
- (if remove " => LINE REMOVED" "")))))))
+ (insert "--")
+ (setq te (org-insert-time-stamp (current-time) 'with-hm 'inactive))
+ (setq s (- (time-to-seconds (apply 'encode-time (org-parse-time-string te)))
+ (time-to-seconds (apply 'encode-time (org-parse-time-string ts))))
+ h (floor (/ s 3600))
+ s (- s (* 3600 h))
+ m (floor (/ s 60))
+ s (- s (* 60 s)))
+ (insert " => " (format "%2d:%02d" h m))
+ (when (setq remove (and org-clock-out-remove-zero-time-clocks
+ (= (+ h m) 0)))
+ (beginning-of-line 1)
+ (delete-region (point) (point-at-eol))
+ (and (looking-at "\n") (> (point-max) (1+ (point)))
+ (delete-char 1)))
+ (move-marker org-clock-marker nil)
+ (when org-log-note-clock-out
+ (org-add-log-setup 'clock-out nil nil nil nil
+ (concat "# Task: " (org-get-heading t) "\n\n")))
+ (when org-clock-mode-line-timer
+ (cancel-timer org-clock-mode-line-timer)
+ (setq org-clock-mode-line-timer nil))
+ (setq global-mode-string
+ (delq 'org-mode-line-string global-mode-string))
+ (when org-clock-out-switch-to-state
+ (save-excursion
+ (org-back-to-heading t)
+ (let ((org-inhibit-logging t))
+ (cond
+ ((functionp org-clock-out-switch-to-state)
+ (looking-at org-complex-heading-regexp)
+ (let ((newstate (funcall org-clock-out-switch-to-state
+ (match-string 2))))
+ (if newstate (org-todo newstate))))
+ ((and org-clock-out-switch-to-state
+ (not (looking-at (concat outline-regexp "[ \t]*"
+ org-clock-out-switch-to-state
+ "\\>"))))
+ (org-todo org-clock-out-switch-to-state))))))
+ (force-mode-line-update)
+ (message (concat "Clock stopped at %s after HH:MM = " org-time-clocksum-format "%s") te h m
+ (if remove " => LINE REMOVED" ""))
+ (run-hooks 'org-clock-out-hook))))))
(defun org-clock-cancel ()
"Cancel the running clock be removing the start timestamp."
(setq global-mode-string
(delq 'org-mode-line-string global-mode-string))
(force-mode-line-update)
- (message "Clock canceled"))
+ (message "Clock canceled")
+ (run-hooks 'org-clock-cancel-hook))
(defun org-clock-goto (&optional select)
- "Go to the currently clocked-in entry.
-With prefix arg SELECT, offer recently clocked tasks."
- (interactive "P")
- (let ((m (if select
- (org-clock-select-task "Select task to go to: ")
- org-clock-marker)))
- (if (not (marker-buffer m))
- (if select
- (error "No task selected")
- (error "No active clock")))
+ "Go to the currently clocked-in entry, or to the most recently clocked one.
+With prefix arg SELECT, offer recently clocked tasks for selection."
+ (interactive "@P")
+ (let* ((recent nil)
+ (m (cond
+ (select
+ (or (org-clock-select-task "Select task to go to: ")
+ (error "No task selected")))
+ ((marker-buffer org-clock-marker) org-clock-marker)
+ ((and org-clock-goto-may-find-recent-task
+ (car org-clock-history)
+ (marker-buffer (car org-clock-history)))
+ (setq recent t)
+ (car org-clock-history))
+ (t (error "No active or recent clock task")))))
(switch-to-buffer (marker-buffer m))
(if (or (< m (point-min)) (> m (point-max))) (widen))
(goto-char m)
(org-show-entry)
- (org-back-to-heading)
+ (org-back-to-heading t)
(org-cycle-hide-drawers 'children)
- (recenter)))
+ (recenter)
+ (if recent
+ (message "No running clock, this is the most recently clocked task"))
+ (run-hooks 'org-clock-goto-hook)))
(defvar org-clock-file-total-minutes nil
"Holds the file total time in minutes, after a call to `org-clock-sum'.")
- (make-variable-buffer-local 'org-clock-file-total-minutes)
+(make-variable-buffer-local 'org-clock-file-total-minutes)
(defun org-clock-sum (&optional tstart tend)
"Sum the times for each subtree.
-Puts the resulting times in minutes as a text property on each headline."
+Puts the resulting times in minutes as a text property on each headline.
+TSTART and TEND can mark a time range to be considered."
(interactive)
(let* ((bmp (buffer-modified-p))
(re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
(level 0)
ts te dt
time)
+ (if (stringp tstart) (setq tstart (org-time-string-to-seconds tstart)))
+ (if (stringp tend) (setq tend (org-time-string-to-seconds tend)))
+ (if (consp tstart) (setq tstart (time-to-seconds tstart)))
+ (if (consp tend) (setq tend (time-to-seconds tend)))
(remove-text-properties (point-min) (point-max) '(:org-clock-minutes t))
(save-excursion
(goto-char (point-max))
(setq org-clock-file-total-minutes (aref ltimes 0)))
(set-buffer-modified-p bmp)))
+(defun org-clock-sum-current-item (&optional tstart)
+ "Returns time, clocked on current item in total"
+ (save-excursion
+ (save-restriction
+ (org-narrow-to-subtree)
+ (org-clock-sum tstart)
+ org-clock-file-total-minutes)))
+
(defun org-clock-display (&optional total-only)
"Show subtree times in the entire buffer.
If TOTAL-ONLY is non-nil, only show the total time for the entire file
and is only done if the variable `org-clock-out-when-done' is not nil."
(when (and org-clock-out-when-done
(member state org-done-keywords)
- (equal (marker-buffer org-clock-marker) (current-buffer))
+ (equal (or (buffer-base-buffer (marker-buffer org-clock-marker))
+ (marker-buffer org-clock-marker))
+ (or (buffer-base-buffer (current-buffer))
+ (current-buffer)))
(< (point) org-clock-marker)
(> (save-excursion (outline-next-heading) (point))
org-clock-marker))
((string-match "\\([0-9]+\\)\\(-\\([wW]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s)
;; 1 1 2 3 3 4 4 5 6 6 5 2
(setq y (string-to-number (match-string 1 s))
- wp (and (match-end 3) (match-string 3 s))
+ wp (and (match-end 3) (match-string 3 s))
mw (and (match-end 4) (string-to-number (match-string 4 s)))
d (and (match-end 6) (string-to-number (match-string 6 s))))
(cond
(maxlevel (or (plist-get params :maxlevel) 3))
(step (plist-get params :step))
(emph (plist-get params :emphasize))
+ (timestamp (plist-get params :timestamp))
(ts (plist-get params :tstart))
(te (plist-get params :tend))
(block (plist-get params :block))
(link (plist-get params :link))
- ipos time p level hlc hdl content recalc formula pcol
+ ipos time p level hlc hdl tsp props content recalc formula pcol
cc beg end pos tbl tbl1 range-text rm-file-column scope-is-list st)
(setq org-clock-file-total-minutes nil)
(when step
(save-match-data
(org-make-org-heading-search-string
(match-string 2))))
- (match-string 2))))
+ (match-string 2)))
+ tsp (when timestamp
+ (setq props (org-entry-properties (point)))
+ (or (cdr (assoc "SCHEDULED" props))
+ (cdr (assoc "TIMESTAMP" props))
+ (cdr (assoc "DEADLINE" props))
+ (cdr (assoc "TIMESTAMP_IA" props)))))
(if (and (not multifile) (= level 1)) (push "|-" tbl))
(push (concat
- "| " (int-to-string level) "|" hlc hdl hlc " |"
+ "| " (int-to-string level) "|"
+ (if timestamp (concat tsp "|") "")
+ hlc hdl hlc " |"
(make-string (1- level) ?|)
hlc (org-minutes-to-hh:mm-string time) hlc
" |") tbl))))))
(if block (concat ", for " range-text ".") "")
"\n\n"))
(if scope-is-list "|File" "")
- "|L|Headline|Time|\n")
+ "|L|" (if timestamp "Timestamp|" "") "Headline|Time|\n")
(setq total-time (or total-time org-clock-file-total-minutes))
(insert-before-markers
"|-\n|"
(if scope-is-list "|" "")
- "|"
+ (if timestamp "|Timestamp|" "|")
"*Total time*| *"
(org-minutes-to-hh:mm-string (or total-time 0))
"*|\n|-\n")
(t (error "invalid formula in clocktable")))
;; Should we rescue an old formula?
(when (stringp (setq content (plist-get params :content)))
- (when (string-match "^\\(#\\+TBLFM:.*\\)" content)
+ (when (string-match "^\\([ \t]*#\\+TBLFM:.*\\)" content)
(setq recalc t)
(insert "\n" (match-string 1 (plist-get params :content)))
(beginning-of-line 0))))
(while (< ts te)
(or (bolp) (insert "\n"))
(setq p1 (plist-put p1 :tstart (format-time-string
- (car org-time-stamp-formats)
+ (org-time-stamp-format nil t)
(seconds-to-time ts))))
(setq p1 (plist-put p1 :tend (format-time-string
- (car org-time-stamp-formats)
+ (org-time-stamp-format nil t)
(seconds-to-time (setq ts (+ ts step))))))
(insert "\n" (if (eq step0 'day) "Daily report: " "Weekly report starting on: ")
(plist-get p1 :tstart) "\n")
"Was the clock file loaded?")
(defun org-clock-load ()
- "Load various clock-related data from disk, optionally resuming
-a stored clock"
+ "Load clock-related data from disk, maybe resuming a stored clock."
(when (and org-clock-persist (not org-clock-loaded))
(let ((filename (expand-file-name org-clock-persist-file))
(org-clock-in-resume 'auto-restart)
(add-hook 'org-mode-hook 'org-clock-load)
(add-hook 'kill-emacs-hook 'org-clock-save))
+;; Suggested bindings
+(org-defkey org-mode-map "\C-c\C-x\C-e" 'org-clock-modify-effort-estimate)
+
(provide 'org-clock)
;; arch-tag: 7b42c5d4-9b36-48be-97c0-66a869daed4c
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(org-defkey org-columns-map "\M-b" 'backward-char)
(org-defkey org-columns-map "a" 'org-columns-edit-allowed)
(org-defkey org-columns-map "s" 'org-columns-edit-attributes)
-(org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
-(org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
+(org-defkey org-columns-map "\M-f"
+ (lambda () (interactive) (goto-char (1+ (point)))))
+(org-defkey org-columns-map [right]
+ (lambda () (interactive) (goto-char (1+ (point)))))
+(org-defkey org-columns-map [down]
+ (lambda () (interactive)
+ (let ((col (current-column)))
+ (beginning-of-line 2)
+ (while (and (org-invisible-p2) (not (eobp)))
+ (beginning-of-line 2))
+ (move-to-column col))))
+(org-defkey org-columns-map [up]
+ (lambda () (interactive)
+ (let ((col (current-column)))
+ (beginning-of-line 0)
+ (while (and (org-invisible-p2) (not (bobp)))
+ (beginning-of-line 0))
+ (move-to-column col))))
(org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
(org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
(org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
org-columns-previous-hscroll (window-hscroll))
(force-mode-line-update)))
+(defvar org-colview-initial-truncate-line-value nil
+ "Remember the value of `truncate-lines' across colview.")
+
(defun org-columns-remove-overlays ()
"Remove all currently active column overlays."
(interactive)
(let ((inhibit-read-only t))
(remove-text-properties (point-min) (point-max) '(read-only t))))
(when org-columns-flyspell-was-active
- (flyspell-mode 1)))))
+ (flyspell-mode 1))
+ (when (local-variable-p 'org-colview-initial-truncate-line-value)
+ (setq truncate-lines org-colview-initial-truncate-line-value)))))
(defun org-columns-cleanup-item (item fmt)
"Remove from ITEM what is a column in the format FMT."
(setq eval '(org-with-point-at pom
(org-edit-headline))))
((equal key "TODO")
- (setq eval '(org-with-point-at pom
- (call-interactively 'org-todo))))
+ (setq eval '(org-with-point-at
+ pom
+ (call-interactively 'org-todo))))
((equal key "PRIORITY")
(setq eval '(org-with-point-at pom
(call-interactively 'org-priority))))
(narrow-to-region beg end)
(org-clock-sum))))
(while (re-search-forward (concat "^" outline-regexp) end t)
- (push (cons (org-current-line) (org-entry-properties)) cache))
+ (if (and org-columns-skip-arrchived-trees
+ (looking-at (concat ".*:" org-archive-tag ":")))
+ (org-end-of-subtree t)
+ (push (cons (org-current-line) (org-entry-properties)) cache)))
(when cache
(setq maxwidths (org-columns-get-autowidth-alist fmt cache))
(org-set-local 'org-columns-current-maxwidths maxwidths)
(when (org-set-local 'org-columns-flyspell-was-active
(org-bound-and-true-p flyspell-mode))
(flyspell-mode 0))
+ (unless (local-variable-p 'org-colview-initial-truncate-line-value)
+ (org-set-local 'org-colview-initial-truncate-line-value
+ truncate-lines))
+ (setq truncate-lines t)
(mapc (lambda (x)
(goto-line (car x))
(org-columns-display-here (cdr x)))
cache)))))
-(defun org-columns-new (&optional prop title width op fmt &rest rest)
+(defvar org-columns-compile-map
+ '(("none" none +)
+ (":" add_times +)
+ ("+" add_numbers +)
+ ("$" currency +)
+ ("X" checkbox +)
+ ("X/" checkbox-n-of-m +)
+ ("X%" checkbox-percent +)
+ ("max" max_numbers max)
+ ("min" min_numbers min)
+ ("mean" mean_numbers (lambda (&rest x) (/ (apply '+ x) (float (length x)))))
+ (":max" max_times max)
+ (":min" min_times min)
+ (":mean" mean_times (lambda (&rest x) (/ (apply '+ x) (float (length x))))))
+ "Operator <-> format,function map.
+Used to compile/uncompile columns format and completing read in
+interactive function org-columns-new.")
+
+(defun org-columns-new (&optional prop title width op fmt fun &rest rest)
"Insert a new column, to the left of the current column."
(interactive)
(let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
(if (string-match "\\S-" width)
(setq width (string-to-number width))
(setq width nil))
- (setq fmt (org-ido-completing-read "Summary [none]: "
- '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
- nil t))
- (if (string-match "\\S-" fmt)
- (setq fmt (intern fmt))
- (setq fmt nil))
+ (setq fmt (org-ido-completing-read
+ "Summary [none]: "
+ (mapcar (lambda (x) (list (symbol-name (cadr x))))
+ org-columns-compile-map)
+ nil t))
+ (setq fmt (intern fmt)
+ fun (cadr (assoc fmt (mapcar 'cdr org-columns-compile-map))))
(if (eq fmt 'none) (setq fmt nil))
(if editp
(progn
(setcar editp prop)
- (setcdr editp (list title width nil fmt)))
+ (setcdr editp (list title width nil fmt nil fun)))
(setq cell (nthcdr (1- (current-column))
org-columns-current-fmt-compiled))
- (setcdr cell (cons (list prop title width nil fmt)
+ (setcdr cell (cons (list prop title width nil fmt nil fun)
(cdr cell))))
(org-columns-store-format)
(org-columns-redo)))
(interactive)
(let* ((re (concat "^" outline-regexp))
(lmax 30) ; Does anyone use deeper levels???
- (lsum (make-vector lmax 0))
+ (lvals (make-vector lmax nil))
(lflag (make-vector lmax nil))
(level 0)
(ass (assoc property org-columns-current-fmt-compiled))
(format (nth 4 ass))
(printf (nth 5 ass))
+ (fun (nth 6 ass))
(beg org-columns-top-level-marker)
last-level val valflag flag end sumpos sum-alist sum str str1 useval)
(save-excursion
(cond
((< level last-level)
;; put the sum of lower levels here as a property
- (setq sum (aref lsum last-level) ; current sum
+ (setq sum (when (aref lvals last-level)
+ (apply fun (aref lvals last-level)))
flag (aref lflag last-level) ; any valid entries from children?
str (org-columns-number-to-string sum format printf)
str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
(org-entry-put nil property (if flag str val)))
;; add current to current level accumulator
(when (or flag valflag)
- (aset lsum level (+ (aref lsum level)
- (if flag sum (org-column-string-to-number
- (if flag str val) format))))
+ (push (if flag sum
+ (org-column-string-to-number (if flag str val) format))
+ (aref lvals level))
(aset lflag level t))
;; clear accumulators for deeper levels
(loop for l from (1+ level) to (1- lmax) do
- (aset lsum l 0)
+ (aset lvals l nil)
(aset lflag l nil)))
((>= level last-level)
;; add what we have here to the accumulator for this level
- (aset lsum level (+ (aref lsum level)
- (org-column-string-to-number (or val "0") format)))
- (and valflag (aset lflag level t)))
+ (when valflag
+ (push (org-column-string-to-number val format)
+ (aref lvals level))
+ (aset lflag level t)))
(t (error "This should not happen")))))))
(defun org-columns-redo ()
(defun org-columns-number-to-string (n fmt &optional printf)
"Convert a computed column number to a string value, according to FMT."
(cond
- ((eq fmt 'add_times)
+ ((not (numberp n)) "")
+ ((memq fmt '(add_times max_times min_times mean_times))
(let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
(format org-time-clocksum-format h m)))
((eq fmt 'checkbox)
(defun org-columns-uncompile-format (cfmt)
"Turn the compiled columns format back into a string representation."
- (let ((rtn "") e s prop title op width fmt printf)
+ (let ((rtn "") e s prop title op op-match width fmt printf)
(while (setq e (pop cfmt))
(setq prop (car e)
title (nth 1 e)
width (nth 2 e)
op (nth 3 e)
fmt (nth 4 e)
- printf (nth 5 e))
- (cond
- ((eq fmt 'add_times) (setq op ":"))
- ((eq fmt 'checkbox) (setq op "X"))
- ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
- ((eq fmt 'checkbox-percent) (setq op "X%"))
- ((eq fmt 'add_numbers) (setq op "+"))
- ((eq fmt 'currency) (setq op "$")))
+ printf (nth 5 e)
+ fun (nth 6 e))
+ (when (setq op-match (rassoc (list fmt fun) org-columns-compile-map))
+ (setq op (car op-match)))
(if (and op printf) (setq op (concat op ";" printf)))
(if (equal title prop) (setq title nil))
(setq s (concat "%" (if width (number-to-string width))
width the column width in characters, can be nil for automatic
operator the operator if any
format the output format for computed results, derived from operator
-printf a printf format for computed values"
- (let ((start 0) width prop title op f printf)
+printf a printf format for computed values
+fun the lisp function to compute values, derived from operator"
+ (let ((start 0) width prop title op op-match f printf fun)
(setq org-columns-current-fmt-compiled nil)
(while (string-match
(org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
title (or (match-string 3 fmt) prop)
op (match-string 4 fmt)
f nil
- printf nil)
+ printf nil
+ fun '+)
(if width (setq width (string-to-number width)))
(when (and op (string-match ";" op))
(setq printf (substring op (match-end 0))
op (substring op 0 (match-beginning 0))))
- (cond
- ((equal op "+") (setq f 'add_numbers))
- ((equal op "$") (setq f 'currency))
- ((equal op ":") (setq f 'add_times))
- ((equal op "X") (setq f 'checkbox))
- ((equal op "X/") (setq f 'checkbox-n-of-m))
- ((equal op "X%") (setq f 'checkbox-percent))
- )
- (push (list prop title width op f printf) org-columns-current-fmt-compiled))
+ (when (setq op-match (assoc op org-columns-compile-map))
+ (setq f (cadr op-match)
+ fun (caddr op-match)))
+ (push (list prop title width op f printf fun) org-columns-current-fmt-compiled))
(setq org-columns-current-fmt-compiled
(nreverse org-columns-current-fmt-compiled))))
of fields."
(save-excursion
(let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
+ (re-comment (concat "\\*+[ \t]+" org-comment-string "\\>"))
+ (re-archive (concat ".*:" org-archive-tag ":"))
(n (length title)) row tbl)
(goto-char (point-min))
(while (re-search-forward "^\\(\\*+\\) " nil t)
- (when (and (or (null maxlevel)
- (>= maxlevel
- (if org-odd-levels-only
- (/ (1+ (length (match-string 1))) 2)
- (length (match-string 1)))))
- (get-char-property (match-beginning 0) 'org-columns-key))
- (setq row nil)
- (loop for i from 0 to (1- n) do
- (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
- (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
- "")
- row))
- (setq row (nreverse row))
- (unless (and skip-empty-rows
- (eq 1 (length (delete "" (delete-dups row)))))
- (push row tbl))))
+ (catch 'next
+ (when (and (or (null maxlevel)
+ (>= maxlevel
+ (if org-odd-levels-only
+ (/ (1+ (length (match-string 1))) 2)
+ (length (match-string 1)))))
+ (get-char-property (match-beginning 0) 'org-columns-key))
+ (when (save-excursion
+ (goto-char (point-at-bol))
+ (or (looking-at re-comment)
+ (looking-at re-archive)))
+ (org-end-of-subtree t)
+ (throw 'next t))
+ (setq row nil)
+ (loop for i from 0 to (1- n) do
+ (push
+ (org-quote-vert
+ (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
+ (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
+ ""))
+ row))
+ (setq row (nreverse row))
+ (unless (and skip-empty-rows
+ (eq 1 (length (delete "" (delete-dups (copy-sequence row))))))
+ (push row tbl)))))
(append (list title 'hline) (nreverse tbl)))))
(defun org-dblock-write:columnview (params)
(while (setq line (pop content-lines))
(when (string-match "^#" line)
(insert "\n" line)
- (when (string-match "^#\\+TBLFM" line)
+ (when (string-match "^[ \t]*#\\+TBLFM" line)
(setq recalc t))))
(if recalc
(progn (goto-char pos) (org-table-recalculate 'all))
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;;; Code:
+(eval-when-compile
+ (require 'cl))
+
(require 'org-macs)
+(declare-function find-library-name "find-func" (library))
+
(defconst org-xemacs-p (featurep 'xemacs)) ; not used by org.el itself
(defconst org-format-transports-properties-p
(let ((x "a"))
(defun org-compatible-face (inherits specs)
"Make a compatible face specification.
If INHERITS is an existing face and if the Emacs version supports it,
-just inherit the face. If not, use SPECS to define the face.
+just inherit the face. If INHERITS is set and the Emacs version does
+not support it, copy the face specification from the inheritance face.
+If INHERITS is not given and SPECS is, use SPECS to define the face.
XEmacs and Emacs 21 do not know about the `min-colors' attribute.
For them we convert a (min-colors 8) entry to a `tty' entry and move it
to the top of the list. The `min-colors' attribute will be removed from
any other entries, and any resulting duplicates will be removed entirely."
+ (when (and inherits (facep inherits) (not specs))
+ (setq specs (or specs
+ (get inherits 'saved-face)
+ (get inherits 'face-defface-spec))))
(cond
((and inherits (facep inherits)
- (not (featurep 'xemacs)) (> emacs-major-version 22))
- ;; In Emacs 23, we use inheritance where possible.
- ;; We only do this in Emacs 23, because only there the outline
- ;; faces have been changed to the original org-mode-level-faces.
+ (not (featurep 'xemacs))
+ (>= emacs-major-version 22)
+ ;; do not inherit outline faces before Emacs 23
+ (or (>= emacs-major-version 23)
+ (not (string-match "\\`outline-[0-9]+"
+ (symbol-name inherits)))))
(list (list t :inherit inherits)))
((or (featurep 'xemacs) (< emacs-major-version 22))
;; These do not understand the `min-colors' attribute.
(use-region-p)
(and transient-mark-mode mark-active))))) ; Emacs 22 and before
+(defun org-cursor-to-region-beginning ()
+ (when (and (org-region-active-p)
+ (> (point) (region-beginning)))
+ (exchange-point-and-mark)))
+
;; Invisibility compatibility
(defun org-add-to-invisibility-spec (arg)
(org-no-properties (substring string (or from 0) to))
(substring-no-properties string from to)))
+(defun org-find-library-name (library)
+ (if (fboundp 'find-library-name)
+ (file-name-directory (find-library-name library))
+ ; XEmacs does not have `find-library-name'
+ (flet ((find-library-name-helper (filename ignored-codesys)
+ filename)
+ (find-library-name (library)
+ (find-library library nil 'find-library-name-helper)))
+ (file-name-directory (find-library-name library)))))
+
(defun org-count-lines (s)
"How many lines in string S?"
(let ((start 0) (n 1))
(setq n (1- n)))
n))
+(defun org-kill-new (string &rest args)
+ (remove-text-properties 0 (length string) '(line-prefix t wrap-prefix t)
+ string)
+ (apply 'kill-new string args))
+
(provide 'org-compat)
;; arch-tag: a0a0579f-e68c-4bdf-9e55-93768b846bbe
--- /dev/null
+;;; org-docbook.el --- DocBook exporter for org-mode
+;;
+;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+;;
+;; Emacs Lisp Archive Entry
+;; Filename: org-docbook.el
+;; Version: 6.29c
+;; Author: Baoqiu Cui <cbaoqiu AT yahoo DOT com>
+;; Maintainer: Baoqiu Cui <cbaoqiu AT yahoo DOT com>
+;; Keywords: org, wp, docbook
+;; Description: Converts an org-mode buffer into DocBook
+;; $Id: org-docbook.el 35 2009-03-23 01:03:21Z baoqiu $
+;; URL:
+
+;; This file is NOT part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;; Commentary:
+;;
+;; This library implements a DocBook exporter for org-mode. The basic
+;; idea and design is very similar to what `org-export-as-html' has.
+;; Code prototype was also started with `org-export-as-html'.
+;;
+;; Put this file into your load-path and the following line into your
+;; ~/.emacs:
+;;
+;; (require 'org-docbook)
+;;
+;; The interactive functions are similar to those of the HTML and LaTeX
+;; exporters:
+;;
+;; M-x `org-export-as-docbook'
+;; M-x `org-export-as-docbook-pdf'
+;; M-x `org-export-as-docbook-pdf-and-open'
+;; M-x `org-export-as-docbook-batch'
+;; M-x `org-export-as-docbook-to-buffer'
+;; M-x `org-export-region-as-docbook'
+;; M-x `org-replace-region-by-docbook'
+;;
+;; Note that, in order to generate PDF files using the DocBook XML files
+;; created by DocBook exporter, the following two variables have to be
+;; set based on what DocBook tools you use for XSLT processor and XSL-FO
+;; processor:
+;;
+;; org-export-docbook-xslt-proc-command
+;; org-export-docbook-xsl-fo-proc-command
+;;
+;; Check the document of these two variables to see examples of how they
+;; can be set.
+;;
+;; If the Org file to be exported contains special characters written in
+;; TeX-like syntax, like \alpha and \beta, you need to include the right
+;; entity file(s) in the DOCTYPE declaration for the DocBook XML file.
+;; This is required to make the DocBook XML file valid. The DOCTYPE
+;; declaration string can be set using the following variable:
+;;
+;; org-export-docbook-doctype
+;;
+;;; Code:
+
+(eval-when-compile
+ (require 'cl))
+
+(require 'footnote)
+(require 'org)
+(require 'org-exp)
+(require 'org-html)
+
+;;; Variables:
+
+(defvar org-docbook-para-open nil)
+(defvar org-export-docbook-inline-images t)
+(defvar org-export-docbook-link-org-files-as-docbook nil)
+
+(declare-function org-id-find-id-file "org-id" (id))
+
+;;; User variables:
+
+(defgroup org-export-docbook nil
+ "Options for exporting Org-mode files to DocBook."
+ :tag "Org Export DocBook"
+ :group 'org-export)
+
+(defcustom org-export-docbook-extension ".xml"
+ "Extension of DocBook XML files."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-header "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
+ "Header of DocBook XML files."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-doctype nil
+ "DOCTYPE declaration string for DocBook XML files.
+This can be used to include entities that are needed to handle
+special characters in Org files.
+
+For example, if the Org file to be exported contains XHTML
+entities, you can set this variable to:
+
+\"<!DOCTYPE article [
+<!ENTITY % xhtml1-symbol PUBLIC
+\"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
+\"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
+>
+%xhtml1-symbol;
+]>
+\"
+
+If you want to process DocBook documents without internet
+connection, it is suggested that you download the required entity
+file(s) and use system identifier(s) (external files) in the
+DOCTYPE declaration."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-article-header "<article xmlns=\"http://docbook.org/ns/docbook\"
+ xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0\" xml:lang=\"en\">"
+ "Article header of DocBook XML files."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-section-id-prefix "sec-"
+ "Prefix of section IDs used during exporting.
+This can be set before exporting to avoid same set of section IDs
+being used again and again, which can be a problem when multiple
+people work on the same document."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-footnote-id-prefix "fn-"
+ "The prefix of footnote IDs used during exporting. Like
+`org-export-docbook-section-id-prefix', this variable can help
+avoid same set of footnote IDs being used multiple times."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-emphasis-alist
+ `(("*" "<emphasis role=\"bold\">" "</emphasis>")
+ ("/" "<emphasis>" "</emphasis>")
+ ("_" "<emphasis role=\"underline\">" "</emphasis>")
+ ("=" "<code>" "</code>")
+ ("~" "<literal>" "</literal>")
+ ("+" "<emphasis role=\"strikethrough\">" "</emphasis>"))
+ "Alist of DocBook expressions to convert emphasis fontifiers.
+Each element of the list is a list of three elements.
+The first element is the character used as a marker for fontification.
+The second element is a formatting string to wrap fontified text with.
+The third element decides whether to protect converted text from other
+conversions."
+ :group 'org-export-docbook
+ :type 'alist)
+
+(defcustom org-export-docbook-default-image-attributes
+ `(("align" . "\"center\"")
+ ("valign". "\"middle\""))
+ "Alist of default DocBook image attributes.
+These attributes will be inserted into element <imagedata> by
+default, but users can override them using `#+ATTR_DocBook:'."
+ :group 'org-export-docbook
+ :type 'alist)
+
+(defcustom org-export-docbook-inline-image-extensions
+ '("jpeg" "jpg" "png" "gif" "svg")
+ "Extensions of image files that can be inlined into DocBook."
+ :group 'org-export-docbook
+ :type '(repeat (string :tag "Extension")))
+
+(defcustom org-export-docbook-coding-system nil
+ "Coding system for DocBook XML files."
+ :group 'org-export-docbook
+ :type 'coding-system)
+
+(defcustom org-export-docbook-xslt-proc-command nil
+ "XSLT processor command used by DocBook exporter.
+This is the command used to process a DocBook XML file to
+generate the formatting object (FO) file.
+
+The value of this variable should be a format control string that
+includes two `%s' arguments: the first one is for the output FO
+file name, and the second one is for the input DocBook XML file
+name.
+
+For example, if you use Saxon as the XSLT processor, you may want
+to set the variable to
+
+ \"java com.icl.saxon.StyleSheet -o %s %s /path/to/docbook.xsl\"
+
+If you use Xalan, you can set it to
+
+ \"java org.apache.xalan.xslt.Process -out %s -in %s -xsl /path/to/docbook.xsl\"
+
+For xsltproc, the following string should work:
+
+ \"xsltproc --output %s /path/to/docbook.xsl %s\"
+
+You need to replace \"/path/to/docbook.xsl\" with the actual path
+to the DocBook stylesheet file on your machine. You can also
+replace it with your own customization layer if you have one.
+
+You can include additional stylesheet parameters in this command.
+Just make sure that they meet the syntax requirement of each
+processor."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-xsl-fo-proc-command nil
+ "XSL-FO processor command used by DocBook exporter.
+This is the command used to process a formatting object (FO) file
+to generate the PDF file.
+
+The value of this variable should be a format control string that
+includes two `%s' arguments: the first one is for the input FO
+file name, and the second one is for the output PDF file name.
+
+For example, if you use FOP as the XSL-FO processor, you can set
+the variable to
+
+ \"fop %s %s\""
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-keywords-markup "<literal>%s</literal>"
+ "A printf format string to be applied to keywords by DocBook exporter."
+ :group 'org-export-docbook
+ :type 'string)
+
+(defcustom org-export-docbook-timestamp-markup "<emphasis>%s</emphasis>"
+ "A printf format string to be applied to time stamps by DocBook exporter."
+ :group 'org-export-docbook
+ :type 'string)
+
+;;; Autoload functions:
+
+;;;###autoload
+(defun org-export-as-docbook-batch ()
+ "Call `org-export-as-docbook' in batch style.
+This function can be used in batch processing.
+
+For example:
+
+$ emacs --batch
+ --load=$HOME/lib/emacs/org.el
+ --visit=MyOrgFile.org --funcall org-export-as-docbook-batch"
+ (org-export-as-docbook 'hidden))
+
+;;;###autoload
+(defun org-export-as-docbook-to-buffer ()
+ "Call `org-export-as-docbook' with output to a temporary buffer.
+No file is created."
+ (interactive)
+ (org-export-as-docbook nil nil "*Org DocBook Export*")
+ (when org-export-show-temporary-export-buffer
+ (switch-to-buffer-other-window "*Org DocBook Export*")))
+
+;;;###autoload
+(defun org-replace-region-by-docbook (beg end)
+ "Replace the region from BEG to END with its DocBook export.
+It assumes the region has `org-mode' syntax, and then convert it to
+DocBook. This can be used in any buffer. For example, you could
+write an itemized list in `org-mode' syntax in an DocBook buffer and
+then use this command to convert it."
+ (interactive "r")
+ (let (reg docbook buf)
+ (save-window-excursion
+ (if (org-mode-p)
+ (setq docbook (org-export-region-as-docbook
+ beg end t 'string))
+ (setq reg (buffer-substring beg end)
+ buf (get-buffer-create "*Org tmp*"))
+ (save-excursion
+ (set-buffer buf)
+ (erase-buffer)
+ (insert reg)
+ (org-mode)
+ (setq docbook (org-export-region-as-docbook
+ (point-min) (point-max) t 'string)))
+ (kill-buffer buf)))
+ (delete-region beg end)
+ (insert docbook)))
+
+;;;###autoload
+(defun org-export-region-as-docbook (beg end &optional body-only buffer)
+ "Convert region from BEG to END in `org-mode' buffer to DocBook.
+If prefix arg BODY-ONLY is set, omit file header and footer and
+only produce the region of converted text, useful for
+cut-and-paste operations. If BUFFER is a buffer or a string,
+use/create that buffer as a target of the converted DocBook. If
+BUFFER is the symbol `string', return the produced DocBook as a
+string and leave not buffer behind. For example, a Lisp program
+could call this function in the following way:
+
+ (setq docbook (org-export-region-as-docbook beg end t 'string))
+
+When called interactively, the output buffer is selected, and shown
+in a window. A non-interactive call will only return the buffer."
+ (interactive "r\nP")
+ (when (interactive-p)
+ (setq buffer "*Org DocBook Export*"))
+ (let ((transient-mark-mode t)
+ (zmacs-regions t)
+ rtn)
+ (goto-char end)
+ (set-mark (point)) ;; To activate the region
+ (goto-char beg)
+ (setq rtn (org-export-as-docbook
+ nil nil
+ buffer body-only))
+ (if (fboundp 'deactivate-mark) (deactivate-mark))
+ (if (and (interactive-p) (bufferp rtn))
+ (switch-to-buffer-other-window rtn)
+ rtn)))
+
+;;;###autoload
+(defun org-export-as-docbook-pdf (&optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Export as DocBook XML file, and generate PDF file."
+ (interactive "P")
+ (if (or (not org-export-docbook-xslt-proc-command)
+ (not (string-match "%s.+%s" org-export-docbook-xslt-proc-command)))
+ (error "XSLT processor command is not set correctly"))
+ (if (or (not org-export-docbook-xsl-fo-proc-command)
+ (not (string-match "%s.+%s" org-export-docbook-xsl-fo-proc-command)))
+ (error "XSL-FO processor command is not set correctly"))
+ (message "Exporting to PDF...")
+ (let* ((wconfig (current-window-configuration))
+ (docbook-buf (org-export-as-docbook hidden ext-plist
+ to-buffer body-only pub-dir))
+ (filename (buffer-file-name docbook-buf))
+ (base (file-name-sans-extension filename))
+ (fofile (concat base ".fo"))
+ (pdffile (concat base ".pdf")))
+ (and (file-exists-p pdffile) (delete-file pdffile))
+ (message "Processing DocBook XML file...")
+ (shell-command (format org-export-docbook-xslt-proc-command
+ fofile (shell-quote-argument filename)))
+ (shell-command (format org-export-docbook-xsl-fo-proc-command
+ fofile pdffile))
+ (message "Processing DocBook file...done")
+ (if (not (file-exists-p pdffile))
+ (error "PDF file was not produced")
+ (set-window-configuration wconfig)
+ (message "Exporting to PDF...done")
+ pdffile)))
+
+;;;###autoload
+(defun org-export-as-docbook-pdf-and-open ()
+ "Export as DocBook XML file, generate PDF file, and open it."
+ (interactive)
+ (let ((pdffile (org-export-as-docbook-pdf)))
+ (if pdffile
+ (org-open-file pdffile)
+ (error "PDF file was not produced"))))
+
+;;;###autoload
+(defun org-export-as-docbook (&optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Export the current buffer as a DocBook file.
+If there is an active region, export only the region. When
+HIDDEN is obsolete and does nothing. EXT-PLIST is a
+property list with external parameters overriding org-mode's
+default settings, but still inferior to file-local settings.
+When TO-BUFFER is non-nil, create a buffer with that name and
+export to that buffer. If TO-BUFFER is the symbol `string',
+don't leave any buffer behind but just return the resulting HTML
+as a string. When BODY-ONLY is set, don't produce the file
+header and footer, simply return the content of the document (all
+top-level sections). When PUB-DIR is set, use this as the
+publishing directory."
+ (interactive "P")
+ ;; Make sure we have a file name when we need it.
+ (when (and (not (or to-buffer body-only))
+ (not buffer-file-name))
+ (if (buffer-base-buffer)
+ (org-set-local 'buffer-file-name
+ (with-current-buffer (buffer-base-buffer)
+ buffer-file-name))
+ (error "Need a file name to be able to export.")))
+
+ (message "Exporting...")
+ (setq-default org-todo-line-regexp org-todo-line-regexp)
+ (setq-default org-deadline-line-regexp org-deadline-line-regexp)
+ (setq-default org-done-keywords org-done-keywords)
+ (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
+ (let* ((opt-plist
+ (org-export-process-option-filters
+ (org-combine-plists (org-default-export-plist)
+ ext-plist
+ (org-infile-export-plist))))
+ (link-validate (plist-get opt-plist :link-validation-function))
+ valid
+ (odd org-odd-levels-only)
+ (region-p (org-region-active-p))
+ (rbeg (and region-p (region-beginning)))
+ (rend (and region-p (region-end)))
+ (subtree-p
+ (if (plist-get opt-plist :ignore-subree-p)
+ nil
+ (when region-p
+ (save-excursion
+ (goto-char rbeg)
+ (and (org-at-heading-p)
+ (>= (org-end-of-subtree t t) rend))))))
+ (level-offset (if subtree-p
+ (save-excursion
+ (goto-char rbeg)
+ (+ (funcall outline-level)
+ (if org-odd-levels-only 1 0)))
+ 0))
+ (opt-plist (setq org-export-opt-plist
+ (if subtree-p
+ (org-export-add-subtree-options opt-plist rbeg)
+ opt-plist)))
+ ;; The following two are dynamically scoped into other
+ ;; routines below.
+ (org-current-export-dir
+ (or pub-dir (org-export-directory :docbook opt-plist)))
+ (org-current-export-file buffer-file-name)
+ (level 0) (line "") (origline "") txt todo
+ (filename (if to-buffer nil
+ (expand-file-name
+ (concat
+ (file-name-sans-extension
+ (or (and subtree-p
+ (org-entry-get (region-beginning)
+ "EXPORT_FILE_NAME" t))
+ (file-name-nondirectory buffer-file-name)))
+ org-export-docbook-extension)
+ (file-name-as-directory
+ (or pub-dir (org-export-directory :docbook opt-plist))))))
+ (current-dir (if buffer-file-name
+ (file-name-directory buffer-file-name)
+ default-directory))
+ (buffer (if to-buffer
+ (cond
+ ((eq to-buffer 'string) (get-buffer-create "*Org DocBook Export*"))
+ (t (get-buffer-create to-buffer)))
+ (find-file-noselect filename)))
+ ;; org-levels-open is a global variable
+ (org-levels-open (make-vector org-level-max nil))
+ (date (plist-get opt-plist :date))
+ (author (or (plist-get opt-plist :author)
+ user-full-name))
+ (email (plist-get opt-plist :email))
+ firstname othername surname
+ (title (or (and subtree-p (org-export-get-title-from-subtree))
+ (plist-get opt-plist :title)
+ (and (not
+ (plist-get opt-plist :skip-before-1st-heading))
+ (org-export-grab-title-from-buffer))
+ (and buffer-file-name
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name)))
+ "UNTITLED"))
+ ;; We will use HTML table formatter to export tables to DocBook
+ ;; format, so need to set html-table-tag here.
+ (html-table-tag (plist-get opt-plist :html-table-tag))
+ (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
+ (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
+ (inquote nil)
+ (infixed nil)
+ (inverse nil)
+ (in-local-list nil)
+ (local-list-type nil)
+ (local-list-indent nil)
+ (llt org-plain-list-ordered-item-terminator)
+ (email (plist-get opt-plist :email))
+ (language (plist-get opt-plist :language))
+ (lang-words nil)
+ cnt
+ (start 0)
+ (coding-system (and (boundp 'buffer-file-coding-system)
+ buffer-file-coding-system))
+ (coding-system-for-write (or org-export-docbook-coding-system
+ coding-system))
+ (save-buffer-coding-system (or org-export-docbook-coding-system
+ coding-system))
+ (charset (and coding-system-for-write
+ (fboundp 'coding-system-get)
+ (coding-system-get coding-system-for-write
+ 'mime-charset)))
+ (region
+ (buffer-substring
+ (if region-p (region-beginning) (point-min))
+ (if region-p (region-end) (point-max))))
+ (lines
+ (org-split-string
+ (org-export-preprocess-string
+ region
+ :emph-multiline t
+ :for-docbook t
+ :skip-before-1st-heading
+ (plist-get opt-plist :skip-before-1st-heading)
+ :drawers (plist-get opt-plist :drawers)
+ :todo-keywords (plist-get opt-plist :todo-keywords)
+ :tags (plist-get opt-plist :tags)
+ :priority (plist-get opt-plist :priority)
+ :footnotes (plist-get opt-plist :footnotes)
+ :timestamps (plist-get opt-plist :timestamps)
+ :archived-trees
+ (plist-get opt-plist :archived-trees)
+ :select-tags (plist-get opt-plist :select-tags)
+ :exclude-tags (plist-get opt-plist :exclude-tags)
+ :add-text
+ (plist-get opt-plist :text)
+ :LaTeX-fragments
+ (plist-get opt-plist :LaTeX-fragments))
+ "[\r\n]"))
+ ;; Use literal output to show check boxes.
+ (checkbox-start
+ (nth 1 (assoc "=" org-export-docbook-emphasis-alist)))
+ (checkbox-end
+ (nth 2 (assoc "=" org-export-docbook-emphasis-alist)))
+ table-open type
+ table-buffer table-orig-buffer
+ ind item-type starter didclose
+ rpl path attr caption label desc descp desc1 desc2 link
+ fnc item-tag
+ footref-seen footnote-list
+ id-file
+ )
+
+ ;; Fine detailed info about author name.
+ (if (string-match "\\([^ ]+\\) \\(.+ \\)?\\([^ ]+\\)" author)
+ (progn
+ (setq firstname (match-string 1 author)
+ othername (or (match-string 2 author) "")
+ surname (match-string 3 author))))
+
+ ;; Get all footnote text.
+ (setq footnote-list
+ (org-export-docbook-get-footnotes lines))
+
+ (let ((inhibit-read-only t))
+ (org-unmodified
+ (remove-text-properties (point-min) (point-max)
+ '(:org-license-to-kill t))))
+
+ (setq org-min-level (org-get-min-level lines level-offset))
+ (setq org-last-level org-min-level)
+ (org-init-section-numbers)
+
+ ;; Get and save the date.
+ (cond
+ ((and date (string-match "%" date))
+ (setq date (format-time-string date)))
+ (date)
+ (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
+
+ ;; Get the language-dependent settings
+ (setq lang-words (or (assoc language org-export-language-setup)
+ (assoc "en" org-export-language-setup)))
+
+ ;; Switch to the output buffer. Use fundamental-mode for now. We
+ ;; could turn on nXML mode later and do some indentation.
+ (set-buffer buffer)
+ (let ((inhibit-read-only t)) (erase-buffer))
+ (fundamental-mode)
+ (org-install-letbind)
+
+ (and (fboundp 'set-buffer-file-coding-system)
+ (set-buffer-file-coding-system coding-system-for-write))
+
+ ;; The main body...
+ (let ((case-fold-search nil)
+ (org-odd-levels-only odd))
+
+ ;; Create local variables for all options, to make sure all called
+ ;; functions get the correct information
+ (mapc (lambda (x)
+ (set (make-local-variable (nth 2 x))
+ (plist-get opt-plist (car x))))
+ org-export-plist-vars)
+
+ ;; Insert DocBook file header, title, and author info.
+ (unless body-only
+ (insert org-export-docbook-header)
+ (if org-export-docbook-doctype
+ (insert org-export-docbook-doctype))
+ (insert "<!-- Date: " date " -->\n")
+ (insert (format "<!-- DocBook XML file generated by Org-mode %s Emacs %s -->\n"
+ org-version emacs-major-version))
+ (insert org-export-docbook-article-header)
+ (insert (format
+ "\n <title>%s</title>
+ <info>
+ <author>
+ <personname>
+ <firstname>%s</firstname> <othername>%s</othername> <surname>%s</surname>
+ </personname>
+ %s
+ </author>
+ </info>\n"
+ (org-docbook-expand title)
+ firstname othername surname
+ (if email (concat "<email>" email "</email>") "")
+ )))
+
+ (org-init-section-numbers)
+
+ (org-export-docbook-open-para)
+
+ ;; Loop over all the lines...
+ (while (setq line (pop lines) origline line)
+ (catch 'nextline
+
+ ;; End of quote section?
+ (when (and inquote (string-match "^\\*+ " line))
+ (insert "]]>\n</programlisting>\n")
+ (org-export-docbook-open-para)
+ (setq inquote nil))
+ ;; Inside a quote section?
+ (when inquote
+ (insert (org-docbook-protect line) "\n")
+ (throw 'nextline nil))
+
+ ;; Fixed-width, verbatim lines (examples)
+ (when (and org-export-with-fixed-width
+ (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
+ (when (not infixed)
+ (setq infixed t)
+ (org-export-docbook-close-para-maybe)
+ (insert "<programlisting><![CDATA["))
+ (insert (match-string 3 line) "\n")
+ (when (or (not lines)
+ (not (string-match "^[ \t]*\\(:.*\\)"
+ (car lines))))
+ (setq infixed nil)
+ (insert "]]>\n</programlisting>\n")
+ (org-export-docbook-open-para))
+ (throw 'nextline nil))
+
+ (org-export-docbook-close-lists-maybe line)
+
+ ;; Protected HTML
+ (when (get-text-property 0 'org-protected line)
+ (let (par (ind (get-text-property 0 'original-indentation line)))
+ (when (re-search-backward
+ "\\(<para>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
+ (setq par (match-string 1))
+ (replace-match "\\2\n"))
+ (insert line "\n")
+ (while (and lines
+ (or (= (length (car lines)) 0)
+ (not ind)
+ (equal ind (get-text-property 0 'original-indentation (car lines))))
+ (or (= (length (car lines)) 0)
+ (get-text-property 0 'org-protected (car lines))))
+ (insert (pop lines) "\n"))
+ (and par (insert "<para>\n")))
+ (throw 'nextline nil))
+
+ ;; Start of block quotes and verses
+ (when (or (equal "ORG-BLOCKQUOTE-START" line)
+ (and (equal "ORG-VERSE-START" line)
+ (setq inverse t)))
+ (org-export-docbook-close-para-maybe)
+ (insert "<blockquote>")
+ ;; Check whether attribution for this blockquote exists.
+ (let (tmp1
+ attribution
+ (end (if inverse "ORG-VERSE-END" "ORG-BLOCKQUOTE-END"))
+ (quote-lines nil))
+ (while (and (setq tmp1 (pop lines))
+ (not (equal end tmp1)))
+ (push tmp1 quote-lines))
+ (push tmp1 lines) ; Put back quote end mark
+ ;; Check the last line in the quote to see if it contains
+ ;; the attribution.
+ (setq tmp1 (pop quote-lines))
+ (if (string-match "\\(^.*\\)\\(--[ \t]+\\)\\(.+\\)$" tmp1)
+ (progn
+ (setq attribution (match-string 3 tmp1))
+ (when (save-match-data
+ (string-match "[^ \t]" (match-string 1 tmp1)))
+ (push (match-string 1 tmp1) lines)))
+ (push tmp1 lines))
+ (while (setq tmp1 (pop quote-lines))
+ (push tmp1 lines))
+ (when attribution
+ (insert "<attribution>" attribution "</attribution>")))
+ ;; Insert <literallayout> for verse.
+ (if inverse
+ (insert "\n<literallayout>")
+ (org-export-docbook-open-para))
+ (throw 'nextline nil))
+
+ ;; End of block quotes
+ (when (equal "ORG-BLOCKQUOTE-END" line)
+ (org-export-docbook-close-para-maybe)
+ (insert "</blockquote>\n")
+ (org-export-docbook-open-para)
+ (throw 'nextline nil))
+
+ ;; End of verses
+ (when (equal "ORG-VERSE-END" line)
+ (insert "</literallayout>\n</blockquote>\n")
+ (org-export-docbook-open-para)
+ (setq inverse nil)
+ (throw 'nextline nil))
+
+ ;; Text centering. Element <para role="centered"> does not
+ ;; seem to work with FOP, so for now we use <informaltable> to
+ ;; center the text, which can contain multiple paragraphs.
+ (when (equal "ORG-CENTER-START" line)
+ (org-export-docbook-close-para-maybe)
+ (insert "<informaltable frame=\"none\" colsep=\"0\" rowsep=\"0\">\n"
+ "<tgroup align=\"center\" cols=\"1\">\n"
+ "<tbody><row><entry>\n")
+ (org-export-docbook-open-para)
+ (throw 'nextline nil))
+
+ (when (equal "ORG-CENTER-END" line)
+ (org-export-docbook-close-para-maybe)
+ (insert "</entry></row></tbody>\n"
+ "</tgroup>\n</informaltable>\n")
+ (org-export-docbook-open-para)
+ (throw 'nextline nil))
+
+ ;; Make targets to anchors. Note that currently FOP does not
+ ;; seem to support <anchor> tags when generating PDF output,
+ ;; but this can be used in DocBook --> HTML conversion.
+ (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
+ (cond
+ ((match-end 2)
+ (setq line (replace-match
+ (format "@<anchor xml:id=\"%s\"/>"
+ (org-solidify-link-text (match-string 1 line)))
+ t t line)))
+ (t
+ (setq line (replace-match
+ (format "@<anchor xml:id=\"%s\"/>"
+ (org-solidify-link-text (match-string 1 line)))
+ t t line)))))
+
+ ;; Put time stamps and related keywords into special mark-up
+ ;; elements.
+ (setq line (org-export-docbook-handle-time-stamps line))
+
+ ;; Replace "&", "<" and ">" by "&", "<" and ">".
+ ;; Handle @<..> HTML tags (replace "@>..<" by "<..>").
+ ;; Also handle sub_superscripts and check boxes.
+ (or (string-match org-table-hline-regexp line)
+ (setq line (org-docbook-expand line)))
+
+ ;; Format the links
+ (setq start 0)
+ (while (string-match org-bracket-link-analytic-regexp++ line start)
+ (setq start (match-beginning 0))
+ (setq path (save-match-data (org-link-unescape
+ (match-string 3 line))))
+ (setq type (cond
+ ((match-end 2) (match-string 2 line))
+ ((save-match-data
+ (or (file-name-absolute-p path)
+ (string-match "^\\.\\.?/" path)))
+ "file")
+ (t "internal")))
+ (setq path (org-extract-attributes (org-link-unescape path)))
+ (setq attr (get-text-property 0 'org-attributes path)
+ caption (get-text-property 0 'org-caption path)
+ label (get-text-property 0 'org-label path))
+ (setq desc1 (if (match-end 5) (match-string 5 line))
+ desc2 (if (match-end 2) (concat type ":" path) path)
+ descp (and desc1 (not (equal desc1 desc2)))
+ desc (or desc1 desc2))
+ ;; Make an image out of the description if that is so wanted
+ (when (and descp (org-file-image-p
+ desc org-export-docbook-inline-image-extensions))
+ (save-match-data
+ (if (string-match "^file:" desc)
+ (setq desc (substring desc (match-end 0))))))
+ ;; FIXME: do we need to unescape here somewhere?
+ (cond
+ ((equal type "internal")
+ (setq rpl (format "<link linkend=\"%s\">%s</link>"
+ (org-solidify-link-text
+ (save-match-data (org-link-unescape path)) nil)
+ (org-export-docbook-format-desc desc))))
+ ((and (equal type "id")
+ (setq id-file (org-id-find-id-file path)))
+ ;; This is an id: link to another file (if it was the same file,
+ ;; it would have become an internal link...)
+ (save-match-data
+ (setq id-file (file-relative-name
+ id-file (file-name-directory org-current-export-file)))
+ (setq id-file (concat (file-name-sans-extension id-file)
+ org-export-docbook-extension))
+ (setq rpl (format "<link xlink:href=\"%s#%s\">%s</link>"
+ id-file path (org-export-docbook-format-desc desc)))))
+ ((member type '("http" "https"))
+ ;; Standard URL, just check if we need to inline an image
+ (if (and (or (eq t org-export-docbook-inline-images)
+ (and org-export-docbook-inline-images (not descp)))
+ (org-file-image-p
+ path org-export-docbook-inline-image-extensions))
+ (setq rpl (org-export-docbook-format-image
+ (concat type ":" path)))
+ (setq link (concat type ":" path))
+ (setq rpl (format "<link xlink:href=\"%s\">%s</link>"
+ (org-export-html-format-href link)
+ (org-export-docbook-format-desc desc)))
+ ))
+ ((member type '("ftp" "mailto" "news"))
+ ;; Standard URL
+ (setq link (concat type ":" path))
+ (setq rpl (format "<link xlink:href=\"%s\">%s</link>"
+ (org-export-html-format-href link)
+ (org-export-docbook-format-desc desc))))
+ ((string= type "coderef")
+ (setq rpl (format (org-export-get-coderef-format path (and descp desc))
+ (cdr (assoc path org-export-code-refs)))))
+ ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
+ ;; The link protocol has a function for format the link
+ (setq rpl
+ (save-match-data
+ (funcall fnc (org-link-unescape path) desc1 'html))))
+
+ ((string= type "file")
+ ;; FILE link
+ (let* ((filename path)
+ (abs-p (file-name-absolute-p filename))
+ thefile file-is-image-p search)
+ (save-match-data
+ (if (string-match "::\\(.*\\)" filename)
+ (setq search (match-string 1 filename)
+ filename (replace-match "" t nil filename)))
+ (setq valid
+ (if (functionp link-validate)
+ (funcall link-validate filename current-dir)
+ t))
+ (setq file-is-image-p
+ (org-file-image-p
+ filename org-export-docbook-inline-image-extensions))
+ (setq thefile (if abs-p (expand-file-name filename) filename))
+ ;; Carry over the properties (expand-file-name will
+ ;; discard the properties of filename)
+ (add-text-properties 0 (1- (length thefile))
+ (list 'org-caption caption
+ 'org-attributes attr
+ 'org-label label)
+ thefile)
+ (when (and org-export-docbook-link-org-files-as-docbook
+ (string-match "\\.org$" thefile))
+ (setq thefile (concat (substring thefile 0
+ (match-beginning 0))
+ org-export-docbook-extension))
+ (if (and search
+ ;; make sure this is can be used as target search
+ (not (string-match "^[0-9]*$" search))
+ (not (string-match "^\\*" search))
+ (not (string-match "^/.*/$" search)))
+ (setq thefile (concat thefile "#"
+ (org-solidify-link-text
+ (org-link-unescape search)))))
+ (when (string-match "^file:" desc)
+ (setq desc (replace-match "" t t desc))
+ (if (string-match "\\.org$" desc)
+ (setq desc (replace-match "" t t desc))))))
+ (setq rpl (if (and file-is-image-p
+ (or (eq t org-export-docbook-inline-images)
+ (and org-export-docbook-inline-images
+ (not descp))))
+ (progn
+ (message "image %s %s" thefile org-docbook-para-open)
+ (org-export-docbook-format-image thefile))
+ (format "<link xlink:href=\"%s\">%s</link>"
+ thefile (org-export-docbook-format-desc desc))))
+ (if (not valid) (setq rpl desc))))
+
+ (t
+ ;; Just publish the path, as default
+ (setq rpl (concat "<" type ":"
+ (save-match-data (org-link-unescape path))
+ ">"))))
+ (setq line (replace-match rpl t t line)
+ start (+ start (length rpl))))
+
+ ;; TODO items: can we do something better?!
+ (if (and (string-match org-todo-line-regexp line)
+ (match-beginning 2))
+ (setq line
+ (concat (substring line 0 (match-beginning 2))
+ "[" (match-string 2 line) "]"
+ (substring line (match-end 2)))))
+
+ ;; Does this contain a reference to a footnote?
+ (when org-export-with-footnotes
+ (setq start 0)
+ (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
+ (if (get-text-property (match-beginning 2) 'org-protected line)
+ (setq start (match-end 2))
+ (let ((num (match-string 2 line)))
+ (if (assoc num footref-seen)
+ (setq line (replace-match
+ (format "%s<footnoteref linkend=\"%s%s\"/>"
+ (match-string 1 line)
+ org-export-docbook-footnote-id-prefix num)
+ t t line))
+ (setq line (replace-match
+ (format "%s<footnote xml:id=\"%s%s\"><para>%s</para></footnote>"
+ (match-string 1 line)
+ org-export-docbook-footnote-id-prefix
+ num
+ (save-match-data
+ (org-docbook-expand
+ (cdr (assoc num footnote-list)))))
+ t t line))
+ (push (cons num 1) footref-seen))))))
+
+ (cond
+ ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
+ ;; This is a headline
+ (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
+ level-offset))
+ txt (match-string 2 line))
+ (if (string-match quote-re0 txt)
+ (setq txt (replace-match "" t t txt)))
+ (when in-local-list
+ ;; Close any local lists before inserting a new header line
+ (while local-list-type
+ (let ((listtype (car local-list-type)))
+ (org-export-docbook-close-li listtype)
+ (insert (cond
+ ((equal listtype "o") "</orderedlist>\n")
+ ((equal listtype "u") "</itemizedlist>\n")
+ ((equal listtype "d") "</variablelist>\n"))))
+ (pop local-list-type))
+ (setq local-list-indent nil
+ in-local-list nil))
+ (org-export-docbook-level-start level txt)
+ ;; QUOTES
+ (when (string-match quote-re line)
+ (org-export-docbook-close-para-maybe)
+ (insert "<programlisting><![CDATA[")
+ (setq inquote t)))
+
+ ;; Tables: since version 4.3 of DocBook DTD, HTML tables are
+ ;; supported. We can use existing HTML table exporter code
+ ;; here.
+ ((and org-export-with-tables
+ (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
+ (if (not table-open)
+ ;; New table starts
+ (setq table-open t
+ table-buffer nil
+ table-orig-buffer nil))
+ ;; Accumulate lines
+ (setq table-buffer (cons line table-buffer)
+ table-orig-buffer (cons origline table-orig-buffer))
+ (when (or (not lines)
+ (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
+ (car lines))))
+ (setq table-open nil
+ table-buffer (nreverse table-buffer)
+ table-orig-buffer (nreverse table-orig-buffer))
+ (org-export-docbook-close-para-maybe)
+ (insert (org-export-docbook-finalize-table
+ (org-format-table-html table-buffer table-orig-buffer)))))
+ (t
+ ;; Normal lines
+ (when (string-match
+ (cond
+ ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
+ ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
+ ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
+ (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
+ line)
+ (setq ind (or (get-text-property 0 'original-indentation line)
+ (org-get-string-indentation line))
+ item-type (if (match-beginning 4) "o" "u")
+ starter (if (match-beginning 2)
+ (substring (match-string 2 line) 0 -1))
+ line (substring line (match-beginning 5))
+ item-tag nil)
+ (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
+ (setq item-type "d"
+ item-tag (match-string 1 line)
+ line (substring line (match-end 0))))
+ (when (and (not (equal item-type "d"))
+ (not (string-match "[^ \t]" line)))
+ ;; Empty line. Pretend indentation is large.
+ (setq ind (if org-empty-line-terminates-plain-lists
+ 0
+ (1+ (or (car local-list-indent) 1)))))
+ (setq didclose nil)
+ (while (and in-local-list
+ (or (and (= ind (car local-list-indent))
+ (not starter))
+ (< ind (car local-list-indent))))
+ (setq didclose t)
+ (let ((listtype (car local-list-type)))
+ (org-export-docbook-close-li listtype)
+ (insert (cond
+ ((equal listtype "o") "</orderedlist>\n")
+ ((equal listtype "u") "</itemizedlist>\n")
+ ((equal listtype "d") "</variablelist>\n"))))
+ (pop local-list-type) (pop local-list-indent)
+ (setq in-local-list local-list-indent))
+ (cond
+ ((and starter
+ (or (not in-local-list)
+ (> ind (car local-list-indent))))
+ ;; Start new (level of) list
+ (org-export-docbook-close-para-maybe)
+ (insert (cond
+ ((equal item-type "u") "<itemizedlist>\n<listitem>\n")
+ ((equal item-type "o") "<orderedlist>\n<listitem>\n")
+ ((equal item-type "d")
+ (format "<variablelist>\n<varlistentry><term>%s</term><listitem>\n" item-tag))))
+ ;; For DocBook, we need to open a para right after tag
+ ;; <listitem>.
+ (org-export-docbook-open-para)
+ (push item-type local-list-type)
+ (push ind local-list-indent)
+ (setq in-local-list t))
+ (starter
+ ;; Continue current list
+ (let ((listtype (car local-list-type)))
+ (org-export-docbook-close-li listtype)
+ (insert (cond
+ ((equal listtype "o") "<listitem>")
+ ((equal listtype "u") "<listitem>")
+ ((equal listtype "d") (format
+ "<varlistentry><term>%s</term><listitem>"
+ (or item-tag
+ "???"))))))
+ ;; For DocBook, we need to open a para right after tag
+ ;; <listitem>.
+ (org-export-docbook-open-para))
+ (didclose
+ ;; We did close a list, normal text follows: need <para>
+ (org-export-docbook-open-para)))
+ ;; Checkboxes.
+ (if (string-match "^[ \t]*\\(\\[[X -]\\]\\)" line)
+ (setq line
+ (replace-match (concat checkbox-start
+ (match-string 1 line)
+ checkbox-end)
+ t t line))))
+
+ ;; Empty lines start a new paragraph. If hand-formatted lists
+ ;; are not fully interpreted, lines starting with "-", "+", "*"
+ ;; also start a new paragraph.
+ (if (and (string-match "^ [-+*]-\\|^[ \t]*$" line)
+ (not inverse))
+ (org-export-docbook-open-para))
+
+ ;; Is this the start of a footnote?
+ (when org-export-with-footnotes
+ (when (and (boundp 'footnote-section-tag-regexp)
+ (string-match (concat "^" footnote-section-tag-regexp)
+ line))
+ ;; ignore this line
+ (throw 'nextline nil))
+ ;; These footnote lines have been read and saved before,
+ ;; ignore them at this time.
+ (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
+ (org-export-docbook-close-para-maybe)
+ (throw 'nextline nil)))
+
+ ;; FIXME: It might be a good idea to add an option to
+ ;; support line break processing instruction <?linebreak?>.
+ ;; Org-mode supports line break "\\" in HTML exporter, and
+ ;; some DocBook users may also want to force line breaks
+ ;; even though DocBook only supports that in
+ ;; <literallayout>.
+
+ (insert line "\n")))))
+
+ ;; Properly close all local lists and other lists
+ (when inquote
+ (insert "]]>\n</programlisting>\n")
+ (org-export-docbook-open-para))
+ (when in-local-list
+ ;; Close any local lists before inserting a new header line
+ (while local-list-type
+ (let ((listtype (car local-list-type)))
+ (org-export-docbook-close-li listtype)
+ (insert (cond
+ ((equal listtype "o") "</orderedlist>\n")
+ ((equal listtype "u") "</itemizedlist>\n")
+ ((equal listtype "d") "</variablelist>\n"))))
+ (pop local-list-type))
+ (setq local-list-indent nil
+ in-local-list nil))
+ ;; Close all open sections.
+ (org-export-docbook-level-start 1 nil)
+
+ (unless (plist-get opt-plist :buffer-will-be-killed)
+ (normal-mode)
+ (if (eq major-mode default-major-mode)
+ (nxml-mode)))
+
+ ;; Remove empty paragraphs and lists. Replace them with a
+ ;; newline.
+ (goto-char (point-min))
+ (while (re-search-forward
+ "[ \r\n\t]*\\(<para>\\)[ \r\n\t]*</para>[ \r\n\t]*" nil t)
+ (when (not (get-text-property (match-beginning 1) 'org-protected))
+ (replace-match "\n")
+ (backward-char 1)))
+ ;; Fill empty sections with <para></para>. This is to make sure
+ ;; that the DocBook document generated is valid and well-formed.
+ (goto-char (point-min))
+ (while (re-search-forward
+ "</title>\\([ \r\n\t]*\\)</section>" nil t)
+ (when (not (get-text-property (match-beginning 0) 'org-protected))
+ (replace-match "\n<para></para>\n" nil nil nil 1)))
+ ;; Insert the last closing tag.
+ (goto-char (point-max))
+ (unless body-only
+ (insert "</article>"))
+ (or to-buffer (save-buffer))
+ (goto-char (point-min))
+ (or (org-export-push-to-kill-ring "DocBook")
+ (message "Exporting... done"))
+ (if (eq to-buffer 'string)
+ (prog1 (buffer-substring (point-min) (point-max))
+ (kill-buffer (current-buffer)))
+ (current-buffer)))))
+
+(defun org-export-docbook-open-para ()
+ "Insert <para>, but first close previous paragraph if any."
+ (org-export-docbook-close-para-maybe)
+ (insert "\n<para>")
+ (setq org-docbook-para-open t))
+
+(defun org-export-docbook-close-para-maybe ()
+ "Close DocBook paragraph if there is one open."
+ (when org-docbook-para-open
+ (insert "</para>\n")
+ (setq org-docbook-para-open nil)))
+
+(defun org-export-docbook-close-li (&optional type)
+ "Close list if necessary."
+ (org-export-docbook-close-para-maybe)
+ (if (equal type "d")
+ (insert "</listitem></varlistentry>\n")
+ (insert "</listitem>\n")))
+
+(defvar in-local-list)
+(defvar local-list-indent)
+(defvar local-list-type)
+(defun org-export-docbook-close-lists-maybe (line)
+ (let ((ind (or (get-text-property 0 'original-indentation line)))
+; (and (string-match "\\S-" line)
+; (org-get-indentation line))))
+ didclose)
+ (when ind
+ (while (and in-local-list
+ (<= ind (car local-list-indent)))
+ (setq didclose t)
+ (let ((listtype (car local-list-type)))
+ (org-export-docbook-close-li listtype)
+ (insert (cond
+ ((equal listtype "o") "</orderedlist>\n")
+ ((equal listtype "u") "</itemizedlist>\n")
+ ((equal listtype "d") "</variablelist>\n"))))
+ (pop local-list-type) (pop local-list-indent)
+ (setq in-local-list local-list-indent))
+ (and didclose (org-export-docbook-open-para)))))
+
+(defun org-export-docbook-level-start (level title)
+ "Insert a new level in DocBook export.
+When TITLE is nil, just close all open levels."
+ (org-export-docbook-close-para-maybe)
+ (let* ((target (and title (org-get-text-property-any 0 'target title)))
+ (l org-level-max)
+ section-number)
+ (while (>= l level)
+ (if (aref org-levels-open (1- l))
+ (progn
+ (insert "</section>\n")
+ (aset org-levels-open (1- l) nil)))
+ (setq l (1- l)))
+ (when title
+ ;; If title is nil, this means this function is called to close
+ ;; all levels, so the rest is done only if title is given.
+ ;;
+ ;; Format tags: put them into a superscript like format.
+ (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
+ (setq title
+ (replace-match
+ (if org-export-with-tags
+ (save-match-data
+ (concat
+ "<superscript>"
+ (match-string 1 title)
+ "</superscript>"))
+ "")
+ t t title)))
+ (aset org-levels-open (1- level) t)
+ (setq section-number (org-section-number level))
+ (insert (format "\n<section xml:id=\"%s%s\">\n<title>%s</title>"
+ org-export-docbook-section-id-prefix
+ section-number title))
+ (org-export-docbook-open-para))))
+
+(defun org-docbook-expand (string)
+ "Prepare STRING for DocBook export.
+Applies all active conversions. If there are links in the
+string, don't modify these."
+ (let* ((re (concat org-bracket-link-regexp "\\|"
+ (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
+ m s l res)
+ (while (setq m (string-match re string))
+ (setq s (substring string 0 m)
+ l (match-string 0 string)
+ string (substring string (match-end 0)))
+ (push (org-docbook-do-expand s) res)
+ (push l res))
+ (push (org-docbook-do-expand string) res)
+ (apply 'concat (nreverse res))))
+
+(defun org-docbook-do-expand (s)
+ "Apply all active conversions to translate special ASCII to DocBook."
+ (setq s (org-html-protect s))
+ (while (string-match "@<\\([^&]*\\)>" s)
+ (setq s (replace-match "<\\1>" t nil s)))
+ (if org-export-with-emphasize
+ (setq s (org-export-docbook-convert-emphasize s)))
+ (if org-export-with-special-strings
+ (setq s (org-export-docbook-convert-special-strings s)))
+ (if org-export-with-sub-superscripts
+ (setq s (org-export-docbook-convert-sub-super s)))
+ (if org-export-with-TeX-macros
+ (let ((start 0) wd ass)
+ (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)\\({}\\)?"
+ s start))
+ (if (get-text-property (match-beginning 0) 'org-protected s)
+ (setq start (match-end 0))
+ (setq wd (match-string 1 s))
+ (if (setq ass (assoc wd org-html-entities))
+ (setq s (replace-match (or (cdr ass)
+ (concat "&" (car ass) ";"))
+ t t s))
+ (setq start (+ start (length wd))))))))
+ s)
+
+(defun org-export-docbook-format-desc (desc)
+ "Make sure DESC is valid as a description in a link."
+ (save-match-data
+ (org-docbook-do-expand desc)))
+
+(defun org-export-docbook-convert-emphasize (string)
+ "Apply emphasis for DocBook exporting."
+ (let ((s 0) rpl)
+ (while (string-match org-emph-re string s)
+ (if (not (equal
+ (substring string (match-beginning 3) (1+ (match-beginning 3)))
+ (substring string (match-beginning 4) (1+ (match-beginning 4)))))
+ (setq s (match-beginning 0)
+ rpl
+ (concat
+ (match-string 1 string)
+ (nth 1 (assoc (match-string 3 string)
+ org-export-docbook-emphasis-alist))
+ (match-string 4 string)
+ (nth 2 (assoc (match-string 3 string)
+ org-export-docbook-emphasis-alist))
+ (match-string 5 string))
+ string (replace-match rpl t t string)
+ s (+ s (- (length rpl) 2)))
+ (setq s (1+ s))))
+ string))
+
+(defun org-docbook-protect (string)
+ (org-html-protect string))
+
+;; For now, simply return string as it is.
+(defun org-export-docbook-convert-special-strings (string)
+ "Convert special characters in STRING to DocBook."
+ string)
+
+(defun org-export-docbook-get-footnotes (lines)
+ "Given a list of LINES, return a list of alist footnotes."
+ (let ((list nil) line)
+ (while (setq line (pop lines))
+ (if (string-match "^[ \t]*\\[\\([0-9]+\\)\\] \\(.+\\)" line)
+ (push (cons (match-string 1 line) (match-string 2 line))
+ list)))
+ list))
+
+(defun org-export-docbook-format-image (src)
+ "Create image element in DocBook."
+ (save-match-data
+ (let* ((caption (org-find-text-property-in-string 'org-caption src))
+ (attr (or (org-find-text-property-in-string 'org-attributes src)
+ ""))
+ (label (org-find-text-property-in-string 'org-label src))
+ (default-attr org-export-docbook-default-image-attributes)
+ tmp)
+ (while (setq tmp (pop default-attr))
+ (if (not (string-match (concat (car tmp) "=") attr))
+ (setq attr (concat attr " " (car tmp) "=" (cdr tmp)))))
+ (format "<mediaobject%s>
+<imageobject>\n<imagedata fileref=\"%s\" %s/>\n</imageobject>
+%s</mediaobject>"
+ (if label (concat " xml:id=\"" label "\"") "")
+ src attr
+ (if caption
+ (concat "<caption>\n<para>"
+ caption
+ "</para>\n</caption>\n")
+ "")
+ ))))
+
+(defun org-export-docbook-preprocess (parameters)
+ "Extra preprocessing work for DocBook export."
+ ;; Merge lines starting with "\par" to one line. Such lines are
+ ;; regarded as the continuation of a long footnote.
+ (goto-char (point-min))
+ (while (re-search-forward "\n\\(\\\\par\\>\\)" nil t)
+ (if (not (get-text-property (match-beginning 1) 'org-protected))
+ (replace-match ""))))
+
+(defun org-export-docbook-finalize-table (table)
+ "Change TABLE to informaltable if caption does not exist.
+TABLE is a string containing the HTML code generated by
+`org-format-table-html' for a table in Org-mode buffer."
+ (if (string-match
+ "^<table \\(\\(.\\|\n\\)+\\)<caption></caption>\n\\(\\(.\\|\n\\)+\\)</table>"
+ table)
+ (replace-match (concat "<informaltable "
+ (match-string 1 table)
+ (match-string 3 table)
+ "</informaltable>")
+ nil nil table)
+ table))
+
+;; Note: This function is very similar to
+;; org-export-html-convert-sub-super. They can be merged in the future.
+(defun org-export-docbook-convert-sub-super (string)
+ "Convert sub- and superscripts in STRING for DocBook."
+ (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
+ (while (string-match org-match-substring-regexp string s)
+ (cond
+ ((and requireb (match-end 8)) (setq s (match-end 2)))
+ ((get-text-property (match-beginning 2) 'org-protected string)
+ (setq s (match-end 2)))
+ (t
+ (setq s (match-end 1)
+ key (if (string= (match-string 2 string) "_")
+ "subscript"
+ "superscript")
+ c (or (match-string 8 string)
+ (match-string 6 string)
+ (match-string 5 string))
+ string (replace-match
+ (concat (match-string 1 string)
+ "<" key ">" c "</" key ">")
+ t t string)))))
+ (while (string-match "\\\\\\([_^]\\)" string)
+ (setq string (replace-match (match-string 1 string) t t string)))
+ string))
+
+(defun org-export-docbook-protect-tags (string)
+ "Change ``<...>'' in string STRING into ``@<...>''.
+This is normally needed when STRING contains DocBook elements
+that need to be preserved in later phase of DocBook exporting."
+ (let ((start 0))
+ (while (string-match "<\\([^>]*\\)>" string start)
+ (setq string (replace-match
+ "@<\\1>" t nil string)
+ start (match-end 0)))
+ string))
+
+(defun org-export-docbook-handle-time-stamps (line)
+ "Format time stamps in string LINE."
+ (let (replaced
+ (kw-markup (org-export-docbook-protect-tags
+ org-export-docbook-keywords-markup))
+ (ts-markup (org-export-docbook-protect-tags
+ org-export-docbook-timestamp-markup)))
+ (while (string-match org-maybe-keyword-time-regexp line)
+ (setq replaced
+ (concat replaced
+ (substring line 0 (match-beginning 0))
+ (if (match-end 1)
+ (format kw-markup
+ (match-string 1 line)))
+ " "
+ (format ts-markup
+ (substring (org-translate-time
+ (match-string 3 line)) 1 -1)))
+ line (substring line (match-end 0))))
+ (concat replaced line)))
+
+(provide 'org-docbook)
+
+;;; org-docbook.el ends here
--- /dev/null
+;;; org-exp-blocks.el --- pre-process blocks when exporting org files
+
+;; Copyright (C) 2009
+;; Free Software Foundation, Inc.
+
+;; Author: Eric Schulte
+
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; This is a utility for pre-processing blocks in org files before
+;; export using the `org-export-preprocess-hook'. It can be used for
+;; exporting new types of blocks from org-mode files and also for
+;; changing the default export behavior of existing org-mode blocks.
+;; The `org-export-blocks' and `org-export-interblocks' variables can
+;; be used to control how blocks and the spaces between blocks
+;; respectively are processed upon export.
+;;
+;; The type of a block is defined as the string following =#+begin_=,
+;; so for example the following block would be of type ditaa. Note
+;; that both upper or lower case are allowed in =#+BEGIN_= and
+;; =#+END_=.
+;;
+;; #+begin_ditaa blue.png -r -S
+;; +---------+
+;; | cBLU |
+;; | |
+;; | +----+
+;; | |cPNK|
+;; | | |
+;; +----+----+
+;; #+end_ditaa
+;;
+;;; Currently Implemented Block Types
+;;
+;; ditaa :: Convert ascii pictures to actual images using ditaa
+;; http://ditaa.sourceforge.net/. To use this set
+;; `org-ditaa-jar-path' to the path to ditaa.jar on your
+;; system (should be set automatically in most cases) .
+;;
+;; dot :: Convert graphs defined using the dot graphing language to
+;; images using the dot utility. For information on dot see
+;; http://www.graphviz.org/
+;;
+;; comment :: Wrap comments with titles and author information, in
+;; their own divs with author-specific ids allowing for css
+;; coloring of comments based on the author.
+;;
+;; R :: Implements Sweave type exporting, evaluates blocks of R code,
+;; and also replaces \R{} chunks in the file with their result
+;; when passed to R. This require the `R' command which is
+;; provided by ESS (Emacs Speaks Statistics).
+;;
+;;; Adding new blocks
+;;
+;; When adding a new block type first define a formatting function
+;; along the same lines as `org-export-blocks-format-dot' and then use
+;; `org-export-blocks-add-block' to add your block type to
+;; `org-export-blocks'.
+
+(eval-when-compile
+ (require 'cl))
+(require 'org)
+
+(defvar comint-last-input-end)
+(defvar comint-prompt-regexp)
+(defvar comint-last-input-end)
+(defvar htmlp)
+(defvar latexp)
+(defvar docbookp)
+(defvar asciip)
+
+(declare-function comint-send-input "comint" (&optional no-newline artificial))
+(declare-function R "ess" nil)
+
+(defun org-export-blocks-set (var value)
+ "Set the value of `org-export-blocks' and install fontification."
+ (set var value)
+ (mapc (lambda (spec)
+ (if (nth 2 spec)
+ (setq org-protecting-blocks
+ (delete (symbol-name (car spec))
+ org-protecting-blocks))
+ (add-to-list 'org-protecting-blocks
+ (symbol-name (car spec)))))
+ value))
+
+(defcustom org-export-blocks
+ '((comment org-export-blocks-format-comment t)
+ (ditaa org-export-blocks-format-ditaa nil)
+ (dot org-export-blocks-format-dot nil)
+ (r org-export-blocks-format-R nil)
+ (R org-export-blocks-format-R nil))
+ "Use this a-list to associate block types with block exporting
+functions. The type of a block is determined by the text
+immediately following the '#+BEGIN_' portion of the block header.
+Each block export function should accept three argumets..."
+ :group 'org-export-general
+ :type '(repeat
+ (list
+ (symbol :tag "Block name")
+ (function :tag "Block formatter")
+ (boolean :tag "Fontify content as Org syntax")))
+ :set 'org-export-blocks-set)
+
+(defun org-export-blocks-add-block (block-spec)
+ "Add a new block type to `org-export-blocks'. BLOCK-SPEC
+should be a three element list the first element of which should
+indicate the name of the block, the second element should be the
+formatting function called by `org-export-blocks-preprocess' and
+the third element a flag indicating whether these types of blocks
+should be fontified in org-mode buffers (see
+`org-protecting-blocks'). For example the BLOCK-SPEC for ditaa
+blocks is as follows...
+
+ (ditaa org-export-blocks-format-ditaa nil)"
+ (unless (member block-spec org-export-blocks)
+ (setq org-export-blocks (cons block-spec org-export-blocks))
+ (org-export-blocks-set 'org-export-blocks org-export-blocks)))
+
+(defcustom org-export-interblocks
+ '((r org-export-interblocks-format-R)
+ (R org-export-interblocks-format-R))
+ "Use this a-list to associate block types with block exporting
+functions. The type of a block is determined by the text
+immediately following the '#+BEGIN_' portion of the block header.
+Each block export function should accept three argumets..."
+ :group 'org-export-general
+ :type 'alist)
+
+(defcustom org-export-blocks-witheld
+ '(hidden)
+ "List of block types (see `org-export-blocks') which should not
+be exported."
+ :group 'org-export-general
+ :type 'list)
+
+(defvar org-export-blocks-postblock-hooks nil "")
+
+(defun org-export-blocks-html-quote (body &optional open close)
+ "Protext BODY from org html export. The optional OPEN and
+CLOSE tags will be inserted around BODY."
+ (concat
+ "\n#+BEGIN_HTML\n"
+ (or open "")
+ body (if (string-match "\n$" body) "" "\n")
+ (or close "")
+ "#+END_HTML\n"))
+
+(defun org-export-blocks-latex-quote (body &optional open close)
+ "Protext BODY from org latex export. The optional OPEN and
+CLOSE tags will be inserted around BODY."
+ (concat
+ "\n#+BEGIN_LaTeX\n"
+ (or open "")
+ body (if (string-match "\n$" body) "" "\n")
+ (or close "")
+ "#+END_LaTeX\n"))
+
+(defun org-export-blocks-preprocess ()
+ "Export all blocks acording to the `org-export-blocks' block
+exportation alist. Does not export block types specified in
+specified in BLOCKS which default to the value of
+`org-export-blocks-witheld'."
+ (interactive)
+ (save-window-excursion
+ (let ((count 0)
+ (blocks org-export-blocks-witheld)
+ (case-fold-search t)
+ (types '())
+ indentation type func start end)
+ (flet ((interblock (start end type)
+ (save-match-data
+ (when (setf func (cadr (assoc type org-export-interblocks)))
+ (funcall func start end)))))
+ (goto-char (point-min))
+ (setf start (point))
+ (while (re-search-forward
+ "^\\([ \t]*\\)#\\+begin_\\(\\S-+\\)[ \t]*\\(.*\\)?[\r\n]\\([^\000]*?\\)[\r\n][ \t]*#\\+end_\\S-+.*" nil t)
+ (save-match-data (setq indentation (length (match-string 1))))
+ (save-match-data (setf type (intern (match-string 2))))
+ (unless (memq type types) (setf types (cons type types)))
+ (setf end (save-match-data (match-beginning 0)))
+ (interblock start end type)
+ (if (setf func (cadr (assoc type org-export-blocks)))
+ (progn
+ (replace-match (save-match-data
+ (if (memq type blocks)
+ ""
+ (apply func (save-match-data (org-remove-indentation (match-string 4)))
+ (split-string (match-string 3) " ")))) t t)
+ ;; indent the replaced match
+ (indent-region (match-beginning 0) (match-end 0) indentation)
+ ))
+ (setf start (save-match-data (match-end 0))))
+ (mapcar (lambda (type)
+ (interblock start (point-max) type))
+ types)))))
+
+(add-hook 'org-export-preprocess-hook 'org-export-blocks-preprocess)
+
+;;================================================================================
+;; type specific functions
+
+;;--------------------------------------------------------------------------------
+;; ditaa: create images from ASCII art using the ditaa utility
+(defvar org-ditaa-jar-path (expand-file-name
+ "ditaa.jar"
+ (file-name-as-directory
+ (expand-file-name
+ "scripts"
+ (file-name-as-directory
+ (expand-file-name
+ "../contrib"
+ (file-name-directory (or load-file-name buffer-file-name)))))))
+ "Path to the ditaa jar executable")
+
+(defun org-export-blocks-format-ditaa (body &rest headers)
+ "Pass block BODY to the ditaa utility creating an image.
+Specify the path at which the image should be saved as the first
+element of headers, any additional elements of headers will be
+passed to the ditaa utility as command line arguments."
+ (message "ditaa-formatting...")
+ (let ((out-file (if headers (car headers)))
+ (args (if (cdr headers) (mapconcat 'identity (cdr headers) " ")))
+ (data-file (make-temp-file "org-ditaa")))
+ (unless (file-exists-p org-ditaa-jar-path)
+ (error (format "Could not find ditaa.jar at %s" org-ditaa-jar-path)))
+ (setq body (if (string-match "^\\([^:\\|:[^ ]\\)" body)
+ body
+ (mapconcat (lambda (x) (substring x (if (> (length x) 1) 2 1)))
+ (org-split-string body "\n")
+ "\n")))
+ (cond
+ ((or htmlp latexp docbookp)
+ (with-temp-file data-file (insert body))
+ (message (concat "java -jar " org-ditaa-jar-path " " args " " data-file " " out-file))
+ (shell-command (concat "java -jar " org-ditaa-jar-path " " args " " data-file " " out-file))
+ (format "\n[[file:%s]]\n" out-file))
+ (t (concat
+ "\n#+BEGIN_EXAMPLE\n"
+ body (if (string-match "\n$" body) "" "\n")
+ "#+END_EXAMPLE\n")))))
+
+;;--------------------------------------------------------------------------------
+;; dot: create graphs using the dot graphing language
+;; (require the dot executable to be in your path)
+(defun org-export-blocks-format-dot (body &rest headers)
+ "Pass block BODY to the dot graphing utility creating an image.
+Specify the path at which the image should be saved as the first
+element of headers, any additional elements of headers will be
+passed to the dot utility as command line arguments. Don't
+forget to specify the output type for the dot command, so if you
+are exporting to a file with a name like 'image.png' you should
+include a '-Tpng' argument, and your block should look like the
+following.
+
+#+begin_dot models.png -Tpng
+digraph data_relationships {
+ \"data_requirement\" [shape=Mrecord, label=\"{DataRequirement|description\lformat\l}\"]
+ \"data_product\" [shape=Mrecord, label=\"{DataProduct|name\lversion\lpoc\lformat\l}\"]
+ \"data_requirement\" -> \"data_product\"
+}
+#+end_dot"
+ (message "dot-formatting...")
+ (let ((out-file (if headers (car headers)))
+ (args (if (cdr headers) (mapconcat 'identity (cdr headers) " ")))
+ (data-file (make-temp-file "org-ditaa")))
+ (cond
+ ((or htmlp latexp docbookp)
+ (with-temp-file data-file (insert body))
+ (message (concat "dot " data-file " " args " -o " out-file))
+ (shell-command (concat "dot " data-file " " args " -o " out-file))
+ (format "\n[[file:%s]]\n" out-file))
+ (t (concat
+ "\n#+BEGIN_EXAMPLE\n"
+ body (if (string-match "\n$" body) "" "\n")
+ "#+END_EXAMPLE\n")))))
+
+;;--------------------------------------------------------------------------------
+;; comment: export comments in author-specific css-stylable divs
+(defun org-export-blocks-format-comment (body &rest headers)
+ "Format comment BODY by OWNER and return it formatted for export.
+Currently, this only does something for HTML export, for all
+other backends, it converts the comment into an EXAMPLE segment."
+ (let ((owner (if headers (car headers)))
+ (title (if (cdr headers) (mapconcat 'identity (cdr headers) " "))))
+ (cond
+ (htmlp ;; We are exporting to HTML
+ (concat "#+BEGIN_HTML\n"
+ "<div class=\"org-comment\""
+ (if owner (format " id=\"org-comment-%s\" " owner))
+ ">\n"
+ (if owner (concat "<b>" owner "</b> ") "")
+ (if (and title (> (length title) 0)) (concat " -- " title "</br>\n") "</br>\n")
+ "<p>\n"
+ "#+END_HTML\n"
+ body
+ "#+BEGIN_HTML\n"
+ "</p>\n"
+ "</div>\n"
+ "#+END_HTML\n"))
+ (t ;; This is not HTML, so just make it an example.
+ (concat "#+BEGIN_EXAMPLE\n"
+ (if title (concat "Title:" title "\n") "")
+ (if owner (concat "By:" owner "\n") "")
+ body
+ (if (string-match "\n\\'" body) "" "\n")
+ "#+END_EXAMPLE\n")))))
+
+;;--------------------------------------------------------------------------------
+;; R: Sweave-type functionality
+(defvar interblock-R-buffer nil
+ "Holds the buffer for the current R process")
+
+(defvar count) ; dynamicaly scoped from `org-export-blocks-preprocess'?
+(defun org-export-blocks-format-R (body &rest headers)
+ "Process R blocks and replace \R{} forms outside the blocks
+with their values as determined by R."
+ (interactive)
+ (message "R processing...")
+ (let ((image-path (or (and (car headers)
+ (string-match "\\(.?\\)\.\\(EPS\\|eps\\)" (car headers))
+ (match-string 1 (car headers)))
+ (and (> (length (car headers)) 0)
+ (car headers))
+ ;; create the default filename
+ (format "Rplot-%03d" count)))
+ (plot (string-match "plot" body))
+ R-proc)
+ (setf count (+ count 1))
+ (interblock-initiate-R-buffer)
+ (setf R-proc (get-buffer-process interblock-R-buffer))
+ ;; send strings to the ESS process using `comint-send-string'
+ (setf body (mapconcat (lambda (line)
+ (interblock-R-input-command line) (concat "> " line))
+ (butlast (split-string body "[\r\n]"))
+ "\n"))
+ ;; if there is a plot command, then create the images
+ (when plot
+ (interblock-R-input-command (format "dev.copy2eps(file=\"%s.eps\")" image-path)))
+ (concat (cond
+ (htmlp (org-export-blocks-html-quote body
+ (format "<div id=\"R-%d\">\n<pre>\n" count)
+ "</pre>\n</div>\n"))
+ (latexp (org-export-blocks-latex-quote body
+ "\\begin{Schunk}\n\\begin{Sinput}\n"
+ "\\end{Sinput}\n\\end{Schunk}\n"))
+ (t (insert ;; default export
+ "#+begin_R " (mapconcat 'identity headers " ") "\n"
+ body (if (string-match "\n$" body) "" "\n")
+ "#+end_R\n")))
+ (if plot
+ (format "[[file:%s.eps]]\n" image-path)
+ ""))))
+
+(defun org-export-interblocks-format-R (start end)
+ "This is run over parts of the org-file which are between R
+blocks. It's main use is to expand the \R{stuff} chunks for
+export."
+ (save-excursion
+ (goto-char start)
+ (interblock-initiate-R-buffer)
+ (let (code replacement)
+ (while (and (< (point) end) (re-search-forward "\\\\R{\\(.*\\)}" end t))
+ (save-match-data (setf code (match-string 1)))
+ (setf replacement (interblock-R-command-to-string code))
+ (setf replacement (cond
+ (htmlp replacement)
+ (latexp replacement)
+ (t replacement)))
+ (setf end (+ end (- (length replacement) (length code))))
+ (replace-match replacement t t)))))
+
+(defun interblock-initiate-R-buffer ()
+ "If there is not a current R process then create one."
+ (unless (and (buffer-live-p interblock-R-buffer) (get-buffer interblock-R-buffer))
+ (save-excursion
+ (R)
+ (setf interblock-R-buffer (current-buffer))
+ (interblock-R-wait-for-output)
+ (interblock-R-input-command ""))))
+
+(defun interblock-R-command-to-string (command)
+ "Send a command to R, and return the results as a string."
+ (interblock-R-input-command command)
+ (interblock-R-last-output))
+
+(defun interblock-R-input-command (command)
+ "Pass COMMAND to the R process running in `interblock-R-buffer'."
+ (save-excursion
+ (save-match-data
+ (set-buffer interblock-R-buffer)
+ (goto-char (process-mark (get-buffer-process (current-buffer))))
+ (insert command)
+ (comint-send-input)
+ (interblock-R-wait-for-output))))
+
+(defun interblock-R-wait-for-output ()
+ "Wait until output arrives"
+ (save-excursion
+ (save-match-data
+ (set-buffer interblock-R-buffer)
+ (while (progn
+ (goto-char comint-last-input-end)
+ (not (re-search-forward comint-prompt-regexp nil t)))
+ (accept-process-output (get-buffer-process (current-buffer)))))))
+
+(defun interblock-R-last-output ()
+ "Return the last R output as a string"
+ (save-excursion
+ (save-match-data
+ (set-buffer interblock-R-buffer)
+ (goto-char (process-mark (get-buffer-process (current-buffer))))
+ (forward-line 0)
+ (let ((raw (buffer-substring comint-last-input-end (- (point) 1))))
+ (if (string-match "\n" raw)
+ raw
+ (and (string-match "\\[[[:digit:]+]\\] *\\(.*\\)$" raw)
+ (message raw)
+ (message (match-string 1 raw))
+ (match-string 1 raw)))))))
+
+(provide 'org-exp-blocks)
+
+;;; org-exp-blocks.el ends here
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(require 'org)
(require 'org-agenda)
+(require 'org-exp-blocks)
(eval-and-compile
(require 'cl))
-(declare-function org-export-latex-preprocess "org-export-latex" ())
+(declare-function org-export-latex-preprocess "org-latex" (parameters))
+(declare-function org-export-ascii-preprocess "org-ascii" (parameters))
+(declare-function org-export-html-preprocess "org-html" (parameters))
+(declare-function org-export-docbook-preprocess "org-docbook" (parameters))
(declare-function org-agenda-skip "org-agenda" ())
(declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
-(declare-function htmlize-region "ext:htmlize" (beg end))
-(declare-function org-id-find-id-file "org-id" (id))
-(defvar htmlize-buffer-places) ; from htmlize.el
-
+(declare-function org-export-htmlize-region-for-paste "org-html" (beg end))
+(declare-function htmlize-buffer "htmlize" (&optional buffer))
+(autoload 'org-export-generic "org-export-generic" "Export using the generic exporter" t)
(defgroup org-export nil
"Options for exporting org-listings."
:tag "Org Export"
:tag "Org Export General"
:group 'org-export)
+(defcustom org-export-allow-BIND 'confirm
+ "Non-nil means, allow #+BIND to define local variable values for export.
+This is a potential security risk, which is why the user must confirm the
+use of these lines."
+ :group 'org-export-general
+ :type '(choice
+ (const :tag "Never" nil)
+ (const :tag "Always" t)
+ (const :tag "Make the user confirm for each file" confirm)))
+
;; FIXME
(defvar org-export-publishing-directory nil)
+(defcustom org-export-show-temporary-export-buffer t
+ "Non-nil means, show buffer after exporting to temp buffer.
+When Org exports to a file, the buffer visiting that file is ever
+shown, but remains buried. However, when exporting to a temporary
+buffer, that buffer is popped up in a second window. When this variable
+is nil, the buffer remains buried also in these cases."
+ :group 'org-export-general
+ :type 'boolean)
+
+(defcustom org-export-copy-to-kill-ring t
+ "Non-nil means, exported stuff will also be pushed onto the kill ring."
+ :group 'org-export-general
+ :type 'boolean)
+
(defcustom org-export-run-in-background nil
"Non-nil means export and publishing commands will run in background.
This works by starting up a separate Emacs process visiting the same file
:group 'org-export-general
:type 'boolean)
-
(defcustom org-export-select-tags '("export")
"Tags that select a tree for export.
If any such tag is found in a buffer, all trees that do not carry one
:group 'org-export-general
:type '(repeat (string :tag "Tag")))
+;; FIXME: rename, this is a general variable
+(defcustom org-export-html-expand t
+ "Non-nil means, for HTML export, treat @<...> as HTML tag.
+When nil, these tags will be exported as plain text and therefore
+not be interpreted by a browser.
+
+This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
+ :group 'org-export-html
+ :group 'org-export-general
+ :type 'boolean)
+
(defcustom org-export-with-special-strings t
"Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
When this option is turned on, these strings will be exported as:
:group 'org-export-translation
:type 'boolean)
+(defcustom org-export-html-link-up ""
+ "Where should the \"UP\" link of exported HTML pages lead?"
+ :group 'org-export-html
+ :group 'org-export-general
+ :type '(string :tag "File or URL"))
+
+(defcustom org-export-html-link-home ""
+ "Where should the \"HOME\" link of exported HTML pages lead?"
+ :group 'org-export-html
+ :group 'org-export-general
+ :type '(string :tag "File or URL"))
+
(defcustom org-export-language-setup
'(("en" "Author" "Date" "Table of Contents" "Footnotes")
("ca" "Autor" "Data" "Índex" "Peus de pàgina")
:group 'org-export-general
:type 'string)
+(defvar org-export-page-description ""
+ "The page description, for the XHTML meta tag.
+This is best set with the #+DESCRIPTION line in a file, it does not make
+sense to set this globally.")
+
+(defvar org-export-page-keywords ""
+ "The page description, for the XHTML meta tag.
+This is best set with the #+KEYWORDS line in a file, it does not make
+sense to set this globally.")
+
(defcustom org-export-skip-text-before-1st-heading nil
"Non-nil means, skip all text before the first headline when exporting.
When nil, that text is exported as well."
This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
:group 'org-export-general
- :type 'number)
+ :type 'integer)
(defcustom org-export-with-section-numbers t
"Non-nil means, add section numbers to headlines when exporting.
:type 'boolean)
(defcustom org-export-remove-timestamps-from-toc t
- "If nil, remove timestamps from the table of contents entries."
+ "If t, remove timestamps from the table of contents entries."
:group 'org-export-general
:type 'boolean)
This selection includes tags-based selection, as well as removal
of commented and archived trees.")
+(defvar org-export-preprocess-after-blockquote-hook nil
+ "Hook for preprocessing an export buffer.
+This is run after blockquote/quote/verse/center have been marked
+with cookies.")
+
(defvar org-export-preprocess-before-backend-specifics-hook nil
"Hook run before backend-specific functions are called during preprocessing.")
:group 'org-export-translation
:type 'boolean)
-(defcustom org-export-html-footnotes-section "<div id=\"footnotes\">
-<h2 class=\"footnotes\">%s: </h2>
-<div id=\"text-footnotes\">
-%s
-</div>
-</div>"
- "Format for the footnotes section.
-Should contain a two instances of %s. The first will be replaced with the
-language-specific word for \"Footnotes\", the second one will be replaced
-by the footnotes themselves."
- :group 'org-export-html
- :type 'string)
-
(defcustom org-export-with-sub-superscripts t
"Non-nil means, interpret \"_\" and \"^\" for export.
When this option is turned on, you can use TeX-like syntax for sub- and
like $a=b$ and \\( a=b \\) for inline math, $$a=b$$ and \\[ a=b \\] for
display math.
-This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\"."
+This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\".
+
+The default is nil, because this option needs the `dvipng' program which
+is not available on all systems."
:group 'org-export-translation
:group 'org-export-latex
:type 'boolean)
:group 'org-export-tables
:type 'boolean)
-(defgroup org-export-ascii nil
- "Options specific for ASCII export of Org-mode files."
- :tag "Org Export ASCII"
- :group 'org-export)
-
-(defcustom org-export-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
- "Characters for underlining headings in ASCII export.
-In the given sequence, these characters will be used for level 1, 2, ..."
- :group 'org-export-ascii
- :type '(repeat character))
-
-(defcustom org-export-ascii-bullets '(?* ?+ ?-)
- "Bullet characters for headlines converted to lists in ASCII export.
-The first character is used for the first lest level generated in this
-way, and so on. If there are more levels than characters given here,
-the list will be repeated.
-Note that plain lists will keep the same bullets as the have in the
-Org-mode file."
- :group 'org-export-ascii
- :type '(repeat character))
(defgroup org-export-xml nil
"Options specific for XML export of Org-mode files."
:tag "Org Export XML"
:group 'org-export)
-(defgroup org-export-html nil
- "Options specific for HTML export of Org-mode files."
- :tag "Org Export HTML"
- :group 'org-export)
-
-(defcustom org-export-html-coding-system nil
- "Coding system for HTML export, defaults to buffer-file-coding-system."
- :group 'org-export-html
- :type 'coding-system)
-
-(defcustom org-export-html-extension "html"
- "The extension for exported HTML files."
- :group 'org-export-html
- :type 'string)
-
-(defcustom org-export-html-link-up ""
- "Where should the \"UP\" link of exported HTML pages lead?"
- :group 'org-export-html
- :type '(string :tag "File or URL"))
-
-(defcustom org-export-html-link-home ""
- "Where should the \"HOME\" link of exported HTML pages lead?"
- :group 'org-export-html
- :type '(string :tag "File or URL"))
-
-(defconst org-export-html-scripts
-"<script type=\"text/javascript\">
-<!--/*--><![CDATA[/*><!--*/
- function CodeHighlightOn(elem, id)
- {
- var target = document.getElementById(id);
- if(null != target) {
- elem.cacheClassElem = elem.className;
- elem.cacheClassTarget = target.className;
- target.className = \"code-highlighted\";
- elem.className = \"code-highlighted\";
- }
- }
- function CodeHighlightOff(elem, id)
- {
- var target = document.getElementById(id);
- if(elem.cacheClassElem)
- elem.className = elem.cacheClassElem;
- if(elem.cacheClassTarget)
- target.className = elem.cacheClassTarget;
- }
-/*]]>*/-->
-</script>"
-"Basic javascript that is needed by HTML files produced by Org-mode.")
-
-(defconst org-export-html-style-default
-"<style type=\"text/css\">
- <!--/*--><![CDATA[/*><!--*/
- html { font-family: Times, serif; font-size: 12pt; }
- .title { text-align: center; }
- .todo { color: red; }
- .done { color: green; }
- .tag { background-color:lightblue; font-weight:normal }
- .target { }
- .timestamp { color: grey }
- .timestamp-kwd { color: CadetBlue }
- p.verse { margin-left: 3% }
- pre {
- border: 1pt solid #AEBDCC;
- background-color: #F3F5F7;
- padding: 5pt;
- font-family: courier, monospace;
- font-size: 90%;
- overflow:auto;
- }
- table { border-collapse: collapse; }
- td, th { vertical-align: top; }
- dt { font-weight: bold; }
- div.figure { padding: 0.5em; }
- div.figure p { text-align: center; }
- .linenr { font-size:smaller }
- .code-highlighted {background-color:#ffff00;}
- .org-info-js_info-navigation { border-style:none; }
- #org-info-js_console-label { font-size:10px; font-weight:bold;
- white-space:nowrap; }
- .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
- font-weight:bold; }
- /*]]>*/-->
-</style>"
- "The default style specification for exported HTML files.
-Please use the variables `org-export-html-style' and
-`org-export-html-style-extra' to add to this style. If you wish to not
-have the default style included, customize the variable
-`org-export-html-style-include-default'.")
-
-(defcustom org-export-html-style-include-default t
- "Non-nil means, include the default style in exported HTML files.
-The actual style is defined in `org-export-html-style-default' and should
-not be modified. Use the variables `org-export-html-style' to add
-your own style information."
- :group 'org-export-html
- :type 'boolean)
-;;;###autoload
-(put 'org-export-html-style 'safe-local-variable 'booleanp)
-
-(defcustom org-export-html-style ""
- "Org-wide style definitions for exported HTML files.
-
-This variable needs to contain the full HTML structure to provide a style,
-including the surrounding HTML tags. If you set the value of this variable,
-you should consider to include definitions for the following classes:
- title, todo, done, timestamp, timestamp-kwd, tag, target.
-
-For example, a valid value would be:
-
- <style type=\"text/css\">
- <![CDATA[
- p { font-weight: normal; color: gray; }
- h1 { color: black; }
- .title { text-align: center; }
- .todo, .timestamp-kwd { color: red; }
- .done { color: green; }
- ]]>
- </style>
-
-If you'd like to refer to en external style file, use something like
-
- <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
-
-As the value of this option simply gets inserted into the HTML <head> header,
-you can \"misuse\" it to add arbitrary text to the header.
-See also the variable `org-export-html-style-extra'."
- :group 'org-export-html
- :type 'string)
-;;;###autoload
-(put 'org-export-html-style 'safe-local-variable 'stringp)
-
-(defcustom org-export-html-style-extra ""
- "Additional style information for HTML export.
-The value of this variable is inserted into the HTML buffer right after
-the value of `org-export-html-style'. Use this variable for per-file
-settings of style information, and do not forget to surround the style
-settings with <style>...</style> tags."
- :group 'org-export-html
- :type 'string)
-;;;###autoload
-(put 'org-export-html-style-extra 'safe-local-variable 'stringp)
-
-
-(defcustom org-export-html-title-format "<h1 class=\"title\">%s</h1>\n"
- "Format for typesetting the document title in HTML export."
- :group 'org-export-html
- :type 'string)
-
-(defcustom org-export-html-toplevel-hlevel 2
- "The <H> level for level 1 headings in HTML export."
- :group 'org-export-html
- :type 'string)
-
-(defcustom org-export-html-link-org-files-as-html t
- "Non-nil means, make file links to `file.org' point to `file.html'.
-When org-mode is exporting an org-mode file to HTML, links to
-non-html files are directly put into a href tag in HTML.
-However, links to other Org-mode files (recognized by the
-extension `.org.) should become links to the corresponding html
-file, assuming that the linked org-mode file will also be
-converted to HTML.
-When nil, the links still point to the plain `.org' file."
- :group 'org-export-html
- :type 'boolean)
-
-(defcustom org-export-html-inline-images 'maybe
- "Non-nil means, inline images into exported HTML pages.
-This is done using an <img> tag. When nil, an anchor with href is used to
-link to the image. If this option is `maybe', then images in links with
-an empty description will be inlined, while images with a description will
-be linked only."
- :group 'org-export-html
- :type '(choice (const :tag "Never" nil)
- (const :tag "Always" t)
- (const :tag "When there is no description" maybe)))
-
-(defcustom org-export-html-inline-image-extensions
- '("png" "jpeg" "jpg" "gif")
- "Extensions of image files that can be inlined into HTML."
- :group 'org-export-html
- :type '(repeat (string :tag "Extension")))
-
-;; FIXME: rename
-(defcustom org-export-html-expand t
- "Non-nil means, for HTML export, treat @<...> as HTML tag.
-When nil, these tags will be exported as plain text and therefore
-not be interpreted by a browser.
-
-This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
- :group 'org-export-html
- :type 'boolean)
-
-(defcustom org-export-html-table-tag
- "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
- "The HTML tag that is used to start a table.
-This must be a <table> tag, but you may change the options like
-borders and spacing."
- :group 'org-export-html
- :type 'string)
-
-(defcustom org-export-table-header-tags '("<th>" . "</th>")
- "The opening tag for table header fields.
-This is customizable so that alignment options can be specified."
- :group 'org-export-tables
- :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
-
-(defcustom org-export-table-data-tags '("<td>" . "</td>")
- "The opening tag for table data fields.
-This is customizable so that alignment options can be specified."
- :group 'org-export-tables
- :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
-
-(defcustom org-export-html-with-timestamp nil
- "If non-nil, write `org-export-html-html-helper-timestamp'
-into the exported HTML text. Otherwise, the buffer will just be saved
-to a file."
- :group 'org-export-html
- :type 'boolean)
-
-(defcustom org-export-html-html-helper-timestamp
- "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
- "The HTML tag used as timestamp delimiter for HTML-helper-mode."
- :group 'org-export-html
- :type 'string)
-
-(defgroup org-export-htmlize nil
- "Options for processing examples with htmlize.el."
- :tag "Org Export Htmlize"
- :group 'org-export-html)
-
-(defcustom org-export-htmlize-output-type 'inline-css
- "Output type to be used by htmlize when formatting code snippets.
-Normally this is `inline-css', but if you have defined to appropriate
-classes in your css style file, setting this to `css' means that the
-fontification will use the class names.
-See also the function `org-export-htmlize-generate-css'."
- :group 'org-export-htmlize
- :type '(choice (const css) (const inline-css)))
-
-(defcustom org-export-htmlize-css-font-prefix "org-"
- "The prefix for CSS class names for htmlize font specifications."
- :group 'org-export-htmlize
- :type 'string)
-
-(defgroup org-export-icalendar nil
- "Options specific for iCalendar export of Org-mode files."
- :tag "Org Export iCalendar"
- :group 'org-export)
-
-(defcustom org-combined-agenda-icalendar-file "~/org.ics"
- "The file name for the iCalendar file covering all agenda files.
-This file is created with the command \\[org-export-icalendar-all-agenda-files].
-The file name should be absolute, the file will be overwritten without warning."
- :group 'org-export-icalendar
- :type 'file)
-
-(defcustom org-icalendar-combined-name "OrgMode"
- "Calendar name for the combined iCalendar representing all agenda files."
- :group 'org-export-icalendar
- :type 'string)
-
-(defcustom org-icalendar-use-deadline '(event-if-not-todo todo-due)
- "Contexts where iCalendar export should use a deadline time stamp.
-This is a list with several symbols in it. Valid symbol are:
-
-event-if-todo Deadlines in TODO entries become calendar events.
-event-if-not-todo Deadlines in non-TODO entries become calendar events.
-todo-due Use deadlines in TODO entries as due-dates"
- :group 'org-export-icalendar
- :type '(set :greedy t
- (const :tag "Deadlines in non-TODO entries become events"
- event-if-not-todo)
- (const :tag "Deadline in TODO entries become events"
- event-if-todo)
- (const :tag "Deadlines in TODO entries become due-dates"
- todo-due)))
-
-(defcustom org-icalendar-use-scheduled '(todo-start)
- "Contexts where iCalendar export should use a scheduling time stamp.
-This is a list with several symbols in it. Valid symbol are:
-
-event-if-todo Scheduling time stamps in TODO entries become an event.
-event-if-not-todo Scheduling time stamps in non-TODO entries become an event.
-todo-start Scheduling time stamps in TODO entries become start date.
- Some calendar applications show TODO entries only after
- that date."
- :group 'org-export-icalendar
- :type '(set :greedy t
- (const :tag
- "SCHEDULED timestamps in non-TODO entries become events"
- event-if-not-todo)
- (const :tag "SCHEDULED timestamps in TODO entries become events"
- event-if-todo)
- (const :tag "SCHEDULED in TODO entries become start date"
- todo-start)))
-
-(defcustom org-icalendar-categories '(local-tags category)
- "Items that should be entered into the categories field.
-This is a list of symbols, the following are valid:
-
-category The Org-mode category of the current file or tree
-todo-state The todo state, if any
-local-tags The tags, defined in the current line
-all-tags All tags, including inherited ones."
- :group 'org-export-icalendar
- :type '(repeat
- (choice
- (const :tag "The file or tree category" category)
- (const :tag "The TODO state" todo-state)
- (const :tag "Tags defined in current line" local-tags)
- (const :tag "All tags, including inherited ones" all-tags))))
-
-(defcustom org-icalendar-include-todo nil
- "Non-nil means, export to iCalendar files should also cover TODO items."
- :group 'org-export-icalendar
- :type '(choice
- (const :tag "None" nil)
- (const :tag "Unfinished" t)
- (const :tag "All" all)))
-
-(defcustom org-icalendar-include-sexps t
- "Non-nil means, export to iCalendar files should also cover sexp entries.
-These are entries like in the diary, but directly in an Org-mode file."
- :group 'org-export-icalendar
- :type 'boolean)
-
-(defcustom org-icalendar-include-body 100
- "Amount of text below headline to be included in iCalendar export.
-This is a number of characters that should maximally be included.
-Properties, scheduling and clocking lines will always be removed.
-The text will be inserted into the DESCRIPTION field."
- :group 'org-export-icalendar
- :type '(choice
- (const :tag "Nothing" nil)
- (const :tag "Everything" t)
- (integer :tag "Max characters")))
-
-(defcustom org-icalendar-store-UID nil
- "Non-nil means, store any created UIDs in properties.
-The iCalendar standard requires that all entries have a unique identifier.
-Org will create these identifiers as needed. When this variable is non-nil,
-the created UIDs will be stored in the ID property of the entry. Then the
-next time this entry is exported, it will be exported with the same UID,
-superceding the previous form of it. This is essential for
-synchronization services.
-This variable is not turned on by default because we want to avoid creating
-a property drawer in every entry if people are only playing with this feature,
-or if they are only using it locally."
- :group 'org-export-icalendar
- :type 'boolean)
-
;;;; Exporting
;;; Variables, constants, and parameter plists
(defconst org-level-max 20)
-(defvar org-export-html-preamble nil
- "Preamble, to be inserted just before <body>. Set by publishing functions.")
-(defvar org-export-html-postamble nil
- "Preamble, to be inserted just after </body>. Set by publishing functions.")
-(defvar org-export-html-auto-preamble t
- "Should default preamble be inserted? Set by publishing functions.")
-(defvar org-export-html-auto-postamble t
- "Should default postamble be inserted? Set by publishing functions.")
(defvar org-current-export-file nil) ; dynamically scoped parameter
(defvar org-current-export-dir nil) ; dynamically scoped parameter
+(defvar org-export-opt-plist nil
+ "Contains the current option plist.")
+(defvar org-last-level nil) ; dynamically scoped variable
+(defvar org-min-level nil) ; dynamically scoped variable
+(defvar org-levels-open nil) ; dynamically scoped parameter
(defconst org-export-plist-vars
'((:link-up nil org-export-html-link-up)
(:link-home nil org-export-html-link-home)
(:language nil org-export-default-language)
+ (:keywords nil org-export-page-keywords)
+ (:description nil org-export-page-description)
(:customtime nil org-display-custom-times)
(:headline-levels "H" org-export-headline-levels)
(:section-numbers "num" org-export-with-section-numbers)
(:tables "|" org-export-with-tables)
(:table-auto-headline nil org-export-highlight-first-table-line)
(:style-include-default nil org-export-html-style-include-default)
+ (:style-include-scripts nil org-export-html-style-include-scripts)
(:style nil org-export-html-style)
(:style-extra nil org-export-html-style-extra)
(:agenda-style nil org-agenda-export-html-style)
(:convert-org-links nil org-export-html-link-org-files-as-html)
(:inline-images nil org-export-html-inline-images)
(:html-extension nil org-export-html-extension)
+ (:xml-declaration nil org-export-html-xml-declaration)
(:html-table-tag nil org-export-html-table-tag)
(:expand-quoted-html "@" org-export-html-expand)
(:timestamp nil org-export-html-with-timestamp)
(:author nil user-full-name)
(:email nil user-mail-address)
(:select-tags nil org-export-select-tags)
- (:exclude-tags nil org-export-exclude-tags))
+ (:exclude-tags nil org-export-exclude-tags)
+
+ (:latex-image-options nil org-export-latex-image-default-option))
"List of properties that represent export/publishing variables.
Each element is a list of 3 items:
1. The property that is used internally, and also for org-publish-project-alist
2. The string that can be used in the OPTION lines to set this option,
or nil if this option cannot be changed in this way
3. The customization variable that sets the default for this option."
-
)
(defun org-default-export-plist ()
"Return the property list with default settings for the export variables."
- (let ((l org-export-plist-vars) rtn e)
+ (let* ((infile (org-infile-export-plist))
+ (letbind (plist-get infile :let-bind))
+ (l org-export-plist-vars) rtn e s v)
(while (setq e (pop l))
- (setq rtn (cons (car e) (cons (symbol-value (nth 2 e)) rtn))))
+ (setq s (nth 2 e)
+ v (cond
+ ((assq s letbind) (nth 1 (assq s letbind)))
+ ((boundp s) (symbol-value s))
+ (t nil))
+ rtn (cons (car e) (cons v rtn))))
rtn))
(defvar org-export-inbuffer-options-extra nil
(append
'("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
"LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE" "LATEX_HEADER"
- "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS")
+ "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
+ "KEYWORDS" "DESCRIPTION" "MACRO" "BIND")
(mapcar 'car org-export-inbuffer-options-extra))))
p key val text options a pr style
- latex-header
+ latex-header macros letbind
ext-setup-or-nil setup-contents (start 0))
(while (or (and ext-setup-or-nil
(string-match re ext-setup-or-nil start)
((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
((string-equal key "EMAIL") (setq p (plist-put p :email val)))
((string-equal key "DATE") (setq p (plist-put p :date val)))
+ ((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
+ ((string-equal key "DESCRIPTION")
+ (setq p (plist-put p :description val)))
((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
((string-equal key "STYLE")
(setq style (concat style "\n" val)))
(setq text (if text (concat text "\n" val) val)))
((string-equal key "OPTIONS")
(setq options (concat val " " options)))
+ ((string-equal key "BIND")
+ (push (read (concat "(" val ")")) letbind))
((string-equal key "LINK_UP")
(setq p (plist-put p :link-up val)))
((string-equal key "LINK_HOME")
(setq p (plist-put p :select-tags (org-split-string val))))
((string-equal key "EXPORT_EXCLUDE_TAGS")
(setq p (plist-put p :exclude-tags (org-split-string val))))
+ ((string-equal key "MACRO")
+ (push val macros))
((equal key "SETUPFILE")
(setq setup-contents (org-file-contents
(expand-file-name
"\n" setup-contents "\n"
(substring ext-setup-or-nil start)))))))
(setq p (plist-put p :text text))
+ (when (and letbind (org-export-confirm-letbind))
+ (setq p (plist-put p :let-bind letbind)))
(when style (setq p (plist-put p :style-extra style)))
(when latex-header
(setq p (plist-put p :latex-header-extra (substring latex-header 1))))
(when options
(setq p (org-export-add-options-to-plist p options)))
+ ;; Add macro definitions
+ (setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
+ (setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
+ (setq p (plist-put
+ p :macro-modification-time
+ (and (buffer-file-name)
+ (file-exists-p (buffer-file-name))
+ (concat
+ "(eval (format-time-string \"$1\" '"
+ (prin1-to-string (nth 5 (file-attributes
+ (buffer-file-name))))
+ "))"))))
+ (setq p (plist-put p :macro-input-file (and (buffer-file-name)
+ (file-name-nondirectory
+ (buffer-file-name)))))
+ (while (setq val (pop macros))
+ (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
+ (setq p (plist-put
+ p (intern
+ (concat ":macro-" (downcase (match-string 1 val))))
+ (match-string 2 val)))))
p))))
+(defvar org-export-allow-BIND-local nil)
+(defun org-export-confirm-letbind ()
+ "Can we use #+BIND values during export?
+By default this will ask fro confirmation by the user, to divert possible
+security risks."
+ (cond
+ ((not org-export-allow-BIND) nil)
+ ((eq org-export-allow-BIND t) t)
+ ((local-variable-p 'org-export-allow-BIND-local (current-buffer))
+ org-export-allow-BIND-local)
+ (t (org-set-local 'org-export-allow-BIND-local
+ (yes-or-no-p "Allow BIND values in this buffer? ")))))
+
+(defun org-install-letbind ()
+ "Install the values from #+BIND lines as local variables."
+ (let ((letbind (plist-get org-export-opt-plist :let-bind)))
+ (while letbind
+ (org-set-local (caar letbind) (nth 1 (pop letbind))))))
+
(defun org-export-add-options-to-plist (p options)
"Parse an OPTIONS line and set values in the property list P."
(let (o)
;; (setq p (plist-put p :title a)))
(when (setq a (org-entry-get pos "EXPORT_TEXT"))
(setq p (plist-put p :text a)))
+ (when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
+ (setq p (plist-put p :author a)))
+ (when (setq a (org-entry-get pos "EXPORT_DATE"))
+ (setq p (plist-put p :date a)))
(when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
(setq p (org-export-add-options-to-plist p a)))))
p))
(help "[t] insert the export option template
\[v] limit export to visible part of outline tree
-\[a] export as ASCII
+\[a] export as ASCII [A] to temporary buffer
-\[h] export as HTML
-\[H] export as HTML to temporary buffer
-\[R] export region as HTML
-\[b] export as HTML and browse immediately
-\[x] export as XOXO
+\[h] export as HTML [H] to temporary buffer [R] export region
+\[b] export as HTML and open in browser
-\[l] export as LaTeX
+\[l] export as LaTeX [L] to temporary buffer
\[p] export as LaTeX and process to PDF
\[d] export as LaTeX, process to PDF, and open the resulting PDF document
-\[L] export as LaTeX to temporary buffer
+
+\[D] export as DocBook
+\[V] export as DocBook, process to PDF, and open the resulting PDF document
+
+\[x] export as XOXO
+\[g] export using Wes Hardaker's generic exporter
\[i] export current file as iCalendar file
\[I] export all agenda files as iCalendar files
\[c] export agenda files into combined iCalendar file
-\[F] publish current file
-\[P] publish current project
-\[X] publish... (project will be prompted for)
-\[A] publish all projects")
+\[F] publish current file [P] publish current project
+\[X] publish a project... [E] publish every projects")
(cmds
'((?t org-insert-export-options-template nil)
(?v org-export-visible nil)
(?a org-export-as-ascii t)
+ (?A org-export-as-ascii-to-buffer t)
(?h org-export-as-html t)
(?b org-export-as-html-and-open t)
(?H org-export-as-html-to-buffer nil)
(?R org-export-region-as-html nil)
(?x org-export-as-xoxo t)
+ (?g org-export-generic t)
+ (?D org-export-as-docbook t)
+ (?V org-export-as-docbook-pdf-and-open t)
(?l org-export-as-latex t)
(?p org-export-as-pdf t)
(?d org-export-as-pdf-and-open t)
(?F org-publish-current-file t)
(?P org-publish-current-project t)
(?X org-publish t)
- (?A org-publish-all t)))
+ (?E org-publish-all t)))
r1 r2 ass)
- (save-window-excursion
- (delete-other-windows)
- (with-output-to-temp-buffer "*Org Export/Publishing Help*"
- (princ help))
- (org-fit-window-to-buffer (get-buffer-window
- "*Org Export/Publishing Help*"))
- (message "Select command: ")
- (setq r1 (read-char-exclusive)))
+ (save-excursion
+ (save-window-excursion
+ (delete-other-windows)
+ (with-output-to-temp-buffer "*Org Export/Publishing Help*"
+ (princ help))
+ (org-fit-window-to-buffer (get-buffer-window
+ "*Org Export/Publishing Help*"))
+ (message "Select command: ")
+ (setq r1 (read-char-exclusive))))
(setq r2 (if (< r1 27) (+ r1 96) r1))
(unless (setq ass (assq r2 cmds))
(error "No command associated with key %c" r1))
("reg")
("macr")
("deg")
+ ("pm" . "±")
("plusmn")
("sup2")
("sup3")
(defvar org-export-target-aliases nil
"Alist of targets with invisible aliases.")
+(defvar org-export-preferred-target-alist nil
+ "Alist of section id's with preferred aliases.")
(defvar org-export-code-refs nil
"Alist of code references and line numbers")
(let* ((htmlp (plist-get parameters :for-html))
(asciip (plist-get parameters :for-ascii))
(latexp (plist-get parameters :for-LaTeX))
- (backend (cond (htmlp 'html) (latexp 'latex) (asciip 'ascii)))
-
+ (docbookp (plist-get parameters :for-docbook))
+ (backend (cond (htmlp 'html)
+ (latexp 'latex)
+ (asciip 'ascii)
+ (docbookp 'docbook)))
(archived-trees (plist-get parameters :archived-trees))
(inhibit-read-only t)
(drawers org-drawers)
target-alist rtn)
(setq org-export-target-aliases nil)
+ (setq org-export-preferred-target-alist nil)
(setq org-export-code-refs nil)
(with-current-buffer (get-buffer-create " org-mode-tmp")
(let ((org-inhibit-startup t)) (org-mode))
(setq case-fold-search t)
+ (org-install-letbind)
;; Call the hook
(run-hooks 'org-export-preprocess-hook)
+ ;; Process the macros
+ (org-export-preprocess-apply-macros)
+ (run-hooks 'org-export-preprocess-after-macros-hook)
+
(untabify (point-min) (point-max))
;; Handle include files, and call a hook
;; Protect quoted subtrees
(org-export-protect-quoted-subtrees)
+ ;; Remove clock lines
+ (org-export-remove-clock-lines)
+
;; Protect verbatim elements
(org-export-protect-verbatim)
- ;; Blockquotes and verse
- (org-export-mark-blockquote-and-verse)
+ ;; Blockquotes, verse, and center
+ (org-export-mark-blockquote-verse-center)
+ (run-hooks 'org-export-preprocess-after-blockquote-hook)
;; Remove timestamps, if the user has requested so
- (org-export-remove-clock-lines)
(unless (plist-get parameters :timestamps)
(org-export-remove-timestamps))
;; LaTeX-specific preprocessing
(when latexp
- (require 'org-export-latex nil)
- (org-export-latex-preprocess))
+ (require 'org-latex nil)
+ (org-export-latex-preprocess parameters))
;; ASCII-specific preprocessing
(when asciip
- (org-export-ascii-preprocess))
+ (org-export-ascii-preprocess parameters))
;; HTML-specific preprocessing
(when htmlp
(org-export-html-preprocess parameters))
+ ;; DocBook-specific preprocessing
+ (when docbookp
+ (require 'org-docbook nil)
+ (org-export-docbook-preprocess parameters))
+
;; Remove or replace comments
(org-export-handle-comments (plist-get parameters :comments))
(goto-char (point-min))
(org-init-section-numbers)
(let ((re (concat "^" org-outline-regexp
- "\\| [ \t]*:ID:[ \t]*\\([^ \t\r\n]+\\)"))
- level target last-section-target a)
+ "\\| [ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
+ level target last-section-target a id)
(while (re-search-forward re nil t)
- (if (match-end 1)
+ (if (match-end 2)
(progn
- (push (cons (org-match-string-no-properties 1)
- target) target-alist)
+ (setq id (org-match-string-no-properties 2))
+ (push (cons id target) target-alist)
(setq a (or (assoc last-section-target org-export-target-aliases)
(progn
(push (list last-section-target)
org-export-target-aliases)
(car org-export-target-aliases))))
- (push (caar target-alist) (cdr a)))
+ (push (caar target-alist) (cdr a))
+ (when (equal (match-string 1) "CUSTOM_ID")
+ (if (not (assoc last-section-target
+ org-export-preferred-target-alist))
+ (push (cons last-section-target id)
+ org-export-preferred-target-alist))))
(setq level (org-reduced-level
(save-excursion (goto-char (point-at-bol))
(org-outline-level))))
found props pos cref
(target
(cond
- ((cdr (assoc slink target-alist)))
+ ((= (string-to-char link) ?#)
+ ;; user wants exactly this link
+ link)
+ ((cdr (assoc slink target-alist))
+ (or (cdr (assoc (assoc slink target-alist)
+ org-export-preferred-target-alist))
+ (cdr (assoc slink target-alist))))
((and (string-match "^id:" link)
(cdr (assoc (substring link 3) target-alist))))
((string-match "^(\\(.*\\))$" link)
(org-delete-all exp-drawers
(copy-sequence all-drawers))
"\\|")
- "\\):[ \t]*\n\\([^\000]*?\n\\)?[ \t]*:END:[ \t]*\n")))
+ "\\):[ \t]*$"))
+ beg eol)
(while (re-search-forward re nil t)
(org-if-unprotected
- (replace-match ""))))))
+ (setq beg (match-beginning 0)
+ eol (match-end 0))
+ (if (re-search-forward "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]"
+ nil t)
+ (if (match-end 1)
+ ;; terminated in this entry
+ (progn
+ (delete-region beg (match-end 1))
+ (goto-char beg))
+ (goto-char eol))))))))
(defun org-export-handle-export-tags (select-tags exclude-tags)
"Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
(defun org-export-remove-timestamps ()
"Remove timestamps and keywords for export."
+ (goto-char (point-min))
(while (re-search-forward org-maybe-keyword-time-regexp nil t)
(backward-char 1)
(org-if-unprotected
(replace-match ""))))))
(defun org-export-remove-clock-lines ()
- "Remove timestamps and keywords for export."
+ "Remove clock lines for export."
+ (goto-char (point-min))
(let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
(while (re-search-forward re nil t)
(org-if-unprotected
(defun org-export-select-backend-specific-text (backend)
(let ((formatters
- '((html "HTML" "BEGIN_HTML" "END_HTML")
+ '((docbook "DOCBOOK" "BEGIN_DOCBOOK" "END_DOCBOOK")
+ (html "HTML" "BEGIN_HTML" "END_HTML")
(ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
(latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
(case-fold-search t)
(when (eq (car fmt) backend)
;; This is selected code, put it into the file for real
(goto-char (point-min))
- (while (re-search-forward (concat "^#\\+" (cadr fmt)
+ (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" (cadr fmt)
":[ \t]*\\(.*\\)") nil t)
- (replace-match "\\1" t)
+ (replace-match "\\1\\2" t)
(add-text-properties
(point-at-bol) (min (1+ (point-at-eol)) (point-max))
'(org-protected t))))
(goto-char (point-min))
(while (re-search-forward
- (concat "^#\\+"
- (caddr fmt) "\\>.*\\(\\(\n.*\\)*?\n\\)#\\+"
- (cadddr fmt) "\\>.*\n?") nil t)
+ (concat "^[ \t]*#\\+" (caddr fmt)
+ "\\>.*\\(\\(\n.*\\)*?\n\\)[ \t]*#\\+" (cadddr fmt)
+ "\\>.*\n?") nil t)
(if (eq (car fmt) backend)
;; yes, keep this
(add-text-properties (match-beginning 1) (1+ (match-end 1))
;; No, this is for a different backend, kill it
(delete-region (match-beginning 0) (match-end 0)))))))
-(defun org-export-mark-blockquote-and-verse ()
+(defun org-export-mark-blockquote-verse-center ()
"Mark block quote and verse environments with special cookies.
These special cookies will later be interpreted by the backend."
;; Blockquotes
- (goto-char (point-min))
- (while (re-search-forward "^#\\+\\(begin\\|end\\)_\\(block\\)?quote\\>.*"
- nil t)
- (replace-match (if (equal (downcase (match-string 1)) "end")
- "ORG-BLOCKQUOTE-END" "ORG-BLOCKQUOTE-START")
- t t))
- ;; Verse
- (goto-char (point-min))
- (while (re-search-forward "^#\\+\\(begin\\|end\\)_verse\\>.*" nil t)
- (replace-match (if (equal (downcase (match-string 1)) "end")
- "ORG-VERSE-END" "ORG-VERSE-START")
- t t)))
+ (let (type t1 ind beg end beg1 end1 content)
+ (goto-char (point-min))
+ (while (re-search-forward
+ "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
+ nil t)
+ (setq ind (length (match-string 1))
+ type (downcase (match-string 3))
+ t1 (if (equal type "quote") "blockquote" type))
+ (setq beg (match-beginning 0)
+ beg1 (1+ (match-end 0)))
+ (when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
+ (setq end (1+ (point-at-eol))
+ end1 (1- (match-beginning 0)))
+ (setq content (org-remove-indentation (buffer-substring beg1 end1)))
+ (setq content (concat "ORG-" (upcase t1) "-START\n"
+ content "\n"
+ "ORG-" (upcase t1) "-END\n"))
+ (delete-region beg end)
+ (insert (org-add-props content nil 'original-indentation ind))))))
(defun org-export-attach-captions-and-attributes (backend target-alist)
"Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
(remove-text-properties (point-min) (point-max)
'(org-caption nil org-attributes nil))
(let ((case-fold-search t)
- (re (concat "^#\\+caption:[ \t]+\\(.*\\)"
+ (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
"\\|"
- "^#\\+attr_" (symbol-name backend) ":[ \t]+\\(.*\\)"
+ "^[ \t]*#\\+attr_" (symbol-name backend) ":[ \t]+\\(.*\\)"
"\\|"
- "^#\\+label:[ \t]+\\(.*\\)"
+ "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
"\\|"
"^[ \t]*|[^-]"
"\\|"
"Remove comments, or convert to backend-specific format.
COMMENTSP can be a format string for publishing comments.
When it is nil, all comments will be removed."
- (let ((re "^#\\(.*\n?\\)")
+ (let ((re "^\\(#\\|[ \t]*#\\+\\)\\(.*\n?\\)")
pos)
(goto-char (point-min))
(while (or (looking-at re)
(re-search-forward re nil t))
(setq pos (match-beginning 0))
- (if commentsp
+ (if (and commentsp
+ (not (equal (char-before (match-end 1)) ?+)))
(progn (add-text-properties
(match-beginning 0) (match-end 0) '(org-protected t))
- (replace-match (format commentsp (match-string 1)) t t))
+ (replace-match (format commentsp (match-string 2)) t t))
(goto-char (1+ pos))
(org-if-unprotected
(replace-match "")
(goto-char (point-min))
(when re-radio
(while (re-search-forward re-radio nil t)
- (org-if-unprotected
- (replace-match "\\1[[\\2]]"))))))
+ (unless
+ (save-match-data
+ (or (org-in-regexp org-bracket-link-regexp)
+ (org-in-regexp org-plain-link-re)))
+ (org-if-unprotected
+ (replace-match "\\1[[\\2]]")))))))
(defun org-export-remove-special-table-lines ()
"Remove tables lines that are used for internal purposes."
(defun org-export-normalize-links ()
"Convert all links to bracket links, and expand link abbreviations."
(let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
- (re-angle-link (concat "\\([^[]\\)" org-angle-link-re)))
+ (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
+ nodesc)
(goto-char (point-min))
(while (re-search-forward re-plain-link nil t)
(goto-char (1- (match-end 0)))
- (org-if-unprotected
+ (org-if-unprotected-at (1+ (match-beginning 0))
(let* ((s (concat (match-string 1) "[[" (match-string 2)
":" (match-string 3) "]]")))
;; added 'org-link face to links
(goto-char (point-min))
(while (re-search-forward org-bracket-link-regexp nil t)
(goto-char (1- (match-end 0)))
+ (setq nodesc (not (match-end 3)))
(org-if-unprotected
(let* ((xx (save-match-data
(org-translate-link
(org-link-expand-abbrev (match-string 1)))))
(s (concat
"[[" (org-add-props (copy-sequence xx)
- nil 'org-protected t)
+ nil 'org-protected t 'org-no-description nodesc)
"]"
(if (match-end 3)
(match-string 2)
- (concat "[" (org-add-props
- (copy-sequence xx)
- '(org-protected t))
+ (concat "[" (copy-sequence xx)
"]"))
"]")))
(put-text-property 0 (length s) 'face 'org-link s)
(a (assoc rtn alist)))
(or (cdr a) rtn))))
-(defun org-get-min-level (lines)
+(defun org-get-min-level (lines &optional offset)
"Get the minimum level in LINES."
(let ((re "^\\(\\*+\\) ") l)
(catch 'exit
(while (setq l (pop lines))
(if (string-match re l)
- (throw 'exit (org-tr-level (length (match-string 1 l))))))
+ (throw 'exit (org-tr-level (- (length (match-string 1 l))
+ (or offset 0))))))
1)))
;; Variable holding the vector with section numbers
(pop roman)))
res)))
-(org-number-to-roman 1961)
+;;; Macros
+(defun org-export-preprocess-apply-macros ()
+ "Replace macro references."
+ (goto-char (point-min))
+ (let (sy val key args args2 s n)
+ (while (re-search-forward
+ "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\((\\(.*?\\))\\)?}}}"
+ nil t)
+ (setq key (downcase (match-string 1))
+ args (match-string 3))
+ (when (setq val (or (plist-get org-export-opt-plist
+ (intern (concat ":macro-" key)))
+ (plist-get org-export-opt-plist
+ (intern (concat ":" key)))))
+ (save-match-data
+ (when args
+ (setq args (org-split-string args ",[ \t]*") args2 nil)
+ (while args
+ (while (string-match "\\\\\\'" (car args))
+ ;; repair bad splits
+ (setcar (cdr args) (concat (substring (car args) 0 -1)
+ ";" (nth 1 args)))
+ (pop args))
+ (push (pop args) args2))
+ (setq args (nreverse args2))
+ (setq s 0)
+ (while (string-match "\\$\\([0-9]+\\)" val s)
+ (setq s (1+ (match-beginning 0))
+ n (string-to-number (match-string 1 val)))
+ (and (>= (length args) n)
+ (setq val (replace-match (nth (1- n) args) t t val)))))
+ (when (string-match "\\`(eval\\>" val)
+ (setq val (eval (read val))))
+ (if (and val (not (stringp val)))
+ (setq val (format "%s" val))))
+ (and (stringp val)
+ (replace-match val t t))))))
+
+(defun org-export-apply-macros-in-string (s)
+ "Apply the macros in string S."
+ (when s
+ (with-temp-buffer
+ (insert s)
+ (org-export-preprocess-apply-macros)
+ (buffer-string))))
;;; Include files
(setq start (format "#+begin_%s %s\n" markup switches)
end (format "#+end_%s" markup))))
(insert (or start ""))
- (insert (org-get-file-contents (expand-file-name file) prefix prefix1))
+ (insert (org-get-file-contents (expand-file-name file) prefix prefix1 markup))
(or (bolp) (newline))
(insert (or end ""))))))
-(defun org-get-file-contents (file &optional prefix prefix1)
+(defun org-get-file-contents (file &optional prefix prefix1 markup)
"Get the contents of FILE and return them as a string.
If PREFIX is a string, prepend it to each line. If PREFIX1
-is a string, prepend it to the first line instead of PREFIX."
+is a string, prepend it to the first line instead of PREFIX.
+If MARKUP, don't protect org-like lines, the exporter will
+take care of the block they are in."
(with-temp-buffer
(insert-file-contents file)
(when (or prefix prefix1)
(insert (or prefix1 prefix))
(setq prefix1 nil)
(beginning-of-line 2)))
+ (buffer-string)
+ (unless markup
+ (goto-char (point-min))
+ (while (re-search-forward "^\\(\\*\\|[ \t]*#\\)" nil t)
+ (goto-char (match-beginning 0))
+ (insert ",")
+ (end-of-line 1)))
(buffer-string)))
(defun org-get-and-remove-property (listvar prop)
"Replace source code segments with special code for export."
(setq org-export-last-code-line-counter-value 0)
(let ((case-fold-search t)
- lang code trans opts)
+ lang code trans opts indent)
(goto-char (point-min))
(while (re-search-forward
- "\\(^#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)\\(.*\\)\n\\([^\000]+?\n\\)#\\+END_SRC.*\\)\\|\\(^#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)#\\+END_EXAMPLE.*\\)"
+ "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\\)"
nil t)
(if (match-end 1)
;; src segments
- (setq lang (match-string 2)
- opts (match-string 3)
- code (match-string 4))
+ (setq lang (match-string 3)
+ opts (match-string 4)
+ code (match-string 5)
+ indent (length (match-string 2)))
(setq lang nil
- opts (match-string 6)
- code (match-string 7)))
+ opts (match-string 8)
+ code (match-string 9)
+ indent (length (match-string 7))))
(setq trans (org-export-format-source-code-or-example
- backend lang code opts))
+ backend lang code opts indent))
(replace-match trans t t))))
(defvar htmlp) ;; dynamically scoped
(defvar latexp) ;; dynamically scoped
+(defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
-(defun org-export-format-source-code-or-example (backend
- lang code &optional opts)
+(defun org-export-format-source-code-or-example
+ (backend lang code &optional opts indent)
"Format CODE from language LANG and return it formatted for export.
If LANG is nil, do not add any fontification.
OPTS contains formatting optons, like `-n' for triggering numbering lines,
and `+n' for continuing previous numering.
Code formatting according to language currently only works for HTML.
-Numbering lines works for all three major backends (html, latex, and ascii)."
+Numbering lines works for all three major backends (html, latex, and ascii).
+INDENT was the original indentation of the block."
(save-match-data
(let (num cont rtn rpllbl keepp textareap cols rows fmt)
(setq opts (or opts "")
;; we cannot use numbering or highlighting.
(setq num nil cont nil lang nil))
(if keepp (setq rpllbl 'keep))
- (setq rtn code)
- (when (equal lang "org")
+ (setq rtn (org-remove-indentation code))
+ (when (string-match "^," rtn)
(setq rtn (with-temp-buffer
(insert rtn)
;; Free up the protected lines
(goto-char (point-min))
(while (re-search-forward "^," nil t)
- (replace-match "")
+ (if (or (equal lang "org")
+ (save-match-data
+ (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
+ (replace-match ""))
(end-of-line 1))
(buffer-string))))
;; Now backend-specific coding
- (cond
- ((eq backend 'html)
- ;; We are exporting to HTML
- (when lang
- (require 'htmlize nil t)
- (when (not (fboundp 'htmlize-region-for-paste))
- ;; we do not have htmlize.el, or an old version of it
- (setq lang nil)
- (message
- "htmlize.el 1.34 or later is needed for source code formatting")))
-
- (if lang
- (let* ((mode (and lang (intern (concat lang "-mode"))))
- (org-inhibit-startup t)
- (org-startup-folded nil))
- (setq rtn
- (with-temp-buffer
- (insert rtn)
- (if (functionp mode)
- (funcall mode)
- (fundamental-mode))
- (font-lock-fontify-buffer)
- (org-export-htmlize-region-for-paste
- (point-min) (point-max))))
- (if (string-match "<pre\\([^>]*\\)>\n?" rtn)
- (setq rtn (replace-match
- (format "<pre class=\"src src-%s\">\n" lang)
- t t rtn))))
- (if textareap
- (setq rtn (concat
- (format "<p>\n<textarea cols=\"%d\" rows=\"%d\" overflow-x:scroll >\n"
- cols rows)
- rtn "</textarea>\n</p>\n"))
- (with-temp-buffer
- (insert rtn)
- (goto-char (point-min))
- (while (re-search-forward "[<>&]" nil t)
- (replace-match (cdr (assq (char-before)
- '((?&."&")(?<."<")(?>.">"))))
- t t))
- (setq rtn (buffer-string)))
- (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
- (unless textareap
- (setq rtn (org-export-number-lines rtn 'html 1 1 num
- cont rpllbl fmt)))
- (concat "\n#+BEGIN_HTML\n" (org-add-props rtn '(org-protected t)) "\n#+END_HTML\n\n"))
- ((eq backend 'latex)
- (setq rtn (org-export-number-lines rtn 'latex 0 0 num cont rpllbl fmt))
- (concat "\n#+BEGIN_LaTeX\n"
- (org-add-props (concat "\\begin{verbatim}\n" rtn "\n\\end{verbatim}\n")
- '(org-protected t))
- "#+END_LaTeX\n\n"))
- ((eq backend 'ascii)
- ;; This is not HTML or LaTeX, so just make it an example.
- (setq rtn (org-export-number-lines rtn 'ascii 0 0 num cont rpllbl fmt))
- (concat "#+BEGIN_ASCII\n"
- (org-add-props
- (concat
- (mapconcat
- (lambda (l) (concat " " l))
- (org-split-string rtn "\n")
- "\n")
- "\n")
- '(org-protected t))
- "#+END_ASCII\n"))))))
+ (setq rtn
+ (cond
+ ((eq backend 'docbook)
+ (setq rtn (org-export-number-lines rtn 'docbook 0 0 num cont rpllbl fmt))
+ (concat "\n#+BEGIN_DOCBOOK\n"
+ (org-add-props (concat "<programlisting><![CDATA["
+ rtn
+ "]]>\n</programlisting>\n")
+ '(org-protected t))
+ "#+END_DOCBOOK\n"))
+ ((eq backend 'html)
+ ;; We are exporting to HTML
+ (when lang
+ (require 'htmlize nil t)
+ (when (not (fboundp 'htmlize-region-for-paste))
+ ;; we do not have htmlize.el, or an old version of it
+ (setq lang nil)
+ (message
+ "htmlize.el 1.34 or later is needed for source code formatting")))
+
+ (if lang
+ (let* ((mode (and lang (intern (concat lang "-mode"))))
+ (org-inhibit-startup t)
+ (org-startup-folded nil))
+ (setq rtn
+ (with-temp-buffer
+ (insert rtn)
+ (if (functionp mode)
+ (funcall mode)
+ (fundamental-mode))
+ (font-lock-fontify-buffer)
+ (org-src-mode)
+ (set-buffer-modified-p nil)
+ (org-export-htmlize-region-for-paste
+ (point-min) (point-max))))
+ (if (string-match "<pre\\([^>]*\\)>\n*" rtn)
+ (setq rtn (replace-match
+ (format "<pre class=\"src src-%s\">\n" lang)
+ t t rtn))))
+ (if textareap
+ (setq rtn (concat
+ (format "<p>\n<textarea cols=\"%d\" rows=\"%d\" overflow-x:scroll >\n"
+ cols rows)
+ rtn "</textarea>\n</p>\n"))
+ (with-temp-buffer
+ (insert rtn)
+ (goto-char (point-min))
+ (while (re-search-forward "[<>&]" nil t)
+ (replace-match (cdr (assq (char-before)
+ '((?&."&")(?<."<")(?>.">"))))
+ t t))
+ (setq rtn (buffer-string)))
+ (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
+ (unless textareap
+ (setq rtn (org-export-number-lines rtn 'html 1 1 num
+ cont rpllbl fmt)))
+ (if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
+ (setq rtn (replace-match "\\1" t nil rtn)))
+ (concat "\n#+BEGIN_HTML\n" (org-add-props rtn '(org-protected t)) "\n#+END_HTML\n\n"))
+ ((eq backend 'latex)
+ (setq rtn (org-export-number-lines rtn 'latex 0 0 num cont rpllbl fmt))
+ (concat "\n#+BEGIN_LaTeX\n"
+ (org-add-props (concat (car org-export-latex-verbatim-wrap)
+ rtn (cdr org-export-latex-verbatim-wrap))
+ '(org-protected t))
+ "#+END_LaTeX\n\n"))
+ ((eq backend 'ascii)
+ ;; This is not HTML or LaTeX, so just make it an example.
+ (setq rtn (org-export-number-lines rtn 'ascii 0 0 num cont rpllbl fmt))
+ (concat "#+BEGIN_ASCII\n"
+ (org-add-props
+ (concat
+ (mapconcat
+ (lambda (l) (concat " " l))
+ (org-split-string rtn "\n")
+ "\n")
+ "\n")
+ '(org-protected t))
+ "#+END_ASCII\n"))))
+ (org-add-props rtn nil 'original-indentation indent))))
(defun org-export-number-lines (text backend
&optional skip1 skip2 number cont
replace-labels label-format)
- (if (and (not number) (not (eq replace-labels 'keep)))
- (setq replace-labels nil)) ;; must use names if no numbers
(setq skip1 (or skip1 0) skip2 (or skip2 0))
(if (not cont) (setq org-export-last-code-line-counter-value 0))
(with-temp-buffer
fmt))
((eq backend 'ascii) fmt)
((eq backend 'latex) fmt)
+ ((eq backend 'docbook) fmt)
(t "")))
(label-format (or label-format org-coderef-label-format))
(label-pre (if (string-match "%s" label-format)
(substring label-format (match-end 0))
""))
(lbl-re
- (concat
+ (concat
".*?\\S-.*?\\([ \t]*\\("
(regexp-quote label-pre)
- "\\([-a-zA-Z0-9_]+\\)"
+ "\\([-a-zA-Z0-9_ ]+\\)"
(regexp-quote label-post)
"\\)\\)"))
ref)
(if number
(insert (format fm (incf n)))
(forward-char 1))
- (when (and (not (eq replace-labels 'keep))
- (looking-at lbl-re))
+ (when (looking-at lbl-re)
(setq ref (match-string 3))
- (if replace-labels
- (progn
- (delete-region (match-beginning 1) (match-end 1))
- (push (cons ref n) org-export-code-refs))
- (goto-char (match-beginning 2))
- (delete-region (match-beginning 2) (match-end 2))
- (insert "(" ref ")")
- (push (cons ref (concat "(" ref ")")) org-export-code-refs))
+ (cond ((numberp replace-labels)
+ ;; remove labels; use numbers for references when lines
+ ;; are numbered, use labels otherwise
+ (delete-region (match-beginning 1) (match-end 1))
+ (push (cons ref (if (> n 0) n ref)) org-export-code-refs))
+ ((eq replace-labels 'keep)
+ ;; don't remove labels; use numbers for references when
+ ;; lines are numbered, use labels otherwise
+ (goto-char (match-beginning 2))
+ (delete-region (match-beginning 2) (match-end 2))
+ (insert "(" ref ")")
+ (push (cons ref (if (> n 0) n (concat "(" ref ")")))
+ org-export-code-refs))
+ (t
+ ;; don't remove labels and don't use numbers for
+ ;; references
+ (goto-char (match-beginning 2))
+ (delete-region (match-beginning 2) (match-end 2))
+ (insert "(" ref ")")
+ (push (cons ref (concat "(" ref ")")) org-export-code-refs)))
(when (eq backend 'html)
(save-excursion
(beginning-of-line 1)
(newline)
(buffer-string))))
-;;; ASCII export
-
-(defvar org-last-level nil) ; dynamically scoped variable
-(defvar org-min-level nil) ; dynamically scoped variable
-(defvar org-levels-open nil) ; dynamically scoped parameter
-(defvar org-ascii-current-indentation nil) ; For communication
-
-;;;###autoload
-(defun org-export-as-ascii (arg)
- "Export the outline as a pretty ASCII file.
-If there is an active region, export only the region.
-The prefix ARG specifies how many levels of the outline should become
-underlined headlines. The default is 3."
- (interactive "P")
- (setq-default org-todo-line-regexp org-todo-line-regexp)
- (let* ((opt-plist (org-combine-plists (org-default-export-plist)
- (org-infile-export-plist)))
- (region-p (org-region-active-p))
- (rbeg (and region-p (region-beginning)))
- (rend (and region-p (region-end)))
- (subtree-p
- (when region-p
- (save-excursion
- (goto-char rbeg)
- (and (org-at-heading-p)
- (>= (org-end-of-subtree t t) rend)))))
- (opt-plist (if subtree-p
- (org-export-add-subtree-options opt-plist rbeg)
- opt-plist))
- (custom-times org-display-custom-times)
- (org-ascii-current-indentation '(0 . 0))
- (level 0) line txt
- (umax nil)
- (umax-toc nil)
- (case-fold-search nil)
- (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
- (filename (concat (file-name-as-directory
- (org-export-directory :ascii opt-plist))
- (file-name-sans-extension
- (or (and subtree-p
- (org-entry-get (region-beginning)
- "EXPORT_FILE_NAME" t))
- (file-name-nondirectory bfname)))
- ".txt"))
- (filename (if (equal (file-truename filename)
- (file-truename bfname))
- (concat filename ".txt")
- filename))
- (buffer (find-file-noselect filename))
- (org-levels-open (make-vector org-level-max nil))
- (odd org-odd-levels-only)
- (date (plist-get opt-plist :date))
- (author (plist-get opt-plist :author))
- (title (or (and subtree-p (org-export-get-title-from-subtree))
- (plist-get opt-plist :title)
- (and (not
- (plist-get opt-plist :skip-before-1st-heading))
- (org-export-grab-title-from-buffer))
- (file-name-sans-extension
- (file-name-nondirectory bfname))))
- (email (plist-get opt-plist :email))
- (language (plist-get opt-plist :language))
- (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
-; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
- (todo nil)
- (lang-words nil)
- (region
- (buffer-substring
- (if (org-region-active-p) (region-beginning) (point-min))
- (if (org-region-active-p) (region-end) (point-max))))
- (lines (org-split-string
- (org-export-preprocess-string
- region
- :for-ascii t
- :skip-before-1st-heading
- (plist-get opt-plist :skip-before-1st-heading)
- :drawers (plist-get opt-plist :drawers)
- :tags (plist-get opt-plist :tags)
- :priority (plist-get opt-plist :priority)
- :footnotes (plist-get opt-plist :footnotes)
- :timestamps (plist-get opt-plist :timestamps)
- :todo-keywords (plist-get opt-plist :todo-keywords)
- :verbatim-multiline t
- :select-tags (plist-get opt-plist :select-tags)
- :exclude-tags (plist-get opt-plist :exclude-tags)
- :archived-trees
- (plist-get opt-plist :archived-trees)
- :add-text (plist-get opt-plist :text))
- "\n"))
- thetoc have-headings first-heading-pos
- table-open table-buffer link desc)
- (let ((inhibit-read-only t))
- (org-unmodified
- (remove-text-properties (point-min) (point-max)
- '(:org-license-to-kill t))))
-
- (setq org-min-level (org-get-min-level lines))
- (setq org-last-level org-min-level)
- (org-init-section-numbers)
-
- (find-file-noselect filename)
-
- (setq lang-words (or (assoc language org-export-language-setup)
- (assoc "en" org-export-language-setup)))
- (switch-to-buffer-other-window buffer)
- (erase-buffer)
- (fundamental-mode)
- ;; create local variables for all options, to make sure all called
- ;; functions get the correct information
- (mapc (lambda (x)
- (set (make-local-variable (nth 2 x))
- (plist-get opt-plist (car x))))
- org-export-plist-vars)
- (org-set-local 'org-odd-levels-only odd)
- (setq umax (if arg (prefix-numeric-value arg)
- org-export-headline-levels))
- (setq umax-toc (if (integerp org-export-with-toc)
- (min org-export-with-toc umax)
- umax))
-
- ;; File header
- (if title (org-insert-centered title ?=))
- (insert "\n")
- (if (and (or author email)
- org-export-author-info)
- (insert (concat (nth 1 lang-words) ": " (or author "")
- (if email (concat " <" email ">") "")
- "\n")))
-
- (cond
- ((and date (string-match "%" date))
- (setq date (format-time-string date)))
- (date)
- (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
-
- (if (and date org-export-time-stamp-file)
- (insert (concat (nth 2 lang-words) ": " date"\n")))
-
- (insert "\n\n")
-
- (if org-export-with-toc
- (progn
- (push (concat (nth 3 lang-words) "\n") thetoc)
- (push (concat (make-string (string-width (nth 3 lang-words)) ?=)
- "\n") thetoc)
- (mapc '(lambda (line)
- (if (string-match org-todo-line-regexp
- line)
- ;; This is a headline
- (progn
- (setq have-headings t)
- (setq level (- (match-end 1) (match-beginning 1))
- level (org-tr-level level)
- txt (match-string 3 line)
- todo
- (or (and org-export-mark-todo-in-toc
- (match-beginning 2)
- (not (member (match-string 2 line)
- org-done-keywords)))
- ; TODO, not DONE
- (and org-export-mark-todo-in-toc
- (= level umax-toc)
- (org-search-todo-below
- line lines level))))
- (setq txt (org-html-expand-for-ascii txt))
-
- (while (string-match org-bracket-link-regexp txt)
- (setq txt
- (replace-match
- (match-string (if (match-end 2) 3 1) txt)
- t t txt)))
-
- (if (and (memq org-export-with-tags '(not-in-toc nil))
- (string-match
- (org-re "[ \t]+:[[:alnum:]_@:]+:[ \t]*$")
- txt))
- (setq txt (replace-match "" t t txt)))
- (if (string-match quote-re0 txt)
- (setq txt (replace-match "" t t txt)))
-
- (if org-export-with-section-numbers
- (setq txt (concat (org-section-number level)
- " " txt)))
- (if (<= level umax-toc)
- (progn
- (push
- (concat
- (make-string
- (* (max 0 (- level org-min-level)) 4) ?\ )
- (format (if todo "%s (*)\n" "%s\n") txt))
- thetoc)
- (setq org-last-level level))
- ))))
- lines)
- (setq thetoc (if have-headings (nreverse thetoc) nil))))
-
- (org-init-section-numbers)
- (while (setq line (pop lines))
- ;; Remove the quoted HTML tags.
- (setq line (org-html-expand-for-ascii line))
- ;; Replace links with the description when possible
- (while (string-match org-bracket-link-regexp line)
- (setq link (match-string 1 line)
- desc (match-string (if (match-end 3) 3 1) line))
- (if (and (> (length link) 8)
- (equal (substring link 0 8) "coderef:"))
- (setq line (replace-match
- (format (org-export-get-coderef-format (substring link 8) desc)
- (cdr (assoc
- (substring link 8)
- org-export-code-refs)))
- t t line))
- (setq line (replace-match
- (if (match-end 3) "[\\3]" "[\\1]")
- t nil line))))
- (when custom-times
- (setq line (org-translate-time line)))
- (cond
- ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
- ;; a Headline
- (setq first-heading-pos (or first-heading-pos (point)))
- (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
- txt (match-string 2 line))
- (org-ascii-level-start level txt umax lines))
-
- ((and org-export-with-tables
- (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
- (if (not table-open)
- ;; New table starts
- (setq table-open t table-buffer nil))
- ;; Accumulate lines
- (setq table-buffer (cons line table-buffer))
- (when (or (not lines)
- (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
- (car lines))))
- (setq table-open nil
- table-buffer (nreverse table-buffer))
- (insert (mapconcat
- (lambda (x)
- (org-fix-indentation x org-ascii-current-indentation))
- (org-format-table-ascii table-buffer)
- "\n") "\n")))
- (t
- (setq line (org-fix-indentation line org-ascii-current-indentation))
- ;; Remove forced line breaks
- (if (string-match "\\\\\\\\[ \t]*$" line)
- (setq line (replace-match "" t t line)))
- (if (and org-export-with-fixed-width
- (string-match "^\\([ \t]*\\)\\(:\\( \\|$\\)\\)" line))
- (setq line (replace-match "\\1" nil nil line)))
- (insert line "\n"))))
-
- (normal-mode)
-
- ;; insert the table of contents
- (when thetoc
- (goto-char (point-min))
- (if (re-search-forward "^[ \t]*\\[TABLE-OF-CONTENTS\\][ \t]*$" nil t)
- (progn
- (goto-char (match-beginning 0))
- (replace-match ""))
- (goto-char first-heading-pos))
- (mapc 'insert thetoc)
- (or (looking-at "[ \t]*\n[ \t]*\n")
- (insert "\n\n")))
-
- ;; Convert whitespace place holders
- (goto-char (point-min))
- (let (beg end)
- (while (setq beg (next-single-property-change (point) 'org-whitespace))
- (setq end (next-single-property-change beg 'org-whitespace))
- (goto-char beg)
- (delete-region beg end)
- (insert (make-string (- end beg) ?\ ))))
-
- (save-buffer)
- ;; remove display and invisible chars
- (let (beg end)
- (goto-char (point-min))
- (while (setq beg (next-single-property-change (point) 'display))
- (setq end (next-single-property-change beg 'display))
- (delete-region beg end)
- (goto-char beg)
- (insert "=>"))
- (goto-char (point-min))
- (while (setq beg (next-single-property-change (point) 'org-cwidth))
- (setq end (next-single-property-change beg 'org-cwidth))
- (delete-region beg end)
- (goto-char beg)))
- (goto-char (point-min))))
-
-(defun org-export-ascii-preprocess ()
- "Do extra work for ASCII export"
- ;; Put quotes around verbatim text
- (goto-char (point-min))
- (while (re-search-forward org-verbatim-re nil t)
- (goto-char (match-end 2))
- (backward-delete-char 1) (insert "'")
- (goto-char (match-beginning 2))
- (delete-char 1) (insert "`")
- (goto-char (match-end 2)))
- (goto-char (point-min))
- ;; Remove target markers
- (while (re-search-forward "<<<?\\([^<>]*\\)>>>?\\([ \t]*\\)" nil t)
- (replace-match "\\1\\2")))
-
(defun org-search-todo-below (line lines level)
"Search the subtree below LINE for any TODO entries."
(let ((rest (cdr (memq line lines)))
(if (<= lv level) (throw 'exit nil))
(if todo (throw 'exit t))))))))
-(defun org-html-expand-for-ascii (line)
- "Handle quoted HTML for ASCII export."
- (if org-export-html-expand
- (while (string-match "@<[^<>\n]*>" line)
- ;; We just remove the tags for now.
- (setq line (replace-match "" nil nil line))))
- line)
-
-(defun org-insert-centered (s &optional underline)
- "Insert the string S centered and underline it with character UNDERLINE."
- (let ((ind (max (/ (- fill-column (string-width s)) 2) 0)))
- (insert (make-string ind ?\ ) s "\n")
- (if underline
- (insert (make-string ind ?\ )
- (make-string (string-width s) underline)
- "\n"))))
-
-(defun org-ascii-level-start (level title umax &optional lines)
- "Insert a new level in ASCII export."
- (let (char (n (- level umax 1)) (ind 0))
- (if (> level umax)
- (progn
- (insert (make-string (* 2 n) ?\ )
- (char-to-string (nth (% n (length org-export-ascii-bullets))
- org-export-ascii-bullets))
- " " title "\n")
- ;; find the indentation of the next non-empty line
- (catch 'stop
- (while lines
- (if (string-match "^\\* " (car lines)) (throw 'stop nil))
- (if (string-match "^\\([ \t]*\\)\\S-" (car lines))
- (throw 'stop (setq ind (org-get-indentation (car lines)))))
- (pop lines)))
- (setq org-ascii-current-indentation (cons (* 2 (1+ n)) ind)))
- (if (or (not (equal (char-before) ?\n))
- (not (equal (char-before (1- (point))) ?\n)))
- (insert "\n"))
- (setq char (nth (- umax level) (reverse org-export-ascii-underline)))
- (unless org-export-with-tags
- (if (string-match (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
- (setq title (replace-match "" t t title))))
- (if org-export-with-section-numbers
- (setq title (concat (org-section-number level) " " title)))
- (insert title "\n" (make-string (string-width title) char) "\n")
- (setq org-ascii-current-indentation '(0 . 0)))))
-
;;;###autoload
(defun org-export-visible (type arg)
"Create a copy of the visible part of the current buffer, and export it.
command."
(interactive
(list (progn
- (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
+ (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [D]ocBook [x]OXO [ ]keep buffer")
(read-char-exclusive))
current-prefix-arg))
- (if (not (member type '(?a ?\C-a ?b ?\C-b ?h ?x ?\ )))
+ (if (not (member type '(?a ?\C-a ?b ?\C-b ?h ?D ?x ?\ )))
(error "Invalid export key"))
(let* ((binding (cdr (assoc type
'((?a . org-export-as-ascii)
+ (?A . org-export-as-ascii-to-buffer)
(?\C-a . org-export-as-ascii)
(?b . org-export-as-html-and-open)
(?\C-b . org-export-as-html-and-open)
(?h . org-export-as-html)
(?H . org-export-as-html-to-buffer)
(?R . org-export-region-as-html)
+ (?D . org-export-as-docbook)
(?x . org-export-as-xoxo)))))
(keepp (equal type ?\ ))
(file buffer-file-name)
(not (get-char-property s 'invisible))))
s))
-;;; HTML export
+(defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
+
+;;;###autoload
+(defun org-export-as-org (arg &optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Make a copy with not-exporting stuff removed.
+The purpose of this function is to provide a way to export the source
+Org file of a webpage in Org format, but with sensitive and/or irrelevant
+stuff removed. This command will remove the following:
+
+- archived trees (if the variable `org-export-with-archived-trees' is nil)
+- comment blocks and trees starting with the COMMENT keyword
+- only trees that are consistent with `org-export-select-tags'
+ and `org-export-exclude-tags'.
+
+The only arguments that will be used are EXT-PLIST and PUB-DIR,
+all the others will be ignored (but are present so that the general
+mechanism to call publishing functions will work).
+
+EXT-PLIST is a property list with external parameters overriding
+org-mode's default settings, but still inferior to file-local
+settings. When PUB-DIR is set, use this as the publishing
+directory."
+ (interactive "P")
+ (let* ((opt-plist (org-combine-plists (org-default-export-plist)
+ ext-plist
+ (org-infile-export-plist)))
+ (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
+ (filename (concat (file-name-as-directory
+ (or pub-dir
+ (org-export-directory :org opt-plist)))
+ (file-name-sans-extension
+ (file-name-nondirectory bfname))
+ ".org"))
+ (filename (and filename
+ (if (equal (file-truename filename)
+ (file-truename bfname))
+ (concat (file-name-sans-extension filename)
+ "-source."
+ (file-name-extension filename))
+ filename)))
+ (backup-inhibited t)
+ (buffer (find-file-noselect filename))
+ (region (buffer-string)))
+ (save-excursion
+ (switch-to-buffer buffer)
+ (erase-buffer)
+ (insert region)
+ (let ((org-inhibit-startup t)) (org-mode))
+ (org-install-letbind)
+
+ ;; Get rid of archived trees
+ (org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
+
+ ;; Remove comment environment and comment subtrees
+ (org-export-remove-comment-blocks-and-subtrees)
+
+ ;; Get rid of excluded trees
+ (org-export-handle-export-tags (plist-get opt-plist :select-tags)
+ (plist-get opt-plist :exclude-tags))
+
+ (when (or (plist-get opt-plist :plain-source)
+ (not (or (plist-get opt-plist :plain-source)
+ (plist-get opt-plist :htmlized-source))))
+ ;; Either nothing special is requested (default call)
+ ;; or the plain source is explicitly requested
+ ;; so: save it
+ (save-buffer))
+ (when (plist-get opt-plist :htmlized-source)
+ ;; Make the htmlized version
+ (require 'htmlize)
+ (require 'org-html)
+ (font-lock-fontify-buffer)
+ (let* ((htmlize-output-type 'css)
+ (newbuf (htmlize-buffer)))
+ (with-current-buffer newbuf
+ (when org-export-htmlized-org-css-url
+ (goto-char (point-min))
+ (and (re-search-forward
+ "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
+ nil t)
+ (replace-match
+ (format
+ "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
+ org-export-htmlized-org-css-url)
+ t t)))
+ (write-file (concat filename ".html")))
+ (kill-buffer newbuf)))
+ (set-buffer-modified-p nil)
+ (kill-buffer (current-buffer)))))
(defvar org-archive-location) ;; gets loaded with the org-archive require.
(defun org-get-current-options ()
#+AUTHOR: %s
#+EMAIL: %s
#+DATE: %s
+#+DESCRIPTION:
+#+KEYWORDS:
#+LANGUAGE: %s
#+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
#+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
"org file:~/org/%s.org"
))
-(defun org-export-html-preprocess (parameters)
- ;; Convert LaTeX fragments to images
- (when (plist-get parameters :LaTeX-fragments)
- (org-format-latex
- (concat "ltxpng/" (file-name-sans-extension
- (file-name-nondirectory
- org-current-export-file)))
- org-current-export-dir nil "Creating LaTeX image %s"))
- (message "Exporting..."))
-
;;;###autoload
(defun org-insert-export-options-template ()
"Insert into the buffer a template with information for exporting."
(setq s (substring s 0 (match-beginning 0))))
(insert s)))
-;;;###autoload
-(defun org-export-as-html-and-open (arg)
- "Export the outline as HTML and immediately open it with a browser.
-If there is an active region, export only the region.
-The prefix ARG specifies how many levels of the outline should become
-headlines. The default is 3. Lower levels will become bulleted lists."
- (interactive "P")
- (org-export-as-html arg 'hidden)
- (org-open-file buffer-file-name))
-
-;;;###autoload
-(defun org-export-as-html-batch ()
- "Call `org-export-as-html', may be used in batch processing as
-emacs --batch
- --load=$HOME/lib/emacs/org.el
- --eval \"(setq org-export-headline-levels 2)\"
- --visit=MyFile --funcall org-export-as-html-batch"
- (org-export-as-html org-export-headline-levels 'hidden))
-
-;;;###autoload
-(defun org-export-as-html-to-buffer (arg)
- "Call `org-export-as-html` with output to a temporary buffer.
-No file is created. The prefix ARG is passed through to `org-export-as-html'."
- (interactive "P")
- (org-export-as-html arg nil nil "*Org HTML Export*")
- (switch-to-buffer-other-window "*Org HTML Export*"))
-
-;;;###autoload
-(defun org-replace-region-by-html (beg end)
- "Assume the current region has org-mode syntax, and convert it to HTML.
-This can be used in any buffer. For example, you could write an
-itemized list in org-mode syntax in an HTML buffer and then use this
-command to convert it."
- (interactive "r")
- (let (reg html buf pop-up-frames)
- (save-window-excursion
- (if (org-mode-p)
- (setq html (org-export-region-as-html
- beg end t 'string))
- (setq reg (buffer-substring beg end)
- buf (get-buffer-create "*Org tmp*"))
- (with-current-buffer buf
- (erase-buffer)
- (insert reg)
- (org-mode)
- (setq html (org-export-region-as-html
- (point-min) (point-max) t 'string)))
- (kill-buffer buf)))
- (delete-region beg end)
- (insert html)))
-
-;;;###autoload
-(defun org-export-region-as-html (beg end &optional body-only buffer)
- "Convert region from BEG to END in org-mode buffer to HTML.
-If prefix arg BODY-ONLY is set, omit file header, footer, and table of
-contents, and only produce the region of converted text, useful for
-cut-and-paste operations.
-If BUFFER is a buffer or a string, use/create that buffer as a target
-of the converted HTML. If BUFFER is the symbol `string', return the
-produced HTML as a string and leave not buffer behind. For example,
-a Lisp program could call this function in the following way:
-
- (setq html (org-export-region-as-html beg end t 'string))
-
-When called interactively, the output buffer is selected, and shown
-in a window. A non-interactive call will only return the buffer."
- (interactive "r\nP")
- (when (interactive-p)
- (setq buffer "*Org HTML Export*"))
- (let ((transient-mark-mode t) (zmacs-regions t)
- ext-plist rtn)
- (setq ext-plist (plist-put ext-plist :ignore-subree-p t))
- (goto-char end)
- (set-mark (point)) ;; to activate the region
- (goto-char beg)
- (setq rtn (org-export-as-html
- nil nil ext-plist
- buffer body-only))
- (if (fboundp 'deactivate-mark) (deactivate-mark))
- (if (and (interactive-p) (bufferp rtn))
- (switch-to-buffer-other-window rtn)
- rtn)))
-
-(defvar html-table-tag nil) ; dynamically scoped into this.
-(defvar org-par-open nil)
-;;;###autoload
-(defun org-export-as-html (arg &optional hidden ext-plist
- to-buffer body-only pub-dir)
- "Export the outline as a pretty HTML file.
-If there is an active region, export only the region. The prefix
-ARG specifies how many levels of the outline should become
-headlines. The default is 3. Lower levels will become bulleted
-lists. When HIDDEN is non-nil, don't display the HTML buffer.
-EXT-PLIST is a property list with external parameters overriding
-org-mode's default settings, but still inferior to file-local
-settings. When TO-BUFFER is non-nil, create a buffer with that
-name and export to that buffer. If TO-BUFFER is the symbol
-`string', don't leave any buffer behind but just return the
-resulting HTML as a string. When BODY-ONLY is set, don't produce
-the file header and footer, simply return the content of
-<body>...</body>, without even the body tags themselves. When
-PUB-DIR is set, use this as the publishing directory."
- (interactive "P")
-
- ;; Make sure we have a file name when we need it.
- (when (and (not (or to-buffer body-only))
- (not buffer-file-name))
- (if (buffer-base-buffer)
- (org-set-local 'buffer-file-name
- (with-current-buffer (buffer-base-buffer)
- buffer-file-name))
- (error "Need a file name to be able to export.")))
-
- (message "Exporting...")
- (setq-default org-todo-line-regexp org-todo-line-regexp)
- (setq-default org-deadline-line-regexp org-deadline-line-regexp)
- (setq-default org-done-keywords org-done-keywords)
- (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
- (let* ((opt-plist
- (org-export-process-option-filters
- (org-combine-plists (org-default-export-plist)
- ext-plist
- (org-infile-export-plist))))
- (style (concat (if (plist-get opt-plist :style-include-default)
- org-export-html-style-default)
- (plist-get opt-plist :style)
- (plist-get opt-plist :style-extra)
- "\n" org-export-html-scripts))
- (html-extension (plist-get opt-plist :html-extension))
- (link-validate (plist-get opt-plist :link-validation-function))
- valid thetoc have-headings first-heading-pos
- (odd org-odd-levels-only)
- (region-p (org-region-active-p))
- (rbeg (and region-p (region-beginning)))
- (rend (and region-p (region-end)))
- (subtree-p
- (if (plist-get opt-plist :ignore-subree-p)
- nil
- (when region-p
- (save-excursion
- (goto-char rbeg)
- (and (org-at-heading-p)
- (>= (org-end-of-subtree t t) rend))))))
- (opt-plist (if subtree-p
- (org-export-add-subtree-options opt-plist rbeg)
- opt-plist))
- ;; The following two are dynamically scoped into other
- ;; routines below.
- (org-current-export-dir
- (or pub-dir (org-export-directory :html opt-plist)))
- (org-current-export-file buffer-file-name)
- (level 0) (line "") (origline "") txt todo
- (umax nil)
- (umax-toc nil)
- (filename (if to-buffer nil
- (expand-file-name
- (concat
- (file-name-sans-extension
- (or (and subtree-p
- (org-entry-get (region-beginning)
- "EXPORT_FILE_NAME" t))
- (file-name-nondirectory buffer-file-name)))
- "." html-extension)
- (file-name-as-directory
- (or pub-dir (org-export-directory :html opt-plist))))))
- (current-dir (if buffer-file-name
- (file-name-directory buffer-file-name)
- default-directory))
- (buffer (if to-buffer
- (cond
- ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
- (t (get-buffer-create to-buffer)))
- (find-file-noselect filename)))
- (org-levels-open (make-vector org-level-max nil))
- (date (plist-get opt-plist :date))
- (author (plist-get opt-plist :author))
- (title (or (and subtree-p (org-export-get-title-from-subtree))
- (plist-get opt-plist :title)
- (and (not
- (plist-get opt-plist :skip-before-1st-heading))
- (org-export-grab-title-from-buffer))
- (and buffer-file-name
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name)))
- "UNTITLED"))
- (html-table-tag (plist-get opt-plist :html-table-tag))
- (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
- (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
- (inquote nil)
- (infixed nil)
- (inverse nil)
- (in-local-list nil)
- (local-list-type nil)
- (local-list-indent nil)
- (llt org-plain-list-ordered-item-terminator)
- (email (plist-get opt-plist :email))
- (language (plist-get opt-plist :language))
- (lang-words nil)
- (head-count 0) cnt
- (start 0)
- (coding-system (and (boundp 'buffer-file-coding-system)
- buffer-file-coding-system))
- (coding-system-for-write (or org-export-html-coding-system
- coding-system))
- (save-buffer-coding-system (or org-export-html-coding-system
- coding-system))
- (charset (and coding-system-for-write
- (fboundp 'coding-system-get)
- (coding-system-get coding-system-for-write
- 'mime-charset)))
- (region
- (buffer-substring
- (if region-p (region-beginning) (point-min))
- (if region-p (region-end) (point-max))))
- (lines
- (org-split-string
- (org-export-preprocess-string
- region
- :emph-multiline t
- :for-html t
- :skip-before-1st-heading
- (plist-get opt-plist :skip-before-1st-heading)
- :drawers (plist-get opt-plist :drawers)
- :todo-keywords (plist-get opt-plist :todo-keywords)
- :tags (plist-get opt-plist :tags)
- :priority (plist-get opt-plist :priority)
- :footnotes (plist-get opt-plist :footnotes)
- :timestamps (plist-get opt-plist :timestamps)
- :archived-trees
- (plist-get opt-plist :archived-trees)
- :select-tags (plist-get opt-plist :select-tags)
- :exclude-tags (plist-get opt-plist :exclude-tags)
- :add-text
- (plist-get opt-plist :text)
- :LaTeX-fragments
- (plist-get opt-plist :LaTeX-fragments))
- "[\r\n]"))
- table-open type
- table-buffer table-orig-buffer
- ind item-type starter didclose
- rpl path attr desc descp desc1 desc2 link
- snumber fnc item-tag
- footnotes footref-seen
- id-file
- )
-
- (let ((inhibit-read-only t))
- (org-unmodified
- (remove-text-properties (point-min) (point-max)
- '(:org-license-to-kill t))))
-
- (message "Exporting...")
-
- (setq org-min-level (org-get-min-level lines))
- (setq org-last-level org-min-level)
- (org-init-section-numbers)
-
- (cond
- ((and date (string-match "%" date))
- (setq date (format-time-string date)))
- (date)
- (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
-
- ;; Get the language-dependent settings
- (setq lang-words (or (assoc language org-export-language-setup)
- (assoc "en" org-export-language-setup)))
-
- ;; Switch to the output buffer
- (set-buffer buffer)
- (let ((inhibit-read-only t)) (erase-buffer))
- (fundamental-mode)
-
- (and (fboundp 'set-buffer-file-coding-system)
- (set-buffer-file-coding-system coding-system-for-write))
-
- (let ((case-fold-search nil)
- (org-odd-levels-only odd))
- ;; create local variables for all options, to make sure all called
- ;; functions get the correct information
- (mapc (lambda (x)
- (set (make-local-variable (nth 2 x))
- (plist-get opt-plist (car x))))
- org-export-plist-vars)
- (setq umax (if arg (prefix-numeric-value arg)
- org-export-headline-levels))
- (setq umax-toc (if (integerp org-export-with-toc)
- (min org-export-with-toc umax)
- umax))
- (unless body-only
- ;; File header
- (insert (format
- "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
- \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
-<html xmlns=\"http://www.w3.org/1999/xhtml\"
-lang=\"%s\" xml:lang=\"%s\">
-<head>
-<title>%s</title>
-<meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
-<meta name=\"generator\" content=\"Org-mode\"/>
-<meta name=\"generated\" content=\"%s\"/>
-<meta name=\"author\" content=\"%s\"/>
-%s
-</head><body>
-"
- language language (org-html-expand title)
- (or charset "iso-8859-1") date author style))
-
- (insert (or (plist-get opt-plist :preamble) ""))
-
- (when (plist-get opt-plist :auto-preamble)
- (if title (insert (format org-export-html-title-format
- (org-html-expand title))))))
-
- (if (and org-export-with-toc (not body-only))
- (progn
- (push (format "<h%d>%s</h%d>\n"
- org-export-html-toplevel-hlevel
- (nth 3 lang-words)
- org-export-html-toplevel-hlevel)
- thetoc)
- (push "<div id=\"text-table-of-contents\">\n" thetoc)
- (push "<ul>\n<li>" thetoc)
- (setq lines
- (mapcar '(lambda (line)
- (if (string-match org-todo-line-regexp line)
- ;; This is a headline
- (progn
- (setq have-headings t)
- (setq level (- (match-end 1) (match-beginning 1))
- level (org-tr-level level)
- txt (save-match-data
- (org-html-expand
- (org-export-cleanup-toc-line
- (match-string 3 line))))
- todo
- (or (and org-export-mark-todo-in-toc
- (match-beginning 2)
- (not (member (match-string 2 line)
- org-done-keywords)))
- ; TODO, not DONE
- (and org-export-mark-todo-in-toc
- (= level umax-toc)
- (org-search-todo-below
- line lines level))))
- (if (string-match
- (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
- (setq txt (replace-match " <span class=\"tag\"> \\1</span>" t nil txt)))
- (if (string-match quote-re0 txt)
- (setq txt (replace-match "" t t txt)))
- (setq snumber (org-section-number level))
- (if org-export-with-section-numbers
- (setq txt (concat snumber " " txt)))
- (if (<= level (max umax umax-toc))
- (setq head-count (+ head-count 1)))
- (if (<= level umax-toc)
- (progn
- (if (> level org-last-level)
- (progn
- (setq cnt (- level org-last-level))
- (while (>= (setq cnt (1- cnt)) 0)
- (push "\n<ul>\n<li>" thetoc))
- (push "\n" thetoc)))
- (if (< level org-last-level)
- (progn
- (setq cnt (- org-last-level level))
- (while (>= (setq cnt (1- cnt)) 0)
- (push "</li>\n</ul>" thetoc))
- (push "\n" thetoc)))
- ;; Check for targets
- (while (string-match org-any-target-regexp line)
- (setq line (replace-match
- (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
- t t line)))
- (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt)
- (setq txt (replace-match "" t t txt)))
- (push
- (format
- (if todo
- "</li>\n<li><a href=\"#sec-%s\"><span class=\"todo\">%s</span></a>"
- "</li>\n<li><a href=\"#sec-%s\">%s</a>")
- snumber txt) thetoc)
-
- (setq org-last-level level))
- )))
- line)
- lines))
- (while (> org-last-level (1- org-min-level))
- (setq org-last-level (1- org-last-level))
- (push "</li>\n</ul>\n" thetoc))
- (push "</div>\n" thetoc)
- (setq thetoc (if have-headings (nreverse thetoc) nil))))
-
- (setq head-count 0)
- (org-init-section-numbers)
-
- (org-open-par)
-
- (while (setq line (pop lines) origline line)
- (catch 'nextline
-
- ;; end of quote section?
- (when (and inquote (string-match "^\\*+ " line))
- (insert "</pre>\n")
- (setq inquote nil))
- ;; inside a quote section?
- (when inquote
- (insert (org-html-protect line) "\n")
- (throw 'nextline nil))
-
- ;; Fixed-width, verbatim lines (examples)
- (when (and org-export-with-fixed-width
- (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
- (when (not infixed)
- (setq infixed t)
- (org-close-par-maybe)
- (insert "<pre class=\"example\">\n"))
- (insert (org-html-protect (match-string 3 line)) "\n")
- (when (or (not lines)
- (not (string-match "^[ \t]*\\(:.*\\)"
- (car lines))))
- (setq infixed nil)
- (insert "</pre>\n"))
- (throw 'nextline nil))
-
- ;; Protected HTML
- (when (get-text-property 0 'org-protected line)
- (let (par)
- (when (re-search-backward
- "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
- (setq par (match-string 1))
- (replace-match "\\2\n"))
- (insert line "\n")
- (while (and lines
- (or (= (length (car lines)) 0)
- (get-text-property 0 'org-protected (car lines))))
- (insert (pop lines) "\n"))
- (and par (insert "<p>\n")))
- (throw 'nextline nil))
-
- ;; Horizontal line
- (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
- (if org-par-open
- (insert "\n</p>\n<hr/>\n<p>\n")
- (insert "\n<hr/>\n"))
- (throw 'nextline nil))
-
- ;; Blockquotes and verse
- (when (equal "ORG-BLOCKQUOTE-START" line)
- (org-close-par-maybe)
- (insert "<blockquote>\n<p>\n")
- (throw 'nextline nil))
- (when (equal "ORG-BLOCKQUOTE-END" line)
- (insert "</p>\n</blockquote>\n")
- (throw 'nextline nil))
- (when (equal "ORG-VERSE-START" line)
- (org-close-par-maybe)
- (insert "\n<p class=\"verse\">\n")
- (setq inverse t)
- (throw 'nextline nil))
- (when (equal "ORG-VERSE-END" line)
- (insert "</p>\n")
- (setq inverse nil)
- (throw 'nextline nil))
- (when inverse
- (let ((i (org-get-string-indentation line)))
- (if (> i 0)
- (setq line (concat (mapconcat 'identity
- (make-list (* 2 i) "\\nbsp") "")
- " " (org-trim line))))
- (setq line (concat line "\\\\"))))
-
- ;; make targets to anchors
- (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
- (cond
- ((match-end 2)
- (setq line (replace-match
- (format
- "@<a name=\"%s\" id=\"%s\">@</a>"
- (org-solidify-link-text (match-string 1 line))
- (org-solidify-link-text (match-string 1 line)))
- t t line)))
- ((and org-export-with-toc (equal (string-to-char line) ?*))
- ;; FIXME: NOT DEPENDENT on TOC?????????????????????
- (setq line (replace-match
- (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
-; (concat "@<i>" (match-string 1 line) "@</i> ")
- t t line)))
- (t
- (setq line (replace-match
- (concat "@<a name=\""
- (org-solidify-link-text (match-string 1 line))
- "\" class=\"target\">" (match-string 1 line) "@</a> ")
- t t line)))))
-
- (setq line (org-html-handle-time-stamps line))
-
- ;; replace "&" by "&", "<" and ">" by "<" and ">"
- ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
- ;; Also handle sub_superscripts and checkboxes
- (or (string-match org-table-hline-regexp line)
- (setq line (org-html-expand line)))
-
- ;; Format the links
- (setq start 0)
- (while (string-match org-bracket-link-analytic-regexp++ line start)
- (setq start (match-beginning 0))
- (setq path (save-match-data (org-link-unescape
- (match-string 3 line))))
- (setq type (cond
- ((match-end 2) (match-string 2 line))
- ((save-match-data
- (or (file-name-absolute-p path)
- (string-match "^\\.\\.?/" path)))
- "file")
- (t "internal")))
- (setq path (org-extract-attributes (org-link-unescape path)))
- (setq attr (get-text-property 0 'org-attributes path))
- (setq desc1 (if (match-end 5) (match-string 5 line))
- desc2 (if (match-end 2) (concat type ":" path) path)
- descp (and desc1 (not (equal desc1 desc2)))
- desc (or desc1 desc2))
- ;; Make an image out of the description if that is so wanted
- (when (and descp (org-file-image-p
- desc org-export-html-inline-image-extensions))
- (save-match-data
- (if (string-match "^file:" desc)
- (setq desc (substring desc (match-end 0)))))
- (setq desc (org-add-props
- (concat "<img src=\"" desc "\"/>")
- '(org-protected t))))
- ;; FIXME: do we need to unescape here somewhere?
- (cond
- ((equal type "internal")
- (setq rpl
- (concat
- "<a href=\"#"
- (org-solidify-link-text
- (save-match-data (org-link-unescape path)) nil)
- "\"" attr ">"
- (org-export-html-format-desc desc)
- "</a>")))
- ((and (equal type "id")
- (setq id-file (org-id-find-id-file path)))
- ;; This is an id: link to another file (if it was the same file,
- ;; it would have become an internal link...)
- (setq id-file (file-relative-name
- id-file (file-name-directory org-current-export-file)))
- (setq id-file (concat (file-name-sans-extension id-file)
- "." html-extension))
- (setq rpl (concat "<a href=\"" id-file "#" path "\""
- attr ">"
- (org-export-html-format-desc desc)
- "</a>")))
- ((member type '("http" "https"))
- ;; standard URL, just check if we need to inline an image
- (if (and (or (eq t org-export-html-inline-images)
- (and org-export-html-inline-images (not descp)))
- (org-file-image-p
- path org-export-html-inline-image-extensions))
- (setq rpl (org-export-html-format-image
- (concat type ":" path) org-par-open))
- (setq link (concat type ":" path))
- (setq rpl (concat "<a href=\""
- (org-export-html-format-href link)
- "\"" attr ">"
- (org-export-html-format-desc desc)
- "</a>"))))
- ((member type '("ftp" "mailto" "news"))
- ;; standard URL
- (setq link (concat type ":" path))
- (setq rpl (concat "<a href=\""
- (org-export-html-format-href link)
- "\"" attr ">"
- (org-export-html-format-desc desc)
- "</a>")))
-
- ((string= type "coderef")
-
- (setq rpl (format "<a href=\"#coderef-%s\" class=\"coderef\" onmouseover=\"CodeHighlightOn(this, 'coderef-%s');\" onmouseout=\"CodeHighlightOff(this, 'coderef-%s');\">%s</a>"
- path path path
- (format (org-export-get-coderef-format path (and descp desc))
- (cdr (assoc path org-export-code-refs))))))
-
- ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
- ;; The link protocol has a function for format the link
- (setq rpl
- (save-match-data
- (funcall fnc (org-link-unescape path) desc1 'html))))
-
- ((string= type "file")
- ;; FILE link
- (let* ((filename path)
- (abs-p (file-name-absolute-p filename))
- thefile file-is-image-p search)
- (save-match-data
- (if (string-match "::\\(.*\\)" filename)
- (setq search (match-string 1 filename)
- filename (replace-match "" t nil filename)))
- (setq valid
- (if (functionp link-validate)
- (funcall link-validate filename current-dir)
- t))
- (setq file-is-image-p
- (org-file-image-p
- filename org-export-html-inline-image-extensions))
- (setq thefile (if abs-p (expand-file-name filename) filename))
- (when (and org-export-html-link-org-files-as-html
- (string-match "\\.org$" thefile))
- (setq thefile (concat (substring thefile 0
- (match-beginning 0))
- "." html-extension))
- (if (and search
- ;; make sure this is can be used as target search
- (not (string-match "^[0-9]*$" search))
- (not (string-match "^\\*" search))
- (not (string-match "^/.*/$" search)))
- (setq thefile (concat thefile "#"
- (org-solidify-link-text
- (org-link-unescape search)))))
- (when (string-match "^file:" desc)
- (setq desc (replace-match "" t t desc))
- (if (string-match "\\.org$" desc)
- (setq desc (replace-match "" t t desc))))))
- (setq rpl (if (and file-is-image-p
- (or (eq t org-export-html-inline-images)
- (and org-export-html-inline-images
- (not descp))))
- (progn
- (message "image %s %s" thefile org-par-open)
- (org-export-html-format-image thefile org-par-open))
- (concat "<a href=\"" thefile "\"" attr ">"
- (org-export-html-format-desc desc)
- "</a>")))
- (if (not valid) (setq rpl desc))))
-
- (t
- ;; just publish the path, as default
- (setq rpl (concat "<i><" type ":"
- (save-match-data (org-link-unescape path))
- "></i>"))))
- (setq line (replace-match rpl t t line)
- start (+ start (length rpl))))
-
- ;; TODO items
- (if (and (string-match org-todo-line-regexp line)
- (match-beginning 2))
-
- (setq line
- (concat (substring line 0 (match-beginning 2))
- "<span class=\""
- (if (member (match-string 2 line)
- org-done-keywords)
- "done" "todo")
- "\">" (match-string 2 line)
- "</span>" (substring line (match-end 2)))))
-
- ;; Does this contain a reference to a footnote?
- (when org-export-with-footnotes
- (setq start 0)
- (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
- (if (get-text-property (match-beginning 2) 'org-protected line)
- (setq start (match-end 2))
- (let ((n (match-string 2 line)) extra a)
- (if (setq a (assoc n footref-seen))
- (progn
- (setcdr a (1+ (cdr a)))
- (setq extra (format ".%d" (cdr a))))
- (setq extra "")
- (push (cons n 1) footref-seen))
- (setq line
- (replace-match
- (format
- "%s<sup><a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a></sup>"
- (match-string 1 line) n extra n n)
- t t line))))))
-
- (cond
- ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
- ;; This is a headline
- (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
- txt (match-string 2 line))
- (if (string-match quote-re0 txt)
- (setq txt (replace-match "" t t txt)))
- (if (<= level (max umax umax-toc))
- (setq head-count (+ head-count 1)))
- (when in-local-list
- ;; Close any local lists before inserting a new header line
- (while local-list-type
- (org-close-li (car local-list-type))
- (insert (format "</%sl>\n" (car local-list-type)))
- (pop local-list-type))
- (setq local-list-indent nil
- in-local-list nil))
- (setq first-heading-pos (or first-heading-pos (point)))
- (org-html-level-start level txt umax
- (and org-export-with-toc (<= level umax))
- head-count)
- ;; QUOTES
- (when (string-match quote-re line)
- (org-close-par-maybe)
- (insert "<pre>")
- (setq inquote t)))
-
- ((and org-export-with-tables
- (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
- (if (not table-open)
- ;; New table starts
- (setq table-open t table-buffer nil table-orig-buffer nil))
- ;; Accumulate lines
- (setq table-buffer (cons line table-buffer)
- table-orig-buffer (cons origline table-orig-buffer))
- (when (or (not lines)
- (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
- (car lines))))
- (setq table-open nil
- table-buffer (nreverse table-buffer)
- table-orig-buffer (nreverse table-orig-buffer))
- (org-close-par-maybe)
- (insert (org-format-table-html table-buffer table-orig-buffer))))
- (t
- ;; Normal lines
- (when (string-match
- (cond
- ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
- ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
- ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
- (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
- line)
- (setq ind (org-get-string-indentation line)
- item-type (if (match-beginning 4) "o" "u")
- starter (if (match-beginning 2)
- (substring (match-string 2 line) 0 -1))
- line (substring line (match-beginning 5))
- item-tag nil)
- (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
- (setq item-type "d"
- item-tag (match-string 1 line)
- line (substring line (match-end 0))))
- (when (and (not (equal item-type "d"))
- (not (string-match "[^ \t]" line)))
- ;; empty line. Pretend indentation is large.
- (setq ind (if org-empty-line-terminates-plain-lists
- 0
- (1+ (or (car local-list-indent) 1)))))
- (setq didclose nil)
- (while (and in-local-list
- (or (and (= ind (car local-list-indent))
- (not starter))
- (< ind (car local-list-indent))))
- (setq didclose t)
- (org-close-li (car local-list-type))
- (insert (format "</%sl>\n" (car local-list-type)))
- (pop local-list-type) (pop local-list-indent)
- (setq in-local-list local-list-indent))
- (cond
- ((and starter
- (or (not in-local-list)
- (> ind (car local-list-indent))))
- ;; Start new (level of) list
- (org-close-par-maybe)
- (insert (cond
- ((equal item-type "u") "<ul>\n<li>\n")
- ((equal item-type "o") "<ol>\n<li>\n")
- ((equal item-type "d")
- (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
- (push item-type local-list-type)
- (push ind local-list-indent)
- (setq in-local-list t))
- (starter
- ;; continue current list
- (org-close-li (car local-list-type))
- (insert (cond
- ((equal (car local-list-type) "d")
- (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
- (t "<li>\n"))))
- (didclose
- ;; we did close a list, normal text follows: need <p>
- (org-open-par)))
- (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
- (setq line
- (replace-match
- (if (equal (match-string 1 line) "X")
- "<b>[X]</b>"
- "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
- t t line))))
-
- ;; Empty lines start a new paragraph. If hand-formatted lists
- ;; are not fully interpreted, lines starting with "-", "+", "*"
- ;; also start a new paragraph.
- (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
-
- ;; Is this the start of a footnote?
- (when org-export-with-footnotes
- (when (and (boundp 'footnote-section-tag-regexp)
- (string-match (concat "^" footnote-section-tag-regexp)
- line))
- ;; ignore this line
- (throw 'nextline nil))
- (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
- (org-close-par-maybe)
- (let ((n (match-string 1 line)))
- (setq org-par-open t
- line (replace-match
- (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
-
- ;; Check if the line break needs to be conserved
- (cond
- ((string-match "\\\\\\\\[ \t]*$" line)
- (setq line (replace-match "<br/>" t t line)))
- (org-export-preserve-breaks
- (setq line (concat line "<br/>"))))
-
- ;; Check if a paragraph should be started
- (let ((start 0))
- (while (and org-par-open
- (string-match "\\\\par\\>" line start))
- ;; Leave a space in the </p> so that the footnote matcher
- ;; does not see this.
- (if (not (get-text-property (match-beginning 0)
- 'org-protected line))
- (setq line (replace-match "</p ><p >" t t line)))
- (setq start (match-end 0))))
-
- (insert line "\n")))))
-
- ;; Properly close all local lists and other lists
- (when inquote
- (insert "</pre>\n")
- (org-open-par))
- (when in-local-list
- ;; Close any local lists before inserting a new header line
- (while local-list-type
- (org-close-li (car local-list-type))
- (insert (format "</%sl>\n" (car local-list-type)))
- (pop local-list-type))
- (setq local-list-indent nil
- in-local-list nil))
- (org-html-level-start 1 nil umax
- (and org-export-with-toc (<= level umax))
- head-count)
- ;; the </div> to close the last text-... div.
- (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
-
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
- (push (match-string 0) footnotes)
- (replace-match "" t t)))
- (when footnotes
- (insert (format org-export-html-footnotes-section
- (or (nth 4 lang-words) "Footnotes")
- (mapconcat 'identity (nreverse footnotes) "\n"))
- "\n"))
- (unless body-only
- (when (plist-get opt-plist :auto-postamble)
- (insert "<div id=\"postamble\">")
- (when (and org-export-author-info author)
- (insert "<p class=\"author\"> "
- (nth 1 lang-words) ": " author "\n")
- (when email
- (if (listp (split-string email ",+ *"))
- (mapc (lambda(e)
- (insert "<a href=\"mailto:" e "\"><"
- e "></a>\n"))
- (split-string email ",+ *"))
- (insert "<a href=\"mailto:" email "\"><"
- email "></a>\n")))
- (insert "</p>\n"))
- (when (and date org-export-time-stamp-file)
- (insert "<p class=\"date\"> "
- (nth 2 lang-words) ": "
- date "</p>\n"))
- (when org-export-creator-info
- (insert (format "<p>HTML generated by org-mode %s in emacs %s</p>\n"
- org-version emacs-major-version)))
- (insert "</div>"))
-
- (if org-export-html-with-timestamp
- (insert org-export-html-html-helper-timestamp))
- (insert (or (plist-get opt-plist :postamble) ""))
- (insert "</body>\n</html>\n"))
-
- (unless (plist-get opt-plist :buffer-will-be-killed)
- (normal-mode)
- (if (eq major-mode default-major-mode) (html-mode)))
-
- ;; insert the table of contents
- (goto-char (point-min))
- (when thetoc
- (if (or (re-search-forward
- "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
- (re-search-forward
- "\\[TABLE-OF-CONTENTS\\]" nil t))
- (progn
- (goto-char (match-beginning 0))
- (replace-match ""))
- (goto-char first-heading-pos)
- (when (looking-at "\\s-*</p>")
- (goto-char (match-end 0))
- (insert "\n")))
- (insert "<div id=\"table-of-contents\">\n")
- (mapc 'insert thetoc)
- (insert "</div>\n"))
- ;; remove empty paragraphs and lists
- (goto-char (point-min))
- (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
- (replace-match ""))
- (goto-char (point-min))
- (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
- (replace-match ""))
- (goto-char (point-min))
- (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t)
- (replace-match ""))
- ;; Convert whitespace place holders
- (goto-char (point-min))
- (let (beg end n)
- (while (setq beg (next-single-property-change (point) 'org-whitespace))
- (setq n (get-text-property beg 'org-whitespace)
- end (next-single-property-change beg 'org-whitespace))
- (goto-char beg)
- (delete-region beg end)
- (insert (format "<span style=\"visibility:hidden;\">%s</span>"
- (make-string n ?x)))))
- (or to-buffer (save-buffer))
- (goto-char (point-min))
- (message "Exporting... done")
- (if (eq to-buffer 'string)
- (prog1 (buffer-substring (point-min) (point-max))
- (kill-buffer (current-buffer)))
- (current-buffer)))))
-
-(defun org-export-get-coderef-format (path desc)
- (save-match-data
- (if (and desc (string-match
- (regexp-quote (concat "(" path ")"))
- desc))
- (replace-match "%s" t t desc)
- "%s")))
-
-
-(defun org-export-html-format-href (s)
- "Make sure the S is valid as a href reference in an XHTML document."
- (save-match-data
- (let ((start 0))
- (while (string-match "&" s start)
- (setq start (+ (match-beginning 0) 3)
- s (replace-match "&" t t s)))))
- s)
-
-(defun org-export-html-format-desc (s)
- "Make sure the S is valid as a description in a link."
- (if (and s (not (get-text-property 1 'org-protected s)))
- (save-match-data
- (org-html-do-expand s))
- s))
-
-(defun org-export-html-format-image (src par-open)
- "Create image tag with source and attributes."
- (save-match-data
- (if (string-match "^ltxpng/" src)
- (format "<img src=\"%s\"/>" src)
- (let* ((caption (org-find-text-property-in-string 'org-caption src))
- (attr (org-find-text-property-in-string 'org-attributes src))
- (label (org-find-text-property-in-string 'org-label src)))
- (format "%s<div %sclass=\"figure\">
-<p><img src=\"%s\"%s /></p>%s
-</div>%s"
- (if org-par-open "</p>\n" "")
- (if label (format "id=\"%s\" " label) "")
- src
- (if (string-match "\\<alt=" (or attr ""))
- (concat " " attr )
- (concat " " attr " alt=\"" src "\""))
- (if caption (concat "\n<p>" caption "</p>") "")
- (if org-par-open "\n<p>" ""))))))
-
-
(defvar org-table-colgroup-info nil)
-(defun org-format-table-ascii (lines)
- "Format a table for ascii export."
- (if (stringp lines)
- (setq lines (org-split-string lines "\n")))
- (if (not (string-match "^[ \t]*|" (car lines)))
- ;; Table made by table.el - test for spanning
- lines
-
- ;; A normal org table
- ;; Get rid of hlines at beginning and end
- (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
- (setq lines (nreverse lines))
- (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
- (setq lines (nreverse lines))
- (when org-export-table-remove-special-lines
- ;; Check if the table has a marking column. If yes remove the
- ;; column and the special lines
- (setq lines (org-table-clean-before-export lines)))
- ;; Get rid of the vertical lines except for grouping
- (let ((vl (org-colgroup-info-to-vline-list org-table-colgroup-info))
- rtn line vl1 start)
- (while (setq line (pop lines))
- (if (string-match org-table-hline-regexp line)
- (and (string-match "|\\(.*\\)|" line)
- (setq line (replace-match " \\1" t nil line)))
- (setq start 0 vl1 vl)
- (while (string-match "|" line start)
- (setq start (match-end 0))
- (or (pop vl1) (setq line (replace-match " " t t line)))))
- (push line rtn))
- (nreverse rtn))))
-
-(defun org-colgroup-info-to-vline-list (info)
- (let (vl new last)
- (while info
- (setq last new new (pop info))
- (if (or (memq last '(:end :startend))
- (memq new '(:start :startend)))
- (push t vl)
- (push nil vl)))
- (setq vl (nreverse vl))
- (and vl (setcar vl nil))
- vl))
-
-(defvar org-table-number-regexp) ; defined in org-table.el
-(defun org-format-table-html (lines olines)
- "Find out which HTML converter to use and return the HTML code."
- (if (stringp lines)
- (setq lines (org-split-string lines "\n")))
- (if (string-match "^[ \t]*|" (car lines))
- ;; A normal org table
- (org-format-org-table-html lines)
- ;; Table made by table.el - test for spanning
- (let* ((hlines (delq nil (mapcar
- (lambda (x)
- (if (string-match "^[ \t]*\\+-" x) x
- nil))
- lines)))
- (first (car hlines))
- (ll (and (string-match "\\S-+" first)
- (match-string 0 first)))
- (re (concat "^[ \t]*" (regexp-quote ll)))
- (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
- hlines))))
- (if (and (not spanning)
- (not org-export-prefer-native-exporter-for-tables))
- ;; We can use my own converter with HTML conversions
- (org-format-table-table-html lines)
- ;; Need to use the code generator in table.el, with the original text.
- (org-format-table-table-html-using-table-generate-source olines)))))
-
-(defvar org-table-number-fraction) ; defined in org-table.el
-(defun org-format-org-table-html (lines &optional splice)
- "Format a table into HTML."
- (require 'org-table)
- ;; Get rid of hlines at beginning and end
- (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
- (setq lines (nreverse lines))
- (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
- (setq lines (nreverse lines))
- (when org-export-table-remove-special-lines
- ;; Check if the table has a marking column. If yes remove the
- ;; column and the special lines
- (setq lines (org-table-clean-before-export lines)))
-
- (let ((caption (or (get-text-property 0 'org-caption (car lines))
- (get-text-property (or (next-single-property-change
- 0 'org-caption (car lines))
- 0)
- 'org-caption (car lines))))
- (head (and org-export-highlight-first-table-line
- (delq nil (mapcar
- (lambda (x) (string-match "^[ \t]*|-" x))
- (cdr lines)))))
-
- (nlines 0) fnum i
- tbopen line fields html gr colgropen)
- (if splice (setq head nil))
- (unless splice (push (if head "<thead>" "<tbody>") html))
- (setq tbopen t)
- (while (setq line (pop lines))
- (catch 'next-line
- (if (string-match "^[ \t]*|-" line)
- (progn
- (unless splice
- (push (if head "</thead>" "</tbody>") html)
- (if lines (push "<tbody>" html) (setq tbopen nil)))
- (setq head nil) ;; head ends here, first time around
- ;; ignore this line
- (throw 'next-line t)))
- ;; Break the line into fields
- (setq fields (org-split-string line "[ \t]*|[ \t]*"))
- (unless fnum (setq fnum (make-vector (length fields) 0)))
- (setq nlines (1+ nlines) i -1)
- (push (concat "<tr>"
- (mapconcat
- (lambda (x)
- (setq i (1+ i))
- (if (and (< i nlines)
- (string-match org-table-number-regexp x))
- (incf (aref fnum i)))
- (if head
- (concat (car org-export-table-header-tags) x
- (cdr org-export-table-header-tags))
- (concat (car org-export-table-data-tags) x
- (cdr org-export-table-data-tags))))
- fields "")
- "</tr>")
- html)))
- (unless splice (if tbopen (push "</tbody>" html)))
- (unless splice (push "</table>\n" html))
- (setq html (nreverse html))
- (unless splice
- ;; Put in col tags with the alignment (unfortunately often ignored...)
- (push (mapconcat
- (lambda (x)
- (setq gr (pop org-table-colgroup-info))
- (format "%s<col align=\"%s\"></col>%s"
- (if (memq gr '(:start :startend))
- (prog1
- (if colgropen "</colgroup>\n<colgroup>" "<colgroup>")
- (setq colgropen t))
- "")
- (if (> (/ (float x) nlines) org-table-number-fraction)
- "right" "left")
- (if (memq gr '(:end :startend))
- (progn (setq colgropen nil) "</colgroup>")
- "")))
- fnum "")
- html)
- (if colgropen (setq html (cons (car html) (cons "</colgroup>" (cdr html)))))
- (if caption (push (format "<caption>%s</caption>" caption) html))
- (push html-table-tag html))
- (concat (mapconcat 'identity html "\n") "\n")))
(defun org-table-clean-before-export (lines &optional maybe-quoted)
"Check if the table has a marking column.
(replace-match "\\1|" t nil x))))
lines))))
-(defun org-format-table-table-html (lines)
- "Format a table generated by table.el into HTML.
-This conversion does *not* use `table-generate-source' from table.el.
-This has the advantage that Org-mode's HTML conversions can be used.
-But it has the disadvantage, that no cell- or row-spanning is allowed."
- (let (line field-buffer
- (head org-export-highlight-first-table-line)
- fields html empty)
- (setq html (concat html-table-tag "\n"))
- (while (setq line (pop lines))
- (setq empty " ")
- (catch 'next-line
- (if (string-match "^[ \t]*\\+-" line)
- (progn
- (if field-buffer
- (progn
- (setq
- html
- (concat
- html
- "<tr>"
- (mapconcat
- (lambda (x)
- (if (equal x "") (setq x empty))
- (if head
- (concat (car org-export-table-header-tags) x
- (cdr org-export-table-header-tags))
- (concat (car org-export-table-data-tags) x
- (cdr org-export-table-data-tags))))
- field-buffer "\n")
- "</tr>\n"))
- (setq head nil)
- (setq field-buffer nil)))
- ;; Ignore this line
- (throw 'next-line t)))
- ;; Break the line into fields and store the fields
- (setq fields (org-split-string line "[ \t]*|[ \t]*"))
- (if field-buffer
- (setq field-buffer (mapcar
- (lambda (x)
- (concat x "<br/>" (pop fields)))
- field-buffer))
- (setq field-buffer fields))))
- (setq html (concat html "</table>\n"))
- html))
-
-(defun org-format-table-table-html-using-table-generate-source (lines)
- "Format a table into html, using `table-generate-source' from table.el.
-This has the advantage that cell- or row-spanning is allowed.
-But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
- (require 'table)
- (with-current-buffer (get-buffer-create " org-tmp1 ")
- (erase-buffer)
- (insert (mapconcat 'identity lines "\n"))
- (goto-char (point-min))
- (if (not (re-search-forward "|[^+]" nil t))
- (error "Error processing table"))
- (table-recognize-table)
- (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
- (table-generate-source 'html " org-tmp2 ")
- (set-buffer " org-tmp2 ")
- (buffer-substring (point-min) (point-max))))
-
-(defun org-export-splice-style (style extra)
- "Splice EXTRA into STYLE, just before \"</style>\"."
- (if (and (stringp extra)
- (string-match "\\S-" extra)
- (string-match "</style>" style))
- (concat (substring style 0 (match-beginning 0))
- "\n" extra "\n"
- (substring style (match-beginning 0)))
- style))
-
-(defun org-html-handle-time-stamps (s)
- "Format time stamps in string S, or remove them."
- (catch 'exit
- (let (r b)
- (while (string-match org-maybe-keyword-time-regexp s)
- (or b (setq b (substring s 0 (match-beginning 0))))
- (setq r (concat
- r (substring s 0 (match-beginning 0))
- (if (match-end 1)
- (format "@<span class=\"timestamp-kwd\">%s @</span>"
- (match-string 1 s)))
- (format " @<span class=\"timestamp\">%s@</span>"
- (substring
- (org-translate-time (match-string 3 s)) 1 -1)))
- s (substring s (match-end 0))))
- ;; Line break if line started and ended with time stamp stuff
- (if (not r)
- s
- (setq r (concat r s))
- (unless (string-match "\\S-" (concat b s))
- (setq r (concat r "@<br/>")))
- r))))
-
-(defun org-export-htmlize-region-for-paste (beg end)
- "Convert the region to HTML, using htmlize.el.
-This is much like `htmlize-region-for-paste', only that it uses
-the settings define in the org-... variables."
- (let* ((htmlize-output-type org-export-htmlize-output-type)
- (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
- (htmlbuf (htmlize-region beg end)))
- (unwind-protect
- (with-current-buffer htmlbuf
- (buffer-substring (plist-get htmlize-buffer-places 'content-start)
- (plist-get htmlize-buffer-places 'content-end)))
- (kill-buffer htmlbuf))))
-
-;;;###autoload
-(defun org-export-htmlize-generate-css ()
- "Create the CSS for all font definitions in the current Emacs session.
-Use this to create face definitions in your CSS style file that can then
-be used by code snippets transformed by htmlize.
-This command just produces a buffer that contains class definitions for all
-faces used in the current Emacs session. You can copy and paste the ones you
-need into your CSS file.
-
-If you then set `org-export-htmlize-output-type' to `css', calls to
-the function `org-export-htmlize-region-for-paste' will produce code
-that uses these same face definitions."
- (interactive)
- (require 'htmlize)
- (and (get-buffer "*html*") (kill-buffer "*html*"))
- (with-temp-buffer
- (let ((fl (face-list))
- (htmlize-css-name-prefix "org-")
- (htmlize-output-type 'css)
- f i)
- (while (setq f (pop fl)
- i (and f (face-attribute f :inherit)))
- (when (and (symbolp f) (or (not i) (not (listp i))))
- (insert (org-add-props (copy-sequence "1") nil 'face f))))
- (htmlize-region (point-min) (point-max))))
- (switch-to-buffer "*html*")
- (goto-char (point-min))
- (if (re-search-forward "<style" nil t)
- (delete-region (point-min) (match-beginning 0)))
- (if (re-search-forward "</style>" nil t)
- (delete-region (1+ (match-end 0)) (point-max)))
- (beginning-of-line 1)
- (if (looking-at " +") (replace-match ""))
- (goto-char (point-min)))
-
-(defun org-html-protect (s)
- ;; convert & to &, < to < and > to >
- (let ((start 0))
- (while (string-match "&" s start)
- (setq s (replace-match "&" t t s)
- start (1+ (match-beginning 0))))
- (while (string-match "<" s)
- (setq s (replace-match "<" t t s)))
- (while (string-match ">" s)
- (setq s (replace-match ">" t t s)))
-; (while (string-match "\"" s)
-; (setq s (replace-match """ t t s)))
- )
- s)
-
(defun org-export-cleanup-toc-line (s)
"Remove tags and timestamps from lines going into the toc."
(when (memq org-export-with-tags '(not-in-toc nil))
t t s)))
s)
-(defun org-html-expand (string)
- "Prepare STRING for HTML export. Applies all active conversions.
-If there are links in the string, don't modify these."
- (let* ((re (concat org-bracket-link-regexp "\\|"
- (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
- m s l res)
- (while (setq m (string-match re string))
- (setq s (substring string 0 m)
- l (match-string 0 string)
- string (substring string (match-end 0)))
- (push (org-html-do-expand s) res)
- (push l res))
- (push (org-html-do-expand string) res)
- (apply 'concat (nreverse res))))
-
-(defun org-html-do-expand (s)
- "Apply all active conversions to translate special ASCII to HTML."
- (setq s (org-html-protect s))
- (if org-export-html-expand
- (while (string-match "@<\\([^&]*\\)>" s)
- (setq s (replace-match "<\\1>" t nil s))))
- (if org-export-with-emphasize
- (setq s (org-export-html-convert-emphasize s)))
- (if org-export-with-special-strings
- (setq s (org-export-html-convert-special-strings s)))
- (if org-export-with-sub-superscripts
- (setq s (org-export-html-convert-sub-super s)))
- (if org-export-with-TeX-macros
- (let ((start 0) wd ass)
- (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)\\({}\\)?"
- s start))
- (if (get-text-property (match-beginning 0) 'org-protected s)
- (setq start (match-end 0))
- (setq wd (match-string 1 s))
- (if (setq ass (assoc wd org-html-entities))
- (setq s (replace-match (or (cdr ass)
- (concat "&" (car ass) ";"))
- t t s))
- (setq start (+ start (length wd))))))))
- s)
-
(defun org-create-multibrace-regexp (left right n)
"Create a regular expression which will match a balanced sexp.
Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
delimiters. It will also define a single group which contains the
match except for the outermost delimiters. The maximum depth of
stacked delimiters is N. Escaping delimiters is not possible."
- (let* ((nothing (concat "[^" "\\" left "\\" right "]*?"))
+ (let* ((nothing (concat "[^" left right "]*?"))
(or "\\|")
(re nothing)
(next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
"\\)")
"The regular expression matching a sub- or superscript, forcing braces.")
-(defconst org-export-html-special-string-regexps
- '(("\\\\-" . "­")
- ("---\\([^-]\\)" . "—\\1")
- ("--\\([^-]\\)" . "–\\1")
- ("\\.\\.\\." . "…"))
- "Regular expressions for special string conversion.")
-
-(defun org-export-html-convert-special-strings (string)
- "Convert special characters in STRING to HTML."
- (let ((all org-export-html-special-string-regexps)
- e a re rpl start)
- (while (setq a (pop all))
- (setq re (car a) rpl (cdr a) start 0)
- (while (string-match re string start)
- (if (get-text-property (match-beginning 0) 'org-protected string)
- (setq start (match-end 0))
- (setq string (replace-match rpl t nil string)))))
- string))
-
-(defun org-export-html-convert-sub-super (string)
- "Convert sub- and superscripts in STRING to HTML."
- (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
- (while (string-match org-match-substring-regexp string s)
- (cond
- ((and requireb (match-end 8)) (setq s (match-end 2)))
- ((get-text-property (match-beginning 2) 'org-protected string)
- (setq s (match-end 2)))
- (t
- (setq s (match-end 1)
- key (if (string= (match-string 2 string) "_") "sub" "sup")
- c (or (match-string 8 string)
- (match-string 6 string)
- (match-string 5 string))
- string (replace-match
- (concat (match-string 1 string)
- "<" key ">" c "</" key ">")
- t t string)))))
- (while (string-match "\\\\\\([_^]\\)" string)
- (setq string (replace-match (match-string 1 string) t t string)))
- string))
-
-(defun org-export-html-convert-emphasize (string)
- "Apply emphasis."
- (let ((s 0) rpl)
- (while (string-match org-emph-re string s)
- (if (not (equal
- (substring string (match-beginning 3) (1+ (match-beginning 3)))
- (substring string (match-beginning 4) (1+ (match-beginning 4)))))
- (setq s (match-beginning 0)
- rpl
- (concat
- (match-string 1 string)
- (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
- (match-string 4 string)
- (nth 3 (assoc (match-string 3 string)
- org-emphasis-alist))
- (match-string 5 string))
- string (replace-match rpl t t string)
- s (+ s (- (length rpl) 2)))
- (setq s (1+ s))))
- string))
-
-(defun org-open-par ()
- "Insert <p>, but first close previous paragraph if any."
- (org-close-par-maybe)
- (insert "\n<p>")
- (setq org-par-open t))
-(defun org-close-par-maybe ()
- "Close paragraph if there is one open."
- (when org-par-open
- (insert "</p>")
- (setq org-par-open nil)))
-(defun org-close-li (&optional type)
- "Close <li> if necessary."
- (org-close-par-maybe)
- (insert (if (equal type "d") "</dd>\n" "</li>\n")))
-
-(defvar body-only) ; dynamically scoped into this.
-(defun org-html-level-start (level title umax with-toc head-count)
- "Insert a new level in HTML export.
-When TITLE is nil, just close all open levels."
- (org-close-par-maybe)
- (let* ((target (and title (org-get-text-property-any 0 'target title)))
- (extra-targets
- (mapconcat (lambda (x)
- (format "<a name=\"%s\" id=\"%s\"></a>"
- x x))
- (cdr (assoc target org-export-target-aliases))
- ""))
- (l org-level-max)
- snumber)
- (while (>= l level)
- (if (aref org-levels-open (1- l))
- (progn
- (org-html-level-close l umax)
- (aset org-levels-open (1- l) nil)))
- (setq l (1- l)))
- (when title
- ;; If title is nil, this means this function is called to close
- ;; all levels, so the rest is done only if title is given
- (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
- (setq title (replace-match
- (if org-export-with-tags
- (save-match-data
- (concat
- " <span class=\"tag\">"
- (mapconcat 'identity (org-split-string
- (match-string 1 title) ":")
- " ")
- "</span>"))
- "")
- t t title)))
- (if (> level umax)
- (progn
- (if (aref org-levels-open (1- level))
- (progn
- (org-close-li)
- (if target
- (insert (format "<li id=\"%s\">" target) extra-targets title "<br/>\n")
- (insert "<li>" title "<br/>\n")))
- (aset org-levels-open (1- level) t)
- (org-close-par-maybe)
- (if target
- (insert (format "<ul>\n<li id=\"%s\">" target)
- extra-targets title "<br/>\n")
- (insert "<ul>\n<li>" title "<br/>\n"))))
- (aset org-levels-open (1- level) t)
- (setq snumber (org-section-number level))
- (if (and org-export-with-section-numbers (not body-only))
- (setq title (concat snumber " " title)))
- (setq level (+ level org-export-html-toplevel-hlevel -1))
- (unless (= head-count 1) (insert "\n</div>\n"))
- (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d\">\n<h%d id=\"sec-%s\">%s%s</h%d>\n<div id=\"text-%s\">\n"
- snumber level level snumber extra-targets title level snumber))
- (org-open-par)))))
(defun org-get-text-property-any (pos prop &optional object)
(or (get-text-property pos prop object)
(and (setq pos (next-single-property-change pos prop object))
(get-text-property pos prop object))))
-(defun org-html-level-close (level max-outline-level)
- "Terminate one level in HTML export."
- (if (<= level max-outline-level)
- (insert "</div>\n")
- (org-close-li)
- (insert "</ul>\n")))
-
-;;; iCalendar export
-
-;;;###autoload
-(defun org-export-icalendar-this-file ()
- "Export current file as an iCalendar file.
-The iCalendar file will be located in the same directory as the Org-mode
-file, but with extension `.ics'."
- (interactive)
- (org-export-icalendar nil buffer-file-name))
-
-;;;###autoload
-(defun org-export-icalendar-all-agenda-files ()
- "Export all files in `org-agenda-files' to iCalendar .ics files.
-Each iCalendar file will be located in the same directory as the Org-mode
-file, but with extension `.ics'."
- (interactive)
- (apply 'org-export-icalendar nil (org-agenda-files t)))
-
-;;;###autoload
-(defun org-export-icalendar-combine-agenda-files ()
- "Export all files in `org-agenda-files' to a single combined iCalendar file.
-The file is stored under the name `org-combined-agenda-icalendar-file'."
- (interactive)
- (apply 'org-export-icalendar t (org-agenda-files t)))
-
-(defun org-export-icalendar (combine &rest files)
- "Create iCalendar files for all elements of FILES.
-If COMBINE is non-nil, combine all calendar entries into a single large
-file and store it under the name `org-combined-agenda-icalendar-file'."
- (save-excursion
- (org-prepare-agenda-buffers files)
- (let* ((dir (org-export-directory
- :ical (list :publishing-directory
- org-export-publishing-directory)))
- file ical-file ical-buffer category started org-agenda-new-buffers)
- (and (get-buffer "*ical-tmp*") (kill-buffer "*ical-tmp*"))
- (when combine
- (setq ical-file
- (if (file-name-absolute-p org-combined-agenda-icalendar-file)
- org-combined-agenda-icalendar-file
- (expand-file-name org-combined-agenda-icalendar-file dir))
- ical-buffer (org-get-agenda-file-buffer ical-file))
- (set-buffer ical-buffer) (erase-buffer))
- (while (setq file (pop files))
- (catch 'nextfile
- (org-check-agenda-file file)
- (set-buffer (org-get-agenda-file-buffer file))
- (unless combine
- (setq ical-file (concat (file-name-as-directory dir)
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))
- ".ics"))
- (setq ical-buffer (org-get-agenda-file-buffer ical-file))
- (with-current-buffer ical-buffer (erase-buffer)))
- (setq category (or org-category
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))))
- (if (symbolp category) (setq category (symbol-name category)))
- (let ((standard-output ical-buffer))
- (if combine
- (and (not started) (setq started t)
- (org-start-icalendar-file org-icalendar-combined-name))
- (org-start-icalendar-file category))
- (org-print-icalendar-entries combine)
- (when (or (and combine (not files)) (not combine))
- (org-finish-icalendar-file)
- (set-buffer ical-buffer)
- (run-hooks 'org-before-save-iCalendar-file-hook)
- (save-buffer)
- (run-hooks 'org-after-save-iCalendar-file-hook)
- (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
- ))))
- (org-release-buffers org-agenda-new-buffers))))
-
-(defvar org-before-save-iCalendar-file-hook nil
- "Hook run before an iCalendar file has been saved.
-This can be used to modify the result of the export.")
-
-(defvar org-after-save-iCalendar-file-hook nil
- "Hook run after an iCalendar file has been saved.
-The iCalendar buffer is still current when this hook is run.
-A good way to use this is to tell a desktop calendar application to re-read
-the iCalendar file.")
-
-(defvar org-agenda-default-appointment-duration) ; defined in org-agenda.el
-(defun org-print-icalendar-entries (&optional combine)
- "Print iCalendar entries for the current Org-mode file to `standard-output'.
-When COMBINE is non nil, add the category to each line."
- (require 'org-agenda)
- (let ((re1 (concat org-ts-regexp "\\|<%%([^>\n]+>"))
- (re2 (concat "--?-?\\(" org-ts-regexp "\\)"))
- (dts (org-ical-ts-to-string
- (format-time-string (cdr org-time-stamp-formats) (current-time))
- "DTSTART"))
- hd ts ts2 state status (inc t) pos b sexp rrule
- scheduledp deadlinep todo prefix due start
- tmp pri categories location summary desc uid
- (sexp-buffer (get-buffer-create "*ical-tmp*")))
- (org-refresh-category-properties)
- (save-excursion
- (goto-char (point-min))
- (while (re-search-forward re1 nil t)
- (catch :skip
- (org-agenda-skip)
- (when (boundp 'org-icalendar-verify-function)
- (unless (funcall org-icalendar-verify-function)
- (outline-next-heading)
- (backward-char 1)
- (throw :skip nil)))
- (setq pos (match-beginning 0)
- ts (match-string 0)
- inc t
- hd (condition-case nil
- (org-icalendar-cleanup-string
- (org-get-heading))
- (error (throw :skip nil)))
- summary (org-icalendar-cleanup-string
- (org-entry-get nil "SUMMARY"))
- desc (org-icalendar-cleanup-string
- (or (org-entry-get nil "DESCRIPTION")
- (and org-icalendar-include-body (org-get-entry)))
- t org-icalendar-include-body)
- location (org-icalendar-cleanup-string
- (org-entry-get nil "LOCATION" 'selective))
- uid (if org-icalendar-store-UID
- (org-id-get-create)
- (or (org-id-get) (org-id-new)))
- categories (org-export-get-categories)
- deadlinep nil scheduledp nil)
- (if (looking-at re2)
- (progn
- (goto-char (match-end 0))
- (setq ts2 (match-string 1)
- inc (not (string-match "[0-9]\\{1,2\\}:[0-9][0-9]" ts2))))
- (setq tmp (buffer-substring (max (point-min)
- (- pos org-ds-keyword-length))
- pos)
- ts2 (if (string-match "[0-9]\\{1,2\\}:[0-9][0-9]-\\([0-9]\\{1,2\\}:[0-9][0-9]\\)" ts)
- (progn
- (setq inc nil)
- (replace-match "\\1" t nil ts))
- ts)
- deadlinep (string-match org-deadline-regexp tmp)
- scheduledp (string-match org-scheduled-regexp tmp)
- todo (org-get-todo-state)
- ;; donep (org-entry-is-done-p)
- ))
- (when (and
- deadlinep
- (if todo
- (not (memq 'event-if-todo org-icalendar-use-deadline))
- (not (memq 'event-if-not-todo org-icalendar-use-deadline))))
- (throw :skip t))
- (when (and
- scheduledp
- (if todo
- (not (memq 'event-if-todo org-icalendar-use-scheduled))
- (not (memq 'event-if-not-todo org-icalendar-use-scheduled))))
- (throw :skip t))
- (setq prefix (if deadlinep "DL-" (if scheduledp "SC-" "TS-")))
- (if (or (string-match org-tr-regexp hd)
- (string-match org-ts-regexp hd))
- (setq hd (replace-match "" t t hd)))
- (if (string-match "\\+\\([0-9]+\\)\\([dwmy]\\)>" ts)
- (setq rrule
- (concat "\nRRULE:FREQ="
- (cdr (assoc
- (match-string 2 ts)
- '(("d" . "DAILY")("w" . "WEEKLY")
- ("m" . "MONTHLY")("y" . "YEARLY"))))
- ";INTERVAL=" (match-string 1 ts)))
- (setq rrule ""))
- (setq summary (or summary hd))
- (if (string-match org-bracket-link-regexp summary)
- (setq summary
- (replace-match (if (match-end 3)
- (match-string 3 summary)
- (match-string 1 summary))
- t t summary)))
- (if deadlinep (setq summary (concat "DL: " summary)))
- (if scheduledp (setq summary (concat "S: " summary)))
- (if (string-match "\\`<%%" ts)
- (with-current-buffer sexp-buffer
- (insert (substring ts 1 -1) " " summary "\n"))
- (princ (format "BEGIN:VEVENT
-UID: %s
-%s
-%s%s
-SUMMARY:%s%s%s
-CATEGORIES:%s
-END:VEVENT\n"
- (concat prefix uid)
- (org-ical-ts-to-string ts "DTSTART")
- (org-ical-ts-to-string ts2 "DTEND" inc)
- rrule summary
- (if (and desc (string-match "\\S-" desc))
- (concat "\nDESCRIPTION: " desc) "")
- (if (and location (string-match "\\S-" location))
- (concat "\nLOCATION: " location) "")
- categories)))))
- (when (and org-icalendar-include-sexps
- (condition-case nil (require 'icalendar) (error nil))
- (fboundp 'icalendar-export-region))
- ;; Get all the literal sexps
- (goto-char (point-min))
- (while (re-search-forward "^&?%%(" nil t)
- (catch :skip
- (org-agenda-skip)
- (setq b (match-beginning 0))
- (goto-char (1- (match-end 0)))
- (forward-sexp 1)
- (end-of-line 1)
- (setq sexp (buffer-substring b (point)))
- (with-current-buffer sexp-buffer
- (insert sexp "\n"))))
- (princ (org-diary-to-ical-string sexp-buffer))
- (kill-buffer sexp-buffer))
-
- (when org-icalendar-include-todo
- (setq prefix "TODO-")
- (goto-char (point-min))
- (while (re-search-forward org-todo-line-regexp nil t)
- (catch :skip
- (org-agenda-skip)
- (when (boundp 'org-icalendar-verify-function)
- (unless (funcall org-icalendar-verify-function)
- (outline-next-heading)
- (backward-char 1)
- (throw :skip nil)))
- (setq state (match-string 2))
- (setq status (if (member state org-done-keywords)
- "COMPLETED" "NEEDS-ACTION"))
- (when (and state
- (or (not (member state org-done-keywords))
- (eq org-icalendar-include-todo 'all))
- (not (member org-archive-tag (org-get-tags-at)))
- )
- (setq hd (match-string 3)
- summary (org-icalendar-cleanup-string
- (org-entry-get nil "SUMMARY"))
- desc (org-icalendar-cleanup-string
- (or (org-entry-get nil "DESCRIPTION")
- (and org-icalendar-include-body (org-get-entry)))
- t org-icalendar-include-body)
- location (org-icalendar-cleanup-string
- (org-entry-get nil "LOCATION" 'selective))
- due (and (member 'todo-due org-icalendar-use-deadline)
- (org-entry-get nil "DEADLINE"))
- start (and (member 'todo-start org-icalendar-use-scheduled)
- (org-entry-get nil "SCHEDULED"))
- categories (org-export-get-categories)
- uid (if org-icalendar-store-UID
- (org-id-get-create)
- (or (org-id-get) (org-id-new))))
- (and due (setq due (org-ical-ts-to-string due "DUE")))
- (and start (setq start (org-ical-ts-to-string start "DTSTART")))
-
- (if (string-match org-bracket-link-regexp hd)
- (setq hd (replace-match (if (match-end 3) (match-string 3 hd)
- (match-string 1 hd))
- t t hd)))
- (if (string-match org-priority-regexp hd)
- (setq pri (string-to-char (match-string 2 hd))
- hd (concat (substring hd 0 (match-beginning 1))
- (substring hd (match-end 1))))
- (setq pri org-default-priority))
- (setq pri (floor (- 9 (* 8. (/ (float (- org-lowest-priority pri))
- (- org-lowest-priority org-highest-priority))))))
-
- (princ (format "BEGIN:VTODO
-UID: %s
-%s
-SUMMARY:%s%s%s%s
-CATEGORIES:%s
-SEQUENCE:1
-PRIORITY:%d
-STATUS:%s
-END:VTODO\n"
- (concat prefix uid)
- (or start dts)
- (or summary hd)
- (if (and location (string-match "\\S-" location))
- (concat "\nLOCATION: " location) "")
- (if (and desc (string-match "\\S-" desc))
- (concat "\nDESCRIPTION: " desc) "")
- (if due (concat "\n" due) "")
- categories
- pri status)))))))))
-
-(defun org-export-get-categories ()
- "Get categories according to `org-icalendar-categories'."
- (let ((cs org-icalendar-categories) c rtn tmp)
- (while (setq c (pop cs))
- (cond
- ((eq c 'category) (push (org-get-category) rtn))
- ((eq c 'todo-state)
- (setq tmp (org-get-todo-state))
- (and tmp (push tmp rtn)))
- ((eq c 'local-tags)
- (setq rtn (append (nreverse (org-get-local-tags-at (point))) rtn)))
- ((eq c 'all-tags)
- (setq rtn (append (nreverse (org-get-tags-at (point))) rtn)))))
- (mapconcat 'identity (nreverse rtn) ",")))
-
-(defun org-icalendar-cleanup-string (s &optional is-body maxlength)
- "Take out stuff and quote what needs to be quoted.
-When IS-BODY is non-nil, assume that this is the body of an item, clean up
-whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
-characters."
- (if (not s)
- nil
- (when is-body
- (let ((re (concat "\\(" org-drawer-regexp "\\)[^\000]*?:END:.*\n?"))
- (re2 (concat "^[ \t]*" org-keyword-time-regexp ".*\n?")))
- (while (string-match re s) (setq s (replace-match "" t t s)))
- (while (string-match re2 s) (setq s (replace-match "" t t s)))))
- (let ((start 0))
- (while (string-match "\\([,;]\\)" s start)
- (setq start (+ (match-beginning 0) 2)
- s (replace-match "\\\\\\1" nil nil s))))
- (setq s (org-trim s))
- (when is-body
- (while (string-match "[ \t]*\n[ \t]*" s)
- (setq s (replace-match "\\n" t t s))))
- (if is-body
- (if maxlength
- (if (and (numberp maxlength)
- (> (length s) maxlength))
- (setq s (substring s 0 maxlength)))))
- s))
-
-(defun org-icalendar-cleanup-string-rfc2455 (s &optional is-body maxlength)
- "Take out stuff and quote what needs to be quoted.
-When IS-BODY is non-nil, assume that this is the body of an item, clean up
-whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
-characters.
-This seems to be more like RFC 2455, but it causes problems, so it is
-not used right now."
- (if (not s)
- nil
- (if is-body
- (let ((re (concat "\\(" org-drawer-regexp "\\)[^\000]*?:END:.*\n?"))
- (re2 (concat "^[ \t]*" org-keyword-time-regexp ".*\n?")))
- (while (string-match re s) (setq s (replace-match "" t t s)))
- (while (string-match re2 s) (setq s (replace-match "" t t s)))
- (setq s (org-trim s))
- (while (string-match "[ \t]*\n[ \t]*" s)
- (setq s (replace-match "\\n" t t s)))
- (if maxlength
- (if (and (numberp maxlength)
- (> (length s) maxlength))
- (setq s (substring s 0 maxlength)))))
- (setq s (org-trim s)))
- (while (string-match "\"" s) (setq s (replace-match "''" t t s)))
- (when (string-match "[;,:]" s) (setq s (concat "\"" s "\"")))
- s))
-
-(defun org-get-entry ()
- "Clean-up description string."
- (save-excursion
- (org-back-to-heading t)
- (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
-
-(defun org-start-icalendar-file (name)
- "Start an iCalendar file by inserting the header."
- (let ((user user-full-name)
- (name (or name "unknown"))
- (timezone (cadr (current-time-zone))))
- (princ
- (format "BEGIN:VCALENDAR
-VERSION:2.0
-X-WR-CALNAME:%s
-PRODID:-//%s//Emacs with Org-mode//EN
-X-WR-TIMEZONE:%s
-CALSCALE:GREGORIAN\n" name user timezone))))
-
-(defun org-finish-icalendar-file ()
- "Finish an iCalendar file by inserting the END statement."
- (princ "END:VCALENDAR\n"))
-
-(defun org-ical-ts-to-string (s keyword &optional inc)
- "Take a time string S and convert it to iCalendar format.
-KEYWORD is added in front, to make a complete line like DTSTART....
-When INC is non-nil, increase the hour by two (if time string contains
-a time), or the day by one (if it does not contain a time)."
- (let ((t1 (org-parse-time-string s 'nodefault))
- t2 fmt have-time time)
- (if (and (car t1) (nth 1 t1) (nth 2 t1))
- (setq t2 t1 have-time t)
- (setq t2 (org-parse-time-string s)))
- (let ((s (car t2)) (mi (nth 1 t2)) (h (nth 2 t2))
- (d (nth 3 t2)) (m (nth 4 t2)) (y (nth 5 t2)))
- (when inc
- (if have-time
- (if org-agenda-default-appointment-duration
- (setq mi (+ org-agenda-default-appointment-duration mi))
- (setq h (+ 2 h)))
- (setq d (1+ d))))
- (setq time (encode-time s mi h d m y)))
- (setq fmt (if have-time ":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
- (concat keyword (format-time-string fmt time))))
-
-;;; XOXO export
-
-(defun org-export-as-xoxo-insert-into (buffer &rest output)
- (with-current-buffer buffer
- (apply 'insert output)))
-(put 'org-export-as-xoxo-insert-into 'lisp-indent-function 1)
-
-;;;###autoload
-(defun org-export-as-xoxo (&optional buffer)
- "Export the org buffer as XOXO.
-The XOXO buffer is named *xoxo-<source buffer name>*"
- (interactive (list (current-buffer)))
- ;; A quickie abstraction
-
- ;; Output everything as XOXO
- (with-current-buffer (get-buffer buffer)
- (let* ((pos (point))
- (opt-plist (org-combine-plists (org-default-export-plist)
- (org-infile-export-plist)))
- (filename (concat (file-name-as-directory
- (org-export-directory :xoxo opt-plist))
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))
- ".html"))
- (out (find-file-noselect filename))
- (last-level 1)
- (hanging-li nil))
- (goto-char (point-min)) ;; CD: beginning-of-buffer is not allowed.
- ;; Check the output buffer is empty.
- (with-current-buffer out (erase-buffer))
- ;; Kick off the output
- (org-export-as-xoxo-insert-into out "<ol class='xoxo'>\n")
- (while (re-search-forward "^\\(\\*+\\)[ \t]+\\(.+\\)" (point-max) 't)
- (let* ((hd (match-string-no-properties 1))
- (level (length hd))
- (text (concat
- (match-string-no-properties 2)
- (save-excursion
- (goto-char (match-end 0))
- (let ((str ""))
- (catch 'loop
- (while 't
- (forward-line)
- (if (looking-at "^[ \t]\\(.*\\)")
- (setq str (concat str (match-string-no-properties 1)))
- (throw 'loop str)))))))))
-
- ;; Handle level rendering
- (cond
- ((> level last-level)
- (org-export-as-xoxo-insert-into out "\n<ol>\n"))
-
- ((< level last-level)
- (dotimes (- (- last-level level) 1)
- (if hanging-li
- (org-export-as-xoxo-insert-into out "</li>\n"))
- (org-export-as-xoxo-insert-into out "</ol>\n"))
- (when hanging-li
- (org-export-as-xoxo-insert-into out "</li>\n")
- (setq hanging-li nil)))
-
- ((equal level last-level)
- (if hanging-li
- (org-export-as-xoxo-insert-into out "</li>\n")))
- )
-
- (setq last-level level)
-
- ;; And output the new li
- (setq hanging-li 't)
- (if (equal ?+ (elt text 0))
- (org-export-as-xoxo-insert-into out "<li class='" (substring text 1) "'>")
- (org-export-as-xoxo-insert-into out "<li>" text))))
-
- ;; Finally finish off the ol
- (dotimes (- last-level 1)
- (if hanging-li
- (org-export-as-xoxo-insert-into out "</li>\n"))
- (org-export-as-xoxo-insert-into out "</ol>\n"))
-
- (goto-char pos)
- ;; Finish the buffer off and clean it up.
- (switch-to-buffer-other-window out)
- (indent-region (point-min) (point-max) nil)
- (save-buffer)
- (goto-char (point-min))
- )))
+(defun org-export-get-coderef-format (path desc)
+ (save-match-data
+ (if (and desc (string-match
+ (regexp-quote (concat "(" path ")"))
+ desc))
+ (replace-match "%s" t t desc)
+ (or desc "%s"))))
+
+(defun org-export-push-to-kill-ring (format)
+ "Push buffer content to kill ring.
+The depends on the variable `org-export-copy-to-kill'."
+ (when org-export-copy-to-kill-ring
+ (org-kill-new (buffer-string))
+ (when (fboundp 'x-set-selection)
+ (ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
+ (ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
+ (message "%s export done, pushed to kill ring and clipboard" format)))
(provide 'org-exp)
+++ /dev/null
-;;; org-export-latex.el --- LaTeX exporter for org-mode
-;;
-;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
-;;
-;; Emacs Lisp Archive Entry
-;; Filename: org-export-latex.el
-;; Version: 6.21b
-;; Author: Bastien Guerry <bzg AT altern DOT org>
-;; Maintainer: Bastien Guerry <bzg AT altern DOT org>
-;; Keywords: org, wp, tex
-;; Description: Converts an org-mode buffer into LaTeX
-;; URL: http://www.cognition.ens.fr/~guerry/u/org-export-latex.el
-
-;; This file is part of GNU Emacs.
-
-;; GNU Emacs is free software: you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation, either version 3 of the License, or
-;; (at your option) any later version.
-
-;; GNU Emacs is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-;; GNU General Public License for more details.
-
-;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
-
-;;; Commentary:
-;;
-;; This library implements a LaTeX exporter for org-mode.
-;;
-;; Put this file into your load-path and the following into your ~/.emacs:
-;; (require 'org-export-latex)
-;;
-;; The interactive functions are similar to those of the HTML exporter:
-;;
-;; M-x `org-export-as-latex'
-;; M-x `org-export-as-pdf'
-;; M-x `org-export-as-pdf-and-open'
-;; M-x `org-export-as-latex-batch'
-;; M-x `org-export-as-latex-to-buffer'
-;; M-x `org-export-region-as-latex'
-;; M-x `org-replace-region-by-latex'
-;;
-;;; Code:
-
-(eval-when-compile
- (require 'cl))
-
-(require 'footnote)
-(require 'org)
-(require 'org-exp)
-
-;;; Variables:
-(defvar org-export-latex-class nil)
-(defvar org-export-latex-header nil)
-(defvar org-export-latex-append-header nil)
-(defvar org-export-latex-options-plist nil)
-(defvar org-export-latex-todo-keywords-1 nil)
-(defvar org-export-latex-all-targets-re nil)
-(defvar org-export-latex-add-level 0)
-(defvar org-export-latex-sectioning "")
-(defvar org-export-latex-sectioning-depth 0)
-(defvar org-export-latex-special-keyword-regexp
- (concat "\\<\\(" org-scheduled-string "\\|"
- org-deadline-string "\\|"
- org-closed-string"\\)")
- "Regexp matching special time planning keywords plus the time after it.")
-
-(defvar latexp) ; dynamically scoped from org.el
-(defvar re-quote) ; dynamically scoped from org.el
-(defvar commentsp) ; dynamically scoped from org.el
-
-;;; User variables:
-
-(defgroup org-export-latex nil
- "Options for exporting Org-mode files to LaTeX."
- :tag "Org Export LaTeX"
- :group 'org-export)
-
-(defcustom org-export-latex-default-class "article"
- "The default LaTeX class."
- :group 'org-export-latex
- :type '(string :tag "LaTeX class"))
-
-(defcustom org-export-latex-classes
- '(("article"
- "\\documentclass[11pt]{article}
-\\usepackage[utf8]{inputenc}
-\\usepackage[T1]{fontenc}
-\\usepackage{graphicx}
-\\usepackage{longtable}
-\\usepackage{hyperref}"
- ("\\section{%s}" . "\\section*{%s}")
- ("\\subsection{%s}" . "\\subsection*{%s}")
- ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
- ("\\paragraph{%s}" . "\\paragraph*{%s}")
- ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
- ("report"
- "\\documentclass[11pt]{report}
-\\usepackage[utf8]{inputenc}
-\\usepackage[T1]{fontenc}
-\\usepackage{graphicx}
-\\usepackage{longtable}
-\\usepackage{hyperref}"
- ("\\part{%s}" . "\\part*{%s}")
- ("\\chapter{%s}" . "\\chapter*{%s}")
- ("\\section{%s}" . "\\section*{%s}")
- ("\\subsection{%s}" . "\\subsection*{%s}")
- ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
- ("book"
- "\\documentclass[11pt]{book}
-\\usepackage[utf8]{inputenc}
-\\usepackage[T1]{fontenc}
-\\usepackage{graphicx}
-\\usepackage{longtable}
-\\usepackage{hyperref}"
- ("\\part{%s}" . "\\part*{%s}")
- ("\\chapter{%s}" . "\\chapter*{%s}")
- ("\\section{%s}" . "\\section*{%s}")
- ("\\subsection{%s}" . "\\subsection*{%s}")
- ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
- "Alist of LaTeX classes and associated header and structure.
-If #+LaTeX_CLASS is set in the buffer, use its value and the
-associated information. Here is the structure of each cell:
-
- \(class-name
- header-string
- (numbered-section . unnumbered-section\)
- ...\)
-
-A %s formatter is mandatory in each section string and will be
-replaced by the title of the section.
-
-Instead of a cons cell (numbered . unnumbered), you can also provide a list
-of 2-4 elements,
-
- (numbered-open numbered-close)
-
-or
-
- (numbered-open numbered-close unnumbered-open unnumbered-close)
-
-providing opening and closing strings for an environment that should
-represent the document section. The opening clause should have a %s
-to represent the section title."
- :group 'org-export-latex
- :type '(repeat
- (list (string :tag "LaTeX class")
- (string :tag "LaTeX header")
- (repeat :tag "Levels" :inline t
- (choice
- (cons :tag "Heading"
- (string :tag "numbered")
- (string :tag "unnumbered)"))
- (list :tag "Environment"
- (string :tag "Opening (numbered) ")
- (string :tag "Closing (numbered) ")
- (string :tag "Opening (unnumbered)")
- (string :tag "Closing (unnumbered)")))))))
-
-(defcustom org-export-latex-emphasis-alist
- '(("*" "\\textbf{%s}" nil)
- ("/" "\\emph{%s}" nil)
- ("_" "\\underline{%s}" nil)
- ("+" "\\texttt{%s}" nil)
- ("=" "\\verb=%s=" nil)
- ("~" "\\verb~%s~" t))
- "Alist of LaTeX expressions to convert emphasis fontifiers.
-Each element of the list is a list of three elements.
-The first element is the character used as a marker for fontification.
-The second element is a formatting string to wrap fontified text with.
-The third element decides whether to protect converted text from other
-conversions."
- :group 'org-export-latex
- :type 'alist)
-
-(defcustom org-export-latex-title-command "\\maketitle"
- "The command used to insert the title just after \\begin{document}.
-If this string contains the formatting specification \"%s\" then
-it will be used as a formatting string, passing the title as an
-argument."
- :group 'org-export-latex
- :type 'string)
-
-(defcustom org-export-latex-date-format
- "%d %B %Y"
- "Format string for \\date{...}."
- :group 'org-export-latex
- :type 'string)
-
-(defcustom org-export-latex-tables-verbatim nil
- "When non-nil, tables are exported verbatim."
- :group 'org-export-latex
- :type 'boolean)
-
-(defcustom org-export-latex-tables-column-borders nil
- "When non-nil, group of columns are surrounded with borders."
- :group 'org-export-latex
- :type 'boolean)
-
-(defcustom org-export-latex-packages-alist nil
- "Alist of packages to be inserted in the header.
-Each cell is of the forma \( \"option\" . \"package\" \)."
- :group 'org-export-latex
- :type 'alist)
-
-(defcustom org-export-latex-low-levels 'description
- "How to convert sections below the current level of sectioning.
-This is specified by the `org-export-headline-levels' option or the
-value of \"H:\" in Org's #+OPTION line.
-
-This can be either nil (skip the sections), 'description (convert
-the sections as descriptive lists) or a string to be used instead
-of \\section{%s}. In this latter case, the %s stands here for the
-inserted headline and is mandatory."
- :group 'org-export-latex
- :type '(choice (const :tag "Ignore" nil)
- (symbol :tag "Convert as descriptive list" description)
- (string :tag "Use a section string" :value "\\subparagraph{%s}")))
-
-(defcustom org-export-latex-list-parameters
- '(:cbon "\\texttt{[ ]}" :cboff "\\texttt{[ ]}")
- "Parameters for the LaTeX list exporter.
-These parameters will be passed on to `org-list-to-latex', which in turn
-will pass them (combined with the LaTeX default list parameters) to
-`org-list-to-generic'."
- :group 'org-export-latex
- :type 'plist)
-
-(defcustom org-export-latex-remove-from-headlines
- '(:todo nil :priority nil :tags nil)
- "A plist of keywords to remove from headlines. OBSOLETE.
-Non-nil means remove this keyword type from the headline.
-
-Don't remove the keys, just change their values.
-
-Obsolete, this variable is no longer used. Use the separate
-variables `org-export-with-todo-keywords', `org-export-with-priority',
-and `org-export-with-tags' instead."
- :type 'plist
- :group 'org-export-latex)
-
-(defcustom org-export-latex-image-default-option "width=10em"
- "Default option for images."
- :group 'org-export-latex
- :type 'string)
-
-(defcustom org-export-latex-inline-image-extensions
- '("pdf" "jpeg" "jpg" "png")
- "Extensions of image files that can be inlined into LaTeX.
-Note that this depends on the way the LaTeX file is processed.
-The default setting (pdf and jpg) assumes that pdflatex is doing the
-processing. If you are using latex and dvips or something similar,
-only postscript files can be included."
- :group 'org-export-html
- :type '(repeat (string :tag "Extension")))
-
-(defcustom org-export-latex-coding-system nil
- "Coding system for the exported LaTex file."
- :group 'org-export-latex
- :type 'coding-system)
-
-(defgroup org-export-pdf nil
- "Options for exporting Org-mode files to PDF, via LaTeX."
- :tag "Org Export LaTeX"
- :group 'org-export-latex
- :group 'org-export)
-
-(defcustom org-export-pdf-remove-logfiles t
- "Non-nil means, remove the logfiles produced by PDF production.
-These are the .aux, .log, .out, and .toc files."
- :group 'org-export-latex
- :type 'boolean)
-
-;;; Autoload functions:
-
-;;;###autoload
-(defun org-export-as-latex-batch ()
- "Call `org-export-as-latex', may be used in batch processing.
-For example:
-
-emacs --batch
- --load=$HOME/lib/emacs/org.el
- --eval \"(setq org-export-headline-levels 2)\"
- --visit=MyFile --funcall org-export-as-latex-batch"
- (org-export-as-latex org-export-headline-levels 'hidden))
-
-;;;###autoload
-(defun org-export-as-latex-to-buffer (arg)
- "Call `org-export-as-latex` with output to a temporary buffer.
-No file is created. The prefix ARG is passed through to `org-export-as-latex'."
- (interactive "P")
- (org-export-as-latex arg nil nil "*Org LaTeX Export*")
- (switch-to-buffer-other-window "*Org LaTeX Export*"))
-
-;;;###autoload
-(defun org-replace-region-by-latex (beg end)
- "Replace the region from BEG to END with its LaTeX export.
-It assumes the region has `org-mode' syntax, and then convert it to
-LaTeX. This can be used in any buffer. For example, you could
-write an itemized list in `org-mode' syntax in an LaTeX buffer and
-then use this command to convert it."
- (interactive "r")
- (let (reg latex buf)
- (save-window-excursion
- (if (org-mode-p)
- (setq latex (org-export-region-as-latex
- beg end t 'string))
- (setq reg (buffer-substring beg end)
- buf (get-buffer-create "*Org tmp*"))
- (save-excursion
- (set-buffer buf)
- (erase-buffer)
- (insert reg)
- (org-mode)
- (setq latex (org-export-region-as-latex
- (point-min) (point-max) t 'string)))
- (kill-buffer buf)))
- (delete-region beg end)
- (insert latex)))
-
-;;;###autoload
-(defun org-export-region-as-latex (beg end &optional body-only buffer)
- "Convert region from BEG to END in `org-mode' buffer to LaTeX.
-If prefix arg BODY-ONLY is set, omit file header, footer, and table of
-contents, and only produce the region of converted text, useful for
-cut-and-paste operations.
-If BUFFER is a buffer or a string, use/create that buffer as a target
-of the converted LaTeX. If BUFFER is the symbol `string', return the
-produced LaTeX as a string and leave not buffer behind. For example,
-a Lisp program could call this function in the following way:
-
- (setq latex (org-export-region-as-latex beg end t 'string))
-
-When called interactively, the output buffer is selected, and shown
-in a window. A non-interactive call will only retunr the buffer."
- (interactive "r\nP")
- (when (interactive-p)
- (setq buffer "*Org LaTeX Export*"))
- (let ((transient-mark-mode t) (zmacs-regions t)
- rtn)
- (goto-char end)
- (set-mark (point)) ;; to activate the region
- (goto-char beg)
- (setq rtn (org-export-as-latex
- nil nil nil
- buffer body-only))
- (if (fboundp 'deactivate-mark) (deactivate-mark))
- (if (and (interactive-p) (bufferp rtn))
- (switch-to-buffer-other-window rtn)
- rtn)))
-
-;;;###autoload
-(defun org-export-as-latex (arg &optional hidden ext-plist
- to-buffer body-only pub-dir)
- "Export current buffer to a LaTeX file.
-If there is an active region, export only the region. The prefix
-ARG specifies how many levels of the outline should become
-headlines. The default is 3. Lower levels will be exported
-depending on `org-export-latex-low-levels'. The default is to
-convert them as description lists. When HIDDEN is non-nil, don't
-display the LaTeX buffer. EXT-PLIST is a property list with
-external parameters overriding org-mode's default settings, but
-still inferior to file-local settings. When TO-BUFFER is
-non-nil, create a buffer with that name and export to that
-buffer. If TO-BUFFER is the symbol `string', don't leave any
-buffer behind but just return the resulting LaTeX as a string.
-When BODY-ONLY is set, don't produce the file header and footer,
-simply return the content of \begin{document}...\end{document},
-without even the \begin{document} and \end{document} commands.
-when PUB-DIR is set, use this as the publishing directory."
- (interactive "P")
- ;; Make sure we have a file name when we need it.
- (when (and (not (or to-buffer body-only))
- (not buffer-file-name))
- (if (buffer-base-buffer)
- (org-set-local 'buffer-file-name
- (with-current-buffer (buffer-base-buffer)
- buffer-file-name))
- (error "Need a file name to be able to export")))
-
- (message "Exporting to LaTeX...")
- (remove-text-properties (point-min) (point-max)
- '(:org-license-to-kill nil))
- (org-update-radio-target-regexp)
- (org-export-latex-set-initial-vars ext-plist arg)
- (let* ((wcf (current-window-configuration))
- (opt-plist org-export-latex-options-plist)
- (region-p (org-region-active-p))
- (rbeg (and region-p (region-beginning)))
- (rend (and region-p (region-end)))
- (subtree-p
- (when region-p
- (save-excursion
- (goto-char rbeg)
- (and (org-at-heading-p)
- (>= (org-end-of-subtree t t) rend)))))
- (opt-plist (if subtree-p
- (org-export-add-subtree-options opt-plist rbeg)
- opt-plist))
- ;; Make sure the variable contains the updated values.
- (org-export-latex-options-plist opt-plist)
- (title (or (and subtree-p (org-export-get-title-from-subtree))
- (plist-get opt-plist :title)
- (and (not
- (plist-get opt-plist :skip-before-1st-heading))
- (org-export-grab-title-from-buffer))
- (file-name-sans-extension
- (file-name-nondirectory buffer-file-name))))
- (filename (concat (file-name-as-directory
- (or pub-dir
- (org-export-directory :LaTeX ext-plist)))
- (file-name-sans-extension
- (or (and subtree-p
- (org-entry-get rbeg "EXPORT_FILE_NAME" t))
- (file-name-nondirectory ;sans-extension
- buffer-file-name)))
- ".tex"))
- (filename (if (equal (file-truename filename)
- (file-truename buffer-file-name))
- (concat filename ".tex")
- filename))
- (buffer (if to-buffer
- (cond
- ((eq to-buffer 'string) (get-buffer-create
- "*Org LaTeX Export*"))
- (t (get-buffer-create to-buffer)))
- (find-file-noselect filename)))
- (odd org-odd-levels-only)
- (header (org-export-latex-make-header title opt-plist))
- (skip (cond (subtree-p nil)
- (region-p nil)
- (t (plist-get opt-plist :skip-before-1st-heading))))
- (text (plist-get opt-plist :text))
- (first-lines (if skip "" (org-export-latex-first-lines
- opt-plist rbeg)))
- (coding-system (and (boundp 'buffer-file-coding-system)
- buffer-file-coding-system))
- (coding-system-for-write (or org-export-latex-coding-system
- coding-system))
- (save-buffer-coding-system (or org-export-latex-coding-system
- coding-system))
- (region (buffer-substring
- (if region-p (region-beginning) (point-min))
- (if region-p (region-end) (point-max))))
- (string-for-export
- (org-export-preprocess-string
- region
- :emph-multiline t
- :for-LaTeX t
- :comments nil
- :tags (plist-get opt-plist :tags)
- :priority (plist-get opt-plist :priority)
- :footnotes (plist-get opt-plist :footnotes)
- :timestamps (plist-get opt-plist :timestamps)
- :todo-keywords (plist-get opt-plist :todo-keywords)
- :add-text (if (eq to-buffer 'string) nil text)
- :skip-before-1st-heading skip
- :select-tags (plist-get opt-plist :select-tags)
- :exclude-tags (plist-get opt-plist :exclude-tags)
- :LaTeX-fragments nil)))
-
- (set-buffer buffer)
- (erase-buffer)
-
- (and (fboundp 'set-buffer-file-coding-system)
- (set-buffer-file-coding-system coding-system-for-write))
-
- ;; insert the header and initial document commands
- (unless (or (eq to-buffer 'string) body-only)
- (insert header))
-
- ;; insert text found in #+TEXT
- (when (and text (not (eq to-buffer 'string)))
- (insert (org-export-latex-content
- text '(lists tables fixed-width keywords))
- "\n\n"))
-
- ;; insert lines before the first headline
- (unless (or skip (eq to-buffer 'string))
- (insert first-lines))
-
- ;; export the content of headlines
- (org-export-latex-global
- (with-temp-buffer
- (insert string-for-export)
- (goto-char (point-min))
- (when (re-search-forward "^\\(\\*+\\) " nil t)
- (let* ((asters (length (match-string 1)))
- (level (if odd (- asters 2) (- asters 1))))
- (setq org-export-latex-add-level
- (if odd (1- (/ (1+ asters) 2)) (1- asters)))
- (org-export-latex-parse-global level odd)))))
-
- ;; finalization
- (unless body-only (insert "\n\\end{document}"))
- (or to-buffer (save-buffer))
- (goto-char (point-min))
- (message "Exporting to LaTeX...done")
- (prog1
- (if (eq to-buffer 'string)
- (prog1 (buffer-substring (point-min) (point-max))
- (kill-buffer (current-buffer)))
- (current-buffer))
- (set-window-configuration wcf))))
-
-;;;###autoload
-(defun org-export-as-pdf (arg &optional hidden ext-plist
- to-buffer body-only pub-dir)
- "Export as LaTeX, then process through to PDF."
- (interactive "P")
- (message "Exporting to PDF...")
- (let* ((wconfig (current-window-configuration))
- (lbuf (org-export-as-latex arg hidden ext-plist
- to-buffer body-only pub-dir))
- (file (buffer-file-name lbuf))
- (base (file-name-sans-extension (buffer-file-name lbuf)))
- (pdffile (concat base ".pdf")))
- (and (file-exists-p pdffile) (delete-file pdffile))
- (message "Processing LaTeX file...")
- (shell-command (format "pdflatex -interaction nonstopmode %s"
- (shell-quote-argument file)))
- (shell-command (format "pdflatex -interaction nonstopmode %s"
- (shell-quote-argument file)))
- (message "Processing LaTeX file...done")
- (if (not (file-exists-p pdffile))
- (error "PDF file was not produced")
- (set-window-configuration wconfig)
- (when org-export-pdf-remove-logfiles
- (dolist (ext '("aux" "log" "out" "toc"))
- (setq file (concat base "." ext))
- (and (file-exists-p file) (delete-file file))))
- (message "Exporting to PDF...done")
- pdffile)))
-
-;;;###autoload
-(defun org-export-as-pdf-and-open (arg)
- "Export as LaTeX, then process through to PDF, and open."
- (interactive "P")
- (let ((pdffile (org-export-as-pdf arg)))
- (if pdffile
- (org-open-file pdffile)
- (error "PDF file was not produced"))))
-
-;;; Parsing functions:
-
-(defun org-export-latex-parse-global (level odd)
- "Parse the current buffer recursively, starting at LEVEL.
-If ODD is non-nil, assume the buffer only contains odd sections.
-Return a list reflecting the document structure."
- (save-excursion
- (goto-char (point-min))
- (let* ((cnt 0) output
- (depth org-export-latex-sectioning-depth))
- (while (re-search-forward
- (concat "^\\(\\(?:\\*\\)\\{"
- (number-to-string (+ (if odd 2 1) level))
- "\\}\\) \\(.*\\)$")
- ;; make sure that there is no upper heading
- (when (> level 0)
- (save-excursion
- (save-match-data
- (re-search-forward
- (concat "^\\(\\(?:\\*\\)\\{"
- (number-to-string level)
- "\\}\\) \\(.*\\)$") nil t)))) t)
- (setq cnt (1+ cnt))
- (let* ((pos (match-beginning 0))
- (heading (match-string 2))
- (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
- (save-excursion
- (narrow-to-region
- (point)
- (save-match-data
- (if (re-search-forward
- (concat "^\\(\\(?:\\*\\)\\{"
- (number-to-string (+ (if odd 2 1) level))
- "\\}\\) \\(.*\\)$") nil t)
- (match-beginning 0)
- (point-max))))
- (goto-char (point-min))
- (setq output
- (append output
- (list
- (list
- `(pos . ,pos)
- `(level . ,nlevel)
- `(occur . ,cnt)
- `(heading . ,heading)
- `(content . ,(org-export-latex-parse-content))
- `(subcontent . ,(org-export-latex-parse-subcontent
- level odd)))))))
- (widen)))
- (list output))))
-
-(defun org-export-latex-parse-content ()
- "Extract the content of a section."
- (let ((beg (point))
- (end (if (re-search-forward "^\\(\\*\\)+ .*$" nil t)
- (progn (beginning-of-line) (point))
- (point-max))))
- (buffer-substring beg end)))
-
-(defun org-export-latex-parse-subcontent (level odd)
- "Extract the subcontent of a section at LEVEL.
-If ODD Is non-nil, assume subcontent only contains odd sections."
- (if (not (re-search-forward
- (concat "^\\(\\(?:\\*\\)\\{"
- (number-to-string (+ (if odd 4 2) level))
- "\\}\\) \\(.*\\)$")
- nil t))
- nil ; subcontent is nil
- (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
-
-;;; Rendering functions:
-(defun org-export-latex-global (content)
- "Export CONTENT to LaTeX.
-CONTENT is an element of the list produced by
-`org-export-latex-parse-global'."
- (if (eq (car content) 'subcontent)
- (mapc 'org-export-latex-sub (cdr content))
- (org-export-latex-sub (car content))))
-
-(defun org-export-latex-sub (subcontent)
- "Export the list SUBCONTENT to LaTeX.
-SUBCONTENT is an alist containing information about the headline
-and its content."
- (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
- (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
-
-(defun org-export-latex-subcontent (subcontent num)
- "Export each cell of SUBCONTENT to LaTeX.
-If NUM, export sections as numerical sections."
- (let* ((heading (org-export-latex-fontify-headline
- (cdr (assoc 'heading subcontent))))
- (level (- (cdr (assoc 'level subcontent))
- org-export-latex-add-level))
- (occur (number-to-string (cdr (assoc 'occur subcontent))))
- (content (cdr (assoc 'content subcontent)))
- (subcontent (cadr (assoc 'subcontent subcontent)))
- (label (org-get-text-property-any 0 'target heading))
- (label-list (cons label (cdr (assoc label
- org-export-target-aliases)))))
- (cond
- ;; Normal conversion
- ((<= level org-export-latex-sectioning-depth)
- (let* ((sec (nth (1- level) org-export-latex-sectioning))
- start end)
- (if (consp (cdr sec))
- (setq start (nth (if num 0 2) sec)
- end (nth (if num 1 3) sec))
- (setq start (if num (car sec) (cdr sec))))
- (insert (format start heading) "\n")
- (when label
- (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
- label-list "\n") "\n"))
- (insert (org-export-latex-content content))
- (cond ((stringp subcontent) (insert subcontent))
- ((listp subcontent) (org-export-latex-sub subcontent)))
- (if end (insert end "\n"))))
- ;; At a level under the hl option: we can drop this subsection
- ((> level org-export-latex-sectioning-depth)
- (cond ((eq org-export-latex-low-levels 'description)
- (insert (format "\\begin{description}\n\n\\item[%s]%s\n\n"
- heading
- (if label (format "\\label{%s}" label) "")))
- (insert (org-export-latex-content content))
- (cond ((stringp subcontent) (insert subcontent))
- ((listp subcontent) (org-export-latex-sub subcontent)))
- (insert "\\end{description}\n"))
- ((stringp org-export-latex-low-levels)
- (insert (format org-export-latex-low-levels heading) "\n")
- (when label (insert (format "\\label{%s}\n" label)))
- (insert (org-export-latex-content content))
- (cond ((stringp subcontent) (insert subcontent))
- ((listp subcontent) (org-export-latex-sub subcontent)))))))))
-
-;;; Exporting internals:
-(defun org-export-latex-set-initial-vars (ext-plist level)
- "Store org local variables required for LaTeX export.
-EXT-PLIST is an optional additional plist.
-LEVEL indicates the default depth for export."
- (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
- org-export-latex-all-targets-re
- (org-make-target-link-regexp (org-all-targets))
- org-export-latex-options-plist
- (org-combine-plists (org-default-export-plist) ext-plist
- (org-infile-export-plist))
- org-export-latex-class
- (or (and (org-region-active-p)
- (save-excursion
- (goto-char (region-beginning))
- (and (looking-at org-complex-heading-regexp)
- (org-entry-get nil "LaTeX_CLASS" 'selective))))
- (save-excursion
- (save-restriction
- (widen)
- (goto-char (point-min))
- (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([a-zA-Z]+\\)" nil t)
- (match-string 1))))
- org-export-latex-default-class)
- org-export-latex-class
- (or (car (assoc org-export-latex-class org-export-latex-classes))
- (error "No definition for class `%s' in `org-export-latex-classes'"
- org-export-latex-class))
- org-export-latex-header
- (cadr (assoc org-export-latex-class org-export-latex-classes))
- org-export-latex-sectioning
- (cddr (assoc org-export-latex-class org-export-latex-classes))
- org-export-latex-sectioning-depth
- (or level
- (let ((hl-levels
- (plist-get org-export-latex-options-plist :headline-levels))
- (sec-depth (length org-export-latex-sectioning)))
- (if (> hl-levels sec-depth) sec-depth hl-levels)))))
-
-(defun org-export-latex-make-header (title opt-plist)
- "Make the LaTeX header and return it as a string.
-TITLE is the current title from the buffer or region.
-OPT-PLIST is the options plist for current buffer."
- (let ((toc (plist-get opt-plist :table-of-contents))
- (author (plist-get opt-plist :author)))
- (concat
- (if (plist-get opt-plist :time-stamp-file)
- (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
- ;; insert LaTeX custom header
- org-export-latex-header
- "\n"
- ;; insert information on LaTeX packages
- (when org-export-latex-packages-alist
- (mapconcat (lambda(p)
- (if (equal "" (car p))
- (format "\\usepackage{%s}" (cadr p))
- (format "\\usepackage[%s]{%s}"
- (car p) (cadr p))))
- org-export-latex-packages-alist "\n"))
- ;; insert additional commands in the header
- (plist-get opt-plist :latex-header-extra)
- org-export-latex-append-header
- ;; insert the title
- (format
- "\n\n\\title{%s}\n"
- ;; convert the title
- (org-export-latex-content
- title '(lists tables fixed-width keywords)))
- ;; insert author info
- (if (plist-get opt-plist :author-info)
- (format "\\author{%s}\n"
- (or author user-full-name))
- (format "%%\\author{%s}\n"
- (or author user-full-name)))
- ;; insert the date
- (format "\\date{%s}\n"
- (format-time-string
- (or (plist-get opt-plist :date)
- org-export-latex-date-format)))
- ;; beginning of the document
- "\n\\begin{document}\n\n"
- ;; insert the title command
- (if (string-match "%s" org-export-latex-title-command)
- (format org-export-latex-title-command title)
- org-export-latex-title-command)
- "\n\n"
- ;; table of contents
- (when (and org-export-with-toc
- (plist-get opt-plist :section-numbers))
- (cond ((numberp toc)
- (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
- (min toc (plist-get opt-plist :headline-levels))))
- (toc (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
- (plist-get opt-plist :headline-levels))))))))
-
-(defun org-export-latex-first-lines (opt-plist &optional beg)
- "Export the first lines before first headline.
-If BEG is non-nil, the is the beginning of he region."
- (save-excursion
- (goto-char (or beg (point-min)))
- (if (org-at-heading-p) (beginning-of-line 2))
- (let* ((pt (point))
- (end (if (re-search-forward "^\\*+ " nil t)
- (goto-char (match-beginning 0))
- (goto-char (point-max)))))
- (prog1
- (org-export-latex-content
- (org-export-preprocess-string
- (buffer-substring pt end)
- :for-LaTeX t
- :emph-multiline t
- :add-text nil
- :comments nil
- :skip-before-1st-heading nil
- :LaTeX-fragments nil
- :timestamps (plist-get opt-plist :timestamps)
- :footnotes (plist-get opt-plist :footnotes)))
- (add-text-properties pt (max pt (1- end))
- '(:org-license-to-kill t))))))
-
-(defun org-export-latex-content (content &optional exclude-list)
- "Convert CONTENT string to LaTeX.
-Don't perform conversions that are in EXCLUDE-LIST. Recognized
-conversion types are: quotation-marks, emphasis, sub-superscript,
-links, keywords, lists, tables, fixed-width"
- (with-temp-buffer
- (insert content)
- (unless (memq 'quotation-marks exclude-list)
- (org-export-latex-quotation-marks))
- (unless (memq 'emphasis exclude-list)
- (when (plist-get org-export-latex-options-plist :emphasize)
- (org-export-latex-fontify)))
- (unless (memq 'sub-superscript exclude-list)
- (org-export-latex-special-chars
- (plist-get org-export-latex-options-plist :sub-superscript)))
- (unless (memq 'links exclude-list)
- (org-export-latex-links))
- (unless (memq 'keywords exclude-list)
- (org-export-latex-keywords))
- (unless (memq 'lists exclude-list)
- (org-export-latex-lists))
- (unless (memq 'tables exclude-list)
- (org-export-latex-tables
- (plist-get org-export-latex-options-plist :tables)))
- (unless (memq 'fixed-width exclude-list)
- (org-export-latex-fixed-width
- (plist-get org-export-latex-options-plist :fixed-width)))
- ;; return string
- (buffer-substring (point-min) (point-max))))
-
-(defun org-export-latex-protect-string (s)
- "Add the org-protected property to string S."
- (add-text-properties 0 (length s) '(org-protected t) s) s)
-
-(defun org-export-latex-protect-char-in-string (char-list string)
- "Add org-protected text-property to char from CHAR-LIST in STRING."
- (with-temp-buffer
- (save-match-data
- (insert string)
- (goto-char (point-min))
- (while (re-search-forward (regexp-opt char-list) nil t)
- (add-text-properties (match-beginning 0)
- (match-end 0) '(org-protected t)))
- (buffer-string))))
-
-(defun org-export-latex-keywords-maybe (&optional remove-list)
- "Maybe remove keywords depending on rules in REMOVE-LIST."
- (goto-char (point-min))
- (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
- (case-fold-search nil))
- ;; convert TODO keywords
- (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
- (if (plist-get remove-list :todo)
- (replace-match "")
- (replace-match (format "\\textbf{%s}" (match-string 1)) t t)))
- ;; convert priority string
- (when (re-search-forward "\\[\\\\#.\\]" nil t)
- (if (plist-get remove-list :priority)
- (replace-match "")
- (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
- ;; convert tags
- (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t)
- (if (or (not org-export-with-tags)
- (plist-get remove-list :tags))
- (replace-match "")
- (replace-match
- (org-export-latex-protect-string
- (format "\\textbf{%s}"
- (save-match-data
- (replace-regexp-in-string
- "_" "\\\\_" (match-string 0)))))
- t t)))))
-
-(defun org-export-latex-fontify-headline (string)
- "Fontify special words in STRING."
- (with-temp-buffer
- ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
- ;; the beginning of the buffer - inserting "\n" is safe here though.
- (insert "\n" string)
- (goto-char (point-min))
- (when (plist-get org-export-latex-options-plist :emphasize)
- (org-export-latex-fontify))
- (org-export-latex-keywords-maybe)
- (org-export-latex-special-chars
- (plist-get org-export-latex-options-plist :sub-superscript))
- (org-export-latex-links)
- (org-trim (buffer-string))))
-
-(defun org-export-latex-quotation-marks ()
- "Export quotation marks depending on language conventions."
- (let* ((lang (plist-get org-export-latex-options-plist :language))
- (quote-rpl (if (equal lang "fr")
- '(("\\(\\s-\\)\"" "«~")
- ("\\(\\S-\\)\"" "~»")
- ("\\(\\s-\\)'" "`"))
- '(("\\(\\s-\\)\"" "``")
- ("\\(\\S-\\)\"" "''")
- ("\\(\\s-\\)'" "`")))))
- (mapc (lambda(l) (goto-char (point-min))
- (while (re-search-forward (car l) nil t)
- (let ((rpl (concat (match-string 1) (cadr l))))
- (org-export-latex-protect-string rpl)
- (org-if-unprotected-1
- (replace-match rpl t t))))) quote-rpl)))
-
-(defun org-export-latex-special-chars (sub-superscript)
- "Export special characters to LaTeX.
-If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
-See the `org-export-latex.el' code for a complete conversion table."
- (goto-char (point-min))
- (mapc (lambda(c)
- (goto-char (point-min))
- (while (re-search-forward c nil t)
- ;; Put the point where to check for org-protected
- (unless (get-text-property (match-beginning 2) 'org-protected)
- (cond ((member (match-string 2) '("\\$" "$"))
- (if (equal (match-string 2) "\\$")
- nil
- (replace-match "\\$" t t)))
- ((member (match-string 2) '("&" "%" "#"))
- (if (equal (match-string 1) "\\")
- (replace-match (match-string 2) t t)
- (replace-match (concat (match-string 1) "\\"
- (match-string 2)) t t)))
- ((equal (match-string 2) "...")
- (replace-match
- (concat (match-string 1)
- (org-export-latex-protect-string "\\ldots{}")) t t))
- ((equal (match-string 2) "~")
- (cond ((equal (match-string 1) "\\") nil)
- ((eq 'org-link (get-text-property 0 'face (match-string 2)))
- (replace-match (concat (match-string 1) "\\~") t t))
- (t (replace-match
- (org-export-latex-protect-string
- (concat (match-string 1) "\\~{}")) t t))))
- ((member (match-string 2) '("{" "}"))
- (unless (save-match-data (org-inside-latex-math-p))
- (if (equal (match-string 1) "\\")
- (replace-match (match-string 2) t t)
- (replace-match (concat (match-string 1) "\\"
- (match-string 2)) t t)))))
- (unless (save-match-data (org-inside-latex-math-p))
- (cond ((equal (match-string 2) "\\")
- (replace-match (or (save-match-data
- (org-export-latex-treat-backslash-char
- (match-string 1)
- (or (match-string 3) "")))
- "") t t))
- ((member (match-string 2) '("_" "^"))
- (replace-match (or (save-match-data
- (org-export-latex-treat-sub-super-char
- sub-superscript
- (match-string 2)
- (match-string 1)
- (match-string 3))) "") t t)))))))
- '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
- "\\(\\(\\\\?\\$\\)\\)"
- "\\([a-za-z0-9]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\([a-za-z0-9]+\\|[ \t\n]\\|[:punct:]\\|{[a-za-z0-9]+}\\|([a-za-z0-9]+)\\)"
- "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|[a-zA-Z&#%{}\"]+\\)"
- "\\(.\\|^\\)\\(&\\)"
- "\\(.\\|^\\)\\(#\\)"
- "\\(.\\|^\\)\\(%\\)"
- "\\(.\\|^\\)\\({\\)"
- "\\(.\\|^\\)\\(}\\)"
- "\\(.\\|^\\)\\(~\\)"
- "\\(.\\|^\\)\\(\\.\\.\\.\\)"
- ;; (?\< . "\\textless{}")
- ;; (?\> . "\\textgreater{}")
- )))
-
-(defun org-inside-latex-math-p ()
- (get-text-property (point) 'org-latex-math))
-
-(defun org-export-latex-treat-sub-super-char
- (subsup char string-before string-after)
- "Convert the \"_\" and \"^\" characters to LaTeX.
-SUBSUP corresponds to the ^: option in the #+OPTIONS line.
-Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
- (cond ((equal string-before "\\")
- (concat string-before char string-after))
- ;; this is part of a math formula
- ((and (string-match "\\S-+" string-before)
- (string-match "\\S-+" string-after))
- (cond ((eq 'org-link (get-text-property 0 'face char))
- (concat string-before "\\" char string-after))
- ((save-match-data (org-inside-latex-math-p))
- (if subsup
- (cond ((eq 1 (length string-after))
- (concat string-before char string-after))
- ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
- (format "%s%s{%s}" string-before char
- (match-string 1 string-after))))))
- ((and (> (length string-after) 1)
- (or (eq subsup t)
- (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
- (string-match "[({]?\\([^)}]+\\)[)}]?" string-after))
- (format "%s$%s{%s}$" string-before char
- (if (> (match-end 1) (1+ (match-beginning 1)))
- (concat "\\mathrm{" (match-string 1 string-after) "}")
- (match-string 1 string-after))))
- ((eq subsup t) (concat string-before "$" char string-after "$"))
- (t (org-export-latex-protect-string
- (concat string-before "\\" char "{}" string-after)))))
- (t (org-export-latex-protect-string
- (concat string-before "\\" char "{}" string-after)))))
-
-(defun org-export-latex-treat-backslash-char (string-before string-after)
- "Convert the \"$\" special character to LaTeX.
-The conversion is made depending of STRING-BEFORE and STRING-AFTER."
- (cond ((member (list string-after) org-html-entities)
- ;; backslash is part of a special entity (like "\alpha")
- (concat string-before "$\\"
- (or (cdar (member (list string-after) org-html-entities))
- string-after) "$"))
- ((and (not (string-match "^[ \n\t]" string-after))
- (not (string-match "[ \t]\\'\\|^" string-before)))
- ;; backslash is inside a word
- (org-export-latex-protect-string
- (concat string-before "\\textbackslash{}" string-after)))
- ((not (or (equal string-after "")
- (string-match "^[ \t\n]" string-after)))
- ;; backslash might escape a character (like \#) or a user TeX
- ;; macro (like \setcounter)
- (org-export-latex-protect-string
- (concat string-before "\\" string-after)))
- ((and (string-match "^[ \t\n]" string-after)
- (string-match "[ \t\n]\\'" string-before))
- ;; backslash is alone, convert it to $\backslash$
- (org-export-latex-protect-string
- (concat string-before "\\textbackslash{}" string-after)))
- (t (org-export-latex-protect-string
- (concat string-before "\\textbackslash{}" string-after)))))
-
-(defun org-export-latex-keywords ()
- "Convert special keywords to LaTeX."
- (goto-char (point-min))
- (let ((re (concat org-export-latex-special-keyword-regexp
- ".*" ; including the time stamp....
- )))
- (while (re-search-forward re nil t)
- (replace-match (format "\\\\texttt{%s}" (match-string 0)) t))))
-
-(defun org-export-latex-fixed-width (opt)
- "When OPT is non-nil convert fixed-width sections to LaTeX."
- (goto-char (point-min))
- (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
- (if opt
- (progn (goto-char (match-beginning 0))
- (insert "\\begin{verbatim}\n")
- (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
- (replace-match (concat (match-string 1)
- (match-string 2)) t t)
- (forward-line))
- (insert "\\end{verbatim}\n\n"))
- (progn (goto-char (match-beginning 0))
- (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
- (replace-match (concat "%" (match-string 1)
- (match-string 2)) t t)
- (forward-line))))))
-
-
-(defvar org-table-last-alignment) ; defined in org-table.el
-(declare-function orgtbl-to-latex "org-table" (table params) t)
-(defun org-export-latex-tables (insert)
- "Convert tables to LaTeX and INSERT it."
- (goto-char (point-min))
- (while (re-search-forward "^\\([ \t]*\\)|" nil t)
- ;; FIXME really need to save-excursion?
- (save-excursion (org-table-align))
- (let* ((beg (org-table-begin))
- (end (org-table-end))
- (raw-table (buffer-substring beg end))
- fnum fields line lines olines gr colgropen line-fmt align
- caption label attr floatp longtblp)
- (if org-export-latex-tables-verbatim
- (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
- "\\end{verbatim}\n")))
- (apply 'delete-region (list beg end))
- (insert (org-export-latex-protect-string tbl)))
- (progn
- (setq caption (org-find-text-property-in-string
- 'org-caption raw-table)
- attr (org-find-text-property-in-string
- 'org-attributes raw-table)
- label (org-find-text-property-in-string
- 'org-label raw-table)
- longtblp (and attr (stringp attr)
- (string-match "\\<longtable\\>" attr))
- align (and attr (stringp attr)
- (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
- (match-string 1 attr))
- floatp (or caption label))
- (setq lines (split-string raw-table "\n" t))
- (apply 'delete-region (list beg end))
- (when org-export-table-remove-special-lines
- (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
- ;; make a formatting string to reflect aligment
- (setq olines lines)
- (while (and (not line-fmt) (setq line (pop olines)))
- (unless (string-match "^[ \t]*|-" line)
- (setq fields (org-split-string line "[ \t]*|[ \t]*"))
- (setq fnum (make-vector (length fields) 0))
- (setq line-fmt
- (mapconcat
- (lambda (x)
- (setq gr (pop org-table-colgroup-info))
- (format "%s%%s%s"
- (cond ((eq gr ':start)
- (prog1 (if colgropen "|" "")
- (setq colgropen t)))
- ((eq gr ':startend)
- (prog1 (if colgropen "|" "|")
- (setq colgropen nil)))
- (t ""))
- (if (memq gr '(:end :startend))
- (progn (setq colgropen nil) "|")
- "")))
- fnum ""))))
- ;; fix double || in line-fmt
- (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
- ;; maybe remove the first and last "|"
- (when (and (not org-export-latex-tables-column-borders)
- (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
- (setq line-fmt (match-string 2 line-fmt)))
- ;; format alignment
- (unless align
- (setq align (apply 'format
- (cons line-fmt
- (mapcar (lambda (x) (if x "r" "l"))
- org-table-last-alignment)))))
- ;; prepare the table to send to orgtbl-to-latex
- (setq lines
- (mapcar
- (lambda(elem)
- (or (and (string-match "[ \t]*|-+" elem) 'hline)
- (split-string (org-trim elem) "|" t)))
- lines))
- (when insert
- (insert (org-export-latex-protect-string
- (concat
- (if longtblp
- (concat "\\begin{longtable}{" align "}\n")
- (if floatp "\\begin{table}[htb]\n"))
- (if (or floatp longtblp)
- (format
- "\\caption{%s%s}"
- (if label (concat "\\\label{" label "}") "")
- (or caption "")))
- (if longtblp "\\\\\n" "\n")
- (if (not longtblp) "\\begin{center}\n")
- (if (not longtblp) (concat "\\begin{tabular}{" align "}\n"))
- (orgtbl-to-latex
- lines
- `(:tstart nil :tend nil
- :hlend ,(if longtblp
- (format "\\\\
-\\hline
-\\endhead
-\\hline\\multicolumn{%d}{r}{Continued on next page}\\
-\\endfoot
-\\endlastfoot" (length org-table-last-alignment))
- nil)))
- (if (not longtblp) (concat "\n\\end{tabular}"))
- (if longtblp "\n" "\n\\end{center}\n")
- (if longtblp
- "\\end{longtable}"
- (if floatp "\\end{table}"))))
- "\n\n")))))))
-
-(defun org-export-latex-fontify ()
- "Convert fontification to LaTeX."
- (goto-char (point-min))
- (while (re-search-forward org-emph-re nil t)
- ;; The match goes one char after the *string*
- (let ((emph (assoc (match-string 3)
- org-export-latex-emphasis-alist))
- (beg (match-beginning 0))
- (end (match-end 0))
- rpl)
- (unless (or (get-text-property (1- (point)) 'org-protected)
- (save-excursion
- (goto-char (match-beginning 1))
- (save-match-data
- (and (org-at-table-p)
- (string-match
- "[|\n]" (buffer-substring beg end))))))
- (setq rpl (concat (match-string 1)
- (format (org-export-latex-protect-char-in-string
- '("\\" "{" "}") (cadr emph))
- (match-string 4))
- (match-string 5)))
- (if (caddr emph)
- (setq rpl (org-export-latex-protect-string rpl)))
- (replace-match rpl t t)))
- (backward-char)))
-
-(defun org-export-latex-links ()
- ;; Make sure to use the LaTeX hyperref and graphicx package
- ;; or send some warnings.
- "Convert links to LaTeX."
- (goto-char (point-min))
- (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
- (org-if-unprotected
- (goto-char (match-beginning 0))
- (let* ((re-radio org-export-latex-all-targets-re)
- (remove (list (match-beginning 0) (match-end 0)))
- (raw-path (org-extract-attributes (match-string 3)))
- (full-raw-path (concat (match-string 1) raw-path))
- (desc (match-string 5))
- (type (or (match-string 2)
- (if (or (file-name-absolute-p raw-path)
- (string-match "^\\.\\.?/" raw-path))
- "file")))
- (coderefp (equal type "coderef"))
- (caption (org-find-text-property-in-string 'org-caption raw-path))
- (attr (org-find-text-property-in-string 'org-attributes raw-path))
- (label (org-find-text-property-in-string 'org-label raw-path))
- (floatp (or label caption))
- imgp radiop
- ;; define the path of the link
- (path (cond
- ((member type '("coderef"))
- raw-path)
- ((member type '("http" "https" "ftp"))
- (concat type ":" raw-path))
- ((and re-radio (string-match re-radio raw-path))
- (setq radiop t))
- ((equal type "mailto")
- (concat type ":" raw-path))
- ((equal type "file")
- (if (and (org-file-image-p
- (expand-file-name
- raw-path)
- org-export-latex-inline-image-extensions)
- (equal desc full-raw-path))
- (setq imgp t)
- (progn (when (string-match "\\(.+\\)::.+" raw-path)
- (setq raw-path (match-string 1 raw-path)))
- (if (file-exists-p raw-path)
- (concat type "://" (expand-file-name raw-path))
- (concat type "://" (org-export-directory
- :LaTeX org-export-latex-options-plist)
- raw-path))))))))
- ;; process with link inserting
- (apply 'delete-region remove)
- (cond ((and imgp (plist-get org-export-latex-options-plist :inline-images))
- (insert
- (concat
- (if floatp "\\begin{figure}[htb]\n")
- (format "\\centerline{\\includegraphics[%s]{%s}}\n"
- (or attr org-export-latex-image-default-option)
- (if (file-name-absolute-p raw-path)
- (expand-file-name raw-path)
- raw-path))
- (if floatp
- (format "\\caption{%s%s}\n"
- (if label (concat "\\label{" label "}") "")
- (or caption "")))
- (if floatp "\\end{figure}\n"))))
- (coderefp
- (insert (format
- (org-export-get-coderef-format path desc)
- (cdr (assoc path org-export-code-refs)))))
- (radiop (insert (format "\\hyperref[%s]{%s}"
- (org-solidify-link-text raw-path) desc)))
- ((not type)
- (insert (format "\\hyperref[%s]{%s}"
- (org-solidify-link-text raw-path) desc)))
- (path (insert (format "\\href{%s}{%s}" path desc)))
- (t (insert "\\texttt{" desc "}")))))))
-
-(defvar org-latex-entities) ; defined below
-(defvar org-latex-entities-regexp) ; defined below
-
-(defun org-export-latex-preprocess ()
- "Clean stuff in the LaTeX export."
- ;; Preserve line breaks
- (goto-char (point-min))
- (while (re-search-forward "\\\\\\\\" nil t)
- (add-text-properties (match-beginning 0) (match-end 0)
- '(org-protected t)))
-
- ;; Preserve latex environments
- (goto-char (point-min))
- (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\)}" nil t)
- (let* ((start (progn (beginning-of-line) (point)))
- (end (or (and (re-search-forward
- (concat "^[ \t]*\\\\end{" (match-string 1) "}") nil t)
- (point-at-eol))
- (point-max))))
- (add-text-properties start end '(org-protected t))))
-
- ;; Preserve math snippets
-
- (let* ((matchers (plist-get org-format-latex-options :matchers))
- (re-list org-latex-regexps)
- beg end re e m n block off)
- ;; Check the different regular expressions
- (while (setq e (pop re-list))
- (setq m (car e) re (nth 1 e) n (nth 2 e)
- block (if (nth 3 e) "\n\n" ""))
- (setq off (if (member m '("$" "$1")) 1 0))
- (when (and (member m matchers) (not (equal m "begin")))
- (goto-char (point-min))
- (while (re-search-forward re nil t)
- (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
- (add-text-properties beg end '(org-protected t org-latex-math t))))))
-
- ;; Convert LaTeX to \LaTeX{}
- (goto-char (point-min))
- (let ((case-fold-search nil))
- (while (re-search-forward "\\([^+_]\\)LaTeX" nil t)
- (org-if-unprotected
- (replace-match (org-export-latex-protect-string
- (concat (match-string 1) "\\LaTeX{}")) t t))))
-
- ;; Convert blockquotes
- (goto-char (point-min))
- (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
- (replace-match "\\begin{quote}" t t))
- (goto-char (point-min))
- (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
- (replace-match "\\end{quote}" t t))
-
- ;; Convert verse
- (goto-char (point-min))
- (while (search-forward "ORG-VERSE-START" nil t)
- (replace-match "\\begin{verse}" t t))
- (goto-char (point-min))
- (while (search-forward "ORG-VERSE-END" nil t)
- (replace-match "\\end{verse}" t t))
-
- ;; Convert horizontal rules
- (goto-char (point-min))
- (while (re-search-forward "^----+.$" nil t)
- (org-if-unprotected
- (replace-match (org-export-latex-protect-string "\\hrule") t t)))
-
- ;; Protect LaTeX commands like \command[...]{...} or \command{...}
- (goto-char (point-min))
- (while (re-search-forward "\\\\[a-zA-Z]+\\(?:\\[.*\\]\\)?{.*}" nil t)
- (add-text-properties (match-beginning 0) (match-end 0)
- '(org-protected t)))
-
- ;; Protect LaTeX entities
- (goto-char (point-min))
- (while (re-search-forward org-latex-entities-regexp nil t)
- (add-text-properties (match-beginning 0) (match-end 0)
- '(org-protected t)))
-
- ;; Replace radio links
- (goto-char (point-min))
- (while (re-search-forward
- (concat "<<<?" org-export-latex-all-targets-re
- ">>>?\\((INVISIBLE)\\)?") nil t)
- (org-if-unprotected
- (replace-match
- (org-export-latex-protect-string
- (format "\\label{%s}%s" (save-match-data (org-solidify-link-text
- (match-string 1)))
- (if (match-string 2) "" (match-string 1)))) t t)))
-
- ;; Delete @<...> constructs
- ;; Thanks to Daniel Clemente for this regexp
- (goto-char (point-min))
- (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
- (org-if-unprotected
- (replace-match "")))
-
- ;; When converting to LaTeX, replace footnotes
- ;; FIXME: don't protect footnotes from conversion
- (when (plist-get org-export-latex-options-plist :footnotes)
- (goto-char (point-min))
- (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t)
- (org-if-unprotected
- (when (save-match-data
- (save-excursion (beginning-of-line)
- (looking-at "[^:|#]")))
- (let ((foot-beg (match-beginning 0))
- (foot-end (match-end 0))
- (foot-prefix (match-string 0))
- footnote footnote-rpl)
- (save-excursion
- (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix))
- nil t))
- (replace-match "$^{\\1}$")
- (replace-match "")
- (let ((end (save-excursion
- (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t)
- (match-beginning 0) (point-max)))))
- (setq footnote (concat (org-trim (buffer-substring (point) end))
- " ")) ; prevent last } being part of a link
- (delete-region (point) end))
- (goto-char foot-beg)
- (delete-region foot-beg foot-end)
- (unless (null footnote)
- (setq footnote-rpl (format "\\footnote{%s}" footnote))
- (add-text-properties 0 10 '(org-protected t) footnote-rpl)
- (add-text-properties (1- (length footnote-rpl))
- (length footnote-rpl)
- '(org-protected t) footnote-rpl)
- (insert footnote-rpl)))
- )))))
-
- ;; Remove footnote section tag for LaTeX
- (goto-char (point-min))
- (while (re-search-forward
- (concat "^" footnote-section-tag-regexp) nil t)
- (org-if-unprotected
- (replace-match "")))))
-
-;;; List handling:
-
-(defun org-export-latex-lists ()
- "Convert plain text lists in current buffer into LaTeX lists."
- (goto-char (point-min))
- (while (re-search-forward org-list-beginning-re nil t)
- (org-if-unprotected
- (beginning-of-line)
- (insert (org-list-to-latex (org-list-parse-list t)
- org-export-latex-list-parameters))
- "\n")))
-
-(defconst org-latex-entities
- '("\\!"
- "\\'"
- "\\+"
- "\\,"
- "\\-"
- "\\:"
- "\\;"
- "\\<"
- "\\="
- "\\>"
- "\\Huge"
- "\\LARGE"
- "\\Large"
- "\\Styles"
- "\\\\"
- "\\`"
- "\\addcontentsline"
- "\\address"
- "\\addtocontents"
- "\\addtocounter"
- "\\addtolength"
- "\\addvspace"
- "\\alph"
- "\\appendix"
- "\\arabic"
- "\\author"
- "\\begin{array}"
- "\\begin{center}"
- "\\begin{description}"
- "\\begin{enumerate}"
- "\\begin{eqnarray}"
- "\\begin{equation}"
- "\\begin{figure}"
- "\\begin{flushleft}"
- "\\begin{flushright}"
- "\\begin{itemize}"
- "\\begin{list}"
- "\\begin{minipage}"
- "\\begin{picture}"
- "\\begin{quotation}"
- "\\begin{quote}"
- "\\begin{tabbing}"
- "\\begin{table}"
- "\\begin{tabular}"
- "\\begin{thebibliography}"
- "\\begin{theorem}"
- "\\begin{titlepage}"
- "\\begin{verbatim}"
- "\\begin{verse}"
- "\\bf"
- "\\bf"
- "\\bibitem"
- "\\bigskip"
- "\\cdots"
- "\\centering"
- "\\circle"
- "\\cite"
- "\\cleardoublepage"
- "\\clearpage"
- "\\cline"
- "\\closing"
- "\\dashbox"
- "\\date"
- "\\ddots"
- "\\dotfill"
- "\\em"
- "\\fbox"
- "\\flushbottom"
- "\\fnsymbol"
- "\\footnote"
- "\\footnotemark"
- "\\footnotesize"
- "\\footnotetext"
- "\\frac"
- "\\frame"
- "\\framebox"
- "\\hfill"
- "\\hline"
- "\\hrulespace"
- "\\hspace"
- "\\huge"
- "\\hyphenation"
- "\\include"
- "\\includeonly"
- "\\indent"
- "\\input"
- "\\it"
- "\\kill"
- "\\label"
- "\\large"
- "\\ldots"
- "\\line"
- "\\linebreak"
- "\\linethickness"
- "\\listoffigures"
- "\\listoftables"
- "\\location"
- "\\makebox"
- "\\maketitle"
- "\\mark"
- "\\mbox"
- "\\medskip"
- "\\multicolumn"
- "\\multiput"
- "\\newcommand"
- "\\newcounter"
- "\\newenvironment"
- "\\newfont"
- "\\newlength"
- "\\newline"
- "\\newpage"
- "\\newsavebox"
- "\\newtheorem"
- "\\nocite"
- "\\nofiles"
- "\\noindent"
- "\\nolinebreak"
- "\\nopagebreak"
- "\\normalsize"
- "\\onecolumn"
- "\\opening"
- "\\oval"
- "\\overbrace"
- "\\overline"
- "\\pagebreak"
- "\\pagenumbering"
- "\\pageref"
- "\\pagestyle"
- "\\par"
- "\\parbox"
- "\\put"
- "\\raggedbottom"
- "\\raggedleft"
- "\\raggedright"
- "\\raisebox"
- "\\ref"
- "\\rm"
- "\\roman"
- "\\rule"
- "\\savebox"
- "\\sc"
- "\\scriptsize"
- "\\setcounter"
- "\\setlength"
- "\\settowidth"
- "\\sf"
- "\\shortstack"
- "\\signature"
- "\\sl"
- "\\small"
- "\\smallskip"
- "\\sqrt"
- "\\tableofcontents"
- "\\telephone"
- "\\thanks"
- "\\thispagestyle"
- "\\tiny"
- "\\title"
- "\\tt"
- "\\twocolumn"
- "\\typein"
- "\\typeout"
- "\\underbrace"
- "\\underline"
- "\\usebox"
- "\\usecounter"
- "\\value"
- "\\vdots"
- "\\vector"
- "\\verb"
- "\\vfill"
- "\\vline"
- "\\vspace")
- "A list of LaTeX commands to be protected when performing conversion.")
-
-(defconst org-latex-entities-regexp
- (let (names rest)
- (dolist (x org-latex-entities)
- (if (string-match "[a-z][A-Z]$" x)
- (push x names)
- (push x rest)))
- (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
- "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
-
-(provide 'org-export-latex)
-
-;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
-
-;;; org-export-latex.el ends here
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
'((((class color) (background light)) (:underline t))
(((class color) (background dark)) (:underline t))
(t (:underline t)))
- "Face for links."
+ "Face for link targets."
:group 'org-faces)
(defface org-date
'((((class color) (background light)) (:foreground "Purple" :underline t))
(((class color) (background dark)) (:foreground "Cyan" :underline t))
(t (:underline t)))
- "Face for links."
+ "Face for date/time stamps."
:group 'org-faces)
(defface org-sexp-date
'((((class color) (background light)) (:foreground "Purple"))
(((class color) (background dark)) (:foreground "Cyan"))
(t (:underline t)))
- "Face for links."
+ "Face for diary-like sexp date specifications."
:group 'org-faces)
(defface org-tag
"Face used for todo keywords that indicate DONE items."
:group 'org-faces)
+(defface org-agenda-done ;; originally copied from font-lock-type-face
+ (org-compatible-face nil
+ '((((class color) (min-colors 16) (background light)) (:foreground "ForestGreen"))
+ (((class color) (min-colors 16) (background dark)) (:foreground "PaleGreen"))
+ (((class color) (min-colors 8)) (:foreground "green"))
+ (t (:bold nil))))
+ "Face used in agenda, to indicate lines switched to DONE.
+This face is used to de-emphasize items that where brightly colord in the
+agenda because they were things to do, or overdue. The DONE state itself
+is of course immediately visible, but for example a passed deadline is
+\(by default) very bright read. This face could be simply the default face
+of the frame, for example."
+ :group 'org-faces)
+
(defface org-headline-done ;; originally copied from font-lock-string-face
(org-compatible-face nil
'((((class color) (min-colors 16) (background light)) (:foreground "RosyBrown"))
(string :tag "keyword")
(sexp :tag "face"))))
+(defcustom org-priority-faces nil
+ "Faces for specific Priorities.
+This is a list of cons cells, with priority character in the car
+and faces in the cdr. The face can be a symbol, or a property
+list of attributes, like (:foreground \"blue\" :weight bold :underline t)."
+ :group 'org-faces
+ :group 'org-todo
+ :type '(repeat
+ (cons
+ (character :tag "Priority")
+ (sexp :tag "face"))))
+
(defvar org-tags-special-faces-re nil)
(defun org-set-tag-faces (var value)
(set var value)
(setq org-tags-special-faces-re
(concat ":\\(" (mapconcat 'car value "\\|") "\\):"))))
+(defface org-checkbox
+ (org-compatible-face 'bold
+ '((t (:bold t))))
+ "Face for checkboxes"
+ :group 'org-faces)
+
+(unless (facep 'org-checkbox-statistics-todo)
+ (copy-face 'org-todo 'org-checkbox-statistics-todo)
+ (set-face-doc-string 'org-checkbox-statistics-todo
+ "Face used for unfinished checkbox statistics."))
+
+(unless (facep 'org-checkbox-statistics-done)
+ (copy-face 'org-done 'org-checkbox-statistics-done)
+ (set-face-doc-string 'org-checkbox-statistics-done
+ "Face used for finished checkbox statistics."))
+
(defcustom org-tag-faces nil
"Faces for specific tags.
This is a list of cons cells, with tags in the car and faces in the cdr.
:group 'org-faces)
(defface org-code
- (org-compatible-face nil
+ (org-compatible-face 'shadow
'((((class color grayscale) (min-colors 88) (background light))
(:foreground "grey50"))
(((class color grayscale) (min-colors 88) (background dark))
:group 'org-faces
:version "22.1")
+(defface org-meta-line
+ (org-compatible-face 'font-lock-comment-face nil)
+ "Face for meta lines startin with \"#+\"."
+ :group 'org-faces
+ :version "22.1")
+
+(defface org-block
+ (org-compatible-face 'shadow
+ '((((class color grayscale) (min-colors 88) (background light))
+ (:foreground "grey50"))
+ (((class color grayscale) (min-colors 88) (background dark))
+ (:foreground "grey70"))
+ (((class color) (min-colors 8) (background light))
+ (:foreground "green"))
+ (((class color) (min-colors 8) (background dark))
+ (:foreground "yellow"))))
+ "Face text in #+begin ... #+end blocks."
+ :group 'org-faces
+ :version "22.1")
+
(defface org-verbatim
- (org-compatible-face nil
+ (org-compatible-face 'shadow
'((((class color grayscale) (min-colors 88) (background light))
(:foreground "grey50" :underline t))
(((class color grayscale) (min-colors 88) (background dark))
(set-face-doc-string 'org-agenda-date
"Face used in agenda for normal days."))
+(unless (facep 'org-agenda-date-today)
+ (copy-face 'org-agenda-date 'org-agenda-date-today)
+ (set-face-doc-string 'org-agenda-date-today
+ "Face used in agenda for today.")
+ (when (fboundp 'set-face-attribute)
+ (set-face-attribute 'org-agenda-date-today nil :weight 'bold :italic 't)))
+
(unless (facep 'org-agenda-date-weekend)
(copy-face 'org-agenda-date 'org-agenda-date-weekend)
(set-face-doc-string 'org-agenda-date-weekend
"The number of different faces to be used for headlines.
Org-mode defines 8 different headline faces, so this can be at most 8.
If it is less than 8, the level-1 face gets re-used for level N+1 etc."
- :type 'number
+ :type 'integer
:group 'org-faces)
(defface org-latex-and-export-specials
"Face used to highlight math latex and other special exporter stuff."
:group 'org-faces)
+(unless (facep 'org-mode-line-clock)
+ (copy-face 'modeline 'org-mode-line-clock)
+ (set-face-doc-string 'org-agenda-date
+ "Face used for clock display in mode line."))
+
(provide 'org-faces)
;; arch-tag: 9dab5f91-c4b9-4d6f-bac3-1f6211ad0a04
--- /dev/null
+;;; org-feed.el --- Add RSS feed items to Org files
+;;
+;; Copyright (C) 2009 Free Software Foundation, Inc.
+;;
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+;;
+;; This module allows to create and change entries in an Org-mode
+;; file triggered by items in an RSS feed. The basic functionality is
+;; geared toward simply adding new items found in a feed as outline nodes
+;; to an Org file. Using hooks, arbitrary actions can be triggered for
+;; new or changed items.
+;;
+;; Selecting feeds and target locations
+;; ------------------------------------
+;;
+;; This module is configured through a single variable, `org-feed-alist'.
+;; Here is an example, using a notes/tasks feed from reQall.com.
+;;
+;; (setq org-feed-alist
+;; '(("ReQall"
+;; "http://www.reqall.com/user/feeds/rss/a1b2c3....."
+;; "~/org/feeds.org" "ReQall Entries")
+;;
+;; With this setup, the command `M-x org-feed-update-all' will
+;; collect new entries in the feed at the given URL and create
+;; entries as subheadings under the "ReQall Entries" heading in the
+;; file "~/org-feeds.org". Each feed should normally have its own
+;; heading - however see the `:drawer' parameter.
+;;
+;; Besides these standard elements that need to be specified for each
+;; feed, keyword-value pairs can set additional options. For example,
+;; to de-select transitional entries with a title containing
+;;
+;; "reQall is typing what you said",
+;;
+;; you could use the `:filter' argument:
+;;
+;; (setq org-feed-alist
+;; '(("ReQall"
+;; "http://www.reqall.com/user/feeds/rss/a1b2c3....."
+;; "~/org/feeds.org" "ReQall Entries"
+;; :filter my-reqall-filter)))
+;;
+;; (defun my-reqall-filter (e)
+;; (if (string-match "reQall is typing what you said"
+;; (plist-get e :title))
+;; nil
+;; e))
+;;
+;; See the docstring for `org-feed-alist' for more details.
+;;
+;;
+;; Keeping track of previously added entries
+;; -----------------------------------------
+;;
+;; Since Org allows you to delete, archive, or move outline nodes,
+;; org-feed.el needs to keep track of which feed items have been handled
+;; before, so that they will not be handled again. For this, org-feed.el
+;; stores information in a special drawer, FEEDSTATUS, under the heading
+;; that received the input of the feed. You should add FEEDSTATUS
+;; to your list of drawers in the files that receive feed input:
+;;
+;; #+DRAWERS: PROPERTIES LOGBOOK FEEDSTATUS
+;;
+;; Acknowledgments
+;; ----------------
+;;
+;; org-feed.el is based on ideas by Brad Bozarth who implemented a
+;; similar mechanism using shell and awk scripts.
+
+;;; Code:
+
+(require 'org)
+(require 'sha1)
+
+(declare-function url-retrieve-synchronously "url" (url))
+(declare-function xml-node-children "xml" (node))
+(declare-function xml-get-children "xml" (node child-name))
+(declare-function xml-get-attribute "xml" (node attribute))
+(declare-function xml-get-attribute-or-nil "xml" (node attribute))
+
+(defgroup org-feed nil
+ "Options concerning RSS feeds as inputs for Org files."
+ :tag "Org ID"
+ :group 'org)
+
+(defcustom org-feed-alist nil
+ "Alist specifying RSS feeds that should create inputs for Org.
+Each entry in this list specified an RSS feed tat should be queried
+to create inbox items in Org. Each entry is a list with the following items:
+
+name a custom name for this feed
+URL the Feed URL
+file the target Org file where entries should be listed
+headline the headline under which entries should be listed
+
+Additional arguments can be given using keyword-value pairs. Many of these
+specify functions that receive one or a list of \"entries\" as their single
+argument. An entry is a property list that describes a feed item. The
+property list has properties for each field in the item, for example `:title'
+for the `<title>' field and `:pubDate' for the publication date. In addition,
+it contains the following properties:
+
+`:item-full-text' the full text in the <item> tag
+`:guid-permalink' t when the guid property is a permalink
+
+Here are the keyword-value pair allows in `org-feed-alist'.
+
+:drawer drawer-name
+ The name of the drawer for storing feed information. The default is
+ \"FEEDSTATUS\". Using different drawers for different feeds allows
+ several feeds to target the same inbox heading.
+
+:filter filter-function
+ A function to select interesting entries in the feed. It gets a single
+ entry as parameter. It should return the entry if it is relevant, or
+ nil if it is not.
+
+:template template-string
+ The default action on new items in the feed is to add them as children
+ under the headline for the feed. The template describes how the entry
+ should be formatted. If not given, it defaults to
+ `org-feed-default-template'.
+
+:formatter formatter-function
+ Instead of relying on a template, you may specify a function to format
+ the outline node to be inserted as a child. This function gets passed
+ a property list describing a single feed item, and it should return a
+ string that is a properly formatted Org outline node of level 1.
+
+:new-handler function
+ If adding new items as children to the outline is not what you want
+ to do with new items, define a handler function that is called with
+ a list of all new items in the feed, each one represented as a property
+ list. The handler should do what needs to be done, and org-feed will
+ mark all items given to this handler as \"handled\", i.e. they will not
+ be passed to this handler again in future readings of the feed.
+ When the handler is called, point will be at the feed headline.
+
+:changed-handler function
+ This function gets passed a list of all entries that have been
+ handled before, but are now still in the feed and have *changed*
+ since last handled (as evidenced by a different sha1 hash).
+ When the handler is called, point will be at the feed headline.
+
+:parse-feed function
+ This function gets passed a buffer, and should return a list of entries,
+ each being a property list containing the `:guid' and `:item-full-text'
+ keys. The default is `org-feed-parse-rss-feed'; `org-feed-parse-atom-feed'
+ is an alternative.
+
+:parse-entry function
+ This function gets passed an entry as returned by the parse-feed
+ function, and should return the entry with interesting properties added.
+ The default is `org-feed-parse-rss-entry'; `org-feed-parse-atom-entry'
+ is an alternative."
+ :group 'org-feed
+ :type '(repeat
+ (list :value ("" "http://" "" "")
+ (string :tag "Name")
+ (string :tag "Feed URL")
+ (file :tag "File for inbox")
+ (string :tag "Headline for inbox")
+ (repeat :inline t
+ (choice
+ (list :inline t :tag "Filter"
+ (const :filter)
+ (symbol :tag "Filter Function"))
+ (list :inline t :tag "Template"
+ (const :template)
+ (string :tag "Template"))
+ (list :inline t :tag "Formatter"
+ (const :formatter)
+ (symbol :tag "Formatter Function"))
+ (list :inline t :tag "New items handler"
+ (const :new-handler)
+ (symbol :tag "Handler Function"))
+ (list :inline t :tag "Changed items"
+ (const :changed-handler)
+ (symbol :tag "Handler Function"))
+ (list :inline t :tag "Parse Feed"
+ (const :parse-feed)
+ (symbol :tag "Parse Feed Function"))
+ (list :inline t :tag "Parse Entry"
+ (const :parse-entry)
+ (symbol :tag "Parse Entry Function"))
+ )))))
+
+(defcustom org-feed-drawer "FEEDSTATUS"
+ "The name of the drawer for feed status information.
+Each feed may also specify its own drawer name using the `:drawer'
+parameter in `org-feed-alist'.
+Note that in order to make these drawers behave like drawers, they must
+be added to the variable `org-drawers' or configured with a #+DRAWERS
+line."
+ :group 'org-feed
+ :type '(string :tag "Drawer Name"))
+
+(defcustom org-feed-default-template "\n* %h\n %U\n %description\n %a\n"
+ "Template for the Org node created from RSS feed items.
+This is just the default, each feed can specify its own.
+Any fields from the feed item can be interpolated into the template with
+%name, for example %title, %description, %pubDate etc. In addition, the
+following special escapes are valid as well:
+
+%h the title, or the first line of the description
+%t the date as a stamp, either from <pubDate> (if present), or
+ the current date.
+%T date and time
+%u,%U like %t,%T, but inactive time stamps
+%a A link, from <guid> if that is a permalink, else from <link>"
+ :group 'org-feed
+ :type '(string :tag "Template"))
+
+(defcustom org-feed-save-after-adding t
+ "Non-nil means, save buffer after adding new feed items."
+ :group 'org-feed
+ :type 'boolean)
+
+(defcustom org-feed-retrieve-method 'url-retrieve-synchronously
+ "The method to be used to retrieve a feed URL.
+This can be `curl' or `wget' to call these external programs, or it can be
+an Emacs Lisp function that will return a buffer containing the content
+of the file pointed to by the URL."
+ :group 'org-feed
+ :type '(choice
+ (const :tag "Internally with url.el" url-retrieve-synchronously)
+ (const :tag "Externally with curl" curl)
+ (const :tag "Externally with wget" wget)
+ (function :tag "Function")))
+
+ (defcustom org-feed-before-adding-hook nil
+ "Hook that is run before adding new feed items to a file.
+You might want to commit the file in its current state to version control,
+for example."
+ :group 'org-feed
+ :type 'hook)
+
+(defcustom org-feed-after-adding-hook nil
+ "Hook that is run after new items have been added to a file.
+Depending on `org-feed-save-after-adding', the buffer will already
+have been saved."
+ :group 'org-feed
+ :type 'hook)
+
+(defvar org-feed-buffer "*Org feed*"
+ "The buffer used to retrieve a feed.")
+
+;;;###autoload
+(defun org-feed-update-all ()
+ "Get inbox items from all feeds in `org-feed-alist'."
+ (interactive)
+ (let ((nfeeds (length org-feed-alist))
+ (nnew (apply '+ (mapcar 'org-feed-update org-feed-alist))))
+ (message "%s from %d %s"
+ (cond ((= nnew 0) "No new entries")
+ ((= nnew 1) "1 new entry")
+ (t (format "%d new entries" nnew)))
+ nfeeds
+ (if (= nfeeds 1) "feed" "feeds"))))
+
+;;;###autoload
+(defun org-feed-update (feed &optional retrieve-only)
+ "Get inbox items from FEED.
+FEED can be a string with an association in `org-feed-alist', or
+it can be a list structured like an entry in `org-feed-alist'."
+ (interactive (list (org-completing-read "Feed name: " org-feed-alist)))
+ (if (stringp feed) (setq feed (assoc feed org-feed-alist)))
+ (unless feed
+ (error "No such feed in `org-feed-alist"))
+ (catch 'exit
+ (let ((name (car feed))
+ (url (nth 1 feed))
+ (file (nth 2 feed))
+ (headline (nth 3 feed))
+ (filter (nth 1 (memq :filter feed)))
+ (formatter (nth 1 (memq :formatter feed)))
+ (new-handler (nth 1 (memq :new-handler feed)))
+ (changed-handler (nth 1 (memq :changed-handler feed)))
+ (template (or (nth 1 (memq :template feed))
+ org-feed-default-template))
+ (drawer (or (nth 1 (memq :drawer feed))
+ org-feed-drawer))
+ (parse-feed (or (nth 1 (memq :parse-feed feed))
+ 'org-feed-parse-rss-feed))
+ (parse-entry (or (nth 1 (memq :parse-entry feed))
+ 'org-feed-parse-rss-entry))
+ feed-buffer inbox-pos new-formatted
+ entries old-status status new changed guid-alist e guid olds)
+ (setq feed-buffer (org-feed-get-feed url))
+ (unless (and feed-buffer (bufferp (get-buffer feed-buffer)))
+ (error "Cannot get feed %s" name))
+ (when retrieve-only
+ (throw 'exit feed-buffer))
+ (setq entries (funcall parse-feed feed-buffer))
+ (ignore-errors (kill-buffer feed-buffer))
+ (save-excursion
+ (save-window-excursion
+ (setq inbox-pos (org-feed-goto-inbox-internal file headline))
+ (setq old-status (org-feed-read-previous-status inbox-pos drawer))
+ ;; Add the "handled" status to the appropriate entries
+ (setq entries (mapcar (lambda (e)
+ (setq e (plist-put e :handled
+ (nth 1 (assoc
+ (plist-get e :guid)
+ old-status)))))
+ entries))
+ ;; Find out which entries are new and which are changed
+ (dolist (e entries)
+ (if (not (plist-get e :handled))
+ (push e new)
+ (setq olds (nth 2 (assoc (plist-get e :guid) old-status)))
+ (if (and olds
+ (not (string= (sha1
+ (plist-get e :item-full-text))
+ olds)))
+ (push e changed))))
+
+ ;; Parse the relevant entries fully
+ (setq new (mapcar parse-entry new)
+ changed (mapcar parse-entry changed))
+
+ ;; Run the filter
+ (when filter
+ (setq new (delq nil (mapcar filter new))
+ changed (delq nil (mapcar filter new))))
+
+ (when (not (or new changed))
+ (message "No new items in feed %s" name)
+ (throw 'exit 0))
+
+ ;; Get alist based on guid, to look up entries
+ (setq guid-alist
+ (append
+ (mapcar (lambda (e) (list (plist-get e :guid) e)) new)
+ (mapcar (lambda (e) (list (plist-get e :guid) e)) changed)))
+
+ ;; Construct the new status
+ (setq status
+ (mapcar
+ (lambda (e)
+ (setq guid (plist-get e :guid))
+ (list guid
+ ;; things count as handled if we handle them now,
+ ;; or if they were handled previously
+ (if (assoc guid guid-alist) t (plist-get e :handled))
+ ;; A hash, to detect changes
+ (sha1 (plist-get e :item-full-text))))
+ entries))
+
+ ;; Handle new items in the feed
+ (when new
+ (if new-handler
+ (progn
+ (goto-char inbox-pos)
+ (funcall new-handler new))
+ ;; No custom handler, do the default adding
+ ;; Format the new entries into an alist with GUIDs in the car
+ (setq new-formatted
+ (mapcar
+ (lambda (e) (org-feed-format-entry e template formatter))
+ new)))
+
+ ;; Insert the new items
+ (org-feed-add-items inbox-pos new-formatted))
+
+ ;; Handle changed items in the feed
+ (when (and changed-handler changed)
+ (goto-char inbox-pos)
+ (funcall changed-handler changed))
+
+ ;; Write the new status
+ ;; We do this only now, in case something goes wrong above, so
+ ;; that would would end up with a status that does not reflect
+ ;; which items truely have been handled
+ (org-feed-write-status inbox-pos drawer status)
+
+ ;; Normalize the visibility of the inbox tree
+ (goto-char inbox-pos)
+ (hide-subtree)
+ (show-children)
+ (org-cycle-hide-drawers 'children)
+
+ ;; Hooks and messages
+ (when org-feed-save-after-adding (save-buffer))
+ (message "Added %d new item%s from feed %s to file %s, heading %s"
+ (length new) (if (> (length new) 1) "s" "")
+ name
+ (file-name-nondirectory file) headline)
+ (run-hooks 'org-feed-after-adding-hook)
+ (length new))))))
+
+;;;###autoload
+(defun org-feed-goto-inbox (feed)
+ "Go to the inbox that captures the feed named FEED."
+ (interactive
+ (list (if (= (length org-feed-alist) 1)
+ (car org-feed-alist)
+ (org-completing-read "Feed name: " org-feed-alist))))
+ (if (stringp feed) (setq feed (assoc feed org-feed-alist)))
+ (unless feed
+ (error "No such feed in `org-feed-alist"))
+ (org-feed-goto-inbox-internal (nth 2 feed) (nth 3 feed)))
+
+;;;###autoload
+(defun org-feed-show-raw-feed (feed)
+ "Show the raw feed buffer of a feed."
+ (interactive
+ (list (if (= (length org-feed-alist) 1)
+ (car org-feed-alist)
+ (org-completing-read "Feed name: " org-feed-alist))))
+ (if (stringp feed) (setq feed (assoc feed org-feed-alist)))
+ (unless feed
+ (error "No such feed in `org-feed-alist"))
+ (switch-to-buffer
+ (org-feed-update feed 'retrieve-only))
+ (goto-char (point-min)))
+
+(defun org-feed-goto-inbox-internal (file heading)
+ "Find or create HEADING in FILE.
+Switch to that buffer, and return the position of that headline."
+ (find-file file)
+ (widen)
+ (goto-char (point-min))
+ (if (re-search-forward
+ (concat "^\\*+[ \t]+" heading "[ \t]*\\(:.*?:[ \t]*\\)?$")
+ nil t)
+ (goto-char (match-beginning 0))
+ (goto-char (point-max))
+ (insert "\n\n* " heading "\n\n")
+ (org-back-to-heading t))
+ (point))
+
+(defun org-feed-read-previous-status (pos drawer)
+ "Get the alist of old GUIDs from the entry at POS.
+This will find DRAWER and extract the alist."
+ (save-excursion
+ (goto-char pos)
+ (let ((end (save-excursion (org-end-of-subtree t t))))
+ (if (re-search-forward
+ (concat "^[ \t]*:" drawer ":[ \t]*\n\\([^\000]*?\\)\n[ \t]*:END:")
+ end t)
+ (read (match-string 1))
+ nil))))
+
+(defun org-feed-write-status (pos drawer status)
+ "Write the feed STATUS to DRAWER in entry at POS."
+ (save-excursion
+ (goto-char pos)
+ (let ((end (save-excursion (org-end-of-subtree t t)))
+ guid)
+ (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*\n")
+ end t)
+ (progn
+ (goto-char (match-end 0))
+ (delete-region (point)
+ (save-excursion
+ (and (re-search-forward "^[ \t]*:END:" nil t)
+ (match-beginning 0)))))
+ (outline-next-heading)
+ (insert " :" drawer ":\n :END:\n")
+ (beginning-of-line 0))
+ (insert (pp-to-string status)))))
+
+(defun org-feed-add-items (pos entries)
+ "Add the formatted items to the headline as POS."
+ (let (entry level)
+ (save-excursion
+ (goto-char pos)
+ (unless (looking-at org-complex-heading-regexp)
+ (error "Wrong position"))
+ (setq level (org-get-valid-level (length (match-string 1)) 1))
+ (org-end-of-subtree t t)
+ (skip-chars-backward " \t\n")
+ (beginning-of-line 2)
+ (setq pos (point))
+ (while (setq entry (pop entries))
+ (org-paste-subtree level entry 'yank))
+ (org-mark-ring-push pos))))
+
+(defun org-feed-format-entry (entry template formatter)
+ "Format ENTRY so that it can be inserted into an Org file.
+ENTRY is a property list. This function adds a `:formatted-for-org' property
+and returns the full property list.
+If that property is already present, nothing changes."
+ (if formatter
+ (funcall formatter entry)
+ (let (dlines fmt tmp indent time name
+ v-h v-t v-T v-u v-U v-a)
+ (setq dlines (org-split-string (or (plist-get entry :description) "???")
+ "\n")
+ v-h (or (plist-get entry :title) (car dlines) "???")
+ time (or (if (plist-get entry :pubDate)
+ (org-read-date t t (plist-get entry :pubDate)))
+ (current-time))
+ v-t (format-time-string (org-time-stamp-format nil nil) time)
+ v-T (format-time-string (org-time-stamp-format t nil) time)
+ v-u (format-time-string (org-time-stamp-format nil t) time)
+ v-U (format-time-string (org-time-stamp-format t t) time)
+ v-a (if (setq tmp (or (and (plist-get entry :guid-permalink)
+ (plist-get entry :guid))
+ (plist-get entry :link)))
+ (concat "[[" tmp "]]\n")
+ ""))
+ (with-temp-buffer
+ (insert template)
+ (goto-char (point-min))
+ (while (re-search-forward "%\\([a-zA-Z]+\\)" nil t)
+ (setq name (match-string 1))
+ (cond
+ ((member name '("h" "t" "T" "u" "U" "a"))
+ (replace-match (symbol-value (intern (concat "v-" name))) t t))
+ ((setq tmp (plist-get entry (intern (concat ":" name))))
+ (save-excursion
+ (save-match-data
+ (beginning-of-line 1)
+ (when (looking-at (concat "^\\([ \t]*\\)%" name "[ \t]*$"))
+ (setq tmp (org-feed-make-indented-block
+ tmp (org-get-indentation))))))
+ (replace-match tmp t t))))
+ (buffer-string)))))
+
+(defun org-feed-make-indented-block (s n)
+ "Add indentaton of N spaces to a multiline string S."
+ (if (not (string-match "\n" s))
+ s
+ (mapconcat 'identity
+ (org-split-string s "\n")
+ (concat "\n" (make-string n ?\ )))))
+
+(defun org-feed-skip-http-headers (buffer)
+ "Remove HTTP headers from BUFFER, and return it.
+Assumes headers are indeed present!"
+ (with-current-buffer buffer
+ (widen)
+ (goto-char (point-min))
+ (search-forward "\n\n")
+ (delete-region (point-min) (point))
+ buffer))
+
+(defun org-feed-get-feed (url)
+ "Get the RSS feed file at URL and return the buffer."
+ (cond
+ ((eq org-feed-retrieve-method 'url-retrieve-synchronously)
+ (org-feed-skip-http-headers (url-retrieve-synchronously url)))
+ ((eq org-feed-retrieve-method 'curl)
+ (ignore-errors (kill-buffer org-feed-buffer))
+ (call-process "curl" nil org-feed-buffer nil "--silent" url)
+ org-feed-buffer)
+ ((eq org-feed-retrieve-method 'wget)
+ (ignore-errors (kill-buffer org-feed-buffer))
+ (call-process "wget" nil org-feed-buffer nil "-q" "-O" "-" url)
+ org-feed-buffer)
+ ((functionp org-feed-retrieve-method)
+ (funcall org-feed-retrieve-method url))))
+
+(defun org-feed-parse-rss-feed (buffer)
+ "Parse BUFFER for RSS feed entries.
+Returns a list of entries, with each entry a property list,
+containing the properties `:guid' and `:item-full-text'."
+ (let (entries beg end item guid entry)
+ (with-current-buffer buffer
+ (widen)
+ (goto-char (point-min))
+ (while (re-search-forward "<item>" nil t)
+ (setq beg (point)
+ end (and (re-search-forward "</item>" nil t)
+ (match-beginning 0)))
+ (setq item (buffer-substring beg end)
+ guid (if (string-match "<guid\\>.*?>\\(.*?\\)</guid>" item)
+ (org-match-string-no-properties 1 item)))
+ (setq entry (list :guid guid :item-full-text item))
+ (push entry entries)
+ (widen)
+ (goto-char end))
+ (nreverse entries))))
+
+(defun org-feed-parse-rss-entry (entry)
+ "Parse the `:item-full-text' field for xml tags and create new properties."
+ (with-temp-buffer
+ (insert (plist-get entry :item-full-text))
+ (goto-char (point-min))
+ (while (re-search-forward "<\\([a-zA-Z]+\\>\\).*?>\\([^\000]*?\\)</\\1>"
+ nil t)
+ (setq entry (plist-put entry
+ (intern (concat ":" (match-string 1)))
+ (match-string 2))))
+ (goto-char (point-min))
+ (unless (re-search-forward "isPermaLink[ \t]*=[ \t]*\"false\"" nil t)
+ (setq entry (plist-put entry :guid-permalink t))))
+ entry)
+
+(defun org-feed-parse-atom-feed (buffer)
+ "Parse BUFFER for Atom feed entries.
+Returns a list of enttries, with each entry a property list,
+containing the properties `:guid' and `:item-full-text'.
+
+The `:item-full-text' property actually contains the sexp
+formatted as a string, not the original XML data."
+ (with-current-buffer buffer
+ (widen)
+ (let ((feed (car (xml-parse-region (point-min) (point-max)))))
+ (mapcar
+ (lambda (entry)
+ (list
+ :guid (car (xml-node-children (car (xml-get-children entry 'id))))
+ :item-full-text (prin1-to-string entry)))
+ (xml-get-children feed 'entry)))))
+
+(defun org-feed-parse-atom-entry (entry)
+ "Parse the `:item-full-text' as a sexp and create new properties."
+ (let ((xml (car (read-from-string (plist-get entry :item-full-text)))))
+ ;; Get first <link href='foo'/>.
+ (setq entry (plist-put entry :link
+ (xml-get-attribute
+ (car (xml-get-children xml 'link))
+ 'href)))
+ ;; Add <title/> as :title.
+ (setq entry (plist-put entry :title
+ (car (xml-node-children
+ (car (xml-get-children xml 'title))))))
+ (let* ((content (car (xml-get-children xml 'content)))
+ (type (xml-get-attribute-or-nil content 'type)))
+ (when content
+ (cond
+ ((string= type "text")
+ ;; We like plain text.
+ (setq entry (plist-put entry :description (car (xml-node-children content)))))
+ ((string= type "html")
+ ;; TODO: convert HTML to Org markup.
+ (setq entry (plist-put entry :description (car (xml-node-children content)))))
+ ((string= type "xhtml")
+ ;; TODO: convert XHTML to Org markup.
+ (setq entry (plist-put entry :description (prin1-to-string (xml-node-children content)))))
+ (t
+ (setq entry (plist-put entry :description (format "Unknown '%s' content." type)))))))
+ entry))
+
+(provide 'org-feed)
+
+;; arch-tag: 0929b557-9bc4-47f4-9633-30a12dbb5ae2
+
+;;; org-feed.el ends here
+
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(declare-function org-show-context "org" (&optional key))
(declare-function org-back-to-heading "org" (&optional invisible-ok))
(declare-function org-end-of-subtree "org" (&optional invisible-ok to-heading))
+(defvar org-odd-levels-only) ;; defined in org.el
(defconst org-footnote-re
(concat "[^][\n]" ; to make sure it is not at the beginning of a line
"\\]")
"Regular expression for matching footnotes.")
-(defconst org-footnote-definition-re
+(defconst org-footnote-definition-re
(org-re "^\\(\\[\\([0-9]+\\|fn:[-_[:word:]]+\\)\\]\\)")
"Regular expression matching the definition of a footnote.")
(const :tag "Offer automatic [fn:N] for editing" confirm)
(const :tag "Create automatic [N]" plain)))
+(defcustom org-footnote-auto-adjust nil
+ "Non-nil means, automatically adjust footnotes after insert/delete.
+When this is t, after each insertion or deletion of a footnote,
+simple fn:N footnotes will be renumbered, and all footnotes will be sorted.
+If you want to have just sorting or just renumbering, set this variable
+to `sort' or `renumber'.
+
+The main values of this variable can be set with in-buffer options:
+
+#+STARTUP: fnadjust
+#+STARTUP: nofnadjust"
+ :group 'org-footnote
+ :type '(choice
+ (const :tag "Renumber" renumber)
+ (const :tag "Sort" sort)
+ (const :tag "Renumber and Sort" t)))
+
(defcustom org-footnote-fill-after-inline-note-extraction nil
"Non-nil means, fill paragraphs after extracting footnotes.
When extracting inline footnotes, the lengths of lines can change a lot.
(message "New reference to existing note"))
(org-footnote-define-inline
(insert "[" label ": ]")
- (backward-char 1))
+ (backward-char 1)
+ (org-footnote-auto-adjust-maybe))
(t
(insert "[" label "]")
- (org-footnote-create-definition label)))))
+ (org-footnote-create-definition label)
+ (org-footnote-auto-adjust-maybe)))))
(defun org-footnote-create-definition (label)
"Start the definition of a footnote with label LABEL."
(let (tmp c)
(cond
(special
- (message "Footnotes: [s]ort | convert to [n]umeric | [d]elete")
+ (message "Footnotes: [s]ort | [r]enumber fn:N | [S]=r+s |->[n]umeric | [d]elete")
(setq c (read-char-exclusive))
(cond
((equal c ?s)
(org-footnote-normalize 'sort))
+ ((equal c ?r)
+ (org-footnote-renumber-fn:N))
+ ((equal c ?S)
+ (org-footnote-renumber-fn:N)
+ (org-footnote-normalize 'sort))
((equal c ?n)
(org-footnote-normalize))
((equal c ?d)
;;;###autoload
(defun org-footnote-normalize (&optional sort-only for-preprocessor)
"Collect the footnotes in various formats and normalize them.
-This find the different sorts of footnotes allowed in Org, and
+This finds the different sorts of footnotes allowed in Org, and
normalizes them to the usual [N] format that is understood by the
Org-mode exporters.
When SORT-ONLY is set, only sort the footnote definitions into the
referenced sequence."
;; This is based on Paul's function, but rewritten.
- (let ((count 0) ref def idef ref-table beg beg1 marker a before
- ins-point)
+ (let* ((limit-level
+ (and (boundp 'org-inlinetask-min-level)
+ org-inlinetask-min-level
+ (1- org-inlinetask-min-level)))
+ (nstars (and limit-level
+ (if org-odd-levels-only
+ (and limit-level (1- (* limit-level 2)))
+ limit-level)))
+ (outline-regexp
+ (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))
+ (count 0)
+ ref def idef ref-table beg beg1 marker a before ins-point)
(save-excursion
;; Now find footnote references, and extract the definitions
(goto-char (point-min))
(and idef
org-footnote-fill-after-inline-note-extraction
(fill-paragraph)))
- (if (not a) (push (list ref marker def) ref-table))))
-
+ (if (not a) (push (list ref marker def (if idef t nil)) ref-table))))
+
;; First find and remove the footnote section
(goto-char (point-min))
(cond
(insert "* " org-footnote-section "\n")
(setq ins-point (point))))))
(t
- (if (re-search-forward
+ (if (re-search-forward
(concat "^"
(regexp-quote org-footnote-tag-for-non-org-mode-files)
"[ \t]*$")
(delete-region (point) (point-max))
(insert "\n\n" org-footnote-tag-for-non-org-mode-files "\n")
(setq ins-point (point))))
-
+
;; Insert the footnotes again
(goto-char (or ins-point (point-max)))
(setq ref-table (reverse ref-table))
(when sort-only
- ;; remove anonymous fotnotes from the list
+ ;; remove anonymous and inline footnotes from the list
(setq ref-table
(delq nil (mapcar
(lambda (x) (and (car x)
(not (equal (car x) "fn:"))
+ (not (nth 3 x))
x))
ref-table))))
;; Make sure each footnote has a description, or an error message.
(defun org-footnote-goto-local-insertion-point ()
"Find insertion point for footnote, just before next outline heading."
- (outline-next-heading)
+ (org-with-limited-levels (outline-next-heading))
(or (bolp) (newline))
(beginning-of-line 0)
(while (and (not (bobp)) (= (char-after) ?#))
(beginning-of-line 0))
- (if (looking-at "#\\+TBLFM:") (beginning-of-line 2))
+ (if (looking-at "[ \t]*#\\+TBLFM:") (beginning-of-line 2))
(end-of-line 1)
(skip-chars-backward "\n\r\t "))
(goto-char (point-max)))
(delete-region beg (point))
(incf ndef))))
+ (org-footnote-auto-adjust-maybe)
(message "%d definition(s) of and %d reference(s) of footnote %s removed"
ndef nref label))))
+(defun org-footnote-renumber-fn:N ()
+ "Renumber the simple footnotes like fn:17 into a sequence in the document."
+ (interactive)
+ (let (map i (n 0))
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char (point-min))
+ (while (re-search-forward "\\[fn:\\([0-9]+\\)[]:]" nil t)
+ (setq i (string-to-number (match-string 1)))
+ (when (and (string-match "\\S-" (buffer-substring
+ (point-at-bol) (match-beginning 0)))
+ (not (assq i map)))
+ (push (cons i (number-to-string (incf n))) map)))
+ (goto-char (point-min))
+ (while (re-search-forward "\\(\\[fn:\\)\\([0-9]+\\)\\([]:]\\)" nil t)
+ (replace-match (concat "\\1" (cdr (assq (string-to-number (match-string 2)) map)) "\\3")))))))
+
+(defun org-footnote-auto-adjust-maybe ()
+ "Renumber and/or sort footnotes according to user settings."
+ (when (memq org-footnote-auto-adjust '(t renumber))
+ (org-footnote-renumber-fn:N))
+ (when (memq org-footnote-auto-adjust '(t sort))
+ (let ((label (nth 1 (org-footnote-at-definition-p))))
+ (org-footnote-normalize 'sort)
+ (when label
+ (goto-char (point-min))
+ (and (re-search-forward (concat "^\\[" (regexp-quote label) "\\]")
+ nil t)
+ (progn (insert " ")
+ (just-one-space)))))))
+
(provide 'org-footnote)
;; arch-tag: 1b5954df-fb5d-4da5-8709-78d944dbfc37
;; Tassilo Horn <tassilo at member dot fsf dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;; Declare external functions and variables
(declare-function gnus-article-show-summary "gnus-art" ())
(declare-function gnus-summary-last-subject "gnus-sum" ())
+(declare-function message-fetch-field "message" (header &optional not-all))
+(declare-function message-narrow-to-head-1 "message" nil)
+
(defvar gnus-other-frame-object)
(defvar gnus-group-name)
(defvar gnus-article-current)
(header (with-current-buffer gnus-article-buffer
(gnus-summary-toggle-header 1)
(goto-char (point-min))
+ ;; mbox files may contain a first line starting with
+ ;; "From" followed by a space, which cannot be parsed as
+ ;; header line, so we skip it.
+ (when (looking-at "From ")
+ (beginning-of-line 2))
(mail-header-extract-no-properties)))
(from (mail-header 'from header))
(message-id (org-remove-angle-brackets
(newsgroups (mail-header 'newsgroups header))
(x-no-archive (mail-header 'x-no-archive header))
(subject (if (eq major-mode 'gnus-article-mode)
- (message-fetch-field "subject")
+ (save-restriction
+ (require 'message)
+ (message-narrow-to-head-1)
+ (message-fetch-field "subject"))
(gnus-summary-subject-string)))
desc link)
(org-store-link-props :type "gnus" :from from :subject subject
--- /dev/null
+;;; org-html.el --- HTML export for Org-mode
+
+;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
+;; Free Software Foundation, Inc.
+
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+
+(require 'org-exp)
+
+(declare-function org-id-find-id-file "org-id" (id))
+(declare-function htmlize-region "ext:htmlize" (beg end))
+
+(defgroup org-export-html nil
+ "Options specific for HTML export of Org-mode files."
+ :tag "Org Export HTML"
+ :group 'org-export)
+
+(defcustom org-export-html-footnotes-section "<div id=\"footnotes\">
+<h2 class=\"footnotes\">%s: </h2>
+<div id=\"text-footnotes\">
+%s
+</div>
+</div>"
+ "Format for the footnotes section.
+Should contain a two instances of %s. The first will be replaced with the
+language-specific word for \"Footnotes\", the second one will be replaced
+by the footnotes themselves."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-footnote-format "<sup>%s</sup>"
+ "The format for the footnote reference.
+%s will be replaced by the footnote reference itself."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-coding-system nil
+ "Coding system for HTML export, defaults to buffer-file-coding-system."
+ :group 'org-export-html
+ :type 'coding-system)
+
+(defcustom org-export-html-extension "html"
+ "The extension for exported HTML files."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-xml-declaration
+ '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
+ ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
+ "The extension for exported HTML files.
+%s will be replaced with the charset of the exported file.
+This may be a string, or an alist with export extensions
+and corresponding declarations."
+ :group 'org-export-html
+ :type '(choice
+ (string :tag "Single declaration")
+ (repeat :tag "Dependent on extension"
+ (cons (string :tag "Extension")
+ (string :tag "Declaration")))))
+
+(defcustom org-export-html-style-include-scripts t
+ "Non-nil means, include the javascript snippets in exported HTML files.
+The actual script is defined in `org-export-html-scripts' and should
+not be modified."
+ :group 'org-export-html
+ :type 'boolean)
+
+(defconst org-export-html-scripts
+"<script type=\"text/javascript\">
+<!--/*--><![CDATA[/*><!--*/
+ function CodeHighlightOn(elem, id)
+ {
+ var target = document.getElementById(id);
+ if(null != target) {
+ elem.cacheClassElem = elem.className;
+ elem.cacheClassTarget = target.className;
+ target.className = \"code-highlighted\";
+ elem.className = \"code-highlighted\";
+ }
+ }
+ function CodeHighlightOff(elem, id)
+ {
+ var target = document.getElementById(id);
+ if(elem.cacheClassElem)
+ elem.className = elem.cacheClassElem;
+ if(elem.cacheClassTarget)
+ target.className = elem.cacheClassTarget;
+ }
+/*]]>*///-->
+</script>"
+"Basic javascript that is needed by HTML files produced by Org-mode.")
+
+(defconst org-export-html-style-default
+"<style type=\"text/css\">
+ <!--/*--><![CDATA[/*><!--*/
+ html { font-family: Times, serif; font-size: 12pt; }
+ .title { text-align: center; }
+ .todo { color: red; }
+ .done { color: green; }
+ .tag { background-color: #add8e6; font-weight:normal }
+ .target { }
+ .timestamp { color: #bebebe; }
+ .timestamp-kwd { color: #5f9ea0; }
+ p.verse { margin-left: 3% }
+ pre {
+ border: 1pt solid #AEBDCC;
+ background-color: #F3F5F7;
+ padding: 5pt;
+ font-family: courier, monospace;
+ font-size: 90%;
+ overflow:auto;
+ }
+ table { border-collapse: collapse; }
+ td, th { vertical-align: top; }
+ dt { font-weight: bold; }
+ div.figure { padding: 0.5em; }
+ div.figure p { text-align: center; }
+ .linenr { font-size:smaller }
+ .code-highlighted {background-color:#ffff00;}
+ .org-info-js_info-navigation { border-style:none; }
+ #org-info-js_console-label { font-size:10px; font-weight:bold;
+ white-space:nowrap; }
+ .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
+ font-weight:bold; }
+ /*]]>*/-->
+</style>"
+ "The default style specification for exported HTML files.
+Please use the variables `org-export-html-style' and
+`org-export-html-style-extra' to add to this style. If you wish to not
+have the default style included, customize the variable
+`org-export-html-style-include-default'.")
+
+(defcustom org-export-html-style-include-default t
+ "Non-nil means, include the default style in exported HTML files.
+The actual style is defined in `org-export-html-style-default' and should
+not be modified. Use the variables `org-export-html-style' to add
+your own style information."
+ :group 'org-export-html
+ :type 'boolean)
+;;;###autoload
+(put 'org-export-html-style 'safe-local-variable 'booleanp)
+
+(defcustom org-export-html-style ""
+ "Org-wide style definitions for exported HTML files.
+
+This variable needs to contain the full HTML structure to provide a style,
+including the surrounding HTML tags. If you set the value of this variable,
+you should consider to include definitions for the following classes:
+ title, todo, done, timestamp, timestamp-kwd, tag, target.
+
+For example, a valid value would be:
+
+ <style type=\"text/css\">
+ <![CDATA[
+ p { font-weight: normal; color: gray; }
+ h1 { color: black; }
+ .title { text-align: center; }
+ .todo, .timestamp-kwd { color: red; }
+ .done { color: green; }
+ ]]>
+ </style>
+
+If you'd like to refer to en external style file, use something like
+
+ <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
+
+As the value of this option simply gets inserted into the HTML <head> header,
+you can \"misuse\" it to add arbitrary text to the header.
+See also the variable `org-export-html-style-extra'."
+ :group 'org-export-html
+ :type 'string)
+;;;###autoload
+(put 'org-export-html-style 'safe-local-variable 'stringp)
+
+(defcustom org-export-html-style-extra ""
+ "Additional style information for HTML export.
+The value of this variable is inserted into the HTML buffer right after
+the value of `org-export-html-style'. Use this variable for per-file
+settings of style information, and do not forget to surround the style
+settings with <style>...</style> tags."
+ :group 'org-export-html
+ :type 'string)
+;;;###autoload
+(put 'org-export-html-style-extra 'safe-local-variable 'stringp)
+
+(defcustom org-export-html-tag-class-prefix ""
+ "Prefix to clas names for TODO keywords.
+Each tag gets a class given by the tag itself, with this prefix.
+The default prefix is empty because it is nice to just use the keyword
+as a class name. But if you get into conflicts with other, existing
+CSS classes, then this prefic can be very useful."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-todo-kwd-class-prefix ""
+ "Prefix to clas names for TODO keywords.
+Each TODO keyword gets a class given by the keyword itself, with this prefix.
+The default prefix is empty because it is nice to just use the keyword
+as a class name. But if you get into conflicts with other, existing
+CSS classes, then this prefic can be very useful."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-title-format "<h1 class=\"title\">%s</h1>\n"
+ "Format for typesetting the document title in HTML export."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-home/up-format
+ "<div style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
+ <a accesskey=\"h\" href=\"%s\"> UP </a>
+ |
+ <a accesskey=\"H\" href=\"%s\"> HOME </a>
+</div>"
+ "Snippet used to insert the HOME and UP links. This is a format,
+the first %s will receive the UP link, the second the HOME link.
+If both `org-export-html-link-up' and `org-export-html-link-home' are
+empty, the entire snippet will be ignored."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-toplevel-hlevel 2
+ "The <H> level for level 1 headings in HTML export.
+This is also important for the classes that will be wrapped around headlines
+and outline structure. If this variable is 1, the top-level headlines will
+be <h1>, and the corresponding classes will be outline-1, section-number-1,
+and outline-text-1. If this is 2, all of these will get a 2 instead.
+The default for this variable is 2, because we use <h1> for formatting the
+document title."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-html-link-org-files-as-html t
+ "Non-nil means, make file links to `file.org' point to `file.html'.
+When org-mode is exporting an org-mode file to HTML, links to
+non-html files are directly put into a href tag in HTML.
+However, links to other Org-mode files (recognized by the
+extension `.org.) should become links to the corresponding html
+file, assuming that the linked org-mode file will also be
+converted to HTML.
+When nil, the links still point to the plain `.org' file."
+ :group 'org-export-html
+ :type 'boolean)
+
+(defcustom org-export-html-inline-images 'maybe
+ "Non-nil means, inline images into exported HTML pages.
+This is done using an <img> tag. When nil, an anchor with href is used to
+link to the image. If this option is `maybe', then images in links with
+an empty description will be inlined, while images with a description will
+be linked only."
+ :group 'org-export-html
+ :type '(choice (const :tag "Never" nil)
+ (const :tag "Always" t)
+ (const :tag "When there is no description" maybe)))
+
+(defcustom org-export-html-inline-image-extensions
+ '("png" "jpeg" "jpg" "gif")
+ "Extensions of image files that can be inlined into HTML."
+ :group 'org-export-html
+ :type '(repeat (string :tag "Extension")))
+
+(defcustom org-export-html-table-tag
+ "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
+ "The HTML tag that is used to start a table.
+This must be a <table> tag, but you may change the options like
+borders and spacing."
+ :group 'org-export-html
+ :type 'string)
+
+(defcustom org-export-table-header-tags '("<th scope=\"%s\">" . "</th>")
+ "The opening tag for table header fields.
+This is customizable so that alignment options can be specified.
+%s will be filled with the scope of the field, either row or col.
+See also the variable `org-export-html-table-use-header-tags-for-first-column'."
+ :group 'org-export-tables
+ :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
+
+(defcustom org-export-table-data-tags '("<td>" . "</td>")
+ "The opening tag for table data fields.
+This is customizable so that alignment options can be specified."
+ :group 'org-export-tables
+ :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
+
+(defcustom org-export-table-row-tags '("<tr>" . "</tr>")
+ "The opening tag for table data fields.
+This is customizable so that alignment options can be specified.
+Instead of strings, these can be Lisp forms that will be evaluated
+for each row in order to construct the table row tags. During evaluation,
+the variable `head' will be true when this is a header line, nil when this
+is a body line. And the variable `nline' will contain the line number,
+starting from 1 in the first header line. For example
+
+ (setq org-export-table-row-tags
+ (cons '(if head
+ \"<tr>\"
+ (if (= (mod nline 2) 1)
+ \"<tr class=\\\"tr-odd\\\">\"
+ \"<tr class=\\\"tr-even\\\">\"))
+ \"</tr>\"))
+
+will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
+ :group 'org-export-tables
+ :type '(cons
+ (choice :tag "Opening tag"
+ (string :tag "Specify")
+ (sexp))
+ (choice :tag "Closing tag"
+ (string :tag "Specify")
+ (sexp))))
+
+
+
+(defcustom org-export-html-table-use-header-tags-for-first-column nil
+ "Non-nil means, format column one in tables with header tags.
+When nil, also column one will use data tags."
+ :group 'org-export-tables
+ :type 'boolean)
+
+(defcustom org-export-html-validation-link nil
+ "Non-nil means, add validationlink to postamble of HTML exported files."
+ :group 'org-export-html
+ :type '(choice
+ (const :tag "Nothing" nil)
+ (const :tag "XHTML 1.0" "<p class=\"xhtml-validation\"><a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a></p>")
+ (string :tag "Specify full HTML")))
+
+
+(defcustom org-export-html-with-timestamp nil
+ "If non-nil, write `org-export-html-html-helper-timestamp'
+into the exported HTML text. Otherwise, the buffer will just be saved
+to a file."
+ :group 'org-export-html
+ :type 'boolean)
+
+(defcustom org-export-html-html-helper-timestamp
+ "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
+ "The HTML tag used as timestamp delimiter for HTML-helper-mode."
+ :group 'org-export-html
+ :type 'string)
+
+(defgroup org-export-htmlize nil
+ "Options for processing examples with htmlize.el."
+ :tag "Org Export Htmlize"
+ :group 'org-export-html)
+
+(defcustom org-export-htmlize-output-type 'inline-css
+ "Output type to be used by htmlize when formatting code snippets.
+We use as default `inline-css', in order to make the resulting
+HTML self-containing.
+However, this will fail when using Emacs in batch mode for export, because
+then no rich font definitions are in place. It will also not be good if
+people with different Emacs setup contribute HTML files to a website,
+because the fonts will represent the individual setups. In these cases,
+it is much better to let Org/Htmlize assign classes only, and to use
+a style file to define the look of these classes.
+To get a start for your css file, start Emacs session and make sure that
+all the faces you are interested in are defined, for example by loading files
+in all modes you want. Then, use the command
+\\[org-export-htmlize-generate-css] to extract class definitions."
+ :group 'org-export-htmlize
+ :type '(choice (const css) (const inline-css)))
+
+(defcustom org-export-htmlize-css-font-prefix "org-"
+ "The prefix for CSS class names for htmlize font specifications."
+ :group 'org-export-htmlize
+ :type 'string)
+
+(defcustom org-export-htmlized-org-css-url nil
+ "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
+Normally when creating an htmlized version of an Org buffer, htmlize will
+create CSS to define the font colors. However, this does not work when
+converting in batch mode, and it also can look bad if different people
+with different fontification setup work on the same website.
+When this variable is non-nil, creating an htmlized version of an Org buffer
+using `org-export-as-org' will remove the internal CSS section and replace it
+with a link to this URL."
+ :group 'org-export-htmlize
+ :type '(choice
+ (const :tag "Keep internal css" nil)
+ (string :tag "URL or local href")))
+
+;;; Variables, constants, and parameter plists
+
+(defvar org-export-html-preamble nil
+ "Preamble, to be inserted just before <body>. Set by publishing functions.
+This may also be a function, building and inserting the preamble.")
+(defvar org-export-html-postamble nil
+ "Preamble, to be inserted just after </body>. Set by publishing functions.
+This may also be a function, building and inserting the postamble.")
+(defvar org-export-html-auto-preamble t
+ "Should default preamble be inserted? Set by publishing functions.")
+(defvar org-export-html-auto-postamble t
+ "Should default postamble be inserted? Set by publishing functions.")
+
+;;; Hooks
+
+(defvar org-export-html-after-blockquotes-hook nil
+ "Hook run during HTML export, after blockquote, verse, center are done.")
+
+;;; HTML export
+
+(defun org-export-html-preprocess (parameters)
+ ;; Convert LaTeX fragments to images
+ (when (and org-current-export-file
+ (plist-get parameters :LaTeX-fragments))
+ (org-format-latex
+ (concat "ltxpng/" (file-name-sans-extension
+ (file-name-nondirectory
+ org-current-export-file)))
+ org-current-export-dir nil "Creating LaTeX image %s"))
+ (message "Exporting..."))
+
+;;;###autoload
+(defun org-export-as-html-and-open (arg)
+ "Export the outline as HTML and immediately open it with a browser.
+If there is an active region, export only the region.
+The prefix ARG specifies how many levels of the outline should become
+headlines. The default is 3. Lower levels will become bulleted lists."
+ (interactive "P")
+ (org-export-as-html arg 'hidden)
+ (org-open-file buffer-file-name))
+
+;;;###autoload
+(defun org-export-as-html-batch ()
+ "Call `org-export-as-html', may be used in batch processing as
+emacs --batch
+ --load=$HOME/lib/emacs/org.el
+ --eval \"(setq org-export-headline-levels 2)\"
+ --visit=MyFile --funcall org-export-as-html-batch"
+ (org-export-as-html org-export-headline-levels 'hidden))
+
+;;;###autoload
+(defun org-export-as-html-to-buffer (arg)
+ "Call `org-export-as-html` with output to a temporary buffer.
+No file is created. The prefix ARG is passed through to `org-export-as-html'."
+ (interactive "P")
+ (org-export-as-html arg nil nil "*Org HTML Export*")
+ (when org-export-show-temporary-export-buffer
+ (switch-to-buffer-other-window "*Org HTML Export*")))
+
+;;;###autoload
+(defun org-replace-region-by-html (beg end)
+ "Assume the current region has org-mode syntax, and convert it to HTML.
+This can be used in any buffer. For example, you could write an
+itemized list in org-mode syntax in an HTML buffer and then use this
+command to convert it."
+ (interactive "r")
+ (let (reg html buf pop-up-frames)
+ (save-window-excursion
+ (if (org-mode-p)
+ (setq html (org-export-region-as-html
+ beg end t 'string))
+ (setq reg (buffer-substring beg end)
+ buf (get-buffer-create "*Org tmp*"))
+ (with-current-buffer buf
+ (erase-buffer)
+ (insert reg)
+ (org-mode)
+ (setq html (org-export-region-as-html
+ (point-min) (point-max) t 'string)))
+ (kill-buffer buf)))
+ (delete-region beg end)
+ (insert html)))
+
+;;;###autoload
+(defun org-export-region-as-html (beg end &optional body-only buffer)
+ "Convert region from BEG to END in org-mode buffer to HTML.
+If prefix arg BODY-ONLY is set, omit file header, footer, and table of
+contents, and only produce the region of converted text, useful for
+cut-and-paste operations.
+If BUFFER is a buffer or a string, use/create that buffer as a target
+of the converted HTML. If BUFFER is the symbol `string', return the
+produced HTML as a string and leave not buffer behind. For example,
+a Lisp program could call this function in the following way:
+
+ (setq html (org-export-region-as-html beg end t 'string))
+
+When called interactively, the output buffer is selected, and shown
+in a window. A non-interactive call will only return the buffer."
+ (interactive "r\nP")
+ (when (interactive-p)
+ (setq buffer "*Org HTML Export*"))
+ (let ((transient-mark-mode t) (zmacs-regions t)
+ ext-plist rtn)
+ (setq ext-plist (plist-put ext-plist :ignore-subree-p t))
+ (goto-char end)
+ (set-mark (point)) ;; to activate the region
+ (goto-char beg)
+ (setq rtn (org-export-as-html
+ nil nil ext-plist
+ buffer body-only))
+ (if (fboundp 'deactivate-mark) (deactivate-mark))
+ (if (and (interactive-p) (bufferp rtn))
+ (switch-to-buffer-other-window rtn)
+ rtn)))
+
+(defvar html-table-tag nil) ; dynamically scoped into this.
+(defvar org-par-open nil)
+;;;###autoload
+(defun org-export-as-html (arg &optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Export the outline as a pretty HTML file.
+If there is an active region, export only the region. The prefix
+ARG specifies how many levels of the outline should become
+headlines. The default is 3. Lower levels will become bulleted
+lists. HIDDEN is obsolete and does nothing.
+EXT-PLIST is a property list with external parameters overriding
+org-mode's default settings, but still inferior to file-local
+settings. When TO-BUFFER is non-nil, create a buffer with that
+name and export to that buffer. If TO-BUFFER is the symbol
+`string', don't leave any buffer behind but just return the
+resulting HTML as a string. When BODY-ONLY is set, don't produce
+the file header and footer, simply return the content of
+<body>...</body>, without even the body tags themselves. When
+PUB-DIR is set, use this as the publishing directory."
+ (interactive "P")
+
+ ;; Make sure we have a file name when we need it.
+ (when (and (not (or to-buffer body-only))
+ (not buffer-file-name))
+ (if (buffer-base-buffer)
+ (org-set-local 'buffer-file-name
+ (with-current-buffer (buffer-base-buffer)
+ buffer-file-name))
+ (error "Need a file name to be able to export.")))
+
+ (message "Exporting...")
+ (setq-default org-todo-line-regexp org-todo-line-regexp)
+ (setq-default org-deadline-line-regexp org-deadline-line-regexp)
+ (setq-default org-done-keywords org-done-keywords)
+ (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
+ (let* ((opt-plist
+ (org-export-process-option-filters
+ (org-combine-plists (org-default-export-plist)
+ ext-plist
+ (org-infile-export-plist))))
+ (body-only (or body-only (plist-get opt-plist :body-only)))
+ (style (concat (if (plist-get opt-plist :style-include-default)
+ org-export-html-style-default)
+ (plist-get opt-plist :style)
+ (plist-get opt-plist :style-extra)
+ "\n"
+ (if (plist-get opt-plist :style-include-scripts)
+ org-export-html-scripts)))
+ (html-extension (plist-get opt-plist :html-extension))
+ (link-validate (plist-get opt-plist :link-validation-function))
+ valid thetoc have-headings first-heading-pos
+ (odd org-odd-levels-only)
+ (region-p (org-region-active-p))
+ (rbeg (and region-p (region-beginning)))
+ (rend (and region-p (region-end)))
+ (subtree-p
+ (if (plist-get opt-plist :ignore-subree-p)
+ nil
+ (when region-p
+ (save-excursion
+ (goto-char rbeg)
+ (and (org-at-heading-p)
+ (>= (org-end-of-subtree t t) rend))))))
+ (level-offset (if subtree-p
+ (save-excursion
+ (goto-char rbeg)
+ (+ (funcall outline-level)
+ (if org-odd-levels-only 1 0)))
+ 0))
+ (opt-plist (setq org-export-opt-plist
+ (if subtree-p
+ (org-export-add-subtree-options opt-plist rbeg)
+ opt-plist)))
+ ;; The following two are dynamically scoped into other
+ ;; routines below.
+ (org-current-export-dir
+ (or pub-dir (org-export-directory :html opt-plist)))
+ (org-current-export-file buffer-file-name)
+ (level 0) (line "") (origline "") txt todo
+ (umax nil)
+ (umax-toc nil)
+ (filename (if to-buffer nil
+ (expand-file-name
+ (concat
+ (file-name-sans-extension
+ (or (and subtree-p
+ (org-entry-get (region-beginning)
+ "EXPORT_FILE_NAME" t))
+ (file-name-nondirectory buffer-file-name)))
+ "." html-extension)
+ (file-name-as-directory
+ (or pub-dir (org-export-directory :html opt-plist))))))
+ (current-dir (if buffer-file-name
+ (file-name-directory buffer-file-name)
+ default-directory))
+ (buffer (if to-buffer
+ (cond
+ ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
+ (t (get-buffer-create to-buffer)))
+ (find-file-noselect filename)))
+ (org-levels-open (make-vector org-level-max nil))
+ (date (plist-get opt-plist :date))
+ (author (plist-get opt-plist :author))
+ (title (or (and subtree-p (org-export-get-title-from-subtree))
+ (plist-get opt-plist :title)
+ (and (not
+ (plist-get opt-plist :skip-before-1st-heading))
+ (org-export-grab-title-from-buffer))
+ (and buffer-file-name
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name)))
+ "UNTITLED"))
+ (link-up (and (plist-get opt-plist :link-up)
+ (string-match "\\S-" (plist-get opt-plist :link-up))
+ (plist-get opt-plist :link-up)))
+ (link-home (and (plist-get opt-plist :link-home)
+ (string-match "\\S-" (plist-get opt-plist :link-home))
+ (plist-get opt-plist :link-home)))
+ (dummy (setq opt-plist (plist-put opt-plist :title title)))
+ (html-table-tag (plist-get opt-plist :html-table-tag))
+ (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
+ (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
+ (inquote nil)
+ (infixed nil)
+ (inverse nil)
+ (in-local-list nil)
+ (local-list-type nil)
+ (local-list-indent nil)
+ (llt org-plain-list-ordered-item-terminator)
+ (email (plist-get opt-plist :email))
+ (language (plist-get opt-plist :language))
+ (keywords (plist-get opt-plist :keywords))
+ (description (plist-get opt-plist :description))
+ (lang-words nil)
+ (head-count 0) cnt
+ (start 0)
+ (coding-system (and (boundp 'buffer-file-coding-system)
+ buffer-file-coding-system))
+ (coding-system-for-write (or org-export-html-coding-system
+ coding-system))
+ (save-buffer-coding-system (or org-export-html-coding-system
+ coding-system))
+ (charset (and coding-system-for-write
+ (fboundp 'coding-system-get)
+ (coding-system-get coding-system-for-write
+ 'mime-charset)))
+ (region
+ (buffer-substring
+ (if region-p (region-beginning) (point-min))
+ (if region-p (region-end) (point-max))))
+ (lines
+ (org-split-string
+ (org-export-preprocess-string
+ region
+ :emph-multiline t
+ :for-html t
+ :skip-before-1st-heading
+ (plist-get opt-plist :skip-before-1st-heading)
+ :drawers (plist-get opt-plist :drawers)
+ :todo-keywords (plist-get opt-plist :todo-keywords)
+ :tags (plist-get opt-plist :tags)
+ :priority (plist-get opt-plist :priority)
+ :footnotes (plist-get opt-plist :footnotes)
+ :timestamps (plist-get opt-plist :timestamps)
+ :archived-trees
+ (plist-get opt-plist :archived-trees)
+ :select-tags (plist-get opt-plist :select-tags)
+ :exclude-tags (plist-get opt-plist :exclude-tags)
+ :add-text
+ (plist-get opt-plist :text)
+ :LaTeX-fragments
+ (plist-get opt-plist :LaTeX-fragments))
+ "[\r\n]"))
+ table-open type
+ table-buffer table-orig-buffer
+ ind item-type starter didclose
+ rpl path attr desc descp desc1 desc2 link
+ snumber fnc item-tag
+ footnotes footref-seen
+ id-file href
+ )
+
+ (let ((inhibit-read-only t))
+ (org-unmodified
+ (remove-text-properties (point-min) (point-max)
+ '(:org-license-to-kill t))))
+
+ (message "Exporting...")
+
+ (setq org-min-level (org-get-min-level lines level-offset))
+ (setq org-last-level org-min-level)
+ (org-init-section-numbers)
+
+ (cond
+ ((and date (string-match "%" date))
+ (setq date (format-time-string date)))
+ (date)
+ (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
+
+ ;; Get the language-dependent settings
+ (setq lang-words (or (assoc language org-export-language-setup)
+ (assoc "en" org-export-language-setup)))
+
+ ;; Switch to the output buffer
+ (set-buffer buffer)
+ (let ((inhibit-read-only t)) (erase-buffer))
+ (fundamental-mode)
+ (org-install-letbind)
+
+ (and (fboundp 'set-buffer-file-coding-system)
+ (set-buffer-file-coding-system coding-system-for-write))
+
+ (let ((case-fold-search nil)
+ (org-odd-levels-only odd))
+ ;; create local variables for all options, to make sure all called
+ ;; functions get the correct information
+ (mapc (lambda (x)
+ (set (make-local-variable (nth 2 x))
+ (plist-get opt-plist (car x))))
+ org-export-plist-vars)
+ (setq umax (if arg (prefix-numeric-value arg)
+ org-export-headline-levels))
+ (setq umax-toc (if (integerp org-export-with-toc)
+ (min org-export-with-toc umax)
+ umax))
+ (unless body-only
+ ;; File header
+ (insert (format
+ "%s
+<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
+ \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
+<html xmlns=\"http://www.w3.org/1999/xhtml\"
+lang=\"%s\" xml:lang=\"%s\">
+<head>
+%s
+<title>%s</title>
+<meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
+<meta name=\"generator\" content=\"Org-mode\"/>
+<meta name=\"generated\" content=\"%s\"/>
+<meta name=\"author\" content=\"%s\"/>
+<meta name=\"description\" content=\"%s\"/>
+<meta name=\"keywords\" content=\"%s\"/>
+%s
+</head>
+<body>
+<div id=\"content\">
+"
+ (format
+ (or (and (stringp org-export-html-xml-declaration)
+ org-export-html-xml-declaration)
+ (cdr (assoc html-extension org-export-html-xml-declaration))
+ (cdr (assoc "html" org-export-html-xml-declaration))
+
+ "")
+ (or charset "iso-8859-1"))
+ language language
+ (if (or link-up link-home)
+ (concat
+ (format org-export-html-home/up-format
+ (or link-up link-home)
+ (or link-home link-up))
+ "\n")
+ "")
+ (org-html-expand title)
+ (or charset "iso-8859-1")
+ date author description keywords
+ style))
+
+ (org-export-html-insert-plist-item opt-plist :preamble opt-plist)
+
+ (when (plist-get opt-plist :auto-preamble)
+ (if title (insert (format org-export-html-title-format
+ (org-html-expand title))))))
+
+ (if (and org-export-with-toc (not body-only))
+ (progn
+ (push (format "<h%d>%s</h%d>\n"
+ org-export-html-toplevel-hlevel
+ (nth 3 lang-words)
+ org-export-html-toplevel-hlevel)
+ thetoc)
+ (push "<div id=\"text-table-of-contents\">\n" thetoc)
+ (push "<ul>\n<li>" thetoc)
+ (setq lines
+ (mapcar '(lambda (line)
+ (if (string-match org-todo-line-regexp line)
+ ;; This is a headline
+ (progn
+ (setq have-headings t)
+ (setq level (- (match-end 1) (match-beginning 1)
+ level-offset)
+ level (org-tr-level level)
+ txt (save-match-data
+ (org-html-expand
+ (org-export-cleanup-toc-line
+ (match-string 3 line))))
+ todo
+ (or (and org-export-mark-todo-in-toc
+ (match-beginning 2)
+ (not (member (match-string 2 line)
+ org-done-keywords)))
+ ; TODO, not DONE
+ (and org-export-mark-todo-in-toc
+ (= level umax-toc)
+ (org-search-todo-below
+ line lines level))))
+ (if (string-match
+ (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
+ (setq txt (replace-match " <span class=\"tag\"> \\1</span>" t nil txt)))
+ (if (string-match quote-re0 txt)
+ (setq txt (replace-match "" t t txt)))
+ (setq snumber (org-section-number level))
+ (if org-export-with-section-numbers
+ (setq txt (concat snumber " " txt)))
+ (if (<= level (max umax umax-toc))
+ (setq head-count (+ head-count 1)))
+ (if (<= level umax-toc)
+ (progn
+ (if (> level org-last-level)
+ (progn
+ (setq cnt (- level org-last-level))
+ (while (>= (setq cnt (1- cnt)) 0)
+ (push "\n<ul>\n<li>" thetoc))
+ (push "\n" thetoc)))
+ (if (< level org-last-level)
+ (progn
+ (setq cnt (- org-last-level level))
+ (while (>= (setq cnt (1- cnt)) 0)
+ (push "</li>\n</ul>" thetoc))
+ (push "\n" thetoc)))
+ ;; Check for targets
+ (while (string-match org-any-target-regexp line)
+ (setq line (replace-match
+ (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
+ t t line)))
+ (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt)
+ (setq txt (replace-match "" t t txt)))
+ (setq href (format "sec-%s" snumber))
+ (setq href (or (cdr (assoc href org-export-preferred-target-alist)) href))
+ (push
+ (format
+ (if todo
+ "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
+ "</li>\n<li><a href=\"#%s\">%s</a>")
+ href txt) thetoc)
+
+ (setq org-last-level level))
+ )))
+ line)
+ lines))
+ (while (> org-last-level (1- org-min-level))
+ (setq org-last-level (1- org-last-level))
+ (push "</li>\n</ul>\n" thetoc))
+ (push "</div>\n" thetoc)
+ (setq thetoc (if have-headings (nreverse thetoc) nil))))
+
+ (setq head-count 0)
+ (org-init-section-numbers)
+
+ (org-open-par)
+
+ (while (setq line (pop lines) origline line)
+ (catch 'nextline
+
+ ;; end of quote section?
+ (when (and inquote (string-match "^\\*+ " line))
+ (insert "</pre>\n")
+ (org-open-par)
+ (setq inquote nil))
+ ;; inside a quote section?
+ (when inquote
+ (insert (org-html-protect line) "\n")
+ (throw 'nextline nil))
+
+ ;; Fixed-width, verbatim lines (examples)
+ (when (and org-export-with-fixed-width
+ (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
+ (when (not infixed)
+ (setq infixed t)
+ (org-close-par-maybe)
+
+ (insert "<pre class=\"example\">\n"))
+ (insert (org-html-protect (match-string 3 line)) "\n")
+ (when (or (not lines)
+ (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
+ (car lines))))
+ (setq infixed nil)
+ (insert "</pre>\n")
+ (org-open-par))
+ (throw 'nextline nil))
+
+ (org-export-html-close-lists-maybe line)
+
+ ;; Protected HTML
+ (when (get-text-property 0 'org-protected line)
+ (let (par (ind (get-text-property 0 'original-indentation line)))
+ (when (re-search-backward
+ "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
+ (setq par (match-string 1))
+ (replace-match "\\2\n"))
+ (insert line "\n")
+ (while (and lines
+ (or (= (length (car lines)) 0)
+ (not ind)
+ (equal ind (get-text-property 0 'original-indentation (car lines))))
+ (or (= (length (car lines)) 0)
+ (get-text-property 0 'org-protected (car lines))))
+ (insert (pop lines) "\n"))
+ (and par (insert "<p>\n")))
+ (throw 'nextline nil))
+
+ ;; Blockquotes, verse, and center
+ (when (equal "ORG-BLOCKQUOTE-START" line)
+ (org-close-par-maybe)
+ (insert "<blockquote>\n")
+ (org-open-par)
+ (throw 'nextline nil))
+ (when (equal "ORG-BLOCKQUOTE-END" line)
+ (org-close-par-maybe)
+ (insert "\n</blockquote>\n")
+ (org-open-par)
+ (throw 'nextline nil))
+ (when (equal "ORG-VERSE-START" line)
+ (org-close-par-maybe)
+ (insert "\n<p class=\"verse\">\n")
+ (setq inverse t)
+ (throw 'nextline nil))
+ (when (equal "ORG-VERSE-END" line)
+ (insert "</p>\n")
+ (org-open-par)
+ (setq inverse nil)
+ (throw 'nextline nil))
+ (when (equal "ORG-CENTER-START" line)
+ (org-close-par-maybe)
+ (insert "\n<div style=\"text-align: center\">")
+ (org-open-par)
+ (throw 'nextline nil))
+ (when (equal "ORG-CENTER-END" line)
+ (org-close-par-maybe)
+ (insert "\n</div>")
+ (org-open-par)
+ (throw 'nextline nil))
+ (run-hooks 'org-export-html-after-blockquotes-hook)
+ (when inverse
+ (let ((i (org-get-string-indentation line)))
+ (if (> i 0)
+ (setq line (concat (mapconcat 'identity
+ (make-list (* 2 i) "\\nbsp") "")
+ " " (org-trim line))))
+ (unless (string-match "\\\\\\\\[ \t]*$" line)
+ (setq line (concat line "\\\\")))))
+
+ ;; make targets to anchors
+ (while (string-match
+ "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
+ (cond
+ ((match-end 2)
+ (setq line (replace-match
+ (format
+ "@<a name=\"%s\" id=\"%s\">@</a>"
+ (org-solidify-link-text (match-string 1 line))
+ (org-solidify-link-text (match-string 1 line)))
+ t t line)))
+ ((and org-export-with-toc (equal (string-to-char line) ?*))
+ ;; FIXME: NOT DEPENDENT on TOC?????????????????????
+ (setq line (replace-match
+ (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
+; (concat "@<i>" (match-string 1 line) "@</i> ")
+ t t line)))
+ (t
+ (setq line (replace-match
+ (concat "@<a name=\""
+ (org-solidify-link-text (match-string 1 line))
+ "\" class=\"target\">" (match-string 1 line) "@</a> ")
+ t t line)))))
+
+ (setq line (org-html-handle-time-stamps line))
+
+ ;; replace "&" by "&", "<" and ">" by "<" and ">"
+ ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
+ ;; Also handle sub_superscripts and checkboxes
+ (or (string-match org-table-hline-regexp line)
+ (setq line (org-html-expand line)))
+
+ ;; Format the links
+ (setq start 0)
+ (while (string-match org-bracket-link-analytic-regexp++ line start)
+ (setq start (match-beginning 0))
+ (setq path (save-match-data (org-link-unescape
+ (match-string 3 line))))
+ (setq type (cond
+ ((match-end 2) (match-string 2 line))
+ ((save-match-data
+ (or (file-name-absolute-p path)
+ (string-match "^\\.\\.?/" path)))
+ "file")
+ (t "internal")))
+ (setq path (org-extract-attributes (org-link-unescape path)))
+ (setq attr (get-text-property 0 'org-attributes path))
+ (setq desc1 (if (match-end 5) (match-string 5 line))
+ desc2 (if (match-end 2) (concat type ":" path) path)
+ descp (and desc1 (not (equal desc1 desc2)))
+ desc (or desc1 desc2))
+ ;; Make an image out of the description if that is so wanted
+ (when (and descp (org-file-image-p
+ desc org-export-html-inline-image-extensions))
+ (save-match-data
+ (if (string-match "^file:" desc)
+ (setq desc (substring desc (match-end 0)))))
+ (setq desc (org-add-props
+ (concat "<img src=\"" desc "\"/>")
+ '(org-protected t))))
+ ;; FIXME: do we need to unescape here somewhere?
+ (cond
+ ((equal type "internal")
+ (setq rpl
+ (concat
+ "<a href=\""
+ (if (= (string-to-char path) ?#) "" "#")
+ (org-solidify-link-text
+ (save-match-data (org-link-unescape path)) nil)
+ "\"" attr ">"
+ (org-export-html-format-desc desc)
+ "</a>")))
+ ((and (equal type "id")
+ (setq id-file (org-id-find-id-file path)))
+ ;; This is an id: link to another file (if it was the same file,
+ ;; it would have become an internal link...)
+ (save-match-data
+ (setq id-file (file-relative-name
+ id-file (file-name-directory org-current-export-file)))
+ (setq id-file (concat (file-name-sans-extension id-file)
+ "." html-extension))
+ (setq rpl (concat "<a href=\"" id-file "#"
+ (if (org-uuidgen-p path) "ID-")
+ path "\""
+ attr ">"
+ (org-export-html-format-desc desc)
+ "</a>"))))
+ ((member type '("http" "https"))
+ ;; standard URL, just check if we need to inline an image
+ (if (and (or (eq t org-export-html-inline-images)
+ (and org-export-html-inline-images (not descp)))
+ (org-file-image-p
+ path org-export-html-inline-image-extensions))
+ (setq rpl (org-export-html-format-image
+ (concat type ":" path) org-par-open))
+ (setq link (concat type ":" path))
+ (setq rpl (concat "<a href=\""
+ (org-export-html-format-href link)
+ "\"" attr ">"
+ (org-export-html-format-desc desc)
+ "</a>"))))
+ ((member type '("ftp" "mailto" "news"))
+ ;; standard URL
+ (setq link (concat type ":" path))
+ (setq rpl (concat "<a href=\""
+ (org-export-html-format-href link)
+ "\"" attr ">"
+ (org-export-html-format-desc desc)
+ "</a>")))
+
+ ((string= type "coderef")
+ (setq rpl (format "<a href=\"#coderef-%s\" class=\"coderef\" onmouseover=\"CodeHighlightOn(this, 'coderef-%s');\" onmouseout=\"CodeHighlightOff(this, 'coderef-%s');\">%s</a>"
+ path path path
+ (format (org-export-get-coderef-format path (and descp desc))
+ (cdr (assoc path org-export-code-refs))))))
+
+ ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
+ ;; The link protocol has a function for format the link
+ (setq rpl
+ (save-match-data
+ (funcall fnc (org-link-unescape path) desc1 'html))))
+
+ ((string= type "file")
+ ;; FILE link
+ (let* ((filename path)
+ (abs-p (file-name-absolute-p filename))
+ thefile file-is-image-p search)
+ (save-match-data
+ (if (string-match "::\\(.*\\)" filename)
+ (setq search (match-string 1 filename)
+ filename (replace-match "" t nil filename)))
+ (setq valid
+ (if (functionp link-validate)
+ (funcall link-validate filename current-dir)
+ t))
+ (setq file-is-image-p
+ (org-file-image-p
+ filename org-export-html-inline-image-extensions))
+ (setq thefile (if abs-p (expand-file-name filename) filename))
+ (when (and org-export-html-link-org-files-as-html
+ (string-match "\\.org$" thefile))
+ (setq thefile (concat (substring thefile 0
+ (match-beginning 0))
+ "." html-extension))
+ (if (and search
+ ;; make sure this is can be used as target search
+ (not (string-match "^[0-9]*$" search))
+ (not (string-match "^\\*" search))
+ (not (string-match "^/.*/$" search)))
+ (setq thefile (concat thefile "#"
+ (org-solidify-link-text
+ (org-link-unescape search)))))
+ (when (string-match "^file:" desc)
+ (setq desc (replace-match "" t t desc))
+ (if (string-match "\\.org$" desc)
+ (setq desc (replace-match "" t t desc))))))
+ (setq rpl (if (and file-is-image-p
+ (or (eq t org-export-html-inline-images)
+ (and org-export-html-inline-images
+ (not descp))))
+ (progn
+ (message "image %s %s" thefile org-par-open)
+ (org-export-html-format-image thefile org-par-open))
+ (concat "<a href=\"" thefile "\"" attr ">"
+ (org-export-html-format-desc desc)
+ "</a>")))
+ (if (not valid) (setq rpl desc))))
+
+ (t
+ ;; just publish the path, as default
+ (setq rpl (concat "<i><" type ":"
+ (save-match-data (org-link-unescape path))
+ "></i>"))))
+ (setq line (replace-match rpl t t line)
+ start (+ start (length rpl))))
+
+ ;; TODO items
+ (if (and (string-match org-todo-line-regexp line)
+ (match-beginning 2))
+
+ (setq line
+ (concat (substring line 0 (match-beginning 2))
+ "<span class=\""
+ (if (member (match-string 2 line)
+ org-done-keywords)
+ "done" "todo")
+ " " (match-string 2 line)
+ "\"> " (org-export-html-get-todo-kwd-class-name
+ (match-string 2 line))
+ "</span>" (substring line (match-end 2)))))
+
+ ;; Does this contain a reference to a footnote?
+ (when org-export-with-footnotes
+ (setq start 0)
+ (while (string-match "\\([^* \t].*\\)?\\[\\([0-9]+\\)\\]" line start)
+ (if (get-text-property (match-beginning 2) 'org-protected line)
+ (setq start (match-end 2))
+ (let ((n (match-string 2 line)) extra a)
+ (if (setq a (assoc n footref-seen))
+ (progn
+ (setcdr a (1+ (cdr a)))
+ (setq extra (format ".%d" (cdr a))))
+ (setq extra "")
+ (push (cons n 1) footref-seen))
+ (setq line
+ (replace-match
+ (format
+ (concat (if (match-string 1 line) "%s" "")
+ (format org-export-html-footnote-format
+ "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
+ (match-string 1 line) n extra n n)
+ t t line))))))
+
+ (cond
+ ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
+ ;; This is a headline
+ (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
+ level-offset))
+ txt (match-string 2 line))
+ (if (string-match quote-re0 txt)
+ (setq txt (replace-match "" t t txt)))
+ (if (<= level (max umax umax-toc))
+ (setq head-count (+ head-count 1)))
+ (when in-local-list
+ ;; Close any local lists before inserting a new header line
+ (while local-list-type
+ (org-close-li (car local-list-type))
+ (insert (format "</%sl>\n" (car local-list-type)))
+ (pop local-list-type))
+ (setq local-list-indent nil
+ in-local-list nil))
+ (setq first-heading-pos (or first-heading-pos (point)))
+ (org-html-level-start level txt umax
+ (and org-export-with-toc (<= level umax))
+ head-count)
+
+ ;; QUOTES
+ (when (string-match quote-re line)
+ (org-close-par-maybe)
+ (insert "<pre>")
+ (setq inquote t)))
+
+ ((string-match "^[ \t]*- __+[ \t]*$" line)
+ ;; Explicit list closure
+ (when local-list-type
+ (let ((ind (org-get-indentation line)))
+ (while (and local-list-indent
+ (<= ind (car local-list-indent)))
+ (org-close-li (car local-list-type))
+ (insert (format "</%sl>\n" (car local-list-type)))
+ (pop local-list-type)
+ (pop local-list-indent))
+ (or local-list-indent (setq in-local-list nil))))
+ (throw 'nextline nil))
+
+ ((and org-export-with-tables
+ (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
+ (when (not table-open)
+ ;; New table starts
+ (setq table-open t table-buffer nil table-orig-buffer nil))
+
+ ;; Accumulate lines
+ (setq table-buffer (cons line table-buffer)
+ table-orig-buffer (cons origline table-orig-buffer))
+ (when (or (not lines)
+ (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
+ (car lines))))
+ (setq table-open nil
+ table-buffer (nreverse table-buffer)
+ table-orig-buffer (nreverse table-orig-buffer))
+ (org-close-par-maybe)
+ (insert (org-format-table-html table-buffer table-orig-buffer))))
+ (t
+ ;; Normal lines
+ (when (string-match
+ (cond
+ ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
+ ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
+ ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
+ (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
+ line)
+ (setq ind (or (get-text-property 0 'original-indentation line)
+ (org-get-string-indentation line))
+ item-type (if (match-beginning 4) "o" "u")
+ starter (if (match-beginning 2)
+ (substring (match-string 2 line) 0 -1))
+ line (substring line (match-beginning 5))
+ item-tag nil)
+ (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
+ (setq item-type "d"
+ item-tag (match-string 1 line)
+ line (substring line (match-end 0))))
+ (when (and (not (equal item-type "d"))
+ (not (string-match "[^ \t]" line)))
+ ;; empty line. Pretend indentation is large.
+ (setq ind (if org-empty-line-terminates-plain-lists
+ 0
+ (1+ (or (car local-list-indent) 1)))))
+ (setq didclose nil)
+ (while (and in-local-list
+ (or (and (= ind (car local-list-indent))
+ (not starter))
+ (< ind (car local-list-indent))))
+ (setq didclose t)
+ (org-close-li (car local-list-type))
+ (insert (format "</%sl>\n" (car local-list-type)))
+ (pop local-list-type) (pop local-list-indent)
+ (setq in-local-list local-list-indent))
+ (cond
+ ((and starter
+ (or (not in-local-list)
+ (> ind (car local-list-indent))))
+ ;; Start new (level of) list
+ (org-close-par-maybe)
+ (insert (cond
+ ((equal item-type "u") "<ul>\n<li>\n")
+ ((equal item-type "o") "<ol>\n<li>\n")
+ ((equal item-type "d")
+ (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
+ (push item-type local-list-type)
+ (push ind local-list-indent)
+ (setq in-local-list t))
+ (starter
+ ;; continue current list
+ (org-close-li (car local-list-type))
+ (insert (cond
+ ((equal (car local-list-type) "d")
+ (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
+ (t "<li>\n"))))
+ (didclose
+ ;; we did close a list, normal text follows: need <p>
+ (org-open-par)))
+ (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
+ (setq line
+ (replace-match
+ (if (equal (match-string 1 line) "X")
+ "<b>[X]</b>"
+ "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
+ t t line))))
+
+ ;; Horizontal line
+ (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
+ (if org-par-open
+ (insert "\n</p>\n<hr/>\n<p>\n")
+ (insert "\n<hr/>\n"))
+ (throw 'nextline nil))
+
+ ;; Empty lines start a new paragraph. If hand-formatted lists
+ ;; are not fully interpreted, lines starting with "-", "+", "*"
+ ;; also start a new paragraph.
+ (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
+
+ ;; Is this the start of a footnote?
+ (when org-export-with-footnotes
+ (when (and (boundp 'footnote-section-tag-regexp)
+ (string-match (concat "^" footnote-section-tag-regexp)
+ line))
+ ;; ignore this line
+ (throw 'nextline nil))
+ (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
+ (org-close-par-maybe)
+ (let ((n (match-string 1 line)))
+ (setq org-par-open t
+ line (replace-match
+ (concat "<p class=\"footnote\">"
+ (format org-export-html-footnote-format
+ "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"
+ n n n) t t line))))))
+ ;; Check if the line break needs to be conserved
+ (cond
+ ((string-match "\\\\\\\\[ \t]*$" line)
+ (setq line (replace-match "<br/>" t t line)))
+ (org-export-preserve-breaks
+ (setq line (concat line "<br/>"))))
+
+ ;; Check if a paragraph should be started
+ (let ((start 0))
+ (while (and org-par-open
+ (string-match "\\\\par\\>" line start))
+ ;; Leave a space in the </p> so that the footnote matcher
+ ;; does not see this.
+ (if (not (get-text-property (match-beginning 0)
+ 'org-protected line))
+ (setq line (replace-match "</p ><p >" t t line)))
+ (setq start (match-end 0))))
+
+ (insert line "\n")))))
+
+ ;; Properly close all local lists and other lists
+ (when inquote
+ (insert "</pre>\n")
+ (org-open-par))
+ (when in-local-list
+ ;; Close any local lists before inserting a new header line
+ (while local-list-type
+ (org-close-li (car local-list-type))
+ (insert (format "</%sl>\n" (car local-list-type)))
+ (pop local-list-type))
+ (setq local-list-indent nil
+ in-local-list nil))
+ (org-html-level-start 1 nil umax
+ (and org-export-with-toc (<= level umax))
+ head-count)
+ ;; the </div> to close the last text-... div.
+ (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
+
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
+ (push (match-string 0) footnotes)
+ (replace-match "" t t)))
+ (when footnotes
+ (insert (format org-export-html-footnotes-section
+ (nth 4 lang-words)
+ (mapconcat 'identity (nreverse footnotes) "\n"))
+ "\n"))
+ (let ((bib (org-export-html-get-bibliography)))
+ (when bib
+ (insert "\n" bib "\n")))
+ (unless body-only
+ (when (plist-get opt-plist :auto-postamble)
+ (insert "<div id=\"postamble\">\n")
+ (when (and org-export-author-info author)
+ (insert "<p class=\"author\"> "
+ (nth 1 lang-words) ": " author "\n")
+ (when email
+ (if (listp (split-string email ",+ *"))
+ (mapc (lambda(e)
+ (insert "<a href=\"mailto:" e "\"><"
+ e "></a>\n"))
+ (split-string email ",+ *"))
+ (insert "<a href=\"mailto:" email "\"><"
+ email "></a>\n")))
+ (insert "</p>\n"))
+ (when (and date org-export-time-stamp-file)
+ (insert "<p class=\"date\"> "
+ (nth 2 lang-words) ": "
+ date "</p>\n"))
+ (when org-export-creator-info
+ (insert (format "<p class=\"creator\">HTML generated by org-mode %s in emacs %s</p>\n"
+ org-version emacs-major-version)))
+ (when org-export-html-validation-link
+ (insert org-export-html-validation-link "\n"))
+ (insert "</div>"))
+
+ (if org-export-html-with-timestamp
+ (insert org-export-html-html-helper-timestamp))
+ (org-export-html-insert-plist-item opt-plist :postamble opt-plist)
+ (insert "\n</div>\n</body>\n</html>\n"))
+
+ (unless (plist-get opt-plist :buffer-will-be-killed)
+ (normal-mode)
+ (if (eq major-mode default-major-mode) (html-mode)))
+
+ ;; insert the table of contents
+ (goto-char (point-min))
+ (when thetoc
+ (if (or (re-search-forward
+ "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
+ (re-search-forward
+ "\\[TABLE-OF-CONTENTS\\]" nil t))
+ (progn
+ (goto-char (match-beginning 0))
+ (replace-match ""))
+ (goto-char first-heading-pos)
+ (when (looking-at "\\s-*</p>")
+ (goto-char (match-end 0))
+ (insert "\n")))
+ (insert "<div id=\"table-of-contents\">\n")
+ (mapc 'insert thetoc)
+ (insert "</div>\n"))
+ ;; remove empty paragraphs and lists
+ (goto-char (point-min))
+ (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
+ (replace-match ""))
+ (goto-char (point-min))
+ (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
+ (replace-match ""))
+ (goto-char (point-min))
+ (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t)
+ (replace-match ""))
+ ;; Convert whitespace place holders
+ (goto-char (point-min))
+ (let (beg end n)
+ (while (setq beg (next-single-property-change (point) 'org-whitespace))
+ (setq n (get-text-property beg 'org-whitespace)
+ end (next-single-property-change beg 'org-whitespace))
+ (goto-char beg)
+ (delete-region beg end)
+ (insert (format "<span style=\"visibility:hidden;\">%s</span>"
+ (make-string n ?x)))))
+ (or to-buffer (save-buffer))
+ (goto-char (point-min))
+ (or (org-export-push-to-kill-ring "HTML")
+ (message "Exporting... done"))
+ (if (eq to-buffer 'string)
+ (prog1 (buffer-substring (point-min) (point-max))
+ (kill-buffer (current-buffer)))
+ (current-buffer)))))
+
+(defun org-export-html-insert-plist-item (plist key &rest args)
+ (let ((item (plist-get plist key)))
+ (cond ((functionp item)
+ (apply item args))
+ (item
+ (insert item)))))
+
+(defun org-export-html-format-href (s)
+ "Make sure the S is valid as a href reference in an XHTML document."
+ (save-match-data
+ (let ((start 0))
+ (while (string-match "&" s start)
+ (setq start (+ (match-beginning 0) 3)
+ s (replace-match "&" t t s)))))
+ s)
+
+(defun org-export-html-format-desc (s)
+ "Make sure the S is valid as a description in a link."
+ (if (and s (not (get-text-property 1 'org-protected s)))
+ (save-match-data
+ (org-html-do-expand s))
+ s))
+
+(defun org-export-html-format-image (src par-open)
+ "Create image tag with source and attributes."
+ (save-match-data
+ (if (string-match "^ltxpng/" src)
+ (format "<img src=\"%s\"/>" src)
+ (let* ((caption (org-find-text-property-in-string 'org-caption src))
+ (attr (org-find-text-property-in-string 'org-attributes src))
+ (label (org-find-text-property-in-string 'org-label src)))
+ (format "%s<div %sclass=\"figure\">
+<p><img src=\"%s\"%s /></p>%s
+</div>%s"
+ (if org-par-open "</p>\n" "")
+ (if label (format "id=\"%s\" " label) "")
+ src
+ (if (string-match "\\<alt=" (or attr ""))
+ (concat " " attr )
+ (concat " " attr " alt=\"" src "\""))
+ (if caption (concat "\n<p>" caption "</p>") "")
+ (if org-par-open "\n<p>" ""))))))
+
+(defun org-export-html-get-bibliography ()
+ "Find bibliography, cut it out and return it."
+ (catch 'exit
+ (let (beg end (cnt 1) bib)
+ (save-excursion
+ (goto-char (point-min))
+ (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
+ (setq beg (match-beginning 0))
+ (while (re-search-forward "</?div\\>" nil t)
+ (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
+ (when (= cnt 0)
+ (and (looking-at ">") (forward-char 1))
+ (setq bib (buffer-substring beg (point)))
+ (delete-region beg (point))
+ (throw 'exit bib))))
+ nil))))
+
+(defvar org-table-number-regexp) ; defined in org-table.el
+(defun org-format-table-html (lines olines)
+ "Find out which HTML converter to use and return the HTML code."
+ (if (stringp lines)
+ (setq lines (org-split-string lines "\n")))
+ (if (string-match "^[ \t]*|" (car lines))
+ ;; A normal org table
+ (org-format-org-table-html lines)
+ ;; Table made by table.el - test for spanning
+ (let* ((hlines (delq nil (mapcar
+ (lambda (x)
+ (if (string-match "^[ \t]*\\+-" x) x
+ nil))
+ lines)))
+ (first (car hlines))
+ (ll (and (string-match "\\S-+" first)
+ (match-string 0 first)))
+ (re (concat "^[ \t]*" (regexp-quote ll)))
+ (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
+ hlines))))
+ (if (and (not spanning)
+ (not org-export-prefer-native-exporter-for-tables))
+ ;; We can use my own converter with HTML conversions
+ (org-format-table-table-html lines)
+ ;; Need to use the code generator in table.el, with the original text.
+ (org-format-table-table-html-using-table-generate-source olines)))))
+
+(defvar org-table-number-fraction) ; defined in org-table.el
+(defun org-format-org-table-html (lines &optional splice)
+ "Format a table into HTML."
+ (require 'org-table)
+ ;; Get rid of hlines at beginning and end
+ (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
+ (setq lines (nreverse lines))
+ (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
+ (setq lines (nreverse lines))
+ (when org-export-table-remove-special-lines
+ ;; Check if the table has a marking column. If yes remove the
+ ;; column and the special lines
+ (setq lines (org-table-clean-before-export lines)))
+
+ (let* ((caption (or (get-text-property 0 'org-caption (car lines))
+ (get-text-property (or (next-single-property-change
+ 0 'org-caption (car lines))
+ 0)
+ 'org-caption (car lines))))
+ (attributes (or (get-text-property 0 'org-attributes (car lines))
+ (get-text-property (or (next-single-property-change
+ 0 'org-attributes (car lines))
+ 0)
+ 'org-attributes (car lines))))
+ (html-table-tag (org-export-splice-attributes
+ html-table-tag attributes))
+ (head (and org-export-highlight-first-table-line
+ (delq nil (mapcar
+ (lambda (x) (string-match "^[ \t]*|-" x))
+ (cdr lines)))))
+
+ (nline 0) fnum i
+ tbopen line fields html gr colgropen rowstart rowend)
+ (if splice (setq head nil))
+ (unless splice (push (if head "<thead>" "<tbody>") html))
+ (setq tbopen t)
+ (while (setq line (pop lines))
+ (catch 'next-line
+ (if (string-match "^[ \t]*|-" line)
+ (progn
+ (unless splice
+ (push (if head "</thead>" "</tbody>") html)
+ (if lines (push "<tbody>" html) (setq tbopen nil)))
+ (setq head nil) ;; head ends here, first time around
+ ;; ignore this line
+ (throw 'next-line t)))
+ ;; Break the line into fields
+ (setq fields (org-split-string line "[ \t]*|[ \t]*"))
+ (unless fnum (setq fnum (make-vector (length fields) 0)))
+ (setq nline (1+ nline) i -1
+ rowstart (eval (car org-export-table-row-tags))
+ rowend (eval (cdr org-export-table-row-tags)))
+ (push (concat rowstart
+ (mapconcat
+ (lambda (x)
+ (setq i (1+ i))
+ (if (and (< i nline)
+ (string-match org-table-number-regexp x))
+ (incf (aref fnum i)))
+ (cond
+ (head
+ (concat
+ (format (car org-export-table-header-tags) "col")
+ x
+ (cdr org-export-table-header-tags)))
+ ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
+ (concat
+ (format (car org-export-table-header-tags) "row")
+ x
+ (cdr org-export-table-header-tags)))
+ (t
+ (concat (car org-export-table-data-tags) x
+ (cdr org-export-table-data-tags)))))
+ fields "")
+ rowend)
+ html)))
+ (unless splice (if tbopen (push "</tbody>" html)))
+ (unless splice (push "</table>\n" html))
+ (setq html (nreverse html))
+ (unless splice
+ ;; Put in col tags with the alignment (unfortuntely often ignored...)
+ (unless (car org-table-colgroup-info)
+ (setq org-table-colgroup-info
+ (cons :start (cdr org-table-colgroup-info))))
+ (push (mapconcat
+ (lambda (x)
+ (setq gr (pop org-table-colgroup-info))
+ (format "%s<col align=\"%s\"></col>%s"
+ (if (memq gr '(:start :startend))
+ (prog1
+ (if colgropen "</colgroup>\n<colgroup>" "<colgroup>")
+ (setq colgropen t))
+ "")
+ (if (> (/ (float x) nline) org-table-number-fraction)
+ "right" "left")
+ (if (memq gr '(:end :startend))
+ (progn (setq colgropen nil) "</colgroup>")
+ "")))
+ fnum "")
+ html)
+ (if colgropen (setq html (cons (car html) (cons "</colgroup>" (cdr html)))))
+ ;; Since the output of HTML table formatter can also be used in
+ ;; DocBook document, we want to always include the caption to make
+ ;; DocBook XML file valid.
+ (push (format "<caption>%s</caption>" (or caption "")) html)
+ (push html-table-tag html))
+ (concat (mapconcat 'identity html "\n") "\n")))
+
+(defun org-export-splice-attributes (tag attributes)
+ "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
+ (if (not attributes)
+ tag
+ (let (oldatt newatt)
+ (setq oldatt (org-extract-attributes-from-string tag)
+ tag (pop oldatt)
+ newatt (cdr (org-extract-attributes-from-string attributes)))
+ (while newatt
+ (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
+ (if (string-match ">" tag)
+ (setq tag
+ (replace-match (concat (org-attributes-to-string oldatt) ">")
+ t t tag)))
+ tag)))
+
+(defun org-format-table-table-html (lines)
+ "Format a table generated by table.el into HTML.
+This conversion does *not* use `table-generate-source' from table.el.
+This has the advantage that Org-mode's HTML conversions can be used.
+But it has the disadvantage, that no cell- or row-spanning is allowed."
+ (let (line field-buffer
+ (head org-export-highlight-first-table-line)
+ fields html empty i)
+ (setq html (concat html-table-tag "\n"))
+ (while (setq line (pop lines))
+ (setq empty " ")
+ (catch 'next-line
+ (if (string-match "^[ \t]*\\+-" line)
+ (progn
+ (if field-buffer
+ (progn
+ (setq
+ html
+ (concat
+ html
+ "<tr>"
+ (mapconcat
+ (lambda (x)
+ (if (equal x "") (setq x empty))
+ (if head
+ (concat
+ (format (car org-export-table-header-tags) "col")
+ x
+ (cdr org-export-table-header-tags))
+ (concat (car org-export-table-data-tags) x
+ (cdr org-export-table-data-tags))))
+ field-buffer "\n")
+ "</tr>\n"))
+ (setq head nil)
+ (setq field-buffer nil)))
+ ;; Ignore this line
+ (throw 'next-line t)))
+ ;; Break the line into fields and store the fields
+ (setq fields (org-split-string line "[ \t]*|[ \t]*"))
+ (if field-buffer
+ (setq field-buffer (mapcar
+ (lambda (x)
+ (concat x "<br/>" (pop fields)))
+ field-buffer))
+ (setq field-buffer fields))))
+ (setq html (concat html "</table>\n"))
+ html))
+
+(defun org-format-table-table-html-using-table-generate-source (lines)
+ "Format a table into html, using `table-generate-source' from table.el.
+This has the advantage that cell- or row-spanning is allowed.
+But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
+ (require 'table)
+ (with-current-buffer (get-buffer-create " org-tmp1 ")
+ (erase-buffer)
+ (insert (mapconcat 'identity lines "\n"))
+ (goto-char (point-min))
+ (if (not (re-search-forward "|[^+]" nil t))
+ (error "Error processing table"))
+ (table-recognize-table)
+ (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
+ (table-generate-source 'html " org-tmp2 ")
+ (set-buffer " org-tmp2 ")
+ (buffer-substring (point-min) (point-max))))
+
+(defun org-export-splice-style (style extra)
+ "Splice EXTRA into STYLE, just before \"</style>\"."
+ (if (and (stringp extra)
+ (string-match "\\S-" extra)
+ (string-match "</style>" style))
+ (concat (substring style 0 (match-beginning 0))
+ "\n" extra "\n"
+ (substring style (match-beginning 0)))
+ style))
+
+(defun org-html-handle-time-stamps (s)
+ "Format time stamps in string S, or remove them."
+ (catch 'exit
+ (let (r b)
+ (while (string-match org-maybe-keyword-time-regexp s)
+ (or b (setq b (substring s 0 (match-beginning 0))))
+ (setq r (concat
+ r (substring s 0 (match-beginning 0))
+ " @<span class=\"timestamp-wrapper\">"
+ (if (match-end 1)
+ (format "@<span class=\"timestamp-kwd\">%s @</span>"
+ (match-string 1 s)))
+ (format " @<span class=\"timestamp\">%s@</span>"
+ (substring
+ (org-translate-time (match-string 3 s)) 1 -1))
+ "@</span>")
+ s (substring s (match-end 0))))
+ ;; Line break if line started and ended with time stamp stuff
+ (if (not r)
+ s
+ (setq r (concat r s))
+ (unless (string-match "\\S-" (concat b s))
+ (setq r (concat r "@<br/>")))
+ r))))
+
+(defvar htmlize-buffer-places) ; from htmlize.el
+(defun org-export-htmlize-region-for-paste (beg end)
+ "Convert the region to HTML, using htmlize.el.
+This is much like `htmlize-region-for-paste', only that it uses
+the settings define in the org-... variables."
+ (let* ((htmlize-output-type org-export-htmlize-output-type)
+ (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
+ (htmlbuf (htmlize-region beg end)))
+ (unwind-protect
+ (with-current-buffer htmlbuf
+ (buffer-substring (plist-get htmlize-buffer-places 'content-start)
+ (plist-get htmlize-buffer-places 'content-end)))
+ (kill-buffer htmlbuf))))
+
+;;;###autoload
+(defun org-export-htmlize-generate-css ()
+ "Create the CSS for all font definitions in the current Emacs session.
+Use this to create face definitions in your CSS style file that can then
+be used by code snippets transformed by htmlize.
+This command just produces a buffer that contains class definitions for all
+faces used in the current Emacs session. You can copy and paste the ones you
+need into your CSS file.
+
+If you then set `org-export-htmlize-output-type' to `css', calls to
+the function `org-export-htmlize-region-for-paste' will produce code
+that uses these same face definitions."
+ (interactive)
+ (require 'htmlize)
+ (and (get-buffer "*html*") (kill-buffer "*html*"))
+ (with-temp-buffer
+ (let ((fl (face-list))
+ (htmlize-css-name-prefix "org-")
+ (htmlize-output-type 'css)
+ f i)
+ (while (setq f (pop fl)
+ i (and f (face-attribute f :inherit)))
+ (when (and (symbolp f) (or (not i) (not (listp i))))
+ (insert (org-add-props (copy-sequence "1") nil 'face f))))
+ (htmlize-region (point-min) (point-max))))
+ (switch-to-buffer "*html*")
+ (goto-char (point-min))
+ (if (re-search-forward "<style" nil t)
+ (delete-region (point-min) (match-beginning 0)))
+ (if (re-search-forward "</style>" nil t)
+ (delete-region (1+ (match-end 0)) (point-max)))
+ (beginning-of-line 1)
+ (if (looking-at " +") (replace-match ""))
+ (goto-char (point-min)))
+
+(defun org-html-protect (s)
+ ;; convert & to &, < to < and > to >
+ (let ((start 0))
+ (while (string-match "&" s start)
+ (setq s (replace-match "&" t t s)
+ start (1+ (match-beginning 0))))
+ (while (string-match "<" s)
+ (setq s (replace-match "<" t t s)))
+ (while (string-match ">" s)
+ (setq s (replace-match ">" t t s)))
+; (while (string-match "\"" s)
+; (setq s (replace-match """ t t s)))
+ )
+ s)
+
+(defun org-html-expand (string)
+ "Prepare STRING for HTML export. Applies all active conversions.
+If there are links in the string, don't modify these."
+ (let* ((re (concat org-bracket-link-regexp "\\|"
+ (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
+ m s l res)
+ (while (setq m (string-match re string))
+ (setq s (substring string 0 m)
+ l (match-string 0 string)
+ string (substring string (match-end 0)))
+ (push (org-html-do-expand s) res)
+ (push l res))
+ (push (org-html-do-expand string) res)
+ (apply 'concat (nreverse res))))
+
+(defun org-html-do-expand (s)
+ "Apply all active conversions to translate special ASCII to HTML."
+ (setq s (org-html-protect s))
+ (if org-export-html-expand
+ (while (string-match "@<\\([^&]*\\)>" s)
+ (setq s (replace-match "<\\1>" t nil s))))
+ (if org-export-with-emphasize
+ (setq s (org-export-html-convert-emphasize s)))
+ (if org-export-with-special-strings
+ (setq s (org-export-html-convert-special-strings s)))
+ (if org-export-with-sub-superscripts
+ (setq s (org-export-html-convert-sub-super s)))
+ (if org-export-with-TeX-macros
+ (let ((start 0) wd ass)
+ (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)\\({}\\)?"
+ s start))
+ (if (get-text-property (match-beginning 0) 'org-protected s)
+ (setq start (match-end 0))
+ (setq wd (match-string 1 s))
+ (if (setq ass (assoc wd org-html-entities))
+ (setq s (replace-match (or (cdr ass)
+ (concat "&" (car ass) ";"))
+ t t s))
+ (setq start (+ start (length wd))))))))
+ s)
+
+(defconst org-export-html-special-string-regexps
+ '(("\\\\-" . "­")
+ ("---\\([^-]\\)" . "—\\1")
+ ("--\\([^-]\\)" . "–\\1")
+ ("\\.\\.\\." . "…"))
+ "Regular expressions for special string conversion.")
+
+(defun org-export-html-convert-special-strings (string)
+ "Convert special characters in STRING to HTML."
+ (let ((all org-export-html-special-string-regexps)
+ e a re rpl start)
+ (while (setq a (pop all))
+ (setq re (car a) rpl (cdr a) start 0)
+ (while (string-match re string start)
+ (if (get-text-property (match-beginning 0) 'org-protected string)
+ (setq start (match-end 0))
+ (setq string (replace-match rpl t nil string)))))
+ string))
+
+(defun org-export-html-convert-sub-super (string)
+ "Convert sub- and superscripts in STRING to HTML."
+ (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
+ (while (string-match org-match-substring-regexp string s)
+ (cond
+ ((and requireb (match-end 8)) (setq s (match-end 2)))
+ ((get-text-property (match-beginning 2) 'org-protected string)
+ (setq s (match-end 2)))
+ (t
+ (setq s (match-end 1)
+ key (if (string= (match-string 2 string) "_") "sub" "sup")
+ c (or (match-string 8 string)
+ (match-string 6 string)
+ (match-string 5 string))
+ string (replace-match
+ (concat (match-string 1 string)
+ "<" key ">" c "</" key ">")
+ t t string)))))
+ (while (string-match "\\\\\\([_^]\\)" string)
+ (setq string (replace-match (match-string 1 string) t t string)))
+ string))
+
+(defun org-export-html-convert-emphasize (string)
+ "Apply emphasis."
+ (let ((s 0) rpl)
+ (while (string-match org-emph-re string s)
+ (if (not (equal
+ (substring string (match-beginning 3) (1+ (match-beginning 3)))
+ (substring string (match-beginning 4) (1+ (match-beginning 4)))))
+ (setq s (match-beginning 0)
+ rpl
+ (concat
+ (match-string 1 string)
+ (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
+ (match-string 4 string)
+ (nth 3 (assoc (match-string 3 string)
+ org-emphasis-alist))
+ (match-string 5 string))
+ string (replace-match rpl t t string)
+ s (+ s (- (length rpl) 2)))
+ (setq s (1+ s))))
+ string))
+
+(defun org-open-par ()
+ "Insert <p>, but first close previous paragraph if any."
+ (org-close-par-maybe)
+ (insert "\n<p>")
+ (setq org-par-open t))
+(defun org-close-par-maybe ()
+ "Close paragraph if there is one open."
+ (when org-par-open
+ (insert "</p>")
+ (setq org-par-open nil)))
+(defun org-close-li (&optional type)
+ "Close <li> if necessary."
+ (org-close-par-maybe)
+ (insert (if (equal type "d") "</dd>\n" "</li>\n")))
+
+(defvar in-local-list)
+(defvar local-list-indent)
+(defvar local-list-type)
+(defun org-export-html-close-lists-maybe (line)
+ (let ((ind (or (get-text-property 0 'original-indentation line)))
+; (and (string-match "\\S-" line)
+; (org-get-indentation line))))
+ didclose)
+ (when ind
+ (while (and in-local-list
+ (<= ind (car local-list-indent)))
+ (setq didclose t)
+ (org-close-li (car local-list-type))
+ (insert (format "</%sl>\n" (car local-list-type)))
+ (pop local-list-type) (pop local-list-indent)
+ (setq in-local-list local-list-indent))
+ (and didclose (org-open-par)))))
+
+(defvar body-only) ; dynamically scoped into this.
+(defun org-html-level-start (level title umax with-toc head-count)
+ "Insert a new level in HTML export.
+When TITLE is nil, just close all open levels."
+ (org-close-par-maybe)
+ (let* ((target (and title (org-get-text-property-any 0 'target title)))
+ (extra-targets (assoc target org-export-target-aliases))
+ (preferred (cdr (assoc target org-export-preferred-target-alist)))
+ (remove (or preferred target))
+ (l org-level-max)
+ snumber href suffix)
+ (setq extra-targets (remove remove extra-targets))
+ (setq extra-targets
+ (mapconcat (lambda (x)
+ (if (org-uuidgen-p x) (setq x (concat "ID-" x)))
+ (format "<a name=\"%s\" id=\"%s\"></a>"
+ x x))
+ extra-targets
+ ""))
+ (while (>= l level)
+ (if (aref org-levels-open (1- l))
+ (progn
+ (org-html-level-close l umax)
+ (aset org-levels-open (1- l) nil)))
+ (setq l (1- l)))
+ (when title
+ ;; If title is nil, this means this function is called to close
+ ;; all levels, so the rest is done only if title is given
+ (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
+ (setq title (replace-match
+ (if org-export-with-tags
+ (save-match-data
+ (concat
+ " <span class=\"tag\">"
+ (mapconcat
+ (lambda (x)
+ (format "<span class=\"%s\">%s</span>"
+ (org-export-html-get-tag-class-name x)
+ x))
+ (org-split-string (match-string 1 title) ":")
+ " ")
+ "</span>"))
+ "")
+ t t title)))
+ (if (> level umax)
+ (progn
+ (if (aref org-levels-open (1- level))
+ (progn
+ (org-close-li)
+ (if target
+ (insert (format "<li id=\"%s\">" target) extra-targets title "<br/>\n")
+ (insert "<li>" title "<br/>\n")))
+ (aset org-levels-open (1- level) t)
+ (org-close-par-maybe)
+ (if target
+ (insert (format "<ul>\n<li id=\"%s\">" target)
+ extra-targets title "<br/>\n")
+ (insert "<ul>\n<li>" title "<br/>\n"))))
+ (aset org-levels-open (1- level) t)
+ (setq snumber (org-section-number level))
+ (setq level (+ level org-export-html-toplevel-hlevel -1))
+ (if (and org-export-with-section-numbers (not body-only))
+ (setq title (concat
+ (format "<span class=\"section-number-%d\">%s</span>"
+ level snumber)
+ " " title)))
+ (unless (= head-count 1) (insert "\n</div>\n"))
+ (setq href (cdr (assoc (concat "sec-" snumber) org-export-preferred-target-alist)))
+ (setq suffix (or href snumber))
+ (setq href (or href (concat "sec-" snumber)))
+ (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d\">\n<h%d id=\"%s\">%s%s</h%d>\n<div class=\"outline-text-%d\" id=\"text-%s\">\n"
+ suffix level level href
+ extra-targets
+ title level level suffix))
+ (org-open-par)))))
+
+(defun org-export-html-get-tag-class-name (tag)
+ "Turn tag into a valid class name.
+Replaces invalid characters with \"_\" and then prepends a prefix."
+ (save-match-data
+ (while (string-match "[^a-zA-Z0-9_]" tag)
+ (setq tag (replace-match "_" t t tag))))
+ (concat org-export-html-tag-class-prefix tag))
+
+(defun org-export-html-get-todo-kwd-class-name (kwd)
+ "Turn todo keyword into a valid class name.
+Replaces invalid characters with \"_\" and then prepends a prefix."
+ (save-match-data
+ (while (string-match "[^a-zA-Z0-9_]" kwd)
+ (setq kwd (replace-match "_" t t kwd))))
+ (concat org-export-html-todo-kwd-class-prefix kwd))
+
+(defun org-html-level-close (level max-outline-level)
+ "Terminate one level in HTML export."
+ (if (<= level max-outline-level)
+ (insert "</div>\n")
+ (org-close-li)
+ (insert "</ul>\n")))
+
+(provide 'org-html)
+
+;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
+
+;;; org-html.el ends here
--- /dev/null
+;;; org-icalendar.el --- iCalendar export for Org-mode
+
+;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
+;; Free Software Foundation, Inc.
+
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+
+(require 'org-exp)
+
+(declare-function org-bbdb-anniv-export-ical "org-bbdb" nil)
+
+(defgroup org-export-icalendar nil
+ "Options specific for iCalendar export of Org-mode files."
+ :tag "Org Export iCalendar"
+ :group 'org-export)
+
+(defcustom org-combined-agenda-icalendar-file "~/org.ics"
+ "The file name for the iCalendar file covering all agenda files.
+This file is created with the command \\[org-export-icalendar-all-agenda-files].
+The file name should be absolute, the file will be overwritten without warning."
+ :group 'org-export-icalendar
+ :type 'file)
+
+(defcustom org-icalendar-combined-name "OrgMode"
+ "Calendar name for the combined iCalendar representing all agenda files."
+ :group 'org-export-icalendar
+ :type 'string)
+
+(defcustom org-icalendar-use-deadline '(event-if-not-todo todo-due)
+ "Contexts where iCalendar export should use a deadline time stamp.
+This is a list with several symbols in it. Valid symbol are:
+
+event-if-todo Deadlines in TODO entries become calendar events.
+event-if-not-todo Deadlines in non-TODO entries become calendar events.
+todo-due Use deadlines in TODO entries as due-dates"
+ :group 'org-export-icalendar
+ :type '(set :greedy t
+ (const :tag "Deadlines in non-TODO entries become events"
+ event-if-not-todo)
+ (const :tag "Deadline in TODO entries become events"
+ event-if-todo)
+ (const :tag "Deadlines in TODO entries become due-dates"
+ todo-due)))
+
+(defcustom org-icalendar-use-scheduled '(todo-start)
+ "Contexts where iCalendar export should use a scheduling time stamp.
+This is a list with several symbols in it. Valid symbol are:
+
+event-if-todo Scheduling time stamps in TODO entries become an event.
+event-if-not-todo Scheduling time stamps in non-TODO entries become an event.
+todo-start Scheduling time stamps in TODO entries become start date.
+ Some calendar applications show TODO entries only after
+ that date."
+ :group 'org-export-icalendar
+ :type '(set :greedy t
+ (const :tag
+ "SCHEDULED timestamps in non-TODO entries become events"
+ event-if-not-todo)
+ (const :tag "SCHEDULED timestamps in TODO entries become events"
+ event-if-todo)
+ (const :tag "SCHEDULED in TODO entries become start date"
+ todo-start)))
+
+(defcustom org-icalendar-categories '(local-tags category)
+ "Items that should be entered into the categories field.
+This is a list of symbols, the following are valid:
+
+category The Org-mode category of the current file or tree
+todo-state The todo state, if any
+local-tags The tags, defined in the current line
+all-tags All tags, including inherited ones."
+ :group 'org-export-icalendar
+ :type '(repeat
+ (choice
+ (const :tag "The file or tree category" category)
+ (const :tag "The TODO state" todo-state)
+ (const :tag "Tags defined in current line" local-tags)
+ (const :tag "All tags, including inherited ones" all-tags))))
+
+(defcustom org-icalendar-include-todo nil
+ "Non-nil means, export to iCalendar files should also cover TODO items.
+Valid values are:
+nil don't inlcude any TODO items
+t include all TODO items that are not in a DONE state
+unblocked include all TODO idems that are not blocked
+all include both done and not done items."
+ :group 'org-export-icalendar
+ :type '(choice
+ (const :tag "None" nil)
+ (const :tag "Unfinished" t)
+ (const :tag "Unblocked" unblocked)
+ (const :tag "All" all)))
+
+(defcustom org-icalendar-include-bbdb-anniversaries nil
+ "Non-nil means, a combined iCalendar files should include anniversaries.
+The anniversaries are define in the BBDB database."
+ :group 'org-export-icalendar
+ :type 'boolean)
+
+(defcustom org-icalendar-include-sexps t
+ "Non-nil means, export to iCalendar files should also cover sexp entries.
+These are entries like in the diary, but directly in an Org-mode file."
+ :group 'org-export-icalendar
+ :type 'boolean)
+
+(defcustom org-icalendar-include-body 100
+ "Amount of text below headline to be included in iCalendar export.
+This is a number of characters that should maximally be included.
+Properties, scheduling and clocking lines will always be removed.
+The text will be inserted into the DESCRIPTION field."
+ :group 'org-export-icalendar
+ :type '(choice
+ (const :tag "Nothing" nil)
+ (const :tag "Everything" t)
+ (integer :tag "Max characters")))
+
+(defcustom org-icalendar-store-UID nil
+ "Non-nil means, store any created UIDs in properties.
+The iCalendar standard requires that all entries have a unique identifier.
+Org will create these identifiers as needed. When this variable is non-nil,
+the created UIDs will be stored in the ID property of the entry. Then the
+next time this entry is exported, it will be exported with the same UID,
+superceding the previous form of it. This is essential for
+synchronization services.
+This variable is not turned on by default because we want to avoid creating
+a property drawer in every entry if people are only playing with this feature,
+or if they are only using it locally."
+ :group 'org-export-icalendar
+ :type 'boolean)
+
+(defcustom org-icalendar-timezone (getenv "TZ")
+ "The time zone string for iCalendar export.
+When nil of the empty string, use the abbreviation retrieved from Emacs."
+ :group 'org-export-icalendar
+ :type '(choice
+ (const :tag "Unspecified" nil)
+ (string :tag "Time zone")))
+
+;;; iCalendar export
+
+;;;###autoload
+(defun org-export-icalendar-this-file ()
+ "Export current file as an iCalendar file.
+The iCalendar file will be located in the same directory as the Org-mode
+file, but with extension `.ics'."
+ (interactive)
+ (org-export-icalendar nil buffer-file-name))
+
+;;;###autoload
+(defun org-export-icalendar-all-agenda-files ()
+ "Export all files in `org-agenda-files' to iCalendar .ics files.
+Each iCalendar file will be located in the same directory as the Org-mode
+file, but with extension `.ics'."
+ (interactive)
+ (apply 'org-export-icalendar nil (org-agenda-files t)))
+
+;;;###autoload
+(defun org-export-icalendar-combine-agenda-files ()
+ "Export all files in `org-agenda-files' to a single combined iCalendar file.
+The file is stored under the name `org-combined-agenda-icalendar-file'."
+ (interactive)
+ (apply 'org-export-icalendar t (org-agenda-files t)))
+
+(defun org-export-icalendar (combine &rest files)
+ "Create iCalendar files for all elements of FILES.
+If COMBINE is non-nil, combine all calendar entries into a single large
+file and store it under the name `org-combined-agenda-icalendar-file'."
+ (save-excursion
+ (org-prepare-agenda-buffers files)
+ (let* ((dir (org-export-directory
+ :ical (list :publishing-directory
+ org-export-publishing-directory)))
+ file ical-file ical-buffer category started org-agenda-new-buffers)
+ (and (get-buffer "*ical-tmp*") (kill-buffer "*ical-tmp*"))
+ (when combine
+ (setq ical-file
+ (if (file-name-absolute-p org-combined-agenda-icalendar-file)
+ org-combined-agenda-icalendar-file
+ (expand-file-name org-combined-agenda-icalendar-file dir))
+ ical-buffer (org-get-agenda-file-buffer ical-file))
+ (set-buffer ical-buffer) (erase-buffer))
+ (while (setq file (pop files))
+ (catch 'nextfile
+ (org-check-agenda-file file)
+ (set-buffer (org-get-agenda-file-buffer file))
+ (unless combine
+ (setq ical-file (concat (file-name-as-directory dir)
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name))
+ ".ics"))
+ (setq ical-buffer (org-get-agenda-file-buffer ical-file))
+ (with-current-buffer ical-buffer (erase-buffer)))
+ (setq category (or org-category
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name))))
+ (if (symbolp category) (setq category (symbol-name category)))
+ (let ((standard-output ical-buffer))
+ (if combine
+ (and (not started) (setq started t)
+ (org-start-icalendar-file org-icalendar-combined-name))
+ (org-start-icalendar-file category))
+ (org-print-icalendar-entries combine)
+ (when (or (and combine (not files)) (not combine))
+ (when (and combine org-icalendar-include-bbdb-anniversaries)
+ (require 'org-bbdb)
+ (org-bbdb-anniv-export-ical))
+ (org-finish-icalendar-file)
+ (set-buffer ical-buffer)
+ (run-hooks 'org-before-save-iCalendar-file-hook)
+ (save-buffer)
+ (run-hooks 'org-after-save-iCalendar-file-hook)
+ (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
+ ))))
+ (org-release-buffers org-agenda-new-buffers))))
+
+(defvar org-before-save-iCalendar-file-hook nil
+ "Hook run before an iCalendar file has been saved.
+This can be used to modify the result of the export.")
+
+(defvar org-after-save-iCalendar-file-hook nil
+ "Hook run after an iCalendar file has been saved.
+The iCalendar buffer is still current when this hook is run.
+A good way to use this is to tell a desktop calendar application to re-read
+the iCalendar file.")
+
+(defvar org-agenda-default-appointment-duration) ; defined in org-agenda.el
+(defun org-print-icalendar-entries (&optional combine)
+ "Print iCalendar entries for the current Org-mode file to `standard-output'.
+When COMBINE is non nil, add the category to each line."
+ (require 'org-agenda)
+ (let ((re1 (concat org-ts-regexp "\\|<%%([^>\n]+>"))
+ (re2 (concat "--?-?\\(" org-ts-regexp "\\)"))
+ (dts (org-ical-ts-to-string
+ (format-time-string (cdr org-time-stamp-formats) (current-time))
+ "DTSTART"))
+ hd ts ts2 state status (inc t) pos b sexp rrule
+ scheduledp deadlinep todo prefix due start
+ tmp pri categories location summary desc uid
+ (sexp-buffer (get-buffer-create "*ical-tmp*")))
+ (org-refresh-category-properties)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward re1 nil t)
+ (catch :skip
+ (org-agenda-skip)
+ (when (boundp 'org-icalendar-verify-function)
+ (unless (funcall org-icalendar-verify-function)
+ (outline-next-heading)
+ (backward-char 1)
+ (throw :skip nil)))
+ (setq pos (match-beginning 0)
+ ts (match-string 0)
+ inc t
+ hd (condition-case nil
+ (org-icalendar-cleanup-string
+ (org-get-heading))
+ (error (throw :skip nil)))
+ summary (org-icalendar-cleanup-string
+ (org-entry-get nil "SUMMARY"))
+ desc (org-icalendar-cleanup-string
+ (or (org-entry-get nil "DESCRIPTION")
+ (and org-icalendar-include-body (org-get-entry)))
+ t org-icalendar-include-body)
+ location (org-icalendar-cleanup-string
+ (org-entry-get nil "LOCATION" 'selective))
+ uid (if org-icalendar-store-UID
+ (org-id-get-create)
+ (or (org-id-get) (org-id-new)))
+ categories (org-export-get-categories)
+ deadlinep nil scheduledp nil)
+ (if (looking-at re2)
+ (progn
+ (goto-char (match-end 0))
+ (setq ts2 (match-string 1)
+ inc (not (string-match "[0-9]\\{1,2\\}:[0-9][0-9]" ts2))))
+ (setq tmp (buffer-substring (max (point-min)
+ (- pos org-ds-keyword-length))
+ pos)
+ ts2 (if (string-match "[0-9]\\{1,2\\}:[0-9][0-9]-\\([0-9]\\{1,2\\}:[0-9][0-9]\\)" ts)
+ (progn
+ (setq inc nil)
+ (replace-match "\\1" t nil ts))
+ ts)
+ deadlinep (string-match org-deadline-regexp tmp)
+ scheduledp (string-match org-scheduled-regexp tmp)
+ todo (org-get-todo-state)
+ ;; donep (org-entry-is-done-p)
+ ))
+ (when (and
+ deadlinep
+ (if todo
+ (not (memq 'event-if-todo org-icalendar-use-deadline))
+ (not (memq 'event-if-not-todo org-icalendar-use-deadline))))
+ (throw :skip t))
+ (when (and
+ scheduledp
+ (if todo
+ (not (memq 'event-if-todo org-icalendar-use-scheduled))
+ (not (memq 'event-if-not-todo org-icalendar-use-scheduled))))
+ (throw :skip t))
+ (setq prefix (if deadlinep "DL-" (if scheduledp "SC-" "TS-")))
+ (if (or (string-match org-tr-regexp hd)
+ (string-match org-ts-regexp hd))
+ (setq hd (replace-match "" t t hd)))
+ (if (string-match "\\+\\([0-9]+\\)\\([dwmy]\\)>" ts)
+ (setq rrule
+ (concat "\nRRULE:FREQ="
+ (cdr (assoc
+ (match-string 2 ts)
+ '(("d" . "DAILY")("w" . "WEEKLY")
+ ("m" . "MONTHLY")("y" . "YEARLY"))))
+ ";INTERVAL=" (match-string 1 ts)))
+ (setq rrule ""))
+ (setq summary (or summary hd))
+ (if (string-match org-bracket-link-regexp summary)
+ (setq summary
+ (replace-match (if (match-end 3)
+ (match-string 3 summary)
+ (match-string 1 summary))
+ t t summary)))
+ (if deadlinep (setq summary (concat "DL: " summary)))
+ (if scheduledp (setq summary (concat "S: " summary)))
+ (if (string-match "\\`<%%" ts)
+ (with-current-buffer sexp-buffer
+ (insert (substring ts 1 -1) " " summary "\n"))
+ (princ (format "BEGIN:VEVENT
+UID: %s
+%s
+%s%s
+SUMMARY:%s%s%s
+CATEGORIES:%s
+END:VEVENT\n"
+ (concat prefix uid)
+ (org-ical-ts-to-string ts "DTSTART")
+ (org-ical-ts-to-string ts2 "DTEND" inc)
+ rrule summary
+ (if (and desc (string-match "\\S-" desc))
+ (concat "\nDESCRIPTION: " desc) "")
+ (if (and location (string-match "\\S-" location))
+ (concat "\nLOCATION: " location) "")
+ categories)))))
+ (when (and org-icalendar-include-sexps
+ (condition-case nil (require 'icalendar) (error nil))
+ (fboundp 'icalendar-export-region))
+ ;; Get all the literal sexps
+ (goto-char (point-min))
+ (while (re-search-forward "^&?%%(" nil t)
+ (catch :skip
+ (org-agenda-skip)
+ (setq b (match-beginning 0))
+ (goto-char (1- (match-end 0)))
+ (forward-sexp 1)
+ (end-of-line 1)
+ (setq sexp (buffer-substring b (point)))
+ (with-current-buffer sexp-buffer
+ (insert sexp "\n"))))
+ (princ (org-diary-to-ical-string sexp-buffer))
+ (kill-buffer sexp-buffer))
+
+ (when org-icalendar-include-todo
+ (setq prefix "TODO-")
+ (goto-char (point-min))
+ (while (re-search-forward org-todo-line-regexp nil t)
+ (catch :skip
+ (org-agenda-skip)
+ (when (boundp 'org-icalendar-verify-function)
+ (unless (save-match-data
+ (funcall org-icalendar-verify-function))
+ (outline-next-heading)
+ (backward-char 1)
+ (throw :skip nil)))
+ (setq state (match-string 2))
+ (setq status (if (member state org-done-keywords)
+ "COMPLETED" "NEEDS-ACTION"))
+ (when (and state
+ (cond
+ ;; check if the state is one we should use
+ ((eq org-icalendar-include-todo 'all)
+ ;; all should be included
+ t)
+ ((eq org-icalendar-include-todo 'unblocked)
+ ;; only undone entries that are not blocked
+ (and (member state org-not-done-keywords)
+ (or (not org-blocker-hook)
+ (save-match-data
+ (run-hook-with-args-until-failure
+ 'org-blocker-hook
+ (list :type 'todo-state-change
+ :position (point-at-bol)
+ :from 'todo
+ :to 'done))))))
+ ((eq org-icalendar-include-todo t)
+ ;; include everything that is not done
+ (member state org-not-done-keywords))))
+ (setq hd (match-string 3)
+ summary (org-icalendar-cleanup-string
+ (org-entry-get nil "SUMMARY"))
+ desc (org-icalendar-cleanup-string
+ (or (org-entry-get nil "DESCRIPTION")
+ (and org-icalendar-include-body (org-get-entry)))
+ t org-icalendar-include-body)
+ location (org-icalendar-cleanup-string
+ (org-entry-get nil "LOCATION" 'selective))
+ due (and (member 'todo-due org-icalendar-use-deadline)
+ (org-entry-get nil "DEADLINE"))
+ start (and (member 'todo-start org-icalendar-use-scheduled)
+ (org-entry-get nil "SCHEDULED"))
+ categories (org-export-get-categories)
+ uid (if org-icalendar-store-UID
+ (org-id-get-create)
+ (or (org-id-get) (org-id-new))))
+ (and due (setq due (org-ical-ts-to-string due "DUE")))
+ (and start (setq start (org-ical-ts-to-string start "DTSTART")))
+
+ (if (string-match org-bracket-link-regexp hd)
+ (setq hd (replace-match (if (match-end 3) (match-string 3 hd)
+ (match-string 1 hd))
+ t t hd)))
+ (if (string-match org-priority-regexp hd)
+ (setq pri (string-to-char (match-string 2 hd))
+ hd (concat (substring hd 0 (match-beginning 1))
+ (substring hd (match-end 1))))
+ (setq pri org-default-priority))
+ (setq pri (floor (- 9 (* 8. (/ (float (- org-lowest-priority pri))
+ (- org-lowest-priority org-highest-priority))))))
+
+ (princ (format "BEGIN:VTODO
+UID: %s
+%s
+SUMMARY:%s%s%s%s
+CATEGORIES:%s
+SEQUENCE:1
+PRIORITY:%d
+STATUS:%s
+END:VTODO\n"
+ (concat prefix uid)
+ (or start dts)
+ (or summary hd)
+ (if (and location (string-match "\\S-" location))
+ (concat "\nLOCATION: " location) "")
+ (if (and desc (string-match "\\S-" desc))
+ (concat "\nDESCRIPTION: " desc) "")
+ (if due (concat "\n" due) "")
+ categories
+ pri status)))))))))
+
+(defun org-export-get-categories ()
+ "Get categories according to `org-icalendar-categories'."
+ (let ((cs org-icalendar-categories) c rtn tmp)
+ (while (setq c (pop cs))
+ (cond
+ ((eq c 'category) (push (org-get-category) rtn))
+ ((eq c 'todo-state)
+ (setq tmp (org-get-todo-state))
+ (and tmp (push tmp rtn)))
+ ((eq c 'local-tags)
+ (setq rtn (append (nreverse (org-get-local-tags-at (point))) rtn)))
+ ((eq c 'all-tags)
+ (setq rtn (append (nreverse (org-get-tags-at (point))) rtn)))))
+ (mapconcat 'identity (nreverse rtn) ",")))
+
+(defun org-icalendar-cleanup-string (s &optional is-body maxlength)
+ "Take out stuff and quote what needs to be quoted.
+When IS-BODY is non-nil, assume that this is the body of an item, clean up
+whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
+characters."
+ (if (not s)
+ nil
+ (when is-body
+ (let ((re (concat "\\(" org-drawer-regexp "\\)[^\000]*?:END:.*\n?"))
+ (re2 (concat "^[ \t]*" org-keyword-time-regexp ".*\n?")))
+ (while (string-match re s) (setq s (replace-match "" t t s)))
+ (while (string-match re2 s) (setq s (replace-match "" t t s)))))
+ (let ((start 0))
+ (while (string-match "\\([,;]\\)" s start)
+ (setq start (+ (match-beginning 0) 2)
+ s (replace-match "\\\\\\1" nil nil s))))
+ (setq s (org-trim s))
+ (when is-body
+ (while (string-match "[ \t]*\n[ \t]*" s)
+ (setq s (replace-match "\\n" t t s))))
+ (if is-body
+ (if maxlength
+ (if (and (numberp maxlength)
+ (> (length s) maxlength))
+ (setq s (substring s 0 maxlength)))))
+ s))
+
+(defun org-icalendar-cleanup-string-rfc2455 (s &optional is-body maxlength)
+ "Take out stuff and quote what needs to be quoted.
+When IS-BODY is non-nil, assume that this is the body of an item, clean up
+whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
+characters.
+This seems to be more like RFC 2455, but it causes problems, so it is
+not used right now."
+ (if (not s)
+ nil
+ (if is-body
+ (let ((re (concat "\\(" org-drawer-regexp "\\)[^\000]*?:END:.*\n?"))
+ (re2 (concat "^[ \t]*" org-keyword-time-regexp ".*\n?")))
+ (while (string-match re s) (setq s (replace-match "" t t s)))
+ (while (string-match re2 s) (setq s (replace-match "" t t s)))
+ (setq s (org-trim s))
+ (while (string-match "[ \t]*\n[ \t]*" s)
+ (setq s (replace-match "\\n" t t s)))
+ (if maxlength
+ (if (and (numberp maxlength)
+ (> (length s) maxlength))
+ (setq s (substring s 0 maxlength)))))
+ (setq s (org-trim s)))
+ (while (string-match "\"" s) (setq s (replace-match "''" t t s)))
+ (when (string-match "[;,:]" s) (setq s (concat "\"" s "\"")))
+ s))
+
+(defun org-start-icalendar-file (name)
+ "Start an iCalendar file by inserting the header."
+ (let ((user user-full-name)
+ (name (or name "unknown"))
+ (timezone (if (> (length org-icalendar-timezone) 0)
+ org-icalendar-timezone
+ (cadr (current-time-zone)))))
+ (princ
+ (format "BEGIN:VCALENDAR
+VERSION:2.0
+X-WR-CALNAME:%s
+PRODID:-//%s//Emacs with Org-mode//EN
+X-WR-TIMEZONE:%s
+CALSCALE:GREGORIAN\n" name user timezone))))
+
+(defun org-finish-icalendar-file ()
+ "Finish an iCalendar file by inserting the END statement."
+ (princ "END:VCALENDAR\n"))
+
+(defun org-ical-ts-to-string (s keyword &optional inc)
+ "Take a time string S and convert it to iCalendar format.
+KEYWORD is added in front, to make a complete line like DTSTART....
+When INC is non-nil, increase the hour by two (if time string contains
+a time), or the day by one (if it does not contain a time)."
+ (let ((t1 (org-parse-time-string s 'nodefault))
+ t2 fmt have-time time)
+ (if (and (car t1) (nth 1 t1) (nth 2 t1))
+ (setq t2 t1 have-time t)
+ (setq t2 (org-parse-time-string s)))
+ (let ((s (car t2)) (mi (nth 1 t2)) (h (nth 2 t2))
+ (d (nth 3 t2)) (m (nth 4 t2)) (y (nth 5 t2)))
+ (when inc
+ (if have-time
+ (if org-agenda-default-appointment-duration
+ (setq mi (+ org-agenda-default-appointment-duration mi))
+ (setq h (+ 2 h)))
+ (setq d (1+ d))))
+ (setq time (encode-time s mi h d m y)))
+ (setq fmt (if have-time ":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
+ (concat keyword (format-time-string fmt time))))
+
+(provide 'org-icalendar)
+
+;; arch-tag: 2dee2b6e-9211-4aee-8a47-a3c7e5bc30cf
+
+;;; org-icalendar.el ends here
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
:tag "Org ID"
:group 'org)
+(defcustom org-id-uuid-program "uuidgen"
+ "The uuidgen program."
+ :group 'org-id
+ :type 'string)
(defcustom org-id-method
(condition-case nil
(if (string-match "\\`[-0-9a-fA-F]\\{36\\}\\'"
- (org-trim (shell-command-to-string "uuidgen")))
+ (org-trim (shell-command-to-string
+ org-id-uuid-program)))
'uuidgen
'org)
(error 'org))
"Copy the ID of the entry at point to the kill ring.
Create an ID if necessary."
(interactive)
- (kill-new (org-id-get nil 'create)))
+ (org-kill-new (org-id-get nil 'create)))
;;;###autoload
(defun org-id-get (&optional pom create prefix)
(let* ((org-refile-targets (or targets '((nil . (:maxlevel . 10)))))
(org-refile-use-outline-path
(if (caar org-refile-targets) 'file t))
+ (org-refile-target-verify-function nil)
(spos (org-refile-get-location "Entry: "))
(pom (and spos (move-marker (make-marker) (nth 3 spos)
(get-file-buffer (nth 1 spos))))))
(if (equal prefix ":") (setq prefix ""))
(cond
((eq org-id-method 'uuidgen)
- (setq unique (org-trim (shell-command-to-string "uuidgen"))))
+ (setq unique (org-trim (shell-command-to-string org-id-uuid-program))))
((eq org-id-method 'org)
(let* ((etime (org-id-reverse-string (org-id-time-to-b36)))
(postfix (if org-id-include-domain
(defun org-id-open (id)
"Go to the entry with id ID."
(org-mark-ring-push)
- (let ((m (org-id-find id 'marker)))
+ (let ((m (org-id-find id 'marker))
+ cmd)
(unless m
(error "Cannot find entry with ID \"%s\"" id))
+ ;; Use a buffer-switching command in analogy to finding files
+ (setq cmd
+ (or
+ (cdr
+ (assq
+ (cdr (assq 'file org-link-frame-setup))
+ '((find-file . switch-to-buffer)
+ (find-file-other-window . switch-to-buffer-other-window)
+ (find-file-other-frame . switch-to-buffer-other-frame))))
+ 'switch-to-buffer-other-window))
(if (not (equal (current-buffer) (marker-buffer m)))
- (switch-to-buffer-other-window (marker-buffer m)))
+ (funcall cmd (marker-buffer m)))
(goto-char m)
(move-marker m nil)
(org-show-context)))
--- /dev/null
+;;; org-indent.el --- Dynamic indentation for Org-mode
+;; Copyright (C) 2008 Free Software Foundation, Inc.
+;;
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; This file is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+
+;; This is an implementation of dynamic virtual indentation. It works
+;; by adding text properties to a buffer to make sure lines are
+;; indented according to outline structure.
+
+(require 'org-macs)
+(require 'org-compat)
+(require 'org)
+(eval-when-compile
+ (require 'cl))
+
+
+(defgroup org-indent nil
+ "Options concerning dynamic virtual outline indentation."
+ :tag "Org Structure"
+ :group 'org)
+
+(defconst org-indent-max 40
+ "Maximum indentation in characters")
+(defconst org-indent-max-levels 40
+ "Maximum indentation in characters")
+
+(defvar org-indent-strings nil
+ "Vector with all indentation strings.
+It will be set in `org-indent-initialize'.")
+(defvar org-indent-stars nil
+ "Vector with all indentation star strings.
+It will be set in `org-indent-initialize'.")
+(defvar org-hide-leading-stars-before-indent-mode nil
+ "Used locally")
+
+(defcustom org-indent-boundary-char ?\ ; comment to protect space char
+ "The end of the virtual indentation strings, a single-character string.
+The default is just a space, but if you wish, you can use \"|\" or so.
+This can be useful on a terminal window - under a windowing system,
+it may be prettier to customize the org-indent face."
+ :group 'org-indent
+ :set (lambda (var val)
+ (set var val)
+ (and org-indent-strings (org-indent-initialize)))
+ :type 'character)
+
+(defcustom org-indent-mode-turns-off-org-adapt-indentation t
+ "Non-nil means, turning on org-indent-mode turns off indentation adaptation.
+For details see the variable `org-adapt-indentation'."
+ :group 'org-indent
+ :type 'boolean)
+
+(defcustom org-indent-mode-turns-on-hiding-stars t
+ "Non-nil means, turning on org-indent-mode turns on `org-hide-leading-stars'."
+ :group 'org-indent
+ :type 'boolean)
+
+(defcustom org-indent-indentation-per-level 2
+ "Indentation per level in number of characters."
+ :group 'org-indent
+ :type 'integer)
+
+(defcustom org-indent-fix-section-after-idle-time 0.2
+ "Seconds of idle time before fixing virtual indentation of section.
+The hooking-in of virtual indentation is not yet perfect. Occasionally,
+a change does not trigger to proper change of indentation. For this we
+have a timer action that fixes indentation in the current section after
+a short amount idle time. If we ever get the integration to work perfectly,
+this variable can be set to nil to get rid of the timer."
+ :group 'org-indent
+ :type '(choice
+ (const "Do not install idle timer" nil)
+ (number :tag "Idle time")))
+
+(defun org-indent-initialize ()
+ "Initialize the indentation strings and set the idle timer."
+ ;; We use an idle timer to "repair" the current section, because the
+ ;; redisplay seems to have some problems.
+ (unless org-indent-strings
+ (when org-indent-fix-section-after-idle-time
+ (run-with-idle-timer
+ org-indent-fix-section-after-idle-time
+ t 'org-indent-refresh-section)))
+ ;; Initialize the indentation and star vectors
+ (setq org-indent-strings (make-vector (1+ org-indent-max) nil))
+ (setq org-indent-stars (make-vector (1+ org-indent-max) nil))
+ (aset org-indent-strings 0 "")
+ (aset org-indent-stars 0 "")
+ (loop for i from 1 to org-indent-max do
+ (aset org-indent-strings i
+ (org-add-props
+ (concat (make-string (1- i) ?\ )
+ (char-to-string org-indent-boundary-char))
+ nil 'face 'org-indent)))
+ (loop for i from 1 to org-indent-max-levels do
+ (aset org-indent-stars i
+ (org-add-props (make-string i ?*)
+ nil 'face 'org-hide))))
+
+;;;###autoload
+(define-minor-mode org-indent-mode
+ "When active, indent text according to outline structure.
+
+Internally this works by adding `line-prefix' properties to all non-headlines.
+These properties are updated locally in idle time.
+FIXME: How to update when broken?"
+ nil " Ind" nil
+ (if (org-bound-and-true-p org-inhibit-startup)
+ (setq org-indent-mode nil)
+ (if org-indent-mode
+ (progn
+ (or org-indent-strings (org-indent-initialize))
+ (when org-indent-mode-turns-off-org-adapt-indentation
+ (org-set-local 'org-adapt-indentation nil))
+ (when org-indent-mode-turns-on-hiding-stars
+ (org-set-local 'org-hide-leading-stars-before-indent-mode
+ org-hide-leading-stars)
+ (org-set-local 'org-hide-leading-stars t))
+ (make-local-variable 'buffer-substring-filters)
+ (add-to-list 'buffer-substring-filters
+ 'org-indent-remove-properties-from-string)
+ (org-add-hook 'org-after-demote-entry-hook
+ 'org-indent-refresh-section nil 'local)
+ (org-add-hook 'org-after-promote-entry-hook
+ 'org-indent-refresh-section nil 'local)
+ (org-add-hook 'org-font-lock-hook
+ 'org-indent-refresh-to nil 'local)
+ (and font-lock-mode (org-restart-font-lock))
+ )
+ (save-excursion
+ (save-restriction
+ (org-indent-remove-properties (point-min) (point-max))
+ (kill-local-variable 'org-adapt-indentation)
+ (when (boundp 'org-hide-leading-stars-before-indent-mode)
+ (org-set-local 'org-hide-leading-stars
+ org-hide-leading-stars-before-indent-mode))
+ (setq buffer-substring-filters
+ (delq 'org-indent-remove-properties-from-string
+ buffer-substring-filters))
+ (remove-hook 'org-after-promote-entry-hook
+ 'org-indent-refresh-section 'local)
+ (remove-hook 'org-after-demote-entry-hook
+ 'org-indent-refresh-section 'local)
+ (and font-lock-mode (org-restart-font-lock))
+ (redraw-display))))))
+
+
+(defface org-indent
+ (org-compatible-face nil nil)
+ "Face for outline indentation.
+The default is to make it look like whitespace. But you may find it
+useful to make it evver so slightly different."
+ :group 'org-faces)
+
+(defun org-indent-indent-buffer ()
+ "Add indentation properties for the whole buffer."
+ (interactive)
+ (when org-indent-mode
+ (save-excursion
+ (save-restriction
+ (widen)
+ (org-indent-remove-properties (point-min) (point-max))
+ (org-indent-add-properties (point-min) (point-max))))))
+
+(defun org-indent-remove-properties (beg end)
+ "Remove indentations between BEG and END."
+ (org-unmodified
+ (remove-text-properties beg end '(line-prefix nil wrap-prefix nil))))
+
+(defun org-indent-remove-properties-from-string (string)
+ "Remove indentations between BEG and END."
+ (remove-text-properties 0 (length string)
+ '(line-prefix nil wrap-prefix nil) string)
+ string)
+
+(defvar org-indent-outline-re (concat "^" org-outline-regexp)
+ "Outline heading regexp.")
+
+(defun org-indent-add-properties (beg end)
+ "Add indentation properties between BEG and END.
+Assumes that BEG is at the beginning of a line."
+ (when (or t org-indent-mode)
+ (let (ov b e n level exit nstars)
+ (org-unmodified
+ (save-excursion
+ (goto-char beg)
+ (while (not exit)
+ (setq e end)
+ (if (not (re-search-forward org-indent-outline-re nil t))
+ (setq e (point-max) exit t)
+ (setq e (match-beginning 0))
+ (if (>= e end) (setq exit t))
+ (setq level (- (match-end 0) (match-beginning 0) 1))
+ (setq nstars (- (* (1- level) org-indent-indentation-per-level)
+ (1- level)))
+ (add-text-properties
+ (point-at-bol) (point-at-eol)
+ (list 'line-prefix
+ (aref org-indent-stars nstars)
+ 'wrap-prefix
+ (aref org-indent-strings
+ (* level org-indent-indentation-per-level)))))
+ (when (and b (> e b))
+ (add-text-properties
+ b e (list 'line-prefix (aref org-indent-strings n)
+ 'wrap-prefix (aref org-indent-strings n))))
+ (setq b (1+ (point-at-eol))
+ n (* level org-indent-indentation-per-level))))))))
+
+(defun org-indent-refresh-section ()
+ "Refresh indentation properties in the current outline section.
+Point is assumed to be at the beginning of a headline."
+ (interactive)
+ (when org-indent-mode
+ (let (beg end)
+ (save-excursion
+ (when (ignore-errors (org-back-to-heading))
+ (setq beg (point))
+ (setq end (or (save-excursion (or (outline-next-heading) (point)))))
+ (org-indent-remove-properties beg end)
+ (org-indent-add-properties beg end))))))
+
+(defun org-indent-refresh-to (limit)
+ "Refresh indentation properties in the current outline section.
+Point is assumed to be at the beginning of a headline."
+ (interactive)
+ (when org-indent-mode
+ (let ((beg (point)) (end limit))
+ (save-excursion
+ (and (ignore-errors (org-back-to-heading t))
+ (setq beg (point))))
+ (org-indent-remove-properties beg end)
+ (org-indent-add-properties beg end)))
+ (goto-char limit))
+
+(defun org-indent-refresh-subtree ()
+ "Refresh indentation properties in the current outline subtree.
+Point is assumed to be at the beginning of a headline."
+ (interactive)
+ (when org-indent-mode
+ (save-excursion
+ (let (beg end)
+ (setq beg (point))
+ (setq end (save-excursion (org-end-of-subtree t t)))
+ (org-indent-remove-properties beg end)
+ (org-indent-add-properties beg end)))))
+
+(defun org-indent-refresh-buffer ()
+ "Refresh indentation properties in the current outline subtree.
+Point is assumed to be at the beginning of a headline."
+ (interactive)
+ (when org-indent-mode
+ (org-indent-mode -1)
+ (org-indent-mode 1)))
+
+(provide 'org-indent)
+
+;;; org-indent.el ends here
+
+
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
--- /dev/null
+;;; org-inlinetask.el --- Tasks independent of outline hierarchy
+;; Copyright (C) 2009 Free Software Foundation, Inc.
+;;
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is not yet part of GNU Emacs.
+;;
+;; GNU Emacs is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+;;
+;; This module implements inline tasks in Org-mode. Inline tasks are
+;; tasks that have all the properties of normal outline nodes, including
+;; the ability to store meta data like scheduling dates, TODO state, tags
+;; and properties. However, these nodes are treated specially by the
+;; visibility cycling and export commands.
+;;
+;; Visibility cycling exempts these nodes from cycling. So whenever their
+;; parent is opened, so are these tasks. This will only work with
+;; `org-cycle', so if you are also using orther commands to show/hide
+;; entries, you will occasionally find these tasks to behave like
+;; all other outline nodes, seemingly splitting the text of the parent
+;; into children.
+;;
+;; Export commands do not treat these nodes as part of the sectioning
+;; structure, but as a special inline text that is either removed, or
+;; formatted in some special way.
+;;
+;; Special fontification of inline tasks, so that they can be immediately
+;; recognized. From the stars of the headline, only the first and the
+;; last two will be visible, the others will be hidden using the
+;; `org-hide' face.
+;;
+;; An inline task is identified solely by a minimum outline level, given
+;; by the variable `org-inlinetask-min-level', default 15.
+;;
+;; Inline tasks are normally assumed to contain at most a time planning
+;; line (DEADLINE etc) after it, and then any number of drawers, for
+;; example LOGBOOK of PROPERTIES. No empty lines are allowed.
+;; If you need to have normal text as part of an inline task, you
+;; can do so by adding an "END" headline with the same number of stars,
+;; for example
+;;
+;; **************** TODO some small task
+;; DEADLINE: <2009-03-30 Mon>
+;; :PROPERTIES:
+;; :SOMETHING: or other
+;; :END:
+;; And here is some extra text
+;; **************** END
+;;
+;; Also, if you want to use refiling and archiving for inline tasks,
+;; The END line must be present to make things work properly.
+;;
+;; This package installs one new comand:
+;;
+;; C-c C-x t Insert a new inline task with END line
+
+
+;;; Code
+
+(require 'org)
+
+(defgroup org-inlinetask nil
+ "Options concerning inline tasks in Org mode."
+ :tag "Org Inline Tasks"
+ :group 'org-structure)
+
+(defcustom org-inlinetask-min-level 15
+ "Minimum level a headline must have before it is treated as an inline task.
+It is strongly recommended that you set `org-cycle-max-level' not at all,
+or to a number smaller than this one. In fact, when `org-cycle-max-level' is
+not set, it will be assumed to be one less than the value of smaller than
+the value of this variable."
+ :group 'org-inlinetask
+ :type 'boolean)
+
+(defcustom org-inlinetask-export 'arrow+content
+ "What should be done with inlinetasks upon export?
+Possible values:
+
+nil Remove entirely, headline and \"content\"
+arrow Insert heading in bold, preceeded by an arrow
+arrow+content Insert arrow and headline, add content below in an
+ #+begin_example box (ugly, but works for now)
+
+The \"content\" of an inline task is the material below the planning
+line and any drawers, up to a lines wit the same number of stars,
+but containing only the word END."
+ :group 'org-inlinetask
+ :group 'org-export-general
+ :type '(choice
+ (const :tag "Remove entirely" nil)
+ (const :tag "Headline preceeded by arrow" arrow)
+ (const :tag "Arrow, headline, + content" arrow+content)))
+
+(defvar org-odd-levels-only)
+(defvar org-keyword-time-regexp)
+(defvar org-drawer-regexp)
+(defvar org-complex-heading-regexp)
+(defvar org-property-end-re)
+
+(defun org-inlinetask-insert-task ()
+ "Insert an inline task."
+ (interactive)
+ (or (bolp) (newline))
+ (insert (make-string org-inlinetask-min-level ?*) " \n"
+ (make-string org-inlinetask-min-level ?*) " END\n")
+ (end-of-line -1))
+(define-key org-mode-map "\C-c\C-xt" 'org-inlinetask-insert-task)
+
+(defun org-inlinetask-export-handler ()
+ "Handle headlines with level larger or equal to `org-inlinetask-min-level'.
+Either remove headline and meta data, or do special formatting."
+ (goto-char (point-min))
+ (let* ((nstars (if org-odd-levels-only
+ (1- (* 2 (or org-inlinetask-min-level 200)))
+ (or org-inlinetask-min-level 200)))
+ (re1 (format "^\\(\\*\\{%d,\\}\\) .*\n" nstars))
+ (re2 (concat "^[ \t]*" org-keyword-time-regexp))
+ headline beg end stars content)
+ (while (re-search-forward re1 nil t)
+ (setq headline (match-string 0)
+ stars (match-string 1)
+ content nil)
+ (replace-match "")
+ (while (looking-at re2)
+ (delete-region (point) (1+ (point-at-eol))))
+ (while (looking-at org-drawer-regexp)
+ (setq beg (point))
+ (if (re-search-forward org-property-end-re nil t)
+ (delete-region beg (1+ (match-end 0)))))
+ (setq beg (point))
+ (when (and (re-search-forward "^\\(\\*+\\) " nil t)
+ (= (length (match-string 1)) (length stars))
+ (progn (goto-char (match-end 0))
+ (looking-at "END[ \t]*$")))
+ (setq content (buffer-substring beg (1- (point-at-bol))))
+ (delete-region beg (1+ (match-end 0))))
+ (goto-char beg)
+ (when (and org-inlinetask-export
+ (string-match org-complex-heading-regexp headline))
+ (when (memq org-inlinetask-export '(arrow+content arrow))
+ (insert "\n\n\\Rightarrow\\Rightarrow\\Rightarrow *"
+ (if (match-end 2) (concat (match-string 2 headline) " ") "")
+ (match-string 4 headline) "*\n"))
+ (when (and content (eq org-inlinetask-export 'arrow+content))
+ (insert "#+BEGIN_EXAMPLE\n" content "\n#+END_EXAMPLE\n"))
+ (insert "\n")))))
+
+(defun org-inlinetask-fontify (limit)
+ "Fontify the inline tasks."
+ (let* ((nstars (if org-odd-levels-only
+ (1- (* 2 (or org-inlinetask-min-level 200)))
+ (or org-inlinetask-min-level 200)))
+ (re (concat "^\\(\\*\\)\\(\\*\\{"
+ (format "%d" (- nstars 3))
+ ",\\}\\)\\(\\*\\* .*\\)")))
+ (while (re-search-forward re limit t)
+ (add-text-properties (match-beginning 1) (match-end 1)
+ '(face org-warning font-lock-fontified t))
+ (add-text-properties (match-beginning 2) (match-end 2)
+ '(face org-hide font-lock-fontified t))
+ (add-text-properties (match-beginning 3) (match-end 3)
+ '(face shadow font-lock-fontified t)))))
+
+(defun org-inlinetask-remove-END-maybe ()
+ "Remove an END line when present."
+ (when (looking-at (format "\\([ \t]*\n\\)*\\*\\{%d,\\}[ \t]+END[ \t]*$"
+ org-inlinetask-min-level))
+ (replace-match "")))
+
+(eval-after-load "org-exp"
+ '(add-hook 'org-export-preprocess-after-tree-selection-hook
+ 'org-inlinetask-export-handler))
+(eval-after-load "org"
+ '(add-hook 'org-font-lock-hook 'org-inlinetask-fontify))
+
+(provide 'org-inlinetask)
+
+;;; org-inlinetask.el ends here
+
;;
;; Author: Philip Jackson <emacs@shellarchive.co.uk>
;; Keywords: erc, irc, link, org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;;; Code:
(require 'org-exp)
+(require 'org-html)
(add-to-list 'org-export-inbuffer-options-extra '("INFOJS_OPT" :infojs-opt))
(add-hook 'org-export-options-filters 'org-infojs-handle-options)
<!--/*--><![CDATA[/*><!--*/
%MANAGER_OPTIONS
org_html_manager.setup(); // activate after the parameters are set
-/*]]>*/-->
+/*]]>*///-->
</script>"
"The template for the export style additions when org-info.js is used.
Option settings will replace the %MANAGER-OPTIONS cookie."
--- /dev/null
+;;; org-latex.el --- LaTeX exporter for org-mode
+;;
+;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
+;;
+;; Emacs Lisp Archive Entry
+;; Filename: org-latex.el
+;; Version: 6.29c
+;; Author: Bastien Guerry <bzg AT altern DOT org>
+;; Maintainer: Carsten Dominik <carsten.dominik AT gmail DOT com>
+;; Keywords: org, wp, tex
+;; Description: Converts an org-mode buffer into LaTeX
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; This library implements a LaTeX exporter for org-mode.
+;;
+;; It is part of Org and will be autoloaded
+;;
+;; The interactive functions are similar to those of the HTML exporter:
+;;
+;; M-x `org-export-as-latex'
+;; M-x `org-export-as-pdf'
+;; M-x `org-export-as-pdf-and-open'
+;; M-x `org-export-as-latex-batch'
+;; M-x `org-export-as-latex-to-buffer'
+;; M-x `org-export-region-as-latex'
+;; M-x `org-replace-region-by-latex'
+;;
+;;; Code:
+
+(eval-when-compile
+ (require 'cl))
+
+(require 'footnote)
+(require 'org)
+(require 'org-exp)
+
+;;; Variables:
+(defvar org-export-latex-class nil)
+(defvar org-export-latex-header nil)
+(defvar org-export-latex-append-header nil)
+(defvar org-export-latex-options-plist nil)
+(defvar org-export-latex-todo-keywords-1 nil)
+(defvar org-export-latex-complex-heading-re nil)
+(defvar org-export-latex-not-done-keywords nil)
+(defvar org-export-latex-done-keywords nil)
+(defvar org-export-latex-display-custom-times nil)
+(defvar org-export-latex-all-targets-re nil)
+(defvar org-export-latex-add-level 0)
+(defvar org-export-latex-sectioning "")
+(defvar org-export-latex-sectioning-depth 0)
+(defvar org-export-latex-special-keyword-regexp
+ (concat "\\<\\(" org-scheduled-string "\\|"
+ org-deadline-string "\\|"
+ org-closed-string"\\)")
+ "Regexp matching special time planning keywords plus the time after it.")
+
+(defvar latexp) ; dynamically scoped from org.el
+(defvar re-quote) ; dynamically scoped from org.el
+(defvar commentsp) ; dynamically scoped from org.el
+
+;;; User variables:
+
+(defgroup org-export-latex nil
+ "Options for exporting Org-mode files to LaTeX."
+ :tag "Org Export LaTeX"
+ :group 'org-export)
+
+(defcustom org-export-latex-default-class "article"
+ "The default LaTeX class."
+ :group 'org-export-latex
+ :type '(string :tag "LaTeX class"))
+
+(defcustom org-export-latex-classes
+ '(("article"
+ "\\documentclass[11pt]{article}
+\\usepackage[utf8]{inputenc}
+\\usepackage[T1]{fontenc}
+\\usepackage{graphicx}
+\\usepackage{longtable}
+\\usepackage{hyperref}"
+ ("\\section{%s}" . "\\section*{%s}")
+ ("\\subsection{%s}" . "\\subsection*{%s}")
+ ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
+ ("\\paragraph{%s}" . "\\paragraph*{%s}")
+ ("\\subparagraph{%s}" . "\\subparagraph*{%s}"))
+ ("report"
+ "\\documentclass[11pt]{report}
+\\usepackage[utf8]{inputenc}
+\\usepackage[T1]{fontenc}
+\\usepackage{graphicx}
+\\usepackage{longtable}
+\\usepackage{hyperref}"
+ ("\\part{%s}" . "\\part*{%s}")
+ ("\\chapter{%s}" . "\\chapter*{%s}")
+ ("\\section{%s}" . "\\section*{%s}")
+ ("\\subsection{%s}" . "\\subsection*{%s}")
+ ("\\subsubsection{%s}" . "\\subsubsection*{%s}"))
+ ("book"
+ "\\documentclass[11pt]{book}
+\\usepackage[utf8]{inputenc}
+\\usepackage[T1]{fontenc}
+\\usepackage{graphicx}
+\\usepackage{longtable}
+\\usepackage{hyperref}"
+ ("\\part{%s}" . "\\part*{%s}")
+ ("\\chapter{%s}" . "\\chapter*{%s}")
+ ("\\section{%s}" . "\\section*{%s}")
+ ("\\subsection{%s}" . "\\subsection*{%s}")
+ ("\\subsubsection{%s}" . "\\subsubsection*{%s}")))
+ "Alist of LaTeX classes and associated header and structure.
+If #+LaTeX_CLASS is set in the buffer, use its value and the
+associated information. Here is the structure of each cell:
+
+ \(class-name
+ header-string
+ (numbered-section . unnumbered-section\)
+ ...\)
+
+A %s formatter is mandatory in each section string and will be
+replaced by the title of the section.
+
+Instead of a cons cell (numbered . unnumbered), you can also provide a list
+of 2-4 elements,
+
+ (numbered-open numbered-close)
+
+or
+
+ (numbered-open numbered-close unnumbered-open unnumbered-close)
+
+providing opening and closing strings for an environment that should
+represent the document section. The opening clause should have a %s
+to represent the section title."
+ :group 'org-export-latex
+ :type '(repeat
+ (list (string :tag "LaTeX class")
+ (string :tag "LaTeX header")
+ (repeat :tag "Levels" :inline t
+ (choice
+ (cons :tag "Heading"
+ (string :tag "numbered")
+ (string :tag "unnumbered)"))
+ (list :tag "Environment"
+ (string :tag "Opening (numbered) ")
+ (string :tag "Closing (numbered) ")
+ (string :tag "Opening (unnumbered)")
+ (string :tag "Closing (unnumbered)")))))))
+
+(defcustom org-export-latex-emphasis-alist
+ '(("*" "\\textbf{%s}" nil)
+ ("/" "\\emph{%s}" nil)
+ ("_" "\\underline{%s}" nil)
+ ("+" "\\texttt{%s}" nil)
+ ("=" "\\verb" t)
+ ("~" "\\verb" t))
+ "Alist of LaTeX expressions to convert emphasis fontifiers.
+Each element of the list is a list of three elements.
+The first element is the character used as a marker for fontification.
+The second element is a formatting string to wrap fontified text with.
+If it is \"\\verb\", Org will automatically select a deimiter
+character that is not in the string.
+The third element decides whether to protect converted text from other
+conversions."
+ :group 'org-export-latex
+ :type 'alist)
+
+(defcustom org-export-latex-title-command "\\maketitle"
+ "The command used to insert the title just after \\begin{document}.
+If this string contains the formatting specification \"%s\" then
+it will be used as a formatting string, passing the title as an
+argument."
+ :group 'org-export-latex
+ :type 'string)
+
+(defcustom org-export-latex-import-inbuffer-stuff nil
+ "Non-nil means define TeX macros for Org's inbuffer definitions.
+For example \orgTITLE for #+TITLE."
+ :group 'org-export-latex
+ :type 'boolean)
+
+(defcustom org-export-latex-date-format
+ "%d %B %Y"
+ "Format string for \\date{...}."
+ :group 'org-export-latex
+ :type 'string)
+
+(defcustom org-export-latex-todo-keyword-markup "\\textbf{%s}"
+ "Markup for TODO keywords, as a printf format.
+This can be a single format for all keywords, a cons cell with separate
+formats for not-done and done states, or an association list with setup
+for individual keywords. If a keyword shows up for which there is no
+markup defined, the first one in the association list will be used."
+ :group 'org-export-latex
+ :type '(choice
+ (string :tag "Default")
+ (cons :tag "Distinguish undone and done"
+ (string :tag "Not-DONE states")
+ (string :tag "DONE states"))
+ (repeat :tag "Per keyword markup"
+ (cons
+ (string :tag "Keyword")
+ (string :tag "Markup")))))
+
+(defcustom org-export-latex-timestamp-markup "\\textit{%s}"
+ "A printf format string to be applied to time stamps."
+ :group 'org-export-latex
+ :type 'string)
+
+(defcustom org-export-latex-timestamp-keyword-markup "\\texttt{%s}"
+ "A printf format string to be applied to time stamps."
+ :group 'org-export-latex
+ :type 'string)
+
+(defcustom org-export-latex-tables-verbatim nil
+ "When non-nil, tables are exported verbatim."
+ :group 'org-export-latex
+ :type 'boolean)
+
+(defcustom org-export-latex-tables-centered t
+ "When non-nil, tables are exported in a center environment."
+ :group 'org-export-latex
+ :type 'boolean)
+
+(defcustom org-export-latex-tables-column-borders nil
+ "When non-nil, grouping columns can cause outer vertical lines in tables.
+When nil, grouping causes only separation lines between groups."
+ :group 'org-export-latex
+ :type 'boolean)
+
+(defcustom org-export-latex-packages-alist nil
+ "Alist of packages to be inserted in the header.
+Each cell is of the forma \( \"option\" . \"package\" \)."
+ :group 'org-export-latex
+ :type 'alist)
+
+(defcustom org-export-latex-low-levels 'itemize
+ "How to convert sections below the current level of sectioning.
+This is specified by the `org-export-headline-levels' option or the
+value of \"H:\" in Org's #+OPTION line.
+
+This can be either nil (skip the sections), `description', `itemize',
+or `enumerate' (convert the sections as the corresponding list type), or
+a string to be used instead of \\section{%s}. In this latter case,
+the %s stands here for the inserted headline and is mandatory.
+
+It may also be a list of three string to define a user-defined environment
+that should be used. The first string should be the like
+\"\\begin{itemize}\", the second should be like \"\\item %s %s\" with up
+to two occurrences of %s for the title and a lable, respectively. The third
+string should be like \"\\end{itemize\"."
+ :group 'org-export-latex
+ :type '(choice (const :tag "Ignore" nil)
+ (const :tag "Convert as descriptive list" description)
+ (const :tag "Convert as itemized list" itemize)
+ (const :tag "Convert as enumerated list" enumerate)
+ (list :tag "User-defined environment"
+ :value ("\\begin{itemize}" "\\end{itemize}" "\\item %s")
+ (string :tag "Start")
+ (string :tag "End")
+ (string :tag "item"))
+ (string :tag "Use a section string" :value "\\subparagraph{%s}")))
+
+(defcustom org-export-latex-list-parameters
+ '(:cbon "\\texttt{[X]}" :cboff "\\texttt{[ ]}")
+ "Parameters for the LaTeX list exporter.
+These parameters will be passed on to `org-list-to-latex', which in turn
+will pass them (combined with the LaTeX default list parameters) to
+`org-list-to-generic'."
+ :group 'org-export-latex
+ :type 'plist)
+
+(defcustom org-export-latex-verbatim-wrap
+ '("\\begin{verbatim}\n" . "\\end{verbatim}\n")
+ "Environment to be wrapped around a fixed-width section in LaTeX export.
+This is a cons with two strings, to be added before and after the
+fixed-with text.
+
+Defaults to \\begin{verbatim} and \\end{verbatim}."
+ :group 'org-export-translation
+ :group 'org-export-latex
+ :type '(cons (string :tag "Open")
+ (string :tag "Close")))
+
+(defcustom org-export-latex-remove-from-headlines
+ '(:todo nil :priority nil :tags nil)
+ "A plist of keywords to remove from headlines. OBSOLETE.
+Non-nil means remove this keyword type from the headline.
+
+Don't remove the keys, just change their values.
+
+Obsolete, this variable is no longer used. Use the separate
+variables `org-export-with-todo-keywords', `org-export-with-priority',
+and `org-export-with-tags' instead."
+ :type 'plist
+ :group 'org-export-latex)
+
+(defcustom org-export-latex-image-default-option "width=10em"
+ "Default option for images."
+ :group 'org-export-latex
+ :type 'string)
+
+(defcustom org-export-latex-inline-image-extensions
+ '("pdf" "jpeg" "jpg" "png" "ps" "eps")
+ "Extensions of image files that can be inlined into LaTeX.
+Note that the image extension *actually* allowed depend on the way the
+LaTeX file is processed. When used with pdflatex, pdf, jpg and png images
+are OK. When processing through dvi to Postscript, only ps and eps are
+allowed. The default we use here encompasses both."
+ :group 'org-export-latex
+ :type '(repeat (string :tag "Extension")))
+
+(defcustom org-export-latex-coding-system nil
+ "Coding system for the exported LaTex file."
+ :group 'org-export-latex
+ :type 'coding-system)
+
+(defgroup org-export-pdf nil
+ "Options for exporting Org-mode files to PDF, via LaTeX."
+ :tag "Org Export LaTeX"
+ :group 'org-export-latex
+ :group 'org-export)
+
+(defcustom org-latex-to-pdf-process
+ '("pdflatex -interaction nonstopmode %s"
+ "pdflatex -interaction nonstopmode %s")
+ "Commands to process a LaTeX file to a PDF file.
+This is a list of strings, each of them will be given to the shell
+as a command. %s in the command will be replaced by the full file name, %b
+by the file base name (i.e. without extension).
+The reason why this is a list is that it usually takes several runs of
+pdflatex, maybe mixed with a call to bibtex. Org does not have a clever
+mechanism to detect whihc of these commands have to be run to get to a stable
+result, and it also does not do any error checking.
+
+Alternatively, this may be a Lisp function that does the processing, so you
+could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode.
+THis function should accept the file name as its single argument."
+ :group 'org-export-latex
+ :type '(choice (repeat :tag "Shell command sequence"
+ (string :tag "Shell command"))
+ (function)))
+
+(defcustom org-export-pdf-remove-logfiles t
+ "Non-nil means, remove the logfiles produced by PDF production.
+These are the .aux, .log, .out, and .toc files."
+ :group 'org-export-pdf
+ :type 'boolean)
+
+;;; Hooks
+
+(defvar org-export-latex-after-blockquotes-hook nil
+ "Hook run during LaTeX export, after blockquote, verse, center are done.")
+
+;;; Autoload functions:
+
+;;;###autoload
+(defun org-export-as-latex-batch ()
+ "Call `org-export-as-latex', may be used in batch processing.
+For example:
+
+emacs --batch
+ --load=$HOME/lib/emacs/org.el
+ --eval \"(setq org-export-headline-levels 2)\"
+ --visit=MyFile --funcall org-export-as-latex-batch"
+ (org-export-as-latex org-export-headline-levels 'hidden))
+
+;;;###autoload
+(defun org-export-as-latex-to-buffer (arg)
+ "Call `org-export-as-latex` with output to a temporary buffer.
+No file is created. The prefix ARG is passed through to `org-export-as-latex'."
+ (interactive "P")
+ (org-export-as-latex arg nil nil "*Org LaTeX Export*")
+ (when org-export-show-temporary-export-buffer
+ (switch-to-buffer-other-window "*Org LaTeX Export*")))
+
+;;;###autoload
+(defun org-replace-region-by-latex (beg end)
+ "Replace the region from BEG to END with its LaTeX export.
+It assumes the region has `org-mode' syntax, and then convert it to
+LaTeX. This can be used in any buffer. For example, you could
+write an itemized list in `org-mode' syntax in an LaTeX buffer and
+then use this command to convert it."
+ (interactive "r")
+ (let (reg latex buf)
+ (save-window-excursion
+ (if (org-mode-p)
+ (setq latex (org-export-region-as-latex
+ beg end t 'string))
+ (setq reg (buffer-substring beg end)
+ buf (get-buffer-create "*Org tmp*"))
+ (save-excursion
+ (set-buffer buf)
+ (erase-buffer)
+ (insert reg)
+ (org-mode)
+ (setq latex (org-export-region-as-latex
+ (point-min) (point-max) t 'string)))
+ (kill-buffer buf)))
+ (delete-region beg end)
+ (insert latex)))
+
+;;;###autoload
+(defun org-export-region-as-latex (beg end &optional body-only buffer)
+ "Convert region from BEG to END in `org-mode' buffer to LaTeX.
+If prefix arg BODY-ONLY is set, omit file header, footer, and table of
+contents, and only produce the region of converted text, useful for
+cut-and-paste operations.
+If BUFFER is a buffer or a string, use/create that buffer as a target
+of the converted LaTeX. If BUFFER is the symbol `string', return the
+produced LaTeX as a string and leave no buffer behind. For example,
+a Lisp program could call this function in the following way:
+
+ (setq latex (org-export-region-as-latex beg end t 'string))
+
+When called interactively, the output buffer is selected, and shown
+in a window. A non-interactive call will only return the buffer."
+ (interactive "r\nP")
+ (when (interactive-p)
+ (setq buffer "*Org LaTeX Export*"))
+ (let ((transient-mark-mode t) (zmacs-regions t)
+ ext-plist rtn)
+ (setq ext-plist (plist-put ext-plist :ignore-subree-p t))
+ (goto-char end)
+ (set-mark (point)) ;; to activate the region
+ (goto-char beg)
+ (setq rtn (org-export-as-latex
+ nil nil ext-plist
+ buffer body-only))
+ (if (fboundp 'deactivate-mark) (deactivate-mark))
+ (if (and (interactive-p) (bufferp rtn))
+ (switch-to-buffer-other-window rtn)
+ rtn)))
+
+;;;###autoload
+(defun org-export-as-latex (arg &optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Export current buffer to a LaTeX file.
+If there is an active region, export only the region. The prefix
+ARG specifies how many levels of the outline should become
+headlines. The default is 3. Lower levels will be exported
+depending on `org-export-latex-low-levels'. The default is to
+convert them as description lists.
+HIDDEN is obsolete and does nothing.
+EXT-PLIST is a property list with
+external parameters overriding org-mode's default settings, but
+still inferior to file-local settings. When TO-BUFFER is
+non-nil, create a buffer with that name and export to that
+buffer. If TO-BUFFER is the symbol `string', don't leave any
+buffer behind but just return the resulting LaTeX as a string.
+When BODY-ONLY is set, don't produce the file header and footer,
+simply return the content of \begin{document}...\end{document},
+without even the \begin{document} and \end{document} commands.
+when PUB-DIR is set, use this as the publishing directory."
+ (interactive "P")
+ ;; Make sure we have a file name when we need it.
+ (when (and (not (or to-buffer body-only))
+ (not buffer-file-name))
+ (if (buffer-base-buffer)
+ (org-set-local 'buffer-file-name
+ (with-current-buffer (buffer-base-buffer)
+ buffer-file-name))
+ (error "Need a file name to be able to export")))
+
+ (message "Exporting to LaTeX...")
+ (org-unmodified
+ (remove-text-properties (point-min) (point-max)
+ '(:org-license-to-kill nil)))
+ (org-update-radio-target-regexp)
+ (org-export-latex-set-initial-vars ext-plist arg)
+ (let* ((wcf (current-window-configuration))
+ (opt-plist org-export-latex-options-plist)
+ (region-p (org-region-active-p))
+ (rbeg (and region-p (region-beginning)))
+ (rend (and region-p (region-end)))
+ (subtree-p
+ (if (plist-get opt-plist :ignore-subree-p)
+ nil
+ (when region-p
+ (save-excursion
+ (goto-char rbeg)
+ (and (org-at-heading-p)
+ (>= (org-end-of-subtree t t) rend))))))
+ (opt-plist (setq org-export-opt-plist
+ (if subtree-p
+ (org-export-add-subtree-options opt-plist rbeg)
+ opt-plist)))
+ ;; Make sure the variable contains the updated values.
+ (org-export-latex-options-plist opt-plist)
+ (title (or (and subtree-p (org-export-get-title-from-subtree))
+ (plist-get opt-plist :title)
+ (and (not
+ (plist-get opt-plist :skip-before-1st-heading))
+ (org-export-grab-title-from-buffer))
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name))))
+ (filename (concat (file-name-as-directory
+ (or pub-dir
+ (org-export-directory :LaTeX ext-plist)))
+ (file-name-sans-extension
+ (or (and subtree-p
+ (org-entry-get rbeg "EXPORT_FILE_NAME" t))
+ (file-name-nondirectory ;sans-extension
+ buffer-file-name)))
+ ".tex"))
+ (filename (if (equal (file-truename filename)
+ (file-truename buffer-file-name))
+ (concat filename ".tex")
+ filename))
+ (buffer (if to-buffer
+ (cond
+ ((eq to-buffer 'string) (get-buffer-create
+ "*Org LaTeX Export*"))
+ (t (get-buffer-create to-buffer)))
+ (find-file-noselect filename)))
+ (odd org-odd-levels-only)
+ (header (org-export-latex-make-header title opt-plist))
+ (skip (cond (subtree-p nil)
+ (region-p nil)
+ (t (plist-get opt-plist :skip-before-1st-heading))))
+ (text (plist-get opt-plist :text))
+ (org-export-preprocess-hook
+ (cons
+ `(lambda () (org-set-local 'org-complex-heading-regexp
+ ,org-export-latex-complex-heading-re))
+ org-export-preprocess-hook))
+ (first-lines (if skip "" (org-export-latex-first-lines
+ opt-plist
+ (if subtree-p
+ (save-excursion
+ (goto-char rbeg)
+ (point-at-bol 2))
+ rbeg)
+ (if region-p rend))))
+ (coding-system (and (boundp 'buffer-file-coding-system)
+ buffer-file-coding-system))
+ (coding-system-for-write (or org-export-latex-coding-system
+ coding-system))
+ (save-buffer-coding-system (or org-export-latex-coding-system
+ coding-system))
+ (region (buffer-substring
+ (if region-p (region-beginning) (point-min))
+ (if region-p (region-end) (point-max))))
+ (string-for-export
+ (org-export-preprocess-string
+ region
+ :emph-multiline t
+ :for-LaTeX t
+ :comments nil
+ :tags (plist-get opt-plist :tags)
+ :priority (plist-get opt-plist :priority)
+ :footnotes (plist-get opt-plist :footnotes)
+ :timestamps (plist-get opt-plist :timestamps)
+ :todo-keywords (plist-get opt-plist :todo-keywords)
+ :add-text (if (eq to-buffer 'string) nil text)
+ :skip-before-1st-heading skip
+ :select-tags (plist-get opt-plist :select-tags)
+ :exclude-tags (plist-get opt-plist :exclude-tags)
+ :LaTeX-fragments nil)))
+
+ (set-buffer buffer)
+ (erase-buffer)
+ (org-install-letbind)
+
+ (and (fboundp 'set-buffer-file-coding-system)
+ (set-buffer-file-coding-system coding-system-for-write))
+
+ ;; insert the header and initial document commands
+ (unless (or (eq to-buffer 'string) body-only)
+ (insert header))
+
+ ;; insert text found in #+TEXT
+ (when (and text (not (eq to-buffer 'string)))
+ (insert (org-export-latex-content
+ text '(lists tables fixed-width keywords))
+ "\n\n"))
+
+ ;; insert lines before the first headline
+ (unless skip
+ (insert first-lines))
+
+ ;; export the content of headlines
+ (org-export-latex-global
+ (with-temp-buffer
+ (insert string-for-export)
+ (goto-char (point-min))
+ (when (re-search-forward "^\\(\\*+\\) " nil t)
+ (let* ((asters (length (match-string 1)))
+ (level (if odd (- asters 2) (- asters 1))))
+ (setq org-export-latex-add-level
+ (if odd (1- (/ (1+ asters) 2)) (1- asters)))
+ (org-export-latex-parse-global level odd)))))
+
+ ;; finalization
+ (unless body-only (insert "\n\\end{document}"))
+
+ ;; Relocate the table of contents
+ (goto-char (point-min))
+ (when (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
+ (goto-char (point-min))
+ (while (re-search-forward "\\\\tableofcontents\\>[ \t]*\n?" nil t)
+ (replace-match ""))
+ (goto-char (point-min))
+ (and (re-search-forward "\\[TABLE-OF-CONTENTS\\]" nil t)
+ (replace-match "\\tableofcontents" t t)))
+
+ (or to-buffer (save-buffer))
+ (goto-char (point-min))
+ (or (org-export-push-to-kill-ring "LaTeX")
+ (message "Exporting to LaTeX...done"))
+ (prog1
+ (if (eq to-buffer 'string)
+ (prog1 (buffer-substring (point-min) (point-max))
+ (kill-buffer (current-buffer)))
+ (current-buffer))
+ (set-window-configuration wcf))))
+
+;;;###autoload
+(defun org-export-as-pdf (arg &optional hidden ext-plist
+ to-buffer body-only pub-dir)
+ "Export as LaTeX, then process through to PDF."
+ (interactive "P")
+ (message "Exporting to PDF...")
+ (let* ((wconfig (current-window-configuration))
+ (lbuf (org-export-as-latex arg hidden ext-plist
+ to-buffer body-only pub-dir))
+ (file (buffer-file-name lbuf))
+ (base (file-name-sans-extension (buffer-file-name lbuf)))
+ (pdffile (concat base ".pdf"))
+ (cmds org-latex-to-pdf-process)
+ (outbuf (get-buffer-create "*Org PDF LaTeX Output*"))
+ (bibtex-p (with-current-buffer lbuf
+ (save-excursion
+ (goto-char (point-min))
+ (re-search-forward "\\\\bibliography{" nil t))))
+ cmd)
+ (with-current-buffer outbuf (erase-buffer))
+ (and (file-exists-p pdffile) (delete-file pdffile))
+ (message "Processing LaTeX file...")
+ (if (and cmds (symbolp cmds))
+ (funcall cmds file)
+ (while cmds
+ (setq cmd (pop cmds))
+ (while (string-match "%b" cmd)
+ (setq cmd (replace-match
+ (save-match-data
+ (shell-quote-argument base))
+ t t cmd)))
+ (while (string-match "%s" cmd)
+ (setq cmd (replace-match
+ (save-match-data
+ (shell-quote-argument file))
+ t t cmd)))
+ (shell-command cmd outbuf outbuf)))
+ (message "Processing LaTeX file...done")
+ (if (not (file-exists-p pdffile))
+ (error "PDF file was not produced")
+ (set-window-configuration wconfig)
+ (when org-export-pdf-remove-logfiles
+ (dolist (ext '("aux" "log" "out" "toc"))
+ (setq file (concat base "." ext))
+ (and (file-exists-p file) (delete-file file))))
+ (message "Exporting to PDF...done")
+ pdffile)))
+
+;;;###autoload
+(defun org-export-as-pdf-and-open (arg)
+ "Export as LaTeX, then process through to PDF, and open."
+ (interactive "P")
+ (let ((pdffile (org-export-as-pdf arg)))
+ (if pdffile
+ (org-open-file pdffile)
+ (error "PDF file was not produced"))))
+
+;;; Parsing functions:
+
+(defun org-export-latex-parse-global (level odd)
+ "Parse the current buffer recursively, starting at LEVEL.
+If ODD is non-nil, assume the buffer only contains odd sections.
+Return a list reflecting the document structure."
+ (save-excursion
+ (goto-char (point-min))
+ (let* ((cnt 0) output
+ (depth org-export-latex-sectioning-depth))
+ (while (re-search-forward
+ (concat "^\\(\\(?:\\*\\)\\{"
+ (number-to-string (+ (if odd 2 1) level))
+ "\\}\\) \\(.*\\)$")
+ ;; make sure that there is no upper heading
+ (when (> level 0)
+ (save-excursion
+ (save-match-data
+ (re-search-forward
+ (concat "^\\(\\(?:\\*\\)\\{"
+ (number-to-string level)
+ "\\}\\) \\(.*\\)$") nil t)))) t)
+ (setq cnt (1+ cnt))
+ (let* ((pos (match-beginning 0))
+ (heading (match-string 2))
+ (nlevel (if odd (/ (+ 3 level) 2) (1+ level))))
+ (save-excursion
+ (narrow-to-region
+ (point)
+ (save-match-data
+ (if (re-search-forward
+ (concat "^\\(\\(?:\\*\\)\\{"
+ (number-to-string (+ (if odd 2 1) level))
+ "\\}\\) \\(.*\\)$") nil t)
+ (match-beginning 0)
+ (point-max))))
+ (goto-char (point-min))
+ (setq output
+ (append output
+ (list
+ (list
+ `(pos . ,pos)
+ `(level . ,nlevel)
+ `(occur . ,cnt)
+ `(heading . ,heading)
+ `(content . ,(org-export-latex-parse-content))
+ `(subcontent . ,(org-export-latex-parse-subcontent
+ level odd)))))))
+ (widen)))
+ (list output))))
+
+(defun org-export-latex-parse-content ()
+ "Extract the content of a section."
+ (let ((beg (point))
+ (end (if (re-search-forward "^\\(\\*\\)+ .*$" nil t)
+ (progn (beginning-of-line) (point))
+ (point-max))))
+ (buffer-substring beg end)))
+
+(defun org-export-latex-parse-subcontent (level odd)
+ "Extract the subcontent of a section at LEVEL.
+If ODD Is non-nil, assume subcontent only contains odd sections."
+ (if (not (re-search-forward
+ (concat "^\\(\\(?:\\*\\)\\{"
+ (number-to-string (+ (if odd 4 2) level))
+ "\\}\\) \\(.*\\)$")
+ nil t))
+ nil ; subcontent is nil
+ (org-export-latex-parse-global (+ (if odd 2 1) level) odd)))
+
+;;; Rendering functions:
+(defun org-export-latex-global (content)
+ "Export CONTENT to LaTeX.
+CONTENT is an element of the list produced by
+`org-export-latex-parse-global'."
+ (if (eq (car content) 'subcontent)
+ (mapc 'org-export-latex-sub (cdr content))
+ (org-export-latex-sub (car content))))
+
+(defun org-export-latex-sub (subcontent)
+ "Export the list SUBCONTENT to LaTeX.
+SUBCONTENT is an alist containing information about the headline
+and its content."
+ (let ((num (plist-get org-export-latex-options-plist :section-numbers)))
+ (mapc (lambda(x) (org-export-latex-subcontent x num)) subcontent)))
+
+(defun org-export-latex-subcontent (subcontent num)
+ "Export each cell of SUBCONTENT to LaTeX.
+If NUM, export sections as numerical sections."
+ (let* ((heading (org-export-latex-fontify-headline
+ (cdr (assoc 'heading subcontent))))
+ (level (- (cdr (assoc 'level subcontent))
+ org-export-latex-add-level))
+ (occur (number-to-string (cdr (assoc 'occur subcontent))))
+ (content (cdr (assoc 'content subcontent)))
+ (subcontent (cadr (assoc 'subcontent subcontent)))
+ (label (org-get-text-property-any 0 'target heading))
+ (label-list (cons label (cdr (assoc label
+ org-export-target-aliases)))))
+ (cond
+ ;; Normal conversion
+ ((<= level org-export-latex-sectioning-depth)
+ (let* ((sec (nth (1- level) org-export-latex-sectioning))
+ start end)
+ (if (consp (cdr sec))
+ (setq start (nth (if num 0 2) sec)
+ end (nth (if num 1 3) sec))
+ (setq start (if num (car sec) (cdr sec))))
+ (insert (format start heading) "\n")
+ (when label
+ (insert (mapconcat (lambda (l) (format "\\label{%s}" l))
+ label-list "\n") "\n"))
+ (insert (org-export-latex-content content))
+ (cond ((stringp subcontent) (insert subcontent))
+ ((listp subcontent) (org-export-latex-sub subcontent)))
+ (if end (insert end "\n"))))
+ ;; At a level under the hl option: we can drop this subsection
+ ((> level org-export-latex-sectioning-depth)
+ (cond ((eq org-export-latex-low-levels 'description)
+ (if (string-match "% ends low level$"
+ (buffer-substring (point-at-bol 0) (point)))
+ (delete-region (point-at-bol 0) (point))
+ (insert "\\begin{description}\n"))
+ (insert (format "\n\\item[%s]%s~\n\n"
+ heading
+ (if label (format "\\label{%s}" label) "")))
+ (insert (org-export-latex-content content))
+ (cond ((stringp subcontent) (insert subcontent))
+ ((listp subcontent) (org-export-latex-sub subcontent)))
+ (insert "\\end{description} % ends low level\n"))
+ ((memq org-export-latex-low-levels '(itemize enumerate))
+ (if (string-match "% ends low level$"
+ (buffer-substring (point-at-bol 0) (point)))
+ (delete-region (point-at-bol 0) (point))
+ (insert (format "\\begin{%s}\n"
+ (symbol-name org-export-latex-low-levels))))
+ (insert (format "\n\\item %s\\\\\n%s\n"
+ heading
+ (if label (format "\\label{%s}" label) "")))
+ (insert (org-export-latex-content content))
+ (cond ((stringp subcontent) (insert subcontent))
+ ((listp subcontent) (org-export-latex-sub subcontent)))
+ (insert (format "\\end{%s} %% ends low level\n"
+ (symbol-name org-export-latex-low-levels))))
+
+ ((listp org-export-latex-low-levels)
+ (if (string-match "% ends low level$"
+ (buffer-substring (point-at-bol 0) (point)))
+ (delete-region (point-at-bol 0) (point))
+ (insert (car org-export-latex-low-levels) "\n"))
+ (insert (format (nth 2 org-export-latex-low-levels)
+ heading
+ (if label (format "\\label{%s}" label) "")))
+ (insert (org-export-latex-content content))
+ (cond ((stringp subcontent) (insert subcontent))
+ ((listp subcontent) (org-export-latex-sub subcontent)))
+ (insert (nth 1 org-export-latex-low-levels)
+ " %% ends low level\n"))
+
+ ((stringp org-export-latex-low-levels)
+ (insert (format org-export-latex-low-levels heading) "\n")
+ (when label (insert (format "\\label{%s}\n" label)))
+ (insert (org-export-latex-content content))
+ (cond ((stringp subcontent) (insert subcontent))
+ ((listp subcontent) (org-export-latex-sub subcontent)))))))))
+
+;;; Exporting internals:
+(defun org-export-latex-set-initial-vars (ext-plist level)
+ "Store org local variables required for LaTeX export.
+EXT-PLIST is an optional additional plist.
+LEVEL indicates the default depth for export."
+ (setq org-export-latex-todo-keywords-1 org-todo-keywords-1
+ org-export-latex-done-keywords org-done-keywords
+ org-export-latex-not-done-keywords org-not-done-keywords
+ org-export-latex-complex-heading-re org-complex-heading-regexp
+ org-export-latex-display-custom-times org-display-custom-times
+ org-export-latex-all-targets-re
+ (org-make-target-link-regexp (org-all-targets))
+ org-export-latex-options-plist
+ (org-combine-plists (org-default-export-plist) ext-plist
+ (org-infile-export-plist))
+ org-export-latex-class
+ (or (and (org-region-active-p)
+ (save-excursion
+ (goto-char (region-beginning))
+ (and (looking-at org-complex-heading-regexp)
+ (org-entry-get nil "LaTeX_CLASS" 'selective))))
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char (point-min))
+ (and (re-search-forward "^#\\+LaTeX_CLASS:[ \t]*\\([a-zA-Z]+\\)" nil t)
+ (match-string 1))))
+ org-export-latex-default-class)
+ org-export-latex-class
+ (or (car (assoc org-export-latex-class org-export-latex-classes))
+ (error "No definition for class `%s' in `org-export-latex-classes'"
+ org-export-latex-class))
+ org-export-latex-header
+ (cadr (assoc org-export-latex-class org-export-latex-classes))
+ org-export-latex-sectioning
+ (cddr (assoc org-export-latex-class org-export-latex-classes))
+ org-export-latex-sectioning-depth
+ (or level
+ (let ((hl-levels
+ (plist-get org-export-latex-options-plist :headline-levels))
+ (sec-depth (length org-export-latex-sectioning)))
+ (if (> hl-levels sec-depth) sec-depth hl-levels)))))
+
+(defun org-export-latex-make-header (title opt-plist)
+ "Make the LaTeX header and return it as a string.
+TITLE is the current title from the buffer or region.
+OPT-PLIST is the options plist for current buffer."
+ (let ((toc (plist-get opt-plist :table-of-contents))
+ (author (plist-get opt-plist :author)))
+ (concat
+ (if (plist-get opt-plist :time-stamp-file)
+ (format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
+ ;; insert LaTeX custom header
+ (org-export-apply-macros-in-string org-export-latex-header)
+ "\n"
+ ;; insert information on LaTeX packages
+ (when org-export-latex-packages-alist
+ (mapconcat (lambda(p)
+ (if (equal "" (car p))
+ (format "\\usepackage{%s}" (cadr p))
+ (format "\\usepackage[%s]{%s}"
+ (car p) (cadr p))))
+ org-export-latex-packages-alist "\n"))
+ ;; insert additional commands in the header
+ (org-export-apply-macros-in-string
+ (plist-get opt-plist :latex-header-extra))
+ (org-export-apply-macros-in-string org-export-latex-append-header)
+ ;; insert the title
+ (format
+ "\n\n\\title{%s}\n"
+ ;; convert the title
+ (org-export-latex-content
+ title '(lists tables fixed-width keywords)))
+ ;; insert author info
+ (if (plist-get opt-plist :author-info)
+ (format "\\author{%s}\n"
+ (org-export-latex-fontify-headline (or author user-full-name)));????????????????????
+ (format "%%\\author{%s}\n"
+ (or author user-full-name)))
+ ;; insert the date
+ (format "\\date{%s}\n"
+ (format-time-string
+ (or (plist-get opt-plist :date)
+ org-export-latex-date-format)))
+ ;; beginning of the document
+ "\n\\begin{document}\n\n"
+ ;; insert the title command
+ (when (string-match "\\S-" title)
+ (if (string-match "%s" org-export-latex-title-command)
+ (format org-export-latex-title-command title)
+ org-export-latex-title-command))
+ "\n\n"
+ ;; table of contents
+ (when (and org-export-with-toc
+ (plist-get opt-plist :section-numbers))
+ (cond ((numberp toc)
+ (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
+ (min toc (plist-get opt-plist :headline-levels))))
+ (toc (format "\\setcounter{tocdepth}{%s}\n\\tableofcontents\n\\vspace*{1cm}\n"
+ (plist-get opt-plist :headline-levels))))))))
+
+(defun org-export-latex-first-lines (opt-plist &optional beg end)
+ "Export the first lines before first headline.
+If BEG is non-nil, it is the beginning of the region.
+If END is non-nil, it is the end of the region."
+ (save-excursion
+ (goto-char (or beg (point-min)))
+ (let* ((pt (point))
+ (end (if (re-search-forward "^\\*+ " end t)
+ (goto-char (match-beginning 0))
+ (goto-char end))))
+ (prog1
+ (org-export-latex-content
+ (org-export-preprocess-string
+ (buffer-substring pt end)
+ :for-LaTeX t
+ :emph-multiline t
+ :add-text nil
+ :comments nil
+ :skip-before-1st-heading nil
+ :LaTeX-fragments nil
+ :timestamps (plist-get opt-plist :timestamps)
+ :footnotes (plist-get opt-plist :footnotes)))
+ (org-unmodified
+ (add-text-properties pt (max pt (1- end))
+ '(:org-license-to-kill t)))))))
+
+(defvar org-export-latex-header-defs nil
+ "The header definitions that might be used in the LaTeX body.")
+(defvar org-export-latex-header-defs-re nil
+ "The header definitions that might be used in the LaTeX body.")
+
+(defun org-export-latex-content (content &optional exclude-list)
+ "Convert CONTENT string to LaTeX.
+Don't perform conversions that are in EXCLUDE-LIST. Recognized
+conversion types are: quotation-marks, emphasis, sub-superscript,
+links, keywords, lists, tables, fixed-width"
+ (with-temp-buffer
+ (insert content)
+ (unless (memq 'timestamps exclude-list)
+ (org-export-latex-time-stamps))
+ (unless (memq 'quotation-marks exclude-list)
+ (org-export-latex-quotation-marks))
+ (unless (memq 'emphasis exclude-list)
+ (when (plist-get org-export-latex-options-plist :emphasize)
+ (org-export-latex-fontify)))
+ (unless (memq 'sub-superscript exclude-list)
+ (org-export-latex-special-chars
+ (plist-get org-export-latex-options-plist :sub-superscript)))
+ (unless (memq 'links exclude-list)
+ (org-export-latex-links))
+ (unless (memq 'keywords exclude-list)
+ (org-export-latex-keywords))
+ (unless (memq 'lists exclude-list)
+ (org-export-latex-lists))
+ (unless (memq 'tables exclude-list)
+ (org-export-latex-tables
+ (plist-get org-export-latex-options-plist :tables)))
+ (unless (memq 'fixed-width exclude-list)
+ (org-export-latex-fixed-width
+ (plist-get org-export-latex-options-plist :fixed-width)))
+ ;; return string
+ (buffer-substring (point-min) (point-max))))
+
+(defun org-export-latex-protect-string (s)
+ "Add the org-protected property to string S."
+ (add-text-properties 0 (length s) '(org-protected t) s) s)
+
+(defun org-export-latex-protect-char-in-string (char-list string)
+ "Add org-protected text-property to char from CHAR-LIST in STRING."
+ (with-temp-buffer
+ (save-match-data
+ (insert string)
+ (goto-char (point-min))
+ (while (re-search-forward (regexp-opt char-list) nil t)
+ (add-text-properties (match-beginning 0)
+ (match-end 0) '(org-protected t)))
+ (buffer-string))))
+
+(defun org-export-latex-keywords-maybe (&optional remove-list)
+ "Maybe remove keywords depending on rules in REMOVE-LIST."
+ (goto-char (point-min))
+ (let ((re-todo (mapconcat 'identity org-export-latex-todo-keywords-1 "\\|"))
+ (case-fold-search nil)
+ (todo-markup org-export-latex-todo-keyword-markup)
+ fmt)
+ ;; convert TODO keywords
+ (when (re-search-forward (concat "^\\(" re-todo "\\)") nil t)
+ (if (plist-get remove-list :todo)
+ (replace-match "")
+ (setq fmt (cond
+ ((stringp todo-markup) todo-markup)
+ ((and (consp todo-markup) (stringp (car todo-markup)))
+ (if (member (match-string 1) org-export-latex-done-keywords)
+ (cdr todo-markup) (car todo-markup)))
+ (t (cdr (or (assoc (match-string 1) todo-markup)
+ (car todo-markup))))))
+ (replace-match (format fmt (match-string 1)) t t)))
+ ;; convert priority string
+ (when (re-search-forward "\\[\\\\#.\\]" nil t)
+ (if (plist-get remove-list :priority)
+ (replace-match "")
+ (replace-match (format "\\textbf{%s}" (match-string 0)) t t)))
+ ;; convert tags
+ (when (re-search-forward "\\(:[a-zA-Z0-9_@]+\\)+:" nil t)
+ (if (or (not org-export-with-tags)
+ (plist-get remove-list :tags))
+ (replace-match "")
+ (replace-match
+ (org-export-latex-protect-string
+ (format "\\textbf{%s}"
+ (save-match-data
+ (replace-regexp-in-string
+ "_" "\\\\_" (match-string 0)))))
+ t t)))))
+
+(defun org-export-latex-fontify-headline (string)
+ "Fontify special words in STRING."
+ (with-temp-buffer
+ ;; FIXME: org-inside-LaTeX-fragment-p doesn't work when the $...$ is at
+ ;; the beginning of the buffer - inserting "\n" is safe here though.
+ (insert "\n" string)
+ (goto-char (point-min))
+ (when (plist-get org-export-latex-options-plist :emphasize)
+ (org-export-latex-fontify))
+ (org-export-latex-keywords-maybe)
+ (org-export-latex-special-chars
+ (plist-get org-export-latex-options-plist :sub-superscript))
+ (org-export-latex-links)
+ (org-trim (buffer-string))))
+
+(defun org-export-latex-time-stamps ()
+ "Format time stamps."
+ (goto-char (point-min))
+ (let ((org-display-custom-times org-export-latex-display-custom-times))
+ (while (re-search-forward org-ts-regexp-both nil t)
+ (org-if-unprotected-at (1- (point))
+ (replace-match
+ (org-export-latex-protect-string
+ (format org-export-latex-timestamp-markup
+ (substring (org-translate-time (match-string 0)) 1 -1)))
+ t t)))))
+
+(defun org-export-latex-quotation-marks ()
+ "Export quotation marks depending on language conventions."
+ (let* ((lang (plist-get org-export-latex-options-plist :language))
+ (quote-rpl (if (equal lang "fr")
+ '(("\\(\\s-\\)\"" "«~")
+ ("\\(\\S-\\)\"" "~»")
+ ("\\(\\s-\\)'" "`"))
+ '(("\\(\\s-\\|(\\)\"" "``")
+ ("\\(\\S-\\)\"" "''")
+ ("\\(\\s-\\|(\\)'" "`")))))
+ (mapc (lambda(l) (goto-char (point-min))
+ (while (re-search-forward (car l) nil t)
+ (let ((rpl (concat (match-string 1) (cadr l))))
+ (org-export-latex-protect-string rpl)
+ (org-if-unprotected-1
+ (replace-match rpl t t))))) quote-rpl)))
+
+(defun org-export-latex-special-chars (sub-superscript)
+ "Export special characters to LaTeX.
+If SUB-SUPERSCRIPT is non-nil, convert \\ and ^.
+See the `org-export-latex.el' code for a complete conversion table."
+ (goto-char (point-min))
+ (mapc (lambda(c)
+ (goto-char (point-min))
+ (while (re-search-forward c nil t)
+ ;; Put the point where to check for org-protected
+ (unless (get-text-property (match-beginning 2) 'org-protected)
+ (cond ((member (match-string 2) '("\\$" "$"))
+ (if (equal (match-string 2) "\\$")
+ nil
+ (replace-match "\\$" t t)))
+ ((member (match-string 2) '("&" "%" "#"))
+ (if (equal (match-string 1) "\\")
+ (replace-match (match-string 2) t t)
+ (replace-match (concat (match-string 1) "\\"
+ (match-string 2)) t t)))
+ ((equal (match-string 2) "...")
+ (replace-match
+ (concat (match-string 1)
+ (org-export-latex-protect-string "\\ldots{}")) t t))
+ ((equal (match-string 2) "~")
+ (cond ((equal (match-string 1) "\\") nil)
+ ((eq 'org-link (get-text-property 0 'face (match-string 2)))
+ (replace-match (concat (match-string 1) "\\~") t t))
+ (t (replace-match
+ (org-export-latex-protect-string
+ (concat (match-string 1) "\\~{}")) t t))))
+ ((member (match-string 2) '("{" "}"))
+ (unless (save-match-data (org-inside-latex-math-p))
+ (if (equal (match-string 1) "\\")
+ (replace-match (match-string 2) t t)
+ (replace-match (concat (match-string 1) "\\"
+ (match-string 2)) t t)))))
+ (unless (save-match-data (org-inside-latex-math-p))
+ (cond ((equal (match-string 2) "\\")
+ (replace-match (or (save-match-data
+ (org-export-latex-treat-backslash-char
+ (match-string 1)
+ (or (match-string 3) "")))
+ "") t t))
+ ((member (match-string 2) '("_" "^"))
+ (replace-match (or (save-match-data
+ (org-export-latex-treat-sub-super-char
+ sub-superscript
+ (match-string 2)
+ (match-string 1)
+ (match-string 3))) "") t t)
+ (backward-char 1)))))))
+ '(;"^\\([^\n$]*?\\|^\\)\\(\\\\?\\$\\)\\([^\n$]*\\)$"
+ "\\(\\(\\\\?\\$\\)\\)"
+ "\\([a-za-z0-9]+\\|[ \t\n]\\|\\b\\|\\\\\\)\\(_\\|\\^\\)\\({[^{}]+}\\|[a-za-z0-9]+\\|[ \t\n]\\|[:punct:]\\|)\\|{[a-za-z0-9]+}\\|([a-za-z0-9]+)\\)"
+ "\\(.\\|^\\)\\(\\\\\\)\\([ \t\n]\\|[a-zA-Z&#%{}\"]+\\)"
+ "\\(.\\|^\\)\\(&\\)"
+ "\\(.\\|^\\)\\(#\\)"
+ "\\(.\\|^\\)\\(%\\)"
+ "\\(.\\|^\\)\\({\\)"
+ "\\(.\\|^\\)\\(}\\)"
+ "\\(.\\|^\\)\\(~\\)"
+ "\\(.\\|^\\)\\(\\.\\.\\.\\)"
+ ;; (?\< . "\\textless{}")
+ ;; (?\> . "\\textgreater{}")
+ )))
+
+(defun org-inside-latex-math-p ()
+ (get-text-property (point) 'org-latex-math))
+
+(defun org-export-latex-treat-sub-super-char
+ (subsup char string-before string-after)
+ "Convert the \"_\" and \"^\" characters to LaTeX.
+SUBSUP corresponds to the ^: option in the #+OPTIONS line.
+Convert CHAR depending on STRING-BEFORE and STRING-AFTER."
+ (cond ((equal string-before "\\")
+ (concat string-before char string-after))
+ ;; this is part of a math formula
+ ((and (string-match "\\S-+" string-before)
+ (string-match "\\S-+" string-after))
+ (cond ((eq 'org-link (get-text-property 0 'face char))
+ (concat string-before "\\" char string-after))
+ ((save-match-data (org-inside-latex-math-p))
+ (if subsup
+ (cond ((eq 1 (length string-after))
+ (concat string-before char string-after))
+ ((string-match "[({]?\\([^)}]+\\)[)}]?" string-after)
+ (format "%s%s{%s}" string-before char
+ (match-string 1 string-after))))))
+ ((and (> (length string-after) 1)
+ (or (eq subsup t)
+ (and (equal subsup '{}) (eq (string-to-char string-after) ?\{)))
+ (string-match "[({]?\\([^)}]+\\)[)}]?" string-after))
+ (org-export-latex-protect-string
+ (format "%s$%s{%s}$" string-before char
+ (if (and (> (match-end 1) (1+ (match-beginning 1)))
+ (not (equal (substring string-after 0 2) "{\\")))
+ (concat "\\mathrm{" (match-string 1 string-after) "}")
+ (match-string 1 string-after)))))
+ ((eq subsup t) (concat string-before "$" char string-after "$"))
+ (t (org-export-latex-protect-string
+ (concat string-before "\\" char "{}" string-after)))))
+ (t (org-export-latex-protect-string
+ (concat string-before "\\" char "{}" string-after)))))
+
+(defun org-export-latex-treat-backslash-char (string-before string-after)
+ "Convert the \"$\" special character to LaTeX.
+The conversion is made depending of STRING-BEFORE and STRING-AFTER."
+ (cond ((member (list string-after) org-html-entities)
+ ;; backslash is part of a special entity (like "\alpha")
+ (concat string-before "$\\"
+ (or (cdar (member (list string-after) org-html-entities))
+ string-after) "$"))
+ ((and (not (string-match "^[ \n\t]" string-after))
+ (not (string-match "[ \t]\\'\\|^" string-before)))
+ ;; backslash is inside a word
+ (org-export-latex-protect-string
+ (concat string-before "\\textbackslash{}" string-after)))
+ ((not (or (equal string-after "")
+ (string-match "^[ \t\n]" string-after)))
+ ;; backslash might escape a character (like \#) or a user TeX
+ ;; macro (like \setcounter)
+ (org-export-latex-protect-string
+ (concat string-before "\\" string-after)))
+ ((and (string-match "^[ \t\n]" string-after)
+ (string-match "[ \t\n]\\'" string-before))
+ ;; backslash is alone, convert it to $\backslash$
+ (org-export-latex-protect-string
+ (concat string-before "\\textbackslash{}" string-after)))
+ (t (org-export-latex-protect-string
+ (concat string-before "\\textbackslash{}" string-after)))))
+
+(defun org-export-latex-keywords ()
+ "Convert special keywords to LaTeX."
+ (goto-char (point-min))
+ (while (re-search-forward org-export-latex-special-keyword-regexp nil t)
+ (replace-match (format org-export-latex-timestamp-keyword-markup
+ (match-string 0)) t t)
+ (save-excursion
+ (beginning-of-line 1)
+ (unless (looking-at ".*\\\\newline[ \t]*$")
+ (end-of-line 1)
+ (insert "\\newline")))))
+
+(defun org-export-latex-fixed-width (opt)
+ "When OPT is non-nil convert fixed-width sections to LaTeX."
+ (goto-char (point-min))
+ (while (re-search-forward "^[ \t]*:\\([ \t]\\|$\\)" nil t)
+ (if opt
+ (progn (goto-char (match-beginning 0))
+ (insert "\\begin{verbatim}\n")
+ (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
+ (replace-match (concat (match-string 1)
+ (match-string 2)) t t)
+ (forward-line))
+ (insert "\\end{verbatim}\n\n"))
+ (progn (goto-char (match-beginning 0))
+ (while (looking-at "^\\([ \t]*\\):\\(\\([ \t]\\|$\\).*\\)$")
+ (replace-match (concat "%" (match-string 1)
+ (match-string 2)) t t)
+ (forward-line))))))
+
+
+(defvar org-table-last-alignment) ; defined in org-table.el
+(declare-function orgtbl-to-latex "org-table" (table params) t)
+(defun org-export-latex-tables (insert)
+ "Convert tables to LaTeX and INSERT it."
+ (goto-char (point-min))
+ (while (re-search-forward "^\\([ \t]*\\)|" nil t)
+ ;; FIXME really need to save-excursion?
+ (save-excursion (org-table-align))
+ (let* ((beg (org-table-begin))
+ (end (org-table-end))
+ (raw-table (buffer-substring beg end))
+ fnum fields line lines olines gr colgropen line-fmt align
+ caption label attr floatp longtblp)
+ (if org-export-latex-tables-verbatim
+ (let* ((tbl (concat "\\begin{verbatim}\n" raw-table
+ "\\end{verbatim}\n")))
+ (apply 'delete-region (list beg end))
+ (insert (org-export-latex-protect-string tbl)))
+ (progn
+ (setq caption (org-find-text-property-in-string
+ 'org-caption raw-table)
+ attr (org-find-text-property-in-string
+ 'org-attributes raw-table)
+ label (org-find-text-property-in-string
+ 'org-label raw-table)
+ longtblp (and attr (stringp attr)
+ (string-match "\\<longtable\\>" attr))
+ align (and attr (stringp attr)
+ (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr)
+ (match-string 1 attr))
+ floatp (or caption label))
+ (setq lines (org-split-string raw-table "\n"))
+ (apply 'delete-region (list beg end))
+ (when org-export-table-remove-special-lines
+ (setq lines (org-table-clean-before-export lines 'maybe-quoted)))
+ ;; make a formatting string to reflect aligment
+ (setq olines lines)
+ (while (and (not line-fmt) (setq line (pop olines)))
+ (unless (string-match "^[ \t]*|-" line)
+ (setq fields (org-split-string line "[ \t]*|[ \t]*"))
+ (setq fnum (make-vector (length fields) 0))
+ (setq line-fmt
+ (mapconcat
+ (lambda (x)
+ (setq gr (pop org-table-colgroup-info))
+ (format "%s%%s%s"
+ (cond ((eq gr :start)
+ (prog1 (if colgropen "|" "|")
+ (setq colgropen t)))
+ ((eq gr :startend)
+ (prog1 (if colgropen "|" "|")
+ (setq colgropen nil)))
+ (t ""))
+ (if (memq gr '(:end :startend))
+ (progn (setq colgropen nil) "|")
+ "")))
+ fnum ""))))
+ ;; fix double || in line-fmt
+ (setq line-fmt (replace-regexp-in-string "||" "|" line-fmt))
+ ;; maybe remove the first and last "|"
+ (when (and (not org-export-latex-tables-column-borders)
+ (string-match "^\\(|\\)?\\(.+\\)|$" line-fmt))
+ (setq line-fmt (match-string 2 line-fmt)))
+ ;; format alignment
+ (unless align
+ (setq align (apply 'format
+ (cons line-fmt
+ (mapcar (lambda (x) (if x "r" "l"))
+ org-table-last-alignment)))))
+ ;; prepare the table to send to orgtbl-to-latex
+ (setq lines
+ (mapcar
+ (lambda(elem)
+ (or (and (string-match "[ \t]*|-+" elem) 'hline)
+ (org-split-string (org-trim elem) "|")))
+ lines))
+ (when insert
+ (insert (org-export-latex-protect-string
+ (concat
+ (if longtblp
+ (concat "\\begin{longtable}{" align "}\n")
+ (if floatp "\\begin{table}[htb]\n"))
+ (if (or floatp longtblp)
+ (format
+ "\\caption{%s%s}"
+ (if label (concat "\\\label{" label "}") "")
+ (or caption "")))
+ (if longtblp "\\\\\n" "\n")
+ (if (and org-export-latex-tables-centered (not longtblp))
+ "\\begin{center}\n")
+ (if (not longtblp) (concat "\\begin{tabular}{" align "}\n"))
+ (orgtbl-to-latex
+ lines
+ `(:tstart nil :tend nil
+ :hlend ,(if longtblp
+ (format "\\\\
+\\hline
+\\endhead
+\\hline\\multicolumn{%d}{r}{Continued on next page}\\
+\\endfoot
+\\endlastfoot" (length org-table-last-alignment))
+ nil)))
+ (if (not longtblp) (concat "\n\\end{tabular}"))
+ (if longtblp "\n" (if org-export-latex-tables-centered
+ "\n\\end{center}\n" "\n"))
+ (if longtblp
+ "\\end{longtable}"
+ (if floatp "\\end{table}"))))
+ "\n\n")))))))
+
+(defun org-export-latex-fontify ()
+ "Convert fontification to LaTeX."
+ (goto-char (point-min))
+ (while (re-search-forward org-emph-re nil t)
+ ;; The match goes one char after the *string*
+ (let ((emph (assoc (match-string 3)
+ org-export-latex-emphasis-alist))
+ (beg (match-beginning 0))
+ (end (match-end 0))
+ rpl)
+ (unless emph
+ (message "`org-export-latex-emphasis-alist' has no entry for formatting triggered by \"%s\""
+ (match-string 3)))
+ (unless (or (get-text-property (1- (point)) 'org-protected)
+ (save-excursion
+ (goto-char (match-beginning 1))
+ (save-match-data
+ (and (org-at-table-p)
+ (string-match
+ "[|\n]" (buffer-substring beg end))))))
+ (setq rpl (concat (match-string 1)
+ (org-export-latex-emph-format (cadr emph)
+ (match-string 4))
+ (match-string 5)))
+ (if (caddr emph)
+ (setq rpl (org-export-latex-protect-string rpl)))
+ (replace-match rpl t t)))
+ (backward-char)))
+
+(defvar org-export-latex-use-verb nil)
+(defun org-export-latex-emph-format (format string)
+ "Format an emphasis string and handle the \\verb special case."
+ (when (equal format "\\verb")
+ (save-match-data
+ (if org-export-latex-use-verb
+ (let ((ll "~,./?;':\"|!@#%^&-_=+abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ<>()[]{}"))
+ (catch 'exit
+ (loop for i from 0 to (1- (length ll)) do
+ (if (not (string-match (regexp-quote (substring ll i (1+ i)))
+ string))
+ (progn
+ (setq format (concat "\\verb" (substring ll i (1+ i))
+ "%s" (substring ll i (1+ i))))
+ (throw 'exit nil))))))
+ (let ((start 0)
+ (trans '(("\\" . "\\backslash")
+ ("~" . "\\ensuremath{\\sim}")
+ ("^" . "\\ensuremath{\\wedge}")))
+ (rtn "") char)
+ (while (string-match "[\\{}$%&_#~^]" string)
+ (setq char (match-string 0 string))
+ (if (> (match-beginning 0) 0)
+ (setq rtn (concat rtn (substring string
+ 0 (match-beginning 0)))))
+ (setq string (substring string (1+ (match-beginning 0))))
+ (setq char (or (cdr (assoc char trans)) (concat "\\" char))
+ rtn (concat rtn char)))
+ (setq string (concat rtn string) format "\\texttt{%s}")))))
+ (setq string (org-export-latex-protect-string
+ (format format string))))
+
+(defun org-export-latex-links ()
+ ;; Make sure to use the LaTeX hyperref and graphicx package
+ ;; or send some warnings.
+ "Convert links to LaTeX."
+ (goto-char (point-min))
+ (while (re-search-forward org-bracket-link-analytic-regexp++ nil t)
+ (org-if-unprotected
+ (goto-char (match-beginning 0))
+ (let* ((re-radio org-export-latex-all-targets-re)
+ (remove (list (match-beginning 0) (match-end 0)))
+ (raw-path (org-extract-attributes (match-string 3)))
+ (full-raw-path (concat (match-string 1) raw-path))
+ (desc (match-string 5))
+ (type (or (match-string 2)
+ (if (or (file-name-absolute-p raw-path)
+ (string-match "^\\.\\.?/" raw-path))
+ "file")))
+ (coderefp (equal type "coderef"))
+ (caption (org-find-text-property-in-string 'org-caption raw-path))
+ (attr (or (org-find-text-property-in-string 'org-attributes raw-path)
+ (plist-get org-export-latex-options-plist :latex-image-options)))
+ (label (org-find-text-property-in-string 'org-label raw-path))
+ (floatp (or label caption))
+ imgp radiop
+ ;; define the path of the link
+ (path (cond
+ ((member type '("coderef"))
+ raw-path)
+ ((member type '("http" "https" "ftp"))
+ (concat type ":" raw-path))
+ ((and re-radio (string-match re-radio raw-path))
+ (setq radiop t))
+ ((equal type "mailto")
+ (concat type ":" raw-path))
+ ((equal type "file")
+ (if (and (org-file-image-p
+ (expand-file-name
+ raw-path)
+ org-export-latex-inline-image-extensions)
+ (or (get-text-property 0 'org-no-description
+ raw-path)
+ (equal desc full-raw-path)))
+ (setq imgp t)
+ (progn (when (string-match "\\(.+\\)::.+" raw-path)
+ (setq raw-path (match-string 1 raw-path)))
+ (if (file-exists-p raw-path)
+ (concat type "://" (expand-file-name raw-path))
+ (concat type "://" (org-export-directory
+ :LaTeX org-export-latex-options-plist)
+ raw-path))))))))
+ ;; process with link inserting
+ (apply 'delete-region remove)
+ (cond ((and imgp (plist-get org-export-latex-options-plist :inline-images))
+ (insert
+ (concat
+ (if floatp "\\begin{figure}[htb]\n")
+ (format "\\centerline{\\includegraphics[%s]{%s}}\n"
+ attr
+ (if (file-name-absolute-p raw-path)
+ (expand-file-name raw-path)
+ raw-path))
+ (if floatp
+ (format "\\caption{%s%s}\n"
+ (if label (concat "\\label{" label "}") "")
+ (or caption "")))
+ (if floatp "\\end{figure}\n"))))
+ (coderefp
+ (insert (format
+ (org-export-get-coderef-format path desc)
+ (cdr (assoc path org-export-code-refs)))))
+ (radiop (insert (format "\\hyperref[%s]{%s}"
+ (org-solidify-link-text raw-path) desc)))
+ ((not type)
+ (insert (format "\\hyperref[%s]{%s}"
+ (org-remove-initial-hash
+ (org-solidify-link-text raw-path)) desc)))
+ (path (insert (format "\\href{%s}{%s}" path desc)))
+ (t (insert "\\texttt{" desc "}")))))))
+
+(defun org-remove-initial-hash (s)
+ (if (string-match "\\`#" s)
+ (substring s 1)
+ s))
+(defvar org-latex-entities) ; defined below
+(defvar org-latex-entities-regexp) ; defined below
+(defvar org-latex-entities-exceptions) ; defined below
+
+(defun org-export-latex-preprocess (parameters)
+ "Clean stuff in the LaTeX export."
+ ;; Preserve line breaks
+ (goto-char (point-min))
+ (while (re-search-forward "\\\\\\\\" nil t)
+ (add-text-properties (match-beginning 0) (match-end 0)
+ '(org-protected t)))
+
+ ;; Preserve latex environments
+ (goto-char (point-min))
+ (while (re-search-forward "^[ \t]*\\\\begin{\\([a-zA-Z]+\\*?\\)}" nil t)
+ (let* ((start (progn (beginning-of-line) (point)))
+ (end (and (re-search-forward
+ (concat "^[ \t]*\\\\end{"
+ (regexp-quote (match-string 1))
+ "}") nil t)
+ (point-at-eol))))
+ (if end
+ (add-text-properties start end '(org-protected t))
+ (goto-char (point-at-eol)))))
+
+ ;; Preserve math snippets
+
+ (let* ((matchers (plist-get org-format-latex-options :matchers))
+ (re-list org-latex-regexps)
+ beg end re e m n block off)
+ ;; Check the different regular expressions
+ (while (setq e (pop re-list))
+ (setq m (car e) re (nth 1 e) n (nth 2 e)
+ block (if (nth 3 e) "\n\n" ""))
+ (setq off (if (member m '("$" "$1")) 1 0))
+ (when (and (member m matchers) (not (equal m "begin")))
+ (goto-char (point-min))
+ (while (re-search-forward re nil t)
+ (setq beg (+ (match-beginning 0) off) end (- (match-end 0) 0))
+ (add-text-properties beg end '(org-protected t org-latex-math t))))))
+
+ ;; Convert LaTeX to \LaTeX{}
+ (goto-char (point-min))
+ (let ((case-fold-search nil))
+ (while (re-search-forward "\\([^+_]\\)LaTeX" nil t)
+ (org-if-unprotected
+ (replace-match (org-export-latex-protect-string
+ (concat (match-string 1) "\\LaTeX{}")) t t))))
+
+ ;; Convert blockquotes
+ (goto-char (point-min))
+ (while (search-forward "ORG-BLOCKQUOTE-START" nil t)
+ (org-replace-match-keep-properties "\\begin{quote}" t t))
+ (goto-char (point-min))
+ (while (search-forward "ORG-BLOCKQUOTE-END" nil t)
+ (org-replace-match-keep-properties "\\end{quote}" t t))
+
+ ;; Convert verse
+ (goto-char (point-min))
+ (while (search-forward "ORG-VERSE-START" nil t)
+ (org-replace-match-keep-properties "\\begin{verse}" t t)
+ (beginning-of-line 2)
+ (while (and (not (looking-at "[ \t]*ORG-VERSE-END.*")) (not (eobp)))
+ (when (looking-at "\\([ \t]+\\)\\([^ \t\n]\\)")
+ (goto-char (match-end 1))
+ (org-replace-match-keep-properties
+ (org-export-latex-protect-string
+ (concat "\\hspace*{1cm}" (match-string 2))) t t)
+ (beginning-of-line 1))
+ (unless (looking-at ".*?[^ \t\n].*?\\\\\\\\[ \t]*$")
+ (end-of-line 1)
+ (insert "\\\\"))
+ (beginning-of-line 2))
+ (and (looking-at "[ \t]*ORG-VERSE-END.*")
+ (org-replace-match-keep-properties "\\end{verse}" t t)))
+
+ ;; Convert center
+ (goto-char (point-min))
+ (while (search-forward "ORG-CENTER-START" nil t)
+ (org-replace-match-keep-properties "\\begin{center}" t t))
+ (goto-char (point-min))
+ (while (search-forward "ORG-CENTER-END" nil t)
+ (org-replace-match-keep-properties "\\end{center}" t t))
+
+ (run-hooks 'org-export-latex-after-blockquotes-hook)
+
+ ;; Convert horizontal rules
+ (goto-char (point-min))
+ (while (re-search-forward "^----+.$" nil t)
+ (org-if-unprotected
+ (replace-match (org-export-latex-protect-string "\\hrule") t t)))
+
+ ;; Protect LaTeX commands like \command[...]{...} or \command{...}
+ (let ((re (concat "\\\\[a-zA-Z]+\\(?:"
+ "\\[.*\\]"
+ "\\)?"
+ (org-create-multibrace-regexp "{" "}" 3))))
+ (while (re-search-forward re nil t)
+ (add-text-properties (match-beginning 0) (match-end 0)
+ '(org-protected t))))
+
+ ;; Protect LaTeX entities
+ (goto-char (point-min))
+ (let (a)
+ (while (re-search-forward org-latex-entities-regexp nil t)
+ (if (setq a (assoc (match-string 0) org-latex-entities-exceptions))
+ (replace-match (org-add-props (nth 1 a) nil 'org-protected t)
+ t t)
+ (add-text-properties (match-beginning 0) (match-end 0)
+ '(org-protected t)))))
+
+ ;; Replace radio links
+ (goto-char (point-min))
+ (while (re-search-forward
+ (concat "<<<?" org-export-latex-all-targets-re
+ ">>>?\\((INVISIBLE)\\)?") nil t)
+ (org-if-unprotected
+ (replace-match
+ (org-export-latex-protect-string
+ (format "\\label{%s}%s" (save-match-data (org-solidify-link-text
+ (match-string 1)))
+ (if (match-string 2) "" (match-string 1)))) t t)))
+
+ ;; Delete @<...> constructs
+ ;; Thanks to Daniel Clemente for this regexp
+ (goto-char (point-min))
+ (while (re-search-forward "@<\\(?:[^\"\n]\\|\".*\"\\)*?>" nil t)
+ (org-if-unprotected
+ (replace-match "")))
+
+ ;; When converting to LaTeX, replace footnotes
+ ;; FIXME: don't protect footnotes from conversion
+ (when (plist-get org-export-latex-options-plist :footnotes)
+ (goto-char (point-min))
+ (while (re-search-forward "\\[\\([0-9]+\\)\\]" nil t)
+ (org-if-unprotected
+ (when (save-match-data
+ (save-excursion (beginning-of-line)
+ (looking-at "[^:|#]")))
+ (let ((foot-beg (match-beginning 0))
+ (foot-end (match-end 0))
+ (foot-prefix (match-string 0))
+ footnote footnote-rpl)
+ (save-excursion
+ (if (not (re-search-forward (concat "^" (regexp-quote foot-prefix))
+ nil t))
+ (replace-match "$^{\\1}$")
+ (replace-match "")
+ (let ((end (save-excursion
+ (if (re-search-forward "^$\\|^#.*$\\|\\[[0-9]+\\]" nil t)
+ (match-beginning 0) (point-max)))))
+ (setq footnote (concat (org-trim (buffer-substring (point) end))
+ " ")) ; prevent last } being part of a link
+ (delete-region (point) end))
+ (goto-char foot-beg)
+ (delete-region foot-beg foot-end)
+ (unless (null footnote)
+ (setq footnote-rpl (format "\\footnote{%s}" footnote))
+ (add-text-properties 0 10 '(org-protected t) footnote-rpl)
+ (add-text-properties (1- (length footnote-rpl))
+ (length footnote-rpl)
+ '(org-protected t) footnote-rpl)
+ (insert footnote-rpl)))
+ )))))
+
+ ;; Remove footnote section tag for LaTeX
+ (goto-char (point-min))
+ (while (re-search-forward
+ (concat "^" footnote-section-tag-regexp) nil t)
+ (org-if-unprotected
+ (replace-match "")))))
+
+;;; List handling:
+
+(defun org-export-latex-lists ()
+ "Convert plain text lists in current buffer into LaTeX lists."
+ (goto-char (point-min))
+ (while (re-search-forward org-list-beginning-re nil t)
+ (org-if-unprotected
+ (beginning-of-line)
+ (insert (org-list-to-latex (org-list-parse-list t)
+ org-export-latex-list-parameters))
+ "\n")))
+
+(defconst org-latex-entities
+ '("\\!"
+ "\\'"
+ "\\+"
+ "\\,"
+ "\\-"
+ "\\:"
+ "\\;"
+ "\\<"
+ "\\="
+ "\\>"
+ "\\Huge"
+ "\\LARGE"
+ "\\Large"
+ "\\Styles"
+ "\\\\"
+ "\\`"
+ "\\addcontentsline"
+ "\\address"
+ "\\addtocontents"
+ "\\addtocounter"
+ "\\addtolength"
+ "\\addvspace"
+ "\\alph"
+ "\\appendix"
+ "\\arabic"
+ "\\author"
+ "\\begin{array}"
+ "\\begin{center}"
+ "\\begin{description}"
+ "\\begin{enumerate}"
+ "\\begin{eqnarray}"
+ "\\begin{equation}"
+ "\\begin{figure}"
+ "\\begin{flushleft}"
+ "\\begin{flushright}"
+ "\\begin{itemize}"
+ "\\begin{list}"
+ "\\begin{minipage}"
+ "\\begin{picture}"
+ "\\begin{quotation}"
+ "\\begin{quote}"
+ "\\begin{tabbing}"
+ "\\begin{table}"
+ "\\begin{tabular}"
+ "\\begin{thebibliography}"
+ "\\begin{theorem}"
+ "\\begin{titlepage}"
+ "\\begin{verbatim}"
+ "\\begin{verse}"
+ "\\bf"
+ "\\bf"
+ "\\bibitem"
+ "\\bigskip"
+ "\\cdots"
+ "\\centering"
+ "\\circle"
+ "\\cite"
+ "\\cleardoublepage"
+ "\\clearpage"
+ "\\cline"
+ "\\closing"
+ "\\dashbox"
+ "\\date"
+ "\\ddots"
+ "\\dotfill"
+ "\\em"
+ "\\fbox"
+ "\\flushbottom"
+ "\\fnsymbol"
+ "\\footnote"
+ "\\footnotemark"
+ "\\footnotesize"
+ "\\footnotetext"
+ "\\frac"
+ "\\frame"
+ "\\framebox"
+ "\\hfill"
+ "\\hline"
+ "\\hrulespace"
+ "\\hspace"
+ "\\huge"
+ "\\hyphenation"
+ "\\include"
+ "\\includeonly"
+ "\\indent"
+ "\\input"
+ "\\it"
+ "\\kill"
+ "\\label"
+ "\\large"
+ "\\ldots"
+ "\\line"
+ "\\linebreak"
+ "\\linethickness"
+ "\\listoffigures"
+ "\\listoftables"
+ "\\location"
+ "\\makebox"
+ "\\maketitle"
+ "\\mark"
+ "\\mbox"
+ "\\medskip"
+ "\\multicolumn"
+ "\\multiput"
+ ("\\nbsp" "~")
+ "\\newcommand"
+ "\\newcounter"
+ "\\newenvironment"
+ "\\newfont"
+ "\\newlength"
+ "\\newline"
+ "\\newpage"
+ "\\newsavebox"
+ "\\newtheorem"
+ "\\nocite"
+ "\\nofiles"
+ "\\noindent"
+ "\\nolinebreak"
+ "\\nopagebreak"
+ "\\normalsize"
+ "\\onecolumn"
+ "\\opening"
+ "\\oval"
+ "\\overbrace"
+ "\\overline"
+ "\\pagebreak"
+ "\\pagenumbering"
+ "\\pageref"
+ "\\pagestyle"
+ "\\par"
+ "\\parbox"
+ "\\put"
+ "\\raggedbottom"
+ "\\raggedleft"
+ "\\raggedright"
+ "\\raisebox"
+ "\\ref"
+ "\\rm"
+ "\\roman"
+ "\\rule"
+ "\\savebox"
+ "\\sc"
+ "\\scriptsize"
+ "\\setcounter"
+ "\\setlength"
+ "\\settowidth"
+ "\\sf"
+ "\\shortstack"
+ "\\signature"
+ "\\sl"
+ "\\small"
+ "\\smallskip"
+ "\\sqrt"
+ "\\tableofcontents"
+ "\\telephone"
+ "\\thanks"
+ "\\thispagestyle"
+ "\\tiny"
+ "\\title"
+ "\\tt"
+ "\\twocolumn"
+ "\\typein"
+ "\\typeout"
+ "\\underbrace"
+ "\\underline"
+ "\\usebox"
+ "\\usecounter"
+ "\\value"
+ "\\vdots"
+ "\\vector"
+ "\\verb"
+ "\\vfill"
+ "\\vline"
+ "\\vspace")
+ "A list of LaTeX commands to be protected when performing conversion.")
+
+(defvar org-latex-entities-exceptions nil)
+
+(defconst org-latex-entities-regexp
+ (let (names rest)
+ (dolist (x org-latex-entities)
+ (when (consp x)
+ (add-to-list 'org-latex-entities-exceptions x)
+ (setq x (car x)))
+ (if (string-match "[a-z][A-Z]$" x)
+ (push x names)
+ (push x rest)))
+ (concat "\\(" (regexp-opt (nreverse names)) "\\>\\)"
+ "\\|\\(" (regexp-opt (nreverse rest)) "\\)")))
+
+(provide 'org-export-latex)
+(provide 'org-latex)
+
+;; arch-tag: 23c2b87d-da04-4c2d-ad2d-1eb6487bc3ad
+
+;;; org-latex.el ends here
;; Bastien Guerry <bzg AT altern DOT org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(defvar org-blank-before-new-entry)
(defvar org-M-RET-may-split-line)
+(defvar org-complex-heading-regexp)
+(defvar org-odd-levels-only)
(declare-function org-invisible-p "org" ())
(declare-function org-on-heading-p "org" (&optional invisible-ok))
(declare-function org-get-indentation "org" (&optional line))
(declare-function org-timer-item "org-timer" (&optional arg))
(declare-function org-combine-plists "org" (&rest plists))
+(declare-function org-entry-get "org" (pom property &optional inherit))
+(declare-function org-narrow-to-subtree "org" ())
+(declare-function org-show-subtree "org" ())
(defgroup org-plain-lists nil
"Options concerning plain lists in Org-mode."
:tag "Org Plain lists"
:group 'org-structure)
-(defcustom org-cycle-include-plain-lists nil
- "Non-nil means, include plain lists into visibility cycling.
-This means that during cycling, plain list items will *temporarily* be
-interpreted as outline headlines with a level given by 1000+i where i is the
-indentation of the bullet. In all other operations, plain list items are
-not seen as headlines. For example, you cannot assign a TODO keyword to
-such an item."
+(defcustom org-cycle-include-plain-lists t
+ "When t, make TAB cycle visibility on plain list items.
+
+Cycling plain lists works only when the cursor is on a plain list
+item. When the cursor is on an outline heading, plain lists are
+treated as text. This is the most stable way of handling this,
+which is why it is the default.
+
+When this is the symbol `integrate', then during cycling, plain
+list items will *temporarily* be interpreted as outline headlines
+with a level given by 1000+i where i is the indentation of the
+bullet. This setting can lead to strange effects when switching
+visibility to `children', because the first \"child\" in a
+subtree decides what children should be listed. If that first
+\"child\" is a plain list item with an implied large level
+number, all true children and grand children of the outline
+heading will be exposed in a children' view."
:group 'org-plain-lists
- :type 'boolean)
+ :type '(choice
+ (const :tag "Never" nil)
+ (const :tag "With cursor in plain list (recommended)" t)
+ (const :tag "As children of outline headings" integrate)))
+
+(defcustom org-list-demote-modify-bullet nil
+ "Default bullet type installed when demoting an item.
+This is an association list, for each bullet type, this alist will point
+to the bulled that should be used when this item is demoted."
+ :group 'org-plain-lists
+ :type '(repeat
+ (cons
+ (choice :tag "If the current bullet is "
+ (const "-")
+ (const "+")
+ (const "*")
+ (const "1.")
+ (const "1)"))
+ (choice :tag "demotion will change it to"
+ (const "-")
+ (const "+")
+ (const "*")
+ (const "1.")
+ (const "1)")))))
(defcustom org-plain-list-ordered-item-terminator t
"The character that makes a line with leading number an ordered list item.
(defcustom org-provide-checkbox-statistics t
"Non-nil means, update checkbox statistics after insert and toggle.
-When this is set, checkbox statistics is updated each time you either insert
-a new checkbox with \\[org-insert-todo-heading] or toggle a checkbox
-with \\[org-ctrl-c-ctrl-c\\]."
+When this is set, checkbox statistics is updated each time you
+either insert a new checkbox with \\[org-insert-todo-heading] or
+toggle a checkbox with \\[org-ctrl-c-ctrl-c]."
+ :group 'org-plain-lists
+ :type 'boolean)
+
+(defcustom org-hierarchical-checkbox-statistics t
+ "Non-nil means, checkbox statistics counts only the state of direct children.
+When nil, all boxes below the cookie are counted."
:group 'org-plain-lists
:type 'boolean)
:type 'integer)
(defvar org-list-beginning-re
- "^\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) +\\(.*\\)$")
+ "^\\([ \t]*\\)\\([-+]\\|[0-9]+[.)]\\) +\\(.*\\)$")
(defcustom org-list-radio-list-templates
'((latex-mode "% BEGIN RECEIVE ORGLST %n
(cond
((eq llt t) "\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
((= llt ?.) "\\([ \t]*\\([-+]\\|\\([0-9]+\\.\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
- ((= llt ?\)) "\\([ \t]*\\([-+]\\|\\([0-9]+))\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
+ ((= llt ?\)) "\\([ \t]*\\([-+]\\|\\([0-9]+)\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
(t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
(defun org-at-item-bullet-p ()
descp))))
(eow (save-excursion (beginning-of-line 1) (looking-at "[ \t]*")
(match-end 0)))
- (blank-a (cdr (assq 'plain-list-item org-blank-before-new-entry)))
+ (blank-a (if org-empty-line-terminates-plain-lists
+ nil
+ (cdr (assq 'plain-list-item org-blank-before-new-entry))))
(blank (if (eq blank-a 'auto) empty-line-p blank-a))
pos)
(if descp (setq checkbox nil))
(defun org-toggle-checkbox (&optional toggle-presence)
"Toggle the checkbox in the current line.
With prefix arg TOGGLE-PRESENCE, add or remove checkboxes.
+With double prefix, set checkbox to [-].
When there is an active region, toggle status or presence of the checkbox
in the first line, and make every item in the region have the same
status or presence, respectively.
text below the heading."
(interactive "P")
(catch 'exit
- (let (beg end status first-present first-status)
+ (let (beg end status first-present first-status blocked)
(cond
((org-region-active-p)
(setq beg (region-beginning) end (region-end)))
((org-on-heading-p)
(setq beg (point) end (save-excursion (outline-next-heading) (point))))
((org-at-item-checkbox-p)
- (let ((pos (point)))
- (if toggle-presence
+ (save-excursion
+ (if (equal toggle-presence '(4))
(progn
(replace-match "")
(goto-char (match-beginning 0))
(just-one-space))
+ (when (setq blocked (org-checkbox-blocked-p))
+ (error "Checkbox blocked because of unchecked box in line %d"
+ blocked))
(replace-match
- (cond ((member (match-string 0) '("[ ]" "[-]")) "[X]")
+ (cond ((equal toggle-presence '(16)) "[-]")
+ ((member (match-string 0) '("[ ]" "[-]")) "[X]")
(t "[ ]"))
- t t))
- (goto-char pos))
+ t t)))
(throw 'exit t))
((org-at-item-p)
;; add a checkbox
(beginning-of-line 2)))))
(org-update-checkbox-count-maybe))
+(defun org-reset-checkbox-state-subtree ()
+ "Reset all checkboxes in an entry subtree."
+ (interactive "*")
+ (save-restriction
+ (save-excursion
+ (org-narrow-to-subtree)
+ (org-show-subtree)
+ (goto-char (point-min))
+ (let ((end (point-max)))
+ (while (< (point) end)
+ (when (org-at-item-checkbox-p)
+ (replace-match "[ ]" t t))
+ (beginning-of-line 2))))
+ (org-update-checkbox-count-maybe)))
+
+(defun org-checkbox-blocked-p ()
+ "Is the current checkbox blocked from for being checked now?
+A checkbox is blocked if all of the following conditions are fulfilled:
+
+1. The checkbox is not checked already.
+2. The current entry has the ORDERED property set.
+3. There is an unchecked checkbox in this entry before the current line."
+ (catch 'exit
+ (save-match-data
+ (save-excursion
+ (unless (org-at-item-checkbox-p) (throw 'exit nil))
+ (when (equal (match-string 0) "[X]")
+ ;; the box is already checked!
+ (throw 'exit nil))
+ (let ((end (point-at-bol)))
+ (condition-case nil (org-back-to-heading t)
+ (error (throw 'exit nil)))
+ (unless (org-entry-get nil "ORDERED") (throw 'exit nil))
+ (if (re-search-forward "^[ \t]*[-+*0-9.)] \\[[- ]\\]" end t)
+ (org-current-line)
+ nil))))))
+
+(defvar org-checkbox-statistics-hook nil
+ "Hook that is run whenever Org thinks checkbox statistics should be updated.
+This hook runs even if `org-provide-checkbox-statistics' is nil, to it can
+be used to implement alternative ways of collecting statistics information.")
+
(defun org-update-checkbox-count-maybe ()
"Update checkbox statistics unless turned off by user."
(when org-provide-checkbox-statistics
- (org-update-checkbox-count)))
+ (org-update-checkbox-count))
+ (run-hooks 'org-checkbox-statistics-hook))
(defun org-update-checkbox-count (&optional all)
"Update the checkbox statistics in the current section.
(re-find (concat re "\\|" re-box))
beg-cookie end-cookie is-percent c-on c-off lim
eline curr-ind next-ind continue-from startsearch
+ (recursive
+ (or (not org-hierarchical-checkbox-statistics)
+ (string-match "\\<recursive\\>"
+ (or (org-entry-get nil "COOKIE_DATA") ""))))
(cstat 0)
)
(when all
(outline-next-heading)
(setq beg (point) end (point-max)))
(goto-char end)
- ;; find each statistic cookie
- (while (re-search-backward re-find beg t)
+ ;; find each statistics cookie
+ (while (and (re-search-backward re-find beg t)
+ (not (save-match-data
+ (and (org-on-heading-p)
+ (string-match "\\<todo\\>"
+ (downcase
+ (or (org-entry-get
+ nil "COOKIE_DATA")
+ "")))))))
(setq beg-cookie (match-beginning 1)
end-cookie (match-end 1)
cstat (+ cstat (if end-cookie 1 0))
(org-beginning-of-item)
(setq curr-ind (org-get-indentation))
(setq next-ind curr-ind)
- (while (and (bolp) (org-at-item-p) (= curr-ind next-ind))
+ (while (and (bolp) (org-at-item-p)
+ (if recursive
+ (<= curr-ind next-ind)
+ (= curr-ind next-ind)))
(save-excursion (end-of-line) (setq eline (point)))
(if (re-search-forward re-box eline t)
(if (member (match-string 2) '("[ ]" "[-]"))
(setq c-off (1+ c-off))
- (setq c-on (1+ c-on))
- )
- )
- (org-end-of-item)
- (setq next-ind (org-get-indentation))
- )))
+ (setq c-on (1+ c-on))))
+ (if (not recursive)
+ (org-end-of-item)
+ (end-of-line)
+ (when (re-search-forward org-list-beginning-re lim t)
+ (beginning-of-line)))
+ (setq next-ind (org-get-indentation)))))
(goto-char continue-from)
;; update cookie
(when end-cookie
The face will be `org-done' when all relevant boxes are checked. Otherwise
it will be `org-todo'."
(if (match-end 1)
- (if (equal (match-string 1) "100%") 'org-done 'org-todo)
+ (if (equal (match-string 1) "100%")
+ 'org-checkbox-statistics-done
+ 'org-checkbox-statistics-todo)
(if (and (> (match-end 2) (match-beginning 2))
(equal (match-string 2) (match-string 3)))
- 'org-done
- 'org-todo)))
+ 'org-checkbox-statistics-done
+ 'org-checkbox-statistics-todo)))
(defun org-beginning-of-item ()
"Go to the beginning of the current hand-formatted item.
(error "On first item")))))
(defun org-first-list-item-p ()
- "Is this heading the item in a plain list?"
+ "Is this heading the first item in a plain list?"
(unless (org-at-item-p)
(error "Not at a plain list item"))
- (org-beginning-of-item)
- (= (point) (save-excursion (org-beginning-of-item-list))))
+ (save-excursion
+ (org-beginning-of-item)
+ (= (point) (save-excursion (org-beginning-of-item-list)))))
(defun org-move-item-down ()
"Move the plain list item at point down, i.e. swap with following item.
(org-beginning-of-item-list)
(setq bobp (bobp))
(looking-at "[ \t]*[0-9]+\\([.)]\\)")
- (setq fmt (concat "%d" (match-string 1)))
+ (setq fmt (concat "%d" (or (match-string 1) ".")))
(beginning-of-line 0)
;; walk forward and replace these numbers
(catch 'exit
(goto-line line)
(org-move-to-column col)))
-(defun org-fix-bullet-type ()
+(defun org-fix-bullet-type (&optional force-bullet)
"Make sure all items in this list have the same bullet as the first item.
Also, fix the indentation."
(interactive)
(beginning-of-line 1)
;; find out what the bullet type is
(looking-at "[ \t]*\\(\\S-+\\)")
- (setq bullet (concat (match-string 1) " "))
+ (setq bullet (concat (or force-bullet (match-string 1)) " "))
(if (and org-list-two-spaces-after-bullet-regexp
(string-match org-list-two-spaces-after-bullet-regexp bullet))
(setq bullet (concat bullet " ")))
(skip-chars-forward " \t")
(looking-at "\\S-+ *")
(setq oldbullet (match-string 0))
- (replace-match bullet)
+ (unless (equal bullet oldbullet) (replace-match bullet))
(org-shift-item-indentation (- (length bullet) (length oldbullet))))))
(goto-line line)
(org-move-to-column col)
(when (org-at-item-p) (setq pos (point-at-bol)))))))
(goto-char pos)))
-
(defun org-end-of-item-list ()
"Go to the end of the current item list.
I.e. to the text after the last item."
(catch 'next
(beginning-of-line 2)
(if (looking-at "[ \t]*$")
- (throw (if (eobp) 'exit 'next) t))
+ (if (eobp)
+ (progn (setq pos (point)) (throw 'exit t))
+ (throw 'next t)))
(skip-chars-forward " \t") (setq ind1 (current-column))
(if (or (< ind1 ind)
(and (= ind1 ind)
(defun org-indent-item (arg)
"Indent a local list item."
(interactive "p")
+ (and (org-region-active-p) (org-cursor-to-region-beginning))
(unless (org-at-item-p)
(error "Not on an item"))
- (save-excursion
- (let (beg end ind ind1 tmp delta ind-down ind-up)
+ (let (beg end ind ind1 ind-bul delta ind-down ind-up firstp)
+ (setq firstp (org-first-list-item-p))
+ (save-excursion
+ (setq end (and (org-region-active-p) (region-end)))
(if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
(setq beg org-last-indent-begin-marker
end org-last-indent-end-marker)
(org-beginning-of-item)
(setq beg (move-marker org-last-indent-begin-marker (point)))
(org-end-of-item)
- (setq end (move-marker org-last-indent-end-marker (point))))
+ (setq end (move-marker org-last-indent-end-marker (or end (point)))))
(goto-char beg)
- (setq tmp (org-item-indent-positions)
- ind (car tmp)
- ind-down (nth 2 tmp)
- ind-up (nth 1 tmp)
+ (setq ind-bul (org-item-indent-positions)
+ ind (caar ind-bul)
+ ind-down (car (nth 2 ind-bul))
+ ind-up (car (nth 1 ind-bul))
delta (if (> arg 0)
(if ind-down (- ind-down ind) 2)
(if ind-up (- ind-up ind) -2)))
(skip-chars-forward " \t") (setq ind1 (current-column))
(delete-region (point-at-bol) (point))
(or (eolp) (org-indent-to-column (+ ind1 delta)))
- (beginning-of-line 2))))
- (org-fix-bullet-type)
- (org-maybe-renumber-ordered-list-safe)
- (save-excursion
- (beginning-of-line 0)
- (condition-case nil (org-beginning-of-item) (error nil))
- (org-maybe-renumber-ordered-list-safe)))
+ (beginning-of-line 2)))
+ (org-fix-bullet-type
+ (and (> arg 0)
+ (not firstp)
+ (cdr (assoc (cdr (nth 0 ind-bul)) org-list-demote-modify-bullet))))
+ (org-maybe-renumber-ordered-list-safe)
+ (save-excursion
+ (beginning-of-line 0)
+ (condition-case nil (org-beginning-of-item) (error nil))
+ (org-maybe-renumber-ordered-list-safe))))
(defun org-item-indent-positions ()
"Return indentation for plain list items.
Assumes cursor in item line."
(let* ((bolpos (point-at-bol))
(ind (org-get-indentation))
- ind-down ind-up pos)
+ (bullet (org-get-bullet))
+ ind-down ind-up bullet-up bullet-down pos)
(save-excursion
(org-beginning-of-item-list)
(skip-chars-backward "\n\r \t")
(when (org-in-item-p)
(org-beginning-of-item)
- (setq ind-up (org-get-indentation))))
+ (setq ind-up (org-get-indentation))
+ (setq bullet-up (org-get-bullet))))
(setq pos (point))
(save-excursion
(cond
(error nil))
(or (forward-char 1) t)
(re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
- (setq ind-down (org-get-indentation)))
+ (setq ind-down (org-get-indentation)
+ bullet-down (org-get-bullet)))
((and (goto-char pos)
(org-at-item-p))
(goto-char (match-end 0))
(skip-chars-forward " \t")
- (setq ind-down (current-column)))))
- (list ind ind-up ind-down)))
-
+ (setq ind-down (current-column)
+ bullet-down (org-get-bullet)))))
+ (if (and bullet-down (string-match "\\`[0-9]+\\(\\.\\|)\\)\\'" bullet-down))
+ (setq bullet-down (concat "1" (match-string 1 bullet-down))))
+ (if (and bullet-up (string-match "\\`[0-9]+\\(\\.\\|)\\)\\'" bullet-up))
+ (setq bullet-up (concat "1" (match-string 1 bullet-up))))
+ (if (and bullet (string-match "\\`[0-9]+\\(\\.\\|)\\)\\'" bullet))
+ (setq bullet (concat "1" (match-string 1 bullet))))
+ (list (cons ind bullet)
+ (cons ind-up bullet-up)
+ (cons ind-down bullet-down))))
+
+(defun org-get-bullet ()
+ (save-excursion
+ (goto-char (point-at-bol))
+ (and (looking-at
+ "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\(\\*\\)\\)\\( \\|$\\)")
+ (or (match-string 2) (match-string 4)))))
;;; Send and receive lists
(progn (goto-char (point-min)) (point))
(cons (match-beginning 0) (match-string 1)))))
+(defun org-list-goto-true-beginning ()
+ "Go to the beginning of the list at point."
+ (beginning-of-line 1)
+ (while (looking-at org-list-beginning-re)
+ (beginning-of-line 0))
+ (progn
+ (re-search-forward org-list-beginning-re nil t)
+ (goto-char (match-beginning 0))))
+
+(defun org-list-make-subtree ()
+ "Convert the plain list at point into a subtree."
+ (interactive)
+ (org-list-goto-true-beginning)
+ (let ((list (org-list-parse-list t)) nstars)
+ (save-excursion
+ (if (condition-case nil
+ (org-back-to-heading)
+ (error nil))
+ (progn (re-search-forward org-complex-heading-regexp nil t)
+ (setq nstars (length (match-string 1))))
+ (setq nstars 0)))
+ (org-list-make-subtrees list (1+ nstars))))
+
+(defun org-list-make-subtrees (list level)
+ "Convert LIST into subtrees starting at LEVEL."
+ (if (symbolp (car list))
+ (org-list-make-subtrees (cdr list) level)
+ (mapcar (lambda (item)
+ (if (stringp item)
+ (insert (make-string
+ (if org-odd-levels-only
+ (1- (* 2 level)) level) ?*) " " item "\n")
+ (org-list-make-subtrees item (1+ level))))
+ list)))
+
(defun org-list-end (indent)
"Return the position of the end of the list.
-INDENT is the indentation of the list."
+INDENT is the indentation of the list, as a string."
(save-excursion
(catch 'exit
(while (or (looking-at org-list-beginning-re)
- (looking-at (concat "^" indent "[ \t]+\\|^$")))
+ (looking-at (concat "^" indent "[ \t]+\\|^$"))
+ (> (or (get-text-property (point) 'original-indentation) -1)
+ (length indent)))
(if (eq (point) (point-max))
(throw 'exit (point-max)))
- (forward-line 1))) (point)))
+ (forward-line 1)))
+ (point)))
(defun org-list-insert-radio-list ()
"Insert a radio list template appropriate for this major mode."
(catch 'exit
(unless (org-at-item-p) (error "Not at a list"))
(save-excursion
- (goto-char (car (org-list-item-beginning)))
+ (org-list-goto-true-beginning)
(beginning-of-line 0)
(unless (looking-at "#\\+ORGLST: *SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
(if maybe
LIST is as returnd by `org-list-parse-list'. PARAMS is a property list
with overruling parameters for `org-list-to-generic'."
(org-list-to-generic
- list
+ list
(org-combine-plists
'(:splicep nil :ostart "@itemize @minus" :oend "@end itemize"
:ustart "@enumerate" :uend "@end enumerate"
-;;; org-mac-message.el --- Support for links to Apple Mail messages from within Org-mode
+;;; org-mac-message.el --- Links to Apple Mail.app messages from within Org-mode
;; Copyright (C) 2008, 2009 Free Software Foundation, Inc.
;; Author: John Wiegley <johnw@gnu.org>
-;; Version: 6.21b
+;; Christopher Suckling <suckling at gmail dot com>
+
+;; Version: 6.29c
;; Keywords: outlines, hypermedia, calendar, wp
;; This file is part of GNU Emacs.
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
-;; This file implements links to Apple Mail messages from within Org-mode.
+;; This file implements links to Apple Mail.app messages from within Org-mode.
;; Org-mode does not load this module by default - if you would actually like
;; this to happen then configure the variable `org-modules'.
+;; If you would like to create links to all flagged messages in an
+;; Apple Mail.app account, please customize the variable
+;; `org-mac-mail-account' and then call one of the following functions:
+
+;; (org-mac-message-insert-selected) copies a formatted list of links to
+;; the kill ring.
+
+;; (org-mac-message-insert-selected) inserts at point links to any
+;; messages selected in Mail.app.
+
+;; (org-mac-message-insert-flagged) searches within an org-mode buffer
+;; for a specific heading, creating it if it doesn't exist. Any
+;; message:// links within the first level of the heading are deleted
+;; and replaced with links to flagged messages.
+
;;; Code:
(require 'org)
+(defgroup org-mac-flagged-mail nil
+ "Options concerning linking to flagged Mail.app messages"
+ :tag "Org Mail.app"
+ :group 'org-link)
+
+(defcustom org-mac-mail-account "customize"
+ "The Mail.app account in which to search for flagged messages"
+ :group 'org-mac-flagged-mail
+ :type 'string)
+
(org-add-link-type "message" 'org-mac-message-open)
;; In mac.c, removed in Emacs 23.
(start-process (concat "open message:" message-id) nil
"open" (concat "message://<" (substring message-id 2) ">")))
-(defun org-mac-message-insert-link ()
- "Insert a link to the messages currently selected in Apple Mail.
+(defun as-get-selected-mail ()
+ "AppleScript to create links to selected messages in Mail.app"
+ (do-applescript
+ (concat
+ "tell application \"Mail\"\n"
+ "set theLinkList to {}\n"
+ "set theSelection to selection\n"
+ "repeat with theMessage in theSelection\n"
+ "set theID to message id of theMessage\n"
+ "set theSubject to subject of theMessage\n"
+ "set theLink to \"message://\" & theID & \"::split::\" & theSubject & \"\n\"\n"
+ "copy theLink to end of theLinkList\n"
+ "end repeat\n"
+ "return theLinkList as string\n"
+ "end tell")))
+
+(defun as-get-flagged-mail ()
+ "AppleScript to create links to flagged messages in Mail.app"
+ (do-applescript
+ (concat
+ ;; Is Growl installed?
+ "tell application \"System Events\"\n"
+ "set growlHelpers to the name of every process whose creator type contains \"GRRR\"\n"
+ "if (count of growlHelpers) > 0 then\n"
+ "set growlHelperApp to item 1 of growlHelpers\n"
+ "else\n"
+ "set growlHelperApp to \"\"\n"
+ "end if\n"
+ "end tell\n"
+
+ ;; Get links
+ "tell application \"Mail\"\n"
+ "set theMailboxes to every mailbox of account \"" org-mac-mail-account "\"\n"
+ "set theLinkList to {}\n"
+ "repeat with aMailbox in theMailboxes\n"
+ "set theSelection to (every message in aMailbox whose flagged status = true)\n"
+ "repeat with theMessage in theSelection\n"
+ "set theID to message id of theMessage\n"
+ "set theSubject to subject of theMessage\n"
+ "set theLink to \"message://\" & theID & \"::split::\" & theSubject & \"\n\"\n"
+ "copy theLink to end of theLinkList\n"
+
+ ;; Report progress through Growl
+ ;; This "double tell" idiom is described in detail at
+ ;; http://macscripter.net/viewtopic.php?id=24570 The
+ ;; script compiler needs static knowledge of the
+ ;; growlHelperApp. Hmm, since we're compiling
+ ;; on-the-fly here, this is likely to be way less
+ ;; portable than I'd hoped. It'll work when the name
+ ;; is still "GrowlHelperApp", though.
+ "if growlHelperApp is not \"\" then\n"
+ "tell application \"GrowlHelperApp\"\n"
+ "tell application growlHelperApp\n"
+ "set the allNotificationsList to {\"FlaggedMail\"}\n"
+ "set the enabledNotificationsList to allNotificationsList\n"
+ "register as application \"FlaggedMail\" all notifications allNotificationsList default notifications enabledNotificationsList icon of application \"Mail\"\n"
+ "notify with name \"FlaggedMail\" title \"Importing flagged message\" description theSubject application name \"FlaggedMail\"\n"
+ "end tell\n"
+ "end tell\n"
+ "end if\n"
+ "end repeat\n"
+ "end repeat\n"
+ "return theLinkList as string\n"
+ "end tell")))
+
+(defun org-mac-message-get-links (&optional select-or-flag)
+ "Create links to the messages currently selected or flagged in Mail.app.
+This will use AppleScript to get the message-id and the subject of the
+messages in Mail.app and make a link out of it.
+When SELECT-OR-FLAG is \"s\", get the selected messages (this is also
+the default). When SELECT-OR-FLAG is \"f\", get the flagged messages.
+The Org-syntax text will be pushed to the kill ring, and also returned."
+ (interactive "sLink to (s)elected or (f)lagged messages: ")
+ (setq select-or-flag (or select-or-flag "s"))
+ (message "AppleScript: searching mailboxes...")
+ (let* ((as-link-list
+ (if (string= select-or-flag "s")
+ (as-get-selected-mail)
+ (if (string= select-or-flag "f")
+ (as-get-flagged-mail)
+ (error "Please select \"s\" or \"f\""))))
+ (link-list
+ (mapcar
+ (lambda (x) (if (string-match "\\`\"\\(.*\\)\"\\'" x) (setq x (match-string 1 x))) x)
+ (split-string as-link-list "[\r\n]+")))
+ split-link URL description orglink orglink-insert rtn orglink-list)
+ (while link-list
+ (setq split-link (split-string (pop link-list) "::split::"))
+ (setq URL (car split-link))
+ (setq description (cadr split-link))
+ (when (not (string= URL ""))
+ (setq orglink (org-make-link-string URL description))
+ (push orglink orglink-list)))
+ (setq rtn (mapconcat 'identity orglink-list "\n"))
+ (kill-new rtn)
+ rtn))
+
+(defun org-mac-message-insert-selected ()
+ "Insert a link to the messages currently selected in Mail.app.
This will use applescript to get the message-id and the subject of the
-active mail in AppleMail and make a link out of it."
+active mail in Mail.app and make a link out of it."
(interactive)
- (insert (org-mac-message-get-link)))
-
-(defun org-mac-message-get-link ()
- "Insert a link to the messages currently selected in Apple Mail.
-This will use applescript to get the message-id and the subject of the
-active mail in AppleMail and make a link out of it."
- (let ((subject (do-applescript "tell application \"Mail\"
- set theMessages to selection
- subject of beginning of theMessages
-end tell"))
- (message-id (do-applescript "tell application \"Mail\"
- set theMessages to selection
- message id of beginning of theMessages
-end tell")))
- (org-make-link-string
- (concat "message://"
- (substring message-id 1 (1- (length message-id))))
- (substring subject 1 (1- (length subject))))))
+ (insert (org-mac-message-get-links "s")))
+
+;; The following line is for backward compatibility
+(defalias 'org-mac-message-insert-link 'org-mac-message-insert-selected)
+
+(defun org-mac-message-insert-flagged (org-buffer org-heading)
+ "Asks for an org buffer and a heading within it, and replace message links.
+If heading exists, delete all message:// links within heading's first
+level. If heading doesn't exist, create it at point-max. Insert
+list of message:// links to flagged mail after heading."
+ (interactive "bBuffer in which to insert links: \nsHeading after which to insert links: ")
+ (save-excursion
+ (set-buffer org-buffer)
+ (goto-char (point-min))
+ (let ((isearch-forward t)
+ (message-re "\\[\\[\\(message:\\)\\([^]]+\\)\\]\\(\\[\\([^]]+\\)\\]\\)?\\]"))
+ (if (org-goto-local-search-headings org-heading nil t)
+ (if (not (eobp))
+ (progn
+ (save-excursion
+ (while (re-search-forward
+ message-re (save-excursion (outline-next-heading)) t)
+ (delete-region (match-beginning 0) (match-end 0)))
+ (insert "\n" (org-mac-message-get-links "f")))
+ (flush-lines "^$" (point) (outline-next-heading)))
+ (insert "\n" (org-mac-message-get-links "f")))
+ (goto-char (point-max))
+ (insert "\n")
+ (org-insert-heading)
+ (insert org-heading "\n" (org-mac-message-get-links "f"))))))
(provide 'org-mac-message)
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;;; Code:
+(eval-and-compile
+ (unless (fboundp 'declare-function)
+ (defmacro declare-function (fn file &optional arglist fileonly))))
+
+(declare-function org-add-props "org-compat" (string plist &rest props))
+
(defmacro org-bound-and-true-p (var)
"Return the value of symbol VAR if it is bound, else nil."
`(and (boundp (quote ,var)) ,var))
(defmacro org-unmodified (&rest body)
- "Execute body without changing `buffer-modified-p'."
+ "Execute body without changing `buffer-modified-p'.
+Also, do not record undo information."
`(set-buffer-modified-p
- (prog1 (buffer-modified-p) ,@body)))
+ (prog1 (buffer-modified-p)
+ (let ((buffer-undo-list t)
+ before-change-functions after-change-functions)
+ ,@body))))
(defmacro org-re (s)
"Replace posix classes in regular expression."
,@body)
(if pc-mode (partial-completion-mode 1)))))
-(eval-and-compile
- (unless (fboundp 'declare-function)
- (defmacro declare-function (fn file &optional arglist fileonly))))
-
(defmacro org-maybe-intangible (props)
"Add '(intangible t) to PROPS if Emacs version is earlier than Emacs 22.
In emacs 21, invisible text is not avoided by the command loop, so the
`(unless (get-text-property (1- (point)) 'org-protected)
,@body))
+(defmacro org-if-unprotected-at (pos &rest body)
+ "Execute BODY if there is no `org-protected' text property at point-1."
+ `(unless (get-text-property ,pos 'org-protected)
+ ,@body))
+
(defmacro org-with-remote-undo (_buffer &rest _body)
"Execute BODY while recording undo information in two buffers."
`(let ((_cline (org-current-line))
((assoc key option) (cdr (assoc key option)))
(t (cdr (assq 'default option)))))
+(defsubst org-check-external-command (cmd &optional use no-error)
+ "Check if external progam CMD for USE exists, error if not.
+When the program does exist, return it's path.
+When it does not exist and NO-ERROR is set, return nil.
+Otherwise, throw an error. The optional argument USE can describe what this
+program is needed for, so that the error message can be more informative."
+ (or (executable-find cmd)
+ (if no-error
+ nil
+ (error "Can't find `%s'%s" cmd
+ (if use (format " (%s)" use) "")))))
+
(defsubst org-inhibit-invisibility ()
"Modified `buffer-invisibility-spec' for Emacs 21.
Some ops with invisible text do not work correctly on Emacs 21. For these
(defsubst org-set-local (var value)
"Make VAR local in current buffer and set it to VALUE."
- (set (make-variable-buffer-local var) value))
+ (set (make-local-variable var) value))
(defsubst org-mode-p ()
"Check if the current buffer is in Org-mode."
(setq plist (cddr plist)))
p))
+
+(defun org-replace-match-keep-properties (newtext &optional fixedcase
+ literal string)
+ "Like `replace-match', but add the text properties found original text."
+ (setq newtext (org-add-props newtext (text-properties-at
+ (match-beginning 0) string)))
+ (replace-match newtext fixedcase literal string))
+
+(defmacro org-with-limited-levels (&rest body)
+ "Execute BODY with limited number of outline levels."
+ `(let* ((outline-regexp (org-get-limited-outline-regexp)))
+ ,@body))
+
+(defvar org-odd-levels-only) ; defined in org.el
+(defvar org-inlinetask-min-level) ; defined in org-inlinetask.el
+(defun org-get-limited-outline-regexp ()
+ "Return outline-regexp with limited number of levels.
+The number of levels is controlled by "
+ (if (or (not (org-mode-p)) (not (featurep 'org-inlinetask)))
+
+ outline-regexp
+ (let* ((limit-level (1- org-inlinetask-min-level))
+ (nstars (if org-odd-levels-only (1- (* limit-level 2)) limit-level)))
+ (format "\\*\\{1,%d\\} " nstars))))
+
(provide 'org-macs)
;; arch-tag: 7e6a73ce-aac9-4fc0-9b30-ce6f89dc6668
;; Author: Tokuya Kameshima <kames at fa2 dot so-net dot ne dot jp>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;; This file is part of GNU Emacs.
;; Author: Thomas Baumann <thomas dot baumann at ch dot tum dot de>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;;
;; Author: Piotr Zielinski <piotr dot zielinski at gmail dot com>
;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(loop for priority from ?A to org-lowest-priority
collect (char-to-string priority)))
+(defun org-mouse-todo-menu (state)
+ "Create the menu with TODO keywords."
+ (append
+ (let ((kwds org-todo-keywords-1))
+ (org-mouse-keyword-menu
+ kwds
+ `(lambda (kwd) (org-todo kwd))
+ (lambda (kwd) (equal state kwd))))))
+
(defun org-mouse-tag-menu () ;todo
+ "Create the tags menu"
(append
(let ((tags (org-get-tags)))
(org-mouse-keyword-menu
["Set Tags ..." (org-set-tags) t])))
-
(defun org-mouse-set-tags (tags)
(save-excursion
;; remove existing tags first
(set-match-data ',match)
(apply ',function rest)))))
-(defun org-mouse-todo-keywords ()
- (if (boundp 'org-todo-keywords-1) org-todo-keywords-1 org-todo-keywords))
-
(defun org-mouse-match-todo-keyword ()
(save-excursion
(org-back-to-heading)
(org-mouse-remove-match-and-spaces))))]
)))
((and (org-mouse-looking-at "\\b\\w+" "a-zA-Z0-9_")
- (member (match-string 0) (org-mouse-todo-keywords)))
+ (member (match-string 0) org-todo-keywords-1))
(popup-menu
`(nil
- ,@(org-mouse-keyword-replace-menu (org-mouse-todo-keywords))
+ ,@(org-mouse-todo-menu (match-string 0))
"--"
["Check TODOs" org-show-todo-tree t]
["List all TODO keywords" org-todo-list t]
["Open" org-open-at-point t]
["Open in Emacs" (org-open-at-point t) t]
"--"
- ["Copy link" (kill-new (match-string 0))]
+ ["Copy link" (org-kill-new (match-string 0))]
["Cut link"
(progn
(kill-region (match-beginning 0) (match-end 0))
"--"
,@(org-mouse-tag-menu))
("TODO Status"
- ,@(progn (org-mouse-match-todo-keyword)
- (org-mouse-keyword-replace-menu (org-mouse-todo-keywords)
- 1)))
+ ,@(org-mouse-todo-menu (org-get-todo-state)))
["Show Tags"
(with-current-buffer org-mouse-main-buffer (org-agenda-show-tags))
:visible (not org-mouse-direct)]
(if (featurep 'xemacs) [button3] [mouse-3])
'org-mouse-show-context-menu)
(define-key org-agenda-keymap [down-mouse-3] 'org-mouse-move-tree-start)
- (define-key org-agenda-keymap [C-mouse-4] 'org-agenda-earlier)
- (define-key org-agenda-keymap [C-mouse-5] 'org-agenda-later)
+ (define-key org-agenda-keymap (if (featurep 'xemacs) [(control mouse-4)] [C-mouse-4]) 'org-agenda-earlier)
+ (define-key org-agenda-keymap (if (featurep 'xemacs) [(control mouse-5)] [C-mouse-5]) 'org-agenda-later)
(define-key org-agenda-keymap [drag-mouse-3]
'(lambda (event) (interactive "e")
(case (org-mouse-get-gesture event)
;; Author: Eric Schulte <schulte dot eric at gmail dot com>
;; Keywords: tables, plotting
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
("file" . :file)
("labels" . :labels)
("map" . :map)
+ ("timeind" . :timeind)
("timefmt" . :timefmt)))
(multiples '("set" "line"))
(regexp ":\\([\"][^\"]+?[\"]\\|[(][^)]+?[)]\\|[^ \t\n\r;,.]*\\)")
(setf back-edge "") (setf front-edge "")))))
row-vals))
-(defun org-plot/gnuplot-script (data-file num-cols params)
+(defun org-plot/gnuplot-script (data-file num-cols params &optional preface)
"Write a gnuplot script to DATA-FILE respecting the options set in PARAMS.
-NUM-COLS controls the number of columns plotted in a 2-d plot."
+NUM-COLS controls the number of columns plotted in a 2-d plot.
+Optional argument PREFACE returns only option parameters in a
+manner suitable for prepending to a user-specified script."
(let* ((type (plist-get params :plot-type))
(with (if (equal type 'grid)
'pm3d
(add-to-script (concat "set timefmt \""
(or timefmt ;; timefmt passed to gnuplot
"%Y-%m-%d-%H:%M:%S") "\"")))
- (case type ;; plot command
+ (unless preface
+ (case type ;; plot command
('2d (dotimes (col num-cols)
(unless (and (equal type '2d)
(or (and ind (equal (+ 1 col) ind))
('grid
(setq plot-lines (list (format "'%s' with %s title ''"
data-file with)))))
- (add-to-script
- (concat plot-cmd " " (mapconcat 'identity (reverse plot-lines) ",\\\n ")))
+ (add-to-script
+ (concat plot-cmd " " (mapconcat 'identity (reverse plot-lines) ",\\\n "))))
script)))
;;-----------------------------------------------------------------------------
;; write script
(with-temp-buffer
(if (plist-get params :script) ;; user script
- (progn (insert-file-contents (plist-get params :script))
- (goto-char (point-min))
- (while (re-search-forward "$datafile" nil t)
- (replace-match data-file nil nil)))
+ (progn (insert
+ (org-plot/gnuplot-script data-file num-cols params t))
+ (insert "\n")
+ (insert-file-contents (plist-get params :script))
+ (goto-char (point-min))
+ (while (re-search-forward "$datafile" nil t)
+ (replace-match data-file nil nil)))
(insert
(org-plot/gnuplot-script data-file num-cols params)))
;; graph table
(gnuplot-send-buffer-to-gnuplot))
;; cleanup
(bury-buffer (get-buffer "*gnuplot*"))
- (delete-file data-file))))
+ (run-with-idle-timer 0.1 nil (lambda () (delete-file data-file))))))
(provide 'org-plot)
--- /dev/null
+;;; org-protocol.el --- Intercept calls from emacsclient to trigger custom actions.
+;;
+;; Copyright (c) 2008, 2009
+;; Free Software Foundation, Inc.
+;;
+;; Author: Bastien Guerry <bzg AT altern DOT org>
+;; Author: Daniel M German <dmg AT uvic DOT org>
+;; Author: Sebastian Rose <sebastian_rose AT gmx DOT de>
+;; Author: Ross Patterson <me AT rpatterson DOT net>
+;; Maintainer: Sebastian Rose <sebastian_rose AT gmx DOT de>
+;; Keywords: org, emacsclient, wp
+;; Version: 6.29c
+
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; Commentary:
+;;
+;; Intercept calls from emacsclient to trigger custom actions.
+;;
+;; This is done by advising `server-visit-files' to scann the list of filenames
+;; for `org-protocol-the-protocol' and sub-procols defined in
+;; `org-protocol-protocol-alist' and `org-protocol-protocol-alist-default'.
+;;
+;; Any application that supports calling external programs with an URL
+;; as argument may be used with this functionality.
+;;
+;;
+;; Usage:
+;; ------
+;;
+;; 1.) Add this to your init file (.emacs probably):
+;;
+;; (add-to-list 'load-path "/path/to/org-protocol/")
+;; (require 'org-protocol)
+;;
+;; 3.) Ensure emacs-server is up and running.
+;; 4.) Try this from the command line (adjust the URL as needed):
+;;
+;; $ emacsclient \
+;; org-protocol://store-link://http:%2F%2Flocalhost%2Findex.html/The%20title
+;;
+;; 5.) Optionally add custom sub-protocols and handlers:
+;;
+;; (setq org-protocol-protocol-alist
+;; '(("my-protocol"
+;; :protocol "my-protocol"
+;; :function my-protocol-handler-fuction)))
+;;
+;; A "sub-protocol" will be found in URLs like this:
+;;
+;; org-protocol://sub-protocol://data
+;;
+;; If it works, you can now setup other applications for using this feature.
+;;
+;;
+;; As of March 2009 Firefox users follow the steps documented on
+;; http://kb.mozillazine.org/Register_protocol, Opera setup is described here:
+;; http://www.opera.com/support/kb/view/535/
+;;
+;;
+;; Documentation
+;; -------------
+;;
+;; org-protocol.el comes with and installs handlers to open sources of published
+;; online content, store and insert the browser's URLs and cite online content
+;; by clicking on a bookmark in Firefox, Opera and probably other browsers and
+;; applications:
+;;
+;; * `org-protocol-open-source' uses the sub-protocol \"open-source\" and maps
+;; URLs to local filenames defined in `org-protocol-project-alist'.
+;;
+;; * `org-protocol-store-link' stores an Org-link (if Org-mode is present) and
+;; pushes the browsers URL to the `kill-ring' for yanking. This handler is
+;; triggered through the sub-protocol \"store-link\".
+;;
+;; * Call `org-protocol-remember' by using the sub-protocol \"remember\". If
+;; Org-mode is loaded, emacs will popup a remember buffer and fill the
+;; template with the data provided. I.e. the browser's URL is inserted as an
+;; Org-link of which the page title will be the description part. If text
+;; was select in the browser, that text will be the body of the entry.
+;;
+;; You may use the same bookmark URL for all those standard handlers and just
+;; adjust the sub-protocol used:
+;;
+;; location.href='org-protocol://sub-protocol://'+
+;; encodeURIComponent(location.href)+'/'+
+;; encodeURIComponent(document.title)+'/'+
+;; encodeURIComponent(window.getSelection())
+;;
+;; The handler for the sub-protocol \"remember\" detects an optional template
+;; char that, if present, triggers the use of a special template.
+;; Example:
+;;
+;; location.href='org-protocol://sub-protocol://x/'+ ...
+;;
+;; use template ?x.
+;;
+;; Note, that using double shlashes is optional from org-protocol.el's point of
+;; view because emacsclient sqashes the slashes to one.
+;;
+;;
+;; provides: 'org-protocol
+;;
+;;; Code:
+
+(require 'org)
+(eval-when-compile
+ (require 'cl))
+
+(declare-function org-publish-initialize-files-alist "org-publish"
+ (&optional refresh))
+(declare-function org-publish-get-project-from-filename "org-publish"
+ (filename &optional up))
+(declare-function server-edit "server" ())
+
+
+(defgroup org-protocol nil
+ "Intercept calls from emacsclient to trigger custom actions.
+
+This is done by advising `server-visit-files' to scann the list of filenames
+for `org-protocol-the-protocol' and sub-procols defined in
+`org-protocol-protocol-alist' and `org-protocol-protocol-alist-default'."
+ :version "22.1"
+ :group 'convenience
+ :group 'org)
+
+
+;;; Variables:
+
+(defconst org-protocol-protocol-alist-default
+ '(("org-remember" :protocol "remember" :function org-protocol-remember :kill-client t)
+ ("org-store-link" :protocol "store-link" :function org-protocol-store-link)
+ ("org-open-source" :protocol "open-source" :function org-protocol-open-source))
+ "Default protocols to use.
+See `org-protocol-protocol-alist' for a description of this variable.")
+
+
+(defconst org-protocol-the-protocol "org-protocol"
+ "This is the protocol to detect if org-protocol.el is loaded.
+`org-protocol-protocol-alist-default' and `org-protocol-protocol-alist' hold the
+sub-protocols that trigger the required action. You will have to define just one
+protocol handler OS-wide (MS-Windows) or per application (Linux). That protocol
+handler should call emacsclient.")
+
+
+;;; User variables:
+
+(defcustom org-protocol-reverse-list-of-files t
+ "* The filenames passed on the commandline are passed to the emacs-server in
+reversed order. Set to `t' (default) to re-reverse the list, i.e. use the
+sequence on the command line. If nil, the sequence of the filenames is
+unchanged."
+ :group 'org-protocol
+ :type 'boolean)
+
+
+(defcustom org-protocol-project-alist nil
+ "* Map URLs to local filenames for `org-protocol-open-source' (open-source).
+
+Each element of this list must be of the form:
+
+ (module-name :property value property: value ...)
+
+where module-name is an arbitrary name. All the values are strings.
+
+Possible properties are:
+
+ :online-suffix - the suffix to strip from the published URLs
+ :working-suffix - the replacement for online-suffix
+ :base-url - the base URL, e.g. http://www.example.com/project/
+ Last slash required.
+ :working-directory - the local working directory. This is, what base-url will
+ be replaced with.
+
+Example:
+
+ (setq org-protocol-project-alist
+ '((\"http://orgmode.org/worg/\"
+ :online-suffix \".php\"
+ :working-suffix \".org\"
+ :base-url \"http://orgmode.org/worg/\"
+ :working-directory \"/home/user/org/Worg/\")
+ (\"http://localhost/org-notes/\"
+ :online-suffix \".html\"
+ :working-suffix \".org\"
+ :base-url \"http://localhost/org/\"
+ :working-directory \"/home/user/org/\")))
+
+Consider using the interactive functions `org-protocol-create' and
+`org-protocol-create-for-org' to help you filling this variable with valid contents."
+ :group 'org-protocol
+ :type 'alist)
+
+
+(defcustom org-protocol-protocol-alist nil
+ "* Register custom handlers for org-protocol.
+
+Each element of this list must be of the form:
+
+ (module-name :protocol protocol :function func :kill-client nil)
+
+protocol - protocol to detect in a filename without trailing colon and slashes.
+ See rfc1738 section 2.1 for more on this.
+ If you define a protocol \"my-protocol\", `org-protocol-check-filename-for-protocol'
+ will search filenames for \"org-protocol:/my-protocol:/\"
+ and trigger your action for every match. `org-protocol' is defined in
+ `org-protocol-the-protocol'. Double and tripple slashes are compressed
+ to one by emacsclient.
+
+function - function that handles requests with protocol and takes exactly one
+ argument: the filename with all protocols stripped. If the function
+ returns nil, emacsclient and -server do nothing. Any non-nil return
+ value is considered a valid filename and thus passed to the server.
+
+ `org-protocol.el provides some support for handling those filenames,
+ if you stay with the conventions used for the standard handlers in
+ `org-protocol-protocol-alist-default'. See `org-protocol-split-data'.
+
+kill-client - If t, kill the client immediately, once the sub-protocol is
+ detected. This is neccessary for actions that can be interupted by
+ `C-g' to avoid dangeling emacsclients. Note, that all other command
+ line arguments but the this one will be discarded, greedy handlers
+ still receive the whole list of arguments though.
+
+Here is an example:
+
+ (setq org-protocol-protocol-alist
+ '((\"my-protocol\"
+ :protocol \"my-protocol\"
+ :function my-protocol-handler-fuction)
+ (\"your-protocol\"
+ :protocol \"your-protocol\"
+ :function your-protocol-handler-fuction)))"
+ :group 'org-protocol
+ :type '(alist))
+
+(defcustom org-protocol-default-template-key "w"
+ "The default org-remember-templates key to use."
+ :group 'org-protocol
+ :type 'string)
+
+
+;;; Helper functions:
+
+(defun org-protocol-sanitize-uri (uri)
+ "emacsclient compresses double and tripple slashes.
+Slashes are sanitized to double slashes here."
+ (when (string-match "^\\([a-z]+\\):/" uri)
+ (let* ((splitparts (split-string uri "/+")))
+ (setq uri (concat (car splitparts) "//" (mapconcat 'identity (cdr splitparts) "/")))))
+ uri)
+
+
+(defun org-protocol-split-data(data &optional unhexify separator)
+ "Split, what a org-protocol handler function gets as only argument.
+data is that one argument. Data is splitted at each occurrence of separator
+ (regexp). If no separator is specified or separator is nil, assume \"/+\".
+The results of that splitting are return as a list. If unhexify is non-nil,
+hex-decode each split part. If unhexify is a function, use that function to
+decode each split part."
+ (let* ((sep (or separator "/+"))
+ (split-parts (split-string data sep)))
+ (if unhexify
+ (if (fboundp unhexify)
+ (mapcar unhexify split-parts)
+ (mapcar 'org-protocol-unhex-string split-parts))
+ split-parts)))
+
+(defun org-protocol-unhex-string(str)
+ "Unhex hexified unicode strings as returned from the JavaScript function
+encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ü'."
+ (setq str (or str ""))
+ (let ((tmp "")
+ (case-fold-search t))
+ (while (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str)
+ (let* ((start (match-beginning 0))
+ (end (match-end 0))
+ (hex (match-string 0 str))
+ (replacement (org-protocol-unhex-compound hex)))
+ (setq tmp (concat tmp (substring str 0 start) replacement))
+ (setq str (substring str end))))
+ (setq tmp (concat tmp str))
+ tmp))
+
+
+(defun org-protocol-unhex-compound (hex)
+ "Unhexify unicode hex-chars. E.g. `%C3%B6' is the german Umlaut `ü'."
+ (let* ((bytes (remove "" (split-string hex "%")))
+ (ret "")
+ (eat 0)
+ (sum 0))
+ (while bytes
+ (let* ((b (pop bytes))
+ (a (elt b 0))
+ (b (elt b 1))
+ (c1 (if (> a ?9) (+ 10 (- a ?A)) (- a ?0)))
+ (c2 (if (> b ?9) (+ 10 (- b ?A)) (- b ?0)))
+ (val (+ (lsh c1 4) c2))
+ (shift
+ (if (= 0 eat) ;; new byte
+ (if (>= val 252) 6
+ (if (>= val 248) 5
+ (if (>= val 240) 4
+ (if (>= val 224) 3
+ (if (>= val 192) 2 0)))))
+ 6))
+ (xor
+ (if (= 0 eat) ;; new byte
+ (if (>= val 252) 252
+ (if (>= val 248) 248
+ (if (>= val 240) 240
+ (if (>= val 224) 224
+ (if (>= val 192) 192 0)))))
+ 128)))
+ (if (>= val 192) (setq eat shift))
+ (setq val (logxor val xor))
+ (setq sum (+ (lsh sum shift) val))
+ (if (> eat 0) (setq eat (- eat 1)))
+ (when (= 0 eat)
+ (setq ret (concat ret (char-to-string sum)))
+ (setq sum 0))
+ )) ;; end (while bytes
+ ret ))
+
+(defun org-protocol-flatten-greedy (param-list &optional strip-path replacement)
+ "Greedy handlers might recieve a list like this from emacsclient:
+ '( (\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\")
+where \"/dir/\" is the absolute path to emacsclients working directory. This
+function transforms it into a flat list utilizing `org-protocol-flatten' and
+transforms the elements of that list as follows:
+
+If strip-path is non-nil, remove the \"/dir/\" prefix from all members of
+param-list.
+
+If replacement is string, replace the \"/dir/\" prefix with it.
+
+The first parameter, the one that contains the protocols, is always changed.
+Everything up to the end of the protocols is stripped.
+
+Note, that this function will always behave as if
+`org-protocol-reverse-list-of-files' was set to t and the returned list will
+reflect that. I.e. emacsclients first parameter will be the first one in the
+returned list."
+(let* ((l (org-protocol-flatten (if org-protocol-reverse-list-of-files
+ param-list
+ (reverse param-list))))
+ (trigger (car l))
+ (len 0)
+ dir
+ ret)
+ (when (string-match "^\\(.*\\)\\(org-protocol:/+[a-zA-z0-9][-_a-zA-z0-9]*:/+\\)\\(.*\\)" trigger)
+ (setq dir (match-string 1 trigger))
+ (setq len (length dir))
+ (setcar l (concat dir (match-string 3 trigger))))
+ (if strip-path
+ (progn
+ (dolist (e l ret)
+ (setq ret
+ (append ret
+ (list
+ (if (stringp e)
+ (if (stringp replacement)
+ (setq e (concat replacement (substring e len)))
+ (setq e (substring e len)))
+ e)))))
+ ret)
+ l)))
+
+
+(defun org-protocol-flatten (l)
+ "Greedy handlers might recieve a list like this from emacsclient:
+ '( (\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\")
+where \"/dir/\" is the absolute path to emacsclients working directory. This
+function transforms it into a flat list."
+ (if (null l) ()
+ (if (listp l)
+ (append (org-protocol-flatten (car l)) (org-protocol-flatten (cdr l)))
+ (list l))))
+
+;;; Standard protocol handlers:
+
+(defun org-protocol-store-link (fname)
+ "Process an org-protocol://store-link:// style url
+and store a browser URL as an org link. Also pushes the links URL to the
+`kill-ring'.
+
+The location for a browser's bookmark has to look like this:
+
+ javascript:location.href='org-protocol://store-link://'+ \\
+ encodeURIComponent(location.href)
+ encodeURIComponent(document.title)+'/'+ \\
+
+Don't use `escape()'! Use `encodeURIComponent()' instead. The title of the page
+could contain slashes and the location definitely will.
+
+The sub-protocol used to reach this function is set in
+`org-protocol-protocol-alist'."
+ (let* ((splitparts (org-protocol-split-data fname t))
+ (uri (org-protocol-sanitize-uri (car splitparts)))
+ (title (cadr splitparts))
+ orglink)
+ (if (boundp 'org-stored-links)
+ (setq org-stored-links (cons (list uri title) org-stored-links)))
+ (kill-new uri)
+ (message "`%s' to insert new org-link, `%s' to insert `%s'"
+ (substitute-command-keys"\\[org-insert-link]")
+ (substitute-command-keys"\\[yank]")
+ uri))
+ nil)
+
+
+(defun org-protocol-remember (info)
+ "Process an org-protocol://remember:// style url.
+
+The sub-protocol used to reach this function is set in
+`org-protocol-protocol-alist'.
+
+This function detects an URL, title and optinal text, separated by '/'
+The location for a browser's bookmark has to look like this:
+
+ javascript:location.href='org-protocol://remember://'+ \\
+ encodeURIComponent(location.href)+'/' \\
+ encodeURIComponent(document.title)+'/'+ \\
+ encodeURIComponent(window.getSelection())
+
+By default, it uses the character `org-protocol-default-template-key',
+which should be associated with a template in `org-remember-templates'.
+But you may prepend the encoded URL with a character and a slash like so:
+
+ javascript:location.href='org-protocol://org-store-link://b/'+ ...
+
+Now template ?b will be used."
+
+ (if (and (boundp 'org-stored-links)
+ (fboundp 'org-remember))
+ (let* ((parts (org-protocol-split-data info t))
+ (template (or (and (= 1 (length (car parts))) (pop parts))
+ org-protocol-default-template-key))
+ (url (org-protocol-sanitize-uri (car parts)))
+ (type (if (string-match "^\\([a-z]+\\):" url)
+ (match-string 1 url)))
+ (title (cadr parts))
+ (region (caddr parts))
+ (orglink (org-make-link-string url title))
+ remember-annotation-functions)
+ (setq org-stored-links
+ (cons (list url title) org-stored-links))
+ (kill-new orglink)
+ (org-store-link-props :type type
+ :link url
+ :description title
+ :initial region)
+ (raise-frame)
+ (org-remember nil (string-to-char template)))
+
+ (message "Org-mode not loaded."))
+ nil)
+
+
+(defun org-protocol-open-source (fname)
+ "Process an org-protocol://open-source:// style url.
+
+Change a filename by mapping URLs to local filenames as set
+in `org-protocol-project-alist'.
+
+The location for a browser's bookmark should look like this:
+
+ javascript:location.href='org-protocol://open-source://'+ \\
+ encodeURIComponent(location.href)"
+
+ ;; As we enter this function for a match on our protocol, the return value
+ ;; defaults to nil.
+ (let ((result nil)
+ (f (org-protocol-unhex-string fname)))
+ (catch 'result
+ (dolist (prolist org-protocol-project-alist)
+ (let* ((base-url (plist-get (cdr prolist) :base-url))
+ (wsearch (regexp-quote base-url)))
+
+ (when (string-match wsearch f)
+ (let* ((wdir (plist-get (cdr prolist) :working-directory))
+ (strip-suffix (plist-get (cdr prolist) :online-suffix))
+ (add-suffix (plist-get (cdr prolist) :working-suffix))
+ (start-pos (+ (string-match wsearch f) (length base-url)))
+ (end-pos (string-match
+ (concat (regexp-quote strip-suffix) "\\([?#].*\\)?$") f))
+ (the-file (concat wdir (substring f start-pos end-pos) add-suffix)))
+ (if (file-readable-p the-file)
+ (throw 'result the-file))
+ (if (file-exists-p the-file)
+ (message "%s: permission denied!" the-file)
+ (message "%s: no such file or directory." the-file))))))
+ result)))
+
+
+;;; Core functions:
+
+(defun org-protocol-check-filename-for-protocol (fname restoffiles client)
+ "Detect if `org-protocol-the-protocol' and a known sub-protocol is used in fname.
+Sub-protocols are registered in `org-protocol-protocol-alist' and
+`org-protocol-protocol-alist-default'.
+This is, how the matching is done:
+
+ (string-match \"protocol:/+sub-protocol:/+\" ...)
+
+protocol and sub-protocol are regexp-quoted.
+
+If a matching protcol is found, the protcol is stripped from fname and the
+result is passed to the protocols function as the only parameter. If the
+function returns nil, the filename is removed from the list of filenames
+passed from emacsclient to the server.
+If the function returns a non nil value, that value is passed to the server
+as filename."
+ (let ((sub-protocols (append org-protocol-protocol-alist org-protocol-protocol-alist-default)))
+ (catch 'fname
+ (let ((the-protocol (concat (regexp-quote org-protocol-the-protocol) ":/+")))
+ (when (string-match the-protocol fname)
+ (dolist (prolist sub-protocols)
+ (let ((proto (concat the-protocol (regexp-quote (plist-get (cdr prolist) :protocol)) ":/+")))
+ (when (string-match proto fname)
+ (let* ((func (plist-get (cdr prolist) :function))
+ (greedy (plist-get (cdr prolist) :greedy))
+ (splitted (split-string fname proto))
+ (result (if greedy restoffiles (cadr splitted))))
+ (when (plist-get (cdr prolist) :kill-client)
+ (message "Greedy org-protocol handler. Killing client.")
+ (server-edit))
+ (when (fboundp func)
+ (unless greedy
+ (throw 'fname (funcall func result)))
+ (funcall func result)
+ (throw 'fname t))))))))
+ ;; (message "fname: %s" fname)
+ fname)))
+
+
+(defadvice server-visit-files (before org-protocol-detect-protocol-server activate)
+ "Advice server-visit-flist to call `org-protocol-modify-filename-for-protocol'."
+ (let ((flist (if org-protocol-reverse-list-of-files
+ (reverse (ad-get-arg 0))
+ (ad-get-arg 0)))
+ (client (ad-get-arg 1)))
+ (catch 'greedy
+ (dolist (var flist)
+ (let ((fname (expand-file-name (car var)))) ;; `\' to `/' on windows. FIXME: could this be done any better?
+ (setq fname (org-protocol-check-filename-for-protocol fname (member var flist) client))
+ (if (eq fname t) ;; greedy? We need the `t' return value.
+ (progn
+ (ad-set-arg 0 nil)
+ (throw 'greedy t))
+ (if (stringp fname) ;; probably filename
+ (setcar var fname)
+ (ad-set-arg 0 (delq var (ad-get-arg 0))))))
+ ))))
+
+;;; Org specific functions:
+
+(defun org-protocol-create-for-org ()
+ "Create a org-protocol project for the current file's Org-mode project.
+This works, if the file visited is part of a publishing project in
+`org-publish-project-alist'. This functions calls `org-protocol-create' to do
+most of the work."
+ (interactive)
+ (require 'org-publish)
+ (org-publish-initialize-files-alist)
+ (let ((all (or (org-publish-get-project-from-filename buffer-file-name))))
+ (if all (org-protocol-create (cdr all))
+ (message "Not in an org-project. Did mean %s?"
+ (substitute-command-keys"\\[org-protocol-create]")))))
+
+
+(defun org-protocol-create(&optional project-plist)
+ "Create a new org-protocol project interactively.
+An org-protocol project is an entry in `org-protocol-project-alist'
+which is used by `org-protocol-open-source'.
+Optionally use project-plist to initialize the defaults for this worglet. If
+project-plist is the CDR of an element in `org-publish-project-alist', reuse
+:base-directory, :html-extension and :base-extension."
+ (interactive)
+ (let ((working-dir (expand-file-name(or (plist-get project-plist :base-directory) default-directory)))
+ (base-url "http://orgmode.org/worg/")
+ (strip-suffix (or (plist-get project-plist :html-extension) ".html"))
+ (working-suffix (if (plist-get project-plist :base-extension)
+ (concat "." (plist-get project-plist :base-extension))
+ ".org"))
+
+ (worglet-buffer nil)
+
+ (insert-default-directory t)
+ (minibuffer-allow-text-properties nil))
+
+ (setq base-url (read-string "Base URL of published content: " base-url nil base-url t))
+ (if (not (string-match "\\/$" base-url))
+ (setq base-url (concat base-url "/")))
+
+ (setq working-dir
+ (expand-file-name
+ (read-directory-name "Local working directory: " working-dir working-dir t)))
+ (if (not (string-match "\\/$" working-dir))
+ (setq working-dir (concat working-dir "/")))
+
+ (setq strip-suffix
+ (read-string
+ (concat "Extension to strip from published URLs ("strip-suffix"): ")
+ strip-suffix nil strip-suffix t))
+
+ (setq working-suffix
+ (read-string
+ (concat "Extension of editable files ("working-suffix"): ")
+ working-suffix nil working-suffix t))
+
+ (when (yes-or-no-p "Save the new worglet to your init file? ")
+ (setq org-protocol-project-alist
+ (cons `(,base-url . (:base-url ,base-url
+ :working-directory ,working-dir
+ :online-suffix ,strip-suffix
+ :working-suffix ,working-suffix))
+ org-protocol-project-alist))
+ (customize-save-variable 'org-protocol-project-alist org-protocol-project-alist))))
+
+(provide 'org-protocol)
+;;; org-protocol.el ends here
;; Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: David O'Toole <dto@gnu.org>
-;; Maintainer: Bastien Guerry <bzg AT altern DOT org>
+;; Maintainer: Carsten Dominik <carsten DOT dominik AT gmail DOT com>
;; Keywords: hypermedia, outlines, wp
-;; Version: 6.21b
+;; Version: 6.29c
;; This file is part of GNU Emacs.
;;
;;
;; org-publish.el can do the following:
;;
-;; + Publish all one's org-files to HTML or LaTeX
+;; + Publish all one's org-files to HTML or PDF
;; + Upload HTML, images, attachments and other files to a web server
;; + Exclude selected private pages from publishing
;; + Publish a clickable index of pages
;; + Manage local timestamps for publishing only changed files
;; + Accept plugin functions to extend range of publishable content
;;
-;; Special thanks to the org-mode maintainer Carsten Dominik for his
-;; ideas, enthusiasm, and cooperation.
-
-;;; Installation:
-
-;; Put org-publish.el in your load path, byte-compile it, and then add
-;; the following lines to your emacs initialization file:
-
-;; (autoload 'org-publish "org-publish" nil t)
-;; (autoload 'org-publish "org-publish-all" nil t)
-;; (autoload 'org-publish "org-publish-current-file" nil t)
-;; (autoload 'org-publish "org-publish-current-project" nil t)
-
-;; NOTE: When org-publish.el is included with org.el, those forms are
-;; already in the file org-install.el, and hence don't need to be put
-;; in your emacs initialization file in this case.
-
-;;; Usage:
-;;
-;; The program's main configuration variable is
-;; `org-publish-project-alist'. See below for example configurations
-;; with commentary.
-
-;; The main interactive functions are:
-;;
-;; M-x org-publish
-;; M-x org-publish-all
-;; M-x org-publish-current-file
-;; M-x org-publish-current-project
-
-;;;; Simple example configuration:
-
-;; (setq org-publish-project-alist
-;; (list
-;; '("org" . (:base-directory "~/org/"
-;; :base-extension "org"
-;; :publishing-directory "~/public_html"
-;; :with-section-numbers nil
-;; :table-of-contents nil
-;; :recursive t
-;; :style "<link rel="stylesheet" href=\"../other/mystyle.css\" type=\"text/css\">")))
-
-;;;; More complex example configuration:
-
-;; Imagine your *.org files are kept in ~/org, your images in
-;; ~/images, and stylesheets in ~/other. Now imagine you want to
-;; publish the files through an ssh connection to a remote host, via
-;; Tramp-mode. To maintain relative links from *.org files to /images
-;; and /other, we should replicate the same directory structure in
-;; your web server account's designated html root (in this case,
-;; assumed to be ~/html)
-
-;; Once you've done created the proper directories, you can adapt the
-;; following example configuration to your specific paths, run M-x
-;; org-publish-all, and it should publish the files to the correct
-;; directories on the web server, transforming the *.org files into
-;; HTML, and leaving other files alone.
-
-;; (setq org-publish-project-alist
-;; (list
-;; '("orgfiles" :base-directory "~/org/"
-;; :base-extension "org"
-;; :publishing-directory "/ssh:user@host:~/html/notebook/"
-;; :publishing-function org-publish-org-to-html
-;; :exclude "PrivatePage.org" ;; regexp
-;; :headline-levels 3
-;; :with-section-numbers nil
-;; :table-of-contents nil
-;; :style "<link rel="stylesheet" href=\"../other/mystyle.css\" type=\"text/css\">"
-;; :auto-preamble t
-;; :auto-postamble nil)
-;; ("images" :base-directory "~/images/"
-;; :base-extension "jpg\\|gif\\|png"
-;; :publishing-directory "/ssh:user@host:~/html/images/"
-;; :publishing-function org-publish-attachment)
-;; ("other" :base-directory "~/other/"
-;; :base-extension "css"
-;; :publishing-directory "/ssh:user@host:~/html/other/"
-;; :publishing-function org-publish-attachment)
-;; ("website" :components ("orgfiles" "images" "other"))))
-
-;; For more information, see the documentation for the variable
-;; `org-publish-project-alist'.
-
-;; Of course, you don't have to publish to remote directories from
-;; within emacs. You can always just publish to local folders, and
-;; then use the synchronization/upload tool of your choice.
-
-;;; List of user-visible changes since version 1.27
-
-;; 1.78: Allow list-valued :publishing-function
-;; 1.77: Added :preparation-function, this allows you to use GNU Make etc.
-;; 1.65: Remove old "composite projects". They're redundant.
-;; 1.64: Allow meta-projects with :components
-;; 1.57: Timestamps flag is now called "org-publish-use-timestamps-flag"
-;; 1.52: Properly set default for :index-filename
-;; 1.48: Composite projects allowed.
-;; :include keyword allowed.
-;; 1.43: Index no longer includes itself in the index.
-;; 1.42: Fix "function definition is void" error
-;; when :publishing-function not set in org-publish-current-file.
-;; 1.41: Fixed bug where index isn't published on first try.
-;; 1.37: Added interactive function "org-publish". Prompts for particular
-;; project name to publish.
-;; 1.34: Added force-publish option to all interactive functions.
-;; 1.32: Fixed "index.org has changed on disk" error during index publishing.
-;; 1.30: Fixed startup error caused by (require 'em-unix)
+;; Documentation for publishing is in the manual.
;;; Code:
:auto-index Whether to publish an index during
`org-publish-current-project' or `org-publish-all'.
:index-filename Filename for output of index. Defaults
- to 'index.org' (which becomes 'index.html').
+ to 'sitemap.org' (which becomes 'sitemap.html').
:index-title Title of index page. Defaults to name of file.
:index-function Plugin function to use for generation of index.
Defaults to `org-publish-org-index', which
:group 'org-publish
:type 'directory)
+(defcustom org-publish-list-skipped-files t
+ "Non-nil means, show message about files *not* published."
+ :group 'org-publish
+ :type 'boolean)
+
(defcustom org-publish-before-export-hook nil
"Hook run before export on the Org file.
-If the functions in this hook modify the original Org buffer, the
-modified buffer will be used for export, but the buffer will be
-restored and saved back to its initial state after export."
+The hook may modify the file in arbitrary ways before publishing happens.
+The orgiginal version of the buffer will be restored after publishing."
:group 'org-publish
:type 'hook)
(defcustom org-publish-after-export-hook nil
"Hook run after export on the exported buffer.
-If functions in this hook modify the buffer, it will be saved."
+Any changes made by this hook will be saved."
:group 'org-publish
:type 'hook)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Timestamp-related functions
-(defun org-publish-timestamp-filename (filename)
+(defun org-publish-timestamp-filename (filename &optional pub-dir pub-func)
"Return path to timestamp file for filename FILENAME."
+ (setq filename (concat filename "::" (or pub-dir "") "::"
+ (format "%s" (or pub-func ""))))
(concat (file-name-as-directory org-publish-timestamp-directory)
"X" (if (fboundp 'sha1) (sha1 filename) (md5 filename))))
-(defun org-publish-needed-p (filename)
- "Return `t' if FILENAME should be published."
+(defun org-publish-needed-p (filename &optional pub-dir pub-func true-pub-dir)
+ "Return `t' if FILENAME should be published in PUB-DIR using PUB-FUNC.
+TRUE-PUB-DIR is there the file will truely end up. Currently we are not using
+this - maybe it can eventually be used to check if the file is present at
+the target location, and how old it is. Right ow we cannot do this, because
+we do not know under what file name the file will be stored - the publishing
+function can still decide about that independently."
(let ((rtn
(if org-publish-use-timestamps-flag
(if (file-exists-p org-publish-timestamp-directory)
org-publish-timestamp-directory)
;; there is a timestamp, check if FILENAME is newer
(file-newer-than-file-p
- filename (org-publish-timestamp-filename filename)))
+ filename (org-publish-timestamp-filename
+ filename pub-dir pub-func)))
(make-directory org-publish-timestamp-directory)
t)
;; don't use timestamps, always return t
t)))
(if rtn
- (message "Publishing file %s" filename)
- (message "Skipping unmodified file %s" filename))
+ (message "Publishing file %s using `%s'" filename pub-func)
+ (when org-publish-list-skipped-files
+ (message "Skipping unmodified file %s" filename)))
rtn))
-(defun org-publish-update-timestamp (filename)
+(defun org-publish-update-timestamp (filename &optional pub-dir pub-func)
"Update publishing timestamp for file FILENAME.
If there is no timestamp, create one."
- (let ((timestamp-file (org-publish-timestamp-filename filename))
+ (let ((timestamp-file (org-publish-timestamp-filename
+ filename pub-dir pub-func))
newly-created-timestamp)
(if (not (file-exists-p timestamp-file))
;; create timestamp file if needed
(if (and (fboundp 'set-file-times)
(not newly-created-timestamp))
(set-file-times timestamp-file)
- (call-process "touch" nil 0 nil timestamp-file))))
+ (call-process "touch" nil 0 nil (expand-file-name timestamp-file)))))
+
+(defun org-publish-remove-all-timestamps ()
+ "Remove all files in the timstamp directory."
+ (let ((dir org-publish-timestamp-directory)
+ files)
+ (when (and (file-exists-p dir)
+ (file-directory-p dir))
+ (mapc 'delete-file (directory-files dir 'full "[^.]\\'")))))
+
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Mapping files to project names
(include-list (plist-get project-plist :include))
(recurse (plist-get project-plist :recursive))
(extension (or (plist-get project-plist :base-extension) "org"))
- (match (concat "^[^\\.].*\\.\\(" extension "\\)$")))
+ (match (if (eq extension 'any)
+ "^[^\\.]"
+ (concat "^[^\\.].*\\.\\(" extension "\\)$"))))
(setq org-publish-temp-files nil)
(org-publish-get-base-files-1 base-dir recurse match
;; FIXME distinguish exclude regexp
include-list)
org-publish-temp-files))
-(defun org-publish-get-project-from-filename (filename)
+(defun org-publish-get-project-from-filename (filename &optional up)
"Return the project FILENAME belongs."
(let* ((project-name (cdr (assoc (expand-file-name filename)
org-publish-files-alist))))
- (dolist (prj org-publish-project-alist)
- (if (member project-name (plist-get (cdr prj) :components))
- (setq project-name (car prj))))
+ (when up
+ (dolist (prj org-publish-project-alist)
+ (if (member project-name (plist-get (cdr prj) :components))
+ (setq project-name (car prj)))))
(assoc project-name org-publish-project-alist)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
See `org-publish-org-to' to the list of arguments."
(org-publish-org-to "html" plist filename pub-dir))
+(defun org-publish-org-to-org (plist filename pub-dir)
+ "Publish an org file to HTML.
+See `org-publish-org-to' to the list of arguments."
+ (org-publish-org-to "org" plist filename pub-dir))
+
(defun org-publish-attachment (plist filename pub-dir)
"Publish a file with no transformation of any kind.
See `org-publish-org-to' to the list of arguments."
;; make sure eshell/cp code is loaded
(unless (file-directory-p pub-dir)
(make-directory pub-dir t))
- (copy-file filename pub-dir t))
+ (or (equal (expand-file-name (file-name-directory filename))
+ (file-name-as-directory (expand-file-name pub-dir)))
+ (copy-file filename
+ (expand-file-name (file-name-nondirectory filename) pub-dir)
+ t)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Publishing files, sets of files, and indices
(defun org-publish-file (filename &optional project)
"Publish file FILENAME from PROJECT."
- (when (org-publish-needed-p filename)
- (let* ((project
- (or project
- (or (org-publish-get-project-from-filename filename)
- (if (y-or-n-p
- (format "%s is not in a project. Re-read the list of projects files? "
- (abbreviate-file-name filename)))
- ;; If requested, re-initialize the list of projects files
- (progn (org-publish-initialize-files-alist t)
- (or (org-publish-get-project-from-filename filename)
- (error "File %s not part of any known project"
- (abbreviate-file-name filename))))
- (error "Can't publish file outside of a project")))))
- (project-plist (cdr project))
- (ftname (file-truename filename))
- (publishing-function
- (or (plist-get project-plist :publishing-function)
- 'org-publish-org-to-html))
- (base-dir (file-name-as-directory
- (file-truename (plist-get project-plist :base-directory))))
- (pub-dir (file-name-as-directory
- (file-truename (plist-get project-plist :publishing-directory))))
- tmp-pub-dir)
- (setq tmp-pub-dir
- (file-name-directory
- (concat pub-dir
- (and (string-match (regexp-quote base-dir) ftname)
- (substring ftname (match-end 0))))))
- (if (listp publishing-function)
- ;; allow chain of publishing functions
- (mapc (lambda (f)
- (funcall f project-plist filename tmp-pub-dir))
- publishing-function)
- (funcall publishing-function project-plist filename tmp-pub-dir)))
- (org-publish-update-timestamp filename)))
+ (let* ((project
+ (or project
+ (or (org-publish-get-project-from-filename filename)
+ (if (y-or-n-p
+ (format "%s is not in a project. Re-read the list of projects files? "
+ (abbreviate-file-name filename)))
+ ;; If requested, re-initialize the list of projects files
+ (progn (org-publish-initialize-files-alist t)
+ (or (org-publish-get-project-from-filename filename)
+ (error "File %s not part of any known project"
+ (abbreviate-file-name filename))))
+ (error "Can't publish file outside of a project")))))
+ (project-plist (cdr project))
+ (ftname (file-truename filename))
+ (publishing-function
+ (or (plist-get project-plist :publishing-function)
+ 'org-publish-org-to-html))
+ (base-dir (file-name-as-directory
+ (file-truename (plist-get project-plist :base-directory))))
+ (pub-dir (file-name-as-directory
+ (file-truename (plist-get project-plist :publishing-directory))))
+ tmp-pub-dir)
+ (setq tmp-pub-dir
+ (file-name-directory
+ (concat pub-dir
+ (and (string-match (regexp-quote base-dir) ftname)
+ (substring ftname (match-end 0))))))
+ (if (listp publishing-function)
+ ;; allow chain of publishing functions
+ (mapc (lambda (f)
+ (when (org-publish-needed-p filename pub-dir f tmp-pub-dir)
+ (funcall f project-plist filename tmp-pub-dir)
+ (org-publish-update-timestamp filename pub-dir f)))
+ publishing-function)
+ (when (org-publish-needed-p filename pub-dir publishing-function
+ tmp-pub-dir)
+ (funcall publishing-function project-plist filename tmp-pub-dir)
+ (org-publish-update-timestamp
+ filename pub-dir publishing-function)))))
(defun org-publish-projects (projects)
"Publish all files belonging to the PROJECTS alist.
(exclude-regexp (plist-get project-plist :exclude))
(index-p (plist-get project-plist :auto-index))
(index-filename (or (plist-get project-plist :index-filename)
- "index.org"))
+ "sitemap.org"))
(index-function (or (plist-get project-plist :index-function)
'org-publish-org-index))
(preparation-function (plist-get project-plist :preparation-function))
(defun org-publish-org-index (project &optional index-filename)
"Create an index of pages in set defined by PROJECT.
Optionally set the filename of the index with INDEX-FILENAME.
-Default for INDEX-FILENAME is 'index.org'."
+Default for INDEX-FILENAME is 'sitemap.org'."
(let* ((project-plist (cdr project))
(dir (file-name-as-directory
(plist-get project-plist :base-directory)))
(indent-str (make-string 2 ?\ ))
(exclude-regexp (plist-get project-plist :exclude))
(files (nreverse (org-publish-get-base-files project exclude-regexp)))
- (index-filename (concat dir (or index-filename "index.org")))
+ (index-filename (concat dir (or index-filename "sitemap.org")))
(index-title (or (plist-get project-plist :index-title)
(concat "Index for project " (car project))))
(index-style (or (plist-get project-plist :index-style)
;;;###autoload
(defun org-publish (project &optional force)
"Publish PROJECT."
- (interactive "P")
+ (interactive
+ (list
+ (assoc (org-ido-completing-read
+ "Publish project: "
+ org-publish-project-alist nil t)
+ org-publish-project-alist)
+ current-prefix-arg))
(setq org-publish-initial-buffer (current-buffer))
(save-window-excursion
- (let* ((force current-prefix-arg)
- (org-publish-use-timestamps-flag
+ (let* ((org-publish-use-timestamps-flag
(if force nil org-publish-use-timestamps-flag)))
- (org-publish-projects
- (list (or project
- (assoc (org-ido-completing-read
- "Publish project: "
- org-publish-project-alist nil t)
- org-publish-project-alist)))))))
+ (org-publish-projects (list project)))))
;;;###autoload
(defun org-publish-all (&optional force)
"Publish all projects.
-With prefix argument, force publish all files."
+With prefix argument, remove all files in the timestamp
+directory and force publishing all files."
(interactive "P")
+ (when force
+ (org-publish-remove-all-timestamps))
(org-publish-initialize-files-alist)
(save-window-excursion
(let ((org-publish-use-timestamps-flag
(interactive "P")
(org-publish-initialize-files-alist)
(save-window-excursion
- (let ((project (org-publish-get-project-from-filename (buffer-file-name)))
+ (let ((project (org-publish-get-project-from-filename (buffer-file-name) 'up))
(org-publish-use-timestamps-flag
(if force nil org-publish-use-timestamps-flag)))
(if (not project)
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(const :tag "Use `org-default-notes-file'" nil))
(choice :tag "Destin. headline"
(string :tag "Specify")
+ (function :tag "Function")
(const :tag "Use `org-remember-default-headline'" nil)
- (const :tag "Level 1 at beginning of file" top)
- (const :tag "Level 1 at end of file" bottom))
+ (const :tag "At beginning of file" top)
+ (const :tag "At end of file" bottom))
(choice :tag "Context"
(const :tag "Use in all contexts" nil)
(const :tag "Use in all contexts" t)
(symbol :tag "Major mode"))
(function :tag "Perform a check against function")))))
+(defcustom org-remember-delete-empty-lines-at-end t
+ "Non-nil means clean up final empty lines in remember buffer."
+ :group 'org-remember
+ :type 'boolean)
+
(defcustom org-remember-before-finalize-hook nil
"Hook that is run right before a remember process is finalized.
The remember buffer is still current when this hook runs."
(const :tag "Always" t)
(const :tag "Query user" query)))
+(defcustom org-remember-backup-directory nil
+ "Directory where to store all remember buffers, for backup purposes.
+After a remember buffer has been stored successfully, the backup file
+will be removed. However, if you forget to finish the remember process,
+the file will remain there.
+See also `org-remember-auto-remove-backup-files'."
+ :group 'org-remember
+ :type '(choice
+ (const :tag "No backups" nil)
+ (directory :tag "Directory")))
+
+(defcustom org-remember-auto-remove-backup-files t
+ "Non-nil means, remove remember backup files after successfully storage.
+When remember is finished successfully, with storing the note at the
+desired target, remove the backup files related to this remember process
+and show a message about remaining backup files, from previous, unfinished
+remember sessions.
+Backup files will only be made at all, when `org-remember-backup-directory'
+is set."
+ :group 'org-remember
+ :type 'boolean)
(defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
(defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
(append (list (nth 1 x) (car x)) (cddr x))
(append (list (car x) "") (cdr x))))
(delq nil pre-selected-templates2)))
+ msg
(char (or use-char
(cond
((= (length templates) 1)
(string-to-char org-force-remember-template-char)
org-force-remember-template-char))
(t
- (message "Select template: %s"
- (mapconcat
- (lambda (x)
- (cond
- ((not (string-match "\\S-" (nth 1 x)))
- (format "[%c]" (car x)))
- ((equal (downcase (car x))
- (downcase (aref (nth 1 x) 0)))
- (format "[%c]%s" (car x)
- (substring (nth 1 x) 1)))
- (t (format "[%c]%s" (car x) (nth 1 x)))))
- templates " "))
- (let ((inhibit-quit t) (char0 (read-char-exclusive)))
+ (setq msg (format
+ "Select template: %s"
+ (mapconcat
+ (lambda (x)
+ (cond
+ ((not (string-match "\\S-" (nth 1 x)))
+ (format "[%c]" (car x)))
+ ((equal (downcase (car x))
+ (downcase (aref (nth 1 x) 0)))
+ (format "[%c]%s" (car x)
+ (substring (nth 1 x) 1)))
+ (t (format "[%c]%s" (car x) (nth 1 x)))))
+ templates " ")))
+ (let ((inhibit-quit t) char0)
+ (while (not char0)
+ (message msg)
+ (setq char0 (read-char-exclusive))
+ (when (and (not (assoc char0 templates))
+ (not (equal char0 ?\C-g)))
+ (message "No such template \"%c\"" char0)
+ (ding) (sit-for 1)
+ (setq char0 nil)))
(when (equal char0 ?\C-g)
(jump-to-register remember-register)
- (kill-buffer remember-buffer))
+ (kill-buffer remember-buffer)
+ (error "Abort"))
char0))))))
(cddr (assoc char templates)))))
(v-T (format-time-string (cdr org-time-stamp-formats) ct))
(v-u (concat "[" (substring v-t 1 -1) "]"))
(v-U (concat "[" (substring v-T 1 -1) "]"))
- ;; `initial' and `annotation' are bound in `remember'
- (v-i (if (boundp 'initial) initial))
- (v-a (if (and (boundp 'annotation) annotation)
- (if (equal annotation "[[]]") "" annotation)
- ""))
+ ;; `initial' and `annotation' are bound in `remember'.
+ ;; But if the property list has them, we prefer those values
+ (v-i (or (plist-get org-store-link-plist :initial)
+ (and (boundp 'initial) initial)
+ ""))
+ (v-a (or (plist-get org-store-link-plist :annotation)
+ (and (boundp 'annotation) annotation)
+ ""))
+ ;; Is the link empty? Then we do not want it...
+ (v-a (if (equal v-a "[[]]") "" v-a))
(clipboards (remove nil (list v-i
(org-get-x-clipboard 'PRIMARY)
(org-get-x-clipboard 'CLIPBOARD)
(when (functionp file)
(setq file (funcall file)))
+ (when (functionp headline)
+ (setq headline (funcall headline)))
(when (and file (not (file-name-absolute-p file)))
(setq file (expand-file-name file org-directory)))
-
(setq org-store-link-plist
- (append (list :annotation v-a :initial v-i)
- org-store-link-plist))
+ (plist-put org-store-link-plist :annotation v-a)
+ org-store-link-plist
+ (plist-put org-store-link-plist :initial v-i))
+
(unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
(erase-buffer)
(insert (substitute-command-keys
nil nil (list org-end-time-was-given)))
(t
(let (org-completion-use-ido)
- (insert (org-completing-read
+ (insert (org-completing-read-no-ido
(concat (if prompt prompt "Enter string")
(if default (concat " [" default "]"))
": ")
(re-search-forward "%&" nil t))
(replace-match "")
(org-set-local 'org-jump-to-target-location t))
+ (when org-remember-backup-directory
+ (unless (file-directory-p org-remember-backup-directory)
+ (make-directory org-remember-backup-directory))
+ (org-set-local 'auto-save-file-name-transforms nil)
+ (setq buffer-file-name
+ (expand-file-name
+ (format-time-string "remember-%Y-%m-%d-%H-%M-%S")
+ org-remember-backup-directory))
+ (save-buffer)
+ (org-set-local 'auto-save-visited-file-name t)
+ (auto-save-mode 1))
(when (save-excursion
(goto-char (point-min))
(re-search-forward "%!" nil t))
(y-or-n-p "The clock is running in this buffer. Clock out now? "))))
(let (org-log-note-clock-out) (org-clock-out))))
(when buffer-file-name
- (save-buffer)
- (setq buffer-file-name nil))
+ (do-auto-save))
(remember-finalize))
(defun org-remember-kill ()
(goto-char (match-beginning 0))
(error "Target headline not found: %s" heading))))
+;; FIXME (bzg): let's clean up of final empty lines happen only once
+;; (see the org-remember-delete-empty-lines-at-end option below)
;;;###autoload
(defun org-remember-handler ()
"Store stuff from remember.el into an org file.
(goto-char (point-min))
(while (looking-at "^[ \t]*\n\\|^##.*\n")
(replace-match ""))
- (goto-char (point-max))
- (beginning-of-line 1)
- (while (looking-at "[ \t]*$\\|##.*")
- (delete-region (1- (point)) (point-max))
- (beginning-of-line 1))
+ (when org-remember-delete-empty-lines-at-end
+ (goto-char (point-max))
+ (beginning-of-line 1)
+ (while (and (looking-at "[ \t]*$\\|##.*") (> (point) 1))
+ (delete-region (1- (point)) (point-max))
+ (beginning-of-line 1)))
(catch 'quit
- (if org-note-abort (throw 'quit nil))
+ (if org-note-abort (throw 'quit t))
(let* ((visitp (org-bound-and-true-p org-jump-to-target-location))
+ (backup-file
+ (and buffer-file-name
+ (equal (file-name-directory buffer-file-name)
+ (file-name-as-directory
+ (expand-file-name org-remember-backup-directory)))
+ (string-match "^remember-[0-9]\\{4\\}"
+ (file-name-nondirectory buffer-file-name))
+ buffer-file-name))
+
+ (dummy
+ (unless (string-match "\\S-" (buffer-string))
+ (message "Nothing to remember")
+ (and backup-file
+ (ignore-errors
+ (delete-file backup-file)
+ (delete-file (concat backup-file "~"))))
+ (set-buffer-modified-p nil)
+ (throw 'quit t)))
(previousp (and (member current-prefix-arg '((16) 0))
org-remember-previous-location))
(clockp (equal current-prefix-arg 2))
(org-startup-folded nil)
(org-startup-align-all-tables nil)
(org-goto-start-pos 1)
- spos exitcmd level reversed txt)
+ spos exitcmd level reversed txt text-before-node-creation)
(when (equal current-prefix-arg '(4))
(setq visitp t))
(when previousp
(setq current-prefix-arg nil)
;; Modify text so that it becomes a nice subtree which can be inserted
;; into an org tree.
- (goto-char (point-min))
- (if (re-search-forward "[ \t\n]+\\'" nil t)
- ;; remove empty lines at end
- (replace-match ""))
+ (when org-remember-delete-empty-lines-at-end
+ (goto-char (point-min))
+ (if (re-search-forward "[ \t\n]+\\'" nil t)
+ ;; remove empty lines at end
+ (replace-match "")))
(goto-char (point-min))
(unless (looking-at org-outline-regexp)
;; add a headline
+ (setq text-before-node-creation (buffer-string))
(insert (concat "* " (current-time-string)
" (" (remember-buffer-desc) ")\n"))
(backward-char 1)
(when org-adapt-indentation
(while (re-search-forward "^" nil t)
(insert " "))))
- (goto-char (point-min))
- (if (re-search-forward "\n[ \t]*\n[ \t\n]*\\'" nil t)
- (replace-match "\n\n")
- (if (re-search-forward "[ \t\n]*\\'")
- (replace-match "\n")))
+ ;; Delete final empty lines
+ (when org-remember-delete-empty-lines-at-end
+ (goto-char (point-min))
+ (if (re-search-forward "\n[ \t]*\n[ \t\n]*\\'" nil t)
+ (replace-match "\n\n")
+ (if (re-search-forward "[ \t\n]*\\'")
+ (replace-match "\n"))))
(goto-char (point-min))
(setq txt (buffer-string))
(org-save-markers-in-region (point-min) (point-max))
+ (set-buffer-modified-p nil)
(when (and (eq org-remember-interactive-interface 'refile)
(not fastp))
(org-refile nil (or visiting (find-file-noselect file)))
(throw 'quit t))
;; Find the file
(with-current-buffer (or visiting (find-file-noselect file))
- (unless (org-mode-p)
- (error "Target files for remember notes must be in Org-mode"))
+ (unless (or (org-mode-p) (member heading '(top bottom)))
+ (error "Target files for notes must be in Org-mode if not filing to top/bottom"))
(save-excursion
(save-restriction
(widen)
- (and (goto-char (point-min))
- (not (re-search-forward "^\\* " nil t))
- (insert "\n* " (or (and (stringp heading) heading)
- "Notes") "\n"))
(setq reversed (org-notes-order-reversed-p))
;; Find the default location
(when heading
(cond
+ ((not (org-mode-p))
+ (if (eq heading 'top)
+ (goto-char (point-min))
+ (goto-char (point-max))
+ (or (bolp) (newline)))
+ (insert text-before-node-creation)
+ (when remember-save-after-remembering
+ (save-buffer)
+ (if (not visiting) (kill-buffer (current-buffer))))
+ (throw 'quit t))
((eq heading 'top)
(goto-char (point-min))
(or (looking-at org-outline-regexp)
(if (and (not visiting)
(not (equal (marker-buffer org-clock-marker)
(current-buffer))))
- (kill-buffer (current-buffer)))))))))
+ (kill-buffer (current-buffer))))
+ (when org-remember-auto-remove-backup-files
+ (when backup-file
+ (ignore-errors
+ (delete-file backup-file)
+ (delete-file (concat backup-file "~"))))
+ (when org-remember-backup-directory
+ (let ((n (length
+ (directory-files
+ org-remember-backup-directory nil
+ "^remember-.*[0-9]$"))))
+ (when (> n 0)
+ (message
+ "%d backup files (unfinished remember calls) in %s"
+ n org-remember-backup-directory))))))))))
t) ;; return t to indicate that we took care of this note.
;; arch-tag: 497f30d0-4bc3-4097-8622-2d27ac5f2698
;;; org-remember.el ends here
+
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
;; Declare external functions and variables
(declare-function rmail-show-message "rmail" (&optional n no-summary))
-(declare-function rmail-get-header "rmail" (name &optional msgnum))
(declare-function rmail-what-message "rmail" ())
(defvar rmail-current-message)
-(defvar rmail-buffer)
-(defvar rmail-view-buffer)
;; Install the link type
(org-add-link-type "rmail" 'org-rmail-open)
;; Implementation
(defun org-rmail-store-link ()
"Store a link to an Rmail folder or message."
- (when (memq major-mode '(rmail-mode rmail-summary-mode))
- (let (message-id from to subject desc link)
- (if (fboundp 'rmail-get-header) ; Emacs 23
- (setq message-id (rmail-get-header "message-id")
- from (rmail-get-header "from")
- to (rmail-get-header "to")
- subject (rmail-get-header "subject"))
- (save-window-excursion ; Emacs 22
- (save-restriction
- (when (eq major-mode 'rmail-summary-mode)
- (rmail-show-message rmail-current-message))
- (with-no-warnings ; don't warn when compiling Emacs 23
- (rmail-narrow-to-non-pruned-header))
- (setq message-id (mail-fetch-field "message-id")
- from (mail-fetch-field "from")
- to (mail-fetch-field "to")
- subject (mail-fetch-field "subject"))
- (rmail-show-message rmail-current-message))))
- (org-store-link-props
- :type "rmail" :from from :to to
- :subject subject :message-id message-id)
- (setq message-id (org-remove-angle-brackets message-id))
- (setq desc (org-email-link-description))
- (setq link (org-make-link "rmail:"
- (with-current-buffer rmail-buffer
- buffer-file-name)
- "#" message-id))
- (org-add-link-props :link link :description desc)
- link)))
+ (when (or (eq major-mode 'rmail-mode)
+ (eq major-mode 'rmail-summary-mode))
+ (save-window-excursion
+ (save-restriction
+ (when (eq major-mode 'rmail-summary-mode)
+ (rmail-show-message rmail-current-message))
+ (when (fboundp 'rmail-narrow-to-non-pruned-header)
+ (rmail-narrow-to-non-pruned-header))
+ (let* ((folder buffer-file-name)
+ (message-id (mail-fetch-field "message-id"))
+ (from (mail-fetch-field "from"))
+ (to (mail-fetch-field "to"))
+ (subject (mail-fetch-field "subject"))
+ desc link)
+ (org-store-link-props
+ :type "rmail" :from from :to to
+ :subject subject :message-id message-id)
+ (setq message-id (org-remove-angle-brackets message-id))
+ (setq desc (org-email-link-description))
+ (setq link (org-make-link "rmail:" folder "#" message-id))
+ (org-add-link-props :link link :description desc)
+ (rmail-show-message rmail-current-message)
+ link)))))
(defun org-rmail-open (path)
"Follow an Rmail message link to the specified PATH."
"Follow an Rmail link to FOLDER and ARTICLE."
(require 'rmail)
(setq article (org-add-angle-brackets article))
- (let (message-number buff)
+ (let (message-number)
(save-excursion
(save-window-excursion
(rmail (if (string= folder "RMAIL") rmail-file-name folder))
- (setq buff (current-buffer)
- message-number
- (with-current-buffer
- (if (and (fboundp 'rmail-buffers-swapped-p)
- (rmail-buffers-swapped-p))
- rmail-view-buffer
- (current-buffer))
- (save-restriction
- (widen)
- (goto-char (point-max))
- (if (re-search-backward
- (concat "^Message-ID:\\s-+" (regexp-quote
- (or article "")))
- nil t)
- ;; This is an rmail "debugging" function. :(
- (with-current-buffer buff
- (rmail-what-message))))))))
+ (setq message-number
+ (save-restriction
+ (widen)
+ (goto-char (point-max))
+ (if (re-search-backward
+ (concat "^Message-ID:\\s-+" (regexp-quote
+ (or article "")))
+ nil t)
+ (rmail-what-message))))))
(if message-number
(progn
(rmail (if (string= folder "RMAIL") rmail-file-name folder))
--- /dev/null
+;;; org-src.el --- Source code examples in Org
+;;
+;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
+;; Free Software Foundation, Inc.
+;;
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Bastien Guerry <bzg AT altern DOT org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+
+;; This file contains the code dealing with source code examples in Org-mode.
+
+;;; Code:
+
+(require 'org-macs)
+(require 'org-compat)
+
+(declare-function org-do-remove-indentation "org" (&optional n))
+(declare-function org-get-indentation "org" (&optional line))
+
+(defcustom org-edit-src-region-extra nil
+ "Additional regexps to identify regions for editing with `org-edit-src-code'.
+For examples see the function `org-edit-src-find-region-and-lang'.
+The regular expression identifying the begin marker should end with a newline,
+and the regexp marking the end line should start with a newline, to make sure
+there are kept outside the narrowed region."
+ :group 'org-edit-structure
+ :type '(repeat
+ (list
+ (regexp :tag "begin regexp")
+ (regexp :tag "end regexp")
+ (choice :tag "language"
+ (string :tag "specify")
+ (integer :tag "from match group")
+ (const :tag "from `lang' element")
+ (const :tag "from `style' element")))))
+
+(defcustom org-coderef-label-format "(ref:%s)"
+ "The default coderef format.
+This format string will be used to search for coderef labels in literal
+examples (EXAMPLE and SRC blocks). The format can be overwritten in
+an individual literal example with the -f option, like
+
+#+BEGIN_SRC pascal +n -r -l \"((%s))\"
+...
+#+END_SRC
+
+If you want to use this for HTML export, make sure that the format does
+not introduce special font-locking, and avoid the HTML special
+characters `<', `>', and `&'. The reason for this restriction is that
+the labels are searched for only after htmlize has done its job."
+ :group 'org-edit-structure ; FIXME this is not in the right group
+ :type 'string)
+
+(defcustom org-edit-fixed-width-region-mode 'artist-mode
+ "The mode that should be used to edit fixed-width regions.
+These are the regions where each line starts with a colon."
+ :group 'org-edit-structure
+ :type '(choice
+ (const artist-mode)
+ (const picture-mode)
+ (const fundamental-mode)
+ (function :tag "Other (specify)")))
+
+(defcustom org-edit-src-content-indentation 2
+ "Indentation for the content is a source code block.
+This should be the number of spaces added to the indentation of the #+begin
+line in order to compute the indentation of the block content after
+editing it with \\[org-edit-src-code]."
+ :group 'org-edit-structure
+ :type 'integer)
+
+(defcustom org-edit-src-persistent-message t
+ "Non-nil means show persistent exit help message while editing src examples.
+The message is shown in the header-line, which will be created in the
+first line of the window showing the editing buffer.
+When nil, the message will only be shown intermittently in the echo area."
+ :group 'org-edit-structure
+ :type 'boolean)
+
+
+(defvar org-src-mode-hook nil
+ "Hook run after Org switched a source code snippet to its Emacs mode.
+This hook will run
+
+- when editing a source code snippet with \"C-c '\".
+- When formatting a source code snippet for export with htmlize.
+
+You may want to use this hook for example to turn off `outline-minor-mode'
+or similar things which you want to have when editing a source code file,
+but which mess up the display of a snippet in Org exported files.")
+
+;;; Editing source examples
+
+(defvar org-src-mode-map (make-sparse-keymap))
+(define-key org-src-mode-map "\C-c'" 'org-edit-src-exit)
+(define-key org-src-mode-map "\C-x\C-s" 'org-edit-src-save)
+(defvar org-edit-src-force-single-line nil)
+(defvar org-edit-src-from-org-mode nil)
+(defvar org-edit-src-picture nil)
+(defvar org-edit-src-beg-marker nil)
+(defvar org-edit-src-end-marker nil)
+(defvar org-edit-src-overlay nil)
+(defvar org-edit-src-nindent nil)
+
+(define-minor-mode org-src-mode
+ "Minor mode for language major mode buffers generated by org.
+This minor mode is turned on in two situations:
+- when editing a source code snippet with \"C-c '\".
+- When formatting a source code snippet for export with htmlize.
+There is a mode hook, and keybindings for `org-edit-src-exit' and
+`org-edit-src-save'")
+
+(defun org-edit-src-code ()
+ "Edit the source code example at point.
+The example is copied to a separate buffer, and that buffer is switched
+to the correct language mode. When done, exit with \\[org-edit-src-exit].
+This will remove the original code in the Org buffer, and replace it with
+the edited version."
+ (interactive)
+ (let ((line (org-current-line))
+ (case-fold-search t)
+ (msg (substitute-command-keys
+ "Edit, then exit with C-c ' (C-c and single quote)"))
+ (info (org-edit-src-find-region-and-lang))
+ (org-mode-p (eq major-mode 'org-mode))
+ (beg (make-marker))
+ (end (make-marker))
+ nindent ovl lang lang-f single lfmt code begline buffer)
+ (if (not info)
+ nil
+ (setq beg (move-marker beg (nth 0 info))
+ end (move-marker end (nth 1 info))
+ code (buffer-substring-no-properties beg end)
+ lang (nth 2 info)
+ single (nth 3 info)
+ lfmt (nth 4 info)
+ nindent (nth 5 info)
+ lang-f (intern (concat lang "-mode"))
+ begline (save-excursion (goto-char beg) (org-current-line)))
+ (unless (functionp lang-f)
+ (error "No such language mode: %s" lang-f))
+ (goto-line line)
+ (if (and (setq buffer (org-edit-src-find-buffer beg end))
+ (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
+ (switch-to-buffer buffer)
+ (when buffer
+ (with-current-buffer buffer
+ (if (boundp 'org-edit-src-overlay)
+ (org-delete-overlay org-edit-src-overlay)))
+ (kill-buffer buffer))
+ (setq buffer (generate-new-buffer "*Org Edit Src Example*"))
+ (setq ovl (org-make-overlay beg end))
+ (org-overlay-put ovl 'face 'secondary-selection)
+ (org-overlay-put ovl 'edit-buffer buffer)
+ (org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
+ (org-overlay-put ovl 'face 'secondary-selection)
+ (org-overlay-put ovl
+ 'keymap
+ (let ((map (make-sparse-keymap)))
+ (define-key map [mouse-1] 'org-edit-src-continue)
+ map))
+ (org-overlay-put ovl :read-only "Leave me alone")
+ (switch-to-buffer buffer)
+ (insert code)
+ (remove-text-properties (point-min) (point-max)
+ '(display nil invisible nil intangible nil))
+ (org-do-remove-indentation)
+ (let ((org-inhibit-startup t))
+ (funcall lang-f)
+ (org-src-mode))
+ (set (make-local-variable 'org-edit-src-force-single-line) single)
+ (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
+ (when lfmt
+ (set (make-local-variable 'org-coderef-label-format) lfmt))
+ (when org-mode-p
+ (goto-char (point-min))
+ (while (re-search-forward "^," nil t)
+ (replace-match "")))
+ (goto-line (1+ (- line begline)))
+ (org-set-local 'org-edit-src-beg-marker beg)
+ (org-set-local 'org-edit-src-end-marker end)
+ (org-set-local 'org-edit-src-overlay ovl)
+ (org-set-local 'org-edit-src-nindent nindent)
+ (and org-edit-src-persistent-message
+ (org-set-local 'header-line-format msg)))
+ (message "%s" msg)
+ t)))
+
+(defun org-edit-src-continue (e)
+ (interactive "e")
+ (mouse-set-point e)
+ (let ((buf (get-char-property (point) 'edit-buffer)))
+ (if buf (switch-to-buffer buf)
+ (error "Something is wrong here"))))
+
+(defun org-edit-src-find-buffer (beg end)
+ "Find a source editing buffer that is already editing the region BEG to END."
+ (catch 'exit
+ (mapc
+ (lambda (b)
+ (with-current-buffer b
+ (if (and (string-match "\\`*Org Edit " (buffer-name))
+ (local-variable-p 'org-edit-src-beg-marker (current-buffer))
+ (local-variable-p 'org-edit-src-end-marker (current-buffer))
+ (equal beg org-edit-src-beg-marker)
+ (equal end org-edit-src-end-marker))
+ (throw 'exit (current-buffer)))))
+ (buffer-list))
+ nil))
+
+(defun org-edit-fixed-width-region ()
+ "Edit the fixed-width ascii drawing at point.
+This must be a region where each line starts with a colon followed by
+a space character.
+An new buffer is created and the fixed-width region is copied into it,
+and the buffer is switched into `artist-mode' for editing. When done,
+exit with \\[org-edit-src-exit]. The edited text will then replace
+the fragment in the Org-mode buffer."
+ (interactive)
+ (let ((line (org-current-line))
+ (case-fold-search t)
+ (msg (substitute-command-keys
+ "Edit, then exit with C-c ' (C-c and single quote)"))
+ (org-mode-p (eq major-mode 'org-mode))
+ (beg (make-marker))
+ (end (make-marker))
+ nindent ovl beg1 end1 code begline buffer)
+ (beginning-of-line 1)
+ (if (looking-at "[ \t]*[^:\n \t]")
+ nil
+ (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
+ (setq beg1 (point) end1 beg1)
+ (save-excursion
+ (if (re-search-backward "^[ \t]*[^: \t]" nil 'move)
+ (setq beg1 (point-at-bol 2))
+ (setq beg1 (point))))
+ (save-excursion
+ (if (re-search-forward "^[ \t]*[^: \t]" nil 'move)
+ (setq end1 (1- (match-beginning 0)))
+ (setq end1 (point))))
+ (goto-line line))
+ (setq beg (move-marker beg beg1)
+ end (move-marker end end1)
+ code (buffer-substring-no-properties beg end)
+ begline (save-excursion (goto-char beg) (org-current-line)))
+ (if (and (setq buffer (org-edit-src-find-buffer beg end))
+ (y-or-n-p "Return to existing edit buffer? [n] will revert changes: "))
+ (switch-to-buffer buffer)
+ (when buffer
+ (with-current-buffer buffer
+ (if (boundp 'org-edit-src-overlay)
+ (org-delete-overlay org-edit-src-overlay)))
+ (kill-buffer buffer))
+ (setq buffer (generate-new-buffer "*Org Edit Src Example*"))
+ (setq ovl (org-make-overlay beg end))
+ (org-overlay-put ovl 'face 'secondary-selection)
+ (org-overlay-put ovl 'edit-buffer buffer)
+ (org-overlay-put ovl 'help-echo "Click with mouse-1 to switch to buffer editing this segment")
+ (org-overlay-put ovl 'face 'secondary-selection)
+ (org-overlay-put ovl
+ 'keymap
+ (let ((map (make-sparse-keymap)))
+ (define-key map [mouse-1] 'org-edit-src-continue)
+ map))
+ (org-overlay-put ovl :read-only "Leave me alone")
+ (switch-to-buffer buffer)
+ (insert code)
+ (remove-text-properties (point-min) (point-max)
+ '(display nil invisible nil intangible nil))
+ (setq nindent (org-do-remove-indentation))
+ (cond
+ ((eq org-edit-fixed-width-region-mode 'artist-mode)
+ (fundamental-mode)
+ (artist-mode 1))
+ (t (funcall org-edit-fixed-width-region-mode)))
+ (set (make-local-variable 'org-edit-src-force-single-line) nil)
+ (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
+ (set (make-local-variable 'org-edit-src-picture) t)
+ (goto-char (point-min))
+ (while (re-search-forward "^[ \t]*: ?" nil t)
+ (replace-match ""))
+ (goto-line (1+ (- line begline)))
+ (org-src-mode)
+ (org-set-local 'org-edit-src-beg-marker beg)
+ (org-set-local 'org-edit-src-end-marker end)
+ (org-set-local 'org-edit-src-overlay ovl)
+ (org-set-local 'org-edit-src-nindent nindent)
+ (and org-edit-src-persistent-message
+ (org-set-local 'header-line-format msg)))
+ (message "%s" msg)
+ t)))
+
+(defun org-edit-src-find-region-and-lang ()
+ "Find the region and language for a local edit.
+Return a list with beginning and end of the region, a string representing
+the language, a switch telling of the content should be in a single line."
+ (let ((re-list
+ (append
+ org-edit-src-region-extra
+ '(
+ ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
+ ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
+ ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
+ ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
+ ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
+ ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
+ ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
+ ("^[ \t]*#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n[ \t]*#\\+end_src" 2)
+ ("^[ \t]*#\\+begin_example.*\n" "\n[ \t]*#\\+end_example" "fundamental")
+ ("^[ \t]*#\\+html:" "\n" "html" single-line)
+ ("^[ \t]*#\\+begin_html.*\n" "\n[ \t]*#\\+end_html" "html")
+ ("^[ \t]*#\\+latex:" "\n" "latex" single-line)
+ ("^[ \t]*#\\+begin_latex.*\n" "\n[ \t]*#\\+end_latex" "latex")
+ ("^[ \t]*#\\+ascii:" "\n" "fundamental" single-line)
+ ("^[ \t]*#\\+begin_ascii.*\n" "\n[ \t]*#\\+end_ascii" "fundamental")
+ ("^[ \t]*#\\+docbook:" "\n" "xml" single-line)
+ ("^[ \t]*#\\+begin_docbook.*\n" "\n[ \t]*#\\+end_docbook" "xml")
+ )))
+ (pos (point))
+ re1 re2 single beg end lang lfmt match-re1 ind entry)
+ (catch 'exit
+ (while (setq entry (pop re-list))
+ (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
+ single (nth 3 entry))
+ (save-excursion
+ (if (or (looking-at re1)
+ (re-search-backward re1 nil t))
+ (progn
+ (setq match-re1 (match-string 0))
+ (setq beg (match-end 0)
+ lang (org-edit-src-get-lang lang)
+ lfmt (org-edit-src-get-label-format match-re1)
+ ind (org-edit-src-get-indentation (match-beginning 0)))
+ (if (and (re-search-forward re2 nil t)
+ (>= (match-end 0) pos))
+ (throw 'exit (list beg (match-beginning 0)
+ lang single lfmt ind))))
+ (if (or (looking-at re2)
+ (re-search-forward re2 nil t))
+ (progn
+ (setq end (match-beginning 0))
+ (if (and (re-search-backward re1 nil t)
+ (<= (match-beginning 0) pos))
+ (progn
+ (setq lfmt (org-edit-src-get-label-format
+ (match-string 0))
+ ind (org-edit-src-get-indentation
+ (match-beginning 0)))
+ (throw 'exit
+ (list (match-end 0) end
+ (org-edit-src-get-lang lang)
+ single lfmt ind))))))))))))
+
+(defun org-edit-src-get-lang (lang)
+ "Extract the src language."
+ (let ((m (match-string 0)))
+ (cond
+ ((stringp lang) lang)
+ ((integerp lang) (match-string lang))
+ ((and (eq lang 'lang)
+ (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
+ (match-string 1 m))
+ ((and (eq lang 'style)
+ (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
+ (match-string 1 m))
+ (t "fundamental"))))
+
+(defun org-edit-src-get-label-format (s)
+ "Extract the label format."
+ (save-match-data
+ (if (string-match "-l[ \t]+\\\\?\"\\([^\t\r\n\"]+\\)\\\\?\"" s)
+ (match-string 1 s))))
+
+(defun org-edit-src-get-indentation (pos)
+ "Extract the label format."
+ (save-match-data
+ (goto-char pos)
+ (org-get-indentation)))
+
+(defun org-edit-src-exit ()
+ "Exit special edit and protect problematic lines."
+ (interactive)
+ (unless (string-match "\\`*Org Edit " (buffer-name (current-buffer)))
+ (error "This is not an sub-editing buffer, something is wrong..."))
+ (let ((beg org-edit-src-beg-marker)
+ (end org-edit-src-end-marker)
+ (ovl org-edit-src-overlay)
+ (buffer (current-buffer))
+ (nindent org-edit-src-nindent)
+ code line)
+ (untabify (point-min) (point-max))
+ (save-excursion
+ (goto-char (point-min))
+ (if (looking-at "[ \t\n]*\n") (replace-match ""))
+ (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match "")))
+ (setq line (if (org-bound-and-true-p org-edit-src-force-single-line)
+ 1
+ (org-current-line)))
+ (when (org-bound-and-true-p org-edit-src-force-single-line)
+ (goto-char (point-min))
+ (while (re-search-forward "\n" nil t)
+ (replace-match " "))
+ (goto-char (point-min))
+ (if (looking-at "\\s-*") (replace-match " "))
+ (if (re-search-forward "\\s-+\\'" nil t)
+ (replace-match "")))
+ (when (org-bound-and-true-p org-edit-src-from-org-mode)
+ (goto-char (point-min))
+ (while (re-search-forward
+ (if (org-mode-p) "^\\(.\\)" "^\\([*]\\|[ \t]*#\\+\\)") nil t)
+ (replace-match ",\\1")))
+ (when (org-bound-and-true-p org-edit-src-picture)
+ (untabify (point-min) (point-max))
+ (goto-char (point-min))
+ (while (re-search-forward "^" nil t)
+ (replace-match ": ")))
+ (when nindent
+ (setq nindent (make-string (+ org-edit-src-content-indentation nindent)
+ ?\ ))
+ (goto-char (point-min))
+ (while (re-search-forward "^" nil t)
+ (replace-match nindent)))
+ (setq code (buffer-string))
+ (switch-to-buffer (marker-buffer beg))
+ (kill-buffer buffer)
+ (goto-char beg)
+ (org-delete-overlay ovl)
+ (delete-region beg end)
+ (insert code)
+ (goto-char beg)
+ (goto-line (1- (+ (org-current-line) line)))
+ (move-marker beg nil)
+ (move-marker end nil)))
+
+(defun org-edit-src-save ()
+ "Save parent buffer with current state source-code buffer."
+ (interactive)
+ (let ((p (point)) (m (mark)) msg)
+ (org-edit-src-exit)
+ (save-buffer)
+ (setq msg (current-message))
+ (org-edit-src-code)
+ (push-mark m 'nomessage)
+ (goto-char (min p (point-max)))
+ (message (or msg ""))))
+
+(provide 'org-src)
+
+;; arch-tag: 6a1fc84f-dec7-47be-a416-64be56bea5d8
+
+;;; org-src.el ends here
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
:type 'boolean)
(defcustom org-table-error-on-row-ref-crossing-hline t
- "Non-nil means, a relative row reference that tries to cross a hline errors.
-When nil, the reference will silently be to the field just next to the hline.
-Coming from below, it will be the field below the hline, coming from
-above, it will be the field above the hline."
+ "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
:group 'org-table
:type 'boolean)
+(defcustom org-table-relative-ref-may-cross-hline t
+ "Non-nil means, reltive formula references may cross hlines.
+Here are the allowed values:
+
+nil Relative references may not cross hlines. They will reference the
+ field next to the hline instead. Coming from below, the reference
+ will be to the field below the hline. Coming from above, it will be
+ to the field above.
+t Relative references may cros hlines.
+error An attempt to cross a hline will throw an error.
+
+It is probably good to never set this variable to nil, for the sake of
+portability of tables."
+ :group 'org-table-calculation
+ :type '(choice
+ (const :tag "Allow to cross" t)
+ (const :tag "Stick to hline" nil)
+ (const :tag "Error on attempt to cross" error)))
+
(defgroup org-table-import-export nil
"Options concerning table import and export in Org-mode."
:tag "Org Table Import Export"
(error "Abort")))
(if (file-directory-p file)
(error "This is a directory path, not a file"))
- (if (equal (file-truename file)
- (file-truename (buffer-file-name)))
+ (if (and (buffer-file-name)
+ (equal (file-truename file)
+ (file-truename (buffer-file-name))))
(error "Please specify a file name that is different from current"))
(unless format
(setq deffmt-readable org-table-export-default-format)
(make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
(hfmt1 (concat
(make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
- emptystrings links dates emph narrow fmax f1 len c e)
+ emptystrings links dates emph narrow falign falign1 fmax f1 len c e)
(untabify beg end)
(remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
;; Check if we have links or dates
;; Check if we are narrowing any columns
(goto-char beg)
(setq narrow (and org-format-transports-properties-p
- (re-search-forward "<[0-9]+>" end t)))
+ (re-search-forward "<[rl]?[0-9]+>" end t)))
+ (goto-char beg)
+ (setq falign (re-search-forward "<[rl][0-9]*>" end t))
;; Get the rows
(setq lines (org-split-string
(buffer-substring beg end) "\n"))
(while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
(setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
;; Check if there is an explicit width specified
- (when narrow
- (setq c column fmax nil)
+ (when (or narrow falign)
+ (setq c column fmax nil falign1 nil)
(while c
(setq e (pop c))
- (if (and (stringp e) (string-match "^<\\([0-9]+\\)>$" e))
- (setq fmax (string-to-number (match-string 1 e)) c nil)))
+ (when (and (stringp e) (string-match "^<\\([rl]\\)?\\([0-9]+\\)?>$" e))
+ (if (match-end 1) (setq falign1 (match-string 1 e)))
+ (if (match-end 2)
+ (setq fmax (string-to-number (match-string 2 e)) c nil))))
;; Find fields that are wider than fmax, and shorten them
(when fmax
(loop for xx in column do
;; Get the maximum width for each column
(push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
;; Get the fraction of numbers, to decide about alignment of the column
- (setq cnt 0 frac 0.0)
- (loop for x in column do
- (if (equal x "")
- nil
- (setq frac ( / (+ (* frac cnt)
- (if (string-match org-table-number-regexp x) 1 0))
- (setq cnt (1+ cnt))))))
- (push (>= frac org-table-number-fraction) typenums))
+ (if falign1
+ (push (equal (downcase falign1) "r") typenums)
+ (setq cnt 0 frac 0.0)
+ (loop for x in column do
+ (if (equal x "")
+ nil
+ (setq frac ( / (+ (* frac cnt)
+ (if (string-match org-table-number-regexp x) 1 0))
+ (setq cnt (1+ cnt))))))
+ (push (>= frac org-table-number-fraction) typenums)))
(setq lengths (nreverse lengths) typenums (nreverse typenums))
;; Store the alignment of this table, for later editing of single fields
;; Replace the old one
(delete-region beg end)
(move-marker end nil)
+ (if (equal (char-before) ?\n)
+ ;; This hack is for org-indent, to force redisplay of the
+ ;; line prefix of the first line. Apparently the redisplay
+ ;; is tied to the newline, which is, I think, a bug.
+ ;; To force this redisplay, we remove and re-insert the
+ ;; newline, so that the redisplay engine thinks it belongs
+ ;; to the changed text.
+ (progn
+ (backward-delete-char 1)
+ (insert "\n")))
(move-marker org-table-aligned-begin-marker (point))
(insert new)
(move-marker org-table-aligned-end-marker (point))
(org-table-align))
(if (org-at-table-hline-p)
(end-of-line 1))
- (re-search-backward "|" (org-table-begin))
- (re-search-backward "|" (org-table-begin))
+ (condition-case nil
+ (progn
+ (re-search-backward "|" (org-table-begin))
+ (re-search-backward "|" (org-table-begin)))
+ (error (error "Cannot move to previous table field")))
(while (looking-at "|\\(-\\|[ \t]*$\\)")
(re-search-backward "|" (org-table-begin)))
(if (looking-at "| ?")
(goto-char (match-end 0))))
+(defun org-table-beginning-of-field (&optional n)
+ "Move to the end of the current table field.
+If already at or after the end, move to the end of the next table field.
+With numeric argument N, move N-1 fields forward first."
+ (interactive "p")
+ (let ((pos (point)))
+ (while (> n 1)
+ (setq n (1- n))
+ (org-table-previous-field))
+ (if (not (re-search-backward "|" (point-at-bol 0) t))
+ (error "No more table fields before the current")
+ (goto-char (match-end 0))
+ (and (looking-at " ") (forward-char 1)))
+ (if (>= (point) pos) (org-table-beginning-of-field 2))))
+
+(defun org-table-end-of-field (&optional n)
+ "Move to the beginning of the current table field.
+If already at or before the beginning, move to the beginning of the
+previous field.
+With numeric argument N, move N-1 fields backward first."
+ (interactive "p")
+ (let ((pos (point)))
+ (while (> n 1)
+ (setq n (1- n))
+ (org-table-next-field))
+ (when (re-search-forward "|" (point-at-eol 1) t)
+ (backward-char 1)
+ (skip-chars-backward " ")
+ (if (and (equal (char-before (point)) ?|) (looking-at " "))
+ (forward-char 1)))
+ (if (<= (point) pos) (org-table-end-of-field 2))))
+
(defun org-table-next-row ()
"Go to the next row (same column) in the current table.
Before doing so, re-align the table if necessary."
(defun org-table-cut-region (beg end)
- "Copy region in table to the clipboard and blank all relevant fields."
- (interactive "r")
+ "Copy region in table to the clipboard and blank all relevant fields.
+If there is no active region, use just the field at point."
+ (interactive (list
+ (if (org-region-active-p) (region-beginning) (point))
+ (if (org-region-active-p) (region-end) (point))))
(org-table-copy-region beg end 'cut))
(defun org-table-copy-region (beg end &optional cut)
"Copy rectangular region in table to clipboard.
A special clipboard is used which can only be accessed
with `org-table-paste-rectangle'."
- (interactive "rP")
+ (interactive (list
+ (if (org-region-active-p) (region-beginning) (point))
+ (if (org-region-active-p) (region-end) (point))
+ current-prefix-arg))
(let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
region cols
(rpl (if cut " " nil)))
(setq alist (sort alist 'org-table-formula-less-p))
(save-excursion
(goto-char (org-table-end))
- (if (looking-at "\\([ \t]*\n\\)*#\\+TBLFM:\\(.*\n?\\)")
+ (if (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM:\\(.*\n?\\)")
(progn
;; don't overwrite TBLFM, we might use text properties to store stuff
(goto-char (match-beginning 2))
(delete-region (match-beginning 2) (match-end 0)))
+ (org-indent-line-function)
(insert "#+TBLFM:"))
(insert " "
(mapconcat (lambda (x)
(let (scol eq eq-alist strings string seen)
(save-excursion
(goto-char (org-table-end))
- (when (looking-at "\\([ \t]*\n\\)*#\\+TBLFM: *\\(.*\\)")
+ (when (looking-at "\\([ \t]*\n\\)*[ \t]*#\\+TBLFM: *\\(.*\\)")
(setq strings (org-split-string (match-string 2) " *:: *"))
(while (setq string (pop strings))
(when (string-match "\\`\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
For all numbers larger than LIMIT, shift them by DELTA."
(save-excursion
(goto-char (org-table-end))
- (when (looking-at "#\\+TBLFM:")
+ (when (looking-at "[ \t]*#\\+TBLFM:")
(let ((re (concat key "\\([0-9]+\\)"))
(re2
(when remove
s n a)
(when remove
(while (re-search-forward re2 (point-at-eol) t)
- (replace-match "")))
+ (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
+ (replace-match ""))))
(while (re-search-forward re (point-at-eol) t)
- (setq s (match-string 1) n (string-to-number s))
- (cond
- ((setq a (assoc s replace))
- (replace-match (concat key (cdr a)) t t))
- ((and limit (> n limit))
- (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
+ (unless (save-match-data (org-in-regexp "remote([^)]+?)"))
+ (setq s (match-string 1) n (string-to-number s))
+ (cond
+ ((setq a (assoc s replace))
+ (replace-match (concat key (cdr a)) t t))
+ ((and limit (> n limit))
+ (replace-match (concat key (int-to-string (+ n delta)))
+ t t)))))))))
(defun org-table-get-specials ()
"Get the column names and local parameters for this table."
(>= i 0) (< i l)
(not (eq (aref table i) type))
(if (and relative (eq (aref table i) 'hline))
- (if org-table-error-on-row-ref-crossing-hline
- (error "Row descriptor %s used in line %d crosses hline" desc cline)
- (progn (setq i (- i (if backwards -1 1)) n 1) nil))
+ (cond
+ ((eq org-table-relative-ref-may-cross-hline t) t)
+ ((eq org-table-relative-ref-may-cross-hline 'error)
+ (error "Row descriptor %s used in line %d crosses hline" desc cline))
+ (t (setq i (- i (if backwards -1 1))
+ n 1)
+ nil))
t)))
(setq n (1- n)))
(if (or (< i 0) (>= i l))
(defun org-table-edit-formulas ()
"Edit the formulas of the current table in a separate buffer."
(interactive)
- (when (save-excursion (beginning-of-line 1) (looking-at "#\\+TBLFM"))
+ (when (save-excursion (beginning-of-line 1) (looking-at "[ \t]*#\\+TBLFM"))
(beginning-of-line 0))
(unless (org-at-table-p) (error "Not at a table"))
(org-table-get-specials)
'("\C-c`" org-table-edit-field)
'("\C-c*" org-table-recalculate)
'("\C-c^" org-table-sort-lines)
+ '("\M-a" org-table-beginning-of-field)
+ '("\M-e" org-table-end-of-field)
'([(control ?#)] org-table-rotate-recalc-marks)))
elt key fun cmd)
(while (setq elt (pop bindings))
(orgtbl-make-binding 'org-table-previous-field 104
[(shift tab)] [(tab)] "\C-i"))
+ (org-defkey orgtbl-mode-map [S-iso-lefttab]
+ (orgtbl-make-binding 'org-table-previous-field 107
+ [S-iso-lefttab] [backtab] [(shift tab)]
+ [(tab)] "\C-i"))
+
+ (org-defkey orgtbl-mode-map [backtab]
+ (orgtbl-make-binding 'org-table-previous-field 108
+ [backtab] [S-iso-lefttab] [(shift tab)]
+ [(tab)] "\C-i"))
+
(org-defkey orgtbl-mode-map "\M-\C-m"
(orgtbl-make-binding 'org-table-wrap-region 105
"\M-\C-m" [(meta return)]))
(defun orgtbl-ctrl-c-ctrl-c (arg)
"If the cursor is inside a table, realign the table.
-It it is a table to be sent away to a receiver, do it.
+If it is a table to be sent away to a receiver, do it.
With prefix arg, also recompute table."
(interactive "P")
(let ((pos (point)) action)
(save-excursion
(beginning-of-line 1)
- (setq action (cond ((looking-at "#\\+ORGTBL:.*\n[ \t]*|") (match-end 0))
+ (setq action (cond ((looking-at "[ \t]*#\\+ORGTBL:.*\n[ \t]*|") (match-end 0))
((looking-at "[ \t]*|") pos)
- ((looking-at "#\\+TBLFM:") 'recalc))))
+ ((looking-at "[ \t]*#\\+TBLFM:") 'recalc))))
(cond
((integerp action)
(goto-char action)
orgtbl-hijacker-command-102
orgtbl-hijacker-command-103
orgtbl-hijacker-command-104
- orgtbl-hijacker-command-105))
+ orgtbl-hijacker-command-105
+ yas/expand))
(org-table-blank-field))
t)
(eq N 1)
(goto-char (match-beginning 0))
(self-insert-command N))
(setq org-table-may-need-update t)
- (let (orgtbl-mode a)
- (call-interactively
- (or (key-binding
- (or (and (listp function-key-map)
- (setq a (assoc last-input-event function-key-map))
- (cdr a))
- (vector last-input-event)))
- 'self-insert-command)))))
+ (let* (orgtbl-mode
+ a
+ (cmd (or (key-binding
+ (or (and (listp function-key-map)
+ (setq a (assoc last-input-event function-key-map))
+ (cdr a))
+ (vector last-input-event)))
+ 'self-insert-command)))
+ (call-interactively cmd)
+ (if (and org-self-insert-cluster-for-undo
+ (eq cmd 'self-insert-command))
+ (if (not (eq last-command 'orgtbl-self-insert-command))
+ (setq org-self-insert-command-undo-counter 1)
+ (if (>= org-self-insert-command-undo-counter 20)
+ (setq org-self-insert-command-undo-counter 1)
+ (and (> org-self-insert-command-undo-counter 0)
+ buffer-undo-list
+ (not (cadr buffer-undo-list)) ; remove nil entry
+ (setcdr buffer-undo-list (cddr buffer-undo-list)))
+ (setq org-self-insert-command-undo-counter
+ (1+ org-self-insert-command-undo-counter))))))))
(defvar orgtbl-exp-regexp "^\\([-+]?[0-9][0-9.]*\\)[eE]\\([-+]?[0-9]+\\)$"
"Regular expression matching exponentials as produced by calc.")
(goto-char (org-table-begin))
(let (rtn)
(beginning-of-line 0)
- (while (looking-at "#\\+ORGTBL[: \t][ \t]*SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
+ (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND +\\([a-zA-Z0-9_]+\\) +\\([^ \t\r\n]+\\)\\( +.*\\)?")
(let ((name (org-no-properties (match-string 1)))
(transform (intern (match-string 2)))
(params (if (match-end 3)
org-table-last-column-widths org-table-last-alignment
org-table-last-column-widths tbeg
buffer loc)
+ (setq form (org-table-convert-refs-to-rc form))
(save-excursion
(save-restriction
(widen)
(save-excursion
(goto-char (point-min))
(if (re-search-forward
- (concat "^#\\+TBLNAME:[ \t]*" (regexp-quote name-or-id) "[ \t]*$")
+ (concat "^#[ \t]*\\+TBLNAME:[ \t]*" (regexp-quote name-or-id) "[ \t]*$")
nil t)
(setq buffer (current-buffer) loc (match-beginning 0))
- (setq id-loc (org-id-find name-or-id 'marker)
- buffer (marker-buffer id-loc)
+ (setq id-loc (org-id-find name-or-id 'marker))
+ (unless (and id-loc (markerp id-loc))
+ (error "Can't find remote table \"%s\"" name-or-id))
+ (setq buffer (marker-buffer id-loc)
loc (marker-position id-loc))
(move-marker id-loc nil)))
(switch-to-buffer buffer)
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(require 'org)
+(declare-function org-show-notification "org-clock" (parameters))
+(declare-function org-agenda-error "org-agenda" ())
+
(defvar org-timer-start-time nil
"t=0 for the running timer.")
(concat " <" (substring (org-timer-value-string) 0 -1) ">"))
(force-mode-line-update)))
+(defvar org-timer-timer1 nil)
+(defvar org-timer-timer2 nil)
+(defvar org-timer-timer3 nil)
+(defvar org-timer-last-timer nil)
+
+(defun org-timer-cancel-timers ()
+ "Reset all timers."
+ (interactive)
+ (mapc (lambda(timer)
+ (when (eval timer)
+ (cancel-timer timer)
+ (setq timer nil)))
+ '(org-timer-timer1
+ org-timer-timer2
+ org-timer-timer3))
+ (message "All timers reset"))
+
+(defun org-timer-show-remaining-time ()
+ "Display the remaining time before the timer ends."
+ (interactive)
+ (require 'time)
+ (if (and (not org-timer-timer1)
+ (not org-timer-timer2)
+ (not org-timer-timer3))
+ (message "No timer set")
+ (let* ((rtime (decode-time
+ (time-subtract (timer--time org-timer-last-timer)
+ (current-time))))
+ (rsecs (nth 0 rtime))
+ (rmins (nth 1 rtime)))
+ (message "%d minutes %d secondes left before next time out"
+ rmins rsecs))))
+
+;;;###autoload
+(defun org-timer-set-timer (minutes)
+ "Set a timer."
+ (interactive "sTime out in (min)? ")
+ (if (not (string-match "[0-9]+" minutes))
+ (org-timer-show-remaining-time)
+ (let* ((mins (string-to-number (match-string 0 minutes)))
+ (secs (* mins 60))
+ (hl (cond
+ ((string-match "Org Agenda" (buffer-name))
+ (let* ((marker (or (get-text-property (point) 'org-marker)
+ (org-agenda-error)))
+ (hdmarker (or (get-text-property (point) 'org-hd-marker)
+ marker))
+ (pos (marker-position marker)))
+ (with-current-buffer (marker-buffer marker)
+ (widen)
+ (goto-char pos)
+ (org-show-entry)
+ (org-get-heading))))
+ ((eq major-mode 'org-mode)
+ (org-get-heading))
+ (t (error "Not in an Org buffer"))))
+ timer-set)
+ (mapcar (lambda(timer)
+ (if (not (or (eval timer) timer-set))
+ (setq timer-set t
+ timer
+ (run-with-timer secs nil 'org-show-notification
+ (format "%s: time out" hl))
+ org-timer-last-timer timer)))
+ '(org-timer-timer1
+ org-timer-timer2
+ org-timer-timer3)))))
+
(provide 'org-timer)
;; arch-tag: 97538f8c-3871-4509-8f23-1e7b3ff3d107
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
:message-id message-id)
(setq message-id (org-remove-angle-brackets message-id))
(setq folder (abbreviate-file-name folder))
- (if (string-match (concat "^" (regexp-quote vm-folder-directory))
- folder)
+ (if (and vm-folder-directory
+ (string-match (concat "^" (regexp-quote vm-folder-directory))
+ folder))
(setq folder (replace-match "" t t folder)))
(setq desc (org-email-link-description))
(setq link (org-make-link "vm:" folder "#" message-id))
;; Author: Andy Stewart <lazycat dot manatee at gmail dot com>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(setq return-content
(concat return-content
(buffer-substring (point) transform-end))))
- (kill-new return-content)
+ (org-kill-new return-content)
(message "Transforming links...done, use C-y to insert text into Org-mode file")
(message "Copy with link transformation complete."))))
;; Author: Tokuya Kameshima <kames at fa2 dot so-net dot ne dot jp>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
--- /dev/null
+;;; org-xoxo.el --- XOXO export for Org-mode
+
+;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
+;; Free Software Foundation, Inc.
+
+;; Author: Carsten Dominik <carsten at orgmode dot org>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: http://orgmode.org
+;; Version: 6.29c
+;;
+;; This file is part of GNU Emacs.
+;;
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Commentary:
+
+(require 'org-exp)
+
+;;; XOXO export
+
+(defun org-export-as-xoxo-insert-into (buffer &rest output)
+ (with-current-buffer buffer
+ (apply 'insert output)))
+(put 'org-export-as-xoxo-insert-into 'lisp-indent-function 1)
+
+;;;###autoload
+(defun org-export-as-xoxo (&optional buffer)
+ "Export the org buffer as XOXO.
+The XOXO buffer is named *xoxo-<source buffer name>*"
+ (interactive (list (current-buffer)))
+ ;; A quickie abstraction
+
+ ;; Output everything as XOXO
+ (with-current-buffer (get-buffer buffer)
+ (let* ((pos (point))
+ (opt-plist (org-combine-plists (org-default-export-plist)
+ (org-infile-export-plist)))
+ (filename (concat (file-name-as-directory
+ (org-export-directory :xoxo opt-plist))
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name))
+ ".html"))
+ (out (find-file-noselect filename))
+ (last-level 1)
+ (hanging-li nil))
+ (goto-char (point-min)) ;; CD: beginning-of-buffer is not allowed.
+ ;; Check the output buffer is empty.
+ (with-current-buffer out (erase-buffer))
+ ;; Kick off the output
+ (org-export-as-xoxo-insert-into out "<ol class='xoxo'>\n")
+ (while (re-search-forward "^\\(\\*+\\)[ \t]+\\(.+\\)" (point-max) 't)
+ (let* ((hd (match-string-no-properties 1))
+ (level (length hd))
+ (text (concat
+ (match-string-no-properties 2)
+ (save-excursion
+ (goto-char (match-end 0))
+ (let ((str ""))
+ (catch 'loop
+ (while 't
+ (forward-line)
+ (if (looking-at "^[ \t]\\(.*\\)")
+ (setq str (concat str (match-string-no-properties 1)))
+ (throw 'loop str)))))))))
+
+ ;; Handle level rendering
+ (cond
+ ((> level last-level)
+ (org-export-as-xoxo-insert-into out "\n<ol>\n"))
+
+ ((< level last-level)
+ (dotimes (- (- last-level level) 1)
+ (if hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n"))
+ (org-export-as-xoxo-insert-into out "</ol>\n"))
+ (when hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n")
+ (setq hanging-li nil)))
+
+ ((equal level last-level)
+ (if hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n")))
+ )
+
+ (setq last-level level)
+
+ ;; And output the new li
+ (setq hanging-li 't)
+ (if (equal ?+ (elt text 0))
+ (org-export-as-xoxo-insert-into out "<li class='" (substring text 1) "'>")
+ (org-export-as-xoxo-insert-into out "<li>" text))))
+
+ ;; Finally finish off the ol
+ (dotimes (- last-level 1)
+ (if hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n"))
+ (org-export-as-xoxo-insert-into out "</ol>\n"))
+
+ (goto-char pos)
+ ;; Finish the buffer off and clean it up.
+ (switch-to-buffer-other-window out)
+ (indent-region (point-min) (point-max) nil)
+ (save-buffer)
+ (goto-char (point-min))
+ )))
+
+(provide 'org-xoxo)
+
+;; arch-tag: 16e6a31f-f4f5-46f1-af18-48dc89faa702
+
+
+;;; org-xoxo.el ends here
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
-;; Version: 6.21b
+;; Version: 6.29c
;;
;; This file is part of GNU Emacs.
;;
(require 'org-compat)
(require 'org-faces)
(require 'org-list)
+(require 'org-src)
(require 'org-footnote)
;;;; Customization variables
;;; Version
-(defconst org-version "6.21b"
+(defconst org-version "6.29c"
"The version number of the file org.el.")
(defun org-version (&optional here)
(const :tag " id: Global IDs for identifying entries" org-id)
(const :tag " info: Links to Info nodes" org-info)
(const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
+ (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
(const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
(const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
(const :tag " mew Links to Mew folders/messages" org-mew)
(const :tag " mhe: Links to MHE folders/messages" org-mhe)
+ (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
(const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
(const :tag " vm: Links to VM folders/messages" org-vm)
(const :tag " wl: Links to Wanderlust folders/messages" org-wl)
- (const :tag " w3m: Special cut/past from w3m to Org." org-w3m)
+ (const :tag " w3m: Special cut/paste from w3m to Org." org-w3m)
(const :tag " mouse: Additional mouse support" org-mouse)
(const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
- (const :tag "C annotation-helper: Call Remember directly from Browser" org-annotation-helper)
+ (const :tag "C annotation-helper: Call Remember directly from Browser (OBSOLETE, use org-protocol)" org-annotation-helper)
(const :tag "C bookmark: Org links to bookmarks" org-bookmark)
- (const :tag "C browser-url: Store link, directly from Browser" org-browser-url)
- (const :tag "C depend: TODO dependencies for Org-mode" org-depend)
+ (const :tag "C browser-url: Store link, directly from Browser (OBSOLETE, use org-protocol)" org-browser-url)
+ (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
+ (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
+ (const :tag "C collector: Collect properties into tables" org-collector)
+ (const :tag "C depend: TODO dependencies for Org-mode (PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
(const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
(const :tag "C eval: Include command output as text" org-eval)
(const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
(const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
- (const :tag "C exp-blocks: Pre-process blocks for export" org-exp-blocks)
- (const :tag "C interactive-query: Interactive modification of tags query" org-interactive-query)
+ (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
+ (const :tag "C interactive-query: Interactive modification of tags query (PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
+ (const :tag "C jira Add a jira:ticket protocol to Org" org-jira)
(const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
+ (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
(const :tag "C man: Support for links to manpages in Org-mode" org-man)
(const :tag "C mtags: Support for muse-like tags" org-mtags)
(const :tag "C panel: Simple routines for us with bad memory" org-panel)
+ (const :tag "C R: Computation using the R language" org-R)
(const :tag "C registry: A registry for Org links" org-registry)
(const :tag "C org2rem: Convert org appointments into reminders" org2rem)
(const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
- (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
+ (const :tag "C special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
(const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
+ (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
(repeat :tag "External packages" :inline t (symbol :tag "Package"))))
(defcustom org-support-shift-select nil
:group 'org-startup
:type 'boolean)
+(defcustom org-startup-indented nil
+ "Non-nil means, turn on `org-indent-mode' on startup.
+This can also be configured on a per-file basis by adding one of
+the following lines anywhere in the buffer:
+
+ #+STARTUP: indent
+ #+STARTUP: noindent"
+ :group 'org-structure
+ :type '(choice
+ (const :tag "Not" nil)
+ (const :tag "Globally (slow on startup in large files)" t)))
+
(defcustom org-startup-align-all-tables nil
"Non-nil means, align all tables when visiting a file.
This is useful when the column width in tables is forced with <N> cookies
(defcustom org-replace-disputed-keys nil
"Non-nil means use alternative key bindings for some keys.
Org-mode uses S-<cursor> keys for changing timestamps and priorities.
-These keys are also used by other packages like `CUA-mode' or `windmove.el'.
+These keys are also used by other packages like shift-selection-mode'
+\(built into Emacs 23), `CUA-mode' or `windmove.el'.
If you want to use Org-mode together with one of these other modes,
or more generally if you would like to move some Org-mode commands to
other keys, set this variable and configure the keys with the variable
:tag "Org Cycle"
:group 'org-structure)
-(defcustom org-drawers '("PROPERTIES" "CLOCK")
+(defcustom org-cycle-skip-children-state-if-no-children t
+ "Non-nil means, skip CHILDREN state in entries that don't have any."
+ :group 'org-cycle
+ :type 'boolean)
+
+(defcustom org-cycle-max-level nil
+ "Maximum level which should still be subject to visibility cycling.
+Levels higher than this will, for cycling, be treated as text, not a headline.
+When `org-odd-levels-only' is set, a value of N in this variable actually
+means 2N-1 stars as the limiting headline.
+When nil, cycle all levels.
+Note that the limiting level of cycling is also influenced by
+`org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
+`org-inlinetask-min-level' is, cycling will be limited to levels one less
+than its value."
+ :group 'org-cycle
+ :type '(choice
+ (const :tag "No limit" nil)
+ (integer :tag "Maximum level")))
+
+(defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
"Names of drawers. Drawers are not opened by cycling on the headline above.
Drawers only open with a TAB on the drawer line itself. A drawer looks like
this:
#+DRAWERS: HIDDEN STATE PROPERTIES"
:group 'org-structure
+ :group 'org-cycle
:type '(repeat (string :tag "Drawer Name")))
+(defcustom org-hide-block-startup nil
+ "Non-nil means, , entering Org-mode will fold all blocks.
+This can also be set in on a per-file basis with
+
+#+STARTUP: hideblocks
+#+STARTUP: showblocks"
+ :group 'org-startup
+ :group 'org-cycle
+ :type 'boolean)
+
(defcustom org-cycle-global-at-bob nil
"Cycle globally if cursor is at beginning of buffer and not at a headline.
This makes it possible to do global cycling without having to use S-TAB or
:type 'integer)
(put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
+(defcustom org-pre-cycle-hook nil
+ "Hook that is run before visibility cycling is happening.
+The function(s) in this hook must accept a single argument which indicates
+the new state that will be set right after running this hook. The
+argument is a symbol. Before a global state change, it can have the values
+`overview', `content', or `all'. Before a local state change, it can have
+the values `folded', `children', or `subtree'."
+ :group 'org-cycle
+ :type 'hook)
+
(defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
org-cycle-hide-drawers
org-cycle-show-empty-lines
:type 'boolean)
(defcustom org-adapt-indentation t
- "Non-nil means, adapt indentation when promoting and demoting.
-When this is set and the *entire* text in an entry is indented, the
-indentation is increased by one space in a demotion command, and
-decreased by one in a promotion command. If any line in the entry
-body starts at column 0, indentation is not changed at all."
+ "Non-nil means, adapt indentation to outline node level.
+
+When this variable is set, Org assumes that you write outlines by
+indenting text in each node to align with the headline (after the stars).
+The following issues are influenced by this variable:
+
+- When this is set and the *entire* text in an entry is indented, the
+ indentation is increased by one space in a demotion command, and
+ decreased by one in a promotion command. If any line in the entry
+ body starts with text at column 0, indentation is not changed at all.
+
+- Property drawers and planning information is inserted indented when
+ this variable s set. When nil, they will not be indented.
+
+- TAB indents a line relative to context. The lines below a headline
+ will be indented when this variable is set.
+
+Note that this is all about true indentation, by adding and removing
+space characters. See also `org-indent.el' which does level-dependent
+indentation in a virtual way, i.e. at display time in Emacs."
:group 'org-edit-structure
:type 'boolean)
(defcustom org-special-ctrl-a/e nil
"Non-nil means `C-a' and `C-e' behave specially in headlines and items.
+
When t, `C-a' will bring back the cursor to the beginning of the
headline text, i.e. after the stars and after a possible TODO keyword.
In an item, this will be the position after the bullet.
When the cursor is already at that position, another `C-a' will bring
it to the beginning of the line.
+
`C-e' will jump to the end of the headline, ignoring the presence of tags
in the headline. A second `C-e' will then jump to the true end of the
line, after any tags.
+
When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
-and only a directly following, identical keypress will bring the cursor
-to the special positions."
+going to the true line boundary first. Only a directly following, identical
+keypress will bring the cursor to the special positions.
+
+This may also be a cons cell where the behavior for `C-a' and `C-e' is
+set separately."
:group 'org-edit-structure
:type '(choice
(const :tag "off" nil)
- (const :tag "after bullet first" t)
- (const :tag "border first" reversed)))
-
+ (const :tag "after stars/bullet and before tags first" t)
+ (const :tag "true line boundary first" reversed)
+ (cons :tag "Set C-a and C-e separately"
+ (choice :tag "Special C-a"
+ (const :tag "off" nil)
+ (const :tag "after stars/bullet first" t)
+ (const :tag "before stars/bullet first" reversed))
+ (choice :tag "Special C-e"
+ (const :tag "off" nil)
+ (const :tag "before tags first" t)
+ (const :tag "after tags first" reversed)))))
(if (fboundp 'defvaralias)
(defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
(plain-list-item . auto))
"Should `org-insert-heading' leave a blank line before new heading/item?
The value is an alist, with `heading' and `plain-list-item' as car,
-and a boolean flag as cdr."
+and a boolean flag as cdr. For plain lists, if the variable
+`org-empty-line-terminates-plain-lists' is set, the setting here
+is ignored and no empty line is inserted, to keep the list in tact."
:group 'org-edit-structure
:type '(list
(cons (const heading)
:group 'org-edit-structure
:type 'boolean)
-(defcustom org-edit-src-region-extra nil
- "Additional regexps to identify regions for editing with `org-edit-src-code'.
-For examples see the function `org-edit-src-find-region-and-lang'.
-The regular expression identifying the begin marker should end with a newline,
-and the regexp marking the end line should start with a newline, to make sure
-there are kept outside the narrowed region."
- :group 'org-edit-structure
- :type '(repeat
- (list
- (regexp :tag "begin regexp")
- (regexp :tag "end regexp")
- (choice :tag "language"
- (string :tag "specify")
- (integer :tag "from match group")
- (const :tag "from `lang' element")
- (const :tag "from `style' element")))))
-
-(defcustom org-coderef-label-format "(ref:%s)"
- "The default coderef format.
-This format string will be used to search for coderef labels in literal
-examples (EXAMPLE and SRC blocks). The format can be overwritten
-an individual literal example with the -f option, like
-
-#+BEGIN_SRC pascal +n -r -l \"((%s))\"
-...
-#+END_SRC
-
-If you want to use this for HTML export, make sure that the format does
-not introduce special font-locking, and avoid the HTML special
-characters `<', `>', and `&'. The reason for this restriction is that
-the labels are searched for only after htmlize has done its job."
- :group 'org-edit-structure ; FIXME this is not in the right group
- :type 'string)
-
-(defcustom org-edit-fixed-width-region-mode 'artist-mode
- "The mode that should be used to edit fixed-width regions.
-These are the regions where each line starts with a colon."
- :group 'org-edit-structure
- :type '(choice
- (const artist-mode)
- (const picture-mode)
- (const fundamental-mode)
- (function :tag "Other (specify)")))
(defcustom org-goto-auto-isearch t
"Non-nil means, typing characters in org-goto starts incremental search."
"The maximum level for Imenu access to Org-mode headlines.
This also applied for speedbar access."
:group 'org-imenu-and-speedbar
- :type 'number)
+ :type 'integer)
(defgroup org-table nil
"Options concerning tables in Org-mode."
(const :tag "on" t)
(const :tag "on, optimized" optimized)))
+(defcustom org-self-insert-cluster-for-undo t
+ "Non-nil means cluster self-insert commands for undo when possible.
+If this is set, then, like in the Emacs command loop, 20 consequtive
+characters will be undone together.
+This is configurable, because there is some impact on typing performance."
+ :group 'org-table
+ :type 'boolean)
+
(defcustom org-table-tab-recognizes-table.el t
"Non-nil means, TAB will automatically notice a table.el table.
When it sees such a table, it moves point into it and - if necessary -
[[linkkey:tag][description]]
+The 'linkkey' must be a word word, starting with a letter, followed
+by letters, numbers, '-' or '_'.
+
If REPLACE is a string, the tag will simply be appended to create the link.
If the string contains \"%s\", the tag will be inserted there. Alternatively,
the placeholder \"%h\" will cause a url-encoded version of the tag to
:group 'org-link-store
:type 'regexp)
-(defcustom org-link-to-org-use-id 'create-if-interactive
+(defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
"Non-nil means, storing a link to an Org file will use entry IDs.
Note that before this variable is even considered, org-id must be loaded,
-to please customize `org-modules' and turn it on.
+so please customize `org-modules' and turn it on.
The variable can have the following values:
template to an entry not having an ID, create it first by
explicitly creating a link to it, using `C-c C-l' first.
+create-if-interactive-and-no-custom-id
+ Like create-if-interactive, but do not create an ID if there is
+ a CUSTOM_ID property defined in the entry. This is the default.
+
use-existing
Use existing ID, do not create one.
:group 'org-link-store
:type '(choice
(const :tag "Create ID to make link" t)
- (const :tag "Create if string link interactively"
- 'create-if-interactive)
- (const :tag "Only use existing" 'use-existing)
+ (const :tag "Create if storing link interactively"
+ create-if-interactive)
+ (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
+ create-if-interactive-and-no-custom-id)
+ (const :tag "Only use existing" use-existing)
(const :tag "Do not use ID to create link" nil)))
(defcustom org-context-in-file-links t
(defcustom org-tab-follows-link nil
"Non-nil means, on links TAB will follow the link.
-Needs to be set before org.el is loaded."
+Needs to be set before org.el is loaded.
+This really should not be used, it does not make sense, and the
+implementation is bad."
:group 'org-link-follow
:type 'boolean)
(defcustom org-open-non-existing-files nil
"Non-nil means, `org-open-file' will open non-existing files.
-When nil, an error will be generated."
+When nil, an error will be generated.
+This variable applies only to external applications because they
+might choke on non-existing files. If the link is to a file that
+will be openend in Emacs, the variable is ignored."
:group 'org-link-follow
:type 'boolean)
This link would show up in your Org-mode document as \"Google Search\",
but really it would remove your entire home directory.
Therefore we advise against setting this variable to nil.
-Just change it to `y-or-n-p' of you want to confirm with a
+Just change it to `y-or-n-p' if you want to confirm with a
single keystroke rather than having to type \"yes\"."
:group 'org-link-follow
:type '(choice
This link would show up in your Org-mode document as \"Google Search\",
but really it would remove your entire home directory.
Therefore we advise against setting this variable to nil.
-Just change it to `y-or-n-p' of you want to confirm with a
+Just change it to `y-or-n-p' if you want to confirm with a
single keystroke rather than having to type \"yes\"."
:group 'org-link-follow
:type '(choice
does define this command, but you can overrule/replace it
here.
string A command to be executed by a shell; %s will be replaced
- by the path to the file.
+ by the path to the file.
sexp A Lisp form which will be evaluated. The file path will
- be available in the Lisp variable `file'.
+ be available in the Lisp variable `file'.
For more examples, see the system specific constants
`org-file-apps-defaults-macosx'
`org-file-apps-defaults-windowsnt'
(defcustom org-directory "~/org"
"Directory with org files.
-This directory will be used as default to prompt for org files.
-Used by the hooks for remember.el."
+This is just a default location to look for Org files. There is no need
+at all to put your files into this directory. It is only used in the
+following situations:
+
+1. When a remember template specifies a target file that is not an
+ absolute path. The path will then be interpreted relative to
+ `org-directory'
+2. When a remember note is filed away in an interactive way (when exiting the
+ note buffer with `C-1 C-c C-c'. The the user is prompted for an org file,
+ with `org-directory' as the default path."
:group 'org-refile
:group 'org-remember
:type 'directory)
(defcustom org-goto-max-level 5
"Maximum level to be considered when running org-goto with refile interface."
:group 'org-refile
- :type 'number)
+ :type 'integer)
(defcustom org-reverse-note-order nil
"Non-nil means, store new notes at the beginning of a file or entry.
a file name or a list of file names. If you use `org-agenda-files' for
that, all agenda files will be scanned for targets. Nil means, consider
headings in the current buffer.
-- A specification of how to select find candidate refile targets. This
- may be any of
+- A specification of how to find candidate refile targets. This may be
+ any of:
- a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
This tag has to be present in all target headlines, inheritance will
not be considered.
- a cons cell (:regexp . \"REGEXP\") with a regular expression matching
headlines that are refiling targets.
- a cons cell (:level . N). Any headline of level N is considered a target.
+ Note that, when `org-odd-levels-only' is set, level corresponds to
+ order in hierarchy, not to the number of stars.
- a cons cell (:maxlevel . N). Any headline with level <= N is a target.
+ Note that, when `org-odd-levels-only' is set, level corresponds to
+ order in hierarchy, not to the number of stars.
+
+You can set the variable `org-refile-target-verify-function' to a function
+to verify each headline found by the simple critery above.
When this variable is nil, all top-level headlines in the current buffer
are used, equivalent to the value `((nil . (:level . 1))'."
(cons :tag "Level number" (const :value :level) (integer))
(cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
+(defcustom org-refile-target-verify-function nil
+ "Function to verify if the headline at point should be a refile target.
+The function will be called without arguments, with point at the
+beginning of the headline. It should return t and leave point
+where it is if the headline is a valid target for refiling.
+
+If the target should not be selected, the function must return nil.
+In addition to this, it may move point to a place from where the search
+should be continued. For example, the function may decide that the entire
+subtree of the current entry should be excluded and move point to the end
+of the subtree."
+ :group 'org-refile
+ :type 'function)
+
(defcustom org-refile-use-outline-path nil
"Non-nil means, provide refile targets as paths.
So a level 3 headline will be available as level1/level2/level3.
+
When the value is `file', also include the file name (without directory)
-into the path. When `full-file-path', include the full file path."
+into the path. In this case, you can also stop the completion after
+the file name, to get entries inserted as top level in the file.
+
+ When `full-file-path', include the full file path."
:group 'org-refile
:type '(choice
(const :tag "Not" nil)
:group 'org-refile
:type 'boolean)
+(defcustom org-refile-allow-creating-parent-nodes nil
+ "Non-nil means, allow to create new nodes as refile targets.
+New nodes are then created by adding \"/new node name\" to the completion
+of an existing node. When the value of this variable is `confirm',
+new node creation must be confirmed by the user (recommended)
+When nil, the completion must match an existing entry.
+
+Note that, if the new heading is not seen by the criteria
+listed in `org-refile-targets', multiple instances of the same
+heading would be created by trying again to file under the new
+heading."
+ :group 'org-refile
+ :type '(choice
+ (const :tag "Never" nil)
+ (const :tag "Always" t)
+ (const :tag "Prompt for confirmation" confirm)))
+
(defgroup org-todo nil
"Options concerning TODO items in Org-mode."
:tag "Org TODO"
:tag "Org Progress"
:group 'org-time)
+(defvar org-todo-interpretation-widgets
+ '(
+ (:tag "Sequence (cycling hits every state)" sequence)
+ (:tag "Type (cycling directly to DONE)" type))
+ "The available interpretation symbols for customizing
+ `org-todo-keywords'.
+ Interested libraries should add to this list.")
+
(defcustom org-todo-keywords '((sequence "TODO" "DONE"))
"List of TODO entry keyword sequences and their interpretation.
\\<org-mode-map>This is a list of sequences.
(cons
(choice
:tag "Interpretation"
- (const :tag "Sequence (cycling hits every state)" sequence)
- (const :tag "Type (cycling directly to DONE)" type))
+ ;;Quick and dirty way to see
+ ;;`org-todo-interpretations'. This takes the
+ ;;place of item arguments
+ :convert-widget
+ (lambda (widget)
+ (widget-put widget
+ :args (mapcar
+ #'(lambda (x)
+ (widget-convert
+ (cons 'const x)))
+ org-todo-interpretation-widgets))
+ widget))
(repeat
(string :tag "Keyword"))))))
(defcustom org-provide-todo-statistics t
"Non-nil means, update todo statistics after insert and toggle.
-When this is set, todo statistics is updated in the parent of the current
-entry each time a todo state is changed."
+ALL-HEADLINES means update todo statistics by including headlines
+with no TODO keyword as well, counting them as not done.
+A list of TODO keywords means the same, but skip keywords that are
+not in this list.
+
+When this is set, todo statistics is updated in the parent of the
+current entry each time a todo state is changed."
+ :group 'org-todo
+ :type '(choice
+ (const :tag "Yes, only for TODO entries" t)
+ (const :tag "Yes, including all entries" 'all-headlines)
+ (repeat :tag "Yes, for TODOs in this list"
+ (string :tag "TODO keyword"))
+ (other :tag "No TODO statistics" nil)))
+
+(defcustom org-hierarchical-todo-statistics t
+ "Non-nil means, TODO statistics covers just direct children.
+When nil, all entries in the subtree are considered.
+This has only an effect if `org-provide-todo-statistics' is set."
:group 'org-todo
:type 'boolean)
"Non-nil means, undone TODO entries will block switching the parent to DONE.
Also, if a parent has an :ORDERED: property, switching an entry to DONE will
be blocked if any prior sibling is not yet done.
+Finally, if the parent is blocked because of ordered siblings of its own,
+the child will also be blocked.
This variable needs to be set before org.el is loaded, and you need to
restart Emacs after a change to make the change effective. The only way
to change is while Emacs is running is through the customize interface."
(set var val)
(if val
(add-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings)
+ 'org-block-todo-from-children-or-siblings-or-parent)
(remove-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings)))
+ 'org-block-todo-from-children-or-siblings-or-parent)))
:group 'org-todo
:type 'boolean)
:group 'org-todo
:type 'boolean)
+(defcustom org-treat-insert-todo-heading-as-state-change nil
+ "Non-nil means, inserting a TODO heading is treated as state change.
+So when the command \\[org-insert-todo-heading] is used, state change
+logging will apply if appropriate. When nil, the new TODO item will
+be inserted directly, and no logging will take place."
+ :group 'org-todo
+ :type 'boolean)
+
+(defcustom org-treat-S-cursor-todo-selection-as-state-change t
+ "Non-nil means, switching TODO states with S-cursor counts as state change.
+This is the default behavior. However, setting this to nil allows a
+convenient way to select a TODO state and bypass any logging associated
+with that."
+ :group 'org-todo
+ :type 'boolean)
+
(defcustom org-todo-state-tags-triggers nil
"Tag changes that should be triggered by TODO state changes.
This is a list. Each entry is
(defcustom org-log-note-headings
'((done . "CLOSING NOTE %t")
- (state . "State %-12s %t")
+ (state . "State %-12s from %-12S %t")
(note . "Note taken on %t")
(clock-out . ""))
"Headings for notes added to entries.
empty string.
%t in the heading will be replaced by a time stamp.
%s will be replaced by the new TODO state, in double quotes.
+%S will be replaced by the old TODO state, in double quotes.
%u will be replaced by the user name.
%U will be replaced by the full user name."
:group 'org-todo
(unless (assq 'note org-log-note-headings)
(push '(note . "%t") org-log-note-headings))
+(defcustom org-log-into-drawer nil
+ "Non-nil means, insert state change notes and time stamps into a drawer.
+When nil, state changes notes will be inserted after the headline and
+any scheduling and clock lines, but not inside a drawer.
+
+The value of this variable should be the name of the drawer to use.
+LOGBOOK is proposed at the default drawer for this purpose, you can
+also set this to a string to define the drawer of your choice.
+
+A value of t is also allowed, representing \"LOGBOOK\".
+
+If this variable is set, `org-log-state-notes-insert-after-drawers'
+will be ignored.
+
+You can set the property LOG_INTO_DRAWER to overrule this setting for
+a subtree."
+ :group 'org-todo
+ :group 'org-progress
+ :type '(choice
+ (const :tag "Not into a drawer" nil)
+ (const :tag "LOGBOOK" t)
+ (string :tag "Other")))
+
+(if (fboundp 'defvaralias)
+ (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
+
+(defun org-log-into-drawer ()
+ "Return the value of `org-log-into-drawer', but let properties overrule.
+If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
+used instead of the default value."
+ (let ((p (ignore-errors (org-entry-get nil "LOG_INTO_DRAWER" 'inherit))))
+ (cond
+ ((or (not p) (equal p "nil")) org-log-into-drawer)
+ ((equal p "t") "LOGBOOK")
+ (t p))))
+
(defcustom org-log-state-notes-insert-after-drawers nil
"Non-nil means, insert state change notes after any drawers in entry.
Only the drawers that *immediately* follow the headline and the
deadline/scheduled line are skipped.
When nil, insert notes right after the heading and perhaps the line
-with deadline/scheduling if present."
+with deadline/scheduling if present.
+
+This variable will have no effect if `org-log-into-drawer' is
+set."
:group 'org-todo
:group 'org-progress
:type 'boolean)
:tag "Org Priorities"
:group 'org-todo)
+(defcustom org-enable-priority-commands t
+ "Non-nil means, priority commands are active.
+When nil, these commands will be disabled, so that you never accidentally
+set a priority."
+ :group 'org-priorities
+ :type 'boolean)
+
(defcustom org-highest-priority ?A
"The highest priority of TODO items. A character like ?A, ?B etc.
Must have a smaller ASCII number than `org-lowest-priority'."
"Custom formats for time stamps. See `format-time-string' for the syntax.
These are overlayed over the default ISO format if the variable
`org-display-custom-times' is set. Time like %H:%M should be at the
-end of the second format."
+end of the second format. The custom formats are also honored by export
+commands, if custom time display is turned on at the time of export."
:group 'org-time
:type 'sexp)
"No. of days before expiration during which a deadline becomes active.
This variable governs the display in sparse trees and in the agenda.
When 0 or negative, it means use this number (the absolute value of it)
-even if a deadline has a different individual lead time specified."
+even if a deadline has a different individual lead time specified.
+
+Custom commands can set this variable in the options section."
:group 'org-time
:group 'org-agenda-daily/weekly
- :type 'number)
+ :type 'integer)
(defcustom org-read-date-prefer-future t
"Non-nil means, assume future for incomplete date input from user.
(defvaralias 'org-popup-calendar-for-date-prompt
'org-read-date-popup-calendar))
+(defcustom org-read-date-minibuffer-setup-hook nil
+ "Hook to be used to set up keys for the date/time interface.
+Add key definitions to `minibuffer-local-map', which will be a temporary
+copy."
+ :group 'org-time
+ :type 'hook)
+
(defcustom org-extend-today-until 0
"The hour when your day really ends. Must be an integer.
This has influence for the following applications:
remain incomplete. Really, it is only here because past midnight seems to
be the favorite working time of John Wiegley :-)"
:group 'org-time
- :type 'number)
+ :type 'integer)
(defcustom org-edit-timestamp-down-means-later nil
"Non-nil means, S-down will increase the time in a time stamp.
(cons (string :tag "Tag name")
(character :tag "Access char"))
(const :tag "Start radio group" (:startgroup))
- (const :tag "End radio group" (:endgroup)))))
+ (const :tag "End radio group" (:endgroup))
+ (const :tag "New line" (:newline)))))
+
+(defcustom org-tag-persistent-alist nil
+ "List of tags that will always appear in all Org-mode files.
+This is in addition to any in buffer settings or customizations
+of `org-tag-alist'.
+When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
+The value of this variable is an alist, the car of each entry must be a
+keyword as a string, the cdr may be a character that is used to select
+that tag through the fast-tag-selection interface.
+See the manual for details.
+To disable these tags on a per-file basis, insert anywhere in the file:
+ #+STARTUP: noptag"
+ :group 'org-tags
+ :type '(repeat
+ (choice
+ (cons (string :tag "Tag name")
+ (character :tag "Access char"))
+ (const :tag "Start radio group" (:startgroup))
+ (const :tag "End radio group" (:endgroup))
+ (const :tag "New line" (:newline)))))
(defvar org-file-tags nil
"List of tags that can be inherited by all entries in the file.
(t (error "Invalid setting of `org-use-tag-inheritance'"))))
(defcustom org-tags-match-list-sublevels t
- "Non-nil means list also sublevels of headlines matching tag search.
+ "Non-nil means list also sublevels of headlines matching a search.
+This variable applies to tags/property searches, and also to stuck
+projects because this search is based on a tags match as well.
+
+When set to the symbol `indented', sublevels are indented with
+leading dots.
+
Because of tag inheritance (see variable `org-use-tag-inheritance'),
the sublevels of a headline matching a tag search often also match
the same search. Listing all of them can create very long lists.
Setting this variable to nil causes subtrees of a match to be skipped.
-This option is off by default, because inheritance in on. If you turn
-inheritance off, you very likely want to turn this option on.
-
-As a special case, if the tag search is restricted to TODO items, the
-value of this variable is ignored and sublevels are always checked, to
-make sure all corresponding TODO items find their way into the list.
This variable is semi-obsolete and probably should always be true. It
is better to limit inheritance to certain tags using the variables
`org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
:group 'org-tags
- :type 'boolean)
+ :type '(choice
+ (const :tag "No, don't list them" nil)
+ (const :tag "Yes, do list them" t)
+ (const :tag "List them, indented with leading dots" indented)))
+
+(defcustom org-tags-sort-function nil
+ "When set, tags are sorted using this function as a comparator"
+ :group 'org-tags
+ :type '(choice
+ (const :tag "No sorting" nil)
+ (const :tag "Alphabetical" string<)
+ (const :tag "Reverse alphabetical" string>)
+ (function :tag "Custom function" nil)))
(defvar org-tags-history nil
"History of minibuffer reads for tags.")
:type '(string :tag "Property"))
(defconst org-global-properties-fixed
- '(("VISIBILITY_ALL" . "folded children content all"))
+ '(("VISIBILITY_ALL" . "folded children content all")
+ ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
"List of property/value pairs that can be inherited by any entry.
-These are fixed values, for the preset properties.")
+These are fixed values, for the preset properties. The user variable
+that can be used to add to this list is `org-global-properties'.
+
+The entries in this list are cons cells where the car is a property
+name and cdr is a string with the value. If the value represents
+multiple items like an \"_ALL\" property, separate the items by
+spaces.")
(defcustom org-global-properties nil
"List of property/value pairs that can be inherited by any entry.
+
+This list will be combined with the constant `org-global-properties-fixed'.
+
+The entries in this list are cons cells where the car is a property
+name and cdr is a string with the value.
+
You can set buffer-local values for the same purpose in the variable
`org-file-properties' this by adding lines like
:group 'org-font-lock
:type 'boolean)
+(defcustom org-fontify-whole-heading-line nil
+ "Non-nil means fontify the whole line for headings.
+This is useful when setting a background color for the
+org-leve-* faces."
+ :group 'org-font-lock
+ :type 'boolean)
+
(defcustom org-highlight-latex-fragments-and-specials nil
"Non-nil means, fontify what is treated specially by the exporters."
:group 'org-font-lock
"\\([" post "]\\|$\\)")))))
(defcustom org-emphasis-regexp-components
- '(" \t('\"" "- \t.,:?;'\")" " \t\r\n,\"'" "." 1)
+ '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
"Components used to build the regular expression for emphasis.
This is a list with 6 entries. Terminology: In an emphasis string
like \" *strong word* \", we call the initial space PREMATCH, the final
example *bold*, _underlined_ and /italic/. This variable sets the marker
characters, the face to be used by font-lock for highlighting in Org-mode
Emacs buffers, and the HTML tags to be used for this.
+For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
Use customize to modify this, or restart Emacs after changing it."
:group 'org-font-lock
:set 'org-set-emph-re
(string :tag "HTML end tag")
(option (const verbatim)))))
+(defvar org-protecting-blocks
+ '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
+ "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
+This is needed for font-lock setup.")
+
;;; Miscellaneous options
(defgroup org-completion nil
(declare-function org-agenda-copy-local-variable "org-agenda" (var))
(declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
"org-agenda" (&optional end))
-
+(declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
+(declare-function org-indent-mode "org-indent" (arg))
(declare-function parse-time-string "parse-time" (string))
(declare-function remember "remember" (&optional initial))
(declare-function remember-buffer-desc "remember" ())
(while (re-search-forward org-table-any-line-regexp nil t)
(message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
(beginning-of-line 1)
- (if (looking-at org-table-line-regexp)
- (save-excursion (funcall function)))
+ (when (looking-at org-table-line-regexp)
+ (save-excursion (funcall function))
+ (or (looking-at org-table-line-regexp)
+ (forward-char 1)))
(re-search-forward org-table-any-border-regexp nil 1))))
(message "Mapping tables: done"))
-;; Declare and autoload functions from org-exp.el
+;; Declare and autoload functions from org-exp.el & Co
(declare-function org-default-export-plist "org-exp")
(declare-function org-infile-export-plist "org-exp")
(declare-function org-get-current-options "org-exp")
(eval-and-compile
(org-autoload "org-exp"
- '(org-export org-export-as-ascii org-export-visible
- org-insert-export-options-template org-export-as-html-and-open
- org-export-as-html-batch org-export-as-html-to-buffer
- org-replace-region-by-html org-export-region-as-html
- org-export-as-html org-export-icalendar-this-file
- org-export-icalendar-all-agenda-files
- org-table-clean-before-export
- org-export-icalendar-combine-agenda-files org-export-as-xoxo)))
+ '(org-export org-export-visible
+ org-insert-export-options-template
+ org-table-clean-before-export))
+ (org-autoload "org-ascii"
+ '(org-export-as-ascii org-export-ascii-preprocess
+ org-export-as-ascii-to-buffer org-replace-region-by-ascii
+ org-export-region-as-ascii))
+ (org-autoload "org-html"
+ '(org-export-as-html-and-open
+ org-export-as-html-batch org-export-as-html-to-buffer
+ org-replace-region-by-html org-export-region-as-html
+ org-export-as-html))
+ (org-autoload "org-icalendar"
+ '(org-export-icalendar-this-file
+ org-export-icalendar-all-agenda-files
+ org-export-icalendar-combine-agenda-files))
+ (org-autoload "org-xoxo" '(org-export-as-xoxo)))
;; Declare and autoload functions from org-agenda.el
(defvar org-clock-start-time)
(defvar org-clock-marker (make-marker)
"Marker recording the last clock-in.")
+(defun org-clock-is-active ()
+ "Return non-nil if clock is currently running.
+The return value is actually the clock marker."
+ (marker-buffer org-clock-marker))
(eval-and-compile
(org-autoload
;; Autoload org-timer.el
-;(declare-function org-timer "org-timer")
-
(eval-and-compile
(org-autoload
"org-timer"
'(org-timer-start org-timer org-timer-item
- org-timer-change-times-in-region)))
+ org-timer-change-times-in-region
+ org-timer-set-timer
+ org-timer-reset-timers
+ org-timer-show-remaining-time)))
+
+;; Autoload org-feed.el
+
+(eval-and-compile
+ (org-autoload
+ "org-feed"
+ '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
+
+;; Autoload org-indent.el
+
+(eval-and-compile
+ (org-autoload
+ "org-indent"
+ '(org-indent-mode)))
;; Autoload archiving code
;; The stuff that is needed for cycling and tags has to be defined here.
:group 'org-agenda-skip
:type 'boolean)
+(defcustom org-columns-skip-arrchived-trees t
+ "Non-nil means, irgnore archived trees when creating column view."
+ :group 'org-archive
+ :group 'org-properties
+ :type 'boolean)
+
(defcustom org-cycle-open-archived-trees nil
"Non-nil means, `org-cycle' will open archived trees.
An archived tree is a tree marked with the tag ARCHIVE.
;; Autoload ID code
(declare-function org-id-store-link "org-id")
+(declare-function org-id-locations-load "org-id")
+(declare-function org-id-locations-save "org-id")
+(defvar org-id-track-globally)
(org-autoload "org-id"
'(org-id-get-create org-id-new org-id-copy org-id-get
org-id-get-with-outline-path-completion
org-id-get-with-outline-drilling
org-id-goto org-id-find org-id-store-link))
+;; Autoload Plotting Code
+
+(org-autoload "org-plot"
+ '(org-plot/gnuplot))
+
;;; Variables for pre-computed regular expressions, all buffer local
(defvar org-drawer-regexp nil
(defvar org-not-done-regexp nil
"Matches any of the TODO state keywords except the last one.")
(make-variable-buffer-local 'org-not-done-regexp)
+(defvar org-not-done-heading-regexp nil
+ "Matches a TODO headline that is not done.")
+(make-variable-buffer-local 'org-not-done-regexp)
(defvar org-todo-line-regexp nil
"Matches a headline and puts TODO state into group 2 if present.")
(make-variable-buffer-local 'org-todo-line-regexp)
("nofold" org-startup-folded nil)
("showall" org-startup-folded nil)
("content" org-startup-folded content)
+ ("indent" org-startup-indented t)
+ ("noindent" org-startup-indented nil)
("hidestars" org-hide-leading-stars t)
("showstars" org-hide-leading-stars nil)
("odd" org-odd-levels-only t)
("fnprompt" org-footnote-auto-label nil)
("fnconfirm" org-footnote-auto-label confirm)
("fnplain" org-footnote-auto-label plain)
+ ("fnadjust" org-footnote-auto-adjust t)
+ ("nofnadjust" org-footnote-auto-adjust nil)
("constcgs" constants-unit-system cgs)
- ("constSI" constants-unit-system SI))
+ ("constSI" constants-unit-system SI)
+ ("noptag" org-tag-persistent-alist nil)
+ ("hideblocks" org-hide-block-startup t)
+ ("nohideblocks" org-hide-block-startup nil))
"Variable associated with STARTUP options for org-mode.
Each element is a list of three items: The startup options as written
in the #+STARTUP line, the corresponding variable, and the value to
(org-set-local 'org-file-properties nil)
(org-set-local 'org-file-tags nil)
(let ((re (org-make-options-regexp
- '("CATEGORY" "SEQ_TODO" "TYP_TODO" "TODO" "COLUMNS"
+ '("CATEGORY" "TODO" "COLUMNS"
"STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
- "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE")))
+ "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE")
+ "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
(splitre "[ \t]+")
kwds kws0 kwsa key log value cat arch tags const links hw dws
tail sep kws1 prio props ftags drawers
(push (cons 'sequence (org-split-string value splitre)) kwds))
((equal key "TYP_TODO")
(push (cons 'type (org-split-string value splitre)) kwds))
+ ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
+ ;; general TODO-like setup
+ (push (cons (intern (downcase (match-string 1 key)))
+ (org-split-string value splitre)) kwds))
((equal key "TAGS")
- (setq tags (append tags (org-split-string value splitre))))
+ (setq tags (append tags (if tags '("\\n") nil)
+ (org-split-string value splitre))))
((equal key "COLUMNS")
(org-set-local 'org-columns-default-format value))
((equal key "LINK")
(org-set-local 'org-lowest-priority (nth 1 prio))
(org-set-local 'org-default-priority (nth 2 prio)))
(and props (org-set-local 'org-file-properties (nreverse props)))
- (and ftags (org-set-local 'org-file-tags ftags))
+ (and ftags (org-set-local 'org-file-tags
+ (mapcar 'org-add-prop-inherited ftags)))
(and drawers (org-set-local 'org-drawers drawers))
(and arch (org-set-local 'org-archive-location arch))
(and links (setq org-link-abbrev-alist-local (nreverse links)))
(setq kwds (nreverse kwds))
(let (inter kws kw)
(while (setq kws (pop kwds))
- (setq inter (pop kws) sep (member "|" kws)
- kws0 (delete "|" (copy-sequence kws))
- kwsa nil
- kws1 (mapcar
- (lambda (x)
- ;; 1 2
- (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
- (progn
- (setq kw (match-string 1 x)
- key (and (match-end 2) (match-string 2 x))
- log (org-extract-log-state-settings x))
- (push (cons kw (and key (string-to-char key))) kwsa)
- (and log (push log org-todo-log-states))
- kw)
- (error "Invalid TODO keyword %s" x)))
- kws0)
- kwsa (if kwsa (append '((:startgroup))
- (nreverse kwsa)
- '((:endgroup))))
- hw (car kws1)
- dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
- tail (list inter hw (car dws) (org-last dws)))
+ (let ((kws (or
+ (run-hook-with-args-until-success
+ 'org-todo-setup-filter-hook kws)
+ kws)))
+ (setq inter (pop kws) sep (member "|" kws)
+ kws0 (delete "|" (copy-sequence kws))
+ kwsa nil
+ kws1 (mapcar
+ (lambda (x)
+ ;; 1 2
+ (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
+ (progn
+ (setq kw (match-string 1 x)
+ key (and (match-end 2) (match-string 2 x))
+ log (org-extract-log-state-settings x))
+ (push (cons kw (and key (string-to-char key))) kwsa)
+ (and log (push log org-todo-log-states))
+ kw)
+ (error "Invalid TODO keyword %s" x)))
+ kws0)
+ kwsa (if kwsa (append '((:startgroup))
+ (nreverse kwsa)
+ '((:endgroup))))
+ hw (car kws1)
+ dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
+ tail (list inter hw (car dws) (org-last dws))))
(add-to-list 'org-todo-heads hw 'append)
(push kws1 org-todo-sets)
(setq org-done-keywords (append org-done-keywords dws nil))
(cond
((equal e "{") (push '(:startgroup) tgs))
((equal e "}") (push '(:endgroup) tgs))
+ ((equal e "\\n") (push '(:newline) tgs))
((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
(push (cons (match-string 1 e)
(string-to-char (match-string 2 e)))
(concat "\\<\\("
(mapconcat 'regexp-quote org-not-done-keywords "\\|")
"\\)\\>")
+ org-not-done-heading-regexp
+ (concat "^\\(\\*+\\)[ \t]+\\("
+ (mapconcat 'regexp-quote org-not-done-keywords "\\|")
+ "\\)\\>")
org-todo-line-regexp
(concat "^\\(\\*+\\)[ \t]+\\(?:\\("
(mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
(cond
((equal e '(:startgroup)) (push e new))
((equal e '(:endgroup)) (push e new))
+ ((equal e '(:newline)) (push e new))
(t
(setq k (car e) c2 nil)
(if (cdr e)
;; FIXME: Occasionally check by commenting these, to make sure
;; no other functions uses these, forgetting to let-bind them.
(defvar entry)
-(defvar state)
(defvar last-state)
(defvar date)
-(defvar description)
;; Defined somewhere in this file, but used before definition.
(defvar org-html-entities)
"Mode hook for Org-mode, run after the mode was turned on.")
(defvar org-inhibit-startup nil) ; Dynamically-scoped param.
(defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
+(defvar org-inhibit-logging nil) ; Dynamically-scoped param.
+(defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
(defvar org-table-buffer-is-an nil)
(defconst org-outline-regexp "\\*+ ")
(org-install-agenda-files-menu)
(if org-descriptive-links (org-add-to-invisibility-spec '(org-link)))
(org-add-to-invisibility-spec '(org-cwidth))
+ (org-add-to-invisibility-spec '(org-hide-block . t))
(when (featurep 'xemacs)
(org-set-local 'line-move-ignore-invisible t))
(org-set-local 'outline-regexp org-outline-regexp)
;; too late :-(
(if org-enforce-todo-dependencies
(add-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings)
+ 'org-block-todo-from-children-or-siblings-or-parent)
(remove-hook 'org-blocker-hook
- 'org-block-todo-from-children-or-siblings))
+ 'org-block-todo-from-children-or-siblings-or-parent))
(if org-enforce-todo-checkbox-dependencies
(add-hook 'org-blocker-hook
'org-block-todo-from-checkboxes)
(let ((bmp (buffer-modified-p)))
(org-table-map-tables 'org-table-align)
(set-buffer-modified-p bmp)))
+ (when org-startup-indented
+ (require 'org-indent)
+ (org-indent-mode 1))
(org-set-startup-visibility)))
(put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
(when org-tab-follows-link
(org-defkey org-mouse-map [(tab)] 'org-open-at-point)
(org-defkey org-mouse-map "\C-i" 'org-open-at-point))
-(when org-return-follows-link
- (org-defkey org-mouse-map [(return)] 'org-open-at-point)
- (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
(require 'font-lock)
(defun org-do-emphasis-faces (limit)
"Run through the buffer and add overlays to links."
- (let (rtn)
+ (let (rtn a)
(while (and (not rtn) (re-search-forward org-emph-re limit t))
(if (not (= (char-after (match-beginning 3))
(char-after (match-beginning 4))))
(progn
(setq rtn t)
+ (setq a (assoc (match-string 3) org-emphasis-alist))
(font-lock-prepend-text-property (match-beginning 2) (match-end 2)
'face
- (nth 1 (assoc (match-string 3)
- org-emphasis-alist)))
+ (nth 1 a))
+ (and (nth 4 a)
+ (org-remove-flyspell-overlays-in
+ (match-beginning 0) (match-end 0)))
(add-text-properties (match-beginning 2) (match-end 2)
'(font-lock-multiline t))
(when org-hide-emphasis-markers
(defconst org-nonsticky-props
'(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
+(defsubst org-rear-nonsticky-at (pos)
+ (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
(defun org-activate-plain-links (limit)
"Run through the buffer and add overlays to links."
(catch 'exit
(let (f)
- (while (re-search-forward org-plain-link-re limit t)
- (setq f (get-text-property (match-beginning 0) 'face))
- (if (or (eq f 'org-tag)
- (and (listp f) (memq 'org-tag f)))
- nil
- (add-text-properties (match-beginning 0) (match-end 0)
- (list 'mouse-face 'highlight
- 'rear-nonsticky org-nonsticky-props
- 'keymap org-mouse-map
- ))
- (throw 'exit t))))))
+ (if (re-search-forward org-plain-link-re limit t)
+ (progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
+ (setq f (get-text-property (match-beginning 0) 'face))
+ (if (or (eq f 'org-tag)
+ (and (listp f) (memq 'org-tag f)))
+ nil
+ (add-text-properties (match-beginning 0) (match-end 0)
+ (list 'mouse-face 'highlight
+ 'keymap org-mouse-map))
+ (org-rear-nonsticky-at (match-end 0)))
+ t)))))
(defun org-activate-code (limit)
(if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
(progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(remove-text-properties (match-beginning 0) (match-end 0)
'(display t invisible t intangible t))
t)))
+(defun org-fontify-meta-lines-and-blocks (limit)
+ "Fontify #+ lines and blocks, in the correct ways."
+ (let ((case-fold-search t))
+ (if (re-search-forward
+ "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\)\\(_\\([a-zA-Z]+\\)\\)?\\)\\(.*\\)\\)"
+ limit t)
+ (let ((beg (match-beginning 0))
+ (beg1 (line-beginning-position 2))
+ (dc1 (downcase (match-string 2)))
+ (dc3 (downcase (match-string 3)))
+ end end1 quoting)
+ (cond
+ ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
+ ;; a single line of backend-specific content
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
+ (remove-text-properties (match-beginning 0) (match-end 0)
+ '(display t invisible t intangible t))
+ (add-text-properties (match-beginning 1) (match-end 3)
+ '(font-lock-fontified t face org-meta-line))
+ (add-text-properties (match-beginning 6) (match-end 6)
+ '(font-lock-fontified t face org-block))
+ t)
+ ((and (match-end 4) (equal dc3 "begin"))
+ ;; Truely a block
+ (setq quoting (member (downcase (match-string 5))
+ org-protecting-blocks))
+ (when (re-search-forward
+ (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
+ nil t) ;; on purpose, we look further than LIMIT
+ (setq end (match-end 0) end1 (1- (match-beginning 0)))
+ (when quoting
+ (remove-text-properties beg end
+ '(display t invisible t intangible t)))
+ (add-text-properties
+ beg end
+ '(font-lock-fontified t font-lock-multiline t))
+ (add-text-properties beg beg1 '(face org-meta-line))
+ (add-text-properties end1 end '(face org-meta-line))
+ (when quoting
+ (add-text-properties beg1 end1 '(face org-block)))
+ t))
+ ((not (member (char-after beg) '(?\ ?\t)))
+ ;; just any other in-buffer setting, but not indented
+ (add-text-properties
+ beg (match-end 0)
+ '(font-lock-fontified t face org-meta-line))
+ t)
+ ((or (member dc1 '("caption:" "label:" "orgtbl:" "tblfm:" "tblname:"))
+ (and (match-end 4) (equal dc3 "attr")))
+ (add-text-properties
+ beg (match-end 0)
+ '(font-lock-fontified t face org-meta-line))
+ t)
+ (t nil))))))
+
(defun org-activate-angle-links (limit)
"Run through the buffer and add overlays to links."
(if (re-search-forward org-angle-link-re limit t)
(progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(add-text-properties (match-beginning 0) (match-end 0)
(list 'mouse-face 'highlight
- 'rear-nonsticky org-nonsticky-props
- 'keymap org-mouse-map
- ))
+ 'keymap org-mouse-map))
+ (org-rear-nonsticky-at (match-end 0))
t)))
(defun org-activate-footnote-links (limit)
"Run through the buffer and add overlays to links."
- (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
+ (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
limit t)
(progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(add-text-properties (match-beginning 2) (match-end 2)
(list 'mouse-face 'highlight
- 'rear-nonsticky org-nonsticky-props
'keymap org-mouse-map
'help-echo
(if (= (point-at-bol) (match-beginning 2))
"Footnote definition"
"Footnote reference")
))
+ (org-rear-nonsticky-at (match-end 2))
t)))
(defun org-activate-bracket-links (limit)
;; but that requires another match, protecting match data,
;; a lot of overhead for font-lock.
(ip (org-maybe-intangible
- (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
+ (list 'invisible 'org-link
'keymap org-mouse-map 'mouse-face 'highlight
'font-lock-multiline t 'help-echo help)))
- (vp (list 'rear-nonsticky org-nonsticky-props
- 'keymap org-mouse-map 'mouse-face 'highlight
- ' font-lock-multiline t 'help-echo help)))
+ (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
+ 'font-lock-multiline t 'help-echo help)))
;; We need to remove the invisible property here. Table narrowing
;; may have made some of this invisible.
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(remove-text-properties (match-beginning 0) (match-end 0)
'(invisible nil))
(if (match-end 3)
(progn
(add-text-properties (match-beginning 0) (match-beginning 3) ip)
+ (org-rear-nonsticky-at (match-beginning 3))
(add-text-properties (match-beginning 3) (match-end 3) vp)
- (add-text-properties (match-end 3) (match-end 0) ip))
+ (org-rear-nonsticky-at (match-end 3))
+ (add-text-properties (match-end 3) (match-end 0) ip)
+ (org-rear-nonsticky-at (match-end 0)))
(add-text-properties (match-beginning 0) (match-beginning 1) ip)
+ (org-rear-nonsticky-at (match-beginning 1))
(add-text-properties (match-beginning 1) (match-end 1) vp)
- (add-text-properties (match-end 1) (match-end 0) ip))
+ (org-rear-nonsticky-at (match-end 1))
+ (add-text-properties (match-end 1) (match-end 0) ip)
+ (org-rear-nonsticky-at (match-end 0)))
t)))
(defun org-activate-dates (limit)
"Run through the buffer and add overlays to dates."
(if (re-search-forward org-tsr-regexp-both limit t)
(progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(add-text-properties (match-beginning 0) (match-end 0)
(list 'mouse-face 'highlight
- 'rear-nonsticky org-nonsticky-props
'keymap org-mouse-map))
+ (org-rear-nonsticky-at (match-end 0))
(when org-display-custom-times
(if (match-end 3)
(org-display-custom-time (match-beginning 3) (match-end 3)))
(let ((case-fold-search t))
(if (re-search-forward org-target-link-regexp limit t)
(progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(add-text-properties (match-beginning 0) (match-end 0)
(list 'mouse-face 'highlight
- 'rear-nonsticky org-nonsticky-props
'keymap org-mouse-map
'help-echo "Radio target link"
'org-linked-text t))
+ (org-rear-nonsticky-at (match-end 0))
t)))))
(defun org-update-radio-target-regexp ()
(regexp-opt
(append (mapcar 'car org-html-entities)
(if (boundp 'org-latex-entities)
- org-latex-entities nil))
+ (mapcar (lambda (x)
+ (or (car-safe x) x))
+ org-latex-entities)
+ nil))
'words))) ; FIXME
))
;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
(defun org-activate-tags (limit)
(if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
(progn
+ (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
(add-text-properties (match-beginning 1) (match-end 1)
(list 'mouse-face 'highlight
- 'rear-nonsticky org-nonsticky-props
'keymap org-mouse-map))
+ (org-rear-nonsticky-at (match-end 1))
t)))
(defun org-outline-level ()
;; Call the hook
'(org-font-lock-hook)
;; Headlines
- '("^\\(\\**\\)\\(\\* \\)\\(.*\\)" (1 (org-get-level-face 1))
- (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
+ `(,(if org-fontify-whole-heading-line
+ "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
+ "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
+ (1 (org-get-level-face 1))
+ (2 (org-get-level-face 2))
+ (3 (org-get-level-face 3)))
;; Table lines
'("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
(1 'org-table t))
'("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
'("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
'("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
+ '("| *\\(<[lr]?[0-9]*>\\)" (1 'org-formula t))
;; Drawers
(list org-drawer-regexp '(0 'org-special-keyword t))
(list "^[ \t]*:END:" '(0 'org-special-keyword t))
(list org-property-re
'(1 'org-special-keyword t)
'(3 'org-property-value t))
- (if org-format-transports-properties-p
- '("| *\\(<[0-9]+>\\) *" (1 'org-formula t)))
;; Links
(if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
(if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
'("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
'(org-hide-wide-columns (0 nil append))
;; TODO lines
- (list (concat "^\\*+[ \t]+" org-todo-regexp)
+ (list (concat "^\\*+[ \t]+" org-todo-regexp "\\([ \t]\\|$\\)")
'(1 (org-get-todo-face 1) t))
;; DONE
(if org-fontify-done-headline
'(2 'org-headline-done t))
nil)
;; Priorities
- (list (concat "\\[#[A-Z0-9]\\]") '(0 'org-special-keyword t))
+ '(org-font-lock-add-priority-faces)
;; Tags
'(org-font-lock-add-tag-faces)
;; Special keywords
'(org-do-emphasis-faces)))
;; Checkboxes
'("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
- 2 'bold prepend)
+ 2 'org-checkbox prepend)
(if org-provide-checkbox-statistics
'("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
(0 (org-get-checkbox-statistics-face) t)))
;; Description list items
'("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
2 'bold prepend)
+ ;; ARCHIVEd headings
(list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
'(1 'org-archived prepend))
;; Specials
"\\|" org-quote-string "\\)\\>")
'(1 'org-special-keyword t))
'("^#.*" (0 'font-lock-comment-face t))
+ ;; Blocks and meta lines
+ '(org-fontify-meta-lines-and-blocks)
)))
(setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
;; Now set the full font-lock-keywords
'(org-font-lock-keywords t nil nil backward-paragraph))
(kill-local-variable 'font-lock-keywords) nil))
+(defun org-fontify-like-in-org-mode (s &optional odd-levels)
+ "Fontify string S like in Org-mode"
+ (with-temp-buffer
+ (insert s)
+ (let ((org-odd-levels-only odd-levels))
+ (org-mode)
+ (font-lock-fontify-buffer)
+ (buffer-string))))
+
(defvar org-m nil)
(defvar org-l nil)
(defvar org-f nil)
'font-lock-fontified t))
(backward-char 1))))
+(defun org-font-lock-add-priority-faces (limit)
+ "Add the special priority faces."
+ (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
+ (add-text-properties
+ (match-beginning 0) (match-end 0)
+ (list 'face (or (cdr (assoc (char-after (match-beginning 1))
+ org-priority-faces))
+ 'org-special-keyword)
+ 'font-lock-fontified t))))
+
(defun org-get-tag-face (kwd)
"Get the right face for a TODO keyword KWD.
If KWD is a number, get the corresponding match group."
deactivate-mark buffer-file-name buffer-file-truename)
(remove-text-properties beg end
'(mouse-face t keymap t org-linked-text t
- invisible t intangible t))))
+ invisible t intangible t
+ line-prefix t wrap-prefix t
+ org-no-flyspell t))))
;;;; Visibility cycling, including org-goto and indirect buffer
(make-variable-buffer-local 'org-cycle-subtree-status)
;;;###autoload
+
+(defvar org-inlinetask-min-level)
+
(defun org-cycle (&optional arg)
- "Visibility cycling for Org-mode.
+ "TAB-action and visibility cycling for Org-mode.
+
+This is the command invoked in Org-moe by the TAB key. It's main purpose
+is outine visibility cycling, but it also invokes other actions
+in special contexts.
- When this function is called with a prefix argument, rotate the entire
buffer through 3 states (global cycling)
1. OVERVIEW: Show only top-level headlines.
2. CONTENTS: Show all headlines of all levels, but no body text.
3. SHOW ALL: Show everything.
- When called with two C-u C-u prefixes, switch to the startup visibility,
+ When called with two `C-u C-u' prefixes, switch to the startup visibility,
determined by the variable `org-startup-folded', and by any VISIBILITY
properties in the buffer.
- When called with three C-u C-u C-u prefixed, show the entire buffer,
- including drawers.
+ When called with three `C-u C-u C-u' prefixed, show the entire buffer,
+ including any drawers.
+
+- When inside a table, re-align the table and move to the next field.
- When point is at the beginning of a headline, rotate the subtree started
by this line through 3 different states (local cycling)
From this state, you can move to one of the children
and zoom in further.
3. SUBTREE: Show the entire subtree, including body text.
+ If there is no subtree, switch directly from CHILDREN to FOLDED.
- When there is a numeric prefix, go up to a heading with level ARG, do
a `show-subtree' and return to the previous cursor position. If ARG
But only if also the variable `org-cycle-global-at-bob' is t."
(interactive "P")
(org-load-modules-maybe)
- (let* ((outline-regexp
- (if (and (org-mode-p) org-cycle-include-plain-lists)
- "\\(?:\\*+ \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"
- outline-regexp))
- (bob-special (and org-cycle-global-at-bob (bobp)
- (not (looking-at outline-regexp))))
- (org-cycle-hook
- (if bob-special
- (delq 'org-optimize-window-after-visibility-change
- (copy-sequence org-cycle-hook))
- org-cycle-hook))
- (pos (point)))
-
- (if (or bob-special (equal arg '(4)))
- ;; special case: use global cycling
- (setq arg t))
-
- (cond
+ (unless (run-hook-with-args-until-success 'org-tab-first-hook)
+ (let* ((limit-level
+ (or org-cycle-max-level
+ (and (boundp 'org-inlinetask-min-level)
+ org-inlinetask-min-level
+ (1- org-inlinetask-min-level))))
+ (nstars (and limit-level
+ (if org-odd-levels-only
+ (and limit-level (1- (* limit-level 2)))
+ limit-level)))
+ (outline-regexp
+ (cond
+ ((not (org-mode-p)) outline-regexp)
+ ((or (eq org-cycle-include-plain-lists 'integrate)
+ (and org-cycle-include-plain-lists (org-at-item-p)))
+ (concat "\\(?:\\*"
+ (if nstars (format "\\{1,%d\\}" nstars) "+")
+ " \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"))
+ (t (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))))
+ (bob-special (and org-cycle-global-at-bob (bobp)
+ (not (looking-at outline-regexp))))
+ (org-cycle-hook
+ (if bob-special
+ (delq 'org-optimize-window-after-visibility-change
+ (copy-sequence org-cycle-hook))
+ org-cycle-hook))
+ (pos (point)))
+
+ (if (or bob-special (equal arg '(4)))
+ ;; special case: use global cycling
+ (setq arg t))
- ((equal arg '(16))
- (org-set-startup-visibility)
- (message "Startup visibility, plus VISIBILITY properties"))
+ (cond
- ((equal arg '(64))
- (show-all)
- (message "Entire buffer visible, including drawers"))
+ ((equal arg '(16))
+ (org-set-startup-visibility)
+ (message "Startup visibility, plus VISIBILITY properties"))
- ((org-at-table-p 'any)
- ;; Enter the table or move to the next field in the table
- (or (org-table-recognize-table.el)
- (progn
- (if arg (org-table-edit-field t)
- (org-table-justify-field-maybe)
- (call-interactively 'org-table-next-field)))))
+ ((equal arg '(64))
+ (show-all)
+ (message "Entire buffer visible, including drawers"))
- ((eq arg t) ;; Global cycling
+ ((org-at-table-p 'any)
+ ;; Enter the table or move to the next field in the table
+ (or (org-table-recognize-table.el)
+ (progn
+ (if arg (org-table-edit-field t)
+ (org-table-justify-field-maybe)
+ (call-interactively 'org-table-next-field)))))
+
+ ((run-hook-with-args-until-success
+ 'org-tab-after-check-for-table-hook))
+
+ ((eq arg t) ;; Global cycling
+ (org-cycle-internal-global))
+
+ ((and org-drawers org-drawer-regexp
+ (save-excursion
+ (beginning-of-line 1)
+ (looking-at org-drawer-regexp)))
+ ;; Toggle block visibility
+ (org-flag-drawer
+ (not (get-char-property (match-end 0) 'invisible))))
+
+ ((integerp arg)
+ ;; Show-subtree, ARG levels up from here.
+ (save-excursion
+ (org-back-to-heading)
+ (outline-up-heading (if (< arg 0) (- arg)
+ (- (funcall outline-level) arg)))
+ (org-show-subtree)))
- (cond
- ((and (eq last-command this-command)
- (eq org-cycle-global-status 'overview))
- ;; We just created the overview - now do table of contents
- ;; This can be slow in very large buffers, so indicate action
- (message "CONTENTS...")
- (org-content)
- (message "CONTENTS...done")
- (setq org-cycle-global-status 'contents)
- (run-hook-with-args 'org-cycle-hook 'contents))
-
- ((and (eq last-command this-command)
- (eq org-cycle-global-status 'contents))
- ;; We just showed the table of contents - now show everything
- (show-all)
- (message "SHOW ALL")
- (setq org-cycle-global-status 'all)
- (run-hook-with-args 'org-cycle-hook 'all))
+ ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
+ (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
- (t
- ;; Default action: go to overview
- (org-overview)
- (message "OVERVIEW")
- (setq org-cycle-global-status 'overview)
- (run-hook-with-args 'org-cycle-hook 'overview))))
+ (org-cycle-internal-local))
- ((and org-drawers org-drawer-regexp
- (save-excursion
- (beginning-of-line 1)
- (looking-at org-drawer-regexp)))
- ;; Toggle block visibility
- (org-flag-drawer
- (not (get-char-property (match-end 0) 'invisible))))
+ ;; TAB emulation and template completion
+ (buffer-read-only (org-back-to-heading))
- ((integerp arg)
- ;; Show-subtree, ARG levels up from here.
- (save-excursion
- (org-back-to-heading)
- (outline-up-heading (if (< arg 0) (- arg)
- (- (funcall outline-level) arg)))
- (org-show-subtree)))
+ ((run-hook-with-args-until-success
+ 'org-tab-after-check-for-cycling-hook))
- ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
- (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
- ;; At a heading: rotate between three different views
- (org-back-to-heading)
- (let ((goal-column 0) eoh eol eos)
- ;; First, some boundaries
- (save-excursion
- (org-back-to-heading)
- (save-excursion
- (beginning-of-line 2)
- (while (and (not (eobp)) ;; this is like `next-line'
- (get-char-property (1- (point)) 'invisible))
- (beginning-of-line 2)) (setq eol (point)))
- (outline-end-of-heading) (setq eoh (point))
- (org-end-of-subtree t)
- (unless (eobp)
- (skip-chars-forward " \t\n")
- (beginning-of-line 1) ; in case this is an item
- )
- (setq eos (1- (point))))
- ;; Find out what to do next and set `this-command'
- (cond
- ((= eos eoh)
- ;; Nothing is hidden behind this heading
- (message "EMPTY ENTRY")
- (setq org-cycle-subtree-status nil)
- (save-excursion
- (goto-char eos)
- (outline-next-heading)
- (if (org-invisible-p) (org-flag-heading nil))))
- ((or (>= eol eos)
- (not (string-match "\\S-" (buffer-substring eol eos))))
- ;; Entire subtree is hidden in one line: open it
- (org-show-entry)
- (show-children)
- (message "CHILDREN")
- (save-excursion
- (goto-char eos)
- (outline-next-heading)
- (if (org-invisible-p) (org-flag-heading nil)))
- (setq org-cycle-subtree-status 'children)
- (run-hook-with-args 'org-cycle-hook 'children))
- ((and (eq last-command this-command)
- (eq org-cycle-subtree-status 'children))
- ;; We just showed the children, now show everything.
- (org-show-subtree)
- (message "SUBTREE")
- (setq org-cycle-subtree-status 'subtree)
- (run-hook-with-args 'org-cycle-hook 'subtree))
- (t
- ;; Default action: hide the subtree.
- (hide-subtree)
- (message "FOLDED")
- (setq org-cycle-subtree-status 'folded)
- (run-hook-with-args 'org-cycle-hook 'folded)))))
+ ((org-try-structure-completion))
- ;; TAB emulation and template completion
- (buffer-read-only (org-back-to-heading))
+ ((org-try-cdlatex-tab))
- ((org-try-structure-completion))
+ ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
+ (or (not (bolp))
+ (not (looking-at outline-regexp))))
+ (call-interactively (global-key-binding "\t")))
- ((org-try-cdlatex-tab))
+ ((if (and (memq org-cycle-emulate-tab '(white whitestart))
+ (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
+ (or (and (eq org-cycle-emulate-tab 'white)
+ (= (match-end 0) (point-at-eol)))
+ (and (eq org-cycle-emulate-tab 'whitestart)
+ (>= (match-end 0) pos))))
+ t
+ (eq org-cycle-emulate-tab t))
+ (call-interactively (global-key-binding "\t")))
- ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
- (or (not (bolp))
- (not (looking-at outline-regexp))))
- (call-interactively (global-key-binding "\t")))
+ (t (save-excursion
+ (org-back-to-heading)
+ (org-cycle)))))))
- ((if (and (memq org-cycle-emulate-tab '(white whitestart))
- (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
- (or (and (eq org-cycle-emulate-tab 'white)
- (= (match-end 0) (point-at-eol)))
- (and (eq org-cycle-emulate-tab 'whitestart)
- (>= (match-end 0) pos))))
- t
- (eq org-cycle-emulate-tab t))
- (call-interactively (global-key-binding "\t")))
+(defun org-cycle-internal-global ()
+ "Do the global cycling action."
+ (cond
+ ((and (eq last-command this-command)
+ (eq org-cycle-global-status 'overview))
+ ;; We just created the overview - now do table of contents
+ ;; This can be slow in very large buffers, so indicate action
+ (run-hook-with-args 'org-pre-cycle-hook 'contents)
+ (message "CONTENTS...")
+ (org-content)
+ (message "CONTENTS...done")
+ (setq org-cycle-global-status 'contents)
+ (run-hook-with-args 'org-cycle-hook 'contents))
+
+ ((and (eq last-command this-command)
+ (eq org-cycle-global-status 'contents))
+ ;; We just showed the table of contents - now show everything
+ (run-hook-with-args 'org-pre-cycle-hook 'all)
+ (show-all)
+ (message "SHOW ALL")
+ (setq org-cycle-global-status 'all)
+ (run-hook-with-args 'org-cycle-hook 'all))
- (t (save-excursion
- (org-back-to-heading)
- (org-cycle))))))
+ (t
+ ;; Default action: go to overview
+ (run-hook-with-args 'org-pre-cycle-hook 'overview)
+ (org-overview)
+ (message "OVERVIEW")
+ (setq org-cycle-global-status 'overview)
+ (run-hook-with-args 'org-cycle-hook 'overview))))
+
+(defun org-cycle-internal-local ()
+ "Do the local cycling action."
+ (org-back-to-heading)
+ (let ((goal-column 0) eoh eol eos level has-children children-skipped)
+ ;; First, some boundaries
+ (save-excursion
+ (org-back-to-heading)
+ (setq level (funcall outline-level))
+ (save-excursion
+ (beginning-of-line 2)
+ (if (or (featurep 'xemacs) (<= emacs-major-version 21))
+ ; XEmacs does not have `next-single-char-property-change'
+ ; I'm not sure about Emacs 21.
+ (while (and (not (eobp)) ;; this is like `next-line'
+ (get-char-property (1- (point)) 'invisible))
+ (beginning-of-line 2))
+ (while (and (not (eobp)) ;; this is like `next-line'
+ (get-char-property (1- (point)) 'invisible))
+ (goto-char (next-single-char-property-change (point) 'invisible))
+;;;??? (or (bolp) (beginning-of-line 2))))
+ (and (eolp) (beginning-of-line 2))))
+ (setq eol (point)))
+ (outline-end-of-heading) (setq eoh (point))
+ (save-excursion
+ (outline-next-heading)
+ (setq has-children (and (org-at-heading-p t)
+ (> (funcall outline-level) level))))
+ (org-end-of-subtree t)
+ (unless (eobp)
+ (skip-chars-forward " \t\n")
+ (beginning-of-line 1) ; in case this is an item
+ )
+ (setq eos (1- (point))))
+ ;; Find out what to do next and set `this-command'
+ (cond
+ ((= eos eoh)
+ ;; Nothing is hidden behind this heading
+ (run-hook-with-args 'org-pre-cycle-hook 'empty)
+ (message "EMPTY ENTRY")
+ (setq org-cycle-subtree-status nil)
+ (save-excursion
+ (goto-char eos)
+ (outline-next-heading)
+ (if (org-invisible-p) (org-flag-heading nil))))
+ ((and (or (>= eol eos)
+ (not (string-match "\\S-" (buffer-substring eol eos))))
+ (or has-children
+ (not (setq children-skipped
+ org-cycle-skip-children-state-if-no-children))))
+ ;; Entire subtree is hidden in one line: children view
+ (run-hook-with-args 'org-pre-cycle-hook 'children)
+ (org-show-entry)
+ (show-children)
+ (message "CHILDREN")
+ (save-excursion
+ (goto-char eos)
+ (outline-next-heading)
+ (if (org-invisible-p) (org-flag-heading nil)))
+ (setq org-cycle-subtree-status 'children)
+ (run-hook-with-args 'org-cycle-hook 'children))
+ ((or children-skipped
+ (and (eq last-command this-command)
+ (eq org-cycle-subtree-status 'children)))
+ ;; We just showed the children, or no children are there,
+ ;; now show everything.
+ (run-hook-with-args 'org-pre-cycle-hook 'subtree)
+ (org-show-subtree)
+ (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
+ (setq org-cycle-subtree-status 'subtree)
+ (run-hook-with-args 'org-cycle-hook 'subtree))
+ (t
+ ;; Default action: hide the subtree.
+ (run-hook-with-args 'org-pre-cycle-hook 'folded)
+ (hide-subtree)
+ (message "FOLDED")
+ (setq org-cycle-subtree-status 'folded)
+ (run-hook-with-args 'org-cycle-hook 'folded)))))
;;;###autoload
(defun org-global-cycle (&optional arg)
((eq org-startup-folded 'content)
(let ((this-command 'org-cycle) (last-command 'org-cycle))
(org-cycle '(4)) (org-cycle '(4)))))
+ (if org-hide-block-startup (org-hide-block-all))
(org-set-visibility-according-to-property 'no-cleanup)
(org-cycle-hide-archived-subtrees 'all)
(org-cycle-hide-drawers 'all)
This function is the default value of the hook `org-cycle-hook'."
(when (get-buffer-window (current-buffer))
(cond
-; ((eq state 'overview) (org-first-headline-recenter 1))
-; ((eq state 'overview) (org-beginning-of-line))
((eq state 'content) nil)
((eq state 'all) nil)
((eq state 'folded) nil)
((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
+;; FIXME: no longer in use
(defun org-compact-display-after-subtree-move ()
"Show a compacter version of the tree of the entry's parent."
(save-excursion
(org-cycle-hide-drawers 'children))
(org-overview))))
+(defun org-remove-empty-overlays-at (pos)
+ "Remove outline overlays that do not contain non-white stuff."
+ (mapc
+ (lambda (o)
+ (and (eq 'outline (org-overlay-get o 'invisible))
+ (not (string-match "\\S-" (buffer-substring (org-overlay-start o)
+ (org-overlay-end o))))
+ (org-delete-overlay o)))
+ (org-overlays-at pos)))
+
+(defun org-clean-visibility-after-subtree-move ()
+ "Fix visibility issues after moving a subtree."
+ ;; First, find a reasonable region to look at:
+ ;; Start two siblings above, end three below
+ (let* ((beg (save-excursion
+ (and (outline-get-last-sibling)
+ (outline-get-last-sibling))
+ (point)))
+ (end (save-excursion
+ (and (outline-get-next-sibling)
+ (outline-get-next-sibling)
+ (outline-get-next-sibling))
+ (if (org-at-heading-p)
+ (point-at-eol)
+ (point))))
+ (level (looking-at "\\*+"))
+ (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
+ (save-excursion
+ (save-restriction
+ (narrow-to-region beg end)
+ (when re
+ ;; Properly fold already folded siblings
+ (goto-char (point-min))
+ (while (re-search-forward re nil t)
+ (if (save-excursion (goto-char (point-at-eol)) (org-invisible-p))
+ (hide-entry))))
+ (org-cycle-show-empty-lines 'overview)
+ (org-cycle-hide-drawers 'overview)))))
+
(defun org-cycle-show-empty-lines (state)
"Show empty lines above all visible headlines.
The region to be covered depends on STATE when called through
(defun org-cycle-hide-drawers (state)
"Re-hide all drawers after a visibility state change."
(when (and (org-mode-p)
- (not (memq state '(overview folded))))
+ (not (memq state '(overview folded contents))))
(save-excursion
(let* ((globalp (memq state '(contents all)))
(beg (if globalp (point-min) (point)))
- (end (if globalp (point-max) (org-end-of-subtree t))))
+ (end (if globalp (point-max)
+ (if (eq state 'children)
+ (save-excursion (outline-next-heading) (point))
+ (org-end-of-subtree t)))))
(goto-char beg)
(while (re-search-forward org-drawer-regexp end t)
(org-flag-drawer t))))))
(beginning-of-line)
(recenter (prefix-numeric-value N))))
+;;; Folding of blocks
+
+(defconst org-block-regexp
+
+ "^[ \t]*#\\+begin_\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_\\1[ \t]*$"
+ "Regular expression for hiding blocks.")
+
+(defvar org-hide-block-overlays nil
+ "Overays hiding blocks.")
+(make-variable-buffer-local 'org-hide-block-overlays)
+
+(defun org-block-map (function &optional start end)
+ "Call func at the head of all source blocks in the current
+buffer. Optional arguments START and END can be used to limit
+the range."
+ (let ((start (or start (point-min)))
+ (end (or end (point-max))))
+ (save-excursion
+ (goto-char start)
+ (while (and (< (point) end) (re-search-forward org-block-regexp end t))
+ (save-excursion
+ (save-match-data
+ (goto-char (match-beginning 0))
+ (funcall function)))))))
+
+(defun org-hide-block-toggle-all ()
+ "Toggle the visibility of all blocks in the current buffer."
+ (org-block-map #'org-hide-block-toggle))
+
+(defun org-hide-block-all ()
+ "Fold all blocks in the current buffer."
+ (interactive)
+ (org-show-block-all)
+ (org-block-map #'org-hide-block-toggle-maybe))
+
+(defun org-show-block-all ()
+ "Unfold all blocks in the current buffer."
+ (mapc 'org-delete-overlay org-hide-block-overlays)
+ (setq org-hide-block-overlays nil))
+
+(defun org-hide-block-toggle-maybe ()
+ "Toggle visibility of block at point."
+ (interactive)
+ (let ((case-fold-search t))
+ (if (save-excursion
+ (beginning-of-line 1)
+ (looking-at org-block-regexp))
+ (progn (org-hide-block-toggle)
+ t) ;; to signal that we took action
+ nil))) ;; to signal that we did not
+
+(defun org-hide-block-toggle (&optional force)
+ "Toggle the visibility of the current block."
+ (interactive)
+ (save-excursion
+ (beginning-of-line)
+ (if (re-search-forward org-block-regexp nil t)
+ (let ((start (- (match-beginning 4) 1)) ;; beginning of body
+ (end (match-end 0))
+ ov) ;; end of entire body
+ (if (memq t (mapcar (lambda (overlay)
+ (eq (org-overlay-get overlay 'invisible)
+ 'org-hide-block))
+ (org-overlays-at start)))
+ (if (or (not force) (eq force 'off))
+ (mapc (lambda (ov)
+ (when (member ov org-hide-block-overlays)
+ (setq org-hide-block-overlays
+ (delq ov org-hide-block-overlays)))
+ (when (eq (org-overlay-get ov 'invisible)
+ 'org-hide-block)
+ (org-delete-overlay ov)))
+ (org-overlays-at start)))
+ (setq ov (org-make-overlay start end))
+ (org-overlay-put ov 'invisible 'org-hide-block)
+ (push ov org-hide-block-overlays)))
+ (error "Not looking at a source block"))))
+
+;; org-tab-after-check-for-cycling-hook
+(add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
+;; Remove overlays when changing major mode
+(add-hook 'org-mode-hook
+ (lambda () (org-add-hook 'change-major-mode-hook
+ 'org-show-block-all 'append 'local)))
+
;;; Org-goto
(defvar org-goto-window-configuration nil)
(interactive "P")
(let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
(org-refile-use-outline-path t)
+ (org-refile-target-verify-function nil)
(interface
(if (not alternative-interface)
org-goto-interface
(or (beginning-of-line 0) t)
(save-match-data
(looking-at "[ \t]*$")))))
-
+
(defun org-insert-heading (&optional force-heading)
"Insert a new heading or item with same depth at point.
If point is in a plain list and FORCE-HEADING is nil, create a new list item.
(org-match-string-no-properties 4)
(org-match-string-no-properties 5)))))
+(defun org-get-entry ()
+ "Get the entry text, after heading, entire subtree."
+ (save-excursion
+ (org-back-to-heading t)
+ (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
+
(defun org-insert-heading-after-current ()
"Insert a new heading with same level as current, after current subtree."
(interactive)
(org-back-to-heading)
(outline-previous-heading)
(looking-at org-todo-line-regexp))
- (if (or arg
- (not (match-beginning 2))
- (member (match-string 2) org-done-keywords))
- (insert (car org-todo-keywords-1) " ")
- (insert (match-string 2) " "))
+ (let*
+ ((new-mark-x
+ (if (or arg
+ (not (match-beginning 2))
+ (member (match-string 2) org-done-keywords))
+ (car org-todo-keywords-1)
+ (match-string 2)))
+ (new-mark
+ (or
+ (run-hook-with-args-until-success
+ 'org-todo-get-default-hook new-mark-x nil)
+ new-mark-x)))
+ (beginning-of-line 1)
+ (and (looking-at "\\*+ ") (goto-char (match-end 0))
+ (if org-treat-insert-todo-heading-as-state-change
+ (org-todo new-mark)
+ (insert new-mark " "))))
(when org-provide-todo-statistics
(org-update-parent-todo-statistics))))
;;; Promotion and Demotion
+(defvar org-after-demote-entry-hook nil
+ "Hook run after an entry has been demoted.
+The cursor will be at the beginning of the entry.
+When a subtree is being demoted, the hook will be called for each node.")
+
+(defvar org-after-promote-entry-hook nil
+ "Hook run after an entry has been promoted.
+The cursor will be at the beginning of the entry.
+When a subtree is being promoted, the hook will be called for each node.")
+
(defun org-promote-subtree ()
"Promote the entire subtree.
See also `org-promote'."
(cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
- (max 1 (+ level change))))
+ (max 1 (+ level (or change 0)))))
(if (boundp 'define-obsolete-function-alias)
(if (or (featurep 'xemacs) (< emacs-major-version 23))
(replace-match up-head nil t)
;; Fixup tag positioning
(and org-auto-align-tags (org-set-tags nil t))
- (if org-adapt-indentation (org-fixup-indentation (- diff)))))
+ (if org-adapt-indentation (org-fixup-indentation (- diff)))
+ (run-hooks 'org-after-promote-entry-hook)))
(defun org-demote ()
"Demote the current heading lower down the tree.
(replace-match down-head nil t)
;; Fixup tag positioning
(and org-auto-align-tags (org-set-tags nil t))
- (if org-adapt-indentation (org-fixup-indentation diff))))
+ (if org-adapt-indentation (org-fixup-indentation diff))
+ (run-hooks 'org-after-demote-entry-hook)))
(defun org-map-tree (fun)
"Call FUN for every heading underneath the current one."
(setq txt (buffer-substring beg end))
(org-save-markers-in-region beg end)
(delete-region beg end)
+ (org-remove-empty-overlays-at beg)
(or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
(or (bobp) (outline-flag-region (1- (point)) (point) nil))
+ (and (not (bolp)) (looking-at "\n") (forward-char 1))
(let ((bbb (point)))
(insert-before-markers txt)
(org-reinstall-markers-in-region bbb)
(kill-line (- ne-ins ne-beg)) (point)))
(insert (make-string (- ne-ins ne-beg) ?\n)))
(move-marker ins-point nil)
- (org-compact-display-after-subtree-move)
- (org-show-empty-lines-in-parent)
- (unless folded
+ (if folded
+ (hide-subtree)
(org-show-entry)
(show-children)
- (org-cycle-hide-drawers 'children))))
+ (org-cycle-hide-drawers 'children))
+ (org-clean-visibility-after-subtree-move)))
(defvar org-subtree-clip ""
"Clipboard for cut and paste of subtrees.
(save-excursion (outline-end-of-heading)
(setq folded (org-invisible-p)))
(condition-case nil
- (outline-forward-same-level (1- n))
+ (org-forward-same-level (1- n) t)
(error nil))
(org-end-of-subtree t t))
(org-back-over-empty-lines)
move back over whitespace before inserting, and move point to the end of
the inserted text when done."
(interactive "P")
+ (setq tree (or tree (and kill-ring (current-kill 0))))
(unless (org-kill-is-subtree-p tree)
(error "%s"
(substitute-command-keys
"The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
(let* ((visp (not (org-invisible-p)))
- (txt (or tree (and kill-ring (current-kill 0))))
+ (txt tree)
(^re (concat "^\\(" outline-regexp "\\)"))
(re (concat "\\(" outline-regexp "\\)"))
(^re_ (concat "\\(\\*+\\)[ \t]*"))
(save-excursion
(save-match-data
(narrow-to-region
- (progn (org-back-to-heading) (point))
+ (progn (org-back-to-heading t) (point))
(progn (org-end-of-subtree t) (point))))))
+(defun org-clone-subtree-with-time-shift (n &optional shift)
+ "Clone the task (subtree) at point N times.
+The clones will be inserted as siblings.
+
+In interactive use, the user will be prompted for the number of clones
+to be produced, and for a time SHIFT, which may be a repeater as used
+in time stamps, for example `+3d'.
+
+When a valid repeater is given and the entry contains any time stamps,
+the clones will become a sequence in time, with time stamps in the
+subtree shifted for each clone produced. If SHIFT is nil or the
+empty string, time stamps will be left alone.
+
+If the original subtree did contain time stamps with a repeater,
+the following will happen:
+- the repeater will be removed in each clone
+- an additional clone will be produced, with the current, unshifted
+ date(s) in the entry.
+- the original entry will be placed *after* all the clones, with
+ repeater intact.
+- the start days in the repeater in the original entry will be shifted
+ to past the last clone.
+I this way you can spell out a number of instances of a repeating task,
+and still retain the repeater to cover future instances of the task."
+ (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
+ (let (beg end template task
+ shift-n shift-what doshift nmin nmax (n-no-remove -1))
+ (if (not (and (integerp n) (> n 0)))
+ (error "Invalid number of replications %s" n))
+ (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
+ (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
+ shift)))
+ (error "Invalid shift specification %s" shift))
+ (when doshift
+ (setq shift-n (string-to-number (match-string 1 shift))
+ shift-what (cdr (assoc (match-string 2 shift)
+ '(("d" . day) ("w" . week)
+ ("m" . month) ("y" . year))))))
+ (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
+ (setq nmin 1 nmax n)
+ (org-back-to-heading t)
+ (setq beg (point))
+ (org-end-of-subtree t t)
+ (setq end (point))
+ (setq template (buffer-substring beg end))
+ (when (and doshift
+ (string-match "<[^<>\n]+ \\+[0-9]+[dwmy][^<>\n]*>" template))
+ (delete-region beg end)
+ (setq end beg)
+ (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
+ (goto-char end)
+ (loop for n from nmin to nmax do
+ (if (not doshift)
+ (setq task template)
+ (with-temp-buffer
+ (insert template)
+ (org-mode)
+ (goto-char (point-min))
+ (while (re-search-forward org-ts-regexp-both nil t)
+ (org-timestamp-change (* n shift-n) shift-what))
+ (unless (= n n-no-remove)
+ (goto-char (point-min))
+ (while (re-search-forward org-ts-regexp nil t)
+ (save-excursion
+ (goto-char (match-beginning 0))
+ (if (looking-at "<[^<>\n]+\\( +\\+[0-9]+[dwmy]\\)")
+ (delete-region (match-beginning 1) (match-end 1))))))
+ (setq task (buffer-string))))
+ (insert task))
+ (goto-char beg)))
;;; Outline Sorting
(defun org-sort (with-case)
"Call `org-sort-entries-or-items' or `org-table-sort-lines'.
-Optional argument WITH-CASE means sort case-sensitively."
+Optional argument WITH-CASE means sort case-sensitively.
+With a double prefix argument, also remove duplicate entries."
(interactive "P")
(if (org-at-table-p)
(org-call-with-arg 'org-table-sort-lines with-case)
(defvar org-priority-regexp) ; defined later in the file
+(defvar org-after-sorting-entries-or-items-hook nil
+ "Hook that is run after a bunch of entries or items have been sorted.
+When children are sorted, the cursor is in the parent line when this
+hook gets called. When a region or a plain list is sorted, the cursor
+will be in the first entry of the sorted region/list.")
+
(defun org-sort-entries-or-items
(&optional with-case sorting-type getkey-func compare-func property)
- "Sort entries on a certain level of an outline tree.
+ "Sort entries on a certain level of an outline tree, or plain list items.
If there is an active region, the entries in the region are sorted.
Else, if the cursor is before the first entry, sort the top-level items.
Else, the children of the entry at point are sorted.
+If the cursor is at the first item in a plain list, the list items will be
+sorted.
+
+Sorting can be alphabetically, numerically, by date/time as given by
+a time stamp, by a property or by priority.
+
+The command prompts for the sorting type unless it has been given to the
+function through the SORTING-TYPE argument, which needs to a character,
+\(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
+precise meaning of each character:
+
+n Numerically, by converting the beginning of the entry/item to a number.
+a Alphabetically, ignoring the TODO keyword and the priority, if any.
+t By date/time, either the first active time stamp in the entry, or, if
+ none exist, by the first inactive one.
+ In items, only the first line will be chekced.
+s By the scheduled date/time.
+d By deadline date/time.
+c By creation time, which is assumed to be the first inactive time stamp
+ at the beginning of a line.
+p By priority according to the cookie.
+r By the value of a property.
+
+Capital letters will reverse the sort order.
-Sorting can be alphabetically, numerically, and by date/time as given by
-the first time stamp in the entry. The command prompts for the sorting
-type unless it has been given to the function through the SORTING-TYPE
-argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
called with point at the beginning of the record. It must return either
a string or a number that should serve as the sorting key for that record.
(unless sorting-type
(message
(if plain-list-p
- "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
- "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty todo[o]rder [f]unc A/N/T/P/O/F means reversed:")
+ "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
+ "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
+ [t]ime [s]cheduled [d]eadline [c]reated
+ A/N/T/S/D/C/P/O/F means reversed:")
what)
(setq sorting-type (read-char-exclusive))
(narrow-to-region start end)
(let ((dcst (downcase sorting-type))
+ (case-fold-search nil)
(now (current-time)))
(sort-subr
(/= dcst sorting-type)
((= dcst ?a)
(buffer-substring (match-end 0) (point-at-eol)))
((= dcst ?t)
- (if (re-search-forward org-ts-regexp
- (point-at-eol) t)
- (org-time-string-to-time (match-string 0))
- now))
+ (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
+ (re-search-forward org-ts-regexp-both
+ (point-at-eol) t))
+ (org-time-string-to-seconds (match-string 0))
+ (time-to-seconds now)))
((= dcst ?f)
(if getkey-func
(progn
(funcall case-func (match-string 4))
nil))
((= dcst ?t)
- (if (re-search-forward org-ts-regexp
- (save-excursion
- (forward-line 2)
- (point)) t)
- (org-time-string-to-time (match-string 0))
- now))
+ (let ((end (save-excursion (outline-next-heading) (point))))
+ (if (or (re-search-forward org-ts-regexp end t)
+ (re-search-forward org-ts-regexp-both end t))
+ (org-time-string-to-seconds (match-string 0))
+ (time-to-seconds now))))
+ ((= dcst ?c)
+ (let ((end (save-excursion (outline-next-heading) (point))))
+ (if (re-search-forward
+ (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
+ end t)
+ (org-time-string-to-seconds (match-string 0))
+ (time-to-seconds now))))
+ ((= dcst ?s)
+ (let ((end (save-excursion (outline-next-heading) (point))))
+ (if (re-search-forward org-scheduled-time-regexp end t)
+ (org-time-string-to-seconds (match-string 1))
+ (time-to-seconds now))))
+ ((= dcst ?d)
+ (let ((end (save-excursion (outline-next-heading) (point))))
+ (if (re-search-forward org-deadline-time-regexp end t)
+ (org-time-string-to-seconds (match-string 1))
+ (time-to-seconds now))))
((= dcst ?p)
(if (re-search-forward org-priority-regexp (point-at-eol) t)
(string-to-char (match-string 2))
nil
(cond
((= dcst ?a) 'string<)
- ((= dcst ?t) 'time-less-p)
((= dcst ?f) compare-func)
+ ((member dcst '(?p ?t ?s ?d ?c)) '<)
(t nil)))))
+ (run-hooks 'org-after-sorting-entries-or-items-hook)
(message "Sorting entries...done")))
(defun org-do-sort (table what &optional with-case sorting-type)
((= dcst ?t)
(setq extractfun
(lambda (x)
- (if (string-match org-ts-regexp x)
+ (if (or (string-match org-ts-regexp x)
+ (string-match org-ts-regexp-both x))
(time-to-seconds
(org-time-string-to-time (match-string 0 x)))
0))
table)
(lambda (a b) (funcall comparefun (car a) (car b))))))
-;;; Editing source examples
-
-(defvar org-exit-edit-mode-map (make-sparse-keymap))
-(define-key org-exit-edit-mode-map "\C-c'" 'org-edit-src-exit)
-(defvar org-edit-src-force-single-line nil)
-(defvar org-edit-src-from-org-mode nil)
-(defvar org-edit-src-picture nil)
-
-(define-minor-mode org-exit-edit-mode
- "Minor mode installing a single key binding, \"C-c '\" to exit special edit.")
-
-(defun org-edit-src-code ()
- "Edit the source code example at point.
-An indirect buffer is created, and that buffer is then narrowed to the
-example at point and switched to the correct language mode. When done,
-exit by killing the buffer with \\[org-edit-src-exit]."
- (interactive)
- (let ((line (org-current-line))
- (case-fold-search t)
- (msg (substitute-command-keys
- "Edit, then exit with C-c ' (C-c and single quote)"))
- (info (org-edit-src-find-region-and-lang))
- (org-mode-p (eq major-mode 'org-mode))
- beg end lang lang-f single lfmt)
- (if (not info)
- nil
- (setq beg (nth 0 info)
- end (nth 1 info)
- lang (nth 2 info)
- single (nth 3 info)
- lfmt (nth 4 info)
- lang-f (intern (concat lang "-mode")))
- (unless (functionp lang-f)
- (error "No such language mode: %s" lang-f))
- (goto-line line)
- (if (get-buffer "*Org Edit Src Example*")
- (kill-buffer "*Org Edit Src Example*"))
- (switch-to-buffer (make-indirect-buffer (current-buffer)
- "*Org Edit Src Example*"))
- (narrow-to-region beg end)
- (remove-text-properties beg end '(display nil invisible nil
- intangible nil))
- (let ((org-inhibit-startup t))
- (funcall lang-f))
- (set (make-local-variable 'org-edit-src-force-single-line) single)
- (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
- (when lfmt
- (set (make-local-variable 'org-coderef-label-format) lfmt))
- (when org-mode-p
- (goto-char (point-min))
- (while (re-search-forward "^," nil t)
- (replace-match "")))
- (goto-line line)
- (org-exit-edit-mode)
- (org-set-local 'header-line-format msg)
- (message "%s" msg)
- t)))
-
-(defun org-edit-fixed-width-region ()
- "Edit the fixed-width ascii drawing at point.
-This must be a region where each line starts with a colon followed by
-a space character.
-An indirect buffer is created, and that buffer is then narrowed to the
-example at point and switched to artist-mode. When done,
-exit by killing the buffer with \\[org-edit-src-exit]."
- (interactive)
- (let ((line (org-current-line))
- (case-fold-search t)
- (msg (substitute-command-keys
- "Edit, then exit with C-c ' (C-c and single quote)"))
- (org-mode-p (eq major-mode 'org-mode))
- beg end)
- (beginning-of-line 1)
- (if (looking-at "[ \t]*[^:\n \t]")
- nil
- (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
- (setq beg (point) end beg)
- (save-excursion
- (if (re-search-backward "^[ \t]*[^:]" nil 'move)
- (setq beg (point-at-bol 2))
- (setq beg (point))))
- (save-excursion
- (if (re-search-forward "^[ \t]*[^:]" nil 'move)
- (setq end (1- (match-beginning 0)))
- (setq end (point))))
- (goto-line line))
- (if (get-buffer "*Org Edit Picture*")
- (kill-buffer "*Org Edit Picture*"))
- (switch-to-buffer (make-indirect-buffer (current-buffer)
- "*Org Edit Picture*"))
- (narrow-to-region beg end)
- (remove-text-properties beg end '(display nil invisible nil
- intangible nil))
- (when (fboundp 'font-lock-unfontify-region)
- (font-lock-unfontify-region (point-min) (point-max)))
- (cond
- ((eq org-edit-fixed-width-region-mode 'artist-mode)
- (fundamental-mode)
- (artist-mode 1))
- (t (funcall org-edit-fixed-width-region-mode)))
- (set (make-local-variable 'org-edit-src-force-single-line) nil)
- (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
- (set (make-local-variable 'org-edit-src-picture) t)
- (goto-char (point-min))
- (while (re-search-forward "^[ \t]*: ?" nil t)
- (replace-match ""))
- (goto-line line)
- (org-exit-edit-mode)
- (org-set-local 'header-line-format msg)
- (message "%s" msg)
- t)))
-
-
-(defun org-edit-src-find-region-and-lang ()
- "Find the region and language for a local edit.
-Return a list with beginning and end of the region, a string representing
-the language, a switch telling of the content should be in a single line."
- (let ((re-list
- (append
- org-edit-src-region-extra
- '(
- ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
- ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
- ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
- ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
- ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
- ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
- ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
- ("^#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n#\\+end_src" 2)
- ("^#\\+begin_example.*\n" "\n#\\+end_example" "fundamental")
- ("^#\\+html:" "\n" "html" single-line)
- ("^#\\+begin_html.*\n" "\n#\\+end_html" "html")
- ("^#\\+begin_latex.*\n" "\n#\\+end_latex" "latex")
- ("^#\\+latex:" "\n" "latex" single-line)
- ("^#\\+begin_ascii.*\n" "\n#\\+end_ascii" "fundamental")
- ("^#\\+ascii:" "\n" "ascii" single-line)
- )))
- (pos (point))
- re1 re2 single beg end lang lfmt match-re1)
- (catch 'exit
- (while (setq entry (pop re-list))
- (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
- single (nth 3 entry))
- (save-excursion
- (if (or (looking-at re1)
- (re-search-backward re1 nil t))
- (progn
- (setq match-re1 (match-string 0))
- (setq beg (match-end 0)
- lang (org-edit-src-get-lang lang)
- lfmt (org-edit-src-get-label-format match-re1))
- (if (and (re-search-forward re2 nil t)
- (>= (match-end 0) pos))
- (throw 'exit (list beg (match-beginning 0)
- lang single lfmt))))
- (if (or (looking-at re2)
- (re-search-forward re2 nil t))
- (progn
- (setq end (match-beginning 0))
- (if (and (re-search-backward re1 nil t)
- (<= (match-beginning 0) pos))
- (progn
- (setq lfmt (org-edit-src-get-label-format
- (match-string 0)))
- (throw 'exit
- (list (match-end 0) end
- (org-edit-src-get-lang lang)
- single lfmt))))))))))))
-
-(defun org-edit-src-get-lang (lang)
- "Extract the src language."
- (let ((m (match-string 0)))
- (cond
- ((stringp lang) lang)
- ((integerp lang) (match-string lang))
- ((and (eq lang 'lang)
- (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
- (match-string 1 m))
- ((and (eq lang 'style)
- (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
- (match-string 1 m))
- (t "fundamental"))))
-
-(defun org-edit-src-get-label-format (s)
- "Extract the label format."
- (save-match-data
- (if (string-match "-l[ \t]+\\\\?\"\\([^\t\r\n\"]+\\)\\\\?\"" s)
- (match-string 1 s))))
-
-(defun org-edit-src-exit ()
- "Exit special edit and protect problematic lines."
- (interactive)
- (unless (buffer-base-buffer (current-buffer))
- (error "This is not an indirect buffer, something is wrong..."))
- (unless (> (point-min) 1)
- (error "This buffer is not narrowed, something is wrong..."))
- (goto-char (point-min))
- (if (looking-at "[ \t\n]*\n") (replace-match ""))
- (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match ""))
- (when (org-bound-and-true-p org-edit-src-force-single-line)
- (goto-char (point-min))
- (while (re-search-forward "\n" nil t)
- (replace-match " "))
- (goto-char (point-min))
- (if (looking-at "\\s-*") (replace-match " "))
- (if (re-search-forward "\\s-+\\'" nil t)
- (replace-match "")))
- (when (org-bound-and-true-p org-edit-src-from-org-mode)
- (goto-char (point-min))
- (while (re-search-forward (if (org-mode-p) "^\\(.\\)" "^\\([*#]\\)") nil t)
- (replace-match ",\\1"))
- (when font-lock-mode
- (font-lock-unfontify-region (point-min) (point-max)))
- (put-text-property (point-min) (point-max) 'font-lock-fontified t))
- (when (org-bound-and-true-p org-edit-src-picture)
- (untabify (point-min) (point-max))
- (goto-char (point-min))
- (while (re-search-forward "^" nil t)
- (replace-match ": "))
- (when font-lock-mode
- (font-lock-unfontify-region (point-min) (point-max)))
- (put-text-property (point-min) (point-max) 'font-lock-fontified t))
- (kill-buffer (current-buffer))
- (and (org-mode-p) (org-restart-font-lock)))
-
;;; The orgstruct minor mode
"Unconditionally turn on `orgstruct-mode'."
(orgstruct-mode 1))
+(defun orgstruct++-mode (&optional arg)
+ "Toggle `orgstruct-mode', the enhanced version of it.
+In addition to setting orgstruct-mode, this also exports all indentation
+and autofilling variables from org-mode into the buffer. It will also
+recognize item context in multiline items.
+Note that turning off orgstruct-mode will *not* remove the
+indentation/paragraph settings. This can only be done by refreshing the
+major mode, for example with \\[normal-mode]."
+ (interactive "P")
+ (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
+ (if (< arg 1)
+ (orgstruct-mode -1)
+ (orgstruct-mode 1)
+ (let (var val)
+ (mapc
+ (lambda (x)
+ (when (string-match
+ "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
+ (symbol-name (car x)))
+ (setq var (car x) val (nth 1 x))
+ (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
+ org-local-vars)
+ (org-set-local 'orgstruct-is-++ t))))
+
+(defvar orgstruct-is-++ nil
+ "Is orgstruct-mode in ++ version in the current-buffer?")
+(make-variable-buffer-local 'orgstruct-is-++)
+
;;;###autoload
(defun turn-on-orgstruct++ ()
- "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
-In addition to setting orgstruct-mode, this also exports all indentation and
-autofilling variables from org-mode into the buffer. Note that turning
-off orgstruct-mode will *not* remove these additional settings."
- (orgstruct-mode 1)
- (let (var val)
- (mapc
- (lambda (x)
- (when (string-match
- "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
- (symbol-name (car x)))
- (setq var (car x) val (nth 1 x))
- (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
- org-local-vars)))
+ "Unconditionally turn on `orgstruct++-mode'."
+ (orgstruct++-mode 1))
(defun orgstruct-error ()
"Error when there is no default binding for a structure key."
'([(meta shift down)] org-shiftmetadown)
'([(meta shift left)] org-shiftmetaleft)
'([(meta shift right)] org-shiftmetaright)
+ '([?\e (up)] org-metaup)
+ '([?\e (down)] org-metadown)
+ '([?\e (left)] org-metaleft)
+ '([?\e (right)] org-metaright)
+ '([?\e (shift up)] org-shiftmetaup)
+ '([?\e (shift down)] org-shiftmetadown)
+ '([?\e (shift left)] org-shiftmetaleft)
+ '([?\e (shift right)] org-shiftmetaright)
'([(shift up)] org-shiftup)
'([(shift down)] org-shiftdown)
'([(shift left)] org-shiftleft)
(orgstruct-make-binding 'org-insert-todo-heading 107
[(meta return)] "\M-\C-m"))
+ (org-defkey orgstruct-mode-map "\e\C-m"
+ (orgstruct-make-binding 'org-insert-heading 108
+ "\e\C-m" [?\e (return)]))
+ (org-defkey orgstruct-mode-map [?\e (return)]
+ (orgstruct-make-binding 'org-insert-heading 109
+ [?\e (return)] "\e\C-m"))
+ (org-defkey orgstruct-mode-map [?\e (shift return)]
+ (orgstruct-make-binding 'org-insert-todo-heading 110
+ [?\e (return)] "\e\C-m"))
+
(unless org-local-vars
(setq org-local-vars (org-get-local-variables)))
"'.")
'(interactive "p")
(list 'if
- '(org-context-p 'headline 'item)
+ `(org-context-p 'headline 'item
+ (and orgstruct-is-++
+ ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
+ 'item-body))
(list 'org-run-like-in-org-mode (list 'quote fun))
(list 'let '(orgstruct-mode)
(list 'call-interactively
;;????????? (looking-at "\\*+"))
(looking-at outline-regexp))
(and (memq 'item contexts)
- (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)")))
+ (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
+ (and (memq 'item-body contexts)
+ (org-in-item-p)))
(goto-char pos))))
(defun org-get-local-variables ()
;;;###autoload
(defun org-run-like-in-org-mode (cmd)
+ "Run a command, pretending that the current buffer is in Org-mode.
+This will temporarily bind local variables that are typically bound in
+Org-mode to the values they have in Org-mode, and then interactively
+call CMD."
(org-load-modules-maybe)
(unless org-local-vars
(setq org-local-vars (org-get-local-variables)))
(interactive "P")
(org-load-modules-maybe)
(setq org-store-link-plist nil) ; reset
- (let (link cpltxt desc description search txt)
+ (let ((outline-regexp (org-get-limited-outline-regexp))
+ link cpltxt desc description search txt custom-id)
(cond
((run-hook-with-args-until-success 'org-store-link-functions)
(org-store-link-props :type "calendar" :date cd)))
((eq major-mode 'w3-mode)
- (setq cpltxt (url-view-url t)
- link (org-make-link cpltxt))
+ (setq cpltxt (if (and (buffer-name)
+ (not (string-match "Untitled" (buffer-name))))
+ (buffer-name)
+ (url-view-url t))
+ link (org-make-link (url-view-url t)))
(org-store-link-props :type "w3" :url (url-view-url t)))
((eq major-mode 'w3m-mode)
link (org-make-link cpltxt)))
((and buffer-file-name (org-mode-p))
+ (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
(cond
((org-in-regexp "<<\\(.*?\\)>>")
(setq cpltxt
(or (eq org-link-to-org-use-id t)
(and (eq org-link-to-org-use-id 'create-if-interactive)
(interactive-p))
+ (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
+ (interactive-p)
+ (not custom-id))
(and org-link-to-org-use-id
(condition-case nil
(org-entry-get nil "ID")
(condition-case nil
(org-make-org-heading-search-string txt)
(error "")))
- desc "NONE")))
+ desc (or (nth 4 (org-heading-components)) "NONE"))))
(if (string-match "::\\'" cpltxt)
(setq cpltxt (substring cpltxt 0 -2)))
(setq link (org-make-link cpltxt)))))
desc (or desc cpltxt))
(if (equal desc "NONE") (setq desc nil))
- (if (and (interactive-p) link)
+ (if (and (or (interactive-p) executing-kbd-macro) link)
(progn
(setq org-stored-links
(cons (list link desc) org-stored-links))
- (message "Stored: %s" (or desc link)))
+ (message "Stored: %s" (or desc link))
+ (when custom-id
+ (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
+ "::#" custom-id))
+ (setq org-stored-links
+ (cons (list link desc) org-stored-links))))
(and link (org-make-link-string link desc)))))
(defun org-store-link-props (&rest plist)
"Association list of escapes for some characters problematic in links.
This is the list that is used for internal purposes.")
+(defvar org-url-encoding-use-url-hexify nil)
+
(defconst org-link-escape-chars-browser
'((?\ . "%20")) ; 32 for the SPC char
"Association list of escapes for some characters problematic in links.
(defun org-link-escape (text &optional table)
"Escape characters in TEXT that are problematic for links."
- (setq table (or table org-link-escape-chars))
- (when text
- (let ((re (mapconcat (lambda (x) (regexp-quote
- (char-to-string (car x))))
- table "\\|")))
- (while (string-match re text)
- (setq text
- (replace-match
- (cdr (assoc (string-to-char (match-string 0 text))
- table))
+ (if org-url-encoding-use-url-hexify
+ (url-hexify-string text)
+ (setq table (or table org-link-escape-chars))
+ (when text
+ (let ((re (mapconcat (lambda (x) (regexp-quote
+ (char-to-string (car x))))
+ table "\\|")))
+ (while (string-match re text)
+ (setq text
+ (replace-match
+ (cdr (assoc (string-to-char (match-string 0 text))
+ table))
t t text)))
- text)))
+ text))))
(defun org-link-unescape (text &optional table)
"Reverse the action of `org-link-escape'."
- (setq table (or table org-link-escape-chars))
- (when text
- (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
- table "\\|")))
- (while (string-match re text)
- (setq text
- (replace-match
- (char-to-string (car (rassoc (match-string 0 text) table)))
- t t text)))
- text)))
+ (if org-url-encoding-use-url-hexify
+ (url-unhex-string text)
+ (setq table (or table org-link-escape-chars))
+ (when text
+ (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
+ table "\\|")))
+ (while (string-match re text)
+ (setq text
+ (replace-match
+ (char-to-string (car (rassoc (match-string 0 text) table)))
+ t t text)))
+ text))))
(defun org-xor (a b)
"Exclusive or."
(desc region)
tmphist ; byte-compile incorrectly complains about this
(link link-location)
- entry file)
+ entry file all-prefixes)
(cond
(link-location) ; specified by arg, just use it.
((org-in-regexp org-bracket-link-regexp 1)
(org-remove-angle-brackets (match-string 0)))))
((member complete-file '((4) (16)))
;; Completing read for file names.
- (setq file (read-file-name "File: "))
- (let ((pwd (file-name-as-directory (expand-file-name ".")))
- (pwd1 (file-name-as-directory (abbreviate-file-name
- (expand-file-name ".")))))
- (cond
- ((equal complete-file '(16))
- (setq link (org-make-link
- "file:"
- (abbreviate-file-name (expand-file-name file)))))
- ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
- (setq link (org-make-link "file:" (match-string 1 file))))
- ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
- (expand-file-name file))
- (setq link (org-make-link
- "file:" (match-string 1 (expand-file-name file)))))
- (t (setq link (org-make-link "file:" file))))))
+ (setq link (org-file-complete-link complete-file)))
(t
;; Read link, with completion for stored links.
(with-output-to-temp-buffer "*Org Links*"
- (princ "Insert a link. Use TAB to complete valid link prefixes.\n")
+ (princ "Insert a link.
+Use TAB to complete link prefixes, then RET for type-specific completion support\n")
(when org-stored-links
(princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
(princ (mapconcat
(let ((cw (selected-window)))
(select-window (get-buffer-window "*Org Links*"))
(setq truncate-lines t)
- (org-fit-window-to-buffer)
- (select-window cw))
+ (unless (pos-visible-in-window-p (point-max))
+ (org-fit-window-to-buffer))
+ (and (window-live-p cw) (select-window cw)))
;; Fake a link history, containing the stored links.
(setq tmphist (append (mapcar 'car org-stored-links)
org-insert-link-history))
+ (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
+ (mapcar 'car org-link-abbrev-alist)
+ org-link-types))
(unwind-protect
- (setq link
- (let ((org-completion-use-ido nil))
- (org-completing-read
- "Link: "
- (append
- (mapcar (lambda (x) (list (concat (car x) ":")))
- (append org-link-abbrev-alist-local org-link-abbrev-alist))
- (mapcar (lambda (x) (list (concat x ":")))
- org-link-types))
- nil nil nil
- 'tmphist
- (or (car (car org-stored-links))))))
+ (progn
+ (setq link
+ (let ((org-completion-use-ido nil))
+ (org-completing-read
+ "Link: "
+ (append
+ (mapcar (lambda (x) (list (concat x ":")))
+ all-prefixes)
+ (mapcar 'car org-stored-links))
+ nil nil nil
+ 'tmphist
+ (car (car org-stored-links)))))
+ (if (or (member link all-prefixes)
+ (and (equal ":" (substring link -1))
+ (member (substring link 0 -1) all-prefixes)
+ (setq link (substring link 0 -1))))
+ (setq link (org-link-try-special-completion link))))
(set-window-configuration wcf)
(kill-buffer "*Org Links*"))
(setq entry (assoc link org-stored-links))
(if remove (apply 'delete-region remove))
(insert (org-make-link-string link desc))))
+(defun org-link-try-special-completion (type)
+ "If there is completion support for link type TYPE, offer it."
+ (let ((fun (intern (concat "org-" type "-complete-link"))))
+ (if (functionp fun)
+ (funcall fun)
+ (read-string "Link (no completion support): " (concat type ":")))))
+
+(defun org-file-complete-link (&optional arg)
+ "Create a file link using completion."
+ (let (file link)
+ (setq file (read-file-name "File: "))
+ (let ((pwd (file-name-as-directory (expand-file-name ".")))
+ (pwd1 (file-name-as-directory (abbreviate-file-name
+ (expand-file-name ".")))))
+ (cond
+ ((equal arg '(16))
+ (setq link (org-make-link
+ "file:"
+ (abbreviate-file-name (expand-file-name file)))))
+ ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
+ (setq link (org-make-link "file:" (match-string 1 file))))
+ ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
+ (expand-file-name file))
+ (setq link (org-make-link
+ "file:" (match-string 1 (expand-file-name file)))))
+ (t (setq link (org-make-link "file:" file)))))
+ link))
+
(defun org-completing-read (&rest args)
"Completing-read with SPACE being a normal character."
(let ((minibuffer-local-completion-map
(fboundp 'ido-completing-read)
(boundp 'ido-mode) ido-mode
(listp (second args)))
- (apply 'ido-completing-read (concat (car args)) (cdr args))
+ (let ((ido-enter-matching-directory nil))
+ (apply 'ido-completing-read (concat (car args))
+ (if (consp (car (nth 1 args)))
+ (mapcar (lambda (x) (car x)) (nth 1 args))
+ (nth 1 args))
+ (cddr args)))
(apply 'completing-read args)))
(defun org-extract-attributes (s)
(org-add-props s nil 'org-attr attr))
s))
+(defun org-extract-attributes-from-string (tag)
+ (let (key value attr)
+ (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
+ (setq key (match-string 1 tag) value (match-string 2 tag)
+ tag (replace-match "" t t tag)
+ attr (plist-put attr (intern key) value)))
+ (cons tag attr)))
+
(defun org-attributes-to-string (plist)
"Format a property list into an HTML attribute list."
(let ((s "") key value)
(defun org-open-link-from-string (s &optional arg)
"Open a link in the string S, as if it was in Org-mode."
(interactive "sLink: \nP")
- (with-temp-buffer
- (let ((org-inhibit-startup t))
- (org-mode)
- (insert s)
- (goto-char (point-min))
- (org-open-at-point arg))))
+ (let ((reference-buffer (current-buffer)))
+ (with-temp-buffer
+ (let ((org-inhibit-startup t))
+ (org-mode)
+ (insert s)
+ (goto-char (point-min))
+ (org-open-at-point arg reference-buffer)))))
-(defun org-open-at-point (&optional in-emacs)
+(defun org-open-at-point (&optional in-emacs reference-buffer)
"Open link at or after point.
If there is no link at point, this function will search forward up to
-the end of the current subtree.
+the end of the current line.
Normally, files will be opened by an appropriate application. If the
optional argument IN-EMACS is non-nil, Emacs will visit the file.
With a double prefix argument, try to open outside of Emacs, in the
((org-at-timestamp-p t) (org-follow-timestamp-link))
((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
(org-footnote-action))
- (t
+ (t
(let (type path link line search (pos (point)))
(catch 'match
(save-excursion
(org-in-regexp org-plain-link-re))
(setq type (match-string 1) path (match-string 2))
(throw 'match t)))
- (when (org-in-regexp "\\<\\([^><\n]+\\)\\>")
- (setq type "tree-match"
- path (match-string 1))
- (throw 'match t))
(save-excursion
(when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
(setq type "tags"
path (match-string 1))
(while (string-match ":" path)
(setq path (replace-match "+" t t path)))
- (throw 'match t))))
+ (throw 'match t)))
+ (when (org-in-regexp "<\\([^><\n]+\\)>")
+ (setq type "tree-match"
+ path (match-string 1))
+ (throw 'match t)))
(unless path
(error "No link found"))
+
+ ;; switch back to reference buffer
+ ;; needed when if called in a temporary buffer through
+ ;; org-open-link-from-string
+ (and reference-buffer (switch-to-buffer reference-buffer))
+
;; Remove any trailing spaces in path
(if (string-match " +\\'" path)
(setq path (replace-match "" t t path)))
;; First check if there are any special
((run-hook-with-args-until-success 'org-execute-file-search-functions s))
;; Now try the builtin stuff
+ ((and (equal (string-to-char s0) ?#)
+ (> (length s0) 1)
+ (save-excursion
+ (goto-char (point-min))
+ (and
+ (re-search-forward
+ (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
+ (setq type 'dedicated
+ pos (match-beginning 0))))
+ ;; There is an exact target for this
+ (goto-char pos)
+ (org-back-to-heading t)))
((save-excursion
(goto-char (point-min))
(and
(defun org-get-refile-targets (&optional default-buffer)
"Produce a table with refile targets."
- (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
- targets txt re files f desc descre fast-path-p level)
+ (let ((case-fold-search nil)
+ ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
+ (entries (or org-refile-targets '((nil . (:level . 1)))))
+ targets txt re files f desc descre fast-path-p level pos0)
(message "Getting targets...")
(with-current-buffer (or default-buffer (current-buffer))
(while (setq entry (pop entries))
(set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
(if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
(setq f (expand-file-name f))
+ (if (eq org-refile-use-outline-path 'file)
+ (push (list (file-name-nondirectory f) f nil nil) targets))
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(while (re-search-forward descre nil t)
- (goto-char (point-at-bol))
- (when (looking-at org-complex-heading-regexp)
- (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
- txt (org-link-display-format (match-string 4))
- re (concat "^" (regexp-quote
- (buffer-substring (match-beginning 1)
- (match-end 4)))))
- (if (match-end 5) (setq re (concat re "[ \t]+"
- (regexp-quote
- (match-string 5)))))
- (setq re (concat re "[ \t]*$"))
- (when org-refile-use-outline-path
- (setq txt (mapconcat 'org-protect-slash
- (append
- (if (eq org-refile-use-outline-path 'file)
- (list (file-name-nondirectory
- (buffer-file-name (buffer-base-buffer))))
- (if (eq org-refile-use-outline-path 'full-file-path)
- (list (buffer-file-name (buffer-base-buffer)))))
- (org-get-outline-path fast-path-p level txt)
- (list txt))
- "/")))
- (push (list txt f re (point)) targets))
- (goto-char (point-at-eol))))))))
+ (goto-char (setq pos0 (point-at-bol)))
+ (catch 'next
+ (when org-refile-target-verify-function
+ (save-match-data
+ (or (funcall org-refile-target-verify-function)
+ (throw 'next t))))
+ (when (looking-at org-complex-heading-regexp)
+ (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
+ txt (org-link-display-format (match-string 4))
+ re (concat "^" (regexp-quote
+ (buffer-substring (match-beginning 1)
+ (match-end 4)))))
+ (if (match-end 5) (setq re (concat re "[ \t]+"
+ (regexp-quote
+ (match-string 5)))))
+ (setq re (concat re "[ \t]*$"))
+ (when org-refile-use-outline-path
+ (setq txt (mapconcat 'org-protect-slash
+ (append
+ (if (eq org-refile-use-outline-path 'file)
+ (list (file-name-nondirectory
+ (buffer-file-name (buffer-base-buffer))))
+ (if (eq org-refile-use-outline-path 'full-file-path)
+ (list (buffer-file-name (buffer-base-buffer)))))
+ (org-get-outline-path fast-path-p level txt)
+ (list txt))
+ "/")))
+ (push (list txt f re (point)) targets)))
+ (when (= (point) pos0)
+ ;; verification function has not moved point
+ (goto-char (point-at-eol))))))))))
(message "Getting targets...done")
- (nreverse targets))))
+ (nreverse targets)))
(defun org-protect-slash (s)
(while (string-match "/" s)
(defvar org-refile-history nil
"History for refiling operations.")
-(defun org-refile (&optional goto default-buffer)
+(defvar org-after-refile-insert-hook nil
+ "Hook run after `org-refile' has inserted its stuff at the new location.
+Note that this is still *before* the stuff will be removed from
+the *old* location.")
+
+(defun org-refile (&optional goto default-buffer rfloc)
"Move the entry at point to another heading.
The list of target headings is compiled using the information in
`org-refile-targets', which see. This list is created before each use
With prefix arg GOTO, the command will only visit the target location,
not actually move anything.
With a double prefix `C-u C-u', go to the location where the last refiling
-operation has put the subtree."
+operation has put the subtree.
+
+RFLOC can be a refile location obtained in a different way.
+
+See also `org-refile-use-outline-path' and `org-completion-use-ido'"
(interactive "P")
(let* ((cbuf (current-buffer))
(regionp (org-region-active-p))
(region-length (and regionp (- region-end region-start)))
(filename (buffer-file-name (buffer-base-buffer cbuf)))
pos it nbuf file re level reversed)
- (when regionp (goto-char region-start)
- (unless (org-kill-is-subtree-p
- (buffer-substring region-start region-end))
- (error "The region is not a (sequence of) subtree(s)")))
+ (when regionp
+ (goto-char region-start)
+ (or (bolp) (goto-char (point-at-bol)))
+ (setq region-start (point))
+ (unless (org-kill-is-subtree-p
+ (buffer-substring region-start region-end))
+ (error "The region is not a (sequence of) subtree(s)")))
(if (equal goto '(16))
(org-refile-goto-last-stored)
- (when (setq it (org-refile-get-location
- (if goto "Goto: " "Refile to: ") default-buffer))
+ (when (setq it (or rfloc
+ (save-excursion
+ (org-refile-get-location
+ (if goto "Goto: " "Refile to: ") default-buffer
+ org-refile-allow-creating-parent-nodes))))
(setq file (nth 1 it)
re (nth 2 it)
pos (nth 3 it))
- (if (and (equal (buffer-file-name) file)
+ (if (and (not goto)
+ pos
+ (equal (buffer-file-name) file)
(if regionp
(and (>= pos region-start)
(<= pos region-end))
(< pos (save-excursion
(org-end-of-subtree t t))))))
(error "Cannot refile to position inside the tree or region"))
-
+
(setq nbuf (or (find-buffer-visiting file)
(find-file-noselect file)))
(if goto
(org-show-context 'org-goto))
(if regionp
(progn
- (kill-new (buffer-substring region-start region-end))
+ (org-kill-new (buffer-substring region-start region-end))
(org-save-markers-in-region region-start region-end))
(org-copy-subtree 1 nil t))
(save-excursion
(save-excursion
(save-restriction
(widen)
- (goto-char pos)
- (looking-at outline-regexp)
- (setq level (org-get-valid-level (funcall outline-level) 1))
- (goto-char
- (if reversed
- (or (outline-next-heading) (point-max))
- (or (save-excursion (outline-get-next-sibling))
- (org-end-of-subtree t t)
- (point-max))))
+ (if pos
+ (progn
+ (goto-char pos)
+ (looking-at outline-regexp)
+ (setq level (org-get-valid-level (funcall outline-level) 1))
+ (goto-char
+ (if reversed
+ (or (outline-next-heading) (point-max))
+ (or (save-excursion (outline-get-next-sibling))
+ (org-end-of-subtree t t)
+ (point-max)))))
+ (setq level 1)
+ (if (not reversed)
+ (goto-char (point-max))
+ (goto-char (point-min))
+ (or (outline-next-heading) (goto-char (point-max)))))
(if (not (bolp)) (newline))
(bookmark-set "org-refile-last-stored")
- (org-paste-subtree level))))
+ (org-paste-subtree level)
+ (if (fboundp 'deactivate-mark) (deactivate-mark))
+ (run-hooks 'org-after-refile-insert-hook))))
(if regionp
(delete-region (point) (+ (point) region-length))
(org-cut-subtree))
+ (when (featurep 'org-inlinetask)
+ (org-inlinetask-remove-END-maybe))
(setq org-markers-to-move nil)
- (message "Refiled to \"%s\"" (car it)))))))
+ (message "Refiled to \"%s\"" (car it))))))
+ (org-reveal))
(defun org-refile-goto-last-stored ()
"Go to the location where the last refile was stored."
(bookmark-jump "org-refile-last-stored")
(message "This is the location of the last refile"))
-(defun org-refile-get-location (&optional prompt default-buffer)
+(defun org-refile-get-location (&optional prompt default-buffer new-nodes)
"Prompt the user for a refile location, using PROMPT."
(let ((org-refile-targets org-refile-targets)
(org-refile-use-outline-path org-refile-use-outline-path))
(unless org-refile-target-table
(error "No refile targets"))
(let* ((cbuf (current-buffer))
+ (partial-completion-mode nil)
(cfn (buffer-file-name (buffer-base-buffer cbuf)))
(cfunc (if (and org-refile-use-outline-path
org-outline-path-complete-in-steps)
(filename (and cfn (expand-file-name cfn)))
(tbl (mapcar
(lambda (x)
- (if (not (equal filename (nth 1 x)))
+ (if (and (not (member org-refile-use-outline-path
+ '(file full-file-path)))
+ (not (equal filename (nth 1 x))))
(cons (concat (car x) extra " ("
(file-name-nondirectory (nth 1 x)) ")")
(cdr x))
(cons (concat (car x) extra) (cdr x))))
org-refile-target-table))
- (completion-ignore-case t))
- (assoc (funcall cfunc prompt tbl nil t nil 'org-refile-history)
- tbl)))
+ (completion-ignore-case t)
+ pa answ parent-target child parent old-hist)
+ (setq old-hist org-refile-history)
+ (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
+ nil 'org-refile-history))
+ (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
+ (if pa
+ (progn
+ (when (or (not org-refile-history)
+ (not (eq old-hist org-refile-history))
+ (not (equal (car pa) (car org-refile-history))))
+ (setq org-refile-history
+ (cons (car pa) (if (assoc (car org-refile-history) tbl)
+ org-refile-history
+ (cdr org-refile-history))))
+ (if (equal (car org-refile-history) (nth 1 org-refile-history))
+ (pop org-refile-history)))
+ pa)
+ (when (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
+ (setq parent (match-string 1 answ)
+ child (match-string 2 answ))
+ (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
+ (when (and parent-target
+ (or (eq new-nodes t)
+ (and (eq new-nodes 'confirm)
+ (y-or-n-p (format "Create new node \"%s\"? " child)))))
+ (org-refile-new-child parent-target child))))))
+
+(defun org-refile-new-child (parent-target child)
+ "Use refile target PARENT-TARGET to add new CHILD below it."
+ (unless parent-target
+ (error "Cannot find parent for new node"))
+ (let ((file (nth 1 parent-target))
+ (pos (nth 3 parent-target))
+ level)
+ (with-current-buffer (or (find-buffer-visiting file)
+ (find-file-noselect file))
+ (save-excursion
+ (save-restriction
+ (widen)
+ (if pos
+ (goto-char pos)
+ (goto-char (point-max))
+ (if (not (bolp)) (newline)))
+ (when (looking-at outline-regexp)
+ (setq level (funcall outline-level))
+ (org-end-of-subtree t t))
+ (org-back-over-empty-lines)
+ (insert "\n" (make-string
+ (if pos (org-get-valid-level level 1) 1) ?*)
+ " " child "\n")
+ (beginning-of-line 0)
+ (list (concat (car parent-target) "/" child) file "" (point)))))))
(defun org-olpath-completing-read (prompt collection &rest args)
"Read an outline path like a file name."
- (let ((thetable collection))
+ (let ((thetable collection)
+ (org-completion-use-ido nil)) ; does not work with ido.
(apply
'org-ido-completing-read prompt
(lambda (string predicate &optional flag)
;;;; Completion
(defconst org-additional-option-like-keywords
- '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
- "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "TBLFM"
+ '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
+ "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
+ "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:" "ATTR_LaTeX"
+ "BEGIN:" "END:"
+ "ORGTBL" "TBLFM:" "TBLNAME:"
"BEGIN_EXAMPLE" "END_EXAMPLE"
"BEGIN_QUOTE" "END_QUOTE"
"BEGIN_VERSE" "END_VERSE"
+ "BEGIN_CENTER" "END_CENTER"
"BEGIN_SRC" "END_SRC"
- "CAPTION" "LABEL" "ATTR_HTML" "ATTR_LaTeX"))
+ "CATEGORY" "COLUMNS"
+ "CAPTION" "LABEL"
+ "BIND"))
(defcustom org-structure-template-alist
'(
"<quote>\n?\n</quote>")
("v" "#+begin_verse\n?\n#+end_verse"
"<verse>\n?\n/verse>")
+ ("c" "#+begin_center\n?\n#+end_center"
+ "<center>\n?\n/center>")
("l" "#+begin_latex\n?\n#+end_latex"
"<literal style=\"latex\">\n?\n</literal>")
("L" "#+latex: "
(defun org-complete-expand-structure-template (start cell)
"Expand a structure template."
(let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
- (rpl (nth (if musep 2 1) cell)))
+ (rpl (nth (if musep 2 1) cell))
+ (ind ""))
(delete-region start (point))
(when (string-match "\\`#\\+" rpl)
(cond
((bolp))
((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
- (delete-region (point-at-bol) (point)))
+ (setq ind (buffer-substring (point-at-bol) (point))))
(t (newline))))
(setq start (point))
(if (string-match "%file" rpl)
(abbreviate-file-name (read-file-name "Include file: ")))
"\"")
t t rpl)))
+ (setq rpl (mapconcat 'identity (split-string rpl "\n")
+ (concat "\n" ind)))
(insert rpl)
(if (re-search-backward "\\?" start t) (delete-char 1))))
(push (nth 2 e) rtn)))
rtn)))))
+(defvar org-todo-setup-filter-hook nil
+ "Hook for functions that pre-filter todo specs.
+
+Each function takes a todo spec and returns either `nil' or the spec
+transformed into canonical form." )
+
+(defvar org-todo-get-default-hook nil
+ "Hook for functions that get a default item for todo.
+
+Each function takes arguments (NEW-MARK OLD-MARK) and returns either
+`nil' or a string to be used for the todo mark." )
+
(defvar org-agenda-headline-snapshot-before-repeat)
+
(defun org-todo (&optional arg)
"Change the TODO state of an item.
The state of an item is given by a keyword at the start of the heading,
really is a member of `org-todo-keywords'."
(interactive "P")
(if (equal arg '(16)) (setq arg 'nextset))
- (let ((org-blocker-hook org-blocker-hook))
+ (let ((org-blocker-hook org-blocker-hook)
+ (case-fold-search nil))
(when (equal arg '(64))
(setq arg nil org-blocker-hook nil))
+ (when (and org-blocker-hook
+ (or org-inhibit-blocking
+ (org-entry-get nil "NOBLOCKING")))
+ (setq org-blocker-hook nil))
(save-excursion
(catch 'exit
(org-back-to-heading)
(if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
- (or (looking-at (concat " +" org-todo-regexp " *"))
+ (or (looking-at (concat " +" org-todo-regexp "\\( +\\|$\\)"))
(looking-at " *"))
(let* ((match-data (match-data))
(startpos (point-at-bol))
((null member) (or head (car org-todo-keywords-1)))
((equal this final-done-word) nil) ;; -> make empty
((null tail) nil) ;; -> first entry
- ((eq interpret 'sequence)
- (car tail))
((memq interpret '(type priority))
(if (eq this-command last-command)
(car tail)
(if (> (length tail) 0)
(or done-word (car org-done-keywords))
nil)))
- (t nil)))
+ (t
+ (car tail))))
+ (state (or
+ (run-hook-with-args-until-success
+ 'org-todo-get-default-hook state last-state)
+ state))
(next (if state (concat " " state " ") " "))
(change-plist (list :type 'todo-state-change :from this :to state
:position startpos))
(not (member this org-done-keywords))))
(and logging (org-local-logging logging))
(when (and (or org-todo-log-states org-log-done)
+ (not (eq org-inhibit-logging t))
(not (memq arg '(nextset previousset))))
;; we need to look at recording a time and note
(setq dolog (or (nth 1 (assoc state org-todo-log-states))
(nth 2 (assoc this org-todo-log-states))))
+ (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
+ (setq dolog 'time))
(when (and state
(member state org-not-done-keywords)
(not (member this org-not-done-keywords)))
;; It is now done, and it was not done before
(org-add-planning-info 'closed (org-current-time))
(if (and (not dolog) (eq 'note org-log-done))
- (org-add-log-setup 'done state 'findpos 'note)))
+ (org-add-log-setup 'done state this 'findpos 'note)))
(when (and state dolog)
;; This is a non-nil state, and we need to log it
- (org-add-log-setup 'state state 'findpos dolog)))
+ (org-add-log-setup 'state state this 'findpos dolog)))
;; Fixup tag positioning
(org-todo-trigger-tag-changes state)
(and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
(< (point) (+ 2 (or (match-end 2) (match-end 1)))))
(progn
(goto-char (or (match-end 2) (match-end 1)))
- (just-one-space)))
+ (and (looking-at " ") (just-one-space))))
(when org-trigger-hook
(save-excursion
(run-hook-with-args 'org-trigger-hook change-plist))))))))
-(defun org-block-todo-from-children-or-siblings (change-plist)
+(defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
"Block turning an entry into a TODO, using the hierarchy.
This checks whether the current task should be blocked from state
changes. Such blocking occurs when:
2. A task has a parent with the property :ORDERED:, and there
are siblings prior to the current task with incomplete
- status."
+ status.
+
+ 3. The parent of the task is blocked because it has siblings that should
+ be done first, or is child of a block grandparent TODO entry."
+
(catch 'dont-block
;; If this is not a todo state change, or if this entry is already DONE,
;; do not block
;; any previous siblings are undone, it's blocked
(save-excursion
(org-back-to-heading t)
- (when (save-excursion
- (ignore-errors
- (org-up-heading-all 1)
- (org-entry-get (point) "ORDERED")))
- (let* ((this-level (funcall outline-level))
- (current-level this-level))
- (while (and (not (bobp))
- (= current-level this-level))
- (outline-previous-heading)
- (setq current-level (funcall outline-level))
- (if (= current-level this-level)
- ;; this todo has children, check whether they are all
- ;; completed
- (if (and (not (org-entry-is-done-p))
- (org-entry-is-todo-p))
- (throw 'dont-block nil)))))))
- t)) ; don't block
+ (let* ((pos (point))
+ (parent-pos (and (org-up-heading-safe) (point))))
+ (if (not parent-pos) (throw 'dont-block t)) ; no parent
+ (when (and (org-entry-get (point) "ORDERED")
+ (forward-line 1)
+ (re-search-forward org-not-done-heading-regexp pos t))
+ (throw 'dont-block nil)) ; block, there is an older sibling not done.
+ ;; Search further up the hierarchy, to see if an anchestor is blocked
+ (while t
+ (goto-char parent-pos)
+ (if (not (looking-at org-not-done-heading-regexp))
+ (throw 'dont-block t)) ; do not block, parent is not a TODO
+ (setq pos (point))
+ (setq parent-pos (and (org-up-heading-safe) (point)))
+ (if (not parent-pos) (throw 'dont-block t)) ; no parent
+ (when (and (org-entry-get (point) "ORDERED")
+ (forward-line 1)
+ (re-search-forward org-not-done-heading-regexp pos t))
+ (throw 'dont-block nil))))))) ; block, older sibling not done.
+
+(defcustom org-track-ordered-property-with-tag nil
+ "Should the ORDERED property also be shown as a tag?
+The ORDERED property decides if an entry should require subtasks to be
+completed in sequence. Since a property is not very visible, setting
+this option means that toggling the ORDERED property with the command
+`org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
+not relevant for the behavior, but it makes things more visible.
+
+Note that toggling the tag with tags commands will not change the property
+and therefore not influence behavior!
+
+This can be t, meaning the tag ORDERED should be used, It can also be a
+string to select a different tag for this task."
+ :group 'org-todo
+ :type '(choice
+ (const :tag "No tracking" nil)
+ (const :tag "Track with ORDERED tag" t)
+ (string :tag "Use other tag")))
(defun org-toggle-ordered-property ()
- "Toggle the ORDERED property of the current entry."
+ "Toggle the ORDERED property of the current entry.
+For better visibility, you can track the value of this property with a tag.
+See variable `org-track-ordered-property-with-tag'."
(interactive)
- (save-excursion
- (org-back-to-heading)
- (if (org-entry-get nil "ORDERED")
- (progn
- (org-delete-property "ORDERED")
- (message "Subtasks can be completed in arbitrary order or parallel"))
- (org-entry-put nil "ORDERED" "t")
- (message "Subtasks must be completed in sequence"))))
-
+ (let* ((t1 org-track-ordered-property-with-tag)
+ (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
+ (save-excursion
+ (org-back-to-heading)
+ (if (org-entry-get nil "ORDERED")
+ (progn
+ (org-delete-property "ORDERED")
+ (and tag (org-toggle-tag tag 'off))
+ (message "Subtasks can be completed in arbitrary order"))
+ (org-entry-put nil "ORDERED" "t")
+ (and tag (org-toggle-tag tag 'on))
+ (message "Subtasks must be completed in sequence")))))
+
+(defvar org-blocked-by-checkboxes) ; dynamically scoped
(defun org-block-todo-from-checkboxes (change-plist)
"Block turning an entry into a TODO, using checkboxes.
This checks whether the current task should be blocked from state
(goto-char beg)
(if (re-search-forward "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\[[- ]\\]"
end t)
- (throw 'dont-block nil))))
+ (progn
+ (if (boundp 'org-blocked-by-checkboxes)
+ (setq org-blocked-by-checkboxes t))
+ (throw 'dont-block nil)))))
t)) ; do not block
+(defvar org-entry-property-inherited-from) ;; defined below
(defun org-update-parent-todo-statistics ()
- "Update any statistics cookie in the parent of the current headline."
+ "Update any statistics cookie in the parent of the current headline.
+When `org-hierarchical-todo-statistics' is nil, statistics will cover
+the entire subtree and this will travel up the hierarchy and update
+statistics everywhere."
(interactive)
- (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
- level (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
+ (let* ((lim 0) prop
+ (recursive (or (not org-hierarchical-todo-statistics)
+ (string-match
+ "\\<recursive\\>"
+ (or (setq prop (org-entry-get
+ nil "COOKIE_DATA" 'inherit)) ""))))
+ (lim (or (and prop (marker-position
+ org-entry-property-inherited-from))
+ lim))
+ (first t)
+ (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
+ level ltoggle l1
+ (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
(catch 'exit
(save-excursion
- (setq level (org-up-heading-safe))
- (unless level
- (throw 'exit nil))
- (while (re-search-forward box-re (point-at-eol) t)
- (setq cnt-all 0 cnt-done 0 cookie-present t)
- (setq is-percent (match-end 2))
- (save-match-data
- (unless (outline-next-heading) (throw 'exit nil))
- (while (looking-at org-todo-line-regexp)
- (setq kwd (match-string 2))
- (and kwd (setq cnt-all (1+ cnt-all)))
- (and (member kwd org-done-keywords)
- (setq cnt-done (1+ cnt-done)))
- (condition-case nil
- (org-forward-same-level 1)
- (error (end-of-line 1)))))
- (replace-match
- (if is-percent
- (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
- (format "[%d/%d]" cnt-done cnt-all))))
+ (beginning-of-line 1)
+ (if (org-at-heading-p)
+ (setq ltoggle (funcall outline-level))
+ (error "This should not happen"))
+ (while (and (setq level (org-up-heading-safe))
+ (or recursive first)
+ (>= (point) lim))
+ (setq first nil)
+ (unless (and level
+ (not (string-match
+ "\\<checkbox\\>"
+ (downcase
+ (or (org-entry-get
+ nil "COOKIE_DATA")
+ "")))))
+ (throw 'exit nil))
+ (while (re-search-forward box-re (point-at-eol) t)
+ (setq cnt-all 0 cnt-done 0 cookie-present t)
+ (setq is-percent (match-end 2))
+ (save-match-data
+ (unless (outline-next-heading) (throw 'exit nil))
+ (while (and (looking-at org-complex-heading-regexp)
+ (> (setq l1 (length (match-string 1))) level))
+ (setq kwd (and (or recursive (= l1 ltoggle))
+ (match-string 2)))
+ (if (or (eq org-provide-todo-statistics 'all-headlines)
+ (and (listp org-provide-todo-statistics)
+ (or (member kwd org-provide-todo-statistics)
+ (member kwd org-done-keywords))))
+ (setq cnt-all (1+ cnt-all))
+ (if (eq org-provide-todo-statistics t)
+ (and kwd (setq cnt-all (1+ cnt-all)))))
+ (and (member kwd org-done-keywords)
+ (setq cnt-done (1+ cnt-done)))
+ (outline-next-heading)))
+ (replace-match
+ (if is-percent
+ (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
+ (format "[%d/%d]" cnt-done cnt-all)))))
(when cookie-present
(run-hook-with-args 'org-after-todo-statistics-hook
- cnt-done (- cnt-all cnt-done)))))))
+ cnt-done (- cnt-all cnt-done)))))
+ (run-hooks 'org-todo-statistics-hook)))
(defvar org-after-todo-statistics-hook nil
"Hook that is called after a TODO statistics cookie has been updated.
(org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
")
+(defvar org-todo-statistics-hook nil
+ "Hook that is run whenever Org thinks TODO statistics should be updated.
+This hook runs even if there is no statisics cookie present, in which case
+`org-after-todo-statistics-hook' would not run.")
+
(defun org-todo-trigger-tag-changes (state)
"Apply the changes defined in `org-todo-state-tags-triggers'."
(let ((l org-todo-state-tags-triggers)
((equal e '(:endgroup))
(setq ingroup nil cnt 0)
(insert "}\n"))
+ ((equal e '(:newline))
+ (when (not (= cnt 0))
+ (setq cnt 0)
+ (insert "\n")
+ (setq e (car tbl))
+ (while (equal (car tbl) '(:newline))
+ (insert "\n")
+ (setq tbl (cdr tbl)))))
(t
(setq tg (car e) c (cdr e))
(if ingroup (push tg (car groups)))
(when repeat
(if (eq org-log-repeat t) (setq org-log-repeat 'state))
(org-todo (if (eq interpret 'type) last-state head))
+ (org-entry-put nil "LAST_REPEAT" (format-time-string
+ (org-time-stamp-format t t)))
(when org-log-repeat
(if (or (memq 'org-add-log-note (default-value 'post-command-hook))
(memq 'org-add-log-note post-command-hook))
(setq org-log-note-how 'note))
;; Set up for taking a record
(org-add-log-setup 'state (or done-word (car org-done-keywords))
+ last-state
'findpos org-log-repeat)))
(org-back-to-heading t)
(org-add-planning-info nil nil 'closed)
"Make a compact tree which shows all headlines marked with TODO.
The tree will show the lines where the regexp matches, and all higher
headlines above the match.
-With a \\[universal-argument] prefix, also show the DONE entries.
+With a \\[universal-argument] prefix, prompt for a regexp to match.
With a numeric prefix N, construct a sparse tree for the Nth element
of `org-todo-keywords-1'."
(interactive "P")
(org-add-planning-info 'scheduled time 'closed)
(message "Scheduled to %s" org-last-inserted-timestamp))))
+(defun org-get-scheduled-time (pom &optional inherit)
+ "Get the scheduled time as a time tuple, of a format suitable
+for calling org-schedule with, or if there is no scheduling,
+returns nil."
+ (let ((time (org-entry-get pom "SCHEDULED" inherit)))
+ (when time
+ (apply 'encode-time (org-parse-time-string time)))))
+
+(defun org-get-deadline-time (pom &optional inherit)
+ "Get the deadine as a time tuple, of a format suitable for
+calling org-deadlin with, or if there is no scheduling, returns
+nil."
+ (let ((time (org-entry-get pom "DEADLINE" inherit)))
+ (when time
+ (apply 'encode-time (org-parse-time-string time)))))
+
(defun org-remove-timestamp-with-keyword (keyword)
"Remove all time stamps with KEYWORD in the current entry."
(let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
(let (org-time-was-given org-end-time-was-given ts
end default-time default-input)
- (when (and (not time) (memq what '(scheduled deadline)))
- ;; Try to get a default date/time from existing timestamp
- (save-excursion
- (org-back-to-heading t)
- (setq end (save-excursion (outline-next-heading) (point)))
- (when (re-search-forward (if (eq what 'scheduled)
- org-scheduled-time-regexp
- org-deadline-time-regexp)
- end t)
- (setq ts (match-string 1)
- default-time
- (apply 'encode-time (org-parse-time-string ts))
- default-input (and ts (org-get-compact-tod ts))))))
- (when what
- ;; If necessary, get the time from the user
- (setq time (or time (org-read-date nil 'to-time nil nil
- default-time default-input))))
-
- (when (and org-insert-labeled-timestamps-at-point
- (member what '(scheduled deadline)))
- (insert
- (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
- (org-insert-time-stamp time org-time-was-given
- nil nil nil (list org-end-time-was-given))
- (setq what nil))
- (save-excursion
- (save-restriction
- (let (col list elt ts buffer-invisibility-spec)
+ (catch 'exit
+ (when (and (not time) (memq what '(scheduled deadline)))
+ ;; Try to get a default date/time from existing timestamp
+ (save-excursion
(org-back-to-heading t)
- (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
- (goto-char (match-end 1))
- (setq col (current-column))
- (goto-char (match-end 0))
- (if (eobp) (insert "\n") (forward-char 1))
- (if (and (not (looking-at outline-regexp))
- (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
- "[^\r\n]*"))
- (not (equal (match-string 1) org-clock-string)))
- (narrow-to-region (match-beginning 0) (match-end 0))
- (insert-before-markers "\n")
- (backward-char 1)
- (narrow-to-region (point) (point))
- (and org-adapt-indentation (org-indent-to-column col)))
- ;; Check if we have to remove something.
- (setq list (cons what remove))
- (while list
- (setq elt (pop list))
+ (setq end (save-excursion (outline-next-heading) (point)))
+ (when (re-search-forward (if (eq what 'scheduled)
+ org-scheduled-time-regexp
+ org-deadline-time-regexp)
+ end t)
+ (setq ts (match-string 1)
+ default-time
+ (apply 'encode-time (org-parse-time-string ts))
+ default-input (and ts (org-get-compact-tod ts))))))
+ (when what
+ ;; If necessary, get the time from the user
+ (setq time (or time (org-read-date nil 'to-time nil nil
+ default-time default-input))))
+
+ (when (and org-insert-labeled-timestamps-at-point
+ (member what '(scheduled deadline)))
+ (insert
+ (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
+ (org-insert-time-stamp time org-time-was-given
+ nil nil nil (list org-end-time-was-given))
+ (setq what nil))
+ (save-excursion
+ (save-restriction
+ (let (col list elt ts buffer-invisibility-spec)
+ (org-back-to-heading t)
+ (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
+ (goto-char (match-end 1))
+ (setq col (current-column))
+ (goto-char (match-end 0))
+ (if (eobp) (insert "\n") (forward-char 1))
+ (when (and (not what)
+ (not (looking-at
+ (concat "[ \t]*"
+ org-keyword-time-not-clock-regexp))))
+ ;; Nothing to add, nothing to remove...... :-)
+ (throw 'exit nil))
+ (if (and (not (looking-at outline-regexp))
+ (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
+ "[^\r\n]*"))
+ (not (equal (match-string 1) org-clock-string)))
+ (narrow-to-region (match-beginning 0) (match-end 0))
+ (insert-before-markers "\n")
+ (backward-char 1)
+ (narrow-to-region (point) (point))
+ (and org-adapt-indentation (org-indent-to-column col)))
+ ;; Check if we have to remove something.
+ (setq list (cons what remove))
+ (while list
+ (setq elt (pop list))
+ (goto-char (point-min))
+ (when (or (and (eq elt 'scheduled)
+ (re-search-forward org-scheduled-time-regexp nil t))
+ (and (eq elt 'deadline)
+ (re-search-forward org-deadline-time-regexp nil t))
+ (and (eq elt 'closed)
+ (re-search-forward org-closed-time-regexp nil t)))
+ (replace-match "")
+ (if (looking-at "--+<[^>]+>") (replace-match ""))
+ (if (looking-at " +") (replace-match ""))))
+ (goto-char (point-max))
+ (when what
+ (insert
+ (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
+ (cond ((eq what 'scheduled) org-scheduled-string)
+ ((eq what 'deadline) org-deadline-string)
+ ((eq what 'closed) org-closed-string))
+ " ")
+ (setq ts (org-insert-time-stamp
+ time
+ (or org-time-was-given
+ (and (eq what 'closed) org-log-done-with-time))
+ (eq what 'closed)
+ nil nil (list org-end-time-was-given)))
+ (end-of-line 1))
(goto-char (point-min))
- (when (or (and (eq elt 'scheduled)
- (re-search-forward org-scheduled-time-regexp nil t))
- (and (eq elt 'deadline)
- (re-search-forward org-deadline-time-regexp nil t))
- (and (eq elt 'closed)
- (re-search-forward org-closed-time-regexp nil t)))
- (replace-match "")
- (if (looking-at "--+<[^>]+>") (replace-match ""))
- (if (looking-at " +") (replace-match ""))))
- (goto-char (point-max))
- (when what
- (insert
- (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
- (cond ((eq what 'scheduled) org-scheduled-string)
- ((eq what 'deadline) org-deadline-string)
- ((eq what 'closed) org-closed-string))
- " ")
- (setq ts (org-insert-time-stamp
- time
- (or org-time-was-given
- (and (eq what 'closed) org-log-done-with-time))
- (eq what 'closed)
- nil nil (list org-end-time-was-given)))
- (end-of-line 1))
- (goto-char (point-min))
- (widen)
- (if (and (looking-at "[ \t]+\n")
- (equal (char-before) ?\n))
- (delete-region (1- (point)) (point-at-eol)))
- ts)))))
+ (widen)
+ (if (and (looking-at "[ \t]+\n")
+ (equal (char-before) ?\n))
+ (delete-region (1- (point)) (point-at-eol)))
+ ts))))))
(defvar org-log-note-marker (make-marker))
(defvar org-log-note-purpose nil)
(defvar org-log-note-state nil)
+(defvar org-log-note-previous-state nil)
(defvar org-log-note-how nil)
(defvar org-log-note-extra nil)
(defvar org-log-note-window-configuration nil)
"Add a note to the current entry.
This is done in the same way as adding a state change note."
(interactive)
- (org-add-log-setup 'note nil 'findpos nil))
+ (org-add-log-setup 'note nil nil 'findpos nil))
(defvar org-property-end-re)
-(defun org-add-log-setup (&optional purpose state findpos how &optional extra)
+(defun org-add-log-setup (&optional purpose state prev-state
+ findpos how &optional extra)
"Set up the post command hook to take a note.
If this is about to TODO state change, the new state is expected in STATE.
When FINDPOS is non-nil, find the correct position for the note in
the current entry. If not, assume that it can be inserted at point.
HOW is an indicator what kind of note should be created.
EXTRA is additional text that will be inserted into the notes buffer."
- (save-restriction
- (save-excursion
- (when findpos
- (org-back-to-heading t)
- (narrow-to-region (point) (save-excursion
- (outline-next-heading) (point)))
- (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
- "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
- "[^\r\n]*\\)?"))
- (goto-char (match-end 0))
- (when (and org-log-state-notes-insert-after-drawers
- (save-excursion
- (forward-line) (looking-at org-drawer-regexp)))
- (progn (forward-line)
- (while (looking-at org-drawer-regexp)
- (goto-char (match-end 0))
- (re-search-forward org-property-end-re (point-max) t)
- (forward-line))
- (forward-line -1)))
- (unless org-log-states-order-reversed
- (and (= (char-after) ?\n) (forward-char 1))
- (org-skip-over-state-notes)
- (skip-chars-backward " \t\n\r")))
- (move-marker org-log-note-marker (point))
- (setq org-log-note-purpose purpose
- org-log-note-state state
- org-log-note-how how
- org-log-note-extra extra)
- (add-hook 'post-command-hook 'org-add-log-note 'append))))
+ (let* ((org-log-into-drawer (org-log-into-drawer))
+ (drawer (cond ((stringp org-log-into-drawer)
+ org-log-into-drawer)
+ (org-log-into-drawer "LOGBOOK")
+ (t nil))))
+ (save-restriction
+ (save-excursion
+ (when findpos
+ (org-back-to-heading t)
+ (narrow-to-region (point) (save-excursion
+ (outline-next-heading) (point)))
+ (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
+ "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
+ "[^\r\n]*\\)?"))
+ (goto-char (match-end 0))
+ (cond
+ (drawer
+ (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
+ nil t)
+ (progn
+ (goto-char (match-end 0))
+ (or org-log-states-order-reversed
+ (and (re-search-forward org-property-end-re nil t)
+ (goto-char (1- (match-beginning 0))))))
+ (insert "\n:" drawer ":\n:END:")
+ (beginning-of-line 0)
+ (org-indent-line-function)
+ (beginning-of-line 2)
+ (org-indent-line-function)
+ (end-of-line 0)))
+ ((and org-log-state-notes-insert-after-drawers
+ (save-excursion
+ (forward-line) (looking-at org-drawer-regexp)))
+ (forward-line)
+ (while (looking-at org-drawer-regexp)
+ (goto-char (match-end 0))
+ (re-search-forward org-property-end-re (point-max) t)
+ (forward-line))
+ (forward-line -1)))
+ (unless org-log-states-order-reversed
+ (and (= (char-after) ?\n) (forward-char 1))
+ (org-skip-over-state-notes)
+ (skip-chars-backward " \t\n\r")))
+ (move-marker org-log-note-marker (point))
+ (setq org-log-note-purpose purpose
+ org-log-note-state state
+ org-log-note-previous-state prev-state
+ org-log-note-how how
+ org-log-note-extra extra)
+ (add-hook 'post-command-hook 'org-add-log-note 'append)))))
(defun org-skip-over-state-notes ()
"Skip past the list of State notes in an entry."
((eq org-log-note-purpose 'clock-out) "stopped clock")
((eq org-log-note-purpose 'done) "closed todo item")
((eq org-log-note-purpose 'state)
- (format "state change to \"%s\"" org-log-note-state))
+ (format "state change from \"%s\" to \"%s\""
+ (or org-log-note-previous-state "")
+ (or org-log-note-state "")))
((eq org-log-note-purpose 'note)
"this entry")
(t (error "This should not happen")))))
(current-time)))
(cons "%s" (if org-log-note-state
(concat "\"" org-log-note-state "\"")
- "")))))
+ ""))
+ (cons "%S" (if org-log-note-previous-state
+ (concat "\"" org-log-note-previous-state "\"")
+ "\"\"")))))
(if lines (setq note (concat note " \\\\")))
(push note lines))
- (when (or current-prefix-arg org-note-abort) (setq lines nil))
+ (when (or current-prefix-arg org-note-abort)
+ (when org-log-into-drawer
+ (org-remove-empty-drawer-at
+ (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
+ org-log-note-marker))
+ (setq lines nil))
(when lines
(save-excursion
(set-buffer (marker-buffer org-log-note-marker))
(move-marker org-log-note-marker nil)
(end-of-line 1)
(if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
- (indent-relative nil)
(insert "- " (pop lines))
(org-indent-line-function)
(beginning-of-line 1)
(looking-at "[ \t]*")
(setq ind (concat (match-string 0) " "))
(end-of-line 1)
- (while lines (insert "\n" ind (pop lines)))))))
+ (while lines (insert "\n" ind (pop lines)))
+ (message "Note stored")
+ (org-back-to-heading t)
+ (org-cycle-hide-drawers 'children)))))
(set-window-configuration org-log-note-window-configuration)
(with-current-buffer (marker-buffer org-log-note-return-to)
(goto-char org-log-note-return-to))
(move-marker org-log-note-return-to nil)
(and org-log-post-message (message "%s" org-log-post-message)))
+(defun org-remove-empty-drawer-at (drawer pos)
+ "Remove an emptyr DARWER drawer at position POS.
+POS may also be a marker."
+ (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char pos)
+ (if (org-in-regexp
+ (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
+ (replace-match ""))))))
+
(defun org-sparse-tree (&optional arg)
"Create a sparse tree, prompt for the details.
This command can create sparse trees. You first need to select the type
of match used to create the tree:
t Show entries with a specific TODO keyword.
-T Show entries selected by a tags match.
+m Show entries selected by a tags/property match.
p Enter a property name and its value (both with completion on existing
names/values) and show entries with that property.
-r Show entries matching a regular expression
-d Show deadlines due within `org-deadline-warning-days'."
+r Show entries matching a regular expression.
+d Show deadlines due within `org-deadline-warning-days'.
+b Show deadlines and scheduled items before a date.
+a Show deadlines and scheduled items after a date."
(interactive "P")
(let (ans kwd value)
- (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
+ (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
(setq ans (read-char-exclusive))
(cond
((equal ans ?d)
(call-interactively 'org-check-deadlines))
((equal ans ?b)
(call-interactively 'org-check-before-date))
+ ((equal ans ?a)
+ (call-interactively 'org-check-after-date))
((equal ans ?t)
(org-show-todo-tree '(4)))
- ((equal ans ?T)
- (call-interactively 'org-tags-sparse-tree))
+ ((member ans '(?T ?m))
+ (call-interactively 'org-match-sparse-tree))
((member ans '(?p ?P))
(setq kwd (org-ido-completing-read "Property: "
(mapcar 'list (org-buffer-property-keys))))
(mapcar 'list (org-property-values kwd))))
(unless (string-match "\\`{.*}\\'" value)
(setq value (concat "\"" value "\"")))
- (org-tags-sparse-tree arg (concat kwd "=" value)))
+ (org-match-sparse-tree arg (concat kwd "=" value)))
((member ans '(?r ?R ?/))
(call-interactively 'org-occur))
(t (error "No such sparse tree command \"%c\"" ans)))))
If CALLBACK is non-nil, it is a function which is called to confirm
that the match should indeed be shown."
(interactive "sRegexp: \nP")
+ (when (equal regexp "")
+ (error "Regexp cannot be empty"))
(unless keep-previous
(org-remove-occur-highlights nil nil t))
(push (cons regexp callback) org-occur-parameters)
"Change the priority of an item by ARG.
ACTION can be `set', `up', `down', or a character."
(interactive)
+ (unless org-enable-priority-commands
+ (error "Priority commands are disabled"))
(setq action (or action 'set))
(let (current new news have remove)
(save-excursion
(replace-match news t t nil 2))
(if remove
(error "No priority cookie found in line")
- (looking-at org-todo-line-regexp)
+ (let ((case-fold-search nil))
+ (looking-at org-todo-line-regexp))
(if (match-end 2)
(progn
(goto-char (match-end 2))
(insert " [#" news "]"))
(goto-char (match-beginning 3))
- (insert "[#" news "] ")))))
- (org-preserve-lc (org-set-tags nil 'align))
+ (insert "[#" news "] "))))
+ (org-preserve-lc (org-set-tags nil 'align)))
(if remove
(message "Priority removed")
(message "Priority of current item set to %s" news))))
-
(defun org-get-priority (s)
"Find priority cookie and return priority."
(save-match-data
;;;; Tags
(defvar org-agenda-archives-mode)
+(defvar org-map-continue-from nil
+ "Position from where mapping should continue.
+Can be set byt the action argument to `org-scan-tag's and `org-map-entries'.")
+
+(defvar org-scanner-tags nil
+ "The current tag list while the tags scanner is running.")
+(defvar org-trust-scanner-tags nil
+ "Should `org-get-tags-at' use the tags fro the scanner.
+This is for internal dynamical scoping only.
+When this is non-nil, the function `org-get-tags-at' will return the value
+of `org-scanner-tags' instead of building the list by itself. This
+can lead to large speed-ups when the tags scanner is used in a file with
+many entries, and when the list of tags is retrieved, for example to
+obtain a list of properties. Building the tags list for each entry in such
+a file becomes an N^2 operation - but with this variable set, it scales
+as N.")
+
(defun org-scan-tags (action matcher &optional todo-only)
"Scan headline tags with inheritance and produce output ACTION.
qualifies a headline for inclusion. When TODO-ONLY is non-nil,
only lines with a TODO keyword are included in the output."
(require 'org-agenda)
- (let* ((re (concat "[\n\r]" outline-regexp " *\\(\\<\\("
+ (let* ((re (concat "^" outline-regexp " *\\(\\<\\("
(mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
(org-re
"\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
(props (list 'face 'default
- 'done-face 'org-done
+ 'done-face 'org-agenda-done
'undone-face 'default
'mouse-face 'highlight
'org-not-done-regexp org-not-done-regexp
(or (buffer-file-name (buffer-base-buffer))
(buffer-name (buffer-base-buffer)))))))
(case-fold-search nil)
+ (org-map-continue-from nil)
lspos tags tags-list
- (tags-alist (list (cons 0 (mapcar 'downcase org-file-tags))))
+ (tags-alist (list (cons 0 org-file-tags)))
(llast 0) rtn rtn1 level category i txt
todo marker entry priority)
(when (not (or (member action '(agenda sparse-tree)) (functionp action)))
(org-remove-occur-highlights))
(while (re-search-forward re nil t)
(catch :skip
- (setq todo (if (match-end 1) (match-string 2))
- tags (if (match-end 4) (match-string 4)))
- (goto-char (setq lspos (1+ (match-beginning 0))))
+ (setq todo (if (match-end 1) (org-match-string-no-properties 2))
+ tags (if (match-end 4) (org-match-string-no-properties 4)))
+ (goto-char (setq lspos (match-beginning 0)))
(setq level (org-reduced-level (funcall outline-level))
category (org-get-category))
(setq i llast llast level)
(setq i (1- i)))
;; add the next tags
(when tags
- (setq tags (mapcar 'downcase (org-split-string tags ":"))
+ (setq tags (org-split-string tags ":")
tags-alist
(cons (cons level tags) tags-alist)))
;; compile tags for current headline
(setq tags-list
(if org-use-tag-inheritance
(apply 'append (mapcar 'cdr (reverse tags-alist)))
- tags))
+ tags)
+ org-scanner-tags tags-list)
(when org-use-tag-inheritance
(setcdr (car tags-alist)
(mapcar (lambda (x)
(org-add-prop-inherited x))
(cdar tags-alist))))
(when (and tags org-use-tag-inheritance
- (not (eq t org-use-tag-inheritance)))
+ (or (not (eq t org-use-tag-inheritance))
+ org-tags-exclude-from-inheritance))
;; selective inheritance, remove uninherited ones
(setcdr (car tags-alist)
(org-remove-uniherited-tags (cdar tags-alist))))
(setq txt (org-format-agenda-item
""
(concat
- (if org-tags-match-list-sublevels
+ (if (eq org-tags-match-list-sublevels 'indented)
(make-string (1- level) ?.) "")
(org-get-heading))
- category (org-get-tags-at))
+ category
+ tags-list
+ )
priority (org-get-priority txt))
(goto-char lspos)
(setq marker (org-agenda-new-marker))
(org-add-props txt props
'org-marker marker 'org-hd-marker marker 'org-category category
+ 'todo-state todo
'priority priority 'type "tagsmatch")
(push txt rtn))
((functionp action)
+ (setq org-map-continue-from nil)
(save-excursion
(setq rtn1 (funcall action))
- (push rtn1 rtn))
- (goto-char (point-at-eol)))
+ (push rtn1 rtn)))
(t (error "Invalid action")))
;; if we are to skip sublevels, jump to end of subtree
- (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
+ (unless org-tags-match-list-sublevels
+ (org-end-of-subtree t)
+ (backward-char 1))))
+ ;; Get the correct position from where to continue
+ (if org-map-continue-from
+ (goto-char org-map-continue-from)
+ (and (= (point) lspos) (end-of-line 1)))))
(when (and (eq action 'sparse-tree)
(not org-sparse-tree-open-archived-trees))
(org-hide-archived-subtrees (point-min) (point-max)))
(defvar todo-only) ;; dynamically scoped
-(defun org-tags-sparse-tree (&optional todo-only match)
+(defun org-match-sparse-tree (&optional todo-only match)
"Create a sparse tree according to tags string MATCH.
MATCH can contain positive and negative selection of tags, like
\"+WORK+URGENT-WITHBOSS\".
(org-prepare-agenda-buffers (list (current-buffer)))
(org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
+(defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
+
(defvar org-cached-props nil)
(defun org-cached-entry-get (pom property)
(if (or (eq t org-use-property-inheritance)
`(,po (or ,gv "") ,pv)
`(,po (string-to-number (or ,gv ""))
,(string-to-number pv) ))))
- (t `(member ,(downcase tag) tags-list)))
+ (t `(member ,tag tags-list)))
mm (if minus (list 'not mm) mm)
term rest)
(push mm tagsmatcher))
When LOCAL is non-nil, only return tags from the current headline,
ignore inherited ones."
(interactive)
- (let (tags ltags lastpos parent)
- (save-excursion
- (save-restriction
- (widen)
- (goto-char (or pos (point)))
- (save-match-data
- (catch 'done
- (condition-case nil
- (progn
- (org-back-to-heading t)
- (while (not (equal lastpos (point)))
- (setq lastpos (point))
- (when (looking-at (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
- (setq ltags (org-split-string
- (org-match-string-no-properties 1) ":"))
- (when parent
- (setq ltags (mapcar 'org-add-prop-inherited ltags)))
- (setq tags (append
- (if parent
- (org-remove-uniherited-tags ltags)
- ltags)
- tags)))
- (or org-use-tag-inheritance (throw 'done t))
- (if local (throw 'done t))
- (org-up-heading-all 1)
- (setq parent t)))
- (error nil)))))
- (append (org-remove-uniherited-tags org-file-tags) tags))))
+ (if (and org-trust-scanner-tags
+ (or (not pos) (equal pos (point)))
+ (not local))
+ org-scanner-tags
+ (let (tags ltags lastpos parent)
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char (or pos (point)))
+ (save-match-data
+ (catch 'done
+ (condition-case nil
+ (progn
+ (org-back-to-heading t)
+ (while (not (equal lastpos (point)))
+ (setq lastpos (point))
+ (when (looking-at
+ (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
+ (setq ltags (org-split-string
+ (org-match-string-no-properties 1) ":"))
+ (when parent
+ (setq ltags (mapcar 'org-add-prop-inherited ltags)))
+ (setq tags (append
+ (if parent
+ (org-remove-uniherited-tags ltags)
+ ltags)
+ tags)))
+ (or org-use-tag-inheritance (throw 'done t))
+ (if local (throw 'done t))
+ (or (org-up-heading-safe) (error nil))
+ (setq parent t)))
+ (error nil)))))
+ (append (org-remove-uniherited-tags org-file-tags) tags)))))
(defun org-add-prop-inherited (s)
(add-text-properties 0 (length s) '(inherited t) s)
(setq tags current)
;; Get a new set of tags from the user
(save-excursion
- (setq table (or org-tag-alist (org-get-buffer-tags))
+ (setq table (append org-tag-persistent-alist
+ (or org-tag-alist (org-get-buffer-tags)))
org-last-tags-completion-table table
current-tags (org-split-string current ":")
inherited-tags (nreverse
;; No boolean logic, just a list
(setq tags (replace-match ":" t t tags))))
+ (if org-tags-sort-function
+ (setq tags (mapconcat 'identity
+ (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
+ org-tags-sort-function) ":")))
+
(if (string-match "\\`[\t ]*\\'" tags)
- (setq tags "")
+ (setq tags "")
(unless (string-match ":$" tags) (setq tags (concat tags ":")))
(unless (string-match "^:" tags) (setq tags (concat ":" tags))))
((equal e '(:endgroup))
(setq ingroup nil cnt 0)
(insert "}\n"))
+ ((equal e '(:newline))
+ (when (not (= cnt 0))
+ (setq cnt 0)
+ (insert "\n")
+ (setq e (car tbl))
+ (while (equal (car tbl) '(:newline))
+ (insert "\n")
+ (setq tbl (cdr tbl)))))
(t
(setq tg (car e) c2 nil)
(if (cdr e)
The return values of all calls to the function will be collected and
returned as a list.
+The call to FUNC will be wrapped into a save-excursion form, so FUNC
+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
+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
+position.
+
MATCH is a tags/property/todo match as it is used in the agenda tags view.
Only headlines that are matched by this query will be considered during
the iteration. When MATCH is nil or t, all headlines will be
will be used as value for `org-agenda-skip-function', so whenever
the the function returns t, FUNC will not be called for that
entry and search will continue from the point where the
- function leaves it."
+ function leaves it.
+
+If your function needs to retrieve the tags including inherited tags
+at the *current* entry, you can use the value of the variable
+`org-scanner-tags' which will be much faster than getting the value
+with `org-get-tags-at'. If your function gets properties with
+`org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
+to t around the call to `org-entry-properties' to get the same speedup.
+Note that if your function moves around to retrieve tags and properties at
+a *different* entry, you cannot use these techniques."
(let* ((org-agenda-archives-mode nil) ; just to make sure
(org-agenda-skip-archived-trees (memq 'archive skip))
(org-agenda-skip-comment-trees (memq 'comment skip))
but in some other way.")
(defconst org-default-properties
- '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
+ '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
"LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
"TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
- "EXPORT_FILE_NAME" "EXPORT_TITLE" "ORDERED")
+ "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
+ "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
+ "CLOCK_MODELINE_TOTAL")
"Some properties that are used by Org-mode for various purposes.
Being in this list makes sure that they are offered for completion.")
)
(when (memq which '(all standard))
- ;; Get the standard properties, like :PORP: ...
+ ;; Get the standard properties, like :PROP: ...
(setq range (org-get-property-block beg end))
(when range
(goto-char (car range))
(setq rtn (append org-special-properties rtn)))
(when include-defaults
- (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
+ (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
+ (add-to-list 'rtn org-effort-property))
(when include-columns
(save-excursion
(interactive)
(org-back-to-heading t)
(looking-at outline-regexp)
- (let ((indent (- (match-end 0)(match-beginning 0)))
+ (let ((indent (if org-adapt-indentation
+ (- (match-end 0)(match-beginning 0))
+ 0))
(beg (point))
(re (concat "^[ \t]*" org-keyword-time-regexp))
end hiddenp)
(setq hiddenp (org-invisible-p))
(end-of-line 1)
(and (equal (char-after) ?\n) (forward-char 1))
- (while (looking-at "^[ \t]*\\(:CLOCK:\\|CLOCK\\|:END:\\)")
- (beginning-of-line 2))
+ (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
+ (if (member (match-string 1) '("CLOCK:" ":END:"))
+ ;; just skip this line
+ (beginning-of-line 2)
+ ;; Drawer start, find the end
+ (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
+ (beginning-of-line 1)))
(org-skip-over-state-notes)
(skip-chars-backward " \t\n\r")
(if (eq (char-before) ?*) (forward-char 1))
(existing (mapcar 'list (org-property-values prop)))
(val (if allowed
(org-completing-read "Value: " allowed nil 'req-match)
- (org-completing-read-no-ido
- (concat "Value" (if (and cur (string-match "\\S-" cur))
- (concat "[" cur "]") "")
- ": ")
- existing nil nil "" nil cur))))
+ (let (org-completion-use-ido)
+ (org-completing-read
+ (concat "Value" (if (and cur (string-match "\\S-" cur))
+ (concat "[" cur "]") "")
+ ": ")
+ existing nil nil "" nil cur)))))
(list prop (if (equal val "") cur val))))
(unless (equal (org-entry-get nil property) value)
(org-entry-put nil property value)))
(when (re-search-forward
(concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
nil t)
- (org-back-to-heading)
+ (org-back-to-heading t)
(point))))))
;;;; Timestamps
(defvar org-overriding-default-time nil) ; dynamically scoped
(defvar org-read-date-overlay nil)
(defvar org-dcst nil) ; dynamically scoped
+(defvar org-read-date-history nil)
+(defvar org-read-date-final-answer nil)
(defun org-read-date (&optional with-time to-time from-string prompt
default-time default-input)
(setcar (nthcdr 1 defdecode) 59)
(setq def (apply 'encode-time defdecode)
defdecode (decode-time def)))))
+ (calendar-frame-setup nil)
(calendar-move-hook nil)
(calendar-view-diary-initially-flag nil)
(view-diary-entries-initially nil)
(minibuffer-local-map (copy-keymap minibuffer-local-map)))
(org-defkey map (kbd "RET") 'org-calendar-select)
(org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
- 'org-calendar-select-mouse)
+ 'org-calendar-select-mouse)
(org-defkey map (if (featurep 'xemacs) [button2] [mouse-2])
- 'org-calendar-select-mouse)
+ 'org-calendar-select-mouse)
(org-defkey minibuffer-local-map [(meta shift left)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-month 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-backward-month 1))))
(org-defkey minibuffer-local-map [(meta shift right)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-month 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-forward-month 1))))
(org-defkey minibuffer-local-map [(meta shift up)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-year 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-backward-year 1))))
(org-defkey minibuffer-local-map [(meta shift down)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-year 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-forward-year 1))))
+ (org-defkey minibuffer-local-map [?\e (shift left)]
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-backward-month 1))))
+ (org-defkey minibuffer-local-map [?\e (shift right)]
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-forward-month 1))))
+ (org-defkey minibuffer-local-map [?\e (shift up)]
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-backward-year 1))))
+ (org-defkey minibuffer-local-map [?\e (shift down)]
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-forward-year 1))))
(org-defkey minibuffer-local-map [(shift up)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-week 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-backward-week 1))))
(org-defkey minibuffer-local-map [(shift down)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-week 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-forward-week 1))))
(org-defkey minibuffer-local-map [(shift left)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-backward-day 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-backward-day 1))))
(org-defkey minibuffer-local-map [(shift right)]
- (lambda () (interactive)
- (org-eval-in-calendar '(calendar-forward-day 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(calendar-forward-day 1))))
(org-defkey minibuffer-local-map ">"
- (lambda () (interactive)
- (org-eval-in-calendar '(scroll-calendar-left 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(scroll-calendar-left 1))))
(org-defkey minibuffer-local-map "<"
- (lambda () (interactive)
- (org-eval-in-calendar '(scroll-calendar-right 1))))
+ (lambda () (interactive)
+ (org-eval-in-calendar '(scroll-calendar-right 1))))
+ (run-hooks 'org-read-date-minibuffer-setup-hook)
(unwind-protect
(progn
(use-local-map map)
(add-hook 'post-command-hook 'org-read-date-display)
- (setq org-ans0 (read-string prompt default-input nil nil))
+ (setq org-ans0 (read-string prompt default-input
+ 'org-read-date-history nil))
;; org-ans0: from prompt
;; org-ans1: from mouse click
;; org-ans2: from calendar motion
(t ; Naked prompt only
(unwind-protect
- (setq ans (read-string prompt default-input nil timestr))
+ (setq ans (read-string prompt default-input
+ 'org-read-date-history timestr))
(when org-read-date-overlay
(org-delete-overlay org-read-date-overlay)
(setq org-read-date-overlay nil)))))
(setq final (org-read-date-analyze ans def defdecode))
+ (setq org-read-date-final-answer ans)
(if to-time
(apply 'encode-time final)
(nth 5 final) (nth 4 final) (nth 3 final)
(nth 2 final) (nth 1 final))
(format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
+
(defvar def)
(defvar defdecode)
(defvar with-time)
(defun org-eval-in-calendar (form &optional keepdate)
"Eval FORM in the calendar window and return to current window.
Also, store the cursor date in variable org-ans2."
- (let ((sw (selected-window)))
- (select-window (get-buffer-window "*Calendar*"))
+ (let ((sf (selected-frame))
+ (sw (selected-window)))
+ (select-window (get-buffer-window "*Calendar*" t))
(eval form)
(when (and (not keepdate) (calendar-cursor-to-date))
(let* ((date (calendar-cursor-to-date))
(time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
(setq org-ans2 (format-time-string "%Y-%m-%d" time))))
(org-move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
- (select-window sw)))
+ (select-window sw)
+ (select-frame-set-input-focus sf)))
(defun org-calendar-select ()
"Return to `org-read-date' with the date currently selected.
((<= org-deadline-warning-days 0)
;; 0 or negative, enforce this value no matter what
(- org-deadline-warning-days))
- ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\)" ts)
+ ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\| \\)" ts)
;; lead time is specified.
(floor (* (string-to-number (match-string 1 ts))
(cdr (assoc (match-string 2 ts)
(message "%d entries before %s"
(org-occur regexp nil callback) date)))
+(defun org-check-after-date (date)
+ "Check if there are deadlines or scheduled entries after DATE."
+ (interactive (list (org-read-date)))
+ (let ((case-fold-search nil)
+ (regexp (concat "\\<\\(" org-deadline-string
+ "\\|" org-scheduled-string
+ "\\) *<\\([^>]+\\)>"))
+ (callback
+ (lambda () (not
+ (time-less-p
+ (org-time-string-to-time (match-string 2))
+ (org-time-string-to-time date))))))
+ (message "%d entries after %s"
+ (org-occur regexp nil callback) date)))
+
(defun org-evaluate-time-range (&optional to-buffer)
"Evaluate a time range by computing the difference between start and end.
Normally the result is just printed in the echo area, but with prefix arg
(defun org-time-string-to-time (s)
(apply 'encode-time (org-parse-time-string s)))
+(defun org-time-string-to-seconds (s)
+ (time-to-seconds (org-time-string-to-time s)))
(defun org-time-string-to-absolute (s &optional daynr prefer show-all)
"Convert a time stamp to an absolute day number.
If there is a specifyer for a cyclic time stamp, get the closest date to
DAYNR.
-PREFER and SHOW-ALL are passed through to `org-closest-date'."
+PREFER and SHOW-ALL are passed through to `org-closest-date'.
+the variable date is bound by the calendar when this is called."
(cond
((and daynr (string-match "\\`%%\\((.*)\\)" s))
(if (org-diary-sexp-entry (match-string 1 s) "" date)
(+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
(+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
(nthcdr 6 time0)))
+ (when (and (member org-ts-what '(hour minute))
+ extra
+ (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
+ (setq extra (org-modify-ts-extra
+ extra
+ (if (eq org-ts-what 'hour) 2 5)
+ n dm)))
(when (integerp org-ts-what)
(setq extra (org-modify-ts-extra extra org-ts-what n dm)))
(if (eq what 'calendar)
(format org-time-clocksum-format h m)))
(defun org-hh:mm-string-to-minutes (s)
- "Convert a string H:MM to a number of minutes."
- (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
- (+ (* (string-to-number (match-string 1 s)) 60)
- (string-to-number (match-string 2 s)))
- 0))
+ "Convert a string H:MM to a number of minutes.
+If the string is just a number, interprete it as minutes.
+In fact, the first hh:mm or number in the string will be taken,
+there can be extra stuff in the string.
+If no number is found, the return value is 0."
+ (cond
+ ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
+ (+ (* (string-to-number (match-string 1 s)) 60)
+ (string-to-number (match-string 2 s))))
+ ((string-match "\\([0-9]+\\)" s)
+ (string-to-number (match-string 1 s)))
+ (t 0)))
+
+;;;; Files
+
+(defun org-save-all-org-buffers ()
+ "Save all Org-mode buffers without user confirmation."
+ (interactive)
+ (message "Saving all Org-mode buffers...")
+ (save-some-buffers t 'org-mode-p)
+ (when (featurep 'org-id) (org-id-locations-save))
+ (message "Saving all Org-mode buffers... done"))
+
+(defun org-revert-all-org-buffers ()
+ "Revert all Org-mode buffers.
+Prompt for confirmation when there are unsaved changes.
+Be sure you know what you are doing before letting this function
+overwrite your changes.
+
+This function is useful in a setup where one tracks org files
+with a version control system, to revert on one machine after pulling
+changes from another. I believe the procedure must be like this:
+
+1. M-x org-save-all-org-buffers
+2. Pull changes from the other machine, resolve conflicts
+3. M-x org-revert-all-org-buffers"
+ (interactive)
+ (unless (yes-or-no-p "Revert all Org buffers from their files? ")
+ (error "Abort"))
+ (save-excursion
+ (save-window-excursion
+ (mapc
+ (lambda (b)
+ (when (and (with-current-buffer b (org-mode-p))
+ (with-current-buffer b buffer-file-name))
+ (switch-to-buffer b)
+ (revert-buffer t 'no-confirm)))
+ (buffer-list))
+ (when (and (featurep 'org-id) org-id-track-globally)
+ (org-id-locations-load)))))
;;;; Agenda files
(t (org-buffer-list)))))
(switch-to-buffer
(org-ido-completing-read "Org buffer: "
- (mapcar 'buffer-name blist)
+ (mapcar 'list (mapcar 'buffer-name blist))
nil t))))
(defun org-buffer-list (&optional predicate exclude-tmp)
(save-excursion
(save-restriction
(while (setq file (pop files))
- (if (bufferp file)
- (set-buffer file)
- (org-check-agenda-file file)
- (set-buffer (org-get-agenda-file-buffer file)))
- (widen)
- (setq bmp (buffer-modified-p))
- (org-refresh-category-properties)
- (setq org-todo-keywords-for-agenda
- (append org-todo-keywords-for-agenda org-todo-keywords-1))
- (setq org-done-keywords-for-agenda
- (append org-done-keywords-for-agenda org-done-keywords))
- (setq org-todo-keyword-alist-for-agenda
- (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
- (setq org-tag-alist-for-agenda
- (append org-tag-alist-for-agenda org-tag-alist))
+ (catch 'nextfile
+ (if (bufferp file)
+ (set-buffer file)
+ (org-check-agenda-file file)
+ (set-buffer (org-get-agenda-file-buffer file)))
+ (widen)
+ (setq bmp (buffer-modified-p))
+ (org-refresh-category-properties)
+ (setq org-todo-keywords-for-agenda
+ (append org-todo-keywords-for-agenda org-todo-keywords-1))
+ (setq org-done-keywords-for-agenda
+ (append org-done-keywords-for-agenda org-done-keywords))
+ (setq org-todo-keyword-alist-for-agenda
+ (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
+ (setq org-tag-alist-for-agenda
+ (append org-tag-alist-for-agenda org-tag-alist))
- (save-excursion
- (remove-text-properties (point-min) (point-max) pall)
- (when org-agenda-skip-archived-trees
+ (save-excursion
+ (remove-text-properties (point-min) (point-max) pall)
+ (when org-agenda-skip-archived-trees
+ (goto-char (point-min))
+ (while (re-search-forward rea nil t)
+ (if (org-on-heading-p t)
+ (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
(goto-char (point-min))
- (while (re-search-forward rea nil t)
- (if (org-on-heading-p t)
- (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
- (goto-char (point-min))
- (setq re (concat "^\\*+ +" org-comment-string "\\>"))
- (while (re-search-forward re nil t)
- (add-text-properties
- (match-beginning 0) (org-end-of-subtree t) pc)))
- (set-buffer-modified-p bmp))))
+ (setq re (concat "^\\*+ +" org-comment-string "\\>"))
+ (while (re-search-forward re nil t)
+ (add-text-properties
+ (match-beginning 0) (org-end-of-subtree t) pc)))
+ (set-buffer-modified-p bmp)))))
(setq org-todo-keyword-alist-for-agenda
(org-uniquify org-todo-keyword-alist-for-agenda)
org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
(matchers (plist-get opt :matchers))
(re-list org-latex-regexps)
(cnt 0) txt link beg end re e checkdir
+ executables-checked
m n block linkfile movefile ov)
;; Check if there are old images files with this prefix, and remove them
(when (file-directory-p todir)
(unless checkdir ; make sure the directory exists
(setq checkdir t)
(or (file-directory-p todir) (make-directory todir)))
+
+ (unless executables-checked
+ (org-check-external-command
+ "latex" "needed to convert LaTeX fragments to images")
+ (org-check-external-command
+ "dvipng" "needed to convert LaTeX fragments to images")
+ (setq executables-checked t))
+
(org-create-formula-image
txt movefile opt forbuffer)
(if overlays
(progn (message "Failed to create dvi file from %s" texfile) nil)
(condition-case nil
(call-process "dvipng" nil nil nil
- "-E" "-fg" fg "-bg" bg
+ "-fg" fg "-bg" bg
"-D" dpi
;;"-x" scale "-y" scale
"-T" "tight"
(org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
(org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
(org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
- (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
+ (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
+ (org-defkey org-mode-map [?\e (tab)] 'org-complete)
+ (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
+ (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
+ (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
+ (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
+ (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
;; All the other keys
(if (boundp 'narrow-map)
(org-defkey narrow-map "s" 'org-narrow-to-subtree)
(org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
+(org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
+(org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
(org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
(org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
(org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
(org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
(org-defkey org-mode-map "\C-c\C-w" 'org-refile)
(org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
-(org-defkey org-mode-map "\C-c\\" 'org-tags-sparse-tree) ; Minor-mode res.
+(org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
(org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
(org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
+(org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
(org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
(org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
(org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
(org-defkey org-mode-map "\C-c\C-e" 'org-export)
(org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
(org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
-(org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
+(org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
+(org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
+;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
(org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
(org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
(org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
(org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
(org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
+(org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
(org-defkey org-mode-map "\C-c\C-x." 'org-timer)
(org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
(define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
+(define-key org-mode-map "\C-c\C-x!" 'org-reload)
+
+(define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
+(define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
+
+(define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
+
+
(when (featurep 'xemacs)
(org-defkey org-mode-map 'button3 'popup-mode-menu))
+
+(defvar org-self-insert-command-undo-counter 0)
+
(defvar org-table-auto-blank-field) ; defined in org-table.el
(defun org-self-insert-command (N)
"Like `self-insert-command', use overwrite-mode for whitespace in tables.
If the cursor is in a table looking at whitespace, the whitespace is
overwritten, and the table is not marked as requiring realignment."
(interactive "p")
- (if (and (org-table-p)
- (progn
- ;; check if we blank the field, and if that triggers align
- (and (featurep 'org-table) org-table-auto-blank-field
- (member last-command
- '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
- (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
- ;; got extra space, this field does not determine column width
- (let (org-table-may-need-update) (org-table-blank-field))
- ;; no extra space, this field may determine column width
- (org-table-blank-field)))
- t)
- (eq N 1)
- (looking-at "[^|\n]* |"))
+ (if (and
+ (org-table-p)
+ (progn
+ ;; check if we blank the field, and if that triggers align
+ (and (featurep 'org-table) org-table-auto-blank-field
+ (member last-command
+ '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
+ (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
+ ;; got extra space, this field does not determine column width
+ (let (org-table-may-need-update) (org-table-blank-field))
+ ;; no extra space, this field may determine column width
+ (org-table-blank-field)))
+ t)
+ (eq N 1)
+ (looking-at "[^|\n]* |"))
(let (org-table-may-need-update)
(goto-char (1- (match-end 0)))
(delete-backward-char 1)
(self-insert-command N))
(setq org-table-may-need-update t)
(self-insert-command N)
- (org-fix-tags-on-the-fly)))
+ (org-fix-tags-on-the-fly)
+ (if org-self-insert-cluster-for-undo
+ (if (not (eq last-command 'org-self-insert-command))
+ (setq org-self-insert-command-undo-counter 1)
+ (if (>= org-self-insert-command-undo-counter 20)
+ (setq org-self-insert-command-undo-counter 1)
+ (and (> org-self-insert-command-undo-counter 0)
+ buffer-undo-list
+ (not (cadr buffer-undo-list)) ; remove nil entry
+ (setcdr buffer-undo-list (cddr buffer-undo-list)))
+ (setq org-self-insert-command-undo-counter
+ (1+ org-self-insert-command-undo-counter)))))))
(defun org-fix-tags-on-the-fly ()
(when (and (equal (char-after (point-at-bol)) ?*)
'delete-backward-char 'org-delete-backward-char)
(org-defkey org-mode-map "|" 'org-force-self-insert))
+(defvar org-ctrl-c-ctrl-c-hook nil
+ "Hook for functions attaching themselves to `C-c C-c'.
+This can be used to add additional functionality to the C-c C-c key which
+executes context-dependent commands.
+Each function will be called with no arguments. The function must check
+if the context is appropriate for it to act. If yes, it should do its
+thing and then return a non-nil value. If the context is wrong,
+just do nothing and return nil.")
+
+(defvar org-tab-first-hook nil
+ "Hook for functions to attach themselves to TAB.
+See `org-ctrl-c-ctrl-c-hook' for more information.
+This hook runs as the first action when TAB is pressed, even before
+`org-cycle' messes around with the `outline-regexp' to cater for
+inline tasks and plain list item folding.
+If any function in this hook returns t, not other actions like table
+field motion visibility cycling will be done.")
+
+(defvar org-tab-after-check-for-table-hook nil
+ "Hook for functions to attach themselves to TAB.
+See `org-ctrl-c-ctrl-c-hook' for more information.
+This hook runs after it has been established that the cursor is not in a
+table, but before checking if the cursor is in a headline or if global cycling
+should be done.
+If any function in this hook returns t, not other actions like visibility
+cycling will be done.")
+
+(defvar org-tab-after-check-for-cycling-hook nil
+ "Hook for functions to attach themselves to TAB.
+See `org-ctrl-c-ctrl-c-hook' for more information.
+This hook runs after it has been established that not table field motion and
+not visibility should be done because of current context. This is probably
+the place where a package like yasnippets can hook in.")
+
+(defvar org-metaleft-hook nil
+ "Hook for functions attaching themselves to `M-left'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-metaright-hook nil
+ "Hook for functions attaching themselves to `M-right'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-metaup-hook nil
+ "Hook for functions attaching themselves to `M-up'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-metadown-hook nil
+ "Hook for functions attaching themselves to `M-down'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-shiftmetaleft-hook nil
+ "Hook for functions attaching themselves to `M-S-left'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-shiftmetaright-hook nil
+ "Hook for functions attaching themselves to `M-S-right'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-shiftmetaup-hook nil
+ "Hook for functions attaching themselves to `M-S-up'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-shiftmetadown-hook nil
+ "Hook for functions attaching themselves to `M-S-down'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+(defvar org-metareturn-hook nil
+ "Hook for functions attaching themselves to `M-RET'.
+See `org-ctrl-c-ctrl-c-hook' for more information.")
+
(defun org-modifier-cursor-error ()
"Throw an error, a modified cursor command was applied in wrong context."
(error "This command is active in special context like tables, headlines or items"))
See the individual commands for more information."
(interactive)
(cond
+ ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
((org-at-table-p) (call-interactively 'org-table-delete-column))
((org-on-heading-p) (call-interactively 'org-promote-subtree))
((org-at-item-p) (call-interactively 'org-outdent-item))
See the individual commands for more information."
(interactive)
(cond
+ ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
((org-at-table-p) (call-interactively 'org-table-insert-column))
((org-on-heading-p) (call-interactively 'org-demote-subtree))
((org-at-item-p) (call-interactively 'org-indent-item))
for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
((org-at-table-p) (call-interactively 'org-table-kill-row))
((org-on-heading-p) (call-interactively 'org-move-subtree-up))
((org-at-item-p) (call-interactively 'org-move-item-up))
(t (org-modifier-cursor-error))))
+
(defun org-shiftmetadown (&optional arg)
"Move subtree down or insert table row.
Calls `org-move-subtree-down' or `org-table-insert-row' or
commands for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
((org-at-table-p) (call-interactively 'org-table-insert-row))
((org-on-heading-p) (call-interactively 'org-move-subtree-down))
((org-at-item-p) (call-interactively 'org-move-item-down))
See the individual commands for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-metaleft-hook))
((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
- ((or (org-on-heading-p) (org-region-active-p))
+ ((or (org-on-heading-p)
+ (and (org-region-active-p)
+ (save-excursion
+ (goto-char (region-beginning))
+ (org-on-heading-p))))
(call-interactively 'org-do-promote))
- ((org-at-item-p) (call-interactively 'org-outdent-item))
+ ((or (org-at-item-p)
+ (and (org-region-active-p)
+ (save-excursion
+ (goto-char (region-beginning))
+ (org-at-item-p))))
+ (call-interactively 'org-outdent-item))
(t (call-interactively 'backward-word))))
(defun org-metaright (&optional arg)
See the individual commands for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-metaright-hook))
((org-at-table-p) (call-interactively 'org-table-move-column))
- ((or (org-on-heading-p) (org-region-active-p))
+ ((or (org-on-heading-p)
+ (and (org-region-active-p)
+ (save-excursion
+ (goto-char (region-beginning))
+ (org-on-heading-p))))
(call-interactively 'org-do-demote))
- ((org-at-item-p) (call-interactively 'org-indent-item))
+ ((or (org-at-item-p)
+ (and (org-region-active-p)
+ (save-excursion
+ (goto-char (region-beginning))
+ (org-at-item-p))))
+ (call-interactively 'org-indent-item))
(t (call-interactively 'forward-word))))
(defun org-metaup (&optional arg)
for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-metaup-hook))
((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
((org-on-heading-p) (call-interactively 'org-move-subtree-up))
((org-at-item-p) (call-interactively 'org-move-item-up))
commands for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-metadown-hook))
((org-at-table-p) (call-interactively 'org-table-move-row))
((org-on-heading-p) (call-interactively 'org-move-subtree-down))
((org-at-item-p) (call-interactively 'org-move-item-down))
(call-interactively (if org-edit-timestamp-down-means-later
'org-timestamp-down 'org-timestamp-up)))
((and (not (eq org-support-shift-select 'always))
+ org-enable-priority-commands
(org-on-heading-p))
(call-interactively 'org-priority-up))
((and (not org-support-shift-select) (org-at-item-p))
(call-interactively (if org-edit-timestamp-down-means-later
'org-timestamp-up 'org-timestamp-down)))
((and (not (eq org-support-shift-select 'always))
+ org-enable-priority-commands
(org-on-heading-p))
(call-interactively 'org-priority-down))
((and (not org-support-shift-select) (org-at-item-p))
(call-interactively 'org-next-item))
((org-clocktable-try-shift 'down arg))
- (org-support-shift-select
+ (org-support-shift-select
(org-call-for-shift-select 'next-line))
(t (org-shiftselect-error))))
((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
((and (not (eq org-support-shift-select 'always))
(org-on-heading-p))
- (org-call-with-arg 'org-todo 'right))
+ (let ((org-inhibit-logging
+ (not org-treat-S-cursor-todo-selection-as-state-change))
+ (org-inhibit-blocking
+ (not org-treat-S-cursor-todo-selection-as-state-change)))
+ (org-call-with-arg 'org-todo 'right)))
((or (and org-support-shift-select
(not (eq org-support-shift-select 'always))
(org-at-item-bullet-p))
(org-at-property-p))
(call-interactively 'org-property-next-allowed-value))
((org-clocktable-try-shift 'right arg))
- (org-support-shift-select
+ (org-support-shift-select
(org-call-for-shift-select 'forward-char))
(t (org-shiftselect-error))))
((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
((and (not (eq org-support-shift-select 'always))
(org-on-heading-p))
- (org-call-with-arg 'org-todo 'left))
+ (let ((org-inhibit-logging
+ (not org-treat-S-cursor-todo-selection-as-state-change))
+ (org-inhibit-blocking
+ (not org-treat-S-cursor-todo-selection-as-state-change)))
+ (org-call-with-arg 'org-todo 'left)))
((or (and org-support-shift-select
(not (eq org-support-shift-select 'always))
(org-at-item-bullet-p))
(org-at-property-p))
(call-interactively 'org-property-previous-allowed-value))
((org-clocktable-try-shift 'left arg))
- (org-support-shift-select
+ (org-support-shift-select
(org-call-for-shift-select 'backward-char))
(t (org-shiftselect-error))))
((org-edit-fixed-width-region))
(t (call-interactively 'ffap))))
+
(defun org-ctrl-c-ctrl-c (&optional arg)
"Set tags in headline, or update according to changed information at point.
This command does many different things, depending on context:
+- If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
+ this is what we do.
+
- If the cursor is in a headline, prompt for tags and insert them
into the current line, aligned to `org-tags-column'. When called
with prefix arg, realign all tags in the current buffer.
((and (local-variable-p 'org-finish-function (current-buffer))
(fboundp org-finish-function))
(funcall org-finish-function))
+ ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
((org-at-property-p)
(call-interactively 'org-property-action))
((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
((org-at-item-checkbox-p)
(call-interactively 'org-toggle-checkbox))
((org-at-item-p)
- (call-interactively 'org-maybe-renumber-ordered-list))
+ (if arg
+ (call-interactively 'org-toggle-checkbox)
+ (call-interactively 'org-maybe-renumber-ordered-list)))
((save-excursion (beginning-of-line 1) (looking-at "#\\+BEGIN:"))
;; Dynamic block
(beginning-of-line 1)
(save-excursion (org-update-dblock)))
- ((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
+ ((save-excursion
+ (beginning-of-line 1)
+ (looking-at "[ \t]*#\\+\\([A-Z]+\\)"))
(cond
((equal (match-string 1) "TBLFM")
;; Recalculate the table before this line
; (org-restart-font-lock)
(let ((org-inhibit-startup t)) (org-mode-restart))
(message "Local setup has been refreshed"))))
+ ((org-clock-update-time-maybe))
(t (error "C-c C-c can do nothing useful at this location.")))))
(defun org-mode-restart ()
(interactive)
(cond
((bobp) (if indent (newline-and-indent) (newline)))
+ ((org-at-table-p)
+ (org-table-justify-field-maybe)
+ (call-interactively 'org-table-next-row))
+ ((and org-return-follows-link
+ (eq (get-text-property (point) 'face) 'org-link))
+ (call-interactively 'org-open-at-point))
((and (org-at-heading-p)
(looking-at
(org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
(org-show-entry)
(end-of-line 1)
(newline))
- ((org-at-table-p)
- (org-table-justify-field-maybe)
- (call-interactively 'org-table-next-row))
(t (if indent (newline-and-indent) (newline)))))
(defun org-return-indent ()
If the first line is a heading, remove the stars from all headlines
in the region.
-If the first line is a plain list item, turn all plain list items into
-headings.
+If the first line is a plain list item, turn all plain list items
+into headings.
-If the first line is a normal line, turn each and every line in the region
-into a heading.
+If the first line is a normal line, turn each and every line in the
+region into a heading.
When converting a line into a heading, the number of stars is chosen
-such that the lines become children of the current entry. However, when
-a prefix argument is given, its value determines the number of stars to add."
+such that the lines become children of the current entry. However,
+when a prefix argument is given, its value determines the number of
+stars to add."
(interactive "P")
(let (l2 l itemp beg end)
(if (org-region-active-p)
(make-string (prefix-numeric-value current-prefix-arg)
?*)
(save-excursion
- (re-search-backward org-complex-heading-regexp nil t)
- (or (match-string 1) "*"))))
- (add-stars (if nstars "" (if org-odd-levels-only "**" "*")))
+ (if (re-search-backward org-complex-heading-regexp nil t)
+ (match-string 1) ""))))
+ (add-stars (cond (nstars "")
+ ((equal stars "") "*")
+ (org-odd-levels-only "**")
+ (t "*")))
(rpl (concat stars add-stars " ")))
(while (< (setq l (1+ l)) l2)
(if itemp
See the individual commands for more information."
(interactive "P")
(cond
+ ((run-hook-with-args-until-success 'org-metareturn-hook))
((org-at-table-p)
(call-interactively 'org-table-wrap-region))
(t (call-interactively 'org-insert-heading))))
["Cut Subtree" org-cut-special (not (org-at-table-p))]
["Paste Subtree" org-paste-special (not (org-at-table-p))]
"--"
+ ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
+ "--"
["Promote Heading" org-metaleft (not (org-at-table-p))]
["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
["Demote Heading" org-metaright (not (org-at-table-p))]
; :active t :keys "C-u C-c C-x C-s"]
)
"--"
+ ("Hyperlinks"
+ ["Store Link (Global)" org-store-link t]
+ ["Find existing link to here" org-occur-link-in-agenda-files t]
+ ["Insert Link" org-insert-link t]
+ ["Follow Link" org-open-at-point t]
+ "--"
+ ["Next link" org-next-link t]
+ ["Previous link" org-previous-link t]
+ "--"
+ ["Descriptive Links"
+ (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
+ :style radio
+ :selected (member '(org-link) buffer-invisibility-spec)]
+ ["Literal Links"
+ (progn
+ (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
+ :style radio
+ :selected (not (member '(org-link) buffer-invisibility-spec))])
+ "--"
("TODO Lists"
["TODO/DONE/-" org-todo t]
("Select keyword"
"--"
["Set Priority" org-priority t]
["Priority Up" org-shiftup t]
- ["Priority Down" org-shiftdown t])
+ ["Priority Down" org-shiftdown t]
+ "--"
+ ["Get news from all feeds" org-feed-update-all t]
+ ["Go to the inbox of a feed..." org-feed-goto-inbox t]
+ ["Customize feeds" (customize-variable 'org-feed-alist) t])
("TAGS and Properties"
["Set Tags" org-set-tags-command t]
["Change tag in region" org-change-tag-in-region (org-region-active-p)]
["Insert Timer String" org-timer t]
["Insert Timer Item" org-timer-item t])
("Logging work"
- ["Clock in" org-clock-in t]
+ ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
+ ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
["Clock out" org-clock-out t]
["Clock cancel" org-clock-cancel t]
+ "--"
+ ["Mark as default task" org-clock-mark-default-task t]
+ ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
["Goto running clock" org-clock-goto t]
+ "--"
["Display times" org-clock-display t]
["Create clock table" org-clock-report t]
"--"
["TODO Tree" org-show-todo-tree t]
["Check Deadlines" org-check-deadlines t]
["Timeline" org-timeline t]
- ["Tags Tree" org-tags-sparse-tree t])
- "--"
- ("Hyperlinks"
- ["Store Link (Global)" org-store-link t]
- ["Insert Link" org-insert-link t]
- ["Follow Link" org-open-at-point t]
- "--"
- ["Next link" org-next-link t]
- ["Previous link" org-previous-link t]
- "--"
- ["Descriptive Links"
- (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
- :style radio
- :selected (member '(org-link) buffer-invisibility-spec)]
- ["Literal Links"
- (progn
- (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
- :style radio
- :selected (not (member '(org-link) buffer-invisibility-spec))])
+ ["Tags/Property tree" org-match-sparse-tree t])
"--"
["Export/Publish..." org-export t]
("LaTeX"
["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
["Modify math symbol" org-cdlatex-math-modify
(org-inside-LaTeX-fragment-p)]
+ ["Insert citation" org-reftex-citation t]
+ "--"
["Export LaTeX fragments as images"
(if (featurep 'org-exp)
(setq org-export-with-LaTeX-fragments
["Expand This Menu" org-create-customize-menu
(fboundp 'customize-menu-create)])
"--"
- ["Refresh setup" org-mode-restart t]
+ ("Refresh/Reload"
+ ["Refresh setup current buffer" org-mode-restart t]
+ ["Reload Org (after update)" org-reload t]
+ ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
))
(defun org-info (&optional node)
(defun org-require-autoloaded-modules ()
(interactive)
(mapc 'require
- '(org-agenda org-archive org-attach org-clock org-colview
- org-exp org-id org-export-latex org-publish
- org-remember org-table org-timer)))
+ '(org-agenda org-archive org-ascii org-attach org-clock org-colview
+ org-docbook org-exp org-html org-icalendar
+ org-id org-latex
+ org-publish org-remember org-table
+ org-timer org-xoxo)))
+
+;;;###autoload
+(defun org-reload (&optional uncompiled)
+ "Reload all org lisp files.
+With prefix arg UNCOMPILED, load the uncompiled versions."
+ (interactive "P")
+ (require 'find-func)
+ (let* ((file-re "^\\(org\\|orgtbl\\)\\(\\.el\\|-.*\\.el\\)")
+ (dir-org (file-name-directory (org-find-library-name "org")))
+ (dir-org-contrib (ignore-errors
+ (file-name-directory
+ (org-find-library-name "org-contribdir"))))
+ (files
+ (append (directory-files dir-org t file-re)
+ (and dir-org-contrib
+ (directory-files dir-org-contrib t file-re))))
+ (remove-re (concat (if (featurep 'xemacs)
+ "org-colview" "org-colview-xemacs")
+ "\\'")))
+ (setq files (mapcar 'file-name-sans-extension files))
+ (setq files (mapcar
+ (lambda (x) (if (string-match remove-re x) nil x))
+ files))
+ (setq files (delq nil files))
+ (mapc
+ (lambda (f)
+ (when (featurep (intern (file-name-nondirectory f)))
+ (if (and (not uncompiled)
+ (file-exists-p (concat f ".elc")))
+ (load (concat f ".elc") nil nil t)
+ (load (concat f ".el") nil nil t))))
+ files))
+ (org-version))
;;;###autoload
(defun org-customize ()
(concat (make-string i1 ?\ ) l)
l)))
+(defun org-remove-indentation (code &optional n)
+ "Remove the maximum common indentation from the lines in CODE.
+N may optionally be the number of spaces to remove."
+ (with-temp-buffer
+ (insert code)
+ (org-do-remove-indentation n)
+ (buffer-string)))
+
+(defun org-do-remove-indentation (&optional n)
+ "Remove the maximum common indentation from the buffer."
+ (untabify (point-min) (point-max))
+ (let ((min 10000) re)
+ (if n
+ (setq min n)
+ (goto-char (point-min))
+ (while (re-search-forward "^ *[^ \n]" nil t)
+ (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
+ (unless (or (= min 0) (= min 10000))
+ (setq re (format "^ \\{%d\\}" min))
+ (goto-char (point-min))
+ (while (re-search-forward re nil t)
+ (replace-match "")
+ (end-of-line 1))
+ min)))
+
(defun org-base-buffer (buffer)
"Return the base buffer of BUFFER, if it has one. Else return the buffer."
(if (not buffer)
list)))
(nreverse list)))
+(defun org-quote-vert (s)
+ "Replace \"|\" with \"\\vert\"."
+ (while (string-match "|" s)
+ (setq s (replace-match "\\vert" t t s)))
+ s)
+
+(defun org-uuidgen-p (s)
+ "Is S an ID created by UUIDGEN?"
+ (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
+
(defun org-context ()
"Return a list of contexts of the current cursor position.
If several contexts apply, all are returned.
(goto-char pos)
(org-reveal)))))))
+(defun org-occur-link-in-agenda-files ()
+ "Create a link and search for it in the agendas.
+The link is not stored in `org-stored-links', it is just created
+for the search purpose."
+ (interactive)
+ (let ((link (condition-case nil
+ (org-store-link nil)
+ (error "Unable to create a link to here"))))
+ (org-occur-in-agenda-files (regexp-quote link))))
+
(defun org-uniquify (list)
"Remove duplicate elements from LIST."
(let (res)
(nreverse rtn)))
(defun org-find-base-buffer-visiting (file)
- "Like `find-buffer-visiting' but alway return the base buffer and
+ "Like `find-buffer-visiting' but always return the base buffer and
not an indirect buffer."
- (let ((buf (find-buffer-visiting file)))
+ (let ((buf (or (get-file-buffer file)
+ (find-buffer-visiting file))))
(if buf
(or (buffer-base-buffer buf) buf)
nil)))
(interactive)
(let* ((pos (point))
(itemp (org-at-item-p))
+ (case-fold-search t)
+ (org-drawer-regexp (or org-drawer-regexp "\000"))
column bpos bcol tpos tcol bullet btype bullet-type)
;; Find the previous relevant line
(beginning-of-line 1)
(cond
((looking-at "#") (setq column 0))
((looking-at "\\*+ ") (setq column 0))
+ ((and (looking-at "[ \t]*:END:")
+ (save-excursion (re-search-backward org-drawer-regexp nil t)))
+ (save-excursion
+ (goto-char (1- (match-beginning 1)))
+ (setq column (current-column))))
+ ((and (looking-at "[ \t]+#\\+end_\\([a-z]+\\)")
+ (save-excursion
+ (re-search-backward
+ (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
+ (setq column (org-get-indentation (match-string 0))))
(t
(beginning-of-line 0)
- (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]"))
+ (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]")
+ (not (looking-at "[ \t]*:END:"))
+ (not (looking-at org-drawer-regexp)))
(beginning-of-line 0))
(cond
((looking-at "\\*+[ \t]+")
(setq column 0)
(goto-char (match-end 0))
(setq column (current-column))))
+ ((looking-at org-drawer-regexp)
+ (goto-char (1- (match-beginning 1)))
+ (setq column (current-column)))
+ ((looking-at "\\([ \t]*\\):END:")
+ (goto-char (match-end 1))
+ (setq column (current-column)))
((org-in-item-p)
(org-beginning-of-item)
(looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
(org-set-local 'comment-start-skip "^#+[ \t]*")
(org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|]")
;; The paragraph starter includes hand-formatted lists.
- (org-set-local 'paragraph-start
- "\f\\|[ ]*$\\|\\*+ \\|\f\\|[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
+ (org-set-local
+ 'paragraph-start
+ (concat
+ "\f" "\\|"
+ "[ ]*$" "\\|"
+ "\\*+ " "\\|"
+ "[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)" "\\|"
+ "[ \t]*[:|]" "\\|"
+ "\\$\\$" "\\|"
+ "\\\\\\(begin\\|end\\|[][]\\)"))
;; Inhibit auto-fill for headers, tables and fixed-width lines.
;; But only if the user has not turned off tables or fixed-width regions
(org-set-local
(end (if regionp (region-end)))
(nlines (or arg (if (and beg end) (count-lines beg end) 1)))
(case-fold-search nil)
- (re "[ \t]*\\(:\\)")
+ (re "[ \t]*\\(: \\)")
off)
(if regionp
(save-excursion
(cond
(arg
(org-move-to-column cc t)
- (insert ":\n")
+ (insert ": \n")
(forward-line -1))
((and off (looking-at re))
(replace-match "" t t nil 1))
- ((not off) (org-move-to-column cc t) (insert ":")))
+ ((not off) (org-move-to-column cc t) (insert ": ")))
(forward-line 1)))
(save-excursion
(org-back-to-heading)
(goto-char (match-end 0))
(insert org-quote-string " "))))))))
+(defun org-reftex-citation ()
+ "Use reftex-citation to insert a citation into the buffer.
+This looks for a line like
+
+#+BIBLIOGRAPHY: foo plain option:-d
+
+and derives from it that foo.bib is the bbliography file relevant
+for this document. It then installs the necessary environment for RefTeX
+to work in this buffer and calls `reftex-citation' to insert a citation
+into the buffer.
+
+Export of such citations to both LaTeX and HTML is handled by the contributed
+package org-exp-bibtex by Taru Karttunen."
+ (interactive)
+ (let ((reftex-docstruct-symbol 'rds)
+ (reftex-cite-format "\\cite{%l}")
+ rds bib)
+ (save-excursion
+ (save-restriction
+ (widen)
+ (let ((case-fold-search t)
+ (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
+ (if (not (save-excursion
+ (or (re-search-forward re nil t)
+ (re-search-backward re nil t))))
+ (error "No bibliography defined in file")
+ (setq bib (concat (match-string 1) ".bib")
+ rds (list (list 'bib bib)))))))
+ (call-interactively 'reftex-citation)))
+
;;;; Functions extending outline functionality
(defun org-beginning-of-line (&optional arg)
first attempt, and only move to after the tags when the cursor is already
beyond the end of the headline."
(interactive "P")
- (let ((pos (point)) refpos)
- (beginning-of-line 1)
+ (let ((pos (point))
+ (special (if (consp org-special-ctrl-a/e)
+ (car org-special-ctrl-a/e)
+ org-special-ctrl-a/e))
+ refpos)
+ (if (org-bound-and-true-p line-move-visual)
+ (beginning-of-visual-line 1)
+ (beginning-of-line 1))
(if (and arg (fboundp 'move-beginning-of-line))
(call-interactively 'move-beginning-of-line)
(if (bobp)
(backward-char 1)
(beginning-of-line 1))
(forward-char 1))))
- (when org-special-ctrl-a/e
+ (when special
(cond
((and (looking-at org-complex-heading-regexp)
(= (char-after (match-end 1)) ?\ ))
(setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
(point-at-eol)))
(goto-char
- (if (eq org-special-ctrl-a/e t)
+ (if (eq special t)
(cond ((> pos refpos) refpos)
((= pos (point)) refpos)
(t (point)))
(t refpos)))))
((org-at-item-p)
(goto-char
- (if (eq org-special-ctrl-a/e t)
+ (if (eq special t)
(cond ((> pos (match-end 4)) (match-end 4))
((= pos (point)) (match-end 4))
(t (point)))
first attempt, and only move to after the tags when the cursor is already
beyond the end of the headline."
(interactive "P")
- (if (or (not org-special-ctrl-a/e)
- (not (org-on-heading-p))
- arg)
- (call-interactively (if (fboundp 'move-end-of-line)
- 'move-end-of-line
- 'end-of-line))
- (let ((pos (point)))
- (beginning-of-line 1)
- (if (looking-at (org-re ".*?\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
- (if (eq org-special-ctrl-a/e t)
- (if (or (< pos (match-beginning 1))
- (= pos (match-end 0)))
- (goto-char (match-beginning 1))
- (goto-char (match-end 0)))
- (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
- (goto-char (match-end 0))
- (goto-char (match-beginning 1))))
- (call-interactively (if (fboundp 'move-end-of-line)
- 'move-end-of-line
- 'end-of-line)))))
- (org-no-warnings
- (and (featurep 'xemacs) (setq zmacs-region-stays t))))
+ (let ((special (if (consp org-special-ctrl-a/e)
+ (cdr org-special-ctrl-a/e)
+ org-special-ctrl-a/e)))
+ (if (or (not special)
+ (not (org-on-heading-p))
+ arg)
+ (call-interactively
+ (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
+ ((fboundp 'move-end-of-line) 'move-end-of-line)
+ (t 'end-of-line)))
+ (let ((pos (point)))
+ (beginning-of-line 1)
+ (if (looking-at (org-re ".*?\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
+ (if (eq special t)
+ (if (or (< pos (match-beginning 1))
+ (= pos (match-end 0)))
+ (goto-char (match-beginning 1))
+ (goto-char (match-end 0)))
+ (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
+ (goto-char (match-end 0))
+ (goto-char (match-beginning 1))))
+ (call-interactively (if (fboundp 'move-end-of-line)
+ 'move-end-of-line
+ 'end-of-line)))))
+ (org-no-warnings
+ (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
(define-key org-mode-map "\C-a" 'org-beginning-of-line)
(define-key org-mode-map "\C-e" 'org-end-of-line)
+(defun org-backward-sentence (&optional arg)
+ "Go to beginning of sentence, or beginning of table field.
+This will call `backward-sentence' or `org-table-beginning-of-field',
+depending on context."
+ (interactive "P")
+ (cond
+ ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
+ (t (call-interactively 'backward-sentence))))
+
+(defun org-forward-sentence (&optional arg)
+ "Go to end of sentence, or end of table field.
+This will call `forward-sentence' or `org-table-end-of-field',
+depending on context."
+ (interactive "P")
+ (cond
+ ((org-at-table-p) (call-interactively 'org-table-end-of-field))
+ (t (call-interactively 'forward-sentence))))
+
+(define-key org-mode-map "\M-a" 'org-backward-sentence)
+(define-key org-mode-map "\M-e" 'org-forward-sentence)
+
(defun org-kill-line (&optional arg)
"Kill line, to tags or end of line."
(interactive "P")
no special treatment. In particular, a simple `C-u' prefix will just
plainly yank the text as it is.
-\[1] Basically, the test checks if the first non-white line is a heading
+\[1] The test checks if the first non-white line is a heading
and if there are no other headings with fewer stars."
(interactive "P")
- (setq this-command 'yank)
+ (org-yank-generic 'yank arg))
+
+(defun org-yank-generic (command arg)
+ "Perform some yank-like command.
+
+This function implements the behavior described in the `org-yank'
+documentation. However, it has been generalized to work for any
+interactive command with similar behavior."
+
+ ;; pretend to be command COMMAND
+ (setq this-command command)
+
(if arg
- (call-interactively 'yank)
+ (call-interactively command)
+
(let ((subtreep ; is kill a subtree, and the yank position appropriate?
(and (org-kill-is-subtree-p)
(or (bolp)
end)
(if (and subtreep org-yank-adjusted-subtrees)
(org-paste-subtree nil nil 'for-yank)
- (call-interactively 'yank))
+ (call-interactively command))
+
(setq end (point))
(goto-char beg)
(when (and (bolp) subtreep
(error (goto-char end)))))
(when swallowp
(message
- "Yanked text not folded because that would swallow text"))
+ "Inserted text not folded because that would swallow text"))
+
(goto-char end)
(skip-chars-forward " \t\n\r")
(beginning-of-line 1)
(org-paste-subtree nil nil 'for-yank)
(push-mark beg 'nomsg)))
(t
- (call-interactively 'yank))))))
+ (call-interactively command))))))
(defun org-yank-folding-would-swallow-text (beg end)
"Would hide-subtree at BEG swallow any text after END?"
(defun org-up-heading-safe ()
"Move to the heading line of which the present line is a subheading.
This version will not throw an error. It will return the level of the
-headline found, or nil if no higher level is found."
+headline found, or nil if no higher level is found.
+
+Also, this function will be a lot faster than `outline-up-heading',
+because it relies on stars being the outline starters. This can really
+make a significant difference in outlines with very many siblings."
(let (start-level re)
(org-back-to-heading t)
(setq start-level (funcall outline-level))
(save-excursion (outline-end-of-heading) (point))
flag))))
-(defun org-forward-same-level (arg)
- "Move forward to the ARG'th subheading at same level as this one.
-Stop at the first and last subheadings of a superior heading.
-This is like outline-forward-same-level, but invisible headings are ok."
- (interactive "p")
- (org-back-to-heading t)
- (while (> arg 0)
- (let ((point-to-move-to (save-excursion
- (org-get-next-sibling))))
- (if point-to-move-to
- (progn
- (goto-char point-to-move-to)
- (setq arg (1- arg)))
- (progn
- (setq arg 0)
- (error "No following same-level heading"))))))
-
(defun org-get-next-sibling ()
"Move to next heading of the same level, and return point.
If there is no such heading, return nil.
(point))))
(defun org-end-of-subtree (&optional invisible-OK to-heading)
- ;; This is an exact copy of the original function, but it uses
+ ;; This contains an exact copy of the original function, but it uses
;; `org-back-to-heading', to make it work also in invisible
;; trees. And is uses an invisible-OK argument.
;; Under Emacs this is not needed, but the old outline.el needs this fix.
+ ;; Furthermore, when used inside Org, finding the end of a large subtree
+ ;; with many children and grandchildren etc, this can be much faster
+ ;; than the outline version.
(org-back-to-heading invisible-OK)
(let ((first t)
(level (funcall outline-level)))
- (while (and (not (eobp))
- (or first (> (funcall outline-level) level)))
- (setq first nil)
- (outline-next-heading))
+ (if (and (org-mode-p) (< level 1000))
+ ;; A true heading (not a plain list item), in Org-mode
+ ;; This means we can easily find the end by looking
+ ;; only for the right number of stars. Using a regexp to do
+ ;; this is so much faster than using a Lisp loop.
+ (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
+ (forward-char 1)
+ (and (re-search-forward re nil 'move) (beginning-of-line 1)))
+ ;; something else, do it the slow way
+ (while (and (not (eobp))
+ (or first (> (funcall outline-level) level)))
+ (setq first nil)
+ (outline-next-heading)))
(unless to-heading
(if (memq (preceding-char) '(?\n ?\^M))
- (progn
- ;; Go to end of line before heading
- (forward-char -1)
- (if (memq (preceding-char) '(?\n ?\^M))
- ;; leave blank line before heading
- (forward-char -1))))))
+ (progn
+ ;; Go to end of line before heading
+ (forward-char -1)
+ (if (memq (preceding-char) '(?\n ?\^M))
+ ;; leave blank line before heading
+ (forward-char -1))))))
(point))
+(defadvice outline-end-of-subtree (around prefer-org-version activate compile)
+ "Use Org version in org-mode, for dramatic speed-up."
+ (if (eq major-mode 'org-mode)
+ (progn
+ (org-end-of-subtree nil t)
+ (backward-char 1))
+ ad-do-it))
+
+(defun org-forward-same-level (arg &optional invisible-ok)
+ "Move forward to the arg'th subheading at same level as this one.
+Stop at the first and last subheadings of a superior heading."
+ (interactive "p")
+ (org-back-to-heading invisible-ok)
+ (org-on-heading-p)
+ (let* ((level (- (match-end 0) (match-beginning 0) 1))
+ (re (format "^\\*\\{1,%d\\} " level))
+ l)
+ (forward-char 1)
+ (while (> arg 0)
+ (while (and (re-search-forward re nil 'move)
+ (setq l (- (match-end 0) (match-beginning 0) 1))
+ (= l level)
+ (not invisible-ok)
+ (org-invisible-p))
+ (if (< l level) (setq arg 1)))
+ (setq arg (1- arg)))
+ (beginning-of-line 1)))
+
+(defun org-backward-same-level (arg &optional invisible-ok)
+ "Move backward to the arg'th subheading at same level as this one.
+Stop at the first and last subheadings of a superior heading."
+ (interactive "p")
+ (org-back-to-heading)
+ (org-on-heading-p)
+ (let* ((level (- (match-end 0) (match-beginning 0) 1))
+ (re (format "^\\*\\{1,%d\\} " level))
+ l)
+ (while (> arg 0)
+ (while (and (re-search-backward re nil 'move)
+ (setq l (- (match-end 0) (match-beginning 0) 1))
+ (= l level)
+ (not invisible-ok)
+ (org-invisible-p))
+ (if (< l level) (setq arg 1)))
+ (setq arg (1- arg)))))
+
(defun org-show-subtree ()
"Show everything after this heading at deeper levels."
(outline-flag-region
(outline-flag-region
(max (point-min) (1- (point)))
(save-excursion
- (re-search-forward
- (concat "[\r\n]\\(" outline-regexp "\\)") nil 'move)
- (or (match-beginning 1) (point-max)))
- nil))
+ (if (re-search-forward
+ (concat "[\r\n]\\(" outline-regexp "\\)") nil t)
+ (match-beginning 1)
+ (point-max)))
+ nil)
+ (org-cycle-hide-drawers 'children))
(error nil))))
-(defun org-make-options-regexp (kwds)
+(defun org-make-options-regexp (kwds &optional extra)
"Make a regular expression for keyword lines."
(concat
"^"
"#?[ \t]*\\+\\("
(mapconcat 'regexp-quote kwds "\\|")
+ (if extra (concat "\\|" extra))
"\\):[ \t]*"
- "\\(.+\\)"))
+ "\\(.*\\)"))
;; Make isearch reveal the necessary context
(defun org-isearch-end ()
;; Make flyspell not check words in links, to not mess up our keymap
(defun org-mode-flyspell-verify ()
"Don't let flyspell put overlays at active buttons."
- (not (get-text-property (point) 'keymap)))
+ (and (not (get-text-property (point) 'keymap))
+ (not (get-text-property (point) 'org-no-flyspell))))
+
+(defun org-remove-flyspell-overlays-in (beg end)
+ "Remove flyspell overlays in region."
+ (and (org-bound-and-true-p flyspell-mode)
+ (fboundp 'flyspell-delete-region-overlays)
+ (flyspell-delete-region-overlays beg end))
+ (add-text-properties beg end '(org-no-flyspell t)))
;; Make `bookmark-jump' show the jump location if it was hidden.
(eval-after-load "bookmark"
;; make tree, check each match with the callback
(org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
-
;;;; Finish up
(provide 'org)
projects / emacs.git / commitdiff