Commit | Line | Data |
---|---|---|
6f463292 | 1 | % Reference Card for Org Mode |
b349f79f | 2 | \def\orgversionnumber{6.05a} |
dbc28aaa | 3 | \def\versionyear{2008} % latest update |
9ec0afe8 | 4 | \def\year{2008} % latest copyright year |
dbc28aaa | 5 | |
6f463292 GM |
6 | %**start of header |
7 | \newcount\columnsperpage | |
873f531d | 8 | \newcount\letterpaper |
6f463292 GM |
9 | |
10 | % This file can be printed with 1, 2, or 3 columns per page (see below). | |
873f531d | 11 | % Specify how many you want here. |
6f463292 | 12 | |
873f531d | 13 | \columnsperpage=3 |
6f463292 | 14 | |
dbc28aaa | 15 | % Set letterpapaer to 0 for A4 paper, 1 for letter (US) paper. Useful |
873f531d | 16 | % only when columnsperpage is 2 or 3. |
6f463292 | 17 | |
873f531d | 18 | \letterpaper=0 |
6f463292 | 19 | |
873f531d | 20 | % Nothing else needs to be changed below this line. |
b83446dd GM |
21 | % Copyright (C) 1987, 1993, 1996, 1997, 2001, 2002, 2003, 2004, 2005, |
22 | % 2006, 2007, 2008 Free Software Foundation, Inc. | |
873f531d CD |
23 | |
24 | % This file is part of GNU Emacs. | |
6f463292 | 25 | |
b83446dd | 26 | % GNU Emacs is free software: you can redistribute it and/or modify |
6f463292 | 27 | % it under the terms of the GNU General Public License as published by |
b83446dd GM |
28 | % the Free Software Foundation, either version 3 of the License, or |
29 | % (at your option) any later version. | |
6f463292 GM |
30 | |
31 | % GNU Emacs is distributed in the hope that it will be useful, | |
32 | % but WITHOUT ANY WARRANTY; without even the implied warranty of | |
33 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
34 | % GNU General Public License for more details. | |
35 | ||
36 | % You should have received a copy of the GNU General Public License | |
b83446dd | 37 | % along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
6f463292 GM |
38 | |
39 | % This file is intended to be processed by plain TeX (TeX82). | |
40 | % | |
41 | % The final reference card has six columns, three on each side. | |
42 | % This file can be used to produce it in any of three ways: | |
43 | % 1 column per page | |
44 | % produces six separate pages, each of which needs to be reduced to 80%. | |
45 | % This gives the best resolution. | |
46 | % 2 columns per page | |
47 | % produces three already-reduced pages. | |
48 | % You will still need to cut and paste. | |
49 | % 3 columns per page | |
50 | % produces two pages which must be printed sideways to make a | |
51 | % ready-to-use 8.5 x 11 inch reference card. | |
52 | % For this you need a dvi device driver that can print sideways. | |
53 | % Which mode to use is controlled by setting \columnsperpage above. | |
54 | % | |
873f531d CD |
55 | % To compile and print this document: |
56 | % tex refcard.tex | |
57 | % dvips -t landscape refcard.dvi | |
58 | % | |
6f463292 GM |
59 | % Author: |
60 | % Stephen Gildea | |
61 | % Internet: gildea@stop.mail-abuse.org | |
62 | % | |
63 | % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik | |
64 | % for their many good ideas. | |
65 | ||
66 | \def\shortcopyrightnotice{\vskip 1ex plus 2 fill | |
67 | \centerline{\small \copyright\ \year\ Free Software Foundation, Inc. | |
68 | Permissions on back. v\orgversionnumber}} | |
69 | ||
70 | \def\copyrightnotice{ | |
71 | \vskip 1ex plus 100 fill\begingroup\small | |
72 | \centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.} | |
73 | \centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \versionyear} | |
74 | \centerline{Author: Philip Rooke} | |
75 | \centerline{based on refcard design and format by Stephen Gildea} | |
76 | ||
77 | Permission is granted to make and distribute copies of | |
78 | this card provided the copyright notice and this permission notice | |
79 | are preserved on all copies. | |
80 | ||
81 | \endgroup} | |
82 | ||
83 | % make \bye not \outer so that the \def\bye in the \else clause below | |
84 | % can be scanned without complaint. | |
85 | \def\bye{\par\vfill\supereject\end} | |
86 | ||
873f531d CD |
87 | \newdimen\intercolumnskip %horizontal space between columns |
88 | \newbox\columna %boxes to hold columns already built | |
6f463292 GM |
89 | \newbox\columnb |
90 | ||
91 | \def\ncolumns{\the\columnsperpage} | |
92 | ||
873f531d | 93 | \message{[\ncolumns\space |
6f463292 GM |
94 | column\if 1\ncolumns\else s\fi\space per page]} |
95 | ||
96 | \def\scaledmag#1{ scaled \magstep #1} | |
97 | ||
98 | % This multi-way format was designed by Stephen Gildea October 1986. | |
99 | % Note that the 1-column format is fontfamily-independent. | |
873f531d | 100 | \if 1\ncolumns %one-column format uses normal size |
6f463292 GM |
101 | \hsize 4in |
102 | \vsize 10in | |
103 | \voffset -.7in | |
104 | \font\titlefont=\fontname\tenbf \scaledmag3 | |
105 | \font\headingfont=\fontname\tenbf \scaledmag2 | |
106 | \font\smallfont=\fontname\sevenrm | |
107 | \font\smallsy=\fontname\sevensy | |
108 | ||
109 | \footline{\hss\folio} | |
110 | \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}} | |
873f531d | 111 | \else %2 or 3 columns uses prereduced size |
873f531d | 112 | \if 1\the\letterpaper |
39586cf3 | 113 | \hsize 3.2in |
873f531d | 114 | \vsize 7.95in |
39586cf3 CD |
115 | \hoffset -.75in |
116 | \voffset -.745in | |
873f531d | 117 | \else |
39586cf3 | 118 | \hsize 3.2in |
873f531d | 119 | \vsize 7.65in |
39586cf3 CD |
120 | \hoffset -.25in |
121 | \voffset -.745in | |
873f531d | 122 | \fi |
6f463292 GM |
123 | \font\titlefont=cmbx10 \scaledmag2 |
124 | \font\headingfont=cmbx10 \scaledmag1 | |
125 | \font\smallfont=cmr6 | |
126 | \font\smallsy=cmsy6 | |
127 | \font\eightrm=cmr8 | |
128 | \font\eightbf=cmbx8 | |
129 | \font\eightit=cmti8 | |
130 | \font\eighttt=cmtt8 | |
131 | \font\eightmi=cmmi8 | |
132 | \font\eightsy=cmsy8 | |
133 | \textfont0=\eightrm | |
134 | \textfont1=\eightmi | |
135 | \textfont2=\eightsy | |
136 | \def\rm{\eightrm} | |
137 | \def\bf{\eightbf} | |
138 | \def\it{\eightit} | |
139 | \def\tt{\eighttt} | |
873f531d CD |
140 | \if 1\the\letterpaper |
141 | \normalbaselineskip=.8\normalbaselineskip | |
142 | \else | |
143 | \normalbaselineskip=.7\normalbaselineskip | |
144 | \fi | |
6f463292 GM |
145 | \normallineskip=.8\normallineskip |
146 | \normallineskiplimit=.8\normallineskiplimit | |
873f531d | 147 | \normalbaselines\rm %make definitions take effect |
6f463292 GM |
148 | |
149 | \if 2\ncolumns | |
150 | \let\maxcolumn=b | |
151 | \footline{\hss\rm\folio\hss} | |
152 | \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}} | |
153 | \else \if 3\ncolumns | |
154 | \let\maxcolumn=c | |
155 | \nopagenumbers | |
156 | \else | |
157 | \errhelp{You must set \columnsperpage equal to 1, 2, or 3.} | |
158 | \errmessage{Illegal number of columns per page} | |
159 | \fi\fi | |
160 | ||
161 | \intercolumnskip=.46in | |
162 | \def\abc{a} | |
873f531d | 163 | \output={% %see The TeXbook page 257 |
6f463292 GM |
164 | % This next line is useful when designing the layout. |
165 | %\immediate\write16{Column \folio\abc\space starts with \firstmark} | |
166 | \if \maxcolumn\abc \multicolumnformat \global\def\abc{a} | |
167 | \else\if a\abc | |
873f531d | 168 | \global\setbox\columna\columnbox \global\def\abc{b} |
6f463292 GM |
169 | %% in case we never use \columnb (two-column mode) |
170 | \global\setbox\columnb\hbox to -\intercolumnskip{} | |
171 | \else | |
873f531d | 172 | \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi} |
6f463292 GM |
173 | \def\multicolumnformat{\shipout\vbox{\makeheadline |
174 | \hbox{\box\columna\hskip\intercolumnskip | |
175 | \box\columnb\hskip\intercolumnskip\columnbox} | |
176 | \makefootline}\advancepageno} | |
177 | \def\columnbox{\leftline{\pagebody}} | |
178 | ||
179 | \def\bye{\par\vfill\supereject | |
180 | \if a\abc \else\null\vfill\eject\fi | |
181 | \if a\abc \else\null\vfill\eject\fi | |
873f531d | 182 | \end} |
6f463292 GM |
183 | \fi |
184 | ||
185 | % we won't be using math mode much, so redefine some of the characters | |
186 | % we might want to talk about | |
187 | %\catcode`\^=12 | |
188 | \catcode`\_=12 | |
189 | ||
190 | % we also need the tilde, for file names. | |
191 | \catcode`\~=12 | |
192 | ||
193 | \chardef\\=`\\ | |
194 | \chardef\{=`\{ | |
195 | \chardef\}=`\} | |
196 | ||
197 | \hyphenation{mini-buf-fer} | |
198 | ||
199 | \parindent 0pt | |
200 | \parskip 1ex plus .5ex minus .5ex | |
201 | ||
202 | \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip} | |
203 | ||
204 | % newcolumn - force a new column. Use sparingly, probably only for | |
205 | % the first column of a page, which should have a title anyway. | |
206 | \outer\def\newcolumn{\vfill\eject} | |
207 | ||
208 | % title - page title. Argument is title text. | |
209 | \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex} | |
210 | ||
211 | % section - new major section. Argument is section name. | |
212 | \outer\def\section#1{\par\filbreak | |
213 | \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}% | |
214 | \vskip 2ex plus 1ex minus 1.5ex} | |
215 | ||
216 | \newdimen\keyindent | |
217 | ||
218 | % beginindentedkeys...endindentedkeys - key definitions will be | |
219 | % indented, but running text, typically used as headings to group | |
220 | % definitions, will not. | |
221 | \def\beginindentedkeys{\keyindent=1em} | |
222 | \def\endindentedkeys{\keyindent=0em} | |
223 | \endindentedkeys | |
224 | ||
225 | % paralign - begin paragraph containing an alignment. | |
226 | % If an \halign is entered while in vertical mode, a parskip is never | |
227 | % inserted. Using \paralign instead of \halign solves this problem. | |
228 | \def\paralign{\vskip\parskip\halign} | |
229 | ||
230 | % \<...> - surrounds a variable name in a code example | |
231 | \def\<#1>{{\it #1\/}} | |
232 | ||
233 | % kbd - argument is characters typed literally. Like the Texinfo command. | |
873f531d | 234 | \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows |
6f463292 GM |
235 | |
236 | % beginexample...endexample - surrounds literal text, such a code example. | |
237 | % typeset in a typewriter font with line breaks preserved | |
238 | \def\beginexample{\par\leavevmode\begingroup | |
239 | \obeylines\obeyspaces\parskip0pt\tt} | |
240 | {\obeyspaces\global\let =\ } | |
241 | \def\endexample{\endgroup} | |
242 | ||
243 | % key - definition of a key. | |
244 | % \key{description of key}{key-name} | |
245 | % prints the description left-justified, and the key-name in a \kbd | |
246 | % form near the right margin. | |
247 | \def\key#1#2{\leavevmode\hbox to \hsize{\vtop | |
248 | {\hsize=.75\hsize\rightskip=1em | |
249 | \hskip\keyindent\relax#1}\kbd{#2}\hfil}} | |
250 | ||
251 | \newbox\metaxbox | |
252 | \setbox\metaxbox\hbox{\kbd{M-x }} | |
253 | \newdimen\metaxwidth | |
254 | \metaxwidth=\wd\metaxbox | |
255 | ||
256 | % metax - definition of a M-x command. | |
257 | % \metax{description of command}{M-x command-name} | |
258 | % Tries to justify the beginning of the command name at the same place | |
259 | % as \key starts the key name. (The "M-x " sticks out to the left.) | |
260 | \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize | |
261 | {\hskip\keyindent\relax#1\hfil}% | |
262 | \hskip -\metaxwidth minus 1fil | |
263 | \kbd{#2}\hfil}} | |
264 | ||
265 | % threecol - like "key" but with two key names. | |
266 | % for example, one for doing the action backward, and one for forward. | |
267 | \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad | |
268 | &\kbd{#3}\hfil\quad\cr} | |
269 | ||
270 | %**end of header | |
271 | \f | |
272 | ||
273 | \title{Org-Mode Reference Card (1/2)} | |
274 | ||
275 | \centerline{(for version \orgversionnumber)} | |
276 | ||
277 | \section{Getting Started} | |
278 | % | |
279 | \vskip -1mm | |
280 | \beginexample% | |
281 | (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode)) | |
282 | (define-key global-map "\\C-cl" 'org-store-link)$^1$ | |
283 | (define-key global-map "\\C-ca" 'org-agenda)$^1$ | |
284 | \endexample | |
285 | % | |
286 | \metax{For the many customization options try}{M-x org-customize} | |
287 | \metax{To read the on-line documentation try}{M-x org-info} | |
288 | ||
289 | \section{Visibility Cycling} | |
290 | ||
291 | \key{rotate current subtree between states}{TAB} | |
292 | \key{rotate entire buffer between states}{S-TAB} | |
293 | \key{show the whole file}{C-c C-a} | |
294 | \key{reveal context around point}{C-c C-r} | |
7f6c6a23 | 295 | \key{show subtree in indirect buffer, ded.\ frame}{C-c C-k} |
6f463292 GM |
296 | %\key{show branches}{C-c C-k} |
297 | ||
298 | \section{Motion} | |
299 | ||
300 | \key{next/previous heading}{C-c C-n/p} | |
301 | \key{next/previous heading, same level}{C-c C-f/b} | |
302 | \key{backward to higher level heading}{C-c C-u} | |
303 | \key{jump to another place in document}{C-c C-j} | |
304 | \key{previous/next plain list item}{S-UP/DOWN$^3$} | |
305 | ||
306 | \section{Structure Editing} | |
307 | ||
308 | \key{insert new heading/item at current level}{M-RET} | |
dbc28aaa | 309 | \key{insert new heading after subtree}{C-RET} |
6f463292 GM |
310 | \key{insert new TODO entry/checkbox item}{M-S-RET} |
311 | ||
b349f79f CD |
312 | \key{promote/demote heading}{M-LEFT/RIGHT} |
313 | \metax{promote/demote current subtree}{M-S-LEFT/RIGHT} | |
6f463292 GM |
314 | |
315 | \key{move subtree/list item up/down}{M-S-UP/DOWN} | |
dbc28aaa | 316 | \key{refile subtree}{C-c C-w} |
6f463292 GM |
317 | \key{kill subtree}{C-c C-x C-w} |
318 | \key{copy subtree}{C-c C-x M-w} | |
319 | \key{yank subtree}{C-c C-x C-y} | |
320 | \key{narrow buffer to current subtree}{C-x n s} | |
b349f79f | 321 | \key{widen restriction to full buffer}{C-x n w} |
6f463292 GM |
322 | |
323 | \section{Archiving} | |
324 | ||
4741f7d4 | 325 | \key{toggle ARCHIVE tag}{C-c C-x a} |
6f463292 | 326 | \key{force cycling of an ARCHIVEd tree}{C-TAB} |
4741f7d4 CD |
327 | \key{move to Attic Sibling}{C-c C-x A} |
328 | %\metax{mark fully done children}{C-u C-c C-x C-a} | |
7f6c6a23 | 329 | \key{move subtree to archive file}{C-c C-x C-s} |
873f531d CD |
330 | %\metax{move all fully done children}{C-u C-c C-x C-s} |
331 | %To set archive location for current file, add a line like$^2$: | |
332 | %\vskip -1mm | |
333 | %\beginexample% | |
334 | %\#+ARCHIVE: archfile::* Archived Tasks | |
335 | %\endexample | |
6f463292 GM |
336 | |
337 | \section{Filtering and Sparse Trees} | |
338 | ||
dbc28aaa CD |
339 | % FIXME: this is garbage |
340 | \key{construct a sparse tree by various criteria}{C-c /} | |
6f463292 GM |
341 | \key{view TODO's in sparse tree}{C-c C-v} |
342 | \key{global TODO list in agenda mode}{C-c t$^1$} | |
6f463292 GM |
343 | \key{time sorted view of current org file}{C-c a L} |
344 | %\key{agenda for the week}{C-c a$^1$} | |
345 | %\key{agenda for date at cursor}{C-c C-o} | |
346 | ||
347 | \section{Tables} | |
348 | ||
349 | {\bf Creating a table} | |
350 | ||
351 | %\metax{insert a new Org-mode table}{M-x org-table-create} | |
352 | \metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB} | |
353 | \key{convert region to table}{C-c |} | |
354 | \key{... separator at least 3 spaces}{C-3 C-c |} | |
355 | ||
356 | {\bf Commands available inside tables} | |
357 | ||
358 | The following commands work when the cursor is {\it inside a table}. | |
359 | Outside of tables, the same keys may have other functionality. | |
360 | ||
361 | {\bf Re-aligning and field motion} | |
362 | ||
363 | \key{re-align the table without moving the cursor}{C-c C-c} | |
364 | \key{re-align the table, move to next field}{TAB} | |
365 | \key{move to previous field}{S-TAB} | |
366 | \key{re-align the table, move to next row}{RET} | |
367 | ||
368 | {\bf Row and column editing} | |
369 | ||
873f531d | 370 | \key{move the current column left}{M-LEFT/RIGHT} |
6f463292 GM |
371 | \key{kill the current column}{M-S-LEFT} |
372 | \key{insert new column to left of cursor position}{M-S-RIGHT} | |
373 | ||
873f531d | 374 | \key{move the current row up/down}{M-UP/DOWN} |
6f463292 GM |
375 | \key{kill the current row or horizontal line}{M-S-UP} |
376 | \key{insert new row above the current row}{M-S-DOWN} | |
7f6c6a23 | 377 | \key{insert hline below (\kbd{C-u} : above) current row}{C-c -} |
6f463292 GM |
378 | \key{sort lines in region}{C-c \^{}} |
379 | ||
380 | {\bf Regions} | |
381 | ||
382 | \key{cut rectangular region}{C-c C-x C-w} | |
383 | \key{copy rectangular region}{C-c C-x M-w} | |
384 | \key{paste rectangular region}{C-c C-x C-y} | |
385 | \key{fill paragraph across selected cells}{C-c C-q} | |
386 | ||
6f463292 GM |
387 | {\bf Miscellaneous} |
388 | ||
389 | \key{to limit column width to \kbd{N} characters, use}{...| <N> |...} | |
390 | \key{edit the current field in a separate window}{C-c `} | |
391 | \key{make current field fully visible}{C-u TAB} | |
392 | \metax{export as tab-separated file}{M-x org-table-export} | |
393 | \metax{import tab-separated file}{M-x org-table-import} | |
873f531d | 394 | \key{sum numbers in current column/rectangle}{C-c +} |
6f463292 GM |
395 | |
396 | {\bf Tables created with the \kbd{table.el} package} | |
397 | ||
398 | \key{insert a new \kbd{table.el} table}{C-c ~} | |
399 | \key{recognize existing table.el table}{C-c C-c} | |
400 | \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~} | |
401 | ||
873f531d CD |
402 | {\bf Spreadsheet} |
403 | ||
404 | Formulas typed in field are executed by \kbd{TAB}, | |
405 | \kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column | |
406 | formula, \kbd{:=} a field formula. | |
407 | ||
408 | \key{Example: Add Col1 and Col2}{|=\$1+\$2 |} | |
409 | \key{... with printf format specification}{|=\$1+\$2;\%.2f|} | |
410 | \key{... with constants from constants.el}{|=\$1/\$c/\$cm |} | |
411 | \metax{sum from 2nd to 3rd hline}{|:=vsum(@II..@III)|} | |
412 | \key{apply current column formula}{| = |} | |
413 | ||
414 | \key{set and eval column formula}{C-c =} | |
415 | \key{set and eval field formula}{C-u C-c =} | |
416 | \key{re-apply all stored equations to current line}{C-c *} | |
417 | \key{re-apply all stored equations to entire table}{C-u C-c *} | |
418 | \key{iterate table to stability}{C-u C-u C-c *} | |
419 | \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#} | |
420 | \key{show line, column, formula reference}{C-c ?} | |
421 | \key{toggle coordinate grid}{C-c \}} | |
422 | \key{toggle formula debugger}{C-c \{} | |
423 | ||
39586cf3 | 424 | \newcolumn |
873f531d CD |
425 | {\it Formula Editor} |
426 | ||
427 | \key{edit formulas in separate buffer}{C-c '} | |
428 | \key{exit and install new formulas}{C-c C-c} | |
429 | \key{exit, install, and apply new formulas}{C-u C-c C-c} | |
430 | \key{abort}{C-c C-q} | |
431 | \key{toggle reference style}{C-c C-r} | |
432 | \key{pretty-print Lisp formula}{TAB} | |
433 | \key{complete Lisp symbol}{M-TAB} | |
434 | \key{shift reference point}{S-cursor} | |
435 | \key{shift test line for column references}{M-up/down} | |
436 | \key{scroll the window showing the table}{M-S-up/down} | |
437 | \key{toggle table coordinate grid}{C-c \}} | |
438 | ||
6f463292 GM |
439 | \section{Links} |
440 | ||
441 | \key{globally store link to the current location}{C-c l$^1$} | |
442 | \key{insert a link (TAB completes stored links)}{C-c C-l} | |
443 | \key{insert file link with file name completion}{C-u C-c C-l} | |
444 | \key{edit (also hidden part of) link at point}{C-c C-l} | |
445 | ||
446 | \key{open file links in emacs}{C-c C-o} | |
447 | \key{...force open in emacs/other window}{C-u C-c C-o} | |
448 | \key{open link at point}{mouse-1/2} | |
449 | \key{...force open in emacs/other window}{mouse-3} | |
450 | \key{record a position in mark ring}{C-c \%} | |
451 | \key{jump back to last followed link(s)}{C-c \&} | |
7f6c6a23 CD |
452 | \key{Find next link}{C-c C-x C-n} |
453 | \key{Find previous link}{C-c C-x C-p} | |
b349f79f | 454 | \key{Edit code snippet of file at point}{C-c '} |
6f463292 GM |
455 | {\bf Internal Links} |
456 | ||
457 | \key{\kbd{<<My Target>>}}{\rm target} | |
458 | \key{\kbd{<<<My Target>>>}}{\rm radio target$^2$} | |
459 | \key{\kbd{[[*this text]]}}{\rm find headline} | |
460 | \metax{\kbd{[[this text]]}}{\rm find target or text in buffer} | |
461 | \metax{\kbd{[[this text][description]]}}{\rm optional link text} | |
462 | ||
463 | {\bf External Links} | |
464 | ||
465 | \key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute} | |
466 | \key{\kbd{file:papers/last.pdf}}{\rm file, relative} | |
467 | \key{\kbd{file:projects.org::*that text}}{\rm find headline} | |
468 | \key{\kbd{file:projects.org::find me}}{\rm find trgt/string} | |
469 | %\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search} | |
470 | \key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web} | |
471 | \key{\kbd{mailto:adent@galaxy.net}}{\rm Email address} | |
472 | \key{\kbd{news:comp.emacs}}{\rm Usenet group} | |
473 | \key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person} | |
474 | \key{\kbd{gnus:group}}{\rm GNUS group} | |
475 | \key{\kbd{gnus:group\#id}}{\rm GNUS message} | |
476 | \key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder} | |
477 | \key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message} | |
478 | \key{\kbd{info:emacs:Regexps}}{\rm Info file:node} | |
479 | \key{\kbd{shell:ls *.org}}{\rm shell command} | |
480 | \key{\kbd{elisp:(calendar)}}{\rm elisp form} | |
481 | \metax{\kbd{[[external link][description]]}}{\rm optional link text} | |
482 | %\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote} | |
483 | ||
484 | ||
873f531d | 485 | % \section{Remember-mode Integration} |
6f463292 | 486 | |
873f531d CD |
487 | % See the manual for how to make remember.el use Org-mode links and |
488 | % files. The note-finishing command \kbd{C-c C-c} will first prompt for | |
489 | % an org file. In the file, find a location with: | |
6f463292 | 490 | |
873f531d CD |
491 | % \key{rotate subtree visibility}{TAB} |
492 | % \key{next heading}{DOWN} | |
493 | % \key{previous heading}{UP} | |
6f463292 | 494 | |
873f531d | 495 | % Insert the note with one of the following: |
6f463292 | 496 | |
873f531d CD |
497 | % \key{as sublevel of heading at cursor}{RET} |
498 | % \key{right here (cursor not on heading)}{RET} | |
499 | % \key{before current heading}{LEFT} | |
500 | % \key{after current heading}{RIGHT} | |
501 | % \key{shortcut to end of buffer (cursor at buf-start)}{RET} | |
502 | % \key{Abort}{q} | |
6f463292 GM |
503 | |
504 | \section{Completion} | |
505 | ||
506 | In-buffer completion completes TODO keywords at headline start, TeX | |
507 | macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS | |
508 | after ``{\tt :}'', and dictionary words elsewhere. | |
509 | ||
510 | \key{Complete word at point}{M-TAB} | |
511 | ||
512 | ||
513 | \newcolumn | |
514 | \title{Org-Mode Reference Card (2/2)} | |
515 | ||
516 | \centerline{(for version \orgversionnumber)} | |
517 | ||
518 | \section{TODO Items and Checkboxes} | |
519 | ||
520 | \key{rotate the state of the current item}{C-c C-t} | |
873f531d CD |
521 | \metax{select next/previous state}{S-LEFT/RIGHT} |
522 | \metax{select next/previous set}{C-S-LEFT/RIGHT} | |
6f463292 GM |
523 | \key{view TODO items in a sparse tree}{C-c C-v} |
524 | \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v} | |
525 | ||
526 | \key{set the priority of the current item}{C-c , [ABC]} | |
527 | \key{remove priority cookie from current item}{C-c , SPC} | |
873f531d CD |
528 | \key{raise/lower priority of current item}{S-UP/DOWN$^3$} |
529 | %\key{lower priority of current item}{S-DOWN$^3$} | |
6f463292 | 530 | |
873f531d CD |
531 | %\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow} |
532 | %\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types} | |
6f463292 GM |
533 | |
534 | \key{insert new checkbox item in plain list}{M-S-RET} | |
535 | \key{toggle checkbox(es) in region/entry/at point}{C-c C-x C-b} | |
536 | \key{toggle checkbox at point}{C-c C-c} | |
537 | \metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{} | |
538 | \key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#} | |
539 | ||
540 | \section{Tags} | |
541 | ||
542 | \key{set tags for current heading}{C-c C-c} | |
543 | \key{realign tags in all headings}{C-u C-c C-c} | |
544 | \key{create sparse tree with matching tags}{C-c \\} | |
545 | \key{globally (agenda) match tags at cursor}{C-c C-o} | |
546 | ||
fecda3e8 CD |
547 | \section{Properties and Column View} |
548 | ||
dbc28aaa | 549 | \key{set property}{C-c C-x p} |
fecda3e8 CD |
550 | \key{special commands in property lines}{C-c C-c} |
551 | \key{next/previous allowed value}{S-left/right} | |
552 | \key{turn on column view}{C-c C-x C-c} | |
dbc28aaa | 553 | \key{capture columns view in dynamic block}{C-c C-x r} |
fecda3e8 CD |
554 | |
555 | \key{quit column view}{q} | |
556 | \key{next/previous allowed value}{S-left/right} | |
557 | \key{next/previous allowed value}{n / p} | |
558 | \key{edit value}{e} | |
559 | \key{edit allowed values list}{a} | |
560 | \key{show value}{v} | |
561 | \key{make column wider/narrower}{> / <} | |
562 | \key{move column left/right}{M-left/right} | |
563 | \key{add new column}{M-S-right} | |
564 | \key{Delete current column}{M-S-left} | |
565 | ||
566 | ||
6f463292 GM |
567 | \section{Timestamps} |
568 | ||
569 | \key{prompt for date and insert timestamp}{C-c .} | |
570 | \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .} | |
571 | \key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME | |
572 | \key{insert DEADLINE timestamp}{C-c C-d} | |
573 | \key{insert SCHEDULED timestamp}{C-c C-s} | |
dbc28aaa | 574 | \key{create sparse tree with all deadlines due}{C-c / d} |
6f463292 GM |
575 | \key{the time between 2 dates in a time range}{C-c C-y} |
576 | \key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$} | |
577 | \key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$} | |
578 | \key{access the calendar for the current date}{C-c >} | |
579 | \key{insert timestamp matching date in calendar}{C-c <} | |
580 | \key{access agenda for current date}{C-c C-o} | |
581 | \key{Select date while prompted}{mouse-1/RET} | |
582 | %\key{... select date in calendar}{mouse-1/RET} | |
583 | %\key{... scroll calendar back/forward one month}{< / >} | |
584 | %\key{... forward/backward one day}{S-LEFT/RIGHT} | |
585 | %\key{... forward/backward one week}{S-UP/DOWN} | |
586 | %\key{... forward/backward one month}{M-S-LEFT/RIGT} | |
587 | \key{Toggle custom format display for dates/times}{C-c C-x C-t} | |
588 | ||
fecda3e8 CD |
589 | \newcolumn |
590 | ||
873f531d | 591 | {\bf Clocking time} |
6f463292 GM |
592 | |
593 | \key{start clock on current item}{C-c C-x C-i} | |
594 | \key{stop clock on current item}{C-c C-x C-o} | |
595 | \key{cancel current clock}{C-c C-x C-x} | |
6f463292 GM |
596 | \key{display total subtree times}{C-c C-x C-d} |
597 | \key{remove displayed times}{C-c C-c} | |
598 | \key{insert/update table with clock report}{C-c C-x C-r} | |
599 | ||
6f463292 GM |
600 | \section{Agenda Views} |
601 | ||
602 | \key{add/move current file to front of agenda}{C-c [} | |
603 | \key{remove current file from your agenda}{C-c ]} | |
7f6c6a23 | 604 | \key{cycle through agenda file list}{C-'} |
dbc28aaa | 605 | \key{set/remove restriction lock}{C-c C-x </>} |
6f463292 GM |
606 | |
607 | \key{compile agenda for the current week}{C-c a a$^1$} | |
608 | \key{compile global TODO list}{C-c a t$^1$} | |
609 | \key{compile TODO list for specific keyword}{C-c a T$^1$} | |
610 | \key{match tags in agenda files}{C-c a m$^1$} | |
611 | \key{match tags in TODO entries}{C-c a M$^1$} | |
7f6c6a23 | 612 | \key{find stuck projects}{C-c a \#$^1$} |
6f463292 GM |
613 | \key{show timeline of current org file}{C-c a L$^1$} |
614 | \key{configure custom commands}{C-c a C$^1$} | |
7f6c6a23 | 615 | \key{configure stuck projects}{C-c a !$^1$} |
6f463292 GM |
616 | \key{agenda for date at cursor}{C-c C-o} |
617 | ||
6f463292 GM |
618 | {\bf Commands available in an agenda buffer} |
619 | ||
620 | {\bf View Org file} | |
621 | ||
622 | \key{show original location of item}{SPC/mouse-3} | |
623 | %\key{... also available with}{mouse-3} | |
624 | \key{show and recenter window}{L} | |
625 | \key{goto original location in other window}{TAB/mouse-2} | |
626 | %\key{... also available with}{mouse-2} | |
627 | \key{goto original location, delete other windows}{RET} | |
7f6c6a23 | 628 | \key{show subtree in indirect buffer, ded.\ frame}{b} |
6f463292 GM |
629 | \key{toggle follow-mode}{f} |
630 | ||
631 | {\bf Change display} | |
632 | ||
633 | \key{delete other windows}{o} | |
39586cf3 | 634 | \key{switch to day/week/month/year view}{d w m y} |
6f463292 | 635 | \key{toggle inclusion of diary entries}{D} |
28a16a1b | 636 | \key{toggle time grid for daily schedule}{G} |
6f463292 | 637 | \key{toggle display of logbook entries}{l} |
28a16a1b | 638 | \key{refresh agenda buffer with any changes}{r / g} |
6f463292 GM |
639 | \key{save all org-mode buffers}{s} |
640 | \key{display the following \kbd{org-agenda-ndays}}{RIGHT} | |
641 | \key{display the previous \kbd{org-agenda-ndays}}{LEFT} | |
642 | \key{goto today}{.} | |
643 | ||
644 | {\bf Remote editing} | |
645 | ||
646 | \key{digit argument}{0-9} | |
647 | \key{change state of current TODO item}{t} | |
648 | \key{kill item and source}{C-k} | |
4741f7d4 | 649 | \key{archive the subtree}{\$ / a / A} |
6f463292 | 650 | \key{show tags of current headline}{T} |
dbc28aaa | 651 | \key{set tags for current headline/region}{:} |
6f463292 GM |
652 | \key{toggle ARCHIVE tag}{a} |
653 | \key{set priority of current item}{p} | |
654 | \key{raise/lower priority of current item}{S-UP/DOWN$^3$} | |
655 | \key{display weighted priority of current item}{P} | |
656 | \key{schedule/set deadline for this item}{C-c C-s/d} | |
657 | \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$} | |
658 | \key{change timestamp to today}{>} | |
659 | \key{insert new entry into diary}{i} | |
660 | ||
fecda3e8 | 661 | \newcolumn |
dbc28aaa CD |
662 | \key{start/stop/cancel the clock on current item}{I / O / X} |
663 | \key{jump to running clock entry}{J} | |
6f463292 | 664 | |
7f6c6a23 | 665 | {\bf Misc} |
6f463292 | 666 | |
7f6c6a23 CD |
667 | \key{Open link in current line}{C-c C-o} |
668 | ||
6f463292 GM |
669 | {\bf Calendar commands} |
670 | ||
671 | \key{find agenda cursor date in calendar}{c} | |
672 | \key{compute agenda for calendar cursor date}{c} | |
673 | \key{show phases of the moon}{M} | |
674 | \key{show sunrise/sunset times}{S} | |
675 | \key{show holidays}{H} | |
676 | \key{convert date to other calendars}{C} | |
677 | ||
678 | {\bf Quit and Exit} | |
679 | ||
680 | \key{quit agenda, remove agenda buffer}{q} | |
681 | \key{exit agenda, remove all agenda buffers}{x} | |
682 | ||
683 | \section{Calendar and Diary Integration} | |
684 | ||
685 | Include Emacs diary entries into Org-mode agenda with: | |
686 | \beginexample% | |
687 | (setq org-agenda-include-diary t) | |
688 | \endexample | |
689 | ||
fecda3e8 CD |
690 | \section{LaTeX and cdlatex-mode} |
691 | ||
692 | \key{preview LaTeX fragment}{C-c C-x C-l} | |
693 | \key{Expand abbreviation (cdlatex-mode)}{TAB} | |
694 | \key{Insert/modify math symbol (cdlatex-mode)}{` / '} | |
695 | ||
6f463292 GM |
696 | \section{Exporting and Publishing} |
697 | ||
698 | Exporting creates files with extensions {\it .txt\/} and {\it .html\/} | |
699 | in the current directory. Publishing puts the resulting file into | |
700 | some other place. | |
701 | ||
702 | \key{export/publish dispatcher}{C-c C-e} | |
703 | ||
704 | \key{export visible part only}{C-c C-e v} | |
705 | \key{insert template of export options}{C-c C-x t} | |
706 | \key{toggle fixed width for entry or region}{C-c :} | |
707 | ||
fecda3e8 CD |
708 | %{\bf HTML formatting} |
709 | ||
710 | %\key{make words {\bf bold}}{*bold*} | |
711 | %\key{make words {\it italic}}{/italic/} | |
712 | %\key{make words \underbar{underlined}}{_underlined_} | |
713 | %\key{sub- and superscripts}{x\^{}3, J_dust} | |
714 | %\key{\TeX{}-like macros}{\\alpha, \\to} | |
715 | %\key{typeset lines in fixed width font}{start with :} | |
716 | %\key{tables are exported as HTML tables}{start with |} | |
717 | %\key{links become HTML links}{http:... etc} | |
718 | %\key{include html tags}{@<b>...@</b>} | |
6f463292 | 719 | |
7f6c6a23 CD |
720 | %{\bf Export options} |
721 | % | |
722 | %Include additional information for export by putting these anywhere in the | |
723 | %org file. Use {\tt M-TAB} completion to make sure to get the right | |
724 | %keywords. {\tt M-TAB} again just after keyword is complete inserts examples. | |
725 | % | |
726 | %\key{the title to be shown}{\#+TITLE:} | |
727 | %\key{the author}{\#+AUTHOR:} | |
728 | %\key{authors email address}{\#+EMAIL:} | |
729 | %\key{language code for html}{\#+LANGUAGE:} | |
730 | %\key{free text description of file}{\#+TEXT:} | |
731 | %\key{... which can carry over multiple lines}{\#+TEXT:} | |
732 | %\key{settings for the export process}{\#+OPTIONS:} | |
6f463292 GM |
733 | |
734 | %\key{set number of headline levels for export}{H:2} | |
735 | %\key{turn on/off section numbers}{num:t} | |
736 | %\key{turn on/off table of contents}{toc:t} | |
737 | %\key{turn on/off linebreak preservation}{\\n:nil} | |
738 | %\key{turn on/off quoted html tags}{@:t} | |
739 | %\key{turn on/off fixed width sections}{::t} | |
740 | %\key{turn on/off tables}{|:t} | |
741 | %\key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t} | |
6772c8e1 | 742 | %\key{turn on/off emphasized text}{*:nil} |
6f463292 GM |
743 | %\key{turn on/off \TeX\ macros}{TeX:t} |
744 | ||
745 | {\bf Comments: Text not being exported} | |
746 | ||
747 | Text before the first headline is not considered part of the document | |
748 | and is therefore never exported. | |
749 | Lines starting with \kbd{\#} are comments and are not exported. | |
750 | Subtrees whose header starts with COMMENT are never exported. | |
751 | ||
752 | \key{toggle COMMENT keyword on entry}{C-c ;} | |
753 | ||
6f463292 GM |
754 | \section{Dynamic Blocks} |
755 | ||
756 | \key{update dynamic block at point}{C-c C-x C-u} | |
757 | \metax{update all dynamic blocks}{C-u C-c C-x C-u} | |
758 | ||
759 | \section{Notes} | |
760 | $^1$ This is only a suggestion for a binding of this command. Choose | |
761 | you own key as shown under INSTALLATION. | |
762 | ||
763 | $^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line, | |
764 | press \kbd{C-c C-c} with the cursor still in the line to update. | |
765 | ||
766 | $^3$ Keybinding affected by {\tt org-CUA-compatibility}. | |
767 | ||
768 | \copyrightnotice | |
769 | ||
770 | \bye | |
771 | \f | |
873f531d | 772 | % Local variables: |
28a16a1b | 773 | % compile-command: "tex refcard" |
873f531d | 774 | % End: |
6f463292 GM |
775 | |
776 | % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290 |