Release 5.07
[org-mode.git] / orgcard.tex
blob12f72b1d6b8d566e3147c0160e264dce2ba4a817
1 % Reference Card for Org Mode
2 \def\orgversionnumber{5.07}
3 \def\versionyear{2007} % latest update
4 \def\year{2007} % 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,
22 % 2005, 2006, 2007 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 2, or (at your option)
29 % 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; see the file COPYING. If not, write to
38 % the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
39 % Boston, MA 02110-1301, USA.
41 % This file is intended to be processed by plain TeX (TeX82).
43 % The final reference card has six columns, three on each side.
44 % This file can be used to produce it in any of three ways:
45 % 1 column per page
46 % produces six separate pages, each of which needs to be reduced to 80%.
47 % This gives the best resolution.
48 % 2 columns per page
49 % produces three already-reduced pages.
50 % You will still need to cut and paste.
51 % 3 columns per page
52 % produces two pages which must be printed sideways to make a
53 % ready-to-use 8.5 x 11 inch reference card.
54 % For this you need a dvi device driver that can print sideways.
55 % Which mode to use is controlled by setting \columnsperpage above.
57 % To compile and print this document:
58 % tex refcard.tex
59 % dvips -t landscape refcard.dvi
61 % Author:
62 % Stephen Gildea
63 % Internet: gildea@stop.mail-abuse.org
65 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
66 % for their many good ideas.
68 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
69 \centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
70 Permissions on back. v\orgversionnumber}}
72 \def\copyrightnotice{
73 \vskip 1ex plus 100 fill\begingroup\small
74 \centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
75 \centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \versionyear}
76 \centerline{Author: Philip Rooke}
77 \centerline{based on refcard design and format by Stephen Gildea}
79 Permission is granted to make and distribute copies of
80 this card provided the copyright notice and this permission notice
81 are preserved on all copies.
83 \endgroup}
85 % make \bye not \outer so that the \def\bye in the \else clause below
86 % can be scanned without complaint.
87 \def\bye{\par\vfill\supereject\end}
89 \newdimen\intercolumnskip %horizontal space between columns
90 \newbox\columna %boxes to hold columns already built
91 \newbox\columnb
93 \def\ncolumns{\the\columnsperpage}
95 \message{[\ncolumns\space
96 column\if 1\ncolumns\else s\fi\space per page]}
98 \def\scaledmag#1{ scaled \magstep #1}
100 % This multi-way format was designed by Stephen Gildea October 1986.
101 % Note that the 1-column format is fontfamily-independent.
102 \if 1\ncolumns %one-column format uses normal size
103 \hsize 4in
104 \vsize 10in
105 \voffset -.7in
106 \font\titlefont=\fontname\tenbf \scaledmag3
107 \font\headingfont=\fontname\tenbf \scaledmag2
108 \font\smallfont=\fontname\sevenrm
109 \font\smallsy=\fontname\sevensy
111 \footline{\hss\folio}
112 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
113 \else %2 or 3 columns uses prereduced size
114 \if 1\the\letterpaper
115 \hsize 3.2in
116 \vsize 7.95in
117 \hoffset -.75in
118 \voffset -.745in
119 \else
120 \hsize 3.2in
121 \vsize 7.65in
122 \hoffset -.25in
123 \voffset -.745in
125 \font\titlefont=cmbx10 \scaledmag2
126 \font\headingfont=cmbx10 \scaledmag1
127 \font\smallfont=cmr6
128 \font\smallsy=cmsy6
129 \font\eightrm=cmr8
130 \font\eightbf=cmbx8
131 \font\eightit=cmti8
132 \font\eighttt=cmtt8
133 \font\eightmi=cmmi8
134 \font\eightsy=cmsy8
135 \textfont0=\eightrm
136 \textfont1=\eightmi
137 \textfont2=\eightsy
138 \def\rm{\eightrm}
139 \def\bf{\eightbf}
140 \def\it{\eightit}
141 \def\tt{\eighttt}
142 \if 1\the\letterpaper
143 \normalbaselineskip=.8\normalbaselineskip
144 \else
145 \normalbaselineskip=.7\normalbaselineskip
147 \normallineskip=.8\normallineskip
148 \normallineskiplimit=.8\normallineskiplimit
149 \normalbaselines\rm %make definitions take effect
151 \if 2\ncolumns
152 \let\maxcolumn=b
153 \footline{\hss\rm\folio\hss}
154 \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
155 \else \if 3\ncolumns
156 \let\maxcolumn=c
157 \nopagenumbers
158 \else
159 \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
160 \errmessage{Illegal number of columns per page}
161 \fi\fi
163 \intercolumnskip=.46in
164 \def\abc{a}
165 \output={% %see The TeXbook page 257
166 % This next line is useful when designing the layout.
167 %\immediate\write16{Column \folio\abc\space starts with \firstmark}
168 \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
169 \else\if a\abc
170 \global\setbox\columna\columnbox \global\def\abc{b}
171 %% in case we never use \columnb (two-column mode)
172 \global\setbox\columnb\hbox to -\intercolumnskip{}
173 \else
174 \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
175 \def\multicolumnformat{\shipout\vbox{\makeheadline
176 \hbox{\box\columna\hskip\intercolumnskip
177 \box\columnb\hskip\intercolumnskip\columnbox}
178 \makefootline}\advancepageno}
179 \def\columnbox{\leftline{\pagebody}}
181 \def\bye{\par\vfill\supereject
182 \if a\abc \else\null\vfill\eject\fi
183 \if a\abc \else\null\vfill\eject\fi
184 \end}
187 % we won't be using math mode much, so redefine some of the characters
188 % we might want to talk about
189 %\catcode`\^=12
190 \catcode`\_=12
192 % we also need the tilde, for file names.
193 \catcode`\~=12
195 \chardef\\=`\\
196 \chardef\{=`\{
197 \chardef\}=`\}
199 \hyphenation{mini-buf-fer}
201 \parindent 0pt
202 \parskip 1ex plus .5ex minus .5ex
204 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
206 % newcolumn - force a new column. Use sparingly, probably only for
207 % the first column of a page, which should have a title anyway.
208 \outer\def\newcolumn{\vfill\eject}
210 % title - page title. Argument is title text.
211 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
213 % section - new major section. Argument is section name.
214 \outer\def\section#1{\par\filbreak
215 \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
216 \vskip 2ex plus 1ex minus 1.5ex}
218 \newdimen\keyindent
220 % beginindentedkeys...endindentedkeys - key definitions will be
221 % indented, but running text, typically used as headings to group
222 % definitions, will not.
223 \def\beginindentedkeys{\keyindent=1em}
224 \def\endindentedkeys{\keyindent=0em}
225 \endindentedkeys
227 % paralign - begin paragraph containing an alignment.
228 % If an \halign is entered while in vertical mode, a parskip is never
229 % inserted. Using \paralign instead of \halign solves this problem.
230 \def\paralign{\vskip\parskip\halign}
232 % \<...> - surrounds a variable name in a code example
233 \def\<#1>{{\it #1\/}}
235 % kbd - argument is characters typed literally. Like the Texinfo command.
236 \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
238 % beginexample...endexample - surrounds literal text, such a code example.
239 % typeset in a typewriter font with line breaks preserved
240 \def\beginexample{\par\leavevmode\begingroup
241 \obeylines\obeyspaces\parskip0pt\tt}
242 {\obeyspaces\global\let =\ }
243 \def\endexample{\endgroup}
245 % key - definition of a key.
246 % \key{description of key}{key-name}
247 % prints the description left-justified, and the key-name in a \kbd
248 % form near the right margin.
249 \def\key#1#2{\leavevmode\hbox to \hsize{\vtop
250 {\hsize=.75\hsize\rightskip=1em
251 \hskip\keyindent\relax#1}\kbd{#2}\hfil}}
253 \newbox\metaxbox
254 \setbox\metaxbox\hbox{\kbd{M-x }}
255 \newdimen\metaxwidth
256 \metaxwidth=\wd\metaxbox
258 % metax - definition of a M-x command.
259 % \metax{description of command}{M-x command-name}
260 % Tries to justify the beginning of the command name at the same place
261 % as \key starts the key name. (The "M-x " sticks out to the left.)
262 \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
263 {\hskip\keyindent\relax#1\hfil}%
264 \hskip -\metaxwidth minus 1fil
265 \kbd{#2}\hfil}}
267 % threecol - like "key" but with two key names.
268 % for example, one for doing the action backward, and one for forward.
269 \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
270 &\kbd{#3}\hfil\quad\cr}
272 %**end of header
275 \title{Org-Mode Reference Card (1/2)}
277 \centerline{(for version \orgversionnumber)}
279 \section{Getting Started}
281 \vskip -1mm
282 \beginexample%
283 (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
284 (define-key global-map "\\C-cl" 'org-store-link)$^1$
285 (define-key global-map "\\C-ca" 'org-agenda)$^1$
286 \endexample
288 \metax{For the many customization options try}{M-x org-customize}
289 \metax{To read the on-line documentation try}{M-x org-info}
291 \section{Visibility Cycling}
293 \key{rotate current subtree between states}{TAB}
294 \key{rotate entire buffer between states}{S-TAB}
295 \key{show the whole file}{C-c C-a}
296 \key{reveal context around point}{C-c C-r}
297 \key{show subtree in indirect buffer, ded.\ frame}{C-c C-k}
298 %\key{show branches}{C-c C-k}
300 \section{Motion}
302 \key{next/previous heading}{C-c C-n/p}
303 \key{next/previous heading, same level}{C-c C-f/b}
304 \key{backward to higher level heading}{C-c C-u}
305 \key{jump to another place in document}{C-c C-j}
306 \key{previous/next plain list item}{S-UP/DOWN$^3$}
308 \section{Structure Editing}
310 \key{insert new heading/item at current level}{M-RET}
311 \key{insert new TODO entry/checkbox item}{M-S-RET}
313 \key{promote current heading up one level}{M-LEFT}
314 \key{demote current heading down one level}{M-RIGHT}
315 \key{promote current subtree up one level}{M-S-LEFT}
316 \key{demote current subtree down one level}{M-S-RIGHT}
318 \key{move subtree/list item up/down}{M-S-UP/DOWN}
319 \key{kill subtree}{C-c C-x C-w}
320 \key{copy subtree}{C-c C-x M-w}
321 \key{yank subtree}{C-c C-x C-y}
322 \key{narrow buffer to current subtree}{C-x n s}
324 \section{Archiving}
326 \key{toggle ARCHIVE tag}{C-c C-x C-a}
327 %\metax{mark fully done children}{C-u C-c C-x C-a}
328 \key{force cycling of an ARCHIVEd tree}{C-TAB}
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 \key{show sparse tree for all matches of a regexp}{C-c /}
340 \key{view TODO's in sparse tree}{C-c C-v}
341 \key{global TODO list in agenda mode}{C-c t$^1$}
342 \key{create sparse tree with all deadlines due}{C-c C-w}
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}
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-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}
547 \section{Properties and Column View}
549 \key{special commands in property lines}{C-c C-c}
550 \key{next/previous allowed value}{S-left/right}
551 \key{turn on column view}{C-c C-x C-c}
553 \key{quit column view}{q}
554 \key{next/previous allowed value}{S-left/right}
555 \key{next/previous allowed value}{n / p}
556 \key{edit value}{e}
557 \key{edit allowed values list}{a}
558 \key{show value}{v}
559 \key{make column wider/narrower}{> / <}
560 \key{move column left/right}{M-left/right}
561 \key{add new column}{M-S-right}
562 \key{Delete current column}{M-S-left}
565 \section{Timestamps}
567 \key{prompt for date and insert timestamp}{C-c .}
568 \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
569 \key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
570 \key{insert DEADLINE timestamp}{C-c C-d}
571 \key{insert SCHEDULED timestamp}{C-c C-s}
572 \key{create sparse tree with all deadlines due}{C-c C-w}
573 \key{the time between 2 dates in a time range}{C-c C-y}
574 \key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$}
575 \key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$}
576 \key{access the calendar for the current date}{C-c >}
577 \key{insert timestamp matching date in calendar}{C-c <}
578 \key{access agenda for current date}{C-c C-o}
579 \key{Select date while prompted}{mouse-1/RET}
580 %\key{... select date in calendar}{mouse-1/RET}
581 %\key{... scroll calendar back/forward one month}{< / >}
582 %\key{... forward/backward one day}{S-LEFT/RIGHT}
583 %\key{... forward/backward one week}{S-UP/DOWN}
584 %\key{... forward/backward one month}{M-S-LEFT/RIGT}
585 \key{Toggle custom format display for dates/times}{C-c C-x C-t}
587 \newcolumn
589 {\bf Clocking time}
591 \key{start clock on current item}{C-c C-x C-i}
592 \key{stop clock on current item}{C-c C-x C-o}
593 \key{cancel current clock}{C-c C-x C-x}
594 \key{display total subtree times}{C-c C-x C-d}
595 \key{remove displayed times}{C-c C-c}
596 \key{insert/update table with clock report}{C-c C-x C-r}
598 \section{Agenda Views}
600 \key{add/move current file to front of agenda}{C-c [}
601 \key{remove current file from your agenda}{C-c ]}
602 \key{cycle through agenda file list}{C-'}
604 \key{compile agenda for the current week}{C-c a a$^1$}
605 \key{compile global TODO list}{C-c a t$^1$}
606 \key{compile TODO list for specific keyword}{C-c a T$^1$}
607 \key{match tags in agenda files}{C-c a m$^1$}
608 \key{match tags in TODO entries}{C-c a M$^1$}
609 \key{find stuck projects}{C-c a \#$^1$}
610 \key{show timeline of current org file}{C-c a L$^1$}
611 \key{configure custom commands}{C-c a C$^1$}
612 \key{configure stuck projects}{C-c a !$^1$}
613 \key{agenda for date at cursor}{C-c C-o}
615 \vskip 1mm
616 To set categories, add lines like$^2$:
617 \vskip -1mm
618 \beginexample%
619 \#+CATEGORY: MyCateg
620 \endexample
622 {\bf Commands available in an agenda buffer}
624 {\bf View Org file}
626 \key{show original location of item}{SPC/mouse-3}
627 %\key{... also available with}{mouse-3}
628 \key{show and recenter window}{L}
629 \key{goto original location in other window}{TAB/mouse-2}
630 %\key{... also available with}{mouse-2}
631 \key{goto original location, delete other windows}{RET}
632 \key{show subtree in indirect buffer, ded.\ frame}{b}
633 \key{toggle follow-mode}{f}
635 {\bf Change display}
637 \key{delete other windows}{o}
638 \key{switch to day/week/month/year view}{d w m y}
639 \key{toggle inclusion of diary entries}{D}
640 \key{toggle time grid for daily schedule}{g}
641 \key{toggle display of logbook entries}{l}
642 \key{refresh agenda buffer with any changes}{r}
643 \key{save all org-mode buffers}{s}
644 \key{display the following \kbd{org-agenda-ndays}}{RIGHT}
645 \key{display the previous \kbd{org-agenda-ndays}}{LEFT}
646 \key{goto today}{.}
648 {\bf Remote editing}
650 \key{digit argument}{0-9}
651 \key{change state of current TODO item}{t}
652 \key{kill item and source}{C-k}
653 \key{archive the subtree}{\$}
654 \key{show tags of current headline}{T}
655 \key{set tags for current headline/region}{:}
656 \key{toggle ARCHIVE tag}{a}
657 \key{set priority of current item}{p}
658 \key{raise/lower priority of current item}{S-UP/DOWN$^3$}
659 \key{display weighted priority of current item}{P}
660 \key{schedule/set deadline for this item}{C-c C-s/d}
661 \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
662 \key{change timestamp to today}{>}
663 \key{insert new entry into diary}{i}
665 \newcolumn
666 \key{start the clock on current item (clock-in)}{I}
667 \key{stop the clock (clock-out)}{O}
668 \key{cancel current clock}{X}
670 {\bf Misc}
672 \key{Open link in current line}{C-c C-o}
674 {\bf Calendar commands}
676 \key{find agenda cursor date in calendar}{c}
677 \key{compute agenda for calendar cursor date}{c}
678 \key{show phases of the moon}{M}
679 \key{show sunrise/sunset times}{S}
680 \key{show holidays}{H}
681 \key{convert date to other calendars}{C}
683 {\bf Quit and Exit}
685 \key{quit agenda, remove agenda buffer}{q}
686 \key{exit agenda, remove all agenda buffers}{x}
688 \section{Calendar and Diary Integration}
690 Include Emacs diary entries into Org-mode agenda with:
691 \beginexample%
692 (setq org-agenda-include-diary t)
693 \endexample
695 \section{LaTeX and cdlatex-mode}
697 \key{preview LaTeX fragment}{C-c C-x C-l}
698 \key{Expand abbreviation (cdlatex-mode)}{TAB}
699 \key{Insert/modify math symbol (cdlatex-mode)}{` / '}
701 \section{Exporting and Publishing}
703 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
704 in the current directory. Publishing puts the resulting file into
705 some other place.
707 \key{export/publish dispatcher}{C-c C-e}
709 \key{export visible part only}{C-c C-e v}
710 \key{insert template of export options}{C-c C-x t}
711 \key{toggle fixed width for entry or region}{C-c :}
713 %{\bf HTML formatting}
715 %\key{make words {\bf bold}}{*bold*}
716 %\key{make words {\it italic}}{/italic/}
717 %\key{make words \underbar{underlined}}{_underlined_}
718 %\key{sub- and superscripts}{x\^{}3, J_dust}
719 %\key{\TeX{}-like macros}{\\alpha, \\to}
720 %\key{typeset lines in fixed width font}{start with :}
721 %\key{tables are exported as HTML tables}{start with |}
722 %\key{links become HTML links}{http:... etc}
723 %\key{include html tags}{@<b>...@</b>}
725 %{\bf Export options}
727 %Include additional information for export by putting these anywhere in the
728 %org file. Use {\tt M-TAB} completion to make sure to get the right
729 %keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
731 %\key{the title to be shown}{\#+TITLE:}
732 %\key{the author}{\#+AUTHOR:}
733 %\key{authors email address}{\#+EMAIL:}
734 %\key{language code for html}{\#+LANGUAGE:}
735 %\key{free text description of file}{\#+TEXT:}
736 %\key{... which can carry over multiple lines}{\#+TEXT:}
737 %\key{settings for the export process}{\#+OPTIONS:}
739 %\key{set number of headline levels for export}{H:2}
740 %\key{turn on/off section numbers}{num:t}
741 %\key{turn on/off table of contents}{toc:t}
742 %\key{turn on/off linebreak preservation}{\\n:nil}
743 %\key{turn on/off quoted html tags}{@:t}
744 %\key{turn on/off fixed width sections}{::t}
745 %\key{turn on/off tables}{|:t}
746 %\key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
747 %\key{turn on/off emphasised text}{*:nil}
748 %\key{turn on/off \TeX\ macros}{TeX:t}
750 {\bf Comments: Text not being exported}
752 Text before the first headline is not considered part of the document
753 and is therefore never exported.
754 Lines starting with \kbd{\#} are comments and are not exported.
755 Subtrees whose header starts with COMMENT are never exported.
757 \key{toggle COMMENT keyword on entry}{C-c ;}
759 \section{Dynamic Blocks}
761 \key{update dynamic block at point}{C-c C-x C-u}
762 \metax{update all dynamic blocks}{C-u C-c C-x C-u}
764 \section{Notes}
765 $^1$ This is only a suggestion for a binding of this command. Choose
766 you own key as shown under INSTALLATION.
768 $^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
769 press \kbd{C-c C-c} with the cursor still in the line to update.
771 $^3$ Keybinding affected by {\tt org-CUA-compatibility}.
773 \copyrightnotice
775 \bye
777 % Local variables:
778 % compile-command: "tex refcard"
779 % End:
781 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290