Skip to content

Commit d69d693

Browse files
author
github-actions
committed
chore(docs): Update docs
1 parent bbdd5dd commit d69d693

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

doc/orgmode.txt

+41-41
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ org_todo_repeat_to_state *orgmode-org_todo_repeat_to_state*
9898

9999
Path to a file that will be used as a default target file when refiling.
100100

101-
Set an entry from |orgmode-org_todokeywords| to use as the "starting" state for
102-
repeatable todos.
101+
Set an entry from |orgmode-org_todo_keywords| to use as the "starting" state
102+
for repeatable todos.
103103

104-
If provided value does not exist in |orgmode-org_todokeywords|, first entry
104+
If provided value does not exist in |orgmode-org_todo_keywords|, first entry
105105
from that list is used.
106106

107107

@@ -383,8 +383,8 @@ org_indent_mode_turns_off_org_adapt_indentation*orgmode-org_indent_mode_turns_of
383383

384384
Possible values:
385385

386-
- `true` - Disable |orgmode-org_adaptindentation| by default when |orgmode-org_startupindented| is enabled.
387-
- `false` - Do not disable |orgmode-org_adaptindentation| by default when |orgmode-org_startupindented| is enabled.
386+
- `true` - Disable |orgmode-org_adapt_indentation| by default when |orgmode-org_startup_indented| is enabled.
387+
- `false` - Do not disable |orgmode-org_adapt_indentation| by default when |orgmode-org_startup_indented| is enabled.
388388

389389

390390
org_indent_mode_turns_on_hiding_stars*orgmode-org_indent_mode_turns_on_hiding_stars*
@@ -394,8 +394,8 @@ org_indent_mode_turns_on_hiding_stars*orgmode-org_indent_mode_turns_on_hiding_st
394394

395395
Possible values:
396396

397-
- `true` - Enable |orgmode-org_hideleadingstars| by default when |orgmode-org_indentmode| is enabled for buffer (`vim.b.org_indent_mode = true`).
398-
- `false` - Do not modify the value in |orgmode-org_hideleadingstars| by default when |orgmode-org_indentmode| is enabled for buffer (`vim.b.org_indent_mode = true`).
397+
- `true` - Enable |orgmode-org_hide_leading_stars| by default when |orgmode-org_indent_mode| is enabled for buffer (`vim.b.org_indent_mode = true`).
398+
- `false` - Do not modify the value in |orgmode-org_hide_leading_stars| by default when |orgmode-org_indent_mode| is enabled for buffer (`vim.b.org_indent_mode = true`).
399399

400400

401401
org_src_window_setup *orgmode-org_src_window_setup*
@@ -486,7 +486,7 @@ org_time_stamp_rounding_minutes *orgmode-org_time_stamp_rounding_minutes*
486486
- Default: `5`
487487

488488
Number of minutes to increase/decrease when using
489-
|orgmode-org_timestampup|/|orgmode-org_timestampdown|
489+
|orgmode-org_timestamp_up|/|orgmode-org_timestamp_down|
490490

491491

492492
org_cycle_separator_lines *orgmode-org_cycle_separator_lines*
@@ -556,7 +556,7 @@ org_id_ts_format *orgmode-org_id_ts_format*
556556
- Type: `string`
557557
- Default: `%Y%m%d%H%M%S`
558558

559-
Format of the id generated when |orgmode-org_idmethod| is set to `ts`.
559+
Format of the id generated when |orgmode-org_id_method| is set to `ts`.
560560

561561

562562
org_id_method *orgmode-org_id_method*
@@ -566,18 +566,18 @@ org_id_method *orgmode-org_id_method*
566566

567567
What method to use to generate ids via org id module.
568568

569-
- `uuid` - Use |orgmode-org_iduuidprogram| to generate
569+
- `uuid` - Use |orgmode-org_id_uuid_program| to generate
570570
the id
571-
- `ts` - Generate id from current timestamp using format |orgmode-org_idtsformat|
572-
- `org` - Generate a random 12 digit number and prepend |orgmode-org_idprefix|
571+
- `ts` - Generate id from current timestamp using format |orgmode-org_id_ts_format|
572+
- `org` - Generate a random 12 digit number and prepend |orgmode-org_id_prefix|
573573

574574

575575
org_id_prefix *orgmode-org_id_prefix*
576576

577577
- Type: `string | nil`
578578
- Default: `nil`
579579

580-
Prefix added to the generated id when |orgmode-org_idmethod| is set to `org`.
580+
Prefix added to the generated id when |orgmode-org_id_method| is set to `org`.
581581

582582

583583
org_id_link_to_org_use_id *orgmode-org_id_link_to_org_use_id*
@@ -586,7 +586,7 @@ org_id_link_to_org_use_id *orgmode-org_id_link_to_org_use_id*
586586
- Default: `false`
587587

588588
If `true`, generate ID with the Org ID module and append it to the headline as
589-
property. More info on |orgmode-org_storelink|
589+
property. More info on |orgmode-org_store_link|
590590

591591

592592
org_babel_default_header_args *orgmode-org_babel_default_header_args*
@@ -750,24 +750,24 @@ Available options for each agenda type are explained down below the example:
750750
These arguments are shared between all of the agenda types:
751751

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

759759
`agenda` type arguments:
760760

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

765765
`tags` and `tags_todo` type arguments:
766766

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

772772

773773
org_agenda_sorting_strategy *orgmode-org_agenda_sorting_strategy*
@@ -806,7 +806,7 @@ org_agenda_block_separator *orgmode-org_agenda_block_separator*
806806
- Default: `-`
807807

808808
Separator used to separate multiple agenda views generated by
809-
|orgmode-org_agendacustomcommands|. To change the highlight, override
809+
|orgmode-org_agenda_custom_commands|. To change the highlight, override
810810
`@org.agenda.separator` hl group.
811811

812812

@@ -874,7 +874,7 @@ Templates have the following fields:
874874
used when creating capture
875875
- `target` (`string?`) — name of the file to which the capture content
876876
will be added. If the target is not specified, the content will be
877-
added to the |orgmode-org_defaultnotesfile| file
877+
added to the |orgmode-org_default_notes_file| file
878878
- `headline` (`string?`) — title of the headline after which the
879879
capture content will be added. If no headline is specified, the
880880
content will be appended to the end of the file
@@ -1111,7 +1111,7 @@ The step size for changing the minutes while the cursor is on the first digit.
11111111
calendar.min_small_step *orgmode-calendar.min_small_step*
11121112

11131113
- Type: `number`
1114-
- Default: same as |orgmode-org_timestamproundingminutes|
1114+
- Default: same as |orgmode-org_time_stamp_rounding_minutes|
11151115

11161116
The step size for changing the minutes while the cursor is on the second digit.
11171117

@@ -1239,8 +1239,8 @@ You can find the configuration file that holds all default mappings here
12391239
Use Enter in insert mode to add list items/checkboxes/todos*orgmode-Use-Enter-in-insert-mode-to-add-list-items/checkboxes/todos*
12401240

12411241
By default, adding list items/checkboxes/todos is done with
1242-
|orgmode-org_metareturn| which is a normal mode mapping. If you want to have an
1243-
insert mode mapping there are two options:
1242+
|orgmode-org_meta_return| which is a normal mode mapping. If you want to have
1243+
an insert mode mapping there are two options:
12441244

12451245
1. If your terminal supports it, map a key like `Shift + Enter` to the
12461246
meta return mapping (Recommended):
@@ -1684,7 +1684,7 @@ in examples references cursor position.
16841684
- Hour - Example date: `<2021-10-01 Fri 1|0:30>` becomes
16851685
`<2022-10-02 Sat 1|1:30>`.
16861686
- Minute - Example date: `<2021-10-01 Fri 10:3|0>` becomes
1687-
`<2022-10-02 Sat 11:3|5>`. See |orgmode-org_timestamproundingminutes| for steps configuration.
1687+
`<2022-10-02 Sat 11:3|5>`. See |orgmode-org_time_stamp_rounding_minutes| for steps configuration.
16881688
- Repeater/Delay range (`h->d->w->m->y`) - Example date:
16891689
`<2021-10-01 Fri 10:30 +1|w>` becomes `<2021-10-01 Fri 10:30 +1|m>`
16901690
- Active/Inactive state - (`<` to `[` and vice versa) - Example date:
@@ -1695,7 +1695,7 @@ org_timestamp_down *orgmode-org_timestamp_down*
16951695

16961696
- Mapped to: `<C-x>`
16971697

1698-
Decrease date part under under cursor. Same as |orgmode-org_timestampup|, just
1698+
Decrease date part under under cursor. Same as |orgmode-org_timestamp_up|, just
16991699
opposite direction.
17001700

17011701

@@ -1753,7 +1753,7 @@ org_todo *orgmode-org_todo*
17531753
- Mapped to: `cit`
17541754

17551755
Cycle todo keyword forward on current headline or open fast access to TODO
1756-
states prompt (see |orgmode-org_todokeywords|) if it's enabled.
1756+
states prompt (see |orgmode-org_todo_keywords|) if it's enabled.
17571757

17581758

17591759
org_todo_prev *orgmode-org_todo_prev*
@@ -1784,7 +1784,7 @@ org_insert_link *orgmode-org_insert_link*
17841784

17851785
Insert a hyperlink at cursor position. When the cursor is on a hyperlink, edit
17861786
that hyperlink. In visual mode, uses selected text as link description. If
1787-
there are any links stored with |orgmode-org_storelink|, pressing `<TAB>` to
1787+
there are any links stored with |orgmode-org_store_link|, pressing `<TAB>` to
17881788
autocomplete the input will show list of all stored links to select. Links
17891789
generated with ID are properly expanded to valid links after selection.
17901790

@@ -1793,10 +1793,10 @@ org_store_link *orgmode-org_store_link*
17931793

17941794
- Mapped to: `<Leader>ols`
17951795

1796-
Generate a link to the closest headline. If |orgmode-org_idlinktoorguseid| is
1797-
`true`, it appends the `ID` property to the headline, and generates link with
1798-
that id to be inserted via |orgmode-org_insertlink|. When
1799-
|orgmode-org_idlinktoorguseid| is `false`, it generates the standard
1796+
Generate a link to the closest headline. If |orgmode-org_id_link_to_org_use_id|
1797+
is `true`, it appends the `ID` property to the headline, and generates link
1798+
with that id to be inserted via |orgmode-org_insert_link|. When
1799+
|orgmode-org_id_link_to_org_use_id| is `false`, it generates the standard
18001800
file::*headline link (example: `file:/path/to/my/todos.org::*My headline`)
18011801

18021802

@@ -1939,7 +1939,7 @@ org_export *orgmode-org_export*
19391939

19401940
Open export options. **NOTE**: Exports are handled via `emacs` and `pandoc`.
19411941
This means that `emacs` and/or `pandoc` must be in `$PATH`. See
1942-
|orgmode-org_customexports| if you want to add your own export options.
1942+
|orgmode-org_custom_exports| if you want to add your own export options.
19431943

19441944

19451945
org_next_visible_heading *orgmode-org_next_visible_heading*
@@ -2306,7 +2306,7 @@ AUTOMATIC UPDATES OF TOTALS
23062306

23072307
When updating closed logbook dates that have a total at the right (`example:
23082308
==> 1:05`), updating any of the dates via
2309-
|orgmode-org_timestampup|/|orgmode-org_timestampdown| automatically
2309+
|orgmode-org_timestamp_up|/|orgmode-org_timestamp_down| automatically
23102310
recalculates this value.
23112311

23122312

@@ -2655,7 +2655,7 @@ There is basic support for extracting source code with `tangle` and `noweb`.
26552655
<https://orgmode.org/manual/Extracting-Source-Code.html>) These options are
26562656
supported:
26572657

2658-
1. Setting `header-args` on multiple levels:1. Configuration (|orgmode-org_babeldefaultheaderargs|)
2658+
1. Setting `header-args` on multiple levels:1. Configuration (|orgmode-org_babel_default_header_args|)
26592659

26602660

26612661
2. File level property (`#+property: header-args :tangle yes`)
@@ -2699,7 +2699,7 @@ Block below will pick up reference from the 2nd block name
26992699
`#+name: headline2block` `#+begin_src lua :tangle yes` `print('Headline 2')`
27002700
`#+end_src` `#+end_src`
27012701

2702-
Running |orgmode-org_babeltangle| will create file `~/org/todos.lua` with this
2702+
Running |orgmode-org_babel_tangle| will create file `~/org/todos.lua` with this
27032703
content:
27042704

27052705
`#+begin_src lua` `print('Headline 2')` `print('Headline 1')` ==
@@ -2717,7 +2717,7 @@ Here we disable tangling, so only first block will give results with the noweb
27172717
`#+name: headline2block` `#+begin_src lua :tangle no` `print('Headline 2')`
27182718
`#+end_src`
27192719

2720-
Running |orgmode-org_babeltangle| will create file `~/org/my_tangled_file.lua`
2720+
Running |orgmode-org_babel_tangle| will create file `~/org/my_tangled_file.lua`
27212721
with this content:
27222722

27232723
`#+begin_src lua` `print('Headline 2')` `print('Headline 1')` `#+end_src`

0 commit comments

Comments
 (0)