Skip to content

Commit 98bf44d

Browse files
author
github-actions
committed
[docgen] Update docs
1 parent b896093 commit 98bf44d

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

doc/orgmode.txt

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -640,8 +640,8 @@ org_agenda_custom_commands *orgmode-org_agenda_custom_commands*
640640
- Default: `{}`
641641

642642
Define custom agenda views that are available through the |orgmode-org_agenda|
643-
mapping. It is possible to combine multiple agenda types into single view. An
644-
example:
643+
mapping. It is possible to combine multiple agenda types into single view.
644+
Available options for each agenda type are explained down below the example:
645645

646646
>lua
647647
require('orgmode').setup({
@@ -703,6 +703,28 @@ example:
703703
})
704704
<
705705

706+
These arguments are shared between all of the agenda types:
707+
708+
- `org_agenda_overriding_header` `(string)` - Override the header of the agenda view
709+
- `org_agenda_files` `(string | string[])` - Set custom files to be loaded into this view. In same format as |orgmode-org_agendafiles|
710+
- `org_agenda_tag_filter_preset` `string` - Custom tags filter for the view. Same format as |orgmode-org_agendafiles|, but applies only for tags.
711+
- `org_agenda_category_filter_preset` `string` - Custom category filter for the view. Same format as |orgmode-org_agendafiles|, but applies only for categories.
712+
- `org_agenda_sorting_strategy` `string[]` - List of sorting functions. See |orgmode-org_agendasortingstrategy|
713+
- `org_agenda_remove_tags` `boolean` - Remove tags from the view. Default: `false`
714+
715+
`agenda` type arguments:
716+
717+
- `org_agenda_span` `string|number` - Set custom span for the view. In same format as |orgmode-org_agendaspan|
718+
- `org_agenda_start_on_weekday` `number` - Set custom start day for the view. In same format as |orgmode-org_agendastartonweekday|
719+
- `org_agenda_start_day` `string` - Set custom start day offset for the view. In same format as |orgmode-org_agendastartday|
720+
721+
`tags` and `tags_todo` type arguments:
722+
723+
- `org_agenda_todo_ignore_scheduled` `('past' | 'future' | 'all' | nil')` - Do not show headlines that have scheduled task according to the value. Default: `nil`
724+
- `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`
725+
- `far` - Do not show deadlines that are too far in future (over |orgmode-org_deadlinewarningdays|)
726+
- `near` - Do not show deadlines that are too near in future (under |orgmode-org_deadlinewarningdays|)
727+
706728

707729
org_agenda_sorting_strategy *orgmode-org_agenda_sorting_strategy*
708730

0 commit comments

Comments
 (0)