Skip to content

Commit bf53c20

Browse files
author
github-actions
committed
[docgen] Update doc/orgmode.txt
1 parent 68179a5 commit bf53c20

File tree

1 file changed

+39
-23
lines changed

1 file changed

+39
-23
lines changed

doc/orgmode.txt

+39-23
Original file line numberDiff line numberDiff line change
@@ -150,24 +150,25 @@ CONTENTS *orgmode-content
150150
1.6. Hyperlinks...........................................|orgmode-hyperlinks|
151151
1.7. Autocompletion...................................|orgmode-autocompletion|
152152
1.8. Abbreviations.....................................|orgmode-abbreviations|
153-
1.9. Colors...................................................|orgmode-colors|
154-
1.9.1. Highlight Groups.........................|orgmode-highlight_groups|
155-
1.10. Advanced search................................|orgmode-advanced_search|
156-
1.11. Notifications (experimental)......|orgmode-notifications_(experimental)|
157-
1.11.1. Cron................................................|orgmode-cron|
158-
1.12. Clocking..............................................|orgmode-clocking|
159-
1.12.1. Clock in................................|orgmode-clock_in|
160-
1.12.2. Clock out..............................|orgmode-clock_out|
161-
1.12.3. Clock cancel........................|orgmode-clock_cancel|
162-
1.12.4. Clock goto............................|orgmode-clock_goto|
163-
1.12.5. Set effort............................|orgmode-set_effort|
164-
1.12.6. Clock report table............|orgmode-clock_report_table|
165-
1.12.7. Automatic updates of totals.|orgmode-automatic_updates_of_totals|
166-
1.12.8. Recalculating totals........|orgmode-recalculating_totals|
167-
1.12.9. Statusline function..........|orgmode-statusline_function|
168-
1.13. Changelog............................................|orgmode-changelog|
169-
1.13.1. 24 October 2021......................|orgmode-24_october_2021|
170-
1.13.2. 10 October 2021......................|orgmode-10_october_2021|
153+
1.9. Formatting...........................................|orgmode-formatting|
154+
1.10. Colors..................................................|orgmode-colors|
155+
1.10.1. Highlight Groups........................|orgmode-highlight_groups|
156+
1.11. Advanced search................................|orgmode-advanced_search|
157+
1.12. Notifications (experimental)......|orgmode-notifications_(experimental)|
158+
1.12.1. Cron................................................|orgmode-cron|
159+
1.13. Clocking..............................................|orgmode-clocking|
160+
1.13.1. Clock in................................|orgmode-clock_in|
161+
1.13.2. Clock out..............................|orgmode-clock_out|
162+
1.13.3. Clock cancel........................|orgmode-clock_cancel|
163+
1.13.4. Clock goto............................|orgmode-clock_goto|
164+
1.13.5. Set effort............................|orgmode-set_effort|
165+
1.13.6. Clock report table............|orgmode-clock_report_table|
166+
1.13.7. Automatic updates of totals.|orgmode-automatic_updates_of_totals|
167+
1.13.8. Recalculating totals........|orgmode-recalculating_totals|
168+
1.13.9. Statusline function..........|orgmode-statusline_function|
169+
1.14. Changelog............................................|orgmode-changelog|
170+
1.14.1. 24 October 2021......................|orgmode-24_october_2021|
171+
1.14.2. 10 October 2021......................|orgmode-10_october_2021|
171172

172173
================================================================================
173174
TABLE OF CONTENT *orgmode-table_of_content*
@@ -190,11 +191,12 @@ TABLE OF CONTENT *orgmode-table_of_conten
190191
6. Hyperlinks (#hyperlinks)
191192
7. Autocompletion (#autocompletion)
192193
8. Abbreviations (#abbreviations)
193-
9. Colors (#colors)
194-
10. Advanced search (#advanced-search)
195-
11. Notifications (experimental) (#notifications-experimental)
196-
12. Clocking (#clocking)
197-
13. Changelog (#changelog)
194+
9. Formatting (#formatting)
195+
10. Colors (#colors)
196+
11. Advanced search (#advanced-search)
197+
12. Notifications (experimental) (#notifications-experimental)
198+
13. Clocking (#clocking)
199+
14. Changelog (#changelog)
198200

199201
--------------------------------------------------------------------------------
200202
GETTING STARTED WITH ORGMODE *orgmode-getting_started_with_orgmode*
@@ -1423,6 +1425,20 @@ ABBREVIATIONS *orgmode-abbreviation
14231425
* `:today:` - expands to today's date (example: `<2021-06-29 Tue>`)
14241426
* `:now:` - expands to today's date and current time (example: `<2021-06-29 Tue 15:32>`)
14251427

1428+
--------------------------------------------------------------------------------
1429+
FORMATTING *orgmode-formatting*
1430+
1431+
Formatting is done via `gq` mapping, which uses `formatexpr` under the hood (see `:help formatexpr` for more info).
1432+
For example, to re-format whole document, you can do `gggqG`. `gg` goes to first line in current file, `gq` starts the format motion,
1433+
and `G` goes to last line in file to make it format the whole thing. To format a single line, do `gqgq`, or to format selection,
1434+
select the lines you want to format and just do `gq`.
1435+
1436+
Currently, these things are formatted:
1437+
1438+
* Tags are aligned according to the `org_tags_column` setting
1439+
* Tables are formatted (see Tables (#Tables) for more info)
1440+
* Clock entries total time is recalculated (see Recalculating totals (#recalculating-totals) in Clocking (#Clocking) section)
1441+
14261442
--------------------------------------------------------------------------------
14271443
COLORS *orgmode-colors*
14281444

0 commit comments

Comments
 (0)