Skip to content

Commit e894f42

Browse files
author
github-actions
committed
[docgen] Update doc/orgmode.txt
skip-checks: true
1 parent 9bdb4a7 commit e894f42

File tree

1 file changed

+64
-41
lines changed

1 file changed

+64
-41
lines changed

doc/orgmode.txt

Lines changed: 64 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ default value: `nil`
395395
Possible values:
396396
* `native` - Includes whole latex syntax file into the org syntax. It can potentially cause some highlighting issues and slowness.
397397
* `entities` - Highlight latex only in these situations (see Orgmode latex fragments (https://orgmode.org/manual/LaTeX-fragments.html#LaTeX-fragments)):
398-
* between `/begin` and `/end` delimiters
398+
* between `\begin` and `\end` delimiters
399399
* between `$` and `$` delimiters - example: `$a^2=b$`
400400
* between `$$` and `$$` delimiters - example: `$$ a=+\sqrt{2} $$`
401401
* between `\[` and `\]` delimiters - example: `\[ a=-\sqrt{2} \]`
@@ -538,9 +538,9 @@ type: `table<string, table>`
538538
default value: `{ t = { description = 'Task', template = '* TODO %?\n %u' } }`
539539
Templates for capture/refile prompt.
540540
Variables:
541-
- `%f`: Prints the file of the buffer capture was called from
542-
- `%F`: Like `%f` but inserts the full path
543-
- `%n`: Inserts the current `$USER`
541+
* `%f`: Prints the file of the buffer capture was called from
542+
* `%F`: Like `%f` but inserts the full path
543+
* `%n`: Inserts the current `$USER`
544544
* `%t`: Prints current date (Example: `<2021-06-10 Thu>`)
545545
* `%T`: Prints current date and time (Example: `<2021-06-10 Thu 12:30>`)
546546
* `%u`: Prints current date in inactive format (Example: `[2021-06-10 Thu]`)
@@ -550,18 +550,44 @@ Variables:
550550
* `%x`: Insert content of the clipboard via the "+" register (see :help clipboard)
551551
* `%?`: Default cursor position when template is opened
552552
* `%^{PROMPT|DEFAULT|COMPLETION...}`: Prompt for input, if completion is provided an :h inputlist will be used
553-
- `%(EXP)`: Runs the given lua code and inserts the result
553+
* `%(EXP)`: Runs the given lua code and inserts the result
554554

555555
Example:
556-
`{ T = { description = 'Todo', template = '* TODO %?\n %u', target = '~/org/todo.org' } }`
556+
>
557+
{ T = {
558+
description = 'Todo',
559+
template = '* TODO %?\n %u',
560+
target = '~/org/todo.org'
561+
} }
562+
<
557563

558564
Journal example:
559-
`{ j = { description = 'Journal', template = '\n*** %<%Y-%m-%d> %<%A>\n**** %U\n\n%?', target = '~/sync/org/journal.org' } }`
565+
>
566+
{ j = {
567+
description = 'Journal',
568+
template = '\n*** %<%Y-%m-%d> %<%A>\n**** %U\n\n%?',
569+
target = '~/sync/org/journal.org'
570+
} }
571+
<
560572

561573
Nested key example:
562-
`{ e = 'Event' }`
563-
`{ er = { description = 'recurring', template = '** %?\n %T', target = '~/org/calendar.org', headline = 'recurring' } }`
564-
`{ eo = { description = 'one-time', template = '** %?\n %T', target = '~/org/calendar.org', headline = 'one-time' } }`
574+
>
575+
{
576+
e = 'Event',
577+
er = {
578+
description = 'recurring',
579+
template = '** %?\n %T',
580+
target = '~/org/calendar.org',
581+
headline = 'recurring'
582+
},
583+
eo = {
584+
description = 'one-time',
585+
template = '** %?\n %T',
586+
target = '~/org/calendar.org',
587+
headline = 'one-time'
588+
}
589+
}
590+
<
565591

566592
ORG_AGENDA_MIN_HEIGHT *orgmode-org_agenda_min_height*
567593

@@ -679,7 +705,7 @@ There are only 2 global mappings that are accessible from everywhere.
679705

680706
ORG_AGENDA *orgmode-org_agenda*
681707

682-
mapped to: <Leader>oa
708+
mapped to: `<Leader\>oa`
683709
Opens up agenda prompt.
684710

685711
ORG_CAPTURE *orgmode-org_capture*
@@ -1378,36 +1404,33 @@ HIGHLIGHT GROUPS *orgmode-highlight_group
13781404

13791405
* The following highlight groups are based on Treesitter query results, hence when setting up Orgmode these
13801406
highlights must be enabled by removing `disable = {'org'}` from the default recommended Treesitter configuration.
1381-
1382-
`OrgTSTimestampActive`: An active timestamp
1383-
`OrgTSTimestampInactive`: An inactive timestamp
1384-
`OrgTSBullet`: A normal bullet under a header item
1385-
`OrgTSPropertyDrawer`: Property drawer start/end delimiters
1386-
`OrgTSDrawer`: Drawer start/end delimiters
1387-
`OrgTSTag`: A tag for a headline item, shown on the righthand side like `:foo:`
1388-
`OrgTSPlan`: `SCHEDULED`, `DEADLINE`, `CLOSED`, etc. keywords
1389-
`OrgTSComment`: A comment block
1390-
`OrgTSLatex`: LaTeX block
1391-
`OrgTSDirective`: Blocks starting with `#+`
1392-
`OrgTSCheckbox`: The default checkbox highlight, overridden if any of the below groups are specified
1393-
`OrgTSCheckboxChecked`: A checkbox checked with either `[x]` or `[X]`
1394-
`OrgTSCheckboxHalfChecked`: A checkbox checked with `[-]`
1395-
`OrgTSCheckboxUnchecked`: A empty checkbox
1396-
`OrgTSHeadlineLevel1`: Headline at level 1
1397-
`OrgTSHeadlineLevel2`: Headline at level 2
1398-
`OrgTSHeadlineLevel3`: Headline at level 3
1399-
`OrgTSHeadlineLevel4`: Headline at level 4
1400-
`OrgTSHeadlineLevel5`: Headline at level 5
1401-
`OrgTSHeadlineLevel6`: Headline at level 6
1402-
`OrgTSHeadlineLevel7`: Headline at level 7
1403-
`OrgTSHeadlineLevel8`: Headline at level 8
1404-
1407+
* `OrgTSTimestampActive`: An active timestamp
1408+
* `OrgTSTimestampInactive`: An inactive timestamp
1409+
* `OrgTSBullet`: A normal bullet under a header item
1410+
* `OrgTSPropertyDrawer`: Property drawer start/end delimiters
1411+
* `OrgTSDrawer`: Drawer start/end delimiters
1412+
* `OrgTSTag`: A tag for a headline item, shown on the righthand side like `:foo:`
1413+
* `OrgTSPlan`: `SCHEDULED`, `DEADLINE`, `CLOSED`, etc. keywords
1414+
* `OrgTSComment`: A comment block
1415+
* `OrgTSLatex`: LaTeX block
1416+
* `OrgTSDirective`: Blocks starting with `#+`
1417+
* `OrgTSCheckbox`: The default checkbox highlight, overridden if any of the below groups are specified
1418+
* `OrgTSCheckboxChecked`: A checkbox checked with either `[x]` or `[X]`
1419+
* `OrgTSCheckboxHalfChecked`: A checkbox checked with `[-]`
1420+
* `OrgTSCheckboxUnchecked`: A empty checkbox
1421+
* `OrgTSHeadlineLevel1`: Headline at level 1
1422+
* `OrgTSHeadlineLevel2`: Headline at level 2
1423+
* `OrgTSHeadlineLevel3`: Headline at level 3
1424+
* `OrgTSHeadlineLevel4`: Headline at level 4
1425+
* `OrgTSHeadlineLevel5`: Headline at level 5
1426+
* `OrgTSHeadlineLevel6`: Headline at level 6
1427+
* `OrgTSHeadlineLevel7`: Headline at level 7
1428+
* `OrgTSHeadlineLevel8`: Headline at level 8
14051429
* The following use vanilla Vim syntax matching, and will work without Treesitter highlighting enabled.
1406-
1407-
`OrgEditSrcHighlight`: The highlight for the source content in an Org buffer while it is being edited in an edit special buffer
1408-
`OrgAgendaDeadline`: A item deadline in the agenda view
1409-
`OrgAgendaScheduled`: A scheduled item in the agenda view
1410-
`OrgAgendaScheduledPast`: A item past its scheduled date in the agenda view
1430+
* `OrgEditSrcHighlight`: The highlight for the source content in an Org buffer while it is being edited in an edit special buffer
1431+
* `OrgAgendaDeadline`: A item deadline in the agenda view
1432+
* `OrgAgendaScheduled`: A scheduled item in the agenda view
1433+
* `OrgAgendaScheduledPast`: A item past its scheduled date in the agenda view
14111434

14121435
--------------------------------------------------------------------------------
14131436
ADVANCED SEARCH *orgmode-advanced_search*
@@ -1588,7 +1611,7 @@ Also, agenda/todo/search view highlights item that is clocked in.
15881611

15891612
CLOCK OUT *orgmode-clock_out*
15901613

1591-
Org file mapping: `<leader>oxi`
1614+
Org file mapping: `<leader>oxo`
15921615
Agenda view mapping: `O`
15931616
Clock out the entry and update the `:LOGBOOK:` drawer, and also add a total tracked time.
15941617
Note that in agenda view pressing `O` anywhere clocks the currently active entry, while in org file cursor must be in the headline subtree.

0 commit comments

Comments
 (0)