OSDN Git Service

Regular updates
[twpd/master.git] / org-mode.md
1 ---
2 title: Org Mode
3 layout: 2017/sheet
4 tags: [WIP]
5 category: Apps
6 updated: 2018-02-19
7 intro: |
8   [Org mode](https://orgmode.org/) is for keeping hierarchal notes (and more) in Emacs.
9 ---
10
11 ## Syntax
12 {: .-three-column}
13
14 ### Headings
15
16 ```org
17 * Welcome to Org mode
18
19   Lines starting with * are headings.
20   These lines without are notes.
21
22 ** Sub-heading
23
24    Two stars mark a 2nd-level subheading (h2).
25 ```
26
27 ### Lists
28
29 ```org
30 * Lists
31
32 To buy:
33 1. Milk
34 2. Eggs
35    - Organic
36 3. Cheese
37    + Parmesan
38    + Mozarella
39 ```
40
41 ### Inline styles
42
43 ```org
44 *bold*
45 /italic/
46 _underline_
47 =verbatim=
48 ~code~
49 +strike-through+
50 ```
51
52 ### To do
53
54 ```org
55 * TODO buy airplane
56 ```
57
58 Cycle by using `S-LEFT` / `S-RIGHT`. List all TODO's via `C-c C-v`.
59
60 ## Shortcuts
61 {: .-three-column}
62
63 ### Basic shortcuts
64
65 | Description    | Shortcut             |
66 | ---            | ---                  |
67 | (Un) fold      | `TAB` / `S-TAB`      |
68 | Move up        | `M-UP` / `M-DOWN`    |
69 | New headline   | `M-RET`              |
70 | Cycle workflow | `S-LEFT` / `S-RIGHT` |
71 | Cycle priority | `S-UP` / `S-DOWN` |
72 {:.-shortcuts-right}
73
74 ### Timer
75
76 | Description     | Shortcut        |
77 | ---             | ---             |
78 | Start timer     | `C-c` `C-x` `0` |
79 | Stop timer      | `C-c` `C-x` `_` |
80 | Pause timer     | `C-c` `C-x` `,` |
81 | ---             | ---             |
82 | Start countdown | `C-c` `C-x` `;` |
83 {:.-shortcuts-right}
84
85 You can use this for Pomodoro!
86
87 ### Agenda
88
89 | Description     | Shortcut        |
90 | ---             | ---             |
91 | Agenda menu     | `C-c` `a`       |
92 | ---             | ---             |
93 | Add document    | `C-c` `[`       |
94 | Remove document | `C-c` `]`       |
95 | ---             | ---             |
96 | Add date        | `C-c` `.`       |
97 | Add time & date | `C-u` `C-c` `.` |
98 {:.-shortcuts-right}
99
100 Start by adding the current file to the agenda (`C-c [`), then use the agenda menu to navigate.
101
102 ### Export
103
104 | Description | Shortcut    |
105 | ---         | ---         |
106 | Export menu | `C-c` `C-e` |
107
108 Lets you export the document as Markdown, HTML, and others.
109
110 ## References
111
112 - [Org for beginners](https://orgmode.org/worg/org-tutorials/org4beginners.html) _(orgmode.org)_
113 - [Org mode website](https://orgmode.org/) _(orgmode.org)_