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