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 14, 2025
1 parent e6ae773 commit 4e4a14a
Showing 1 changed file with 125 additions and 9 deletions.
134 changes: 125 additions & 9 deletions doc/orgmode.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,18 @@ CONTENTS *orgmode-content
1.2.2.2. org_agenda_span.....................|orgmode-org_agenda_span|
1.2.2.3. org_agenda_start_on_weekday.|orgmode-org_agenda_start_on_weekday|
1.2.2.4. org_agenda_start_day...........|orgmode-org_agenda_start_day|
1.2.2.5. org_capture_templates.........|orgmode-org_capture_templates|
1.2.2.6. org_agenda_min_height.........|orgmode-org_agenda_min_height|
1.2.2.7. org_priority_highest...........|orgmode-org_priority_highest|
1.2.2.8. org_priority_default...........|orgmode-org_priority_default|
1.2.2.9. org_priority_lowest.............|orgmode-org_priority_lowest|
1.2.2.10. org_agenda_skip_scheduled_if_done.|orgmode-org_agenda_skip_scheduled_if_done|
1.2.2.11. org_agenda_skip_deadline_if_done.|orgmode-org_agenda_skip_deadline_if_done|
1.2.2.12. org_agenda_text_search_extra_files.|orgmode-org_agenda_text_search_extra_files|
1.2.2.5. org_agenda_custom_commands.|orgmode-org_agenda_custom_commands|
1.2.2.6. org_agenda_sorting_strategy.|orgmode-org_agenda_sorting_strategy|
1.2.2.7. org_agenda_block_separator.|orgmode-org_agenda_block_separator|
1.2.2.8. org_agenda_remove_tags.......|orgmode-org_agenda_remove_tags|
1.2.2.9. org_capture_templates.........|orgmode-org_capture_templates|
1.2.2.10. org_agenda_min_height........|orgmode-org_agenda_min_height|
1.2.2.11. org_priority_highest..........|orgmode-org_priority_highest|
1.2.2.12. org_priority_default..........|orgmode-org_priority_default|
1.2.2.13. org_priority_lowest............|orgmode-org_priority_lowest|
1.2.2.14. org_agenda_skip_scheduled_if_done.|orgmode-org_agenda_skip_scheduled_if_done|
1.2.2.15. org_agenda_skip_deadline_if_done.|orgmode-org_agenda_skip_deadline_if_done|
1.2.2.16. org_agenda_text_search_extra_files.|orgmode-org_agenda_text_search_extra_files|
1.2.3. Calendar settings.......................|orgmode-calendar_settings|
1.2.3.1. calendar.round_min_with_hours.|orgmode-calendar.round_min_with_hours|
1.2.3.2. calendar.min_big_step.........|orgmode-calendar.min_big_step|
Expand Down Expand Up @@ -568,8 +572,18 @@ Determine on which day the week will start in calendar modal (ex: changing the d
EMACS_CONFIG *orgmode-emacs_config*

type: `table`
default value: `{ executable_path = 'emacs', config_path='$HOME/.emacs.d/init.el' }`
default value: `{ executable_path = 'emacs', config_path=nil }`
Set configuration for your emacs. This is useful for having the emacs export properly pickup your emacs config and plugins.
If `config_path` is not provided, exporter tries to find a configuration file from these locations:

1. `~/.config/emacs/init.el`
2. `~/.emacs.d/init.el`
3. `~/.emacs.el`

If there is no configuration found, it will still process the export.

If it finds a configuration and export attempt fails because of the configuration issue, there will be a prompt to
attempt the same export without the configuration file.

AGENDA SETTINGS *orgmode-agenda_settings*

Expand Down Expand Up @@ -610,6 +624,108 @@ Example:
If `org_agenda_start_on_weekday` is `false`, and `org_agenda_start_day` is `-2d`,
agenda will always show current week from today - 2 days

ORG_AGENDA_CUSTOM_COMMANDS *orgmode-org_agenda_custom_commands*

type: `table<string, OrgAgendaCustomCommand>`
default value: `{}`

Define custom agenda views that are available through the (org_agenda)[#org_agenda] mapping.
It is possible to combine multiple agenda types into single view.
An example:
>
require('orgmode').setup({
org_agenda_files = {'~/org/**/*'},
org_agenda_custom_commands = {
-- "c" is the shortcut that will be used in the prompt
c = {
description = 'Combined view', -- Description shown in the prompt for the shortcut
types = {
{
type = 'tags_todo', -- Type can be agenda | tags | tags_todo
match = '+PRIORITY="A"', --Same as providing a "Match:" for tags view <leader>oa + m, See: https://orgmode.org/manual/Matching-tags-and-properties.html
org_agenda_overriding_header = 'High priority todos',
org_agenda_todo_ignore_deadlines = 'far', -- Ignore all deadlines that are too far in future (over org_deadline_warning_days). Possible values: all | near | far | past | future
},
{
type = 'agenda',
org_agenda_overriding_header = 'My daily agenda',
org_agenda_span = 'day' -- can be any value as org_agenda_span
},
{
type = 'tags',
match = 'WORK', --Same as providing a "Match:" for tags view <leader>oa + m, See: https://orgmode.org/manual/Matching-tags-and-properties.html
org_agenda_overriding_header = 'My work todos',
org_agenda_todo_ignore_scheduled = 'all', -- Ignore all headlines that are scheduled. Possible values: past | future | all
},
{
type = 'agenda',
org_agenda_overriding_header = 'Whole week overview',
org_agenda_span = 'week', -- 'week' is default, so it's not necessary here, just an example
org_agenda_start_on_weekday = 1 -- Start on Monday
org_agenda_remove_tags = true -- Do not show tags only for this view
},
}
},
p = {
description = 'Personal agenda',
types = {
{
type = 'tags_todo',
org_agenda_overriding_header = 'My personal todos',
org_agenda_category_filter_preset = 'todos', -- Show only headlines from `todos` category. Same value providad as when pressing `/` in the Agenda view
org_agenda_sorting_strategy = {'todo-state-up', 'priority-down'} -- See all options available on org_agenda_sorting_strategy
},
{
type = 'agenda',
org_agenda_overriding_header = 'Personal projects agenda',
org_agenda_files = {'~/my-projects/**/*'}, -- Can define files outside of the default org_agenda_files
},
{
type = 'tags',
org_agenda_overriding_header = 'Personal projects notes',
org_agenda_files = {'~/my-projects/**/*'},
org_agenda_tag_filter_preset = 'NOTES-REFACTOR' -- Show only headlines with NOTES tag that does not have a REFACTOR tag. Same value providad as when pressing `/` in the Agenda view
},
}
}
}
})
<

ORG_AGENDA_SORTING_STRATEGY *orgmode-org_agenda_sorting_strategy*

type: `table<'agenda' | 'todo' | 'tags', OrgAgendaSortingStrategy[]><`
default value: `{ agenda = {'time-up', 'priority-down', 'category-keep'}, todo = {'priority-down', 'category-keep'}, tags = {'priority-down', 'category-keep'}}`
List of sorting strategies to apply to a given view.
Available strategies:

* `time-up` - Sort entries by time of day. Applicable only in `agenda` view
* `time-down` - Opposite of `time-up`
* `priority-down` - Sort by priority, from highest to lowest
* `priority-up` - Sort by priority, from lowest to highest
* `tag-up` - Sort by sorted tags string, ascending
* `tag-down` - Sort by sorted tags string, descending
* `todo-state-up` - Sort by todo keyword by position (example: 'TODO, PROGRESS, DONE' has a sort value of 1, 2 and 3), ascending
* `todo-state-down` - Sort by todo keyword, descending
* `clocked-up` - Show clocked in headlines first
* `clocked-down` - Show clocked in headines last
* `category-up` - Sort by category name, ascending
* `category-down` - Sort by category name, descending
* `category-keep` - Keep default category sorting, as it appears in org-agenda-files

ORG_AGENDA_BLOCK_SEPARATOR *orgmode-org_agenda_block_separator*

type: `string`
default value: `-`
Separator used to separate multiple agenda views generated by org_agenda_custom_commands.
To change the highlight, override `@org.agenda.separator` hl group.

ORG_AGENDA_REMOVE_TAGS *orgmode-org_agenda_remove_tags*

type: `boolean`
default value: `false`
Should tags be hidden from all agenda views.

ORG_CAPTURE_TEMPLATES *orgmode-org_capture_templates*

type: `table<string, table>`
Expand Down

0 comments on commit 4e4a14a

Please sign in to comment.