Skip to content

Commit ba28d8b

Browse files
author
github-actions
committed
[docgen] Update doc/orgmode.txt
1 parent d9fd462 commit ba28d8b

File tree

1 file changed

+44
-37
lines changed

1 file changed

+44
-37
lines changed

‎doc/orgmode.txt

Lines changed: 44 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -145,26 +145,27 @@ CONTENTS *orgmode-content
145145
1.3.7. Dot repeat.....................................|orgmode-dot_repeat|
146146
1.4. Document Diagnostics.......................|orgmode-document_diagnostics|
147147
1.5. Tables...................................................|orgmode-tables|
148-
1.6. Autocompletion...................................|orgmode-autocompletion|
149-
1.7. Abbreviations.....................................|orgmode-abbreviations|
150-
1.8. Colors...................................................|orgmode-colors|
151-
1.8.1. Highlight Groups.........................|orgmode-highlight_groups|
152-
1.9. Advanced search.................................|orgmode-advanced_search|
153-
1.10. Notifications (experimental)......|orgmode-notifications_(experimental)|
154-
1.10.1. Cron................................................|orgmode-cron|
155-
1.11. Clocking..............................................|orgmode-clocking|
156-
1.11.1. Clock in................................|orgmode-clock_in|
157-
1.11.2. Clock out..............................|orgmode-clock_out|
158-
1.11.3. Clock cancel........................|orgmode-clock_cancel|
159-
1.11.4. Clock goto............................|orgmode-clock_goto|
160-
1.11.5. Set effort............................|orgmode-set_effort|
161-
1.11.6. Clock report table............|orgmode-clock_report_table|
162-
1.11.7. Automatic updates of totals.|orgmode-automatic_updates_of_totals|
163-
1.11.8. Recalculating totals........|orgmode-recalculating_totals|
164-
1.11.9. Statusline function..........|orgmode-statusline_function|
165-
1.12. Changelog............................................|orgmode-changelog|
166-
1.12.1. 24 October 2021......................|orgmode-24_october_2021|
167-
1.12.2. 10 October 2021......................|orgmode-10_october_2021|
148+
1.6. Hyperlinks...........................................|orgmode-hyperlinks|
149+
1.7. Autocompletion...................................|orgmode-autocompletion|
150+
1.8. Abbreviations.....................................|orgmode-abbreviations|
151+
1.9. Colors...................................................|orgmode-colors|
152+
1.9.1. Highlight Groups.........................|orgmode-highlight_groups|
153+
1.10. Advanced search................................|orgmode-advanced_search|
154+
1.11. Notifications (experimental)......|orgmode-notifications_(experimental)|
155+
1.11.1. Cron................................................|orgmode-cron|
156+
1.12. Clocking..............................................|orgmode-clocking|
157+
1.12.1. Clock in................................|orgmode-clock_in|
158+
1.12.2. Clock out..............................|orgmode-clock_out|
159+
1.12.3. Clock cancel........................|orgmode-clock_cancel|
160+
1.12.4. Clock goto............................|orgmode-clock_goto|
161+
1.12.5. Set effort............................|orgmode-set_effort|
162+
1.12.6. Clock report table............|orgmode-clock_report_table|
163+
1.12.7. Automatic updates of totals.|orgmode-automatic_updates_of_totals|
164+
1.12.8. Recalculating totals........|orgmode-recalculating_totals|
165+
1.12.9. Statusline function..........|orgmode-statusline_function|
166+
1.13. Changelog............................................|orgmode-changelog|
167+
1.13.1. 24 October 2021......................|orgmode-24_october_2021|
168+
1.13.2. 10 October 2021......................|orgmode-10_october_2021|
168169

169170
================================================================================
170171
TABLE OF CONTENT *orgmode-table_of_content*
@@ -184,13 +185,14 @@ TABLE OF CONTENT *orgmode-table_of_conten
184185
7. Dot repeat (#dot-repeat)
185186
4. Document Diagnostics (#document-diagnostics)
186187
5. Tables (#tables)
187-
6. Autocompletion (#autocompletion)
188-
7. Abbreviations (#abbreviations)
189-
8. Colors (#colors)
190-
9. Advanced search (#advanced-search)
191-
10. Notifications (experimental) (#notifications-experimental)
192-
11. Clocking (#clocking)
193-
12. Changelog (#changelog)
188+
6. Hyperlinks (#hyperlinks)
189+
7. Autocompletion (#autocompletion)
190+
8. Abbreviations (#abbreviations)
191+
9. Colors (#colors)
192+
10. Advanced search (#advanced-search)
193+
11. Notifications (experimental) (#notifications-experimental)
194+
12. Clocking (#clocking)
195+
13. Changelog (#changelog)
194196

195197
--------------------------------------------------------------------------------
196198
GETTING STARTED WITH ORGMODE *orgmode-getting_started_with_orgmode*
@@ -297,7 +299,7 @@ Always open in tab:
297299

298300
Always open vertically:
299301
>
300-
win_split_mode = 'tabnew'
302+
win_split_mode = 'vsplit'
301303
<
302304

303305
Always open horizontally with specific height of 20 lines:
@@ -1028,15 +1030,7 @@ Toggle current line to headline and vice versa. Checkboxes will turn into TODO h
10281030
ORG_OPEN_AT_POINT *orgmode-org_open_at_point*
10291031

10301032
mapped to: `<Leader>oo`
1031-
Open hyperlink or date under cursor.
1032-
Hyperlink types supported:
1033-
* URL (http://, https://)
1034-
* File (starts with `file:`. Example: `file:/home/user/.config/nvim/init.lua`) Optionally, a line number can be specified
1035-
using the '+' character. Example: `file:/home/user/.config/nvim/init.lua +10`
1036-
* Headline title target (starts with `*`)
1037-
* Headline with `CUSTOM_ID` property (starts with `#`)
1038-
* Fallback: If file path, opens the file, otherwise, tries to find the Headline title.
1039-
When date is under the cursor, open the agenda for that day.
1033+
Open hyperlink or date under cursor. When date is under the cursor, open the agenda for that day.
10401034

10411035
ORG_EDIT_SPECIAL *orgmode-org_edit_special*
10421036

@@ -1335,6 +1329,19 @@ And going to line `4` and pressing `gqgq`, it will format it to this:
13351329
| col 1 | col 2 |
13361330
<
13371331

1332+
--------------------------------------------------------------------------------
1333+
HYPERLINKS *orgmode-hyperlinks*
1334+
1335+
The format for links is either `[[LINK]]` or `[[LINK][DESCRIPTION]]`. If a description is provided, the actual link is concealed in favor of the description.
1336+
1337+
Hyperlink types supported:
1338+
* URL (http://, https://)
1339+
* File (starts with `file:`. Example: `file:/home/user/.config/nvim/init.lua`) Optionally, a line number can be specified
1340+
using the '+' character (Example: `file:/home/user/.config/nvim/init.lua +10`) or a headline within the specified file using '::' (Example: `file:/home/user/org/file.org::*Specific Headline`)
1341+
* Headline title target within the same file (starts with `*`)
1342+
* Headline with `CUSTOM_ID` property within the same file (starts with `#`)
1343+
* Fallback: If file path, opens the file, otherwise, tries to find the headline title.
1344+
13381345
--------------------------------------------------------------------------------
13391346
AUTOCOMPLETION *orgmode-autocompletion*
13401347

0 commit comments

Comments
 (0)