Skip to content

Commit

Permalink
[docgen] Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jan 26, 2025
1 parent b896093 commit 98bf44d
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions doc/orgmode.txt
Original file line number Diff line number Diff line change
Expand Up @@ -640,8 +640,8 @@ org_agenda_custom_commands *orgmode-org_agenda_custom_commands*
- Default: `{}`

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

>lua
require('orgmode').setup({
Expand Down Expand Up @@ -703,6 +703,28 @@ example:
})
<

These arguments are shared between all of the agenda types:

- `org_agenda_overriding_header` `(string)` - Override the header of the agenda view
- `org_agenda_files` `(string | string[])` - Set custom files to be loaded into this view. In same format as |orgmode-org_agendafiles|
- `org_agenda_tag_filter_preset` `string` - Custom tags filter for the view. Same format as |orgmode-org_agendafiles|, but applies only for tags.
- `org_agenda_category_filter_preset` `string` - Custom category filter for the view. Same format as |orgmode-org_agendafiles|, but applies only for categories.
- `org_agenda_sorting_strategy` `string[]` - List of sorting functions. See |orgmode-org_agendasortingstrategy|
- `org_agenda_remove_tags` `boolean` - Remove tags from the view. Default: `false`

`agenda` type arguments:

- `org_agenda_span` `string|number` - Set custom span for the view. In same format as |orgmode-org_agendaspan|
- `org_agenda_start_on_weekday` `number` - Set custom start day for the view. In same format as |orgmode-org_agendastartonweekday|
- `org_agenda_start_day` `string` - Set custom start day offset for the view. In same format as |orgmode-org_agendastartday|

`tags` and `tags_todo` type arguments:

- `org_agenda_todo_ignore_scheduled` `('past' | 'future' | 'all' | nil')` - Do not show headlines that have scheduled task according to the value. Default: `nil`
- `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`
- `far` - Do not show deadlines that are too far in future (over |orgmode-org_deadlinewarningdays|)
- `near` - Do not show deadlines that are too near in future (under |orgmode-org_deadlinewarningdays|)


org_agenda_sorting_strategy *orgmode-org_agenda_sorting_strategy*

Expand Down

0 comments on commit 98bf44d

Please sign in to comment.