Skip to content

Commit 220f7f0

Browse files
author
github-actions
committed
[docgen] Update doc/orgmode.txt
1 parent 14e880e commit 220f7f0

File tree

1 file changed

+110
-67
lines changed

1 file changed

+110
-67
lines changed

‎doc/orgmode.txt‎

Lines changed: 110 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -84,67 +84,71 @@ CONTENTS *orgmode-content
8484
1.3.3.2. org_capture_refile...............|orgmode-org_capture_refile|
8585
1.3.3.3. org_capture_kill...................|orgmode-org_capture_kill|
8686
1.3.3.4. org_capture_show_help.........|orgmode-org_capture_show_help|
87-
1.3.4. Org mappings.................................|orgmode-org_mappings|
88-
1.3.4.1. org_refile...............................|orgmode-org_refile|
89-
1.3.4.2. org_timestamp_up...................|orgmode-org_timestamp_up|
90-
1.3.4.3. org_timestamp_down...............|orgmode-org_timestamp_down|
91-
1.3.4.4. org_timestamp_up_day...........|orgmode-org_timestamp_up_day|
92-
1.3.4.5. org_timestamp_down_day.......|orgmode-org_timestamp_down_day|
93-
1.3.4.6. org_change_date.....................|orgmode-org_change_date|
94-
1.3.4.7. org_priority...........................|orgmode-org_priority|
95-
1.3.4.8. org_priority_up.....................|orgmode-org_priority_up|
96-
1.3.4.9. org_priority_down.................|orgmode-org_priority_down|
97-
1.3.4.10. org_todo..................................|orgmode-org_todo|
98-
1.3.4.11. org_todo_prev........................|orgmode-org_todo_prev|
99-
1.3.4.12. org_toggle_checkbox............|orgmode-org_toggle_checkbox|
100-
1.3.4.13. org_toggle_heading..............|orgmode-org_toggle_heading|
101-
1.3.4.14. org_open_at_point................|orgmode-org_open_at_point|
102-
1.3.4.15. org_edit_special..................|orgmode-org_edit_special|
103-
1.3.4.16. org_cycle................................|orgmode-org_cycle|
104-
1.3.4.17. org_global_cycle..................|orgmode-org_global_cycle|
105-
1.3.4.18. org_archive_subtree............|orgmode-org_archive_subtree|
106-
1.3.4.19. org_set_tags_command..........|orgmode-org_set_tags_command|
107-
1.3.4.20. org_toggle_archive_tag......|orgmode-org_toggle_archive_tag|
108-
1.3.4.21. org_do_promote......................|orgmode-org_do_promote|
109-
1.3.4.22. org_do_demote........................|orgmode-org_do_demote|
110-
1.3.4.23. org_promote_subtree............|orgmode-org_promote_subtree|
111-
1.3.4.24. org_demote_subtree..............|orgmode-org_demote_subtree|
112-
1.3.4.25. org_meta_return....................|orgmode-org_meta_return|
113-
1.3.4.26. org_insert_heading_respect_content.|orgmode-org_insert_heading_respect_content|
114-
1.3.4.27. org_insert_todo_heading....|orgmode-org_insert_todo_heading|
115-
1.3.4.28. org_insert_todo_heading_respect_content.|orgmode-org_insert_todo_heading_respect_content|
116-
1.3.4.29. org_move_subtree_up............|orgmode-org_move_subtree_up|
117-
1.3.4.30. org_move_subtree_down........|orgmode-org_move_subtree_down|
118-
1.3.4.31. org_export..............................|orgmode-org_export|
119-
1.3.4.32. org_next_visible_heading..|orgmode-org_next_visible_heading|
120-
1.3.4.33. org_previous_visible_heading.|orgmode-org_previous_visible_heading|
121-
1.3.4.34. org_forward_heading_same_level.|orgmode-org_forward_heading_same_level|
122-
1.3.4.35. org_backward_heading_same_level.|orgmode-org_backward_heading_same_level|
123-
1.3.4.36. outline_up_heading..............|orgmode-outline_up_heading|
124-
1.3.4.37. org_deadline..........................|orgmode-org_deadline|
125-
1.3.4.38. org_schedule..........................|orgmode-org_schedule|
126-
1.3.4.39. org_time_stamp......................|orgmode-org_time_stamp|
127-
1.3.4.40. org_time_stamp_inactive....|orgmode-org_time_stamp_inactive|
128-
1.3.4.41. org_clock_in..........................|orgmode-org_clock_in|
129-
1.3.4.42. org_clock_out........................|orgmode-org_clock_out|
130-
1.3.4.43. org_clock_cancel..................|orgmode-org_clock_cancel|
131-
1.3.4.44. org_clock_goto......................|orgmode-org_clock_goto|
132-
1.3.4.45. org_set_effort......................|orgmode-org_set_effort|
133-
1.3.4.46. org_show_help........................|orgmode-org_show_help|
134-
1.3.5. Edit Src.........................................|orgmode-edit_src|
135-
1.3.5.1. org_edit_src_abort...............|orgmode-org_edit_src_abort|
136-
1.3.5.2. org_edit_src_save.................|orgmode-org_edit_src_save|
137-
1.3.5.3. org_edit_src_show_help.......|orgmode-org_edit_src_show_help|
138-
1.3.6. Text objects.................................|orgmode-text_objects|
139-
1.3.6.1. inner_heading.........................|orgmode-inner_heading|
140-
1.3.6.2. around_heading.......................|orgmode-around_heading|
141-
1.3.6.3. inner_subtree.........................|orgmode-inner_subtree|
142-
1.3.6.4. around_subtree.......................|orgmode-around_subtree|
143-
1.3.6.5. inner_heading_from_root.....|orgmode-inner_heading_from_root|
144-
1.3.6.6. around_heading_from_root...|orgmode-around_heading_from_root|
145-
1.3.6.7. inner_subtree_from_root.....|orgmode-inner_subtree_from_root|
146-
1.3.6.8. around_subtree_from_root...|orgmode-around_subtree_from_root|
147-
1.3.7. Dot repeat.....................................|orgmode-dot_repeat|
87+
1.3.4. Closing note mappings...............|orgmode-closing_note_mappings|
88+
1.3.4.1. org_note_finalize.................|orgmode-org_note_finalize|
89+
1.3.4.2. org_note_kill.........................|orgmode-org_note_kill|
90+
1.3.4.3. org_capture_show_help.........|orgmode-org_capture_show_help|
91+
1.3.5. Org mappings.................................|orgmode-org_mappings|
92+
1.3.5.1. org_refile...............................|orgmode-org_refile|
93+
1.3.5.2. org_timestamp_up...................|orgmode-org_timestamp_up|
94+
1.3.5.3. org_timestamp_down...............|orgmode-org_timestamp_down|
95+
1.3.5.4. org_timestamp_up_day...........|orgmode-org_timestamp_up_day|
96+
1.3.5.5. org_timestamp_down_day.......|orgmode-org_timestamp_down_day|
97+
1.3.5.6. org_change_date.....................|orgmode-org_change_date|
98+
1.3.5.7. org_priority...........................|orgmode-org_priority|
99+
1.3.5.8. org_priority_up.....................|orgmode-org_priority_up|
100+
1.3.5.9. org_priority_down.................|orgmode-org_priority_down|
101+
1.3.5.10. org_todo..................................|orgmode-org_todo|
102+
1.3.5.11. org_todo_prev........................|orgmode-org_todo_prev|
103+
1.3.5.12. org_toggle_checkbox............|orgmode-org_toggle_checkbox|
104+
1.3.5.13. org_toggle_heading..............|orgmode-org_toggle_heading|
105+
1.3.5.14. org_open_at_point................|orgmode-org_open_at_point|
106+
1.3.5.15. org_edit_special..................|orgmode-org_edit_special|
107+
1.3.5.16. org_cycle................................|orgmode-org_cycle|
108+
1.3.5.17. org_global_cycle..................|orgmode-org_global_cycle|
109+
1.3.5.18. org_archive_subtree............|orgmode-org_archive_subtree|
110+
1.3.5.19. org_set_tags_command..........|orgmode-org_set_tags_command|
111+
1.3.5.20. org_toggle_archive_tag......|orgmode-org_toggle_archive_tag|
112+
1.3.5.21. org_do_promote......................|orgmode-org_do_promote|
113+
1.3.5.22. org_do_demote........................|orgmode-org_do_demote|
114+
1.3.5.23. org_promote_subtree............|orgmode-org_promote_subtree|
115+
1.3.5.24. org_demote_subtree..............|orgmode-org_demote_subtree|
116+
1.3.5.25. org_meta_return....................|orgmode-org_meta_return|
117+
1.3.5.26. org_insert_heading_respect_content.|orgmode-org_insert_heading_respect_content|
118+
1.3.5.27. org_insert_todo_heading....|orgmode-org_insert_todo_heading|
119+
1.3.5.28. org_insert_todo_heading_respect_content.|orgmode-org_insert_todo_heading_respect_content|
120+
1.3.5.29. org_move_subtree_up............|orgmode-org_move_subtree_up|
121+
1.3.5.30. org_move_subtree_down........|orgmode-org_move_subtree_down|
122+
1.3.5.31. org_export..............................|orgmode-org_export|
123+
1.3.5.32. org_next_visible_heading..|orgmode-org_next_visible_heading|
124+
1.3.5.33. org_previous_visible_heading.|orgmode-org_previous_visible_heading|
125+
1.3.5.34. org_forward_heading_same_level.|orgmode-org_forward_heading_same_level|
126+
1.3.5.35. org_backward_heading_same_level.|orgmode-org_backward_heading_same_level|
127+
1.3.5.36. outline_up_heading..............|orgmode-outline_up_heading|
128+
1.3.5.37. org_deadline..........................|orgmode-org_deadline|
129+
1.3.5.38. org_schedule..........................|orgmode-org_schedule|
130+
1.3.5.39. org_time_stamp......................|orgmode-org_time_stamp|
131+
1.3.5.40. org_time_stamp_inactive....|orgmode-org_time_stamp_inactive|
132+
1.3.5.41. org_clock_in..........................|orgmode-org_clock_in|
133+
1.3.5.42. org_clock_out........................|orgmode-org_clock_out|
134+
1.3.5.43. org_clock_cancel..................|orgmode-org_clock_cancel|
135+
1.3.5.44. org_clock_goto......................|orgmode-org_clock_goto|
136+
1.3.5.45. org_set_effort......................|orgmode-org_set_effort|
137+
1.3.5.46. org_show_help........................|orgmode-org_show_help|
138+
1.3.6. Edit Src.........................................|orgmode-edit_src|
139+
1.3.6.1. org_edit_src_abort...............|orgmode-org_edit_src_abort|
140+
1.3.6.2. org_edit_src_save.................|orgmode-org_edit_src_save|
141+
1.3.6.3. org_edit_src_show_help.......|orgmode-org_edit_src_show_help|
142+
1.3.7. Text objects.................................|orgmode-text_objects|
143+
1.3.7.1. inner_heading.........................|orgmode-inner_heading|
144+
1.3.7.2. around_heading.......................|orgmode-around_heading|
145+
1.3.7.3. inner_subtree.........................|orgmode-inner_subtree|
146+
1.3.7.4. around_subtree.......................|orgmode-around_subtree|
147+
1.3.7.5. inner_heading_from_root.....|orgmode-inner_heading_from_root|
148+
1.3.7.6. around_heading_from_root...|orgmode-around_heading_from_root|
149+
1.3.7.7. inner_subtree_from_root.....|orgmode-inner_subtree_from_root|
150+
1.3.7.8. around_subtree_from_root...|orgmode-around_subtree_from_root|
151+
1.3.8. Dot repeat.....................................|orgmode-dot_repeat|
148152
1.4. Document Diagnostics.......................|orgmode-document_diagnostics|
149153
1.5. Tables...................................................|orgmode-tables|
150154
1.6. Hyperlinks...........................................|orgmode-hyperlinks|
@@ -182,10 +186,11 @@ TABLE OF CONTENT *orgmode-table_of_conten
182186
1. Global mappings (#global-mappings)
183187
2. Agenda mappings (#agenda-mappings)
184188
3. Capture mappings (#capture-mappings)
185-
4. Org mappings (#org-mappings)
186-
5. Edit Src mappings (#edit-src)
187-
6. Text objects (#text-objects)
188-
7. Dot repeat (#dot-repeat)
189+
4. Note mappings (#note-mappings)
190+
5. Org mappings (#org-mappings)
191+
6. Edit Src mappings (#edit-src)
192+
7. Text objects (#text-objects)
193+
8. Dot repeat (#dot-repeat)
189194
4. Document Diagnostics (#document-diagnostics)
190195
5. Tables (#tables)
191196
6. Hyperlinks (#hyperlinks)
@@ -393,8 +398,10 @@ ORG_LOG_DONE *orgmode-org_log_don
393398

394399
type: `string|nil`
395400
default value: `time`
396-
When set to `time`(default), adds `CLOSED` date when marking headline as done.
397-
When set to `false`, it is disabled.
401+
Possible values:
402+
* `time` - adds `CLOSED` date when marking headline as done
403+
* `note` - adds `CLOSED` date as above, and prompts for closing note via capture window. Confirm note with `org_note_finalize` (Default `<C-c>`), or ignore providing note via `org_note_kill` (Default `<Leader>ok`)
404+
* `nil|false` - Disable any logging
398405

399406
ORG_HIGHLIGHT_LATEX_AND_RELATED *orgmode-org_highlight_latex_and_related*
400407

@@ -978,6 +985,40 @@ These mappings live under `mappings.capture`, and can be changed like this:
978985
})
979986
<
980987

988+
CLOSING NOTE MAPPINGS *orgmode-closing_note_mappings*
989+
990+
Mappings used in closing note window.
991+
992+
ORG_NOTE_FINALIZE *orgmode-org_note_finalize*
993+
994+
mapped to: `<C-c>`
995+
Save note window content as closing note for a headline. Ignores first comment (if exists)
996+
997+
ORG_NOTE_KILL *orgmode-org_note_kill*
998+
999+
mapped to: `<Leader>ok`
1000+
Close note window without saving anything
1001+
1002+
ORG_CAPTURE_SHOW_HELP *orgmode-org_capture_show_help*
1003+
1004+
mapped to: `g?`
1005+
Show help popup with mappings
1006+
1007+
These mappings live under `mappings.capture`, and can be changed like this:
1008+
>
1009+
require('orgmode').setup({
1010+
org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'},
1011+
org_default_notes_file = '~/Dropbox/org/refile.org',
1012+
mappings = {
1013+
capture = {
1014+
org_capture_finalize = '<Leader>w',
1015+
org_capture_refile = 'R',
1016+
org_capture_kill = 'Q'
1017+
}
1018+
}
1019+
})
1020+
<
1021+
9811022
ORG MAPPINGS *orgmode-org_mappings*
9821023

9831024
Mappings for `org` files.
@@ -1433,7 +1474,9 @@ ABBREVIATIONS *orgmode-abbreviation
14331474
`org` buffers have access to two abbreviations:
14341475

14351476
* `:today:` - expands to today's date (example: `<2021-06-29 Tue>`)
1477+
* `:itoday:` - expands to an invactive version of today's date (example: `[2021-06-29 Tue]`)
14361478
* `:now:` - expands to today's date and current time (example: `<2021-06-29 Tue 15:32>`)
1479+
* `:inow:` - expands to invactive version of today's date and current time (example: `[2021-06-29 Tue 15:32]`)
14371480

14381481
--------------------------------------------------------------------------------
14391482
FORMATTING *orgmode-formatting*

0 commit comments

Comments
 (0)