(Fdefine_key): Minor doc fix.
[emacs.git] / etc / orgcard.tex
blob55a797000c6221dfcd5927e27301d754fc407a3b
1 % Reference Card for Org Mode
2 \def\orgversionnumber{4.67}
3 \def\versionyear{2007} % latest update
4 \def\year{2007} % latest copyright year
6 %**start of header
7 \newcount\columnsperpage
9 % This file can be printed with 1, 2, or 3 columns per page (see below).
10 % At the moment this card works quite nicely in 3 column format and
11 % currently takes 2 full pages. It is thus suited to producing one
12 % double-side page when printed.
14 % There are a couple of tweaks in the format of this card which make it work
15 % slightly better on A4 paper. The changes due, I think, to Stephen Eglen,
16 % are commented below. Revert the changes if you want letter sized paper.
18 % Try running something like
19 % tex org-mode-ref.tex; dvips -t landscape org-mode-ref.dvi
20 % to print the card
22 \columnsperpage=3
24 % Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc
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., 59 Temple Place - Suite 330,
39 % Boston, MA 02111-1307, 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 % Author:
58 % Stephen Gildea
59 % Internet: gildea@stop.mail-abuse.org
61 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
62 % for their many good ideas.
64 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
65 \centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
66 Permissions on back. v\orgversionnumber}}
68 \def\copyrightnotice{
69 \vskip 1ex plus 100 fill\begingroup\small
70 \centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
71 \centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \versionyear}
72 \centerline{Author: Philip Rooke}
73 \centerline{based on refcard design and format by Stephen Gildea}
75 Permission is granted to make and distribute copies of
76 this card provided the copyright notice and this permission notice
77 are preserved on all copies.
79 \endgroup}
81 % make \bye not \outer so that the \def\bye in the \else clause below
82 % can be scanned without complaint.
83 \def\bye{\par\vfill\supereject\end}
85 \newdimen\intercolumnskip %horizontal space between columns
86 \newbox\columna %boxes to hold columns already built
87 \newbox\columnb
89 \def\ncolumns{\the\columnsperpage}
91 \message{[\ncolumns\space
92 column\if 1\ncolumns\else s\fi\space per page]}
94 \def\scaledmag#1{ scaled \magstep #1}
96 % This multi-way format was designed by Stephen Gildea October 1986.
97 % Note that the 1-column format is fontfamily-independent.
98 \if 1\ncolumns %one-column format uses normal size
99 \hsize 4in
100 \vsize 10in
101 \voffset -.7in
102 \font\titlefont=\fontname\tenbf \scaledmag3
103 \font\headingfont=\fontname\tenbf \scaledmag2
104 \font\smallfont=\fontname\sevenrm
105 \font\smallsy=\fontname\sevensy
107 \footline{\hss\folio}
108 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
109 \else %2 or 3 columns uses prereduced size
110 \hsize 3.2in
112 % FIXME - Try to make things more A4 friendly
113 % \vsize 7.95in
114 \vsize 7.65in
115 % \hoffset -.75in
116 \hoffset -.25in
117 \voffset -.745in
118 \font\titlefont=cmbx10 \scaledmag2
119 \font\headingfont=cmbx10 \scaledmag1
120 \font\smallfont=cmr6
121 \font\smallsy=cmsy6
122 \font\eightrm=cmr8
123 \font\eightbf=cmbx8
124 \font\eightit=cmti8
125 \font\eighttt=cmtt8
126 \font\eightmi=cmmi8
127 \font\eightsy=cmsy8
128 \textfont0=\eightrm
129 \textfont1=\eightmi
130 \textfont2=\eightsy
131 \def\rm{\eightrm}
132 \def\bf{\eightbf}
133 \def\it{\eightit}
134 \def\tt{\eighttt}
136 % FIXME - Try to make things more A4 friendly
137 % \normalbaselineskip=.8\normalbaselineskip
138 \normalbaselineskip=.7\normalbaselineskip
139 \normallineskip=.8\normallineskip
140 \normallineskiplimit=.8\normallineskiplimit
141 \normalbaselines\rm %make definitions take effect
143 \if 2\ncolumns
144 \let\maxcolumn=b
145 \footline{\hss\rm\folio\hss}
146 \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
147 \else \if 3\ncolumns
148 \let\maxcolumn=c
149 \nopagenumbers
150 \else
151 \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
152 \errmessage{Illegal number of columns per page}
153 \fi\fi
155 \intercolumnskip=.46in
156 \def\abc{a}
157 \output={% %see The TeXbook page 257
158 % This next line is useful when designing the layout.
159 %\immediate\write16{Column \folio\abc\space starts with \firstmark}
160 \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
161 \else\if a\abc
162 \global\setbox\columna\columnbox \global\def\abc{b}
163 %% in case we never use \columnb (two-column mode)
164 \global\setbox\columnb\hbox to -\intercolumnskip{}
165 \else
166 \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
167 \def\multicolumnformat{\shipout\vbox{\makeheadline
168 \hbox{\box\columna\hskip\intercolumnskip
169 \box\columnb\hskip\intercolumnskip\columnbox}
170 \makefootline}\advancepageno}
171 \def\columnbox{\leftline{\pagebody}}
173 \def\bye{\par\vfill\supereject
174 \if a\abc \else\null\vfill\eject\fi
175 \if a\abc \else\null\vfill\eject\fi
176 \end}
179 % we won't be using math mode much, so redefine some of the characters
180 % we might want to talk about
181 %\catcode`\^=12
182 \catcode`\_=12
184 % we also need the tilde, for file names.
185 \catcode`\~=12
187 \chardef\\=`\\
188 \chardef\{=`\{
189 \chardef\}=`\}
191 \hyphenation{mini-buf-fer}
193 \parindent 0pt
194 \parskip 1ex plus .5ex minus .5ex
196 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
198 % newcolumn - force a new column. Use sparingly, probably only for
199 % the first column of a page, which should have a title anyway.
200 \outer\def\newcolumn{\vfill\eject}
202 % title - page title. Argument is title text.
203 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
205 % section - new major section. Argument is section name.
206 \outer\def\section#1{\par\filbreak
207 \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
208 \vskip 2ex plus 1ex minus 1.5ex}
210 \newdimen\keyindent
212 % beginindentedkeys...endindentedkeys - key definitions will be
213 % indented, but running text, typically used as headings to group
214 % definitions, will not.
215 \def\beginindentedkeys{\keyindent=1em}
216 \def\endindentedkeys{\keyindent=0em}
217 \endindentedkeys
219 % paralign - begin paragraph containing an alignment.
220 % If an \halign is entered while in vertical mode, a parskip is never
221 % inserted. Using \paralign instead of \halign solves this problem.
222 \def\paralign{\vskip\parskip\halign}
224 % \<...> - surrounds a variable name in a code example
225 \def\<#1>{{\it #1\/}}
227 % kbd - argument is characters typed literally. Like the Texinfo command.
228 \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
230 % beginexample...endexample - surrounds literal text, such a code example.
231 % typeset in a typewriter font with line breaks preserved
232 \def\beginexample{\par\leavevmode\begingroup
233 \obeylines\obeyspaces\parskip0pt\tt}
234 {\obeyspaces\global\let =\ }
235 \def\endexample{\endgroup}
237 % key - definition of a key.
238 % \key{description of key}{key-name}
239 % prints the description left-justified, and the key-name in a \kbd
240 % form near the right margin.
241 \def\key#1#2{\leavevmode\hbox to \hsize{\vtop
242 {\hsize=.75\hsize\rightskip=1em
243 \hskip\keyindent\relax#1}\kbd{#2}\hfil}}
245 \newbox\metaxbox
246 \setbox\metaxbox\hbox{\kbd{M-x }}
247 \newdimen\metaxwidth
248 \metaxwidth=\wd\metaxbox
250 % metax - definition of a M-x command.
251 % \metax{description of command}{M-x command-name}
252 % Tries to justify the beginning of the command name at the same place
253 % as \key starts the key name. (The "M-x " sticks out to the left.)
254 \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
255 {\hskip\keyindent\relax#1\hfil}%
256 \hskip -\metaxwidth minus 1fil
257 \kbd{#2}\hfil}}
259 % threecol - like "key" but with two key names.
260 % for example, one for doing the action backward, and one for forward.
261 \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
262 &\kbd{#3}\hfil\quad\cr}
264 %**end of header
267 \title{Org-Mode Reference Card (1/2)}
269 \centerline{(for version \orgversionnumber)}
271 \section{Getting Started}
273 \vskip -1mm
274 \beginexample%
275 (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
276 (define-key global-map "\\C-cl" 'org-store-link)$^1$
277 (define-key global-map "\\C-ca" 'org-agenda)$^1$
278 \endexample
280 \metax{For the many customization options try}{M-x org-customize}
281 \metax{To read the on-line documentation try}{M-x org-info}
283 \section{Visibility Cycling}
285 \key{rotate current subtree between states}{TAB}
286 \key{rotate entire buffer between states}{S-TAB}
287 \key{show the whole file}{C-c C-a}
288 \key{reveal context around point}{C-c C-r}
289 \key{show subtree in indirect buffer, ded.\ frame}{C-c C-k}
290 %\key{show branches}{C-c C-k}
292 \section{Motion}
294 \key{next/previous heading}{C-c C-n/p}
295 \key{next/previous heading, same level}{C-c C-f/b}
296 \key{backward to higher level heading}{C-c C-u}
297 \key{jump to another place in document}{C-c C-j}
298 \key{previous/next plain list item}{S-UP/DOWN$^3$}
300 \section{Structure Editing}
302 \key{insert new heading/item at current level}{M-RET}
303 \key{insert new TODO entry/checkbox item}{M-S-RET}
305 \key{promote current heading up one level}{M-LEFT}
306 \key{demote current heading down one level}{M-RIGHT}
307 \key{promote current subtree up one level}{M-S-LEFT}
308 \key{demote current subtree down one level}{M-S-RIGHT}
310 \key{move subtree/list item up/down}{M-S-UP/DOWN}
311 \key{kill subtree}{C-c C-x C-w}
312 \key{copy subtree}{C-c C-x M-w}
313 \key{yank subtree}{C-c C-x C-y}
314 \key{narrow buffer to current subtree}{C-x n s}
316 \section{Archiving}
318 \key{toggle ARCHIVE tag}{C-c C-x C-a}
319 \metax{mark fully done children}{C-u C-c C-x C-a}
320 \key{force cycling of an ARCHIVEd tree}{C-TAB}
321 \key{move subtree to archive file}{C-c C-x C-s}
322 \metax{move all fully done children}{C-u C-c C-x C-s}
323 To set archive location for current file, add a line like$^2$:
324 \vskip -1mm
325 \beginexample%
326 \#+ARCHIVE: archfile::* Archived Tasks
327 \endexample
329 \section{Filtering and Sparse Trees}
331 \key{show sparse tree for all matches of a regexp}{C-c /}
332 \key{view TODO's in sparse tree}{C-c C-v}
333 \key{global TODO list in agenda mode}{C-c t$^1$}
334 \key{create sparse tree with all deadlines due}{C-c C-w}
335 \key{time sorted view of current org file}{C-c a L}
336 %\key{agenda for the week}{C-c a$^1$}
337 %\key{agenda for date at cursor}{C-c C-o}
339 \section{Tables}
341 {\bf Creating a table}
343 %\metax{insert a new Org-mode table}{M-x org-table-create}
344 \metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
345 \key{convert region to table}{C-c |}
346 \key{... separator at least 3 spaces}{C-3 C-c |}
348 {\bf Commands available inside tables}
350 The following commands work when the cursor is {\it inside a table}.
351 Outside of tables, the same keys may have other functionality.
353 {\bf Re-aligning and field motion}
355 \key{re-align the table without moving the cursor}{C-c C-c}
356 \key{re-align the table, move to next field}{TAB}
357 \key{move to previous field}{S-TAB}
358 \key{re-align the table, move to next row}{RET}
360 {\bf Row and column editing}
362 \key{move the current column left}{M-LEFT}
363 \key{move the current column right}{M-RIGHT}
364 \key{kill the current column}{M-S-LEFT}
365 \key{insert new column to left of cursor position}{M-S-RIGHT}
367 \key{move the current row up}{M-UP}
368 \key{move the current row down}{M-DOWN}
369 \key{kill the current row or horizontal line}{M-S-UP}
370 \key{insert new row above the current row}{M-S-DOWN}
371 \key{insert hline below (\kbd{C-u} : above) current row}{C-c -}
372 \key{sort lines in region}{C-c \^{}}
374 {\bf Regions}
376 \key{cut rectangular region}{C-c C-x C-w}
377 \key{copy rectangular region}{C-c C-x M-w}
378 \key{paste rectangular region}{C-c C-x C-y}
379 \key{fill paragraph across selected cells}{C-c C-q}
381 {\bf Calculations} (in combination with Emacs \kbd{calc} package)
383 \key{set and eval column formula}{C-c =}
384 \key{set and eval field formula}{C-u C-c =}
385 \key{edit formulas in separate buffer}{C-c '}
386 \key{re-apply all stored equations to current line}{C-c *}
387 \key{re-apply all stored equations to entire table}{C-u C-c *}
388 \key{iterate table to stability}{C-u C-u C-c *}
390 %\kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
391 %in lines starting with: {\tt | \# |}.
393 \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
395 \key{show line, column, formula reference}{C-c ?}
396 \key{sum numbers in current column/rectangle}{C-c +}
397 \key{copy down with increment}{S-RET$^3$}
399 Formulas typed in field are executed by \kbd{TAB},
400 \kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
401 formula, \kbd{:=} a named-field formula.
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}{=}
409 {\bf Miscellaneous}
411 \key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
412 \key{edit the current field in a separate window}{C-c `}
413 \key{make current field fully visible}{C-u TAB}
414 \metax{export as tab-separated file}{M-x org-table-export}
415 \metax{import tab-separated file}{M-x org-table-import}
417 {\bf Tables created with the \kbd{table.el} package}
419 \key{insert a new \kbd{table.el} table}{C-c ~}
420 \key{recognize existing table.el table}{C-c C-c}
421 \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
423 \section{Links}
425 \key{globally store link to the current location}{C-c l$^1$}
426 \key{insert a link (TAB completes stored links)}{C-c C-l}
427 \key{insert file link with file name completion}{C-u C-c C-l}
428 \key{edit (also hidden part of) link at point}{C-c C-l}
430 \key{open file links in emacs}{C-c C-o}
431 \key{...force open in emacs/other window}{C-u C-c C-o}
432 \key{open link at point}{mouse-1/2}
433 \key{...force open in emacs/other window}{mouse-3}
434 \key{record a position in mark ring}{C-c \%}
435 \key{jump back to last followed link(s)}{C-c \&}
436 \key{Find next link}{C-c C-x C-n}
437 \key{Find previous link}{C-c C-x C-p}
439 {\bf Internal Links}
441 \key{\kbd{<<My Target>>}}{\rm target}
442 \key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
443 \key{\kbd{[[*this text]]}}{\rm find headline}
444 \metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
445 \metax{\kbd{[[this text][description]]}}{\rm optional link text}
447 {\bf External Links}
449 \key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
450 \key{\kbd{file:papers/last.pdf}}{\rm file, relative}
451 \key{\kbd{file:projects.org::*that text}}{\rm find headline}
452 \key{\kbd{file:projects.org::find me}}{\rm find trgt/string}
453 %\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
454 \key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
455 \key{\kbd{mailto:adent@galaxy.net}}{\rm Email address}
456 \key{\kbd{news:comp.emacs}}{\rm Usenet group}
457 \key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
458 \key{\kbd{gnus:group}}{\rm GNUS group}
459 \key{\kbd{gnus:group\#id}}{\rm GNUS message}
460 \key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
461 \key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
462 \key{\kbd{info:emacs:Regexps}}{\rm Info file:node}
463 \key{\kbd{shell:ls *.org}}{\rm shell command}
464 \key{\kbd{elisp:(calendar)}}{\rm elisp form}
465 \metax{\kbd{[[external link][description]]}}{\rm optional link text}
466 %\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
469 \section{Remember-mode Integration}
471 See the manual for how to make remember.el use Org-mode links and
472 files. The note-finishing command \kbd{C-c C-c} will first prompt for
473 an org file. In the file, find a location with:
475 \key{rotate subtree visibility}{TAB}
476 \key{next heading}{DOWN}
477 \key{previous heading}{UP}
479 Insert the note with one of the following:
481 \key{as sublevel of heading at cursor}{RET}
482 \key{right here (cursor not on heading)}{RET}
483 \key{before current heading}{LEFT}
484 \key{after current heading}{RIGHT}
485 \key{shortcut to end of buffer (cursor at buf-start)}{RET}
486 \key{Abort}{q}
488 \section{Completion}
490 In-buffer completion completes TODO keywords at headline start, TeX
491 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS
492 after ``{\tt :}'', and dictionary words elsewhere.
494 \key{Complete word at point}{M-TAB}
497 \newcolumn
498 \title{Org-Mode Reference Card (2/2)}
500 \centerline{(for version \orgversionnumber)}
502 \section{TODO Items and Checkboxes}
504 \key{rotate the state of the current item}{C-c C-t}
505 \key{view TODO items in a sparse tree}{C-c C-v}
506 \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
508 \key{set the priority of the current item}{C-c , [ABC]}
509 \key{remove priority cookie from current item}{C-c , SPC}
510 \key{raise priority of current item}{S-UP$^3$}
511 \key{lower priority of current item}{S-DOWN$^3$}
513 \key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
514 \key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
516 \key{insert new checkbox item in plain list}{M-S-RET}
517 \key{toggle checkbox(es) in region/entry/at point}{C-c C-x C-b}
518 \key{toggle checkbox at point}{C-c C-c}
519 \metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{}
520 \key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#}
522 \section{Tags}
524 \key{set tags for current heading}{C-c C-c}
525 \key{realign tags in all headings}{C-u C-c C-c}
526 \key{create sparse tree with matching tags}{C-c \\}
527 \key{globally (agenda) match tags at cursor}{C-c C-o}
529 \section{Timestamps}
531 \key{prompt for date and insert timestamp}{C-c .}
532 \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
533 \key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
534 \key{insert DEADLINE timestamp}{C-c C-d}
535 \key{insert SCHEDULED timestamp}{C-c C-s}
536 \key{create sparse tree with all deadlines due}{C-c C-w}
537 \key{the time between 2 dates in a time range}{C-c C-y}
538 \key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$}
539 \key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$}
540 \key{access the calendar for the current date}{C-c >}
541 \key{insert timestamp matching date in calendar}{C-c <}
542 \key{access agenda for current date}{C-c C-o}
543 \key{Select date while prompted}{mouse-1/RET}
544 %\key{... select date in calendar}{mouse-1/RET}
545 %\key{... scroll calendar back/forward one month}{< / >}
546 %\key{... forward/backward one day}{S-LEFT/RIGHT}
547 %\key{... forward/backward one week}{S-UP/DOWN}
548 %\key{... forward/backward one month}{M-S-LEFT/RIGT}
549 \key{Toggle custom format display for dates/times}{C-c C-x C-t}
552 \section{Clocking Time}
554 \key{start clock on current item}{C-c C-x C-i}
555 \key{stop clock on current item}{C-c C-x C-o}
556 \key{cancel current clock}{C-c C-x C-x}
558 \key{display total subtree times}{C-c C-x C-d}
559 \key{remove displayed times}{C-c C-c}
560 \key{insert/update table with clock report}{C-c C-x C-r}
562 \section{LaTeX and cdlatex-mode}
564 \key{preview LaTeX fragment}{C-c C-x C-l}
565 \key{Expand abbreviation (cdlatex-mode)}{TAB}
566 \key{Insert/modify math symbol (cdlatex-mode)}{` / '}
568 \section{Agenda Views}
570 \key{add/move current file to front of agenda}{C-c [}
571 \key{remove current file from your agenda}{C-c ]}
572 \key{cycle through agenda file list}{C-'}
574 \key{compile agenda for the current week}{C-c a a$^1$}
575 \key{compile global TODO list}{C-c a t$^1$}
576 \key{compile TODO list for specific keyword}{C-c a T$^1$}
577 \key{match tags in agenda files}{C-c a m$^1$}
578 \key{match tags in TODO entries}{C-c a M$^1$}
579 \key{find stuck projects}{C-c a \#$^1$}
580 \key{show timeline of current org file}{C-c a L$^1$}
581 \key{configure custom commands}{C-c a C$^1$}
582 \key{configure stuck projects}{C-c a !$^1$}
583 \key{agenda for date at cursor}{C-c C-o}
585 \vskip 1mm
586 To set categories, add lines like$^2$:
587 \vskip -1mm
588 \beginexample%
589 \#+CATEGORY: MyCateg
590 \endexample
592 {\bf Commands available in an agenda buffer}
594 {\bf View Org file}
596 \key{show original location of item}{SPC/mouse-3}
597 %\key{... also available with}{mouse-3}
598 \key{show and recenter window}{L}
599 \key{goto original location in other window}{TAB/mouse-2}
600 %\key{... also available with}{mouse-2}
601 \key{goto original location, delete other windows}{RET}
602 \key{show subtree in indirect buffer, ded.\ frame}{b}
603 \key{toggle follow-mode}{f}
605 {\bf Change display}
607 \key{delete other windows}{o}
608 \key{switch to daily / weekly view}{d / w}
609 \key{toggle inclusion of diary entries}{D}
610 \key{toggle time grid for daily schedule}{g}
611 \key{toggle display of logbook entries}{l}
612 \key{refresh agenda buffer with any changes}{r}
613 \key{save all org-mode buffers}{s}
614 \key{display the following \kbd{org-agenda-ndays}}{RIGHT}
615 \key{display the previous \kbd{org-agenda-ndays}}{LEFT}
616 \key{goto today}{.}
618 {\bf Remote editing}
620 \key{digit argument}{0-9}
621 \key{change state of current TODO item}{t}
622 \key{kill item and source}{C-k}
623 \key{archive the subtree}{\$}
624 \key{show tags of current headline}{T}
625 \key{set tags for current headline}{:}
626 \key{toggle ARCHIVE tag}{a}
627 \key{set priority of current item}{p}
628 \key{raise/lower priority of current item}{S-UP/DOWN$^3$}
629 \key{display weighted priority of current item}{P}
630 \key{schedule/set deadline for this item}{C-c C-s/d}
631 \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
632 \key{change timestamp to today}{>}
633 \key{insert new entry into diary}{i}
635 \key{start the clock on current item (clock-in)}{I}
636 \key{stop the clock (clock-out)}{O}
637 \key{cancel current clock}{X}
639 {\bf Misc}
641 \key{Open link in current line}{C-c C-o}
643 \newcolumn
644 {\bf Calendar commands}
646 \key{find agenda cursor date in calendar}{c}
647 \key{compute agenda for calendar cursor date}{c}
648 \key{show phases of the moon}{M}
649 \key{show sunrise/sunset times}{S}
650 \key{show holidays}{H}
651 \key{convert date to other calendars}{C}
653 {\bf Quit and Exit}
655 \key{quit agenda, remove agenda buffer}{q}
656 \key{exit agenda, remove all agenda buffers}{x}
658 \section{Calendar and Diary Integration}
660 Include Emacs diary entries into Org-mode agenda with:
661 \beginexample%
662 (setq org-agenda-include-diary t)
663 \endexample
665 \section{Exporting and Publishing}
667 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
668 in the current directory. Publishing puts the resulting file into
669 some other place.
671 \key{export/publish dispatcher}{C-c C-e}
673 \key{export visible part only}{C-c C-e v}
674 \key{insert template of export options}{C-c C-x t}
675 \key{toggle fixed width for entry or region}{C-c :}
677 {\bf HTML formatting}
679 \key{make words {\bf bold}}{*bold*}
680 \key{make words {\it italic}}{/italic/}
681 \key{make words \underbar{underlined}}{_underlined_}
682 \key{sub- and superscripts}{x\^{}3, J_dust}
683 \key{\TeX{}-like macros}{\\alpha, \\to}
684 \key{typeset lines in fixed width font}{start with :}
685 \key{tables are exported as HTML tables}{start with |}
686 \key{links become HTML links}{http:... etc}
687 \key{include html tags}{@<b>...@</b>}
689 %{\bf Export options}
691 %Include additional information for export by putting these anywhere in the
692 %org file. Use {\tt M-TAB} completion to make sure to get the right
693 %keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
695 %\key{the title to be shown}{\#+TITLE:}
696 %\key{the author}{\#+AUTHOR:}
697 %\key{authors email address}{\#+EMAIL:}
698 %\key{language code for html}{\#+LANGUAGE:}
699 %\key{free text description of file}{\#+TEXT:}
700 %\key{... which can carry over multiple lines}{\#+TEXT:}
701 %\key{settings for the export process}{\#+OPTIONS:}
703 %\key{set number of headline levels for export}{H:2}
704 %\key{turn on/off section numbers}{num:t}
705 %\key{turn on/off table of contents}{toc:t}
706 %\key{turn on/off linebreak preservation}{\\n:nil}
707 %\key{turn on/off quoted html tags}{@:t}
708 %\key{turn on/off fixed width sections}{::t}
709 %\key{turn on/off tables}{|:t}
710 %\key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
711 %\key{turn on/off emphasised text}{*:nil}
712 %\key{turn on/off \TeX\ macros}{TeX:t}
714 {\bf Comments: Text not being exported}
716 Text before the first headline is not considered part of the document
717 and is therefore never exported.
718 Lines starting with \kbd{\#} are comments and are not exported.
719 Subtrees whose header starts with COMMENT are never exported.
721 \key{toggle COMMENT keyword on entry}{C-c ;}
724 %\section{CUA and pc-select compatibility}%
726 %Configure the variable {\tt org-CUA-compatibility} to make Org-mode
727 %avoid the \kbd{S-<cursor>} bindings used by these modes. When set,
728 %Org-mode will change the following keybindings (also in the agenda
729 %buffer, but not during date selection). See note mark four$^3$
730 %throughout the reference card.
731 %%\vskip-mm
732 %\beginexample
733 %S-UP $\to$ M-p S-DOWN $\to$ M-n
734 %S-LEFT $\to$ M-- S-RIGHT $\to$ M-+
735 %S-RET $\to$ C-S-RET
736 %\endexample
738 \section{Dynamic Blocks}
740 \key{update dynamic block at point}{C-c C-x C-u}
741 \metax{update all dynamic blocks}{C-u C-c C-x C-u}
743 \section{Notes}
744 $^1$ This is only a suggestion for a binding of this command. Choose
745 you own key as shown under INSTALLATION.
747 $^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
748 press \kbd{C-c C-c} with the cursor still in the line to update.
750 $^3$ Keybinding affected by {\tt org-CUA-compatibility}.
752 \copyrightnotice
754 \bye
757 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290
759 %%% Local Variables:
760 %%% mode: latex
761 %%% TeX-master: t
762 %%% End: