From e0070404b8b8d30e84692ec1575ff0a9fd969072 Mon Sep 17 00:00:00 2001 From: Carsten Dominik Date: Wed, 20 May 2009 15:46:32 +0200 Subject: [PATCH] Add properties to the index --- doc/org.texi | 51 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 48 insertions(+), 3 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index e1bcdc140..e88ed5ba7 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -863,6 +863,7 @@ 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 @@ -1184,6 +1185,7 @@ setting multiple archive locations in a buffer is using properties.}: #+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 @@ -2665,6 +2667,7 @@ internal structure of all links, use the menu entry @cindex links, internal @cindex targets, for links +@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 @@ -2836,6 +2839,8 @@ 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 @@ -3462,6 +3467,7 @@ necessary, define a special face and use that. @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 @@ -3491,6 +3497,7 @@ example: @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 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 @@ -3573,6 +3580,7 @@ giving you an overview of what has been done. @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 @@ -3620,6 +3628,7 @@ to a buffer: #+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 @@ -3722,6 +3731,7 @@ be updates each time the todo status of a child changes. For example: ** DONE Talk to neighbor @end example +@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 @@ -3776,6 +3786,7 @@ checked. @cindex statistics, for checkboxes @cindex checkbox statistics +@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 are present. This can give you an idea on @@ -3796,6 +3807,7 @@ whatever was changed last. Set the property @code{COOKIE_DATA} to either @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 bove it. @@ -3832,6 +3844,7 @@ This works only if the cursor is already in a plain list item @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. @@ -4204,7 +4217,7 @@ publishers and the number of disks in a box like this: If you want to set properties that can be inherited by any entry in a file, use a line like - +@cindex property: _ALL @example #+PROPERTY: NDisks_ALL 1 2 3 4 @end example @@ -4260,6 +4273,17 @@ these states into columns 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 @example TODO @r{The TODO keyword of the entry.} TAGS @r{The tags defined directly in the headline.} @@ -4337,6 +4361,7 @@ 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 @@ -4345,12 +4370,15 @@ where a @code{:COLUMNS:} property is defined is used as the starting 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 @@ -4569,6 +4597,7 @@ This is 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: +@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} @@ -5331,6 +5360,7 @@ worked on or closed during a day. @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 @@ -5811,11 +5841,13 @@ 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 +@vindex property: ATTACH_DIR_INHERIT Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the same directory for attachments as the parent. @end table @@ -6571,6 +6603,7 @@ property.}: @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. @@ -7487,6 +7520,7 @@ 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 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 @@ -7804,6 +7838,7 @@ non-comment line in the buffer. If no such line exists, or if you have 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. @@ -8352,6 +8387,7 @@ file. @table @kbd @kindex C-c C-e a @item C-c C-e a +@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 @@ -8421,6 +8457,7 @@ language, but with additional support for tables. @table @kbd @kindex C-c C-e h @item C-c C-e h +@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 @@ -8754,6 +8791,7 @@ references, the PDF output file will be fully linked. @table @kbd @kindex C-c C-e l @item C-c C-e l +@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 @@ -8835,6 +8873,7 @@ 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 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:} @@ -8922,6 +8961,7 @@ Currently DocBook exporter only supports DocBook V5.0. @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 @@ -9119,6 +9159,7 @@ 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 @@ -9150,6 +9191,9 @@ Create a single large iCalendar file from all files in @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 @@ -9739,6 +9783,7 @@ This line sets the category for the agenda file. The category applies 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 applies. @@ -11455,8 +11500,8 @@ and contributed various ideas and code snippets. @printindex ky -@node Variable and Faces Index, , Key Index, Top -@unnumbered Variable Index +@node Variable and Property Index, , Key Index, Top +@unnumbered Variable and Property 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