From 2e53d9b137e8e96efbdff2daf256bab3635d9f9f Mon Sep 17 00:00:00 2001 From: Carsten Dominik Date: Thu, 21 Jan 2010 16:15:40 +0100 Subject: [PATCH] Remove comma after means in many docstrings Stephen Eglen says these commas should not be there. --- contrib/lisp/org-depend.el | 4 +- contrib/lisp/org-export-generic.el | 2 +- contrib/lisp/org-interactive-query.el | 2 +- contrib/lisp/org-mtags.el | 2 +- contrib/lisp/org2rem.el | 12 +-- lisp/org-agenda.el | 76 +++++++-------- lisp/org-archive.el | 4 +- lisp/org-ascii.el | 4 +- lisp/org-attach.el | 2 +- lisp/org-clock.el | 6 +- lisp/org-exp.el | 48 +++++----- lisp/org-feed.el | 2 +- lisp/org-footnote.el | 8 +- lisp/org-gnus.el | 2 +- lisp/org-html.el | 12 +-- lisp/org-icalendar.el | 10 +- lisp/org-id.el | 6 +- lisp/org-indent.el | 4 +- lisp/org-inlinetask.el | 2 +- lisp/org-latex.el | 4 +- lisp/org-list.el | 8 +- lisp/org-mobile.el | 4 +- lisp/org-plot.el | 2 +- lisp/org-publish.el | 2 +- lisp/org-remember.el | 6 +- lisp/org-table.el | 24 ++--- lisp/org.el | 170 +++++++++++++++++----------------- 27 files changed, 214 insertions(+), 214 deletions(-) diff --git a/contrib/lisp/org-depend.el b/contrib/lisp/org-depend.el index 54746d6f..eb38aa03 100644 --- a/contrib/lisp/org-depend.el +++ b/contrib/lisp/org-depend.el @@ -57,7 +57,7 @@ ;; ;; 3) If the TRIGGER property contains any other words like ;; XYZ(KEYWORD), these are treated as entry id's with keywords. That -;; means, Org-mode will search for an entry with the ID property XYZ +;; means Org-mode will search for an entry with the ID property XYZ ;; and switch that entry to KEYWORD as well. ;; ;; Blocking @@ -69,7 +69,7 @@ ;; state, the current state change is blocked. ;; ;; 2) If the BLOCKER property contains any other words, these are -;; treated as entry id's. That means, Org-mode will search for an +;; treated as entry id's. That means Org-mode will search for an ;; entry with the ID property exactly equal to this word. If any ;; of these entries is not yet marked DONE, the current state change ;; will be blocked. diff --git a/contrib/lisp/org-export-generic.el b/contrib/lisp/org-export-generic.el index 7b4a30d4..42250aff 100644 --- a/contrib/lisp/org-export-generic.el +++ b/contrib/lisp/org-export-generic.el @@ -104,7 +104,7 @@ :group 'org-export) (defcustom org-export-generic-links-to-notes t - "Non-nil means, convert links to notes before the next headline. + "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-generic diff --git a/contrib/lisp/org-interactive-query.el b/contrib/lisp/org-interactive-query.el index 4fd6a188..1051e7ce 100644 --- a/contrib/lisp/org-interactive-query.el +++ b/contrib/lisp/org-interactive-query.el @@ -41,7 +41,7 @@ ;;; Agenda interactive query manipulation (defcustom org-agenda-query-selection-single-key t - "Non-nil means, query manipulation exits after first change. + "Non-nil means query manipulation exits after first change. When nil, you have to press RET to exit it. During query selection, you can toggle this flag with `C-c'. This variable can also have the value `expert'. In this case, the window diff --git a/contrib/lisp/org-mtags.el b/contrib/lisp/org-mtags.el index 2f820adf..24065520 100644 --- a/contrib/lisp/org-mtags.el +++ b/contrib/lisp/org-mtags.el @@ -105,7 +105,7 @@ :group 'org-faces) (defcustom org-mtags-prefer-muse-templates t - "Non-nil means, prefere Muse tags for structure elements. + "Non-nil means prefere Muse tags for structure elements. This is relevane when expanding the templates defined in the variable `org-structure-templates'." :group 'org-mtags diff --git a/contrib/lisp/org2rem.el b/contrib/lisp/org2rem.el index 808bd4a5..5d160dc6 100644 --- a/contrib/lisp/org2rem.el +++ b/contrib/lisp/org2rem.el @@ -115,7 +115,7 @@ all-tags All tags, including inherited ones." (const :tag "All tags, including inherited ones" all-tags)))) (defcustom org-remind-include-todo nil - "Non-nil means, export to remind files should also cover TODO items." + "Non-nil means export to remind files should also cover TODO items." :group 'org2rem :type '(choice (const :tag "None" nil) @@ -123,19 +123,19 @@ all-tags All tags, including inherited ones." (const :tag "All" all))) (defcustom org-remind-include-sexps t - "Non-nil means, export to Remind files should also cover sexp entries. + "Non-nil means export to Remind files should also cover sexp entries. These are entries like in the diary, but directly in an Org-mode file." :group 'org2rem :type 'boolean) (defcustom org-remind-deadline-over-scheduled t - "Non-nil means, use deadline as target when both deadline and + "Non-nil means use deadline as target when both deadline and scheduled present, vice-versa. Default is Non-nil." :group 'org2rem :type 'boolean) (defcustom org-remind-escape-percentage t - "Non-nil means, % will be escaped, vice-versa. Default is Non-nil." + "Non-nil means % will be escaped, vice-versa. Default is Non-nil." :group 'org2rem :type 'boolean) @@ -150,7 +150,7 @@ scheduled present, vice-versa. Default is Non-nil." :type 'number) (defcustom org-remind-suppress-last-newline nil - "Non-nil means, suppress last newline REM body. Default is nil." + "Non-nil means suppress last newline REM body. Default is nil." :group 'org2rem :type 'boolean) @@ -166,7 +166,7 @@ The text will be inserted into the DESCRIPTION field." (integer :tag "Max characters"))) (defcustom org-remind-store-UID nil - "Non-nil means, store any created UIDs in properties. + "Non-nil means store any created UIDs in properties. The Remind standard requires that all entries have a unique identifyer. 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 diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index 10e94ce9..0a7c5245 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -88,7 +88,7 @@ only needed when the text to be killed contains more than N non-white lines." (integer :tag "When more than N lines"))) (defcustom org-agenda-compact-blocks nil - "Non-nil means, make the block agenda more compact. + "Non-nil means make the block agenda more compact. This is done by leaving out unnecessary lines." :group 'org-agenda :type 'boolean) @@ -108,7 +108,7 @@ If it is a character, it will be repeated to fill the window width." :group 'org-agenda) (defcustom org-agenda-with-colors t - "Non-nil means, use colors in agenda views." + "Non-nil means use colors in agenda views." :group 'org-agenda-export :type 'boolean) @@ -149,7 +149,7 @@ variable `org-agenda-entry-text-maxlines'." :type 'integer) (defcustom org-agenda-add-entry-text-descriptive-links t - "Non-nil means, export org-links as descriptive links in agenda added text. + "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." @@ -499,20 +499,20 @@ this one will be used." :group 'org-agenda) (defvar org-agenda-archives-mode nil - "Non-nil means, the agenda will include archived items. + "Non-nil means the agenda will include archived items. If this is the symbol `trees', trees in the selected agenda scope that are marked with the ARCHIVE tag will be included anyway. When this is t, also all archive files associated with the current selection of agenda files will be included.") (defcustom org-agenda-skip-comment-trees t - "Non-nil means, skip trees that start with the COMMENT keyword. + "Non-nil means skip trees that start with the COMMENT keyword. When nil, these trees are also scanned by agenda commands." :group 'org-agenda-skip :type 'boolean) (defcustom org-agenda-todo-list-sublevels t - "Non-nil means, check also the sublevels of a TODO entry for TODO entries. + "Non-nil means check also the sublevels of a TODO entry for TODO entries. When nil, the sublevels of a TODO entry are not checked, resulting in potentially much shorter TODO lists." :group 'org-agenda-skip @@ -520,7 +520,7 @@ potentially much shorter TODO lists." :type 'boolean) (defcustom org-agenda-todo-ignore-with-date nil - "Non-nil means, don't show entries with a date in the global todo list. + "Non-nil means don't show entries with a date in the global todo list. You can use this if you prefer to mark mere appointments with a TODO keyword, 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 @@ -532,7 +532,7 @@ See also the variable `org-agenda-tags-todo-honor-ignore-options'." :type 'boolean) (defcustom org-agenda-todo-ignore-scheduled nil - "Non-nil means, don't show scheduled entries in the global todo list. + "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'. @@ -542,7 +542,7 @@ See also the variable `org-agenda-tags-todo-honor-ignore-options'." :type 'boolean) (defcustom org-agenda-todo-ignore-deadlines nil - "Non-nil means, don't show near deadline entries in the global todo list. + "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'. @@ -552,7 +552,7 @@ See also the variable `org-agenda-tags-todo-honor-ignore-options'." :type 'boolean) (defcustom org-agenda-tags-todo-honor-ignore-options nil - "Non-nil means, honor todo-list ...ignore options also in tags-todo search. + "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' @@ -617,7 +617,7 @@ entry, the rest of the entry will not be searched." :type 'boolean) (defcustom org-agenda-dim-blocked-tasks t - "Non-nil means, dim blocked tasks in the agenda display. + "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', `org-enforce-todo-checkbox-dependencies', or any other blocking @@ -639,7 +639,7 @@ will only be dimmed." (const :tag "Make invisible" invisible))) (defcustom org-timeline-show-empty-dates 3 - "Non-nil means, `org-timeline' also shows dates without an entry. + "Non-nil means `org-timeline' also shows dates without an entry. When nil, only the days which actually have entries are shown. When t, all days between the first and the last date are shown. When an integer, show also empty dates, but if there is a gap of more than @@ -661,7 +661,7 @@ N days, just insert a special line indicating the size of the gap." :type 'hook) (defcustom org-agenda-mouse-1-follows-link nil - "Non-nil means, mouse-1 on a link will follow the link in the agenda. + "Non-nil means mouse-1 on a link will follow the link in the agenda. A longer mouse click will still set point. Does not work on XEmacs. Needs to be set before org.el is loaded." :group 'org-agenda-startup @@ -673,7 +673,7 @@ Needs to be set before org.el is loaded." :type 'boolean) (defcustom org-agenda-show-outline-path t - "Non-il means, show outline path in echo area after line motion." + "Non-nil means show outline path in echo area after line motion." :group 'org-agenda-startup :type 'boolean) @@ -707,7 +707,7 @@ have been removed when this is called, as will any matches for regular expressions listed in `org-agenda-entry-text-exclude-regexps'.") (defvar org-agenda-include-inactive-timestamps nil - "Non-nil means, include inactive time stamps in agenda and timeline.") + "Non-nil means include inactive time stamps in agenda and timeline.") (defgroup org-agenda-windows nil "Options concerning the windows used by the Agenda in Org Mode." @@ -740,7 +740,7 @@ It only matters if `org-agenda-window-setup' is `reorganize-frame'." :type '(cons (number :tag "Minimum") (number :tag "Maximum"))) (defcustom org-agenda-restore-windows-after-quit nil - "Non-nil means, restore window configuration open exiting agenda. + "Non-nil means restore window configuration open exiting agenda. Before the window configuration is changed for displaying the agenda, the current status is recorded. When the agenda is exited with `q' or `x' and this option is set, the old state is restored. If @@ -757,7 +757,7 @@ Custom commands can set this variable in the options section." :type 'integer) (defcustom org-agenda-start-on-weekday 1 - "Non-nil means, start the overview always on the specified weekday. + "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. Custom commands can set this variable in the options section." @@ -766,7 +766,7 @@ Custom commands can set this variable in the options section." (integer :tag "Weekday No."))) (defcustom org-agenda-show-all-dates t - "Non-nil means, `org-agenda' shows every day in the selected range. + "Non-nil means `org-agenda' shows every day in the selected range. When nil, only the days which actually have entries are shown." :group 'org-agenda-daily/weekly :type 'boolean) @@ -840,7 +840,7 @@ This option is deprecated, it is better to define a block agenda instead." :type 'boolean) (defcustom org-agenda-repeating-timestamp-show-all t - "Non-nil means, show all occurrences of a repeating stamp in the agenda. + "Non-nil means show all occurrences of a repeating stamp in the agenda. When nil, only one occurrence is shown, either today or the nearest into the future." :group 'org-agenda-daily/weekly @@ -867,7 +867,7 @@ the agenda to display all available LOG items temporarily." :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. + "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." @@ -898,7 +898,7 @@ current display in the agenda." :type 'plist) (defcustom org-agenda-search-view-always-boolean nil - "Non-nil means, the search string is interpreted as individual parts. + "Non-nil means the search string is interpreted as individual parts. The search string for search view can either be interpreted as a phrase, or as a list of snippets that define a boolean search for a number of @@ -941,7 +941,7 @@ When nil, they may also match part of a word." :group 'org-agenda) (defcustom org-agenda-search-headline-for-time t - "Non-nil means, search headline for a time-of-day. + "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 @@ -952,7 +952,7 @@ for a time." :type 'boolean) (defcustom org-agenda-use-time-grid t - "Non-nil means, show a time grid in the agenda schedule. + "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 8:00 and 20:00). The items scheduled for a day at specific times are sorted in between these lines. @@ -1069,7 +1069,7 @@ part of an agenda sorting strategy." :type 'symbol) (defcustom org-sort-agenda-notime-is-late t - "Non-nil means, items without time are considered late. + "Non-nil means items without time are considered late. This is only relevant for sorting. When t, items which have no explicit time like 15:30 will be considered as 99:01, i.e. later than any items which do have a time. When nil, the default time is before 0:00. You can use this @@ -1079,7 +1079,7 @@ agenda entries." :type 'boolean) (defcustom org-sort-agenda-noeffort-is-high t - "Non-nil means, items without effort estimate are sorted as high effort. + "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. @@ -1218,7 +1218,7 @@ is (was)." (function)))) (defcustom org-agenda-remove-times-when-in-prefix t - "Non-nil means, remove duplicate time specifications in agenda items. + "Non-nil means remove duplicate time specifications in agenda items. When the format `org-agenda-prefix-format' contains a `%t' specifier, a time-of-day specification in a headline or diary entry is extracted and placed into the prefix. If this option is non-nil, the original specification @@ -1245,7 +1245,7 @@ When non-nil, this must be the number of minutes, e.g. 60 for one hour." (const :tag "No default duration"))) (defcustom org-agenda-show-inherited-tags t - "Non-nil means, show inherited tags in each agenda line." + "Non-nil means show inherited tags in each agenda line." :group 'org-agenda-line-format :type 'boolean) @@ -1260,7 +1260,7 @@ Nil means don't hide any tags." (string :tag "Regexp "))) (defcustom org-agenda-remove-tags nil - "Non-nil means, remove the tags from the headline copy in the agenda. + "Non-nil means remove the tags from the headline copy in the agenda. When this is the symbol `prefix', only remove tags when `org-agenda-prefix-format' contains a `%T' specifier." :group 'org-agenda-line-format @@ -1285,7 +1285,7 @@ it means that the tags should be flushright to that column. For example, (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)) (defcustom org-agenda-fontify-priorities 'cookies - "Non-nil means, highlight low and high priorities in agenda. + "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 @@ -1310,12 +1310,12 @@ or a list like `(:background \"Red\")'." :group 'org-agenda) (defcustom org-agenda-columns-show-summaries t - "Non-nil means, show summaries for columns displayed in the agenda view." + "Non-nil means show summaries for columns displayed in the agenda view." :group 'org-agenda-column-view :type 'boolean) (defcustom org-agenda-columns-remove-prefix-from-item t - "Non-nil means, remove the prefix from a headline for agenda column view. + "Non-nil means remove the prefix from a headline for agenda column view. The special ITEM field in the columns format contains the current line, with all information shown in other columns (like the TODO state or a tag). When this variable is non-nil, also the agenda prefix will be removed from @@ -1325,7 +1325,7 @@ headline can be shown in the limited width of the field." :type 'boolean) (defcustom org-agenda-columns-compute-summary-properties t - "Non-nil means, recompute all summary properties before column view. + "Non-nil means recompute all summary properties before column view. When column view in the agenda is listing properties that have a summary operator, it can go to all relevant buffers and recompute the summaries there. This can mean overhead for the agenda column view, but is necessary @@ -1336,7 +1336,7 @@ computations are current." :type 'boolean) (defcustom org-agenda-columns-add-appointments-to-effort-sum nil - "Non-nil means, the duration of an appointment will add to day effort. + "Non-nil means the duration of an appointment will add to day effort. The property to which appointment durations will be added is the one given in the option `org-effort-property'. If an appointment does not have an end time, `org-agenda-default-appointment-duration' will be used. If that @@ -1718,7 +1718,7 @@ The following commands are available: ;;; Agenda undo (defvar org-agenda-allow-remote-undo t - "Non-nil means, allow remote undo from the agenda buffer.") + "Non-nil means allow remote undo from the agenda buffer.") (defvar org-agenda-undo-list nil "List of undoable operations in the agenda since last refresh.") (defvar org-agenda-undo-has-started-in nil @@ -5400,22 +5400,22 @@ If the line does not have an effort defined, return nil." (defun org-agenda-manipulate-query-add () "Manipulate the query by adding a search term with positive selection. -Positive selection means, the term must be matched for selection of an entry." +Positive selection means the term must be matched for selection of an entry." (interactive) (org-agenda-manipulate-query ?\[)) (defun org-agenda-manipulate-query-subtract () "Manipulate the query by adding a search term with negative selection. -Negative selection means, term must not be matched for selection of an entry." +Negative selection means term must not be matched for selection of an entry." (interactive) (org-agenda-manipulate-query ?\])) (defun org-agenda-manipulate-query-add-re () "Manipulate the query by adding a search regexp with positive selection. -Positive selection means, the regexp must match for selection of an entry." +Positive selection means the regexp must match for selection of an entry." (interactive) (org-agenda-manipulate-query ?\{)) (defun org-agenda-manipulate-query-subtract-re () "Manipulate the query by adding a search regexp with negative selection. -Negative selection means, regexp must not match for selection of an entry." +Negative selection means regexp must not match for selection of an entry." (interactive) (org-agenda-manipulate-query ?\})) (defun org-agenda-manipulate-query (char) diff --git a/lisp/org-archive.el b/lisp/org-archive.el index 91241f09..6ce012a3 100644 --- a/lisp/org-archive.el +++ b/lisp/org-archive.el @@ -50,7 +50,7 @@ See `org-archive-to-archive-sibling' for more information." :type 'string) (defcustom org-archive-mark-done nil - "Non-nil means, mark entries as DONE when they are moved to the archive file. + "Non-nil means mark entries as DONE when they are moved to the archive file. This can be a string to set the keyword to use. When t, Org-mode will use the first keyword in its list that means done." :group 'org-archive @@ -60,7 +60,7 @@ use the first keyword in its list that means done." (string :tag "Use this keyword"))) (defcustom org-archive-stamp-time t - "Non-nil means, add a time stamp to entries moved to an archive file. + "Non-nil means add a time stamp to entries moved to an archive file. This variable is obsolete and has no effect anymore, instead add or remove `time' from the variable `org-archive-save-context-info'." :group 'org-archive diff --git a/lisp/org-ascii.el b/lisp/org-ascii.el index e87fc6a9..92227052 100644 --- a/lisp/org-ascii.el +++ b/lisp/org-ascii.el @@ -52,14 +52,14 @@ Org-mode file." :type '(repeat character)) (defcustom org-export-ascii-links-to-notes t - "Non-nil means, convert links to notes before the next headline. + "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) (defcustom org-export-ascii-table-keep-all-vertical-lines nil - "Non-nil means, keep all vertical lines in ASCII tables. + "Non-nil means keep all vertical lines in ASCII tables. When nil, vertical lines will be removed except for those needed for column grouping." :group 'org-export-ascii diff --git a/lisp/org-attach.el b/lisp/org-attach.el index 830bf77b..0428001b 100644 --- a/lisp/org-attach.el +++ b/lisp/org-attach.el @@ -92,7 +92,7 @@ ln create a hard link. Note that this is not supported :type 'boolean) (defcustom org-attach-allow-inheritance t - "Non-nil means, allow attachment directories be inherited." + "Non-nil means allow attachment directories be inherited." :group 'org-attach :type 'boolean) diff --git a/lisp/org-clock.el b/lisp/org-clock.el index 46e09323..e83971df 100644 --- a/lisp/org-clock.el +++ b/lisp/org-clock.el @@ -64,7 +64,7 @@ which see." (defcustom org-clock-out-when-done t "When non-nil, clock will be stopped when the clocked entry is marked DONE. DONE here means any DONE-like state. -A nil value means, clock will keep running until stopped explicitly with +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. Instead of t, this can also be a list of TODO states that should trigger clocking out." @@ -76,7 +76,7 @@ clocking out." (string :tag "TODO keyword")))) (defcustom org-clock-out-remove-zero-time-clocks nil - "Non-nil means, remove the clock line when the resulting time is zero." + "Non-nil means remove the clock line when the resulting time is zero." :group 'org-clock :type 'boolean) @@ -112,7 +112,7 @@ state to switch it to." :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." + "Non-nil means `org-clock-goto' can go to recent task if no active clock." :group 'org-clock :type 'boolean) diff --git a/lisp/org-exp.el b/lisp/org-exp.el index 35dfc11e..a18e4e9c 100644 --- a/lisp/org-exp.el +++ b/lisp/org-exp.el @@ -54,7 +54,7 @@ :group 'org-export) (defcustom org-export-allow-BIND 'confirm - "Non-nil means, allow #+BIND to define local variable values for export. + "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 @@ -67,7 +67,7 @@ use of these lines." (defvar org-export-publishing-directory nil) (defcustom org-export-show-temporary-export-buffer t - "Non-nil means, show buffer after exporting to temp buffer. + "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 @@ -76,7 +76,7 @@ is nil, the buffer remains buried also in these cases." :type 'boolean) (defcustom org-export-copy-to-kill-ring t - "Non-nil means, exported stuff will also be pushed onto the kill ring." + "Non-nil means exported stuff will also be pushed onto the kill ring." :group 'org-export-general :type 'boolean) @@ -114,7 +114,7 @@ This is without condition, so even subtrees inside that carry one of the ;; FIXME: rename, this is a general variable (defcustom org-export-html-expand t - "Non-nil means, for HTML export, treat @<...> as HTML tag. + "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. @@ -124,7 +124,7 @@ This option can also be set with the +OPTIONS line, e.g. \"@:nil\"." :type 'boolean) (defcustom org-export-with-special-strings t - "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export. + "Non-nil means interpret \"\-\", \"--\" and \"---\" for export. When this option is turned on, these strings will be exported as: Org HTML LaTeX @@ -198,7 +198,7 @@ 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. + "Non-nil means skip all text before the first headline when exporting. When nil, that text is exported as well." :group 'org-export-general :type 'boolean) @@ -214,7 +214,7 @@ This option can also be set with the +OPTIONS line, e.g. \"H:2\"." :type 'integer) (defcustom org-export-with-section-numbers t - "Non-nil means, add section numbers to headlines when exporting. + "Non-nil means add section numbers to headlines when exporting. This option can also be set with the +OPTIONS line, e.g. \"num:t\"." :group 'org-export-general @@ -241,7 +241,7 @@ The variable has two components. (string :tag "Terminator"))) (defcustom org-export-with-toc t - "Non-nil means, create a table of contents in exported files. + "Non-nil means create a table of contents in exported files. The TOC contains headlines with levels up to`org-export-headline-levels'. When an integer, include levels up to N in the toc, this may then be different from `org-export-headline-levels', but it will not be allowed @@ -263,24 +263,24 @@ or \"toc:3\"." (integer :tag "TOC to level"))) (defcustom org-export-mark-todo-in-toc nil - "Non-nil means, mark TOC lines that contain any open TODO items." + "Non-nil means mark TOC lines that contain any open TODO items." :group 'org-export-general :type 'boolean) (defcustom org-export-with-todo-keywords t - "Non-nil means, include TODO keywords in export. + "Non-nil means include TODO keywords in export. When nil, remove all these keywords from the export." :group 'org-export-general :type 'boolean) (defcustom org-export-with-priority nil - "Non-nil means, include priority cookies in export. + "Non-nil means include priority cookies in export. When nil, remove priority cookies for export." :group 'org-export-general :type 'boolean) (defcustom org-export-preserve-breaks nil - "Non-nil means, preserve all line breaks when exporting. + "Non-nil means preserve all line breaks when exporting. Normally, in HTML output paragraphs will be reformatted. In ASCII export, line breaks will always be preserved, regardless of this variable. @@ -302,7 +302,7 @@ headline Only export the headline, but skip the tree below it." (const :tag "entirely" t))) (defcustom org-export-author-info t - "Non-nil means, insert author name and email into the exported file. + "Non-nil means insert author name and email into the exported file. This option can also be set with the +OPTIONS line, e.g. \"author-info:nil\"." @@ -310,13 +310,13 @@ e.g. \"author-info:nil\"." :type 'boolean) (defcustom org-export-creator-info t - "Non-nil means, the postamble should contain a creator sentence. + "Non-nil means the postamble should contain a creator sentence. This sentence is \"HTML generated by org-mode XX in emacs XXX\"." :group 'org-export-general :type 'boolean) (defcustom org-export-time-stamp-file t - "Non-nil means, insert a time stamp into the exported file. + "Non-nil means insert a time stamp into the exported file. The time stamp shows when the file was created. This option can also be set with the +OPTIONS line, @@ -347,7 +347,7 @@ This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"." (const :tag "On" t))) (defcustom org-export-with-drawers nil - "Non-nil means, export with drawers like the property drawer. + "Non-nil means export with drawers like the property drawer. When t, all drawers are exported. This may also be a list of drawer names to export." :group 'org-export-general @@ -402,7 +402,7 @@ returning the buffer string to the backend.") :group 'org-export) (defcustom org-export-with-emphasize t - "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text. + "Non-nil means interpret *word*, /word/, and _word_ as emphasized text. If the export target supports emphasizing text, the word will be typeset in bold, italic, or underlined, respectively. Works only for single words, but you can say: I *really* *mean* *this*. @@ -421,7 +421,7 @@ This option can also be set with the +OPTIONS line, e.g. \"f:nil\"." :type 'boolean) (defcustom org-export-with-sub-superscripts t - "Non-nil means, interpret \"_\" and \"^\" for export. + "Non-nil means interpret \"_\" and \"^\" for export. When this option is turned on, you can use TeX-like syntax for sub- and superscripts. Several characters after \"_\" or \"^\" will be considered as a single item - so grouping with {} is normally not @@ -450,7 +450,7 @@ This option can also be set with the +OPTIONS line, e.g. \"^:nil\"." (const :tag "Never interpret" nil))) (defcustom org-export-with-TeX-macros t - "Non-nil means, interpret simple TeX-like macros when exporting. + "Non-nil means interpret simple TeX-like macros when exporting. For example, HTML export converts \\alpha to α and \\AA to Å. Not only real TeX macros will work here, but the standard HTML entities for math can be used as macro names as well. For a list of supported @@ -463,7 +463,7 @@ This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"." :type 'boolean) (defcustom org-export-with-LaTeX-fragments nil - "Non-nil means, convert LaTeX fragments to images when exporting to HTML. + "Non-nil means convert LaTeX fragments to images when exporting to HTML. When set, the exporter will find LaTeX environments if the \\begin line is the first non-white thing on a line. It will also find the math delimiters like $a=b$ and \\( a=b \\) for inline math, $$a=b$$ and \\[ a=b \\] for @@ -478,7 +478,7 @@ is not available on all systems." :type 'boolean) (defcustom org-export-with-fixed-width t - "Non-nil means, lines starting with \":\" will be in fixed width font. + "Non-nil means lines starting with \":\" will be in fixed width font. This can be used to have pre-formatted text, fragments of code etc. For example: : ;; Some Lisp examples @@ -517,7 +517,7 @@ This option can also be set with the +OPTIONS line, e.g. \"|:nil\"." :type 'boolean) (defcustom org-export-highlight-first-table-line t - "Non-nil means, highlight the first table line. + "Non-nil means highlight the first table line. In HTML export, this means use instead of . In tables created with table.el, this applies to the first table line. In Org-mode tables, all lines before the first horizontal separator @@ -535,8 +535,8 @@ the values of constants may be useful to have." :type 'boolean) (defcustom org-export-prefer-native-exporter-for-tables nil - "Non-nil means, always export tables created with table.el natively. -Natively means, use the HTML code generator in table.el. + "Non-nil means always export tables created with table.el natively. +Natively means use the HTML code generator in table.el. When nil, Org-mode's own HTML generator is used when possible (i.e. if the table does not use row- or column-spanning). This has the advantage, that the automatic HTML conversions for math symbols and diff --git a/lisp/org-feed.el b/lisp/org-feed.el index 358baf97..142d42db 100644 --- a/lisp/org-feed.el +++ b/lisp/org-feed.el @@ -234,7 +234,7 @@ following special escapes are valid as well: :type '(string :tag "Template")) (defcustom org-feed-save-after-adding t - "Non-nil means, save buffer after adding new feed items." + "Non-nil means save buffer after adding new feed items." :group 'org-feed :type 'boolean) diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el index 9d5e12d8..074738c0 100644 --- a/lisp/org-footnote.el +++ b/lisp/org-footnote.el @@ -91,7 +91,7 @@ of the file, followed by the collected and normalized footnotes." :type 'string) (defcustom org-footnote-define-inline nil - "Non-nil means, define footnotes inline, at reference location. + "Non-nil means define footnotes inline, at reference location. When nil, footnotes will be defined in a special section near the end of the document. When t, the [fn:label:definition] notation will be used to define the footnote at the reference position." @@ -99,7 +99,7 @@ will be used to define the footnote at the reference position." :type 'boolean) (defcustom org-footnote-auto-label t - "Non-nil means, define automatically new labels for footnotes. + "Non-nil means define automatically new labels for footnotes. Possible values are: nil prompt the user for each label @@ -116,7 +116,7 @@ plain Automatically create plain number labels like [1]" (const :tag "Create automatic [N]" plain))) (defcustom org-footnote-auto-adjust nil - "Non-nil means, automatically adjust footnotes after insert/delete. + "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 @@ -133,7 +133,7 @@ The main values of this variable can be set with in-buffer options: (const :tag "Renumber and Sort" t))) (defcustom org-footnote-fill-after-inline-note-extraction nil - "Non-nil means, fill paragraphs after extracting footnotes. + "Non-nil means fill paragraphs after extracting footnotes. When extracting inline footnotes, the lengths of lines can change a lot. When this option is set, paragraphs from which an inline footnote has been extracted will be filled again." diff --git a/lisp/org-gnus.el b/lisp/org-gnus.el index 99697961..dd357b7e 100644 --- a/lisp/org-gnus.el +++ b/lisp/org-gnus.el @@ -48,7 +48,7 @@ (defvaralias 'org-usenet-links-prefer-google 'org-gnus-prefer-web-links)) (defcustom org-gnus-prefer-web-links nil - "Non-nil means, `org-store-link' will create web links to Google groups. + "Non-nil means `org-store-link' will create web links to Google groups. When nil, Gnus will be used for such links. Using a prefix arg to the command \\[org-store-link] (`org-store-link') negates this setting for the duration of the command." diff --git a/lisp/org-html.el b/lisp/org-html.el index 57d4a469..768b345c 100644 --- a/lisp/org-html.el +++ b/lisp/org-html.el @@ -81,7 +81,7 @@ and corresponding declarations." (string :tag "Declaration"))))) (defcustom org-export-html-style-include-scripts t - "Non-nil means, include the javascript snippets in exported HTML files. + "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 @@ -153,7 +153,7 @@ 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. + "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." @@ -253,7 +253,7 @@ document title." :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'. + "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 @@ -265,7 +265,7 @@ When nil, the links still point to the plain `.org' file." :type 'boolean) (defcustom org-export-html-inline-images 'maybe - "Non-nil means, inline images into exported HTML pages. + "Non-nil means inline images into exported HTML pages. This is done using an 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 @@ -333,13 +333,13 @@ will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"." (defcustom org-export-html-table-use-header-tags-for-first-column nil - "Non-nil means, format column one in tables with header tags. + "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." + "Non-nil means add validationlink to postamble of HTML exported files." :group 'org-export-html :type '(choice (const :tag "Nothing" nil) diff --git a/lisp/org-icalendar.el b/lisp/org-icalendar.el index c8d0d0d8..e2cead83 100644 --- a/lisp/org-icalendar.el +++ b/lisp/org-icalendar.el @@ -48,7 +48,7 @@ The file name should be absolute, the file will be overwritten without warning." :type 'string) (defcustom org-icalendar-use-plain-timestamp t - "Non-nil means, make an event from every plain time stamp." + "Non-nil means make an event from every plain time stamp." :group 'org-export-icalendar :type 'boolean) @@ -104,7 +104,7 @@ all-tags All tags, including inherited ones." (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. + "Non-nil means export to iCalendar files should also cover TODO items. Valid values are: nil don't include any TODO items t include all TODO items that are not in a DONE state @@ -129,13 +129,13 @@ up in the ics file. But for normal iCalendar export, you can use this for whatever you need.") (defcustom org-icalendar-include-bbdb-anniversaries nil - "Non-nil means, a combined iCalendar files should include anniversaries. + "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. + "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) @@ -152,7 +152,7 @@ The text will be inserted into the DESCRIPTION field." (integer :tag "Max characters"))) (defcustom org-icalendar-store-UID nil - "Non-nil means, store any created UIDs in properties. + "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 diff --git a/lisp/org-id.el b/lisp/org-id.el index c5fec966..6f272874 100644 --- a/lisp/org-id.el +++ b/lisp/org-id.el @@ -123,7 +123,7 @@ to have no space characters in them." (string :tag "Prefix"))) (defcustom org-id-include-domain nil - "Non-nil means, add the domain name to new IDs. + "Non-nil means add the domain name to new IDs. This ensures global uniqueness of IDs, and is also suggested by RFC 2445 in combination with RFC 822. This is only relevant if `org-id-method' is `org'. When uuidgen is used, the domain will never @@ -135,7 +135,7 @@ people to make this necessary." :type 'boolean) (defcustom org-id-track-globally t - "Non-nil means, track IDs through files, so that links work globally. + "Non-nil means track IDs through files, so that links work globally. This work by maintaining a hash table for IDs and writing this table to disk when exiting Emacs. Because of this, it works best if you use a single Emacs process, not many. @@ -178,7 +178,7 @@ This variable is only relevant when `org-id-track-globally' is set." (file)))) (defcustom org-id-search-archives t - "Non-nil means, search also the archive files of agenda files for entries. + "Non-nil means search also the archive files of agenda files for entries. This is a possibility to reduce overhead, but it means that entries moved to the archives can no longer be found by ID. This variable is only relevant when `org-id-track-globally' is set." diff --git a/lisp/org-indent.el b/lisp/org-indent.el index c66001d6..04e776c1 100644 --- a/lisp/org-indent.el +++ b/lisp/org-indent.el @@ -67,13 +67,13 @@ it may be prettier to customize the org-indent face." :type 'character) (defcustom org-indent-mode-turns-off-org-adapt-indentation t - "Non-nil means, turning on org-indent-mode turns off indentation adaptation. + "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'." + "Non-nil means turning on `org-indent-mode' turns on `org-hide-leading-stars'." :group 'org-indent :type 'boolean) diff --git a/lisp/org-inlinetask.el b/lisp/org-inlinetask.el index d3a0e2f5..4f3d3cb8 100644 --- a/lisp/org-inlinetask.el +++ b/lisp/org-inlinetask.el @@ -94,7 +94,7 @@ the value of this variable." :type 'boolean) (defcustom org-inlinetask-export t - "Non-nil means, export inline tasks. + "Non-nil means export inline tasks. When nil, they will not be exported." :group 'org-inlinetask :type 'boolean) diff --git a/lisp/org-latex.el b/lisp/org-latex.el index ef575549..5db3beae 100644 --- a/lisp/org-latex.el +++ b/lisp/org-latex.el @@ -349,7 +349,7 @@ Defaults to \\begin{verbatim} and \\end{verbatim}." (string :tag "Close"))) (defcustom org-export-latex-listings nil - "Non-nil means, export source code using the listings package. + "Non-nil means export source code using the listings package. This package will fontify source code, possibly even with color. If you want to use this, you also need to make LaTeX use the listings package, and if you want to have color, the color @@ -451,7 +451,7 @@ This function should accept the file name as its single argument." :type '(repeat (string :tag "Extension"))) (defcustom org-export-pdf-remove-logfiles t - "Non-nil means, remove the logfiles produced by PDF production. + "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) diff --git a/lisp/org-list.el b/lisp/org-list.el index 881d9b97..a00b240a 100644 --- a/lisp/org-list.el +++ b/lisp/org-list.el @@ -125,7 +125,7 @@ the bullet in each item of he list." (regexp))) (defcustom org-empty-line-terminates-plain-lists nil - "Non-nil means, an empty line ends all plain list levels. + "Non-nil means an empty line ends all plain list levels. This is currently effective only during export. It should also have an effect for indentation and plain list folding, but it does not. When nil, empty lines are part of the preceding item." @@ -133,7 +133,7 @@ When nil, empty lines are part of the preceding item." :type 'boolean) (defcustom org-auto-renumber-ordered-lists t - "Non-nil means, automatically renumber ordered plain lists. + "Non-nil means automatically renumber ordered plain lists. Renumbering happens when the sequence have been changed with \\[org-shiftmetaup] or \\[org-shiftmetadown]. After other editing commands, use \\[org-ctrl-c-ctrl-c] to trigger renumbering." @@ -141,7 +141,7 @@ use \\[org-ctrl-c-ctrl-c] to trigger renumbering." :type 'boolean) (defcustom org-provide-checkbox-statistics t - "Non-nil means, update checkbox statistics after insert and toggle. + "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]." @@ -149,7 +149,7 @@ toggle a checkbox with \\[org-ctrl-c-ctrl-c]." :type 'boolean) (defcustom org-hierarchical-checkbox-statistics t - "Non-nil means, checkbox statistics counts only the state of direct children. + "Non-nil means checkbox statistics counts only the state of direct children. When nil, all boxes below the cookie are counted. This can be set to nil on a per-node basis using a COOKIE_DATA property with the word \"recursive\" in the value." diff --git a/lisp/org-mobile.el b/lisp/org-mobile.el index ff214ef7..809ea25e 100644 --- a/lisp/org-mobile.el +++ b/lisp/org-mobile.el @@ -47,7 +47,7 @@ directly. Directories will be search for files with the extension `.org'. In addition to this, the list may also contain the following symbols: org-agenda-files - This means, include the complete, unrestricted list of files given in + This means include the complete, unrestricted list of files given in the variable `org-agenda-files'. org-agenda-text-search-extra-files Include the files given in the variable @@ -107,7 +107,7 @@ list a list of selection key(s) as string." :type 'boolean) (defcustom org-mobile-force-mobile-change nil - "Non-nil means, force the change made on the mobile device. + "Non-nil means force the change made on the mobile device. So even if there have been changes to the computer version of the entry, force the new value set on the mobile. When nil, mark the entry from the mobile with an error message. diff --git a/lisp/org-plot.el b/lisp/org-plot.el index 95dd3c92..4cf89b01 100644 --- a/lisp/org-plot.el +++ b/lisp/org-plot.el @@ -134,7 +134,7 @@ Pass PARAMS through to `orgtbl-to-generic' when exporting TABLE." (defun org-plot/gnuplot-to-grid-data (table data-file params) "Export the data in TABLE to DATA-FILE for gnuplot. -This means, in a format appropriate for grid plotting by gnuplot. +This means in a format appropriate for grid plotting by gnuplot. PARAMS specifies which columns of TABLE should be plotted as independent and dependant variables." (interactive) diff --git a/lisp/org-publish.el b/lisp/org-publish.el index 5bcb5caa..fa9ddf0b 100644 --- a/lisp/org-publish.el +++ b/lisp/org-publish.el @@ -177,7 +177,7 @@ When nil, do no timestamp checking and always publish all files." :type 'directory) (defcustom org-publish-list-skipped-files t - "Non-nil means, show message about files *not* published." + "Non-nil means show message about files *not* published." :group 'org-publish :type 'boolean) diff --git a/lisp/org-remember.el b/lisp/org-remember.el index dfaf7d46..4a179942 100644 --- a/lisp/org-remember.el +++ b/lisp/org-remember.el @@ -54,7 +54,7 @@ :group 'org) (defcustom org-remember-store-without-prompt t - "Non-nil means, `C-c C-c' stores remember note without further prompts. + "Non-nil means `C-c C-c' stores remember note without further prompts. It then uses the file and headline specified by the template or (if the template does not specify them) by the variables `org-default-notes-file' and `org-remember-default-headline'. To force prompting anyway, use @@ -225,7 +225,7 @@ for a Remember buffer.") (define-key org-remember-mode-map "\C-c\C-k" 'org-remember-kill) (defcustom org-remember-clock-out-on-exit 'query - "Non-nil means, stop the clock when exiting a clocking remember buffer. + "Non-nil means stop the clock when exiting a clocking remember buffer. This only applies if the clock is running in the remember buffer. If the clock is not stopped, it continues to run in the storage location. Instead of nil or t, this may also be the symbol `query' to prompt the @@ -248,7 +248,7 @@ See also `org-remember-auto-remove-backup-files'." (directory :tag "Directory"))) (defcustom org-remember-auto-remove-backup-files t - "Non-nil means, remove remember backup files after successfully storage. + "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 diff --git a/lisp/org-table.el b/lisp/org-table.el index 5f99a734..49c59e35 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -49,7 +49,7 @@ (defvar constants-unit-system) (defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized) - "Non-nil means, use the optimized table editor version for `orgtbl-mode'. + "Non-nil means use the optimized table editor version for `orgtbl-mode'. In the optimized version, the table editor takes over all simple keys that normally just insert a character. In tables, the characters are inserted in a way to minimize disturbing the table structure (i.e. in overwrite mode @@ -142,14 +142,14 @@ alignment to the right border applies." :group 'org-table) (defcustom org-table-automatic-realign t - "Non-nil means, automatically re-align table when pressing TAB or RETURN. + "Non-nil means automatically re-align table when pressing TAB or RETURN. When nil, aligning is only done with \\[org-table-align], or after column removal/insertion." :group 'org-table-editing :type 'boolean) (defcustom org-table-auto-blank-field t - "Non-nil means, automatically blank table field when starting to type into it. + "Non-nil means automatically blank table field when starting to type into it. This only happens when typing immediately after a field motion command (TAB, S-TAB or RET). Only relevant when `org-enable-table-editor' is equal to `optimized'." @@ -157,7 +157,7 @@ Only relevant when `org-enable-table-editor' is equal to `optimized'." :type 'boolean) (defcustom org-table-tab-jumps-over-hlines t - "Non-nil means, tab in the last column of a table with jump over a hline. + "Non-nil means tab in the last column of a table with jump over a hline. If a horizontal separator line is following the current line, `org-table-next-field' can either create a new row before that line, or jump over the line. When this option is nil, a new line will be created before @@ -183,7 +183,7 @@ t: accept as input and present for editing" (const :tag "Convert user input, don't offer during editing" 'from))) (defcustom org-table-copy-increment t - "Non-nil means, increment when copying current field with \\[org-table-copy-down]." + "Non-nil means increment when copying current field with \\[org-table-copy-down]." :group 'org-table-calculation :type 'boolean) @@ -204,7 +204,7 @@ relies on the variables to be present in the list." :type 'plist) (defcustom org-table-formula-evaluate-inline t - "Non-nil means, TAB and RET evaluate a formula in current table field. + "Non-nil means TAB and RET evaluate a formula in current table field. If the current field starts with an equal sign, it is assumed to be a formula which should be evaluated as described in the manual and in the documentation string of the command `org-table-eval-formula'. This feature requires the @@ -215,7 +215,7 @@ the command \\[org-table-eval-formula]." :type 'boolean) (defcustom org-table-formula-use-constants t - "Non-nil means, interpret constants in formulas in tables. + "Non-nil means interpret constants in formulas in tables. A constant looks like `$c' or `$Grav' and will be replaced before evaluation by the value given in `org-table-formula-constants', or by a value obtained from the `constants.el' package." @@ -241,8 +241,8 @@ Constants can also be defined on a per-file basis using a line like (string :tag "value")))) (defcustom org-table-allow-automatic-line-recalculation t - "Non-nil means, lines marked with |#| or |*| will be recomputed automatically. -Automatically means, when TAB or RET or C-c C-c are pressed in the line." + "Non-nil means lines marked with |#| or |*| will be recomputed automatically. +Automatically means when TAB or RET or C-c C-c are pressed in the line." :group 'org-table-calculation :type 'boolean) @@ -252,7 +252,7 @@ Automatically means, when TAB or RET or C-c C-c are pressed in the line." :type 'boolean) (defcustom org-table-relative-ref-may-cross-hline t - "Non-nil means, relative formula references may cross hlines. + "Non-nil means relative formula references may cross hlines. Here are the allowed values: nil Relative references may not cross hlines. They will reference the @@ -567,7 +567,7 @@ This is being used to correctly align a single field after TAB or RET.") "List of max width of fields in each column. This is being used to correctly align a single field after TAB or RET.") (defvar org-table-formula-debug nil - "Non-nil means, debug table formulas. + "Non-nil means debug table formulas. When nil, simply write \"#ERROR\" in corrupted fields.") (make-variable-buffer-local 'org-table-formula-debug) (defvar org-table-overlay-coordinates nil @@ -2340,7 +2340,7 @@ $1-> %s\n" orig formula form0 form)) "Get a calc vector from a column, according to descriptor DESC. Optional arguments TBEG and COL can give the beginning of the table and the current column, to avoid unnecessary parsing. -HIGHLIGHT means, just highlight the range." +HIGHLIGHT means just highlight the range." (if (not (equal (string-to-char desc) ?@)) (setq desc (concat "@" desc))) (save-excursion diff --git a/lisp/org.el b/lisp/org.el index 5e1d5f6d..d89618ea 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -243,7 +243,7 @@ to add the symbol `xyz', and the package must have a call to (repeat :tag "External packages" :inline t (symbol :tag "Package")))) (defcustom org-support-shift-select nil - "Non-nil means, make shift-cursor commands select text when possible. + "Non-nil means make shift-cursor commands select text when possible. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start selecting a region, or enlarge thusly regions started in this way. @@ -291,7 +291,7 @@ is Emacs 23 only." :group 'org) (defcustom org-startup-folded t - "Non-nil means, entering Org-mode will switch to OVERVIEW. + "Non-nil means entering Org-mode will switch to OVERVIEW. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: @@ -307,14 +307,14 @@ the following lines anywhere in the buffer: (const :tag "show everything, even drawers" showeverything))) (defcustom org-startup-truncated t - "Non-nil means, entering Org-mode will set `truncate-lines'. + "Non-nil means entering Org-mode will set `truncate-lines'. This is useful since some lines containing links can be very long and uninteresting. Also tables look terrible when wrapped." :group 'org-startup :type 'boolean) (defcustom org-startup-indented nil - "Non-nil means, turn on `org-indent-mode' on startup. + "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: @@ -326,7 +326,7 @@ the following lines anywhere in the buffer: (const :tag "Globally (slow on startup in large files)" t))) (defcustom org-startup-with-beamer-mode nil - "Non-nil means, turn on `org-beamer-mode' on startup. + "Non-nil means turn on `org-beamer-mode' on startup. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: @@ -335,7 +335,7 @@ the following lines anywhere in the buffer: :type 'boolean) (defcustom org-startup-align-all-tables nil - "Non-nil means, align all tables when visiting a file. + "Non-nil means align all tables when visiting a file. This is useful when the column width in tables is forced with cookies in table fields. Such tables will look correct only after the first re-align. This can also be configured on a per-file basis by adding one of @@ -526,7 +526,7 @@ After a match, group 1 contains the repeat expression.") "Contexts for the reveal options.") (defcustom org-show-hierarchy-above '((default . t)) - "Non-nil means, show full hierarchy when revealing a location. + "Non-nil means show full hierarchy when revealing a location. Org-mode often shows locations in an org-mode file which might have been invisible before. When this is set, the hierarchy of headings above the exposed location is shown. @@ -546,7 +546,7 @@ contexts. Valid contexts are :type org-context-choice) (defcustom org-show-following-heading '((default . nil)) - "Non-nil means, show following heading when revealing a location. + "Non-nil means show following heading when revealing a location. Org-mode often shows locations in an org-mode file which might have been invisible before. When this is set, the heading following the match is shown. @@ -559,7 +559,7 @@ contexts. See `org-show-hierarchy-above' for valid contexts." :type org-context-choice) (defcustom org-show-siblings '((default . nil) (isearch t)) - "Non-nil means, show all sibling heading when revealing a location. + "Non-nil means show all sibling heading when revealing a location. Org-mode often shows locations in an org-mode file which might have been invisible before. When this is set, the sibling of the current entry heading are all made visible. If `org-show-hierarchy-above' is t, @@ -575,7 +575,7 @@ contexts. See `org-show-hierarchy-above' for valid contexts." :type org-context-choice) (defcustom org-show-entry-below '((default . nil)) - "Non-nil means, show the entry below a headline when revealing a location. + "Non-nil means show the entry below a headline when revealing a location. Org-mode often shows locations in an org-mode file which might have been invisible before. When this is set, the text below the headline that is exposed is also shown. @@ -606,7 +606,7 @@ new-frame Make a new frame each time. Note that in this case (const :tag "One dedicated frame" dedicated-frame))) (defcustom org-use-speed-commands nil - "Non-nil means, activate single letter commands at beginning of a headline. + "Non-nil means activate single letter commands at beginning of a headline. This may also be a function to test for appropriate locations where speed commands should be active." :group 'org-structure @@ -643,7 +643,7 @@ copmmands in the Help buffer using the `?' speed command." :group 'org-structure) (defcustom org-cycle-skip-children-state-if-no-children t - "Non-nil means, skip CHILDREN state in entries that don't have any." + "Non-nil means skip CHILDREN state in entries that don't have any." :group 'org-cycle :type 'boolean) @@ -680,7 +680,7 @@ Drawers can be defined on the per-file basis with a line like: :type '(repeat (string :tag "Drawer Name"))) (defcustom org-hide-block-startup nil - "Non-nil means, , entering Org-mode will fold all blocks. + "Non-nil means entering Org-mode will fold all blocks. This can also be set in on a per-file basis with #+STARTUP: hideblocks @@ -702,7 +702,7 @@ of the buffer." :type 'boolean) (defcustom org-cycle-level-after-item/entry-creation t - "Non-nil means, cycle entry level or item indentation in new empty entries. + "Non-nil means cycle entry level or item indentation in new empty entries. When the cursor is at the end of an empty headline, i.e with only stars and maybe a TODO keyword, TAB will then switch the entry to become a child, @@ -739,7 +739,7 @@ If you leave an empty line between the end of a subtree and the following headline, this empty line is hidden when the subtree is folded. Org-mode will leave (exactly) one empty line visible if the number of empty lines is equal or larger to the number given in this variable. -So the default 2 means, at least 2 empty lines after the end of a subtree +So the default 2 means at least 2 empty lines after the end of a subtree are needed to produce free space between a collapsed subtree and the following headline. @@ -780,7 +780,7 @@ the values `folded', `children', or `subtree'." :group 'org-structure) (defcustom org-odd-levels-only nil - "Non-nil means, skip even levels and only use odd levels for the outline. + "Non-nil means skip even levels and only use odd levels for the outline. This has the effect that two stars are being added/taken away in promotion/demotion commands. It also influences how levels are handled by the exporters. @@ -796,7 +796,7 @@ lines to the buffer: :type 'boolean) (defcustom org-adapt-indentation t - "Non-nil means, adapt indentation to outline node level. + "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). @@ -870,7 +870,7 @@ When t, the following will happen while the cursor is in the headline: :type 'boolean) (defcustom org-yank-folded-subtrees t - "Non-nil means, when yanking subtrees, fold them. + "Non-nil means when yanking subtrees, fold them. If the kill is a single subtree, or a sequence of subtrees, i.e. if it starts with a heading and all other headings in it are either children or siblings, then fold all the subtrees. However, do this only if no @@ -879,14 +879,14 @@ text after the yank would be swallowed into a folded tree by this action." :type 'boolean) (defcustom org-yank-adjusted-subtrees nil - "Non-nil means, when yanking subtrees, adjust the level. + "Non-nil means when yanking subtrees, adjust the level. With this setting, `org-paste-subtree' is used to insert the subtree, see this function for details." :group 'org-edit-structure :type 'boolean) (defcustom org-M-RET-may-split-line '((default . t)) - "Non-nil means, M-RET will split the line at the cursor position. + "Non-nil means M-RET will split the line at the cursor position. When nil, it will go to the end of the line before making a new line. You may also set this option in a different way for different @@ -913,7 +913,7 @@ default the value to be used for all contexts not explicitly (defcustom org-insert-heading-respect-content nil - "Non-nil means, insert new headings after the current subtree. + "Non-nil means insert new headings after the current subtree. When nil, the new heading is created directly after the current line. The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn this variable on @@ -945,8 +945,8 @@ is ignored and no empty line is inserted, to keep the list in tact." :type 'hook) (defcustom org-enable-fixed-width-editor t - "Non-nil means, lines starting with \":\" are treated as fixed-width. -This currently only means, they are never auto-wrapped. + "Non-nil means lines starting with \":\" are treated as fixed-width. +This currently only means they are never auto-wrapped. When nil, such lines will be treated like ordinary lines. See also the QUOTE keyword." :group 'org-edit-structure @@ -954,7 +954,7 @@ See also the QUOTE keyword." (defcustom org-goto-auto-isearch t - "Non-nil means, typing characters in org-goto starts incremental search." + "Non-nil means typing characters in org-goto starts incremental search." :group 'org-edit-structure :type 'boolean) @@ -964,14 +964,14 @@ See also the QUOTE keyword." :group 'org-structure) (defcustom org-highlight-sparse-tree-matches t - "Non-nil means, highlight all matches that define a sparse tree. + "Non-nil means highlight all matches that define a sparse tree. The highlights will automatically disappear the next time the buffer is changed by an edit command." :group 'org-sparse-trees :type 'boolean) (defcustom org-remove-highlights-with-change t - "Non-nil means, any change to the buffer will remove temporary highlights. + "Non-nil means any change to the buffer will remove temporary highlights. Such highlights are created by `org-occur' and `org-clock-display'. When nil, `C-c C-c needs to be used to get rid of the highlights. The highlights created by `org-preview-latex-fragment' always need @@ -1005,7 +1005,7 @@ This also applied for speedbar access." :group 'org) (defcustom org-enable-table-editor 'optimized - "Non-nil means, lines starting with \"|\" are handled by the table editor. + "Non-nil means lines starting with \"|\" are handled by the table editor. When nil, such lines will be treated like ordinary lines. When equal to the symbol `optimized', the table editor will be optimized to @@ -1044,7 +1044,7 @@ This is configurable, because there is some impact on typing performance." :type 'boolean) (defcustom org-table-tab-recognizes-table.el t - "Non-nil means, TAB will automatically notice a table.el table. + "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 - calls `table-recognize-table'." :group 'org-table-editing @@ -1089,7 +1089,7 @@ See the manual for examples." (function))))) (defcustom org-descriptive-links t - "Non-nil means, hide link part and only show description of bracket links. + "Non-nil means hide link part and only show description of bracket links. Bracket links are like [[link][description]]. This variable sets the initial state in new org-mode buffers. The setting can then be toggled on a per-buffer basis from the Org->Hyperlinks menu." @@ -1186,7 +1186,7 @@ It should match if the message is from the user him/herself." :type 'regexp) (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. + "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, so please customize `org-modules' and turn it on. @@ -1226,7 +1226,7 @@ nil Never use an ID to make a link, instead link using a text search for (const :tag "Do not use ID to create link" nil))) (defcustom org-context-in-file-links t - "Non-nil means, file links from `org-store-link' contain context. + "Non-nil means file links from `org-store-link' contain context. A search string will be added to the file name with :: as separator and used to find the context when the link is activated by the command `org-open-at-point'. @@ -1236,7 +1236,7 @@ negates this setting for the duration of the command." :type 'boolean) (defcustom org-keep-stored-link-after-insertion nil - "Non-nil means, keep link in list for entire session. + "Non-nil means keep link in list for entire session. The command `org-store-link' adds a link pointing to the current location to an internal list. These links accumulate during a session. @@ -1273,7 +1273,7 @@ links created by planner." :type 'hook) (defcustom org-tab-follows-link nil - "Non-nil means, on links TAB will follow the link. + "Non-nil means on links TAB will follow the link. 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." @@ -1281,14 +1281,14 @@ implementation is bad." :type 'boolean) (defcustom org-return-follows-link nil - "Non-nil means, on links RET will follow the link. + "Non-nil means on links RET will follow the link. Needs to be set before org.el is loaded." :group 'org-link-follow :type 'boolean) (defcustom org-mouse-1-follows-link (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t) - "Non-nil means, mouse-1 on a link will follow the link. + "Non-nil means mouse-1 on a link will follow the link. A longer mouse click will still set point. Does not work on XEmacs. Needs to be set before org.el is loaded." :group 'org-link-follow @@ -1341,7 +1341,7 @@ another window." (const find-file-other-frame))))) (defcustom org-display-internal-link-with-indirect-buffer nil - "Non-nil means, use indirect buffer to display infile links. + "Non-nil means use indirect buffer to display infile links. Activating internal links (from one location in a file to another location in the same file) normally just jumps to the location. When the link is activated with a C-u prefix (or with mouse-3), the link is displayed in @@ -1352,7 +1352,7 @@ changes to the current buffer." :type 'boolean) (defcustom org-open-non-existing-files nil - "Non-nil means, `org-open-file' will open non-existing files. + "Non-nil means `org-open-file' will open non-existing files. 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 @@ -1361,7 +1361,7 @@ will be opened in Emacs, the variable is ignored." :type 'boolean) (defcustom org-open-directory-means-index-dot-org nil - "Non-nil means, a link to a directory really means to index.org. + "Non-nil means a link to a directory really means to index.org. When nil, following a directory link will run dired or open a finder/explorer window on that directory." :group 'org-link-follow @@ -1381,7 +1381,7 @@ if one was given like in ." (cons :tag "other" (function) (repeat :tag "argument" sexp)))) (defcustom org-confirm-shell-link-function 'yes-or-no-p - "Non-nil means, ask for confirmation before executing shell links. + "Non-nil means ask for confirmation before executing shell links. Shell links can be dangerous: just think about a link [[shell:rm -rf ~/*][Google Search]] @@ -1398,7 +1398,7 @@ single keystroke rather than having to type \"yes\"." (const :tag "no confirmation (dangerous)" nil))) (defcustom org-confirm-elisp-link-function 'yes-or-no-p - "Non-nil means, ask for confirmation before executing Emacs Lisp links. + "Non-nil means ask for confirmation before executing Emacs Lisp links. Elisp links can be dangerous: just think about a link [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]] @@ -1572,7 +1572,7 @@ outline-path-completion Headlines in the current buffer are offered via :type 'integer) (defcustom org-reverse-note-order nil - "Non-nil means, store new notes at the beginning of a file or entry. + "Non-nil means store new notes at the beginning of a file or entry. When nil, new notes will be filed to the end of a file or entry. This can also be a list with cons cells of regular expressions that are matched against file names, and values." @@ -1590,7 +1590,7 @@ This is list of cons cells. Each cell contains: - a specification of the files to be considered, either a list of files, or a symbol whose function or variable value will be used to retrieve 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 + that, all agenda files will be scanned for targets. Nil means consider headings in the current buffer. - A specification of how to find candidate refile targets. This may be any of: @@ -1642,7 +1642,7 @@ of the subtree." :type 'function) (defcustom org-refile-use-outline-path nil - "Non-nil means, provide refile targets as paths. + "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) @@ -1658,7 +1658,7 @@ the file name, to get entries inserted as top level in the file. (const :tag "Start with full file path" full-file-path))) (defcustom org-outline-path-complete-in-steps t - "Non-nil means, complete the outline path in hierarchical steps. + "Non-nil means complete the outline path in hierarchical steps. When Org-mode uses the refile interface to select an outline path \(see variable `org-refile-use-outline-path'), the completion of the path can be done is a single go, or if can be done in steps down @@ -1670,7 +1670,7 @@ fast, while still showing the whole path to the entry." :type 'boolean) (defcustom org-refile-allow-creating-parent-nodes nil - "Non-nil means, allow to create new nodes as refile targets. + "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) @@ -1806,7 +1806,7 @@ more information." (const type))) (defcustom org-use-fast-todo-selection t - "Non-nil means, use the fast todo selection scheme with C-c C-t. + "Non-nil means use the fast todo selection scheme with C-c C-t. This variable describes if and under what circumstances the cycling mechanism for TODO keywords will be replaced by a single-key, direct selection scheme. @@ -1830,7 +1830,7 @@ by a letter in parenthesis, like TODO(t)." (const :tag "Only with C-u C-c C-t" prefix))) (defcustom org-provide-todo-statistics t - "Non-nil means, update todo statistics after insert and toggle. + "Non-nil means update todo statistics after insert and toggle. 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 @@ -1847,7 +1847,7 @@ current entry each time a todo state is changed." (other :tag "No TODO statistics" nil))) (defcustom org-hierarchical-todo-statistics t - "Non-nil means, TODO statistics covers just direct children. + "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. To set this to nil for only a single subtree, use a COOKIE_DATA @@ -1892,7 +1892,7 @@ TODO state changes :to new state, like in :from") (defcustom org-enforce-todo-dependencies nil - "Non-nil means, undone TODO entries will block switching the parent to DONE. + "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, @@ -1911,7 +1911,7 @@ to change is while Emacs is running is through the customize interface." :type 'boolean) (defcustom org-enforce-todo-checkbox-dependencies nil - "Non-nil means, unchecked boxes will block switching the parent to DONE. + "Non-nil means unchecked boxes will block switching the parent to DONE. When this is nil, checkboxes have no influence on switching TODO states. When non-nil, you first need to check off all check boxes before the TODO entry can be switched to DONE. @@ -1929,7 +1929,7 @@ to change is while Emacs is running is through the customize interface." :type 'boolean) (defcustom org-treat-insert-todo-heading-as-state-change nil - "Non-nil means, inserting a TODO heading is treated as state change. + "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." @@ -1937,7 +1937,7 @@ be inserted directly, and no logging will take place." :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. + "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." @@ -2041,7 +2041,7 @@ property to one or more of these keywords." (const :tag "Record timestamp with note." note))) (defcustom org-log-note-clock-out nil - "Non-nil means, record a note when clocking out of an item. + "Non-nil means record a note when clocking out of an item. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: @@ -2052,7 +2052,7 @@ the following lines anywhere in the buffer: :type 'boolean) (defcustom org-log-done-with-time t - "Non-nil means, the CLOSED time stamp will contain date and time. + "Non-nil means the CLOSED time stamp will contain date and time. When nil, only the date will be recorded." :group 'org-progress :type 'boolean) @@ -2096,7 +2096,7 @@ agenda log mode depends on the format of these entries." (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. + "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. @@ -2132,7 +2132,7 @@ used instead of the default value." (t p)))) (defcustom org-log-state-notes-insert-after-drawers nil - "Non-nil means, insert state change notes after any drawers in entry. + "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 @@ -2145,14 +2145,14 @@ set." :type 'boolean) (defcustom org-log-states-order-reversed t - "Non-nil means, the latest state change note will be directly after heading. + "Non-nil means the latest state change note will be directly after heading. When nil, the notes will be orderer according to time." :group 'org-todo :group 'org-progress :type 'boolean) (defcustom org-log-repeat 'time - "Non-nil means, record moving through the DONE state when triggering repeat. + "Non-nil means record moving through the DONE state when triggering repeat. An auto-repeating task is immediately switched back to TODO when marked DONE. If you are not logging state changes (by adding \"@\" or \"!\" to the TODO keyword definition), or set `org-log-done' to @@ -2185,7 +2185,7 @@ property to one or more of these keywords." :group 'org-todo) (defcustom org-enable-priority-commands t - "Non-nil means, priority commands are active. + "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 @@ -2210,7 +2210,7 @@ This is the priority an item get if no explicit priority is given." :type 'character) (defcustom org-priority-start-cycle-with-default t - "Non-nil means, start with default priority when starting to cycle. + "Non-nil means start with default priority when starting to cycle. When this is nil, the first step in the cycle will be (depending on the command used) one higher or lower that the default priority." :group 'org-priorities @@ -2222,7 +2222,7 @@ command used) one higher or lower that the default priority." :group 'org) (defcustom org-insert-labeled-timestamps-at-point nil - "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point. + "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point. When nil, these labeled time stamps are forces into the second line of an entry, just after the headline. When scheduling from the global TODO list, the time stamp will always be forced into the second line." @@ -2263,7 +2263,7 @@ of minutes to shift." org-time-stamp-rounding-minutes))) (defcustom org-display-custom-times nil - "Non-nil means, overlay custom formats over all time stamps. + "Non-nil means overlay custom formats over all time stamps. The formats are defined through the variable `org-time-stamp-custom-formats'. To turn this on on a per-file basis, insert anywhere in the file: #+STARTUP: customtime" @@ -2320,7 +2320,7 @@ Custom commands can set this variable in the options section." :type 'integer) (defcustom org-read-date-prefer-future t - "Non-nil means, assume future for incomplete date input from user. + "Non-nil means assume future for incomplete date input from user. This affects the following situations: 1. The user gives a month but not a year. For example, if it is april and you enter \"feb 2\", this will be read @@ -2347,13 +2347,13 @@ used as defaults." (const :tag "Check month, day, and time" time))) (defcustom org-read-date-display-live t - "Non-nil means, display current interpretation of date prompt live. + "Non-nil means display current interpretation of date prompt live. This display will be in an overlay, in the minibuffer." :group 'org-time :type 'boolean) (defcustom org-read-date-popup-calendar t - "Non-nil means, pop up a calendar when prompting for a date. + "Non-nil means pop up a calendar when prompting for a date. In the calendar, the date can be selected with mouse-1. However, the minibuffer will also be active, and you can simply enter the date as well. When nil, only the minibuffer will be available." @@ -2386,13 +2386,13 @@ be the favorite working time of John Wiegley :-)" :type 'integer) (defcustom org-edit-timestamp-down-means-later nil - "Non-nil means, S-down will increase the time in a time stamp. + "Non-nil means S-down will increase the time in a time stamp. When nil, S-up will increase." :group 'org-time :type 'boolean) (defcustom org-calendar-follow-timestamp-change t - "Non-nil means, make the calendar window follow timestamp changes. + "Non-nil means make the calendar window follow timestamp changes. When a timestamp is modified and the calendar window is visible, it will be moved to the new date." :group 'org-time @@ -2465,7 +2465,7 @@ says they should be. This variable is populated from #+FILETAGS lines.") (defcustom org-use-fast-tag-selection 'auto - "Non-nil means, use fast tag selection scheme. + "Non-nil means use fast tag selection scheme. This is a special interface to select and deselect tags with single keys. When nil, fast selection is never used. When the symbol `auto', fast selection is used if and only if selection @@ -2480,7 +2480,7 @@ automatically if necessary." (const :tag "When selection characters are configured" 'auto))) (defcustom org-fast-tag-selection-single-key nil - "Non-nil means, fast tag selection exits after first change. + "Non-nil means fast tag selection exits after first change. When nil, you have to press RET to exit it. During fast tag selection, you can toggle this flag with `C-c'. This variable can also have the value `expert'. In this case, the window @@ -2492,7 +2492,7 @@ displaying the tags menu is not even shown, until you press C-c again." (const :tag "Expert" expert))) (defvar org-fast-tag-selection-include-todo nil - "Non-nil means, fast tags selection interface will also offer TODO states. + "Non-nil means fast tags selection interface will also offer TODO states. This is an undocumented feature, you should not rely on it.") (defcustom org-tags-column (if (featurep 'xemacs) -76 -77) @@ -2504,7 +2504,7 @@ it means that the tags should be flushright to that column. For example, :type 'integer) (defcustom org-auto-align-tags t - "Non-nil means, realign tags after pro/demotion of TODO state change. + "Non-nil means realign tags after pro/demotion of TODO state change. These operations change the length of a headline and therefore shift the tags around. With this options turned on, after each such operation the tags are again aligned to `org-tags-column'." @@ -2512,7 +2512,7 @@ the tags are again aligned to `org-tags-column'." :type 'boolean) (defcustom org-use-tag-inheritance t - "Non-nil means, tags in levels apply also for sublevels. + "Non-nil means tags in levels apply also for sublevels. When nil, only the tags directly given in a specific line apply there. This may also be a list of tags that should be inherited, or a regexp that matches tags that should be inherited. Additional control is possible @@ -2603,7 +2603,7 @@ lined-up with respect to each other." :type 'string) (defcustom org-use-property-inheritance nil - "Non-nil means, properties apply also for sublevels. + "Non-nil means properties apply also for sublevels. This setting is chiefly used during property searches. Turning it on can cause significant overhead when doing a search, which is why it is not @@ -2919,7 +2919,7 @@ also in regions already fontified." :type 'boolean) (defcustom org-hide-leading-stars nil - "Non-nil means, hide the first N-1 stars in a headline. + "Non-nil means hide the first N-1 stars in a headline. This works by using the face `org-hide' for these stars. This face is white for a light background, and black for a dark background. You may have to customize the face `org-hide' to @@ -2935,7 +2935,7 @@ lines to the buffer: :type 'boolean) (defcustom org-fontify-done-headline nil - "Non-nil means, change the face of a headline if it is marked DONE. + "Non-nil means change the face of a headline if it is marked DONE. Normally, only the TODO/DONE keyword indicates the state of a headline. When this is non-nil, the headline after the keyword is set to the `org-headline-done' as an additional indication." @@ -2956,7 +2956,7 @@ org-level-* faces." :type 'boolean) (defcustom org-highlight-latex-fragments-and-specials nil - "Non-nil means, fontify what is treated specially by the exporters." + "Non-nil means fontify what is treated specially by the exporters." :group 'org-font-lock :type 'boolean) @@ -3094,7 +3094,7 @@ This is needed for font-lock setup.") :group 'org) (defcustom org-completion-use-ido nil - "Non-nil means, use ido completion wherever possible. + "Non-nil means use ido completion wherever possible. Note that `ido-mode' must be active for this variable to be relevant. If you decide to turn this variable on, you might well want to turn off `org-outline-path-complete-in-steps'. @@ -3103,7 +3103,7 @@ See also `org-completion-use-iswitchb'." :type 'boolean) (defcustom org-completion-use-iswitchb nil - "Non-nil means, use iswitchb completion wherever possible. + "Non-nil means use iswitchb completion wherever possible. Note that `iswitchb-mode' must be active for this variable to be relevant. If you decide to turn this variable on, you might well want to turn off `org-outline-path-complete-in-steps'. @@ -3113,7 +3113,7 @@ Note that this variable has only an effect if `org-completion-use-ido' is nil." (defcustom org-completion-fallback-command 'hippie-expand "The expansion command called by \\[org-complete] in normal context. -Normal means, no org-mode-specific context." +Normal means no org-mode-specific context." :group 'org-completion :type 'function) @@ -3533,7 +3533,7 @@ get the proper fontification." :type 'string) (defcustom org-agenda-skip-archived-trees t - "Non-nil means, the agenda will skip any items located in archived trees. + "Non-nil means the agenda will skip any items located in archived trees. An archived tree is a tree marked with the tag ARCHIVE. The use of this variable is no longer recommended, you should leave it at the value t. Instead, use the key `v' to cycle the archives-mode in the agenda." @@ -3542,13 +3542,13 @@ Instead, use the key `v' to cycle the archives-mode in the agenda." :type 'boolean) (defcustom org-columns-skip-archived-trees t - "Non-nil means, ignore archived trees when creating column view." + "Non-nil means ignore 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. + "Non-nil means `org-cycle' will open archived trees. An archived tree is a tree marked with the tag ARCHIVE. When nil, archived trees will stay folded. You can still open them with normal outline commands like `show-all', but not with the cycling commands." @@ -5644,7 +5644,7 @@ open and agenda-wise Org files." (defun org-first-headline-recenter (&optional N) "Move cursor to the first headline and recenter the headline. -Optional argument N means, put the headline into the Nth line of the window." +Optional argument N means put the headline into the Nth line of the window." (goto-char (point-min)) (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t) (beginning-of-line) @@ -13606,7 +13606,7 @@ This is used by `org-read-date' in a temporary keymap for the calendar buffer." (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra) "Insert a date stamp for the date given by the internal TIME. -WITH-HM means, use the stamp format that includes the time of the day. +WITH-HM means use the stamp format that includes the time of the day. INACTIVE means use square brackets instead of angular ones, so that the stamp will not contribute to the agenda. PRE and POST are optional strings to be inserted before and after the @@ -14543,7 +14543,7 @@ end of the list." (defun org-remove-file (&optional file) "Remove current file from the list of files in variable `org-agenda-files'. These are the files which are being checked for agenda entries. -Optional argument FILE means, use this file instead of the current." +Optional argument FILE means use this file instead of the current." (interactive) (let* ((org-agenda-skip-unavailable-files nil) (file (or file buffer-file-name)) -- 2.11.4.GIT