File: org-agenda.el.html
This file contains the code for creating and using the Agenda for Org.
The functions org-batch-agenda, org-batch-agenda-csv, and
org-batch-store-agenda-views are implemented as macros to provide
a convenient way for extracting agenda information from the command
line. The Lisp does not evaluate parameters of a macro call; thus
it is not necessary to quote the parameters passed to one of those
functions. E.g. you can write:
emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
To export an agenda spanning 7 days. If org-batch-agenda would
have been implemented as a regular function you'd have to quote the
symbol org-agenda-span. Moreover: To use a symbol as parameter
value you would have to double quote the symbol.
This is a hack, but it works even when running Org byte-compiled.
Defined variables (176)
org-agenda-add-entry-text-descriptive-links | Non-nil means export org-links as descriptive links in agenda added text. |
org-agenda-add-entry-text-maxlines | Maximum number of entry text lines to be added to agenda. |
org-agenda-after-show-hook | Normal hook run after an item has been shown from the agenda. |
org-agenda-align-tags-to-column | Shift tags in agenda items to this column. |
org-agenda-allow-remote-undo | Non-nil means allow remote undo from the agenda buffer. |
org-agenda-archives-mode | Non-nil means the agenda will include archived items. |
org-agenda-auto-exclude-function | A function called with a tag to decide if it is filtered on ‘\ RET’. |
org-agenda-before-sorting-filter-function | Function to be applied to agenda items prior to sorting. |
org-agenda-before-write-hook | Hook run in a temporary buffer before writing the agenda to an export file. |
org-agenda-block-separator | The separator between blocks in the agenda. |
org-agenda-breadcrumbs-separator | The separator of breadcrumbs in agenda lines. |
org-agenda-buffer | Agenda buffer currently being generated. |
org-agenda-bulk-custom-functions | Alist of characters and custom functions for bulk actions. |
org-agenda-bulk-mark-char | A single-character string to be used as the bulk mark. |
org-agenda-bulk-marked-entries | List of markers that refer to marked entries in the agenda. |
org-agenda-category-filter-preset | A preset of the category filter used for secondary agenda filtering. |
org-agenda-category-icon-alist | Alist of category icon to be displayed in agenda views. |
org-agenda-cleanup-fancy-diary-hook | Hook run when the fancy diary buffer is cleaned up. |
org-agenda-clock-consistency-checks | This is a property list, with the following keys: |
org-agenda-clock-report-header | Header inserted before the table in Org agenda clock report mode. |
org-agenda-clockreport-parameter-plist | Property list with parameters for the clocktable in clockreport mode. |
org-agenda-cmp-user-defined | A function to define the comparison ‘user-defined’. |
org-agenda-columns-add-appointments-to-effort-sum | Non-nil means the duration of an appointment will add to day effort. |
org-agenda-columns-compute-summary-properties | Non-nil means recompute all summary properties before column view. |
org-agenda-columns-show-summaries | Non-nil means show summaries for columns displayed in the agenda view. |
org-agenda-compact-blocks | Non-nil means make the block agenda more compact. |
org-agenda-confirm-kill | When set, remote killing from the agenda buffer needs confirmation. |
org-agenda-current-date | Active date when building the agenda. |
org-agenda-current-span | The current span used in the agenda view. |
org-agenda-current-time-string | The string for the current time marker in the agenda. |
org-agenda-custom-commands | Custom commands for the agenda. |
org-agenda-custom-commands-contexts | Alist of custom agenda keys and contextual rules. |
org-agenda-custom-commands-local-options | Selection of examples for agenda command settings. |
org-agenda-day-face-function | Function called to determine what face should be used to display a day. |
org-agenda-deadline-leaders | Text preceding deadline items in the agenda view. |
org-agenda-default-appointment-duration | Default duration for appointments that only have a starting time. |
org-agenda-diary-file | File to which to add new entries with the ‘i’ key in agenda and calendar. |
org-agenda-diary-sexp-prefix | A regexp that matches part of a diary sexp entry |
org-agenda-dim-blocked-tasks | Non-nil means dim blocked tasks in the agenda display. |
org-agenda-effort-filter-preset | A preset of the effort condition used for secondary agenda filtering. |
org-agenda-entry-text-cleanup-hook | Hook that is run after basic cleanup of entry text to be shown in agenda. |
org-agenda-entry-text-exclude-regexps | List of regular expressions to clean up entry text. |
org-agenda-entry-text-leaders | Text prepended to the entry text in agenda buffers. |
org-agenda-entry-text-maxlines | Number of text lines to be added when ‘E’ is pressed in the agenda. |
org-agenda-entry-types | List of types searched for when creating the daily/weekly agenda. |
org-agenda-export-html-style | The style specification for exported HTML Agenda files. |
org-agenda-exporter-settings | Alist of variable/value pairs that should be active during agenda export. |
org-agenda-filter-hook | Hook run just after filtering with ‘org-agenda-filter’. |
org-agenda-filter-preset | A preset of the tags filter used for secondary agenda filtering. |
org-agenda-filter-variables | Alist of filter types and associated variables. |
org-agenda-filters-preset | Alist of filter types and associated preset of filters. |
org-agenda-finalize-hook | Hook run just before displaying an agenda buffer. |
org-agenda-follow-indirect | Non-nil means ‘org-agenda-follow-mode’ displays only the |
org-agenda-fontify-priorities | Non-nil means highlight low and high priorities in agenda. |
org-agenda-format-date | Format string for displaying dates in the agenda. |
org-agenda-hide-tags-regexp | Regular expression used to filter away specific tags in agenda views. |
org-agenda-inactive-leader | Text preceding item pulled into the agenda by inactive time stamps. |
org-agenda-include-deadlines | If non-nil, include entries within their deadline warning period. |
org-agenda-include-diary | If non-nil, include in the agenda entries from the Emacs Calendar’s diary. |
org-agenda-include-inactive-timestamps | Non-nil means include inactive time stamps in agenda. |
org-agenda-insert-diary-extract-time | Non-nil means extract any time specification from the diary entry. |
org-agenda-insert-diary-strategy | Where in ‘org-agenda-diary-file’ should new entries be added? |
org-agenda-keymap | Keymap for ‘org-agenda-mode’. |
org-agenda-last-indirect-buffer | Last buffer loaded by ‘org-agenda-tree-to-indirect-buffer’. |
org-agenda-last-marker-time | Creation time of the last agenda marker. |
org-agenda-local-vars | Variables that must be local in agenda buffers to allow multiple buffers. |
org-agenda-log-mode-add-notes | Non-nil means add first line of notes to log entries in agenda views. |
org-agenda-log-mode-items | List of items that should be shown in agenda log mode. |
org-agenda-loop-over-headlines-in-active-region | Shall some commands act upon headlines in the active region? |
org-agenda-markers | List of all currently active markers created by ‘org-agenda’. |
org-agenda-max-effort | Maximum cumulated effort duration for the agenda. |
org-agenda-max-entries | Maximum number of entries to display in an agenda. |
org-agenda-max-tags | Maximum number of tagged entries to display in an agenda. |
org-agenda-max-todos | Maximum number of TODOs to display in an agenda. |
org-agenda-menu | Agenda menu. |
org-agenda-menu-show-matcher | Non-nil means show the match string in the agenda dispatcher menu. |
org-agenda-menu-two-columns | Non-nil means, use two columns to show custom commands in the dispatcher. |
org-agenda-mode-hook | Hook run after ‘org-agenda-mode’ is turned on. |
org-agenda-mode-map | Keymap for ‘org-agenda-mode’. |
org-agenda-mouse-1-follows-link | Non-nil means mouse-1 on a link will follow the link in the agenda. |
org-agenda-move-date-from-past-immediately-to-today | Non-nil means jump to today when moving a past date forward in time. |
org-agenda-overriding-header | When set during agenda, todo and tags searches it replaces the header. |
org-agenda-overriding-restriction | Non-nil means extended agenda restriction is active. |
org-agenda-pending-undo-list | In a series of undo commands, this is the list of remaining undo items. |
org-agenda-persistent-filter | When set, keep filters from one agenda view to the next. |
org-agenda-persistent-marks | Non-nil means marked items will stay marked after a bulk action. |
org-agenda-prefer-last-repeat | Non-nil sets date for repeated entries to their last repeat. |
org-agenda-prefix-format | Format specifications for the prefix of items in the agenda views. |
org-agenda-query-register | The register holding the current query string. |
org-agenda-regexp-filter-preset | A preset of the regexp filter used for secondary agenda filtering. |
org-agenda-remove-tags | Non-nil means remove the tags from the headline copy in the agenda. |
org-agenda-remove-tags-when-in-prefix | Non-nil means remove the tags from the headline copy in the agenda. |
org-agenda-remove-timeranges-from-blocks | Non-nil means remove time ranges specifications in agenda |
org-agenda-remove-times-when-in-prefix | Non-nil means remove duplicate time specifications in agenda items. |
org-agenda-represented-categories | Cache for the list of all categories in the agenda. |
org-agenda-represented-tags | Cache for the list of all categories in the agenda. |
org-agenda-restore-windows-after-quit | Non-nil means restore window configuration upon exiting agenda. |
org-agenda-restrict | Non-nil means agenda restriction is active. |
org-agenda-restrict-begin | Internal variable used to mark the restriction beginning. |
org-agenda-restrict-end | Internal variable used to mark the restriction end. |
org-agenda-restriction-lock-highlight-subtree | Non-nil means highlight the whole subtree when restriction is active. |
org-agenda-restriction-lock-overlay | Overlay to mark the headline to which agenda commands are restricted. |
org-agenda-scheduled-leaders | Text preceding scheduled items in the agenda view. |
org-agenda-search-headline-for-time | Non-nil means search headline for a time-of-day. |
org-agenda-search-view-always-boolean | Non-nil means the search string is interpreted as individual parts. |
org-agenda-search-view-force-full-words | Non-nil means, search words must be matches as complete words. |
org-agenda-search-view-max-outline-level | Maximum outline level to display in search view. |
org-agenda-search-view-search-words-only | Non-nil means the search string is interpreted as individual parts. |
org-agenda-show-all-dates | Non-nil means ‘org-agenda’ shows every day in the selected range. |
org-agenda-show-current-time-in-grid | Non-nil means show the current time in the time grid. |
org-agenda-show-future-repeats | Non-nil shows repeated entries in the future part of the agenda. |
org-agenda-show-inherited-tags | Non-nil means show inherited tags in each agenda line. |
org-agenda-show-log | When non-nil, show the log in the agenda. |
org-agenda-show-outline-path | Non-nil means show outline path in echo area after line motion. |
org-agenda-skip-additional-timestamps-same-entry | When nil, multiple same-day timestamps in entry make multiple agenda lines. |
org-agenda-skip-comment-trees | Non-nil means skip trees that start with the COMMENT keyword. |
org-agenda-skip-deadline-if-done | Non-nil means don’t show deadlines when the corresponding item is done. |
org-agenda-skip-deadline-prewarning-if-scheduled | Non-nil means skip deadline prewarning when entry is also scheduled. |
org-agenda-skip-function | Function to be called at each match during agenda construction. |
org-agenda-skip-function-global | Function to be called at each match during agenda construction. |
org-agenda-skip-regexp | Regular expression used in skipping subtrees for the agenda. |
org-agenda-skip-scheduled-delay-if-deadline | Non-nil means skip scheduled delay when entry also has a deadline. |
org-agenda-skip-scheduled-if-deadline-is-shown | Non-nil means skip scheduling line if same entry shows because of deadline. |
org-agenda-skip-scheduled-if-done | Non-nil means don’t show scheduled items in agenda when they are done. |
org-agenda-skip-scheduled-repeats-after-deadline | Non-nil hides scheduled repeated entries past deadline. |
org-agenda-skip-timestamp-if-deadline-is-shown | Non-nil means skip timestamp line if same entry shows because of deadline. |
org-agenda-skip-timestamp-if-done | Non-nil means don’t select item by timestamp or -range if it is DONE. |
org-agenda-sort-noeffort-is-high | Non-nil means items without effort estimate are sorted as high effort. |
org-agenda-sort-notime-is-late | Non-nil means items without time are considered late. |
org-agenda-sorting-strategy | Sorting structure for the agenda items of a single day. |
org-agenda-span | Number of days to include in overview display. |
org-agenda-start-day | Start day for the agenda view. |
org-agenda-start-on-weekday | Non-nil means start the overview always on the specified weekday. |
org-agenda-start-with-archives-mode | Initial value of archive mode in a newly created agenda window. |
org-agenda-start-with-clockreport-mode | The initial value of clockreport-mode in a newly created agenda window. |
org-agenda-start-with-entry-text-mode | The initial value of entry-text-mode in a newly created agenda window. |
org-agenda-start-with-follow-mode | The initial value of follow mode in a newly created agenda window. |
org-agenda-start-with-log-mode | The initial value of log-mode in a newly created agenda window. |
org-agenda-sticky | Non-nil means agenda q key will bury agenda buffers. |
org-agenda-tag-filter-preset | A preset of the tags filter used for secondary agenda filtering. |
org-agenda-tags-column | Shift tags in agenda items to this column. |
org-agenda-tags-todo-honor-ignore-options | Non-nil means honor todo-list ignores options also in tags-todo search. |
org-agenda-time-grid | The settings for time grid for agenda display. |
org-agenda-time-leading-zero | Non-nil means use leading zero for military times in agenda. |
org-agenda-timegrid-use-ampm | When set, show AM/PM style timestamps on the timegrid. |
org-agenda-timerange-leaders | Text preceding timerange entries in the agenda view. |
org-agenda-todo-ignore-deadlines | Non-nil means ignore some deadline TODO items when making TODO list. |
org-agenda-todo-ignore-scheduled | Non-nil means, ignore some scheduled TODO items when making TODO list. |
org-agenda-todo-ignore-time-comparison-use-seconds | Time unit to use when possibly ignoring an agenda item. |
org-agenda-todo-ignore-timestamp | Non-nil means don’t show entries with a timestamp. |
org-agenda-todo-ignore-with-date | Non-nil means don’t show entries with a date in the global todo list. |
org-agenda-todo-keyword-format | Format for the TODO keyword in agenda lines. |
org-agenda-todo-list-sublevels | Non-nil means check also the sublevels of a TODO entry for TODO entries. |
org-agenda-undo-has-started-in | Buffers that have already seen ‘undo-start’ in the current undo sequence. |
org-agenda-undo-list | List of undoable operations in the agenda since last refresh. |
org-agenda-use-tag-inheritance | List of agenda view types where to use tag inheritance. |
org-agenda-use-time-grid | Non-nil means show a time grid in the agenda schedule. |
org-agenda-view-columns-initially | When non-nil, switch to columns view right after creating the agenda. |
org-agenda-weekend-days | Which days are weekend? |
org-agenda-window-frame-fractions | The min and max height of the agenda window as a fraction of frame height. |
org-agenda-window-setup | How the agenda buffer should be displayed. |
org-agenda-with-colors | Non-nil means use colors in agenda views. |
org-deadline-past-days | Number of days to warn about missed deadlines. |
org-last-heading-marker | Marker pointing to the headline that last changed its TODO state |
org-prefix-category-length | Used by ‘org-compile-prefix-format’ to remember the category field width. |
org-prefix-category-max-length | Used by ‘org-compile-prefix-format’ to remember the category field width. |
org-prefix-format-compiled | The compiled prefix format and associated variables. |
org-prefix-has-breadcrumbs | A flag, set by ‘org-compile-prefix-format’. |
org-prefix-has-effort | A flag, set by ‘org-compile-prefix-format’. |
org-prefix-has-tag | A flag, set by ‘org-compile-prefix-format’. |
org-prefix-has-time | A flag, set by ‘org-compile-prefix-format’. |
org-scheduled-past-days | Number of days to continue listing scheduled items not marked DONE. |
org-search-syntax-table | Special syntax table for Org search. |
org-select-this-todo-keyword | Keyword selector for todo agenda. |
org-sorting-choice | Sorting choices. |
org-stuck-projects | How to identify stuck projects. |