Release 6.17b
[org-mode/org-tableheadings.git] / doc / orgcard.tex
blob1a0986d750db54713c889bca768809f92547a6a9
1 % Reference Card for Org Mode
2 \def\orgversionnumber{6.17b}
3 \def\versionyear{2009} % latest update
4 \def\year{2009} % latest copyright year
6 %**start of header
7 \newcount\columnsperpage
8 \newcount\letterpaper
10 % This file can be printed with 1, 2, or 3 columns per page (see below).
11 % Specify how many you want here.
13 \columnsperpage=3
15 % Set letterpapaer to 0 for A4 paper, 1 for letter (US) paper. Useful
16 % only when columnsperpage is 2 or 3.
18 \letterpaper=0
20 % Nothing else needs to be changed below this line.
21 % Copyright (C) 1987, 1993, 1996, 1997, 2001, 2002, 2003, 2004, 2005,
22 % 2006, 2007, 2008 Free Software Foundation, Inc.
24 % This file is part of GNU Emacs.
26 % GNU Emacs is free software: you can redistribute it and/or modify
27 % it under the terms of the GNU General Public License as published by
28 % the Free Software Foundation, either version 3 of the License, or
29 % (at your option) any later version.
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.
36 % You should have received a copy of the GNU General Public License
37 % along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
39 % This file is intended to be processed by plain TeX (TeX82).
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.
55 % To compile and print this document:
56 % tex refcard.tex
57 % dvips -t landscape refcard.dvi
59 % Author:
60 % Stephen Gildea
61 % Internet: gildea@stop.mail-abuse.org
63 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
64 % for their many good ideas.
66 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
67 \centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
68 Permissions on back. v\orgversionnumber}}
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}
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.
81 \endgroup}
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}
87 \newdimen\intercolumnskip %horizontal space between columns
88 \newbox\columna %boxes to hold columns already built
89 \newbox\columnb
91 \def\ncolumns{\the\columnsperpage}
93 \message{[\ncolumns\space
94 column\if 1\ncolumns\else s\fi\space per page]}
96 \def\scaledmag#1{ scaled \magstep #1}
98 % This multi-way format was designed by Stephen Gildea October 1986.
99 % Note that the 1-column format is fontfamily-independent.
100 \if 1\ncolumns %one-column format uses normal size
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
109 \footline{\hss\folio}
110 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
111 \else %2 or 3 columns uses prereduced size
112 \if 1\the\letterpaper
113 \hsize 3.2in
114 \vsize 7.95in
115 \hoffset -.75in
116 \voffset -.745in
117 \else
118 \hsize 3.2in
119 \vsize 7.65in
120 \hoffset -.25in
121 \voffset -.745in
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}
140 \if 1\the\letterpaper
141 \normalbaselineskip=.8\normalbaselineskip
142 \else
143 \normalbaselineskip=.7\normalbaselineskip
145 \normallineskip=.8\normallineskip
146 \normallineskiplimit=.8\normallineskiplimit
147 \normalbaselines\rm %make definitions take effect
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
161 \intercolumnskip=.46in
162 \def\abc{a}
163 \output={% %see The TeXbook page 257
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
168 \global\setbox\columna\columnbox \global\def\abc{b}
169 %% in case we never use \columnb (two-column mode)
170 \global\setbox\columnb\hbox to -\intercolumnskip{}
171 \else
172 \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
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}}
179 \def\bye{\par\vfill\supereject
180 \if a\abc \else\null\vfill\eject\fi
181 \if a\abc \else\null\vfill\eject\fi
182 \end}
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
190 % we also need the tilde, for file names.
191 \catcode`\~=12
193 \chardef\\=`\\
194 \chardef\{=`\{
195 \chardef\}=`\}
197 \hyphenation{mini-buf-fer}
199 \parindent 0pt
200 \parskip 1ex plus .5ex minus .5ex
202 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
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}
208 % title - page title. Argument is title text.
209 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
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}
216 \newdimen\keyindent
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
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}
230 % \<...> - surrounds a variable name in a code example
231 \def\<#1>{{\it #1\/}}
233 % kbd - argument is characters typed literally. Like the Texinfo command.
234 \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
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}
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}}
251 \newbox\metaxbox
252 \setbox\metaxbox\hbox{\kbd{M-x }}
253 \newdimen\metaxwidth
254 \metaxwidth=\wd\metaxbox
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}}
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}
270 %**end of header
273 \title{Org-Mode Reference Card (1/2)}
275 \centerline{(for version \orgversionnumber)}
277 \section{Getting Started}
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
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}
289 \section{Visibility Cycling}
291 \key{rotate current subtree between states}{TAB}
292 \key{rotate entire buffer between states}{S-TAB}
293 \key{restore property-dependent startup visibility}{C-u C-u TAB}
294 \metax{show the whole file, including drawers}{C-u C-u C-u TAB}
295 \key{reveal context around point}{C-c C-r}
297 \section{Motion}
299 \key{next/previous heading}{C-c C-n/p}
300 \key{next/previous heading, same level}{C-c C-f/b}
301 \key{backward to higher level heading}{C-c C-u}
302 \key{jump to another place in document}{C-c C-j}
303 \key{previous/next plain list item}{S-UP/DOWN$^3$}
305 \section{Structure Editing}
307 \key{insert new heading/item at current level}{M-RET}
308 \key{insert new heading after subtree}{C-RET}
309 \key{insert new TODO entry/checkbox item}{M-S-RET}
310 \key{insert TODO entry/ckbx after subtree}{C-S-RET}
312 \key{promote/demote heading}{M-LEFT/RIGHT}
313 \metax{promote/demote current subtree}{M-S-LEFT/RIGHT}
315 \key{move subtree/list item up/down}{M-S-UP/DOWN}
316 \key{refile subtree}{C-c C-w}
317 \key{kill subtree}{C-c C-x C-w}
318 \key{copy subtree}{C-c C-x M-w}
319 \metax{yank subtree}{C-c C-x C-y or C-y}
320 \key{narrow buffer to current subtree}{C-x n s}
321 \key{widen restriction to full buffer}{C-x n w}
323 \section{Archiving}
325 \key{toggle ARCHIVE tag}{C-c C-x a}
326 \key{force cycling of an ARCHIVEd tree}{C-TAB}
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}
329 \key{move subtree to archive file}{C-c C-x C-s}
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
337 \section{Filtering and Sparse Trees}
339 % FIXME: this is garbage
340 \key{construct a sparse tree by various criteria}{C-c /}
341 \key{view TODO's in sparse tree}{C-c C-v}
342 \key{global TODO list in agenda mode}{C-c a t$^1$}
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}
347 \section{Tables}
349 {\bf Creating a table}
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 |}
356 {\bf Commands available inside tables}
358 The following commands work when the cursor is {\it inside a table}.
359 Outside of tables, the same keys may have other functionality.
361 {\bf Re-aligning and field motion}
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}
368 {\bf Row and column editing}
370 \key{move the current column left}{M-LEFT/RIGHT}
371 \key{kill the current column}{M-S-LEFT}
372 \key{insert new column to left of cursor position}{M-S-RIGHT}
374 \key{move the current row up/down}{M-UP/DOWN}
375 \key{kill the current row or horizontal line}{M-S-UP}
376 \key{insert new row above the current row}{M-S-DOWN}
377 \key{insert hline below (\kbd{C-u} : above) current row}{C-c -}
378 \key{sort lines in region}{C-c \^{}}
380 {\bf Regions}
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}
387 {\bf Miscellaneous}
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}
394 \key{sum numbers in current column/rectangle}{C-c +}
396 {\bf Tables created with the \kbd{table.el} package}
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 ~}
402 {\bf Spreadsheet}
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.
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}{| = |}
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 \{}
424 \newcolumn
425 {\it Formula Editor}
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 \}}
439 \section{Links}
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}
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 \&}
452 \key{find next link}{C-c C-x C-n}
453 \key{find previous link}{C-c C-x C-p}
454 \key{edit code snippet of file at point}{C-c '}
455 {\bf Internal Links}
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}
463 {\bf External Links}
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}
485 % \section{Remember-mode Integration}
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:
491 % \key{rotate subtree visibility}{TAB}
492 % \key{next heading}{DOWN}
493 % \key{previous heading}{UP}
495 % Insert the note with one of the following:
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}
504 \section{Completion}
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.
510 \key{Complete word at point}{M-TAB}
513 \newcolumn
514 \title{Org-Mode Reference Card (2/2)}
516 \centerline{(for version \orgversionnumber)}
518 \section{TODO Items and Checkboxes}
520 \key{rotate the state of the current item}{C-c C-t}
521 \metax{select next/previous state}{S-LEFT/RIGHT}
522 \metax{select next/previous set}{C-S-LEFT/RIGHT}
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}
526 \key{set the priority of the current item}{C-c , [ABC]}
527 \key{remove priority cookie from current item}{C-c , SPC}
528 \key{raise/lower priority of current item}{S-UP/DOWN$^3$}
529 %\key{lower priority of current item}{S-DOWN$^3$}
531 %\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
532 %\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
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 \#}
540 \section{Tags}
542 \key{set tags for current heading}{C-c C-q}
543 \key{realign tags in all headings}{C-u C-c C-q}
544 \key{create sparse tree with matching tags}{C-c \\}
545 \key{globally (agenda) match tags at cursor}{C-c C-o}
547 \section{Properties and Column View}
549 \key{set property}{C-c C-x p}
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}
553 \key{capture columns view in dynamic block}{C-c C-x i}
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}
567 \section{Timestamps}
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}
574 \key{create sparse tree with all deadlines due}{C-c / d}
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}
589 \newcolumn
591 {\bf Clocking time}
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}
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}
600 \section{Agenda Views}
602 \key{add/move current file to front of agenda}{C-c [}
603 \key{remove current file from your agenda}{C-c ]}
604 \key{cycle through agenda file list}{C-'}
605 \key{set/remove restriction lock}{C-c C-x </>}
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, TODO kwds, properties}{C-c a m$^1$}
611 \key{match only in TODO entries}{C-c a M$^1$}
612 \key{find stuck projects}{C-c a \#$^1$}
613 \key{show timeline of current org file}{C-c a L$^1$}
614 \key{configure custom commands}{C-c a C$^1$}
615 %\key{configure stuck projects}{C-c a !$^1$}
616 \key{agenda for date at cursor}{C-c C-o}
618 {\bf Commands available in an agenda buffer}
620 {\bf View Org file}
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}
628 \key{show subtree in indirect buffer, ded.\ frame}{b}
629 \key{toggle follow-mode}{f}
631 {\bf Change display}
633 \key{delete other windows}{o}
634 \key{switch to day/week/month/year view}{d w m y}
635 \key{toggle inclusion of diary entries}{D}
636 \key{toggle time grid for daily schedule}{G}
637 \key{toggle display of logbook entries}{l}
638 \key{toggle inclusion of archived trees/files}{v / C-u v}
639 \key{refresh agenda buffer with any changes}{r / g}
640 \key{filter with repect to a tag}{/}
641 \key{save all org-mode buffers}{s}
642 \key{display next/previous day,week,...}{RIGHT/LEFT}
643 \key{goto today}{.}
645 {\bf Remote editing}
647 \key{digit argument}{0-9}
648 \key{change state of current TODO item}{t}
649 \key{kill item and source}{C-k}
650 \key{archive the subtree (file/tag/sibling)}{\$ / a / A}
651 \key{show tags of current headline}{T}
652 \key{set tags for current headline/region}{:}
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{run an attachment command}{C-c C-a}
657 \key{schedule/set deadline for this item}{C-c C-s/d}
658 \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
659 \key{change timestamp to today}{>}
660 \key{insert new entry into diary}{i}
662 \newcolumn
663 \key{start/stop/cancel the clock on current item}{I / O / X}
664 \key{jump to running clock entry}{J}
666 {\bf Misc}
668 \key{Open link in current line}{C-c C-o}
670 {\bf Calendar commands}
672 \key{find agenda cursor date in calendar}{c}
673 \key{compute agenda for calendar cursor date}{c}
674 \key{show phases of the moon}{M}
675 \key{show sunrise/sunset times}{S}
676 \key{show holidays}{H}
677 \key{convert date to other calendars}{C}
679 {\bf Quit and Exit}
681 \key{quit agenda, remove agenda buffer}{q}
682 \key{exit agenda, remove all agenda buffers}{x}
684 \section{Calendar and Diary Integration}
686 Include Emacs diary entries into Org-mode agenda with:
687 \beginexample%
688 (setq org-agenda-include-diary t)
689 \endexample
691 \section{LaTeX and cdlatex-mode}
693 \key{preview LaTeX fragment}{C-c C-x C-l}
694 \key{Expand abbreviation (cdlatex-mode)}{TAB}
695 \key{Insert/modify math symbol (cdlatex-mode)}{` / '}
697 \section{Exporting and Publishing}
699 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
700 in the current directory. Publishing puts the resulting file into
701 some other place.
703 \key{export/publish dispatcher}{C-c C-e}
705 \key{export visible part only}{C-c C-e v}
706 \key{insert template of export options}{C-c C-x t}
707 \key{toggle fixed width for entry or region}{C-c :}
709 %{\bf HTML formatting}
711 %\key{make words {\bf bold}}{*bold*}
712 %\key{make words {\it italic}}{/italic/}
713 %\key{make words \underbar{underlined}}{_underlined_}
714 %\key{sub- and superscripts}{x\^{}3, J_dust}
715 %\key{\TeX{}-like macros}{\\alpha, \\to}
716 %\key{typeset lines in fixed width font}{start with :}
717 %\key{tables are exported as HTML tables}{start with |}
718 %\key{links become HTML links}{http:... etc}
719 %\key{include html tags}{@<b>...@</b>}
721 %{\bf Export options}
723 %Include additional information for export by putting these anywhere in the
724 %org file. Use {\tt M-TAB} completion to make sure to get the right
725 %keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
727 %\key{the title to be shown}{\#+TITLE:}
728 %\key{the author}{\#+AUTHOR:}
729 %\key{authors email address}{\#+EMAIL:}
730 %\key{language code for html}{\#+LANGUAGE:}
731 %\key{free text description of file}{\#+TEXT:}
732 %\key{... which can carry over multiple lines}{\#+TEXT:}
733 %\key{settings for the export process}{\#+OPTIONS:}
735 %\key{set number of headline levels for export}{H:2}
736 %\key{turn on/off section numbers}{num:t}
737 %\key{turn on/off table of contents}{toc:t}
738 %\key{turn on/off linebreak preservation}{\\n:nil}
739 %\key{turn on/off quoted html tags}{@:t}
740 %\key{turn on/off fixed width sections}{::t}
741 %\key{turn on/off tables}{|:t}
742 %\key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
743 %\key{turn on/off emphasised text}{*:nil}
744 %\key{turn on/off \TeX\ macros}{TeX:t}
746 {\bf Comments: Text not being exported}
748 Text before the first headline is not considered part of the document
749 and is therefore never exported.
750 Lines starting with \kbd{\#} are comments and are not exported.
751 Subtrees whose header starts with COMMENT are never exported.
753 \key{toggle COMMENT keyword on entry}{C-c ;}
755 \section{Dynamic Blocks}
757 \key{update dynamic block at point}{C-c C-x C-u}
758 \metax{update all dynamic blocks}{C-u C-c C-x C-u}
760 \section{Notes}
761 $^1$ This is only a suggestion for a binding of this command. Choose
762 your own key as shown under INSTALLATION.
764 $^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
765 press \kbd{C-c C-c} with the cursor still in the line to update.
767 $^3$ Keybinding affected by {\tt org-CUA-compatibility}.
769 \copyrightnotice
771 \bye
773 % Local variables:
774 % compile-command: "tex refcard"
775 % End:
777 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290