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