Skip to content

Commit 4478f7a

Browse files
author
github-actions
committed
[docgen] Update doc/orgmode.txt
1 parent f9256c5 commit 4478f7a

File tree

1 file changed

+84
-36
lines changed

1 file changed

+84
-36
lines changed

‎doc/orgmode.txt‎

Lines changed: 84 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,13 @@ CONTENTS *orgmode-content
2929
1.2.1.18. org_custom_exports..............|orgmode-org_custom_exports|
3030
1.2.1.19. org_time_stamp_rounding_minutes.|orgmode-org_time_stamp_rounding_minutes|
3131
1.2.1.20. org_blank_before_new_entry.|orgmode-org_blank_before_new_entry|
32-
1.2.1.21. calendar_week_start_day....|orgmode-calendar_week_start_day|
33-
1.2.1.22. emacs_config..........................|orgmode-emacs_config|
32+
1.2.1.21. org_id_uuid_program............|orgmode-org_id_uuid_program|
33+
1.2.1.22. org_id_ts_format..................|orgmode-org_id_ts_format|
34+
1.2.1.23. org_id_method........................|orgmode-org_id_method|
35+
1.2.1.24. org_id_prefix........................|orgmode-org_id_prefix|
36+
1.2.1.25. org_id_link_to_org_use_id.|orgmode-org_id_link_to_org_use_id|
37+
1.2.1.26. calendar_week_start_day....|orgmode-calendar_week_start_day|
38+
1.2.1.27. emacs_config..........................|orgmode-emacs_config|
3439
1.2.2. Agenda settings...........................|orgmode-agenda_settings|
3540
1.2.2.1. org_deadline_warning_days.|orgmode-org_deadline_warning_days|
3641
1.2.2.2. org_agenda_span.....................|orgmode-org_agenda_span|
@@ -105,39 +110,40 @@ CONTENTS *orgmode-content
105110
1.3.5.12. org_toggle_checkbox............|orgmode-org_toggle_checkbox|
106111
1.3.5.13. org_toggle_heading..............|orgmode-org_toggle_heading|
107112
1.3.5.14. org_insert_link....................|orgmode-org_insert_link|
108-
1.3.5.15. org_open_at_point................|orgmode-org_open_at_point|
109-
1.3.5.16. org_edit_special..................|orgmode-org_edit_special|
110-
1.3.5.17. org_cycle................................|orgmode-org_cycle|
111-
1.3.5.18. org_global_cycle..................|orgmode-org_global_cycle|
112-
1.3.5.19. org_archive_subtree............|orgmode-org_archive_subtree|
113-
1.3.5.20. org_set_tags_command..........|orgmode-org_set_tags_command|
114-
1.3.5.21. org_toggle_archive_tag......|orgmode-org_toggle_archive_tag|
115-
1.3.5.22. org_do_promote......................|orgmode-org_do_promote|
116-
1.3.5.23. org_do_demote........................|orgmode-org_do_demote|
117-
1.3.5.24. org_promote_subtree............|orgmode-org_promote_subtree|
118-
1.3.5.25. org_demote_subtree..............|orgmode-org_demote_subtree|
119-
1.3.5.26. org_meta_return....................|orgmode-org_meta_return|
120-
1.3.5.27. org_insert_heading_respect_content.|orgmode-org_insert_heading_respect_content|
121-
1.3.5.28. org_insert_todo_heading....|orgmode-org_insert_todo_heading|
122-
1.3.5.29. org_insert_todo_heading_respect_content.|orgmode-org_insert_todo_heading_respect_content|
123-
1.3.5.30. org_move_subtree_up............|orgmode-org_move_subtree_up|
124-
1.3.5.31. org_move_subtree_down........|orgmode-org_move_subtree_down|
125-
1.3.5.32. org_export..............................|orgmode-org_export|
126-
1.3.5.33. org_next_visible_heading..|orgmode-org_next_visible_heading|
127-
1.3.5.34. org_previous_visible_heading.|orgmode-org_previous_visible_heading|
128-
1.3.5.35. org_forward_heading_same_level.|orgmode-org_forward_heading_same_level|
129-
1.3.5.36. org_backward_heading_same_level.|orgmode-org_backward_heading_same_level|
130-
1.3.5.37. outline_up_heading..............|orgmode-outline_up_heading|
131-
1.3.5.38. org_deadline..........................|orgmode-org_deadline|
132-
1.3.5.39. org_schedule..........................|orgmode-org_schedule|
133-
1.3.5.40. org_time_stamp......................|orgmode-org_time_stamp|
134-
1.3.5.41. org_time_stamp_inactive....|orgmode-org_time_stamp_inactive|
135-
1.3.5.42. org_clock_in..........................|orgmode-org_clock_in|
136-
1.3.5.43. org_clock_out........................|orgmode-org_clock_out|
137-
1.3.5.44. org_clock_cancel..................|orgmode-org_clock_cancel|
138-
1.3.5.45. org_clock_goto......................|orgmode-org_clock_goto|
139-
1.3.5.46. org_set_effort......................|orgmode-org_set_effort|
140-
1.3.5.47. org_show_help........................|orgmode-org_show_help|
113+
1.3.5.15. org_store_link......................|orgmode-org_store_link|
114+
1.3.5.16. org_open_at_point................|orgmode-org_open_at_point|
115+
1.3.5.17. org_edit_special..................|orgmode-org_edit_special|
116+
1.3.5.18. org_cycle................................|orgmode-org_cycle|
117+
1.3.5.19. org_global_cycle..................|orgmode-org_global_cycle|
118+
1.3.5.20. org_archive_subtree............|orgmode-org_archive_subtree|
119+
1.3.5.21. org_set_tags_command..........|orgmode-org_set_tags_command|
120+
1.3.5.22. org_toggle_archive_tag......|orgmode-org_toggle_archive_tag|
121+
1.3.5.23. org_do_promote......................|orgmode-org_do_promote|
122+
1.3.5.24. org_do_demote........................|orgmode-org_do_demote|
123+
1.3.5.25. org_promote_subtree............|orgmode-org_promote_subtree|
124+
1.3.5.26. org_demote_subtree..............|orgmode-org_demote_subtree|
125+
1.3.5.27. org_meta_return....................|orgmode-org_meta_return|
126+
1.3.5.28. org_insert_heading_respect_content.|orgmode-org_insert_heading_respect_content|
127+
1.3.5.29. org_insert_todo_heading....|orgmode-org_insert_todo_heading|
128+
1.3.5.30. org_insert_todo_heading_respect_content.|orgmode-org_insert_todo_heading_respect_content|
129+
1.3.5.31. org_move_subtree_up............|orgmode-org_move_subtree_up|
130+
1.3.5.32. org_move_subtree_down........|orgmode-org_move_subtree_down|
131+
1.3.5.33. org_export..............................|orgmode-org_export|
132+
1.3.5.34. org_next_visible_heading..|orgmode-org_next_visible_heading|
133+
1.3.5.35. org_previous_visible_heading.|orgmode-org_previous_visible_heading|
134+
1.3.5.36. org_forward_heading_same_level.|orgmode-org_forward_heading_same_level|
135+
1.3.5.37. org_backward_heading_same_level.|orgmode-org_backward_heading_same_level|
136+
1.3.5.38. outline_up_heading..............|orgmode-outline_up_heading|
137+
1.3.5.39. org_deadline..........................|orgmode-org_deadline|
138+
1.3.5.40. org_schedule..........................|orgmode-org_schedule|
139+
1.3.5.41. org_time_stamp......................|orgmode-org_time_stamp|
140+
1.3.5.42. org_time_stamp_inactive....|orgmode-org_time_stamp_inactive|
141+
1.3.5.43. org_clock_in..........................|orgmode-org_clock_in|
142+
1.3.5.44. org_clock_out........................|orgmode-org_clock_out|
143+
1.3.5.45. org_clock_cancel..................|orgmode-org_clock_cancel|
144+
1.3.5.46. org_clock_goto......................|orgmode-org_clock_goto|
145+
1.3.5.47. org_set_effort......................|orgmode-org_set_effort|
146+
1.3.5.48. org_show_help........................|orgmode-org_show_help|
141147
1.3.6. Edit Src.........................................|orgmode-edit_src|
142148
1.3.6.1. org_edit_src_abort...............|orgmode-org_edit_src_abort|
143149
1.3.6.2. org_edit_src_save.................|orgmode-org_edit_src_save|
@@ -546,6 +552,39 @@ Determine if blank line should be prepended when:
546552
* Adding heading via `org_meta_return` and `org_insert_*` mappings
547553
* Adding a list item via `org_meta_return`
548554

555+
ORG_ID_UUID_PROGRAM *orgmode-org_id_uuid_program*
556+
557+
type: `string`
558+
default value: `uuidgen`
559+
External program used to generate uuid's for id module
560+
561+
ORG_ID_TS_FORMAT *orgmode-org_id_ts_format*
562+
563+
type: `string`
564+
default value: `%Y%m%d%H%M%S`
565+
Format of the id generated when org_id_method (#org_id_method) is set to `ts`.
566+
567+
ORG_ID_METHOD *orgmode-org_id_method*
568+
569+
type: `'uuid' | 'ts' | 'org'`
570+
default value: `uuid`
571+
What method to use to generate ids via org id module.
572+
* `uuid` - Use org_id_uuid_program (#org_id_uuid_program) to generate the id
573+
* `ts` - Generate id from current timestamp using format org_id_ts_format (#org_id_ts_format)
574+
* `org` - Generate a random 12 digit number and prepend org_id_prefix (#org_id_prefix)
575+
576+
ORG_ID_PREFIX *orgmode-org_id_prefix*
577+
578+
type: `string | nil`
579+
default value: `nil`
580+
Prefix added to the generated id when org_id_method (#org_id_method) is set to `org`.
581+
582+
ORG_ID_LINK_TO_ORG_USE_ID *orgmode-org_id_link_to_org_use_id*
583+
584+
type: `boolean`
585+
default value: `false`
586+
If `true`, generate ID with the Org ID module and append it to the headline as property. More info on org_store_link (#org_store_link)
587+
549588
CALENDAR_WEEK_START_DAY *orgmode-calendar_week_start_day*
550589

551590
type: `number`
@@ -1206,8 +1245,17 @@ Toggle current line to headline and vice versa. Checkboxes will turn into TODO h
12061245

12071246
ORG_INSERT_LINK *orgmode-org_insert_link*
12081247

1209-
mapped to: `<Leader>oil`
1248+
mapped to: `<Leader>oli`
12101249
Insert a hyperlink at cursor position. When the cursor is on a hyperlink, edit that hyperlink.
1250+
If there are any links stored with org_store_link (#org_store_link), pressing `<TAB>` to autocomplete the input
1251+
will show list of all stored links to select. Links generated with ID are properly expanded to valid links after selection.
1252+
1253+
ORG_STORE_LINK *orgmode-org_store_link*
1254+
1255+
mapped to: `<Leader>ols`
1256+
Generate a link to the closest headline. If org_id_link_to_org_use_id (#org_id_link_to_org_use_id) is `true`,
1257+
it appends the `ID` property to the headline, and generates link with that id to be inserted via org_insert_link (#org_insert_link).
1258+
When org_id_link_to_org_use_id (#org_id_link_to_org_use_id) is `false`, it generates the standard file::*headline link (example: `file:/path/to/my/todos.org::*My headline`)
12111259

12121260
ORG_OPEN_AT_POINT *orgmode-org_open_at_point*
12131261

0 commit comments

Comments
 (0)