Skip to content

Commit 60f6257

Browse files
author
github-actions
committed
chore(docs): Update docs
1 parent d59c7b2 commit 60f6257

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

doc/orgmode.txt

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -842,6 +842,56 @@ org_agenda_remove_tags *orgmode-org_agenda_remove_tags*
842842
Should tags be hidden from all agenda views.
843843

844844

845+
org_agenda_time_grid *orgmode-org_agenda_time_grid*
846+
847+
- Type: `{ type: ('daily', 'weekly', 'require-timed', 'remove-match')[], times:
848+
number[], time_separator: string, time_label: string }`
849+
- Default:
850+
>lua
851+
{
852+
type = { 'daily', 'today', 'require-timed' },
853+
times = { 800, 1000, 1200, 1400, 1600, 1800, 2000 },
854+
time_separator = '┄┄┄┄┄',
855+
time_label = '┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄'
856+
}
857+
<
858+
859+
Settings for the time grid visible in agenda. To disable showing the time grid
860+
altogether, set |orgmode-org_agenda_use_time_grid| to `false`.
861+
862+
- `type`: List of options where all have to apply to show the grid
863+
- `daily` - Show grid in daily agenda (1 day view)
864+
- `weekly` - Show grid in any agenda type
865+
- `today` - Show grid only for today
866+
- `require-timed` - Show grid only if day has any entries with time specification
867+
- `remove-match` - Hide grid entries that overlap with the existing time slot taken by an agenda item
868+
- `times`: List of times (in 24h format) to show on the grid. It should be integer value, example `1030` represents `10:30`
869+
- `time_separator`: Value that is showed after the grid time as a separator
870+
- `time_label`: Value that is showed after the `time_separator` to fill in the place that is usually for the agenda item title
871+
872+
To customize the label for the current time, check
873+
|orgmode-org_agenda_current_time_string|
874+
875+
876+
org_agenda_use_time_grid *orgmode-org_agenda_use_time_grid*
877+
878+
- Type: `boolean`
879+
- Default: `true`
880+
881+
Show time grid in agenda. See |orgmode-org_agenda_time_grid| for configuration
882+
options.
883+
884+
885+
org_agenda_current_time_string *orgmode-org_agenda_current_time_string*
886+
887+
- Type: `string`
888+
- Default: `<- now -----------------------------------------------`
889+
890+
Label value for the current time in the agenda time grid. See
891+
|orgmode-org_agenda_time_grid| for time grid configuration or
892+
|orgmode-org_agenda_use_time_grid| to disable the grid.
893+
894+
845895
org_capture_templates *orgmode-org_capture_templates*
846896

847897
- Type: `table<string, table>`
@@ -2888,6 +2938,7 @@ The following highlight groups are used:
28882938
- `@org.agenda.deadline`: A item deadline in the agenda view - Parsed from `Error` (see note below)
28892939
- `@org.agenda.scheduled`: A scheduled item in the agenda view - Parsed from `DiffAdd` (see note below)
28902940
- `@org.agenda.scheduled_past`: A item past its scheduled date in the agenda view - Parsed from `WarningMsg` (see note below)
2941+
- `@org.agenda.time_grid`: Time grid line - Parsed from `WarningMsg` (see note below)
28912942
- `@org.agenda.day`: Highlight for all days in Agenda view - linked to `Statement`
28922943
- `@org.agenda.today`: Highlight for today in Agenda view - linked to `@org.bold`
28932944
- `@org.agenda.weekend`: Highlight for weekend days in Agenda view - linked to `@org.bold`

0 commit comments

Comments
 (0)