Skip to content

Commit bab4cef

Browse files
author
nvim-orgmode
committed
1 parent 31e87de commit bab4cef

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/configuration.org

+21-1
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,8 @@ agenda will always show current week from today - 2 days
596596

597597
Define custom agenda views that are available through the
598598
[[#org_agenda][org_agenda]] mapping. It is possible to combine multiple
599-
agenda types into single view. An example:
599+
agenda types into single view. Available options for each agenda
600+
type are explained down below the example:
600601

601602
#+begin_src lua
602603
require('orgmode').setup({
@@ -658,6 +659,25 @@ require('orgmode').setup({
658659
})
659660
#+end_src
660661

662+
These arguments are shared between all of the agenda types:
663+
- =org_agenda_overriding_header= =(string)= - Override the header of the agenda view
664+
- =org_agenda_files= =(string | string[])= - Set custom files to be loaded into this view. In same format as [[#org_agenda_files][org_agenda_files]]
665+
- =org_agenda_tag_filter_preset= =string= - Custom tags filter for the view. Same format as [[#org_agenda_files][org_agenda_files]], but applies only for tags.
666+
- =org_agenda_category_filter_preset= =string= - Custom category filter for the view. Same format as [[#org_agenda_files][org_agenda_files]], but applies only for categories.
667+
- =org_agenda_sorting_strategy= =string[]= - List of sorting functions. See [[#org_agenda_sorting_strategy][org_agenda_sorting_strategy]]
668+
- =org_agenda_remove_tags= =boolean= - Remove tags from the view. Default: =false=
669+
670+
=agenda= type arguments:
671+
- =org_agenda_span= =string|number= - Set custom span for the view. In same format as [[#org_agenda_span][org_agenda_span]]
672+
- =org_agenda_start_on_weekday= =number= - Set custom start day for the view. In same format as [[#org_agenda_start_on_weekday][org_agenda_start_on_weekday]]
673+
- =org_agenda_start_day= =string= - Set custom start day offset for the view. In same format as [[#org_agenda_start_day][org_agenda_start_day]]
674+
675+
=tags= and =tags_todo= type arguments:
676+
- =org_agenda_todo_ignore_scheduled= =('past' | 'future' | 'all' | nil')= - Do not show headlines that have scheduled task according to the value. Default: =nil=
677+
- =org_agenda_todo_ignore_deadlines= =('near' | 'far' | 'all' | 'past' | 'future' | nil')= - Do not show headlines that have deadline task according to the value. Default: =nil=
678+
- =far= - Do not show deadlines that are too far in future (over [[#org_deadline_warning_days][org_deadline_warning_days]])
679+
- =near= - Do not show deadlines that are too near in future (under [[#org_deadline_warning_days][org_deadline_warning_days]])
680+
661681
*** =org_agenda_sorting_strategy=
662682
:PROPERTIES:
663683
:CUSTOM_ID: org_agenda_sorting_strategy

0 commit comments

Comments
 (0)