Skip to content

Commit 5184232

Browse files
author
nvim-orgmode
committed
1 parent 60e36df commit 5184232

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

docs/configuration.org

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -787,6 +787,53 @@ To change the highlight, override =@org.agenda.separator= hl group.
787787
- Default: =false=
788788
Should tags be hidden from all agenda views.
789789

790+
*** org_agenda_time_grid
791+
:PROPERTIES:
792+
:CUSTOM_ID: org_agenda_time_grid
793+
:END:
794+
- Type: ={ type: ('daily', 'weekly', 'require-timed', 'remove-match')[], times: number[], time_separator: string, time_label: string }=
795+
- Default:
796+
#+begin_src lua
797+
{
798+
type = { 'daily', 'today', 'require-timed' },
799+
times = { 800, 1000, 1200, 1400, 1600, 1800, 2000 },
800+
time_separator = '┄┄┄┄┄',
801+
time_label = '┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄'
802+
}
803+
#+end_src
804+
805+
Settings for the time grid visible in agenda. To disable showing the time grid altogether, set [[#org_agenda_use_time_grid][org_agenda_use_time_grid]] to =false=.
806+
807+
- =type=: List of options where all have to apply to show the grid
808+
- =daily= - Show grid in daily agenda (1 day view)
809+
- =weekly= - Show grid in any agenda type
810+
- =today= - Show grid only for today
811+
- =require-timed= - Show grid only if day has any entries with time specification
812+
- =remove-match= - Hide grid entries that overlap with the existing time slot taken by an agenda item
813+
- =times=: List of times (in 24h format) to show on the grid. It should be integer value, example =1030= represents =10:30=
814+
- =time_separator=: Value that is showed after the grid time as a separator
815+
- =time_label=: Value that is showed after the =time_separator= to fill in the place that is usually for the agenda item title
816+
817+
To customize the label for the current time, check [[#org_agenda_current_time_string][org_agenda_current_time_string]]
818+
819+
*** org_agenda_use_time_grid
820+
:PROPERTIES:
821+
:CUSTOM_ID: org_agenda_use_time_grid
822+
:END:
823+
- Type: =boolean=
824+
- Default: =true=
825+
Show time grid in agenda. See [[#org_agenda_time_grid][org_agenda_time_grid]] for configuration options.
826+
827+
*** org_agenda_current_time_string
828+
:PROPERTIES:
829+
:CUSTOM_ID: org_agenda_current_time_string
830+
:END:
831+
- Type: =string=
832+
- Default: =<- now -----------------------------------------------=
833+
Label value for the current time in the agenda time grid.
834+
See [[#org_agenda_time_grid][org_agenda_time_grid]] for time grid configuration or [[#org_agenda_use_time_grid][org_agenda_use_time_grid]] to disable the grid.
835+
836+
790837
*** org_capture_templates
791838
:PROPERTIES:
792839
:CUSTOM_ID: org_capture_templates
@@ -2872,6 +2919,7 @@ The following highlight groups are used:
28722919
- =@org.agenda.deadline=: A item deadline in the agenda view - Parsed from =Error= (see note below)
28732920
- =@org.agenda.scheduled=: A scheduled item in the agenda view - Parsed from =DiffAdd= (see note below)
28742921
- =@org.agenda.scheduled_past=: A item past its scheduled date in the agenda view - Parsed from =WarningMsg= (see note below)
2922+
- =@org.agenda.time_grid=: Time grid line - Parsed from =WarningMsg= (see note below)
28752923
- =@org.agenda.day=: Highlight for all days in Agenda view - linked to =Statement=
28762924
- =@org.agenda.today=: Highlight for today in Agenda view - linked to =@org.bold=
28772925
- =@org.agenda.weekend=: Highlight for weekend days in Agenda view - linked to =@org.bold=

0 commit comments

Comments
 (0)