Update the manual for Cancel Running Task and the Mac preset keys !170
10 files changed, +91 −87
Layout: unified · split
docs/manual/guide/03-keys.org +35 −35
| @@ -18,7 +18,7 @@ Choose a preset in Settings ▸ General ▸ Keys, or with =keymap= in the =[orgs | ||
| 18 | 18 | | Mac | ="mac"= | Standard macOS text keys stay as they are. Org commands use Control-Command chords (=⌃⌘T=, =⌃⌘←=), which macOS text editing leaves free. | |
| 19 | 19 | | Doom (Vim keys) | ="doom"= | Modal editing as in Doom Emacs with evil and evil-org: normal, insert and visual states, the =SPC= leader and =SPC m= local leader, plus the Emacs preset's Org keys in every state. | |
| 20 | 20 | |
| 21 | The Mac preset binds fewer commands than the others. It has no keys for links, export, agenda, capture, clocking, narrowing, sorting, properties, footnotes, code blocks or =C-c C-c=. Run those from the Org menu, from the command palette (=⇧⌘P=), from a menu shortcut (Agenda =⇧⌘A=, Capture =⇧⌘N=), or bind them yourself in =keymap.toml=. | |
| 21 | The Mac preset binds fewer commands than the others. =⌃⌘X= is its =C-c C-c=, =⌘K= inserts a link and =⇧⌘E= opens the export sheet; the [[*Key reference][key reference]] lists the rest. It has no keys for agenda, capture or the single export formats. Run those from the Org menu, from the command palette (=⇧⌘P=), from a menu shortcut (Agenda =⇧⌘A=, Capture =⇧⌘N=), or bind them yourself in =keymap.toml=. | |
| 22 | 22 | |
| 23 | 23 | In the Emacs and Mac presets, and in Doom's insert state, macOS's own text keys keep working where the preset does not bind the key: =⌥←=, =⌘←=, =⇧= with arrows to select, and the Control keys the macOS text system provides (=⌃A=, =⌃E=, =⌃K= and so on). Menu shortcuts such as =⌘S= and =⌘F= work in every preset; see [[*Menu shortcuts][Menu shortcuts]]. |
| 24 | 24 | |
| @@ -119,7 +119,7 @@ These come from the menu bar and work in every preset. In the Doom preset, keys | ||
| 119 | 119 | | Edit ▸ Find | Find Next | =⌘G= | |
| 120 | 120 | | Edit ▸ Find | Find Previous | =⇧⌘G= | |
| 121 | 121 | | Edit ▸ Find | Use Selection for Find | =⌘E= | |
| 122 | | Edit | Cancel Running Block | =⌘.= | | |
| 122 | | Edit | Cancel Running Task | =⌘.= | | |
| 123 | 123 | | Edit | Search Notes | =⇧⌘F= | |
| 124 | 124 | | View | Show Markup | =⇧⌘M= | |
| 125 | 125 | | View | Show Line Numbers | =⇧⌘L= | |
| @@ -252,16 +252,16 @@ A =mode= other than =normal=, =insert= or =visual= (including =visual-line=) is | ||
| 252 | 252 | ** More examples |
| 253 | 253 | |
| 254 | 254 | #+BEGIN_SRC toml |
| 255 | # Mac preset: ⌃⌘L inserts a link, ⌃⌘O opens the export sheet, ⌃⌘X runs C-c C-c. | |
| 255 | # Mac preset: ⌃⌘U goes up to the parent heading, ⌃⌘R recalculates the table row, ⌃⌘; toggles COMMENT. | |
| 256 | 256 | [[bind]] |
| 257 | keys = "C-s-l" | |
| 258 | command = "org.link.insert" | |
| 257 | keys = "C-s-u" | |
| 258 | command = "org.heading.up" | |
| 259 | 259 | [[bind]] |
| 260 | keys = "C-s-o" | |
| 261 | command = "app.export-dialog" | |
| 260 | keys = "C-s-r" | |
| 261 | command = "org.table.recalc" | |
| 262 | 262 | [[bind]] |
| 263 | keys = "C-s-x" | |
| 264 | command = "org.ctrl-c-ctrl-c" | |
| 263 | keys = "C-s-;" | |
| 264 | command = "org.heading.toggle-comment" | |
| 265 | 265 | |
| 266 | 266 | # Emacs preset: C-c b opens the board, C-c r reloads this file. |
| 267 | 267 | [[bind]] |
| @@ -756,7 +756,7 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 756 | 756 | | Narrow to Subtree (=org.narrow.subtree=) | =C-x n s= | — | =SPC m s n= (N) | Shows only the current subtree (=org-narrow-to-subtree=). | |
| 757 | 757 | | Narrow to Block (=org.narrow.block=) | =C-x n b= | — | — | Shows only the current block (=org-narrow-to-block=). | |
| 758 | 758 | | Widen (=org.widen=) | =C-x n w= | — | =SPC m s N= (N) | Shows the whole file again (=widen=). | |
| 759 | | Narrow to Subtree or Widen (=org.narrow.toggle=) | — | — | — | Narrows to the subtree, or widens when already narrowed (=org-toggle-narrow-to-subtree=). | | |
| 759 | | Narrow to Subtree or Widen (=org.narrow.toggle=) | — | =⌃⌘N= | — | Narrows to the subtree, or widens when already narrowed (=org-toggle-narrow-to-subtree=). | | |
| 760 | 760 | | Sparse Tree… (=org.sparse-tree=) | =C-c /= | — | =SPC m s s= (N) | Asks for a match and shows only the matching entries and their context (=org-sparse-tree=). =C-c C-c= clears the highlights. | |
| 761 | 761 | | Show or Hide Inline Images (=org.toggle-inline-images=) | =C-c C-x C-v= | — | — | Shows or hides image links as images (=org-toggle-inline-images=). | |
| 762 | 762 | |
| @@ -766,8 +766,8 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 766 | 766 | |-+-+-+-+-| |
| 767 | 767 | | Next Heading (=org.heading.next=) | =C-c C-n= | =⌥⌘↓= | — | Moves to the next heading (=org-next-visible-heading=). | |
| 768 | 768 | | Previous Heading (=org.heading.previous=) | =C-c C-p= | =⌥⌘↑= | — | Moves to the previous heading (=org-previous-visible-heading=). | |
| 769 | | Next Heading at Same Level (=org.heading.forward-same-level=) | =C-c C-f= | — | =] h= (N) | Moves to the next heading at the same level (=org-forward-heading-same-level=). | | |
| 770 | | Previous Heading at Same Level (=org.heading.backward-same-level=) | =C-c C-b= | — | =[ h= (N) | Moves to the previous heading at the same level (=org-backward-heading-same-level=). | | |
| 769 | | Next Heading at Same Level (=org.heading.forward-same-level=) | =C-c C-f= | =⌥⇧⌘↓= | =] h= (N) | Moves to the next heading at the same level (=org-forward-heading-same-level=). | | |
| 770 | | Previous Heading at Same Level (=org.heading.backward-same-level=) | =C-c C-b= | =⌥⇧⌘↑= | =[ h= (N) | Moves to the previous heading at the same level (=org-backward-heading-same-level=). | | |
| 771 | 771 | | Up to Parent Heading (=org.heading.up=) | =C-c C-u= | — | =g h= (N) | Moves to the parent heading (=outline-up-heading=). | |
| 772 | 772 | | Go to Heading… (=org.goto=) | =C-c C-j= | — | =SPC m .= (N) | Asks for a heading of this file by its outline path and jumps to it (=org-goto=). | |
| 773 | 773 | | Insert Heading (=org.heading.insert=) | =M-RET= | =⌘↩= | — | Inserts a heading at the current level; on a list item, see Insert Item (=org-meta-return=, =org-insert-heading=). | |
| @@ -784,7 +784,7 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 784 | 784 | | Copy Subtree (=org.subtree.copy=) | =C-c C-x M-w= | — | — | Copies the subtree to the clipboard (=org-copy-subtree=). | |
| 785 | 785 | | Paste Subtree (=org.subtree.paste=) | =C-c C-x C-y= | — | — | Pastes a subtree from the clipboard, its levels adjusted to fit (=org-paste-subtree=). | |
| 786 | 786 | | Clone Subtree with Time Shift (=org.subtree.clone=) | =C-c C-x c= | — | =SPC m s c= (N) | Asks for a count and a time shift, then inserts shifted copies of the subtree (=org-clone-subtree-with-time-shift=). | |
| 787 | | Sort Entries (=org.sort=) | =C-c ^= | — | =SPC m s S= (N) | Sorts by a key you pick: the lines of a table in a table, the list on an item, otherwise the children of the current heading (=org-sort=). | | |
| 787 | | Sort Entries (=org.sort=) | =C-c ^= | =⌃⇧⌘S= | =SPC m s S= (N) | Sorts by a key you pick: the lines of a table in a table, the list on an item, otherwise the children of the current heading (=org-sort=). | | |
| 788 | 788 | | Toggle Heading (=org.heading.toggle=) | =C-c *= | — | =SPC m h= (N) | Outside a table, turns headings into text and lines or items into headings (=org-toggle-heading=). | |
| 789 | 789 | | Toggle COMMENT (=org.heading.toggle-comment=) | =C-c ;= | — | — | Adds or removes the =COMMENT= keyword (=org-toggle-comment=). | |
| 790 | 790 | | Refile… (=app.refile=) | =C-c C-w= | =⌃⌘W= | =SPC m r r= (N), =SPC m s r= (N) | Asks for a target heading in your folders and moves the subtree there (=org-refile=). | |
| @@ -812,11 +812,11 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 812 | 812 | | Command | Emacs | Mac | Doom | What it does | |
| 813 | 813 | |-+-+-+-+-| |
| 814 | 814 | | Cycle TODO State (=org.todo.cycle=) | =C-c C-t= | =⌃⌘T= | =SPC m t= (N) | Cycles the TODO keyword; with fast-selection keys in =#+TODO=, asks for one (=org-todo=). | |
| 815 | | Next TODO Keyword (=org.todo.next=) | =S-<right>= | — | =C-S-l= (N, I) | On a heading, sets the next keyword across all sequences (=org-shiftright=). | | |
| 816 | | Previous TODO Keyword (=org.todo.previous=) | =S-<left>= | — | =C-S-h= (N, I) | On a heading, sets the previous keyword (=org-shiftleft=). | | |
| 815 | | Next TODO Keyword (=org.todo.next=) | =S-<right>= | =⌃⇧⌘→= | =C-S-l= (N, I) | On a heading, sets the next keyword across all sequences (=org-shiftright=). | | |
| 816 | | Previous TODO Keyword (=org.todo.previous=) | =S-<left>= | =⌃⇧⌘←= | =C-S-h= (N, I) | On a heading, sets the previous keyword (=org-shiftleft=). | | |
| 817 | 817 | | Raise Priority (=org.priority.up=) | =S-<up>= | =⌃⌘↑= | =C-S-k= (N, I), =SPC m p u= (N) | On a heading, raises the priority (=org-priority-up=). | |
| 818 | 818 | | Lower Priority (=org.priority.down=) | =S-<down>= | =⌃⌘↓= | =C-S-j= (N, I), =SPC m p d= (N) | On a heading, lowers the priority (=org-priority-down=). | |
| 819 | | Set Priority… (=org.priority.set=) | =C-c ,= | — | =SPC m p p= (N) | Asks for a priority; =SPC= removes it (=org-priority=). | | |
| 819 | | Set Priority… (=org.priority.set=) | =C-c ,= | =⌃⌘,= | =SPC m p p= (N) | Asks for a priority; =SPC= removes it (=org-priority=). | | |
| 820 | 820 | | Set Priority A (=org.priority.set-a=) | — | — | — | Sets priority A. Bound only as a speed key. | |
| 821 | 821 | | Set Priority B (=org.priority.set-b=) | — | — | — | Sets priority B. Bound only as a speed key. | |
| 822 | 822 | | Set Priority C (=org.priority.set-c=) | — | — | — | Sets priority C. Bound only as a speed key. | |
| @@ -827,13 +827,13 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 827 | 827 | |
| 828 | 828 | | Command | Emacs | Mac | Doom | What it does | |
| 829 | 829 | |-+-+-+-+-| |
| 830 | | Set Property… (=org.property.read-and-set=) | =C-c C-x p= | — | =SPC m o= (N) | Asks for a property and a value and sets it (=org-set-property=). | | |
| 831 | | Next Allowed Value (=org.property.next-value=) | =S-<right>= | — | =C-S-l= (N, I) | On a property line, sets the next allowed value (=org-property-next-allowed-value=). | | |
| 832 | | Previous Allowed Value (=org.property.previous-value=) | =S-<left>= | — | =C-S-h= (N, I) | On a property line, sets the previous allowed value (=org-property-previous-allowed-value=). | | |
| 833 | | Set Effort (=org.effort.set=) | =C-c C-x e= | — | =SPC m c E= (N) | Sets the =Effort= property, offering =Effort_ALL= values (=org-set-effort=). | | |
| 830 | | Set Property… (=org.property.read-and-set=) | =C-c C-x p= | =⌃⇧⌘P= | =SPC m o= (N) | Asks for a property and a value and sets it (=org-set-property=). | | |
| 831 | | Next Allowed Value (=org.property.next-value=) | =S-<right>= | =⌃⇧⌘→= | =C-S-l= (N, I) | On a property line, sets the next allowed value (=org-property-next-allowed-value=). | | |
| 832 | | Previous Allowed Value (=org.property.previous-value=) | =S-<left>= | =⌃⇧⌘←= | =C-S-h= (N, I) | On a property line, sets the previous allowed value (=org-property-previous-allowed-value=). | | |
| 833 | | Set Effort (=org.effort.set=) | =C-c C-x e= | =⌃⇧⌘E= | =SPC m c E= (N) | Sets the =Effort= property, offering =Effort_ALL= values (=org-set-effort=). | | |
| 834 | 834 | | Column View (=org.columns=) | =C-c C-x C-c= | — | — | Shows the column view of the entries, read-only (=org-columns=). | |
| 835 | 835 | | Insert Column View Table (=org.columns.insert-dblock=) | =C-c C-x i= | — | — | Inserts a =columnview= dynamic block (=org-columns-insert-dblock=). | |
| 836 | | Update Dynamic Block (=org.dblock.update=) | =C-c C-x C-u=, =C-c C-c= | — | — | Updates the dynamic block at point, such as a clock table; =C-c C-c= does it on the block's =#+BEGIN= line (=org-update-dblock=). | | |
| 836 | | Update Dynamic Block (=org.dblock.update=) | =C-c C-x C-u=, =C-c C-c= | =⌃⌘X= | — | Updates the dynamic block at point, such as a clock table; =C-c C-c= and =⌃⌘X= do it on the block's =#+BEGIN= line (=org-update-dblock=). | | |
| 837 | 837 | |
| 838 | 838 | ** Dates and clocking |
| 839 | 839 | |
| @@ -848,10 +848,10 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 848 | 848 | | Timestamp One Day Later (=org.timestamp.day-later=) | =S-<right>= | =⌃⌘→= | =C-S-l= (N, I) | On a timestamp, moves it one day later (=org-timestamp-up-day=). | |
| 849 | 849 | | Timestamp One Day Earlier (=org.timestamp.day-earlier=) | =S-<left>= | =⌃⌘←= | =C-S-h= (N, I) | On a timestamp, moves it one day earlier (=org-timestamp-down-day=). | |
| 850 | 850 | | Evaluate Time Range (=org.timestamp.evaluate-range=) | =C-c C-y= | — | — | Shows how long the time range lasts, or updates a clock line (=org-evaluate-time-range=). | |
| 851 | | Clock In (=app.clock.in=) | =C-c C-x C-i= | — | =SPC m c i= (N) | Starts the clock on the current entry (=org-clock-in=). | | |
| 852 | | Clock Out (=app.clock.out=) | =C-c C-x C-o= | — | =SPC m c o= (N) | Stops the clock (=org-clock-out=). | | |
| 851 | | Clock In (=app.clock.in=) | =C-c C-x C-i= | =⌃⌘I= | =SPC m c i= (N) | Starts the clock on the current entry (=org-clock-in=). | | |
| 852 | | Clock Out (=app.clock.out=) | =C-c C-x C-o= | =⌃⇧⌘I= | =SPC m c o= (N) | Stops the clock (=org-clock-out=). | | |
| 853 | 853 | | Cancel Clock (=app.clock.cancel=) | =C-c C-x C-q= | — | =SPC m c c= (N) | Stops the clock and removes the running clock line (=org-clock-cancel=). | |
| 854 | | Go to Clocked Entry (=app.clock.goto=) | =C-c C-x C-j= | — | =SPC m c g= (N) | Opens the entry the clock is running on (=org-clock-goto=). | | |
| 854 | | Go to Clocked Entry (=app.clock.goto=) | =C-c C-x C-j= | =⌃⌘J= | =SPC m c g= (N) | Opens the entry the clock is running on (=org-clock-goto=). | | |
| 855 | 855 | | Clock Report (=app.clock.report=) | — | — | =SPC z t= (N), =SPC m c R= (N) | Opens the Clock Report window. | |
| 856 | 856 | | Insert or Update Clock Table (=org.clock.report=) | =C-c C-x C-r= | — | — | Inserts a clock table, or updates the one at point (=org-clock-report=). | |
| 857 | 857 | |
| @@ -874,7 +874,7 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 874 | 874 | | Delete Table Row (=org.table.kill-row=) | =M-S-<up>= | =⌃⌥⌘↑= | =M-K=, =SPC m b d r= (N) | In a table, deletes the row (=org-table-kill-row=). | |
| 875 | 875 | | Insert Table Rule (=org.table.insert-hline=) | =C-c -= | =⌃⌘-= | =SPC m b -= (N), =SPC m b i h= (N) | In a table, inserts a horizontal rule (=org-table-insert-hline=). | |
| 876 | 876 | | Recalculate Table Row (=org.table.recalc=) | =C-c *= | — | — | In a table, recalculates the current row (=org-table-recalculate=). | |
| 877 | | Recalculate Table (=org.table.recalc-all=) | =C-c C-c= | — | =SPC m b r= (N) | Recalculates the whole table; =C-c C-c= runs it on a =#+TBLFM= line (=org-table-recalculate= with =C-u=). | | |
| 877 | | Recalculate Table (=org.table.recalc-all=) | =C-c C-c= | =⌃⌘X= | =SPC m b r= (N) | Recalculates the whole table; =C-c C-c= and =⌃⌘X= run it on a =#+TBLFM= line (=org-table-recalculate= with =C-u=). | | |
| 878 | 878 | | Set Column Formula (=org.table.column-formula=) | ~C-c =~ | — | — | Asks for the column's formula, offering the stored one (=org-table-eval-formula=). | |
| 879 | 879 | | Edit Table Field (=org.table.edit-field=) | =C-c `= | — | — | In a table, edits the field in a separate editor (=org-table-edit-field=). | |
| 880 | 880 | | Shrink or Expand Table Column (=org.table.toggle-column-width=) | =C-c TAB= | — | — | In a table, shrinks or expands the column (=org-table-toggle-column-width=). | |
| @@ -883,22 +883,22 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 883 | 883 | |
| 884 | 884 | | Command | Emacs | Mac | Doom | What it does | |
| 885 | 885 | |-+-+-+-+-| |
| 886 | | Open Link (=org.link.open=) | =C-c C-o= | — | — | Follows the link or timestamp at the caret (=org-open-at-point=). | | |
| 887 | | Insert Link… (=org.link.insert=) | =C-c C-l= | — | =SPC m l l= (N) | Asks for a link and description and inserts it, offering stored links (=org-insert-link=). | | |
| 888 | | Store Link (=org.link.store=) | =C-c l= | — | =SPC m l s= (N), =SPC n l= (N) | Stores a link to the current entry for a later Insert Link (=org-store-link=). | | |
| 886 | | Open Link (=org.link.open=) | =C-c C-o= | =⌃⌘O= | — | Follows the link or timestamp at the caret (=org-open-at-point=). | | |
| 887 | | Insert Link… (=org.link.insert=) | =C-c C-l= | =⌘K= | =SPC m l l= (N) | Asks for a link and description and inserts it, offering stored links (=org-insert-link=). | | |
| 888 | | Store Link (=org.link.store=) | =C-c l= | =⌃⌘L= | =SPC m l s= (N), =SPC n l= (N) | Stores a link to the current entry for a later Insert Link (=org-store-link=). | | |
| 889 | 889 | | Store ID Link (=org.id.store-link=) | — | — | =SPC m l i= (N) | Gives the entry an =ID= if needed and stores an =id:= link to it (=org-id-store-link=). | |
| 890 | | Footnote Action (=org.footnote.action=) | =C-c C-x f= | — | — | On a reference, goes to its definition; on a definition, back to a reference; elsewhere inserts a footnote (=org-footnote-action=). | | |
| 890 | | Footnote Action (=org.footnote.action=) | =C-c C-x f= | =⌃⇧⌘F= | — | On a reference, goes to its definition; on a definition, back to a reference; elsewhere inserts a footnote (=org-footnote-action=). | | |
| 891 | 891 | |
| 892 | 892 | ** Code blocks and C-c C-c |
| 893 | 893 | |
| 894 | 894 | | Command | Emacs | Mac | Doom | What it does | |
| 895 | 895 | |-+-+-+-+-| |
| 896 | | Act at Point (C-c C-c) (=org.ctrl-c-ctrl-c=) | =C-c C-c= | — | — | Does what fits the context: sets tags on a heading, toggles an item's checkbox, follows a footnote, offers the property menu in a property drawer, updates a clock line, statistics cookie or timestamp, runs a =#+CALL:= line, inline =call_= or inline =src_= block, and refreshes the setup on a =#+= keyword line (=org-ctrl-c-ctrl-c=). In a table it evaluates a formula typed in the field (starting with ~=~ or ~:=~), then recalculates the row when it is marked =#= and otherwise aligns the table; at the table's first character it recalculates the whole table. After a sparse tree, the first =C-c C-c= only clears the highlights. More specific bindings take =C-c C-c= in src blocks, =#+TBLFM= lines and dynamic blocks. | | |
| 896 | | Act at Point (C-c C-c) (=org.ctrl-c-ctrl-c=) | =C-c C-c= | =⌃⌘X= | — | Does what fits the context: sets tags on a heading, toggles an item's checkbox, follows a footnote, offers the property menu in a property drawer, updates a clock line, statistics cookie or timestamp, runs a =#+CALL:= line, inline =call_= or inline =src_= block, and refreshes the setup on a =#+= keyword line (=org-ctrl-c-ctrl-c=). In a table it evaluates a formula typed in the field (starting with ~=~ or ~:=~), then recalculates the row when it is marked =#= and otherwise aligns the table; at the table's first character it recalculates the whole table. After a sparse tree, the first =C-c C-c= only clears the highlights. More specific bindings take =C-c C-c= and =⌃⌘X= in src blocks, =#+TBLFM= lines and dynamic blocks. | | |
| 897 | 897 | | Act at Point (=org.dwim=) | — | — | =RET= (N) | Doom's =+org/dwim-at-point=: follows a link, runs a src block, recalculates or aligns a table, toggles a checkbox, or switches a heading between TODO and done. | |
| 898 | | Run Source Block (=org.babel.execute=) | =C-c C-c= | — | — | In a src block, runs it and inserts the results (=org-babel-execute-src-block=). | | |
| 899 | | Tangle File (=org.babel.tangle=) | =C-c C-v t=, =C-c C-v C-t= | — | — | Writes the file's src blocks to their tangle targets (=org-babel-tangle=). | | |
| 898 | | Run Source Block (=org.babel.execute=) | =C-c C-c= | =⌃⌘X= | — | In a src block, runs it and inserts the results (=org-babel-execute-src-block=). | | |
| 899 | | Tangle File (=org.babel.tangle=) | =C-c C-v t=, =C-c C-v C-t= | =⌃⌘V= | — | Writes the file's src blocks to their tangle targets (=org-babel-tangle=). | | |
| 900 | 900 | | Insert Structure Template (=org.structure-template=) | =C-c C-,= | — | — | Asks for a block type and inserts the block, or wraps the selection (=org-insert-structure-template=). | |
| 901 | | Edit Block (=org.edit-special=) | =C-c '= | — | =SPC m '= (N) | Edits the src, example or export block at point in a separate editor (=org-edit-special=). | | |
| 901 | | Edit Block (=org.edit-special=) | =C-c '= | =⌃⌘'= | =SPC m '= (N) | Edits the src, example or export block at point in a separate editor (=org-edit-special=). | | |
| 902 | 902 | |
| 903 | 903 | ** Agenda and capture |
| 904 | 904 | |
| @@ -911,6 +911,7 @@ When a key appears in several rows, it runs the command whose condition holds at | ||
| 911 | 911 | |
| 912 | 912 | | Command | Emacs | Mac | Doom | What it does | |
| 913 | 913 | |-+-+-+-+-| |
| 914 | | Export… (=app.export-dialog=) | — | =⇧⌘E= | — | Opens the export sheet. In the Emacs and Doom presets =C-c C-e= is a prefix for the export keys only; pausing after it lists them in the key hints. | | |
| 914 | 915 | | Export to HTML (=app.export.html=) | =C-c C-e h h= | — | =SPC m e h h= (N) | Exports to HTML (=org-html-export-to-html=). | |
| 915 | 916 | | Export to HTML and Open (=app.export.html-open=) | =C-c C-e h o= | — | =SPC m e h o= (N) | Exports to HTML and opens the result. | |
| 916 | 917 | | Export to Markdown (=app.export.markdown=) | =C-c C-e m m= | — | =SPC m e m m= (N) | Exports to Markdown (=org-md-export-to-markdown=). | |
| @@ -947,9 +948,8 @@ No preset binds these. Run them from the palette or a menu, or bind them in =key | ||
| 947 | 948 | | Command | What it does | |
| 948 | 949 | |-+-| |
| 949 | 950 | | Board (=app.board=) | Opens the Board window. Window ▸ Board, =⇧⌘B=. | |
| 950 | | Cancel Running Block (=app.babel.cancel=) | Stops the src block that is running. Edit ▸ Cancel Running Block, =⌘.=. | | |
| 951 | | Cancel Running Task (=app.babel.cancel=) | Stops the src block that is running, or an export or table recalculation running in Emacs. Edit ▸ Cancel Running Task, =⌘.=. | | |
| 951 | 952 | | Edit Config File (=app.edit-config=) | Opens =config.toml= in the editor. =⌥⌘,=. | |
| 952 | | Export… (=app.export-dialog=) | Opens the export sheet. In the Emacs and Doom presets =C-c C-e= is a prefix for the export keys only; pausing after it lists them in the key hints. | | |
| 953 | 953 | | Import from Emacs… (=app.import-emacs=) | Opens Import from Emacs…. | |
| 954 | 954 | | Revert to File on Disk (=app.revert=) | Replaces the buffer with the file on disk; unsaved changes go to recovery (=revert-buffer=). | |
| 955 | 955 | | Recovery Versions… (=app.recovery=) | Shows the recovery versions of the file. | |
docs/manual/guide/04-outlines.org +12 −13
| @@ -122,8 +122,8 @@ lines they do nothing. Orgstar has no =org-drag-element= for paragraphs. | ||
| 122 | 122 | |--------------------------------+-----------------------------------+-----------+--------+-------------------| |
| 123 | 123 | | Next Heading | =org-next-visible-heading= | =C-c C-n= | =⌥⌘↓= | =C-c C-n= | |
| 124 | 124 | | Previous Heading | =org-previous-visible-heading= | =C-c C-p= | =⌥⌘↑= | =C-c C-p= | |
| 125 | | Next Heading at Same Level | =org-forward-heading-same-level= | =C-c C-f= | menu | =] h= | | |
| 126 | | Previous Heading at Same Level | =org-backward-heading-same-level= | =C-c C-b= | menu | =[ h= | | |
| 125 | | Next Heading at Same Level | =org-forward-heading-same-level= | =C-c C-f= | =⌥⇧⌘↓= | =] h= | | |
| 126 | | Previous Heading at Same Level | =org-backward-heading-same-level= | =C-c C-b= | =⌥⇧⌘↑= | =[ h= | | |
| 127 | 127 | | Up to Parent Heading | =outline-up-heading= | =C-c C-u= | menu | =g h= | |
| 128 | 128 | | Go to Heading… | =org-goto= | =C-c C-j= | menu | =SPC m .= | |
| 129 | 129 | |
| @@ -227,7 +227,7 @@ clone, as Org does. | ||
| 227 | 227 | |
| 228 | 228 | ** Sorting |
| 229 | 229 | |
| 230 | Sort Entries (=org-sort=, =C-c ^=, Doom =SPC m s S=) sorts what the caret is in: | |
| 230 | Sort Entries (=org-sort=, =C-c ^=, Mac =⌃⇧⌘S=, Doom =SPC m s S=) sorts what the caret is in: | |
| 231 | 231 | |
| 232 | 232 | - In a table, the table's lines (=org-table-sort-lines=, see [[file:10-tables.org][Tables]]). |
| 233 | 233 | - On a list item, the items of that list (=org-sort-list=). |
| @@ -262,7 +262,7 @@ Org's =f= (custom function) key is not available. | ||
| 262 | 262 | | Narrow to Subtree | =org-narrow-to-subtree= | =C-x n s= | menu | =SPC m s n= | |
| 263 | 263 | | Narrow to Block | =org-narrow-to-block= | =C-x n b= | menu | =C-x n b= | |
| 264 | 264 | | Widen | =widen= | =C-x n w= | menu | =SPC m s N= | |
| 265 | | Narrow to Subtree or Widen | =org-toggle-narrow-to-subtree= | speed key =s= | speed key =s= | speed key =s= | | |
| 265 | | Narrow to Subtree or Widen | =org-toggle-narrow-to-subtree= | speed key =s= | =⌃⌘N=, speed key =s= | speed key =s= | | |
| 266 | 266 | |
| 267 | 267 | Narrowing hides everything outside the current subtree or block, so the editor shows |
| 268 | 268 | only that part of the file. Narrow to Block works on src, example, export, comment and |
| @@ -502,7 +502,7 @@ opens unless =org-cycle-hide-block-startup= is on in =config.toml= or the file h | ||
| 502 | 502 | =#+STARTUP: hideblocks= (=nohideblocks= overrides the setting the other way). See |
| 503 | 503 | [[file:02-the-editor.org][The editor]] for folding in general. |
| 504 | 504 | |
| 505 | Edit Block (=org-edit-special=, =C-c '=) edits a src, example or export block in a | |
| 505 | Edit Block (=org-edit-special=, =C-c '=, Mac =⌃⌘'=) edits a src, example or export block in a | |
| 506 | 506 | separate editor. See [[file:11-code-blocks.org][Code blocks]]. |
| 507 | 507 | |
| 508 | 508 | * Drawers |
| @@ -547,12 +547,12 @@ space between. | ||
| 547 | 547 | |
| 548 | 548 | | Command | Org command | Emacs | Mac | Doom | |
| 549 | 549 | |-----------------------------+---------------------------------+-------------+------+------------| |
| 550 | | Set Property… | =org-set-property= | =C-c C-x p= | menu | =SPC m o= | | |
| 550 | | Set Property… | =org-set-property= | =C-c C-x p= | =⌃⇧⌘P= | =SPC m o= | | |
| 551 | 551 | | Delete Property… | =org-delete-property= | none | menu | none | |
| 552 | 552 | | Delete Property Everywhere… | =org-delete-property-globally= | none | menu | none | |
| 553 | | Property Action… | =org-property-action= | =C-c C-c= in a property drawer | menu | =C-c C-c= | | |
| 554 | | Next Allowed Value | =org-property-next-allowed-value= | =S-<right>= on a property line | menu | =S-<right>=, =C-S-l= | | |
| 555 | | Previous Allowed Value | =org-property-previous-allowed-value= | =S-<left>= on a property line | menu | =S-<left>=, =C-S-h= | | |
| 553 | | Property Action… | =org-property-action= | =C-c C-c= in a property drawer | =⌃⌘X= in a property drawer | =C-c C-c= | | |
| 554 | | Next Allowed Value | =org-property-next-allowed-value= | =S-<right>= on a property line | =⌃⇧⌘→= on a property line | =S-<right>=, =C-S-l= | | |
| 555 | | Previous Allowed Value | =org-property-previous-allowed-value= | =S-<left>= on a property line | =⌃⇧⌘←= on a property line | =S-<left>=, =C-S-h= | | |
| 556 | 556 | |
| 557 | 557 | Set Property asks for the key, offering the keys used in the file, Org's standard keys |
| 558 | 558 | and the properties named in =COLUMNS= formats; on a property line, Return takes that |
| @@ -666,7 +666,7 @@ capture: =local= (the default, the entry at the caret), =global= (the whole file | ||
| 666 | 666 | ,#+END: |
| 667 | 667 | #+END_SRC |
| 668 | 668 | |
| 669 | =C-c C-c= on the =#+BEGIN:= line, or =C-c C-x C-u= anywhere in the block, updates it. | |
| 669 | =C-c C-c= (Mac =⌃⌘X=) on the =#+BEGIN:= line, or =C-c C-x C-u= anywhere in the block, updates it. | |
| 670 | 670 | Updating writes summary values into the parents' properties, as Org does. The block |
| 671 | 671 | takes these parameters: |
| 672 | 672 | |
| @@ -687,7 +687,7 @@ Existing =#+TBLFM:= lines after the table are kept. An =:id= of the form =file:p | ||
| 687 | 687 | |
| 688 | 688 | | Command | Org command | Emacs | Mac | Doom | |
| 689 | 689 | |-----------------+----------------------+-------------+------+-------------| |
| 690 | | Footnote Action | =org-footnote-action= | =C-c C-x f= | menu | =C-c C-x f= | | |
| 690 | | Footnote Action | =org-footnote-action= | =C-c C-x f= | =⌃⇧⌘F= | =C-c C-x f= | | |
| 691 | 691 | | Footnote Menu | =org-footnote-action= with a prefix | none | menu | none | |
| 692 | 692 | |
| 693 | 693 | Footnote Action depends on where the caret is: |
| @@ -826,8 +826,7 @@ below the outline (see [[file:09-links.org][Links]]). | ||
| 826 | 826 | * C-c C-c |
| 827 | 827 | |
| 828 | 828 | =C-c C-c= (=org-ctrl-c-ctrl-c=) does what fits the caret's position. In the Emacs and |
| 829 | Doom presets it is =C-c C-c=; in the Mac preset, run Act at Point (C-c C-c) from the Org | |
| 830 | menu or the palette. In order, it: | |
| 829 | Doom presets it is =C-c C-c=; in the Mac preset it is =⌃⌘X=. In order, it: | |
| 831 | 830 | |
| 832 | 831 | | Caret on | Effect | |
| 833 | 832 | |--------------------------------------------+------------------------------------------------------------| |
docs/manual/guide/05-todos-and-tags.org +5 −5
| @@ -61,10 +61,10 @@ Logging is described under "Logging state changes" below. | ||
| 61 | 61 | | Command | Org command | Emacs, Doom | Mac | Doom leader | |
| 62 | 62 | |------------------------+------------------+----------------+------+-------------| |
| 63 | 63 | | Cycle TODO State | =org-todo= | =C-c C-t= | ⌃⌘T | =SPC m t= | |
| 64 | | Next TODO Keyword | =org-shiftright= | =S-<right>= | | | | |
| 65 | | Previous TODO Keyword | =org-shiftleft= | =S-<left>= | | | | |
| 64 | | Next TODO Keyword | =org-shiftright= | =S-<right>= | ⌃⇧⌘→ | | | |
| 65 | | Previous TODO Keyword | =org-shiftleft= | =S-<left>= | ⌃⇧⌘← | | | |
| 66 | 66 | |
| 67 | =S-<right>= and =S-<left>= act on the TODO keyword when the caret is on a heading line and not on a timestamp. In the Doom preset they also work in normal and insert state, and =C-S-l= and =C-S-h= do the same. The Mac preset has no key for them; use the Org menu or the command palette. | |
| 67 | =S-<right>= and =S-<left>= act on the TODO keyword when the caret is on a heading line and not on a timestamp. In the Doom preset they also work in normal and insert state, and =C-S-l= and =C-S-h= do the same. The Mac preset's =⌃⇧⌘→= and =⌃⇧⌘←= act on the keyword when the caret is on a heading line. | |
| 68 | 68 | |
| 69 | 69 | With speed commands on (=org-use-speed-commands=), =t= at the start of a heading line runs Cycle TODO State. |
| 70 | 70 | |
| @@ -198,7 +198,7 @@ The range is =A= (highest) to =C= (lowest), with =B= as the default. A file can | ||
| 198 | 198 | |
| 199 | 199 | | Command | Org command | Emacs, Doom | Mac | Doom leader | |
| 200 | 200 | |-------------------------------+-----------------+-----------------+-------+-------------| |
| 201 | | Set Priority… | =org-priority= | =C-c ,= | | =SPC m p p= | | |
| 201 | | Set Priority… | =org-priority= | =C-c ,= | ⌃⌘, | =SPC m p p= | | |
| 202 | 202 | | Raise Priority | =org-priority-up= | =S-<up>= | ⌃⌘↑ | =SPC m p u= | |
| 203 | 203 | | Lower Priority | =org-priority-down= | =S-<down>= | ⌃⌘↓ | =SPC m p d= | |
| 204 | 204 | |
| @@ -226,7 +226,7 @@ A tag consists of letters, digits, =_=, =@=, =#= and =%=. | ||
| 226 | 226 | |-----------+---------------------------+---------------+-------+-------------| |
| 227 | 227 | | Set Tags | =org-set-tags-command= | =C-c C-q= | ⌃⌘G | =SPC m q= | |
| 228 | 228 | |
| 229 | =C-c C-c= on a heading line also runs Set Tags, and so does =:= as a speed command. | |
| 229 | =C-c C-c= (Mac =⌃⌘X=) on a heading line also runs Set Tags, and so does =:= as a speed command. | |
| 230 | 230 | |
| 231 | 231 | Without fast selection (see below), Set Tags asks for the tags in the echo area, starting with the current ones. Completion offers the tags in the file's =#+TAGS= lines, or, without those, every tag used in the file and its =#+FILETAGS=, and in both cases the tags used across your folders. You can type tags that are not offered. Spaces, commas and colons all separate tags; an empty answer removes all tags. |
| 232 | 232 | |
docs/manual/guide/06-dates-and-clocking.org +11 −11
| @@ -192,9 +192,9 @@ To turn the repeat note off for a file, use =#+STARTUP: nologrepeat=; =lognotere | ||
| 192 | 192 | |
| 193 | 193 | Effort estimates live in the =Effort= property. |
| 194 | 194 | |
| 195 | | Command | Org command | Emacs, Doom | Doom leader | Speed key | | |
| 196 | |-------------+------------------+---------------+---------------+-----------| | |
| 197 | | Set Effort | =org-set-effort= | =C-c C-x e= | =SPC m c E= | =e= | | |
| 195 | | Command | Org command | Emacs, Doom | Mac | Doom leader | Speed key | | |
| 196 | |-------------+------------------+---------------+--------+---------------+-----------| | |
| 197 | | Set Effort | =org-set-effort= | =C-c C-x e= | =⌃⇧⌘E= | =SPC m c E= | =e= | | |
| 198 | 198 | |
| 199 | 199 | Set Effort asks for a value, such as =0:30= or =2:00=, starting with the current one. If the entry, an ancestor, or a =#+PROPERTY: Effort_ALL= line defines =Effort_ALL=, its values are offered as choices; you can also type another value. |
| 200 | 200 | |
| @@ -208,14 +208,14 @@ Effort appears in column view and in clock tables with =:properties ("Effort")=. | ||
| 208 | 208 | |
| 209 | 209 | Clocking records the time you work on an entry as =CLOCK:= lines in its =LOGBOOK= drawer. |
| 210 | 210 | |
| 211 | | Command | Org command | Emacs, Doom | Doom leader | Speed key | | |
| 212 | |----------------------+--------------------+-----------------+-------------+-----------| | |
| 213 | | Clock In | =org-clock-in= | =C-c C-x C-i= | =SPC m c i= | =I= | | |
| 214 | | Clock Out | =org-clock-out= | =C-c C-x C-o= | =SPC m c o= | =O= | | |
| 215 | | Cancel Clock | =org-clock-cancel= | =C-c C-x C-q= | =SPC m c c= | | | |
| 216 | | Go to Clocked Entry | =org-clock-goto= | =C-c C-x C-j= | =SPC m c g= | | | |
| 211 | | Command | Org command | Emacs, Doom | Mac | Doom leader | Speed key | | |
| 212 | |----------------------+--------------------+-----------------+--------+-------------+-----------| | |
| 213 | | Clock In | =org-clock-in= | =C-c C-x C-i= | =⌃⌘I= | =SPC m c i= | =I= | | |
| 214 | | Clock Out | =org-clock-out= | =C-c C-x C-o= | =⌃⇧⌘I= | =SPC m c o= | =O= | | |
| 215 | | Cancel Clock | =org-clock-cancel= | =C-c C-x C-q= | | =SPC m c c= | | | |
| 216 | | Go to Clocked Entry | =org-clock-goto= | =C-c C-x C-j= | =⌃⌘J= | =SPC m c g= | | | |
| 217 | 217 | |
| 218 | The Mac preset has no keys for these; run them from the command palette, or the clock menus described below. In the agenda, =I=, =O= and =X= clock in, out and cancel for the entry at the line ([[file:07-agenda.org][The agenda]]). Capture templates can clock in too ([[file:08-capture.org][Capture]]). | |
| 218 | The Mac preset has no key for Cancel Clock; run it from the command palette, or the clock menus described below. In the agenda, =I=, =O= and =X= clock in, out and cancel for the entry at the line ([[file:07-agenda.org][The agenda]]). Capture templates can clock in too ([[file:08-capture.org][Capture]]). | |
| 219 | 219 | |
| 220 | 220 | ** Clocking in and out |
| 221 | 221 | |
| @@ -295,7 +295,7 @@ A clock table is a dynamic block that Orgstar fills with a summary of clocked ti | ||
| 295 | 295 | | Insert or Update Clock Table | =org-clock-report= | =C-c C-x C-r= | |
| 296 | 296 | | Update Dynamic Block | =org-update-dblock= | =C-c C-x C-u= | |
| 297 | 297 | |
| 298 | =C-c C-c= on the =#+BEGIN:= line also updates the block. In the Mac preset, use the Org menu or the command palette. | |
| 298 | =C-c C-c= on the =#+BEGIN:= line also updates the block; in the Mac preset, =⌃⌘X= does. | |
| 299 | 299 | |
| 300 | 300 | Insert or Update Clock Table updates the clock table at the caret. Elsewhere it inserts a new one, with =:scope subtree= inside an entry or =:scope file= before the first heading, and fills it: |
| 301 | 301 | |
docs/manual/guide/09-links.org +4 −4
| @@ -42,7 +42,7 @@ file into a link, matched case-insensitively, as in Org. | ||
| 42 | 42 | | Preset | Key | |
| 43 | 43 | |--------+---------------------------------------------------------------------------------------| |
| 44 | 44 | | Emacs | =C-c C-o= | |
| 45 | | Mac | Org ▸ Open Link (no key by default) | | |
| 45 | | Mac | =⌃⌘O= | | |
| 46 | 46 | | Doom | =C-c C-o= in any state; =RET= in normal state follows a link before doing anything else | |
| 47 | 47 | | All | =⌘=-click on the link; =o= at the start of a heading line when speed commands are on | |
| 48 | 48 | |
| @@ -123,7 +123,7 @@ has the ID= followed by the ID. | ||
| 123 | 123 | |
| 124 | 124 | ** Timestamps |
| 125 | 125 | |
| 126 | =C-c C-o= or =⌘=-click on a timestamp opens the agenda on that day, as | |
| 126 | =C-c C-o= (Mac =⌃⌘O=) or =⌘=-click on a timestamp opens the agenda on that day, as | |
| 127 | 127 | =org-follow-timestamp-link= does. On a date range such as |
| 128 | 128 | =<2026-10-05 Mon>--<2026-10-09 Fri>=, the agenda shows the whole span. See |
| 129 | 129 | [[file:07-agenda.org][Agenda]]. |
| @@ -135,7 +135,7 @@ has the ID= followed by the ID. | ||
| 135 | 135 | | Preset | Key | |
| 136 | 136 | |--------+------------------------------| |
| 137 | 137 | | Emacs | =C-c C-l= | |
| 138 | | Mac | Org ▸ Insert Link… | | |
| 138 | | Mac | =⌘K= | | |
| 139 | 139 | | Doom | =SPC m l l=, or =C-c C-l= | |
| 140 | 140 | |
| 141 | 141 | The first prompt reads =Insert link:=, or =Insert link (default …):= when you have |
| @@ -186,7 +186,7 @@ see [[file:02-the-editor.org][The editor]]. | ||
| 186 | 186 | | Preset | Key | |
| 187 | 187 | |--------+---------------------------------------| |
| 188 | 188 | | Emacs | =C-c l= | |
| 189 | | Mac | Org ▸ Store Link | | |
| 189 | | Mac | =⌃⌘L= | | |
| 190 | 190 | | Doom | =SPC m l s= or =SPC n l= | |
| 191 | 191 | |
| 192 | 192 | The stored link is a =file:= link to the current file, written with =~= for your home |
docs/manual/guide/10-tables.org +10 −6
| @@ -63,10 +63,10 @@ table command, not while you type. To align without moving, use Org ▸ Align Ta | ||
| 63 | 63 | | Preset | Key | |
| 64 | 64 | |--------+------------------------------| |
| 65 | 65 | | Emacs | =C-c C-c= in a table | |
| 66 | | Mac | Org ▸ Align Table | | |
| 66 | | Mac | =⌃⌘X= in a table | | |
| 67 | 67 | | Doom | =C-c C-c=, or =SPC m b a= | |
| 68 | 68 | |
| 69 | =C-c C-c= in a table is =org-ctrl-c-ctrl-c=, as in Emacs. It first evaluates a formula | |
| 69 | =C-c C-c= (Mac =⌃⌘X=) in a table is =org-ctrl-c-ctrl-c=, as in Emacs. It first evaluates a formula | |
| 70 | 70 | typed in the current field (see /Entering formulas/). Then, in a row marked =#= (see |
| 71 | 71 | /Names, parameters and constants/), it recalculates that row, which also aligns the |
| 72 | 72 | table; in any other row it aligns the table. With the caret at the table's very first |
| @@ -90,7 +90,7 @@ in the config file (default =false=), or put =#+STARTUP: align= in the file; | ||
| 90 | 90 | | Insert row above | =org-table-insert-row= | =M-S-<down>= | =⌃⌥⌘↓= | =M-S-<down>=, =SPC m b i r= | |
| 91 | 91 | | Delete row | =org-table-kill-row= | =M-S-<up>= | =⌃⌥⌘↑= | =M-S-<up>=, =SPC m b d r= | |
| 92 | 92 | | Insert rule below | =org-table-insert-hline= | =C-c -= | =⌃⌘-= | =C-c -=, =SPC m b -=, =SPC m b i h= | |
| 93 | | Sort rows | =org-table-sort-lines= | =C-c ^= | Org ▸ Sort Table Lines | =C-c ^= | | |
| 93 | | Sort rows | =org-table-sort-lines= | =C-c ^= | =⌃⇧⌘S= | =C-c ^= | | |
| 94 | 94 | | Transpose | =org-table-transpose-table-at-point= | Org ▸ Transpose Table | Org ▸ Transpose Table | Org ▸ Transpose Table | |
| 95 | 95 | | Edit field in its own editor | =org-table-edit-field= | =C-c `= | Org ▸ Edit Table Field | =C-c `= | |
| 96 | 96 | |
| @@ -472,7 +472,7 @@ grouped under =# Column Formulas=, =# Field and Range Formulas= and | ||
| 472 | 472 | =# Named Field Formulas=. A formula can continue on indented lines. =C-c '= or |
| 473 | 473 | =⌘Return= installs the formulas; =Escape= or =C-c C-k= leaves them unchanged. |
| 474 | 474 | Installing doesn't recalculate. The echo area says so and points to Recalculate Table: |
| 475 | =C-c C-c= on the =#+TBLFM:= line, or Org ▸ Recalculate Table in the Mac preset. | |
| 475 | =C-c C-c= on the =#+TBLFM:= line, or =⌃⌘X= there in the Mac preset. | |
| 476 | 476 | |
| 477 | 477 | The formulas are stored sorted the way =org-table-formula-less-p= sorts them. |
| 478 | 478 | |
| @@ -480,7 +480,7 @@ The formulas are stored sorted the way =org-table-formula-less-p= sorts them. | ||
| 480 | 480 | |
| 481 | 481 | | Command | Org command | Emacs | Mac | Doom | |
| 482 | 482 | |----------------------------------+-----------------------------------+-------------------------------+-----------------------------+-------------------------------------| |
| 483 | | Recalculate Table | =org-table-recalculate= with =C-u= | =C-c C-c= on =#+TBLFM:= | Org ▸ Recalculate Table | =SPC m b r=, =C-c C-c= on =#+TBLFM:= | | |
| 483 | | Recalculate Table | =org-table-recalculate= with =C-u= | =C-c C-c= on =#+TBLFM:= | =⌃⌘X= on =#+TBLFM:= | =SPC m b r=, =C-c C-c= on =#+TBLFM:= | | |
| 484 | 484 | | Recalculate Table Row | =org-table-recalculate= | =C-c *= | Org ▸ Recalculate Table Row | =C-c *= | |
| 485 | 485 | |
| 486 | 486 | In Doom's normal state, =RET= in a table recalculates it when it has a =#+TBLFM:= |
| @@ -495,7 +495,7 @@ the table. Formulas are evaluated once; Org's iterate-until-stable recalculation | ||
| 495 | 495 | |
| 496 | 496 | Tables are not recalculated automatically. Rows marked =#= are not recalculated when |
| 497 | 497 | you press =TAB= or =RET= in them, as =org-table-maybe-recalculate-line= would do in |
| 498 | Emacs; recalculate with one of the commands above, or with =C-c C-c= in the row. | |
| 498 | Emacs; recalculate with one of the commands above, or with =C-c C-c= (Mac =⌃⌘X=) in the row. | |
| 499 | 499 | |
| 500 | 500 | * When Emacs is needed |
| 501 | 501 | |
| @@ -522,6 +522,10 @@ programs a formula starts are found when Orgstar was opened from the Dock. The r | ||
| 522 | 522 | stops after 60 seconds. If you edit the table while Emacs is working, its result is |
| 523 | 523 | discarded. |
| 524 | 524 | |
| 525 | Edit ▸ Cancel Running Task (=⌘.=) stops the recalculation; the echo area shows | |
| 526 | =Recalculation canceled= and the table is unchanged. Starting another recalculation or | |
| 527 | export in Emacs cancels the one that is running. | |
| 528 | ||
| 525 | 529 | If the table's formulas contain Lisp, Orgstar asks first: |
| 526 | 530 | =This table's formulas run Lisp. Run them? (yes, no, always)=. =always= trusts this |
| 527 | 531 | table's text in this file, so the question isn't asked again until the text changes. |
docs/manual/guide/11-code-blocks.org +9 −9
| @@ -51,7 +51,7 @@ Names are matched without regard to case. Blocks in any other language show as p | ||
| 51 | 51 | |--------+---------------------------| |
| 52 | 52 | | Emacs | =C-c '= | |
| 53 | 53 | | Doom | =C-c '=, or =SPC m '= in normal state | |
| 54 | | Mac | Org ▸ Edit Block, or the command palette | | |
| 54 | | Mac | =⌃⌘'= | | |
| 55 | 55 | |
| 56 | 56 | On the Mac the block opens in a sheet titled with the block's kind and language, with the same highlighting as the main editor. The protecting commas are removed while you edit and added back when you save. |
| 57 | 57 | |
| @@ -72,7 +72,7 @@ On iOS the block opens in a plain text sheet with Cancel and Save buttons. | ||
| 72 | 72 | |--------+------------------------------------------------------| |
| 73 | 73 | | Emacs | =C-c C-c= | |
| 74 | 74 | | Doom | =C-c C-c= in normal, insert and visual state | |
| 75 | | Mac | Org ▸ Run Source Block, or the command palette | | |
| 75 | | Mac | =⌃⌘X= | | |
| 76 | 76 | |
| 77 | 77 | The program runs in the folder of the file, or in =:dir=. It reads the code on standard input. While it runs, the message area shows "Running /language/ block…"; when it ends, it shows "Code block evaluation complete." or the problem. |
| 78 | 78 | |
| @@ -126,7 +126,7 @@ When a block's =:var= or =:stdin= refers to other blocks that have to run first, | ||
| 126 | 126 | |
| 127 | 127 | ** Cancelling a run |
| 128 | 128 | |
| 129 | On the Mac, Edit ▸ Cancel Running Block (⌘.) stops the running block. Its result is not inserted, and the message area shows "Code block canceled." The command is also in the command palette. | |
| 129 | On the Mac, Edit ▸ Cancel Running Task (⌘.) stops the running block. Its result is not inserted, and the message area shows "Code block canceled." The same command stops an export or table recalculation running in Emacs (see [[file:12-export.org][Export]] and [[file:10-tables.org][Tables]]). With nothing running it shows "Nothing is running". The command is also in the command palette. | |
| 130 | 130 | |
| 131 | 131 | Only one block runs at a time. Starting another block cancels the one that is running. |
| 132 | 132 | |
| @@ -561,13 +561,13 @@ digraph { a -> b } | ||
| 561 | 561 | |
| 562 | 562 | Tangling writes source blocks to the files their =:tangle= argument names (=org-babel-tangle=). |
| 563 | 563 | |
| 564 | | Command | Emacs and Doom | What it tangles | | |
| 565 | |-------------------------+-----------------------------+---------------------------------------------------| | |
| 566 | | Tangle File | =C-c C-v t=, =C-c C-v C-t= | Every block in the file | | |
| 567 | | Tangle Block | none | The block at the caret (Emacs: =C-u C-c C-v t=) | | |
| 568 | | Tangle Block's Target | none | Every block going to the same file as the one at the caret (Emacs: =C-u C-u C-c C-v t=) | | |
| 564 | | Command | Emacs and Doom | Mac | What it tangles | | |
| 565 | |-------------------------+-----------------------------+--------+---------------------------------------------------| | |
| 566 | | Tangle File | =C-c C-v t=, =C-c C-v C-t= | =⌃⌘V= | Every block in the file | | |
| 567 | | Tangle Block | none | none | The block at the caret (Emacs: =C-u C-c C-v t=) | | |
| 568 | | Tangle Block's Target | none | none | Every block going to the same file as the one at the caret (Emacs: =C-u C-u C-c C-v t=) | | |
| 569 | 569 | |
| 570 | All three are in the Org menu and the command palette. The Mac preset has no keys for them. Tangling uses the text in the editor, saved or not, and the message area reports "Tangled /N/ code blocks from /file/". | |
| 570 | All three are in the Org menu and the command palette. Tangling uses the text in the editor, saved or not, and the message area reports "Tangled /N/ code blocks from /file/". | |
| 571 | 571 | |
| 572 | 572 | ** =:tangle= and file names |
| 573 | 573 | |
docs/manual/guide/12-export.org +3 −2
| @@ -18,13 +18,13 @@ Export works on the file in the current editor, using its text as it is now, sav | ||
| 18 | 18 | | ODT | Export to ODT with Emacs | =C-c C-e o o= | =C-c C-e o o= | yes | |
| 19 | 19 | | Plain text | Export to Plain Text with Emacs | =C-c C-e t u= | =C-c C-e t u= | yes | |
| 20 | 20 | |
| 21 | The keys follow Emacs's export dispatcher (=org-export-dispatch=). =C-c C-e= on its own is only a prefix: pause after it and the key hints list the formats. The =SPC m e= keys work in normal state; the =C-c C-e= keys work in every Doom state. The Mac preset has no export keys. | |
| 21 | The keys follow Emacs's export dispatcher (=org-export-dispatch=). =C-c C-e= on its own is only a prefix: pause after it and the key hints list the formats. The =SPC m e= keys work in normal state; the =C-c C-e= keys work in every Doom state. The Mac preset has no keys for the single formats; its =⇧⌘E= opens the export dialog. | |
| 22 | 22 | |
| 23 | 23 | All seven commands are in File ▸ Export and in the command palette. They write the export beside the Org file, with the same name and the format's extension: =.html=, =.md=, =.pdf=, =.tex=, =.odt= or =.txt=. A file already there is replaced. The message area shows "Exported to /name/". |
| 24 | 24 | |
| 25 | 25 | ** The export dialog |
| 26 | 26 | |
| 27 | *Export…* in the command palette opens a dialog. No preset binds it to a key; bind =app.export-dialog= in =keymap.toml= if you want one (see [[file:03-keys.org][Keys and commands]]). The dialog has: | |
| 27 | *Export…* in the command palette, or =⇧⌘E= in the Mac preset, opens a dialog. The Emacs and Doom presets have no key for it; bind =app.export-dialog= in =keymap.toml= if you want one (see [[file:03-keys.org][Keys and commands]]). The dialog has: | |
| 28 | 28 | |
| 29 | 29 | - *Format*: HTML, Markdown, PDF (Emacs), ODT (Emacs), LaTeX (Emacs) or Plain text (Emacs). |
| 30 | 30 | - *Destination*: beside the Org file by default. *Choose…* picks another place and name. Changing the format changes the extension. |
| @@ -233,6 +233,7 @@ Things to know: | ||
| 233 | 233 | - File-local variables are applied only when Emacs considers them safe. |
| 234 | 234 | - =org-export-use-babel= is off, so no source blocks run. |
| 235 | 235 | - An export that takes more than two minutes is stopped with "Emacs took too long to export." |
| 236 | - Edit ▸ Cancel Running Task (=⌘.=) stops the export and shows "Export canceled". Starting another export or table recalculation in Emacs cancels the one that is running. | |
| 236 | 237 | - If Emacs fails, the message area shows the last line of its error output. |
| 237 | 238 | |
| 238 | 239 | To use your own Emacs configuration, or formats Orgstar does not list, export from Emacs itself; see [[file:15-alongside-emacs.org][Alongside Emacs]]. |
docs/manual/guide/15-alongside-emacs.org +1 −1
| @@ -143,7 +143,7 @@ An app started from the Dock doesn't see your shell's =PATH=, which is why Orgst | ||
| 143 | 143 | - Export doesn't run source blocks (=org-export-use-babel= is =nil=). The exported file is written next to the org file, as Emacs writes it, or moved to the place you chose. |
| 144 | 144 | - For export and table recalculation, Emacs gets your =PATH= with =/opt/homebrew/bin=, =/usr/local/bin=, =/Library/TeX/texbin=, =/usr/bin= and =/bin= added, as source blocks do, so the programs it starts, such as =pdflatex=, are found when Orgstar was opened from the Dock. |
| 145 | 145 | - PDF export needs a LaTeX installation that Org's LaTeX exporter can run. |
| 146 | - A table recalculation that takes more than 60 seconds, or an export that takes more than 120 seconds, is stopped. Source blocks have a limit of 300 seconds, and =⌘.= (Cancel Running Block) stops one. | |
| 146 | - A table recalculation that takes more than 60 seconds, or an export that takes more than 120 seconds, is stopped. Source blocks have a limit of 300 seconds. =⌘.= (Cancel Running Task) stops a running block, export or table recalculation sooner. | |
| 147 | 147 | |
| 148 | 148 | * Quick Look |
| 149 | 149 | |
docs/manual/quickstart.org +1 −1
| @@ -56,7 +56,7 @@ With the Emacs keys: | ||
| 56 | 56 | | =C-c C-c= | Context action: toggle a checkbox, align a table, run a code block. | |
| 57 | 57 | |
| 58 | 58 | With the Mac preset, the Org commands are on =⌃⌘= keys (=⌃⌘T= cycles TODO, =⌃⌘S= |
| 59 | schedules); with Doom, they're under =SPC m= (=SPC m t=, =SPC m d s=). | |
| 59 | schedules, =⌃⌘X= is the context action); with Doom, they're under =SPC m= (=SPC m t=, =SPC m d s=). | |
| 60 | 60 | |
| 61 | 61 | The [[file:guide/02-the-editor.org][editor chapter]] covers how Org markup is shown and |
| 62 | 62 | hidden, and [[file:guide/04-outlines.org][Outlines and structure]] covers headings and lists. |