Release 5.02

This commit is contained in:
Carsten Dominik 2008-01-31 11:35:14 +01:00
parent a6ad26736b
commit 1b2e32f488
8 changed files with 3133 additions and 2210 deletions

908
org

File diff suppressed because it is too large Load Diff

1111
org.el

File diff suppressed because it is too large Load Diff

BIN
org.pdf

Binary file not shown.

380
org.texi
View File

@ -3,7 +3,7 @@
@setfilename ../info/org @setfilename ../info/org
@settitle Org Mode Manual @settitle Org Mode Manual
@set VERSION 5.01 @set VERSION 5.02
@set DATE July 2007 @set DATE July 2007
@dircategory Emacs @dircategory Emacs
@ -81,7 +81,7 @@ Software Foundation raise funds for GNU development.''
* Hyperlinks:: Notes in context * Hyperlinks:: Notes in context
* TODO items:: Every tree branch can be a TODO item * TODO items:: Every tree branch can be a TODO item
* Tags:: Tagging headlines and matching sets of tags * Tags:: Tagging headlines and matching sets of tags
* Properties:: * Properties and columns::
* Timestamps:: Assign date and time to items * Timestamps:: Assign date and time to items
* Agenda views:: Collecting information into views * Agenda views:: Collecting information into views
* Embedded LaTeX:: LaTeX fragments and formulas * Embedded LaTeX:: LaTeX fragments and formulas
@ -113,7 +113,8 @@ Document Structure
* Archiving:: Move done task trees to a different place * Archiving:: Move done task trees to a different place
* Sparse trees:: Matches embedded in context * Sparse trees:: Matches embedded in context
* Plain lists:: Additional structure within an entry * Plain lists:: Additional structure within an entry
* Drawers:: * Drawers:: Tucking stuff away
* orgstruct-mode:: Structure editing outside Org-mode
Archiving Archiving
@ -181,7 +182,7 @@ Tags
* Setting tags:: How to assign tags to a headline * Setting tags:: How to assign tags to a headline
* Tag searches:: Searching for combinations of tags * Tag searches:: Searching for combinations of tags
Properties Properties and Columns
* Property syntax:: How properties are spelled out * Property syntax:: How properties are spelled out
* Special properties:: Access to other Org-mode features * Special properties:: Access to other Org-mode features
@ -194,6 +195,11 @@ Column View
* Defining columns:: The COLUMNS format property * Defining columns:: The COLUMNS format property
* Using column view:: How to create and use column view * Using column view:: How to create and use column view
Defining Columns
* Scope of column definitions::
* Column attributes::
Timestamps Timestamps
* Time stamps:: Assigning a time to a tree entry * Time stamps:: Assigning a time to a tree entry
@ -379,7 +385,7 @@ tags etc are created dynamically when you need them.
Org-mode keeps simple things simple. When first fired up, it should Org-mode keeps simple things simple. When first fired up, it should
feel like a straightforward, easy to use outliner. Complexity is not feel like a straightforward, easy to use outliner. Complexity is not
imposed, but a large amount of functionality is available when you need imposed, but a large amount of functionality is available when you need
it. Org-mode can be used on different levels and in different ways, for it. Org-mode is a toolbox and can be used in different ways, for
example as: example as:
@example @example
@ -389,6 +395,7 @@ example as:
@r{@bullet{} TODO list editor} @r{@bullet{} TODO list editor}
@r{@bullet{} full agenda and planner with deadlines and work scheduling} @r{@bullet{} full agenda and planner with deadlines and work scheduling}
@r{@bullet{} environment to implement David Allen's GTD system} @r{@bullet{} environment to implement David Allen's GTD system}
@r{@bullet{} a basic database application}
@r{@bullet{} simple hypertext system, with HTML export} @r{@bullet{} simple hypertext system, with HTML export}
@r{@bullet{} publishing tool to create a set of interlinked webpages} @r{@bullet{} publishing tool to create a set of interlinked webpages}
@end example @end example
@ -396,7 +403,9 @@ example as:
Org-mode's automatic, context sensitive table editor with spreadsheet Org-mode's automatic, context sensitive table editor with spreadsheet
capabilities can be integrated into any major mode by activating the capabilities can be integrated into any major mode by activating the
minor Orgtbl-mode. Using a translation step, it can be used to maintain minor Orgtbl-mode. Using a translation step, it can be used to maintain
tables in arbitrary file types, for example in LaTeX. tables in arbitrary file types, for example in LaTeX. The structure
editing and list creation capabilities can be used outside Org-mode with
the minor Orgstruct-mode.
@cindex FAQ @cindex FAQ
There is a website for Org-mode which provides links to the newest There is a website for Org-mode which provides links to the newest
@ -468,9 +477,10 @@ make install-info
@iftex @iftex
@b{Important:} @i{If you use copy-and-paste to copy lisp code from the @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
PDF documentation to your .emacs file, the single quote character comes PDF documentation as viewed by Acrobat reader to your .emacs file, the
out incorrectly and the code will not work. You need to fix the single single quote character comes out incorrectly and the code will not work.
quotes by hand, or copy from Info documentation.} You need to fix the single quotes by hand, or copy from Info
documentation.}
@end iftex @end iftex
Add the following lines to your @file{.emacs} file. The last two lines Add the following lines to your @file{.emacs} file. The last two lines
@ -580,7 +590,8 @@ edit the structure of the document.
* Archiving:: Move done task trees to a different place * Archiving:: Move done task trees to a different place
* Sparse trees:: Matches embedded in context * Sparse trees:: Matches embedded in context
* Plain lists:: Additional structure within an entry * Plain lists:: Additional structure within an entry
* Drawers:: * Drawers:: Tucking stuff away
* orgstruct-mode:: Structure editing outside Org-mode
@end menu @end menu
@node Outlines, Headlines, Document structure, Document structure @node Outlines, Headlines, Document structure, Document structure
@ -1121,14 +1132,15 @@ bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}).
With prefix arg, select the nth bullet from this list. With prefix arg, select the nth bullet from this list.
@end table @end table
@node Drawers, , Plain lists, Document structure @node Drawers, orgstruct-mode, Plain lists, Document structure
@section Drawers @section Drawers
@cindex drawers @cindex drawers
@cindex visibility cycling, drawers
Sometimes you want to keep information associated with an entry, but you Sometimes you want to keep information associated with an entry, but you
normally don't want to see it, except when explicitly asking for it. normally don't want to see it. For this, Org-mode has @emph{drawers}.
For this, Org-mode has @emph{drawers}. Drawers need to be configured Drawers need to be configured with the variable @code{org-drawers}, and
with the variable @code{org-drawers}, and look like this: look like this:
@example @example
** This is a headline ** This is a headline
@ -1143,7 +1155,30 @@ Visibility cycling (@pxref{Visibility cycling}) on the headline will
hide and show the entry, but keep the drawer collapsed to a single line. 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 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 drawer line and press @key{TAB} there. Org-mode uses a drawer for
storing properties (@pxref{Properties}). storing properties (@pxref{Properties and columns}).
@node orgstruct-mode, , Drawers, Document structure
@section The Orgstruct minor mode
@cindex orgstruct-mode
@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
@lisp
(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-mode 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.
@node Tables, Hyperlinks, Document structure, Top @node Tables, Hyperlinks, Document structure, Top
@chapter Tables @chapter Tables
@ -1611,15 +1646,15 @@ line like
@end example @end example
@noindent @noindent
Also properties (@pxref{Properties}) can be used as constants in table Also properties (@pxref{Properties and columns}) can be used as
formulas: For a property @samp{:XYZ:} use the name @samp{$PROP_XYZ}, and constants in table formulas: For a property @samp{:XYZ:} use the name
the property will be searched in the current outline entry and in the @samp{$PROP_XYZ}, and the property will be searched in the current
hierarchy above it. If you have the @file{constants.el} package, it outline entry and in the hierarchy above it. If you have the
will also be used to resolve constants, including natural constants like @file{constants.el} package, it will also be used to resolve constants,
@samp{$h} for Planck's constant, and units like @samp{$km} for including natural constants like @samp{$h} for Planck's constant, and
kilometers@footnote{@file{Constant.el} can supply the values of units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
constants in two different unit systems, @code{SI} and @code{cgs}. supply the values of constants in two different unit systems, @code{SI}
Which one is used depends on the value of the variable 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 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
@code{constSI} and @code{constcgs} to set this value for the current @code{constSI} and @code{constcgs} to set this value for the current
buffer.}. Column names and parameters can be specified in special table buffer.}. Column names and parameters can be specified in special table
@ -3030,7 +3065,7 @@ back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
@end table @end table
@node Tags, Properties, TODO items, Top @node Tags, Properties and columns, TODO items, Top
@chapter Tags @chapter Tags
@cindex tags @cindex tags
@cindex headline tagging @cindex headline tagging
@ -3286,8 +3321,8 @@ instead of any TAG an expression like @samp{LEVEL=3}. For example, a
search @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines that search @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines that
have the tag BOSS and are @emph{not} marked with the todo keyword DONE. have the tag BOSS and are @emph{not} marked with the todo keyword DONE.
@node Properties, Timestamps, Tags, Top @node Properties and columns, Timestamps, Tags, Top
@chapter Properties @chapter Properties and Columns
@cindex properties @cindex properties
Properties are a set of key-value pairs associated with an entry. There Properties are a set of key-value pairs associated with an entry. There
@ -3298,7 +3333,8 @@ tags like @code{:release_1:}, @code{:release_2:}, it can be more
efficient to use a property @code{RELEASE} with a value @code{1.0} or efficient to use a property @code{RELEASE} with a value @code{1.0} or
@code{2.0}. Second, you can use properties to implement (very basic) @code{2.0}. Second, you can use properties to implement (very basic)
database capabilities in an Org-mode buffer, for example to create a database capabilities in an Org-mode buffer, for example to create a
list of Music CD's you own. list of Music CD's you own. You can edit and view properties
conveniently in column view (@pxref{Column view}).
@menu @menu
* Property syntax:: How properties are spelled out * Property syntax:: How properties are spelled out
@ -3308,8 +3344,10 @@ list of Music CD's you own.
* Property API:: Properties for Lisp programmers * Property API:: Properties for Lisp programmers
@end menu @end menu
@node Property syntax, Special properties, Properties, Properties @node Property syntax, Special properties, Properties and columns, Properties and columns
@section Property Syntax @section Property Syntax
@cindex property syntax
@cindex drawer, for properties
Properties are key-value pairs. They need to be inserted into a special Properties are key-value pairs. They need to be inserted into a special
drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
@ -3324,26 +3362,65 @@ first, and the value after it. Here is an example:
:Title: Goldberg Variations :Title: Goldberg Variations
:Composer: J.S. Bach :Composer: J.S. Bach
:Artist: Glen Gould :Artist: Glen Gould
:END: :Publisher: Deutsche Grammphon
:NDisks: 1
:END:
@end example
You may define the allowed values for a particular property @samp{XYZ}
by setting a property @samp{XYZ_ALL}. This special property is
@emph{inherited}, so if you set it in a level 1 entry, it will apply to
the entire tree. When allowed values are defined, setting the
corresponding property becomes easier and is less prone to typing
errors. For the example with the CD collection, we can predefine
publishers and the number of disks in a box like this:
@example
* CD collection
:PROPERTIES:
:NDisks_ALL: 1 2 3 4
:Publisher_ALL: "Deutsche Grammophon" Phillips EMI
:END:
@end example @end example
@noindent @noindent
The following commands help to insert properties: The following commands help to work with properties:
@table @kbd @table @kbd
@kindex M-@key{TAB} @kindex M-@key{TAB}
@item M-@key{TAB} @item M-@key{TAB}
After an initial colon in a line, complete property keys. All keys used After an initial colon in a line, complete property keys. All keys used
in the current file will be offered as possible completions. in the current file will be offered as possible completions.
@item M-x org-insert-property-drawer
Insert a property drawer into the current entry. The drawer will be
inserted early in the entry, but after the lines with planning
information like deadlines.
@kindex C-c C-c
@item C-c C-c
With the cursor in a property drawer, this executes property commands.
@item C-c C-c s
Set a property in the current entry. Both the property and the value
can be inserted using completion.
@kindex S-@key{right}
@kindex S-@key{left}
@item S-@key{left}/@key{right}
Switch property at point to the next/previous allowed value.
@item C-c C-c d
Remove a property from the current entry.
@item C-c C-c D
Globally remove a property, from all entries in the current file.
@end table @end table
@node Special properties, Property searches, Property syntax, Properties and columns
@node Special properties, Property searches, Property syntax, Properties
@section Special Properties @section Special Properties
@cindex properties, special
Several properties are special, because they can be used to access other Special properties provide alternative access method to Org-mode
features of Org-mode like the TODO status: 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}). The following
property names are special and should not be used as keys in the
properties drawer:
@example @example
TODO @r{The TODO keyword of the entry.} TODO @r{The TODO keyword of the entry.}
@ -3354,8 +3431,9 @@ DEADLINE @r{The deadline time string, without the angular brackets.}
SCHEDULED @r{The scheduling time stamp, without the angular brackets.} SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
@end example @end example
@node Property searches, Column view, Special properties, Properties @node Property searches, Column view, Special properties, Properties and columns
@section Property searches @section Property searches
@cindex properties, searching
To create sparse trees and special lists with selection based on To create sparse trees and special lists with selection based on
properties, the same commands are used as for tag searches (@pxref{Tag properties, the same commands are used as for tag searches (@pxref{Tag
@ -3371,23 +3449,23 @@ also have a priority value @samp{A}, a @samp{:coffee:} property with the
value @samp{unlimited}, and a @samp{:with:} property that is matched by value @samp{unlimited}, and a @samp{:with:} property that is matched by
the regular expression @samp{Sarah\|Denny}. the regular expression @samp{Sarah\|Denny}.
@node Column view, Property API, Property searches, Properties @node Column view, Property API, Property searches, Properties and columns
@section Column View @section Column View
If different items in a document have similar properties, it can be nice A great way to view and edit properties in aan outline tree is
to view and edit those properties in a table-like format, in @emph{column view}. In column view, each outline item is turned into a
@emph{column view}. Org-mode implements columns by overlaying a tabular table row. Columns in this table provide access to properties of the
structure over the headline of an item. So the column view does not use entries. Org-mode implements columns by overlaying a tabular structure
a special buffer, it happens in exactly the same buffer where the over the headline of each item. While the headlines have been turned
outline is, and only temporarily changes the look of this buffer - not into a table row, you can still change the visibility of the outline
the content. This has the advantage that you can still change the tree. For example, you get a compact table by switching to CONTENTS
visibility of the outline tree. For example, you get a compact table by view (@kbd{S-@key{TAB} S-@key{TAB}}, or simple @kbd{c} while column view
switching to CONTENTS view, but you can still open, read, and edit the is active), but you can still open, read, and
entry below each headline. Or, you can switch to column view after edit the entry below each headline. Or, you can switch to column view
executing a sparse tree command and in this way get a table only for the after executing a sparse tree command and in this way get a table only
selected items. Column view also works in agenda buffers (@pxref{Agenda for the selected items. Column view also works in agenda buffers
views}) where queries have collected selected items, possibly from a (@pxref{Agenda views}) where queries have collected selected items,
number of files. possibly from a number of files.
@menu @menu
* Defining columns:: The COLUMNS format property * Defining columns:: The COLUMNS format property
@ -3396,81 +3474,122 @@ number of files.
@node Defining columns, Using column view, Column view, Column view @node Defining columns, Using column view, Column view, Column view
@subsection Defining Columns @subsection Defining Columns
@cindex column view, for properties
@cindex properties, column view
Setting up a column view first requires defining the columns. A column Setting up a column view first requires defining the columns. This is
definition is a property itself and looks like this: done by defining a column format line.
@menu
* Scope of column definitions:: Where defined, where valid?
* Column attributes:: Appearance and content of a column
@end menu
@node Scope of column definitions, Column attributes, Defining columns, Defining columns
@subsubsection Scope of column definitions
To define a column format for an entire file, use a line like
@example @example
:COLUMNS: %25ITEM %TAGS %PRIORITY %TODO #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
@end example @end example
This definition means that column 1 should be the first 25 characters of To specify a format that only applies to a specific tree, add a COLUMNS
the item itself, i.e. of the headline. You probably always should start property to the top node of that tree, for example
the column definition with the ITEM specifier - just select a useful
width for it. The other specifiers create columns for the local tags,
for the priority and for the TODO state. When no width is given after
the @samp{%} character, the column will be exactly as wide as it need to
be in order to fully display all values.
If a @code{COLUMNS} property is present in an entry, it defines
columns for the entry itself, and for the entire subtree below it.
Since the column definition is part of the hierarchical structure of the
document, you can define columns on level 1 that are general enough for
all sublevels, and more specific columns further down, when you edit a deeper
part of the tree. Here is an example:
@example @example
* People ** Top node for columns view
:PROPERTIES:
:COLUMNS: %25ITEM %Name
:END:
** Family
:PROPERTIES: :PROPERTIES:
:COLUMNS: %25ITEM %Name %3Age :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
:END: :END:
*** Sam
Info about Sam, including a property list with Name and Age.
*** Sarah
Info about Sarah, including a property list with Name and Age.
** Office
:PROPERTIES:
:COLUMNS: %25ITEM %Name %Function %Salary
:END:
*** Boss
Info about the Boss, including a property list with Name,
Function and Salary (if only we knew....).
@end example @end example
Now we have defined three different sets of columns. If you switch to If a @code{COLUMNS} property is present in an entry, it defines columns
column view in the @emph{Family} section, you will get a different table for the entry itself, and for the entire subtree below it. Since the
than if you do it in the @emph{Office} section. However, if you switch column definition is part of the hierarchical structure of the document,
to column view with the cursor on the @emph{People} section, the table you can define columns on level 1 that are general enough for all
will cover all entries, but contain only the @emph{Name} column. sublevels, and more specific columns further down, when you edit a
deeper part of the tree.
If no COLUMNS property applies to a given location, Org-mode uses a @node Column attributes, , Scope of column definitions, Defining columns
default format specified in the variable @subsubsection Column attributes
@code{org-default-columns-format}. This format in particular also A column definition sets the attributes of a column. The general
applies when column view is invoked with the cursor before the first definition looks like this:
headline. You can set the default format on a per-file basis with a
line (don't forget to press @kbd{C-c C-c} to activate any changes to
this line).
@example @example
#+COLUMNS: %25ITEM ....." %[width]property[(title)][@{summary-type@}]
@end example @end example
@noindent
Except for the percent sign and the property name, all items are
optional. The individual parts have the following meaning:
@example
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.}
(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}
@r{parent nodes are computed from the children.}
@r{Supported summary types are:}
@{+@} @r{Sum numbers in this column.}
@{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
@{X@} @r{Checkbox status, [X] if all children are [X].}
@end example
@noindent
Here is an example for a complete columns definition, along with allowed
values.
@example
:COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status %10Time_Spent@{:@}
:Owner_ALL: Tammy Mark Karl Lisa Don
:Status_ALL: "In progress" "Not started yet" "Finished" ""
:Approved_ALL: "[ ]" "[X]"
@end example
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
column definition with the 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
field @samp{Approved}. When no width is given after the @samp{%}
character, the column will be exactly as wide as it needs to be in order
to fully display all values. The @samp{Approved} column does have a
modified title (@samp{Approved?}, with a question mark). Summaries will
be created for the @samp{Time_Spent} column by adding time duration
expressions like HH:MM, and for the @samp{Approved} column, by providing
an @samp{[X]} status if all children have been checked.
@node Using column view, , Defining columns, Column view @node Using column view, , Defining columns, Column view
@subsection Using Column View @subsection Using Column View
@table @kbd @table @kbd
@tsubheading{Turning column view on and off}
@kindex C-c C-x C-c @kindex C-c C-x C-c
@item C-c C-x C-c @item C-c C-x C-c
Create the column view for the local environment. This command searches Create the column view for the local environment. This command searches
the hierarchy, up from point, for a @code{COLUMNS} property that defines 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 a format. When one is found, the column view table is established for
the entire subtree. 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.
@kindex q
@item q
Exit column view.
@tsubheading{Editing values}
@item @key{left} @key{right} @key{up} @key{down} @item @key{left} @key{right} @key{up} @key{down}
Move through the column view from field to field. Move through the column view from field to field.
@kindex S-@key{left}
@kindex S-@key{right}
@item S-@key{left}/@key{right}
Switch to the next/previous allowed value of the field. For this, you
have to have specified allowed values for a property.
@kindex n
@kindex p
@itemx n / p
Same as @kbd{S-@key{left}/@key{right}}
@kindex e @kindex e
@item e @item e
Edit the property at point. For the special properties, this will Edit the property at point. For the special properties, this will
@ -3481,20 +3600,36 @@ or fast selection interface will pop up.
@item v @item v
View the full value of this property. This is useful if the width of View the full value of this property. This is useful if the width of
the column is smaller than that of the value. the column is smaller than that of the value.
@kindex q @kindex a
@item q @item a
Exit column view. Edit the list of allowed values for this property. If the list is found
in the hierarchy, the modified values is stored there. If no list is
found, the new value is stored in the first entry that is part of the
current column view.
@tsubheading{Modifying the table structure}
@kindex <
@kindex >
@item < / >
Make the column narrower/wider by one character.
@kindex S-M-@key{right}
@item S-M-@key{right}
Insert a new column, to the right of the current column.
@kindex S-M-@key{left}
@item S-M-@key{left}
Delete the current column.
@end table @end table
@node Property API, , Column view, Properties @node Property API, , Column view, Properties and columns
@section The Property API @section The Property API
@cindex properties, API
@cindex API, for properties
There is a full API for accessing and changing properties. This API can There is a full API for accessing and changing properties. This API can
be used by Emacs Lisp programs to work with properties and to implement be used by Emacs Lisp programs to work with properties and to implement
features based on them. For more information see @ref{Using the features based on them. For more information see @ref{Using the
property API}. property API}.
@node Timestamps, Agenda views, Properties, Top @node Timestamps, Agenda views, Properties and columns, Top
@chapter Timestamps @chapter Timestamps
@cindex time stamps @cindex time stamps
@cindex date stamps @cindex date stamps
@ -4604,7 +4739,9 @@ Delete other windows.
@kindex m @kindex m
@kindex y @kindex y
@item d w m y @item d w m y
Switch to day/week/month/year view. Switch to day/week/month/year view. When switching to day or week view,
this setting becomes the default for subseqent agenda commands. Since
month and year views are slow to create, the do not become the default.
@c @c
@kindex D @kindex D
@item D @item D
@ -5947,16 +6084,15 @@ skip: @r{turn on/off skipping the text before the first heading}
@chapter Publishing @chapter Publishing
@cindex publishing @cindex publishing
Org-mode includes@footnote{@file{org-publish.el} is not yet part of Org-mode includes@footnote{@file{org-publish.el} is not distributed with
Emacs, so if you are using @file{org.el} as it comes with Emacs, you Emacs 21, if you are still using Emacs 21, you need you need to download
need to download this file separately. Also make sure org.el is at this file separately.} a publishing management system that allows you to
least version 4.27.} a publishing management system configure automatic HTML conversion of @emph{projects} composed of
that allows you to configure automatic HTML conversion of interlinked org files. This system is called @emph{org-publish}. You
@emph{projects} composed of interlinked org files. This system is can also configure org-publish to automatically upload your exported
called @emph{org-publish}. You can also configure org-publish to HTML pages and related attachments, such as images and source code
automatically upload your exported HTML pages and related attachments, files, to a web server. Org-publish turns org-mode into a web-site
such as images and source code files, to a web server. Org-publish turns authoring tool.
org-mode into a web-site authoring tool.
Org-publish has been contributed to Org-mode by David O'Toole. Org-publish has been contributed to Org-mode by David O'Toole.
@ -6118,7 +6254,7 @@ respective variable for details.
When a property is given a value in org-publish-project-alist, its When a property is given a value in org-publish-project-alist, its
setting overrides the value of the corresponding user variable (if any) setting overrides the value of the corresponding user variable (if any)
during publishing. options set within a file (@pxref{Export during publishing. Options set within a file (@pxref{Export
options}), however, override everything. options}), however, override everything.
@node Publishing links, Project page index, Publishing options, Configuration @node Publishing links, Project page index, Publishing options, Configuration
@ -6445,8 +6581,8 @@ Logging TODO state changes and clock intervals (variable
logging @r{record a timestamp when an item is marked DONE} logging @r{record a timestamp when an item is marked DONE}
nologging @r{don't record when items are marked DONE} nologging @r{don't record when items are marked DONE}
lognotedone @r{record timestamp and a note when DONE} lognotedone @r{record timestamp and a note when DONE}
lognotestate @r{record timestamp, note when TODO state changes} lognotestate @r{record timestamp and a note when TODO state changes}
logrepeat @r{record a not when re-instating a repeating item} logrepeat @r{record a note when re-instating a repeating item}
nologrepeat @r{do not record when re-instating repeating item} nologrepeat @r{do not record when re-instating repeating item}
lognoteclock-out @r{record timestamp and a note when clocking out} lognoteclock-out @r{record timestamp and a note when clocking out}
@end example @end example
@ -6531,6 +6667,9 @@ default location.
If the cursor is on a @code{<<<target>>>}, update radio targets and If the cursor is on a @code{<<<target>>>}, update radio targets and
corresponding links in this buffer. corresponding links in this buffer.
@item @item
If the cursor is in a property line or at the start or end of a property
drawer, offer property commands.
@item
If the cursor is in a plain list item with a checkbox, toggle the status If the cursor is in a plain list item with a checkbox, toggle the status
of the checkbox. of the checkbox.
@item @item
@ -7289,6 +7428,7 @@ MATCH is being ignored."
@node Using the property API, , Special agenda views, Extensions and Hacking @node Using the property API, , Special agenda views, Extensions and Hacking
@section Using the property API @section Using the property API
@cindex API, for properties @cindex API, for properties
@cindex properties, API
Here is a description of the functions that can be used to work with Here is a description of the functions that can be used to work with
properties. properties.

Binary file not shown.

View File

@ -1,5 +1,5 @@
% Reference Card for Org Mode % Reference Card for Org Mode
\def\orgversionnumber{5.01} \def\orgversionnumber{5.02}
\def\versionyear{2007} % latest update \def\versionyear{2007} % latest update
\def\year{2007} % latest copyright year \def\year{2007} % latest copyright year
@ -544,6 +544,24 @@ after ``{\tt :}'', and dictionary words elsewhere.
\key{create sparse tree with matching tags}{C-c \\} \key{create sparse tree with matching tags}{C-c \\}
\key{globally (agenda) match tags at cursor}{C-c C-o} \key{globally (agenda) match tags at cursor}{C-c C-o}
\section{Properties and Column View}
\key{special commands in property lines}{C-c C-c}
\key{next/previous allowed value}{S-left/right}
\key{turn on column view}{C-c C-x C-c}
\key{quit column view}{q}
\key{next/previous allowed value}{S-left/right}
\key{next/previous allowed value}{n / p}
\key{edit value}{e}
\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{Delete current column}{M-S-left}
\section{Timestamps} \section{Timestamps}
\key{prompt for date and insert timestamp}{C-c .} \key{prompt for date and insert timestamp}{C-c .}
@ -566,6 +584,8 @@ after ``{\tt :}'', and dictionary words elsewhere.
%\key{... forward/backward one month}{M-S-LEFT/RIGT} %\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 Clocking time} {\bf Clocking time}
\key{start clock on current item}{C-c C-x C-i} \key{start clock on current item}{C-c C-x C-i}
@ -575,12 +595,6 @@ after ``{\tt :}'', and dictionary words elsewhere.
\key{remove displayed times}{C-c C-c} \key{remove displayed times}{C-c C-c}
\key{insert/update table with clock report}{C-c C-x C-r} \key{insert/update table with clock report}{C-c C-x C-r}
\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)}{` / '}
\section{Agenda Views} \section{Agenda Views}
\key{add/move current file to front of agenda}{C-c [} \key{add/move current file to front of agenda}{C-c [}
@ -648,6 +662,7 @@ To set categories, add lines like$^2$:
\key{change timestamp to today}{>} \key{change timestamp to today}{>}
\key{insert new entry into diary}{i} \key{insert new entry into diary}{i}
\newcolumn
\key{start the clock on current item (clock-in)}{I} \key{start the clock on current item (clock-in)}{I}
\key{stop the clock (clock-out)}{O} \key{stop the clock (clock-out)}{O}
\key{cancel current clock}{X} \key{cancel current clock}{X}
@ -656,7 +671,6 @@ To set categories, add lines like$^2$:
\key{Open link in current line}{C-c C-o} \key{Open link in current line}{C-c C-o}
\newcolumn
{\bf Calendar commands} {\bf Calendar commands}
\key{find agenda cursor date in calendar}{c} \key{find agenda cursor date in calendar}{c}
@ -678,6 +692,12 @@ Include Emacs diary entries into Org-mode agenda with:
(setq org-agenda-include-diary t) (setq org-agenda-include-diary t)
\endexample \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)}{` / '}
\section{Exporting and Publishing} \section{Exporting and Publishing}
Exporting creates files with extensions {\it .txt\/} and {\it .html\/} Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
@ -690,17 +710,17 @@ some other place.
\key{insert template of export options}{C-c C-x t} \key{insert template of export options}{C-c C-x t}
\key{toggle fixed width for entry or region}{C-c :} \key{toggle fixed width for entry or region}{C-c :}
{\bf HTML formatting} %{\bf HTML formatting}
\key{make words {\bf bold}}{*bold*} %\key{make words {\bf bold}}{*bold*}
\key{make words {\it italic}}{/italic/} %\key{make words {\it italic}}{/italic/}
\key{make words \underbar{underlined}}{_underlined_} %\key{make words \underbar{underlined}}{_underlined_}
\key{sub- and superscripts}{x\^{}3, J_dust} %\key{sub- and superscripts}{x\^{}3, J_dust}
\key{\TeX{}-like macros}{\\alpha, \\to} %\key{\TeX{}-like macros}{\\alpha, \\to}
\key{typeset lines in fixed width font}{start with :} %\key{typeset lines in fixed width font}{start with :}
\key{tables are exported as HTML tables}{start with |} %\key{tables are exported as HTML tables}{start with |}
\key{links become HTML links}{http:... etc} %\key{links become HTML links}{http:... etc}
\key{include html tags}{@<b>...@</b>} %\key{include html tags}{@<b>...@</b>}
%{\bf Export options} %{\bf Export options}
% %

Binary file not shown.

File diff suppressed because it is too large Load Diff