Release 4.22
[org-mode.git] / orgcard.tex
blob3dfbe6faa06807b1af285e883f19e63b867ee59d
1 % Reference Card for Org Mode
2 \def\orgversionnumber{4.22}
3 \def\year{2006}
5 %**start of header
6 \newcount\columnsperpage
8 % This file can be printed with 1, 2, or 3 columns per page (see below).
9 % At the moment this card works quite nicely in 3 column format and
10 % currently takes 2 full pages. It is thus suited to producing one
11 % double-side page when printed.
13 % There are a couple of tweaks in the format of this card which make it work
14 % slightly better on A4 paper. The changes due, I think, to Stephen Eglen,
15 % are commented below. Revert the changes if you want letter sized paper.
17 % Try running something like
18 % tex org-mode-ref.tex; dvips -t landscape org-mode-ref.dvi
19 % to print the card
21 \columnsperpage=3
23 % Copyright (c) 2004 Philip Rooke, 2005, 2006 Free Software Foundation
25 % GNU Emacs is free software; you can redistribute it and/or modify
26 % it under the terms of the GNU General Public License as published by
27 % the Free Software Foundation; either version 2, or (at your option)
28 % any later version.
30 % GNU Emacs is distributed in the hope that it will be useful,
31 % but WITHOUT ANY WARRANTY; without even the implied warranty of
32 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 % GNU General Public License for more details.
35 % You should have received a copy of the GNU General Public License
36 % along with GNU Emacs; see the file COPYING. If not, write to
37 % the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
38 % Boston, MA 02111-1307, USA.
40 % This file is intended to be processed by plain TeX (TeX82).
42 % The final reference card has six columns, three on each side.
43 % This file can be used to produce it in any of three ways:
44 % 1 column per page
45 % produces six separate pages, each of which needs to be reduced to 80%.
46 % This gives the best resolution.
47 % 2 columns per page
48 % produces three already-reduced pages.
49 % You will still need to cut and paste.
50 % 3 columns per page
51 % produces two pages which must be printed sideways to make a
52 % ready-to-use 8.5 x 11 inch reference card.
53 % For this you need a dvi device driver that can print sideways.
54 % Which mode to use is controlled by setting \columnsperpage above.
56 % Author:
57 % Stephen Gildea
58 % Internet: gildea@stop.mail-abuse.org
60 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
61 % for their many good ideas.
63 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
64 \centerline{\small \copyright\ 2004, 2005, 2006\ Free Software Foundation, Inc.
65 Permissions on back. v\orgversionnumber}}
67 \def\copyrightnotice{
68 \vskip 1ex plus 100 fill\begingroup\small
69 \centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
70 \centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \year}
71 \centerline{Author: Philip Rooke}
72 \centerline{based on refcard design and format by Stephen Gildea}
74 Permission is granted to make and distribute copies of
75 this card provided the copyright notice and this permission notice
76 are preserved on all copies.
78 \endgroup}
80 % make \bye not \outer so that the \def\bye in the \else clause below
81 % can be scanned without complaint.
82 \def\bye{\par\vfill\supereject\end}
84 \newdimen\intercolumnskip %horizontal space between columns
85 \newbox\columna %boxes to hold columns already built
86 \newbox\columnb
88 \def\ncolumns{\the\columnsperpage}
90 \message{[\ncolumns\space
91 column\if 1\ncolumns\else s\fi\space per page]}
93 \def\scaledmag#1{ scaled \magstep #1}
95 % This multi-way format was designed by Stephen Gildea October 1986.
96 % Note that the 1-column format is fontfamily-independent.
97 \if 1\ncolumns %one-column format uses normal size
98 \hsize 4in
99 \vsize 10in
100 \voffset -.7in
101 \font\titlefont=\fontname\tenbf \scaledmag3
102 \font\headingfont=\fontname\tenbf \scaledmag2
103 \font\smallfont=\fontname\sevenrm
104 \font\smallsy=\fontname\sevensy
106 \footline{\hss\folio}
107 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
108 \else %2 or 3 columns uses prereduced size
109 \hsize 3.2in
111 % FIXME - Try to make things more A4 friendly
112 % \vsize 7.95in
113 \vsize 7.65in
114 % \hoffset -.75in
115 \hoffset -.25in
116 \voffset -.745in
117 \font\titlefont=cmbx10 \scaledmag2
118 \font\headingfont=cmbx10 \scaledmag1
119 \font\smallfont=cmr6
120 \font\smallsy=cmsy6
121 \font\eightrm=cmr8
122 \font\eightbf=cmbx8
123 \font\eightit=cmti8
124 \font\eighttt=cmtt8
125 \font\eightmi=cmmi8
126 \font\eightsy=cmsy8
127 \textfont0=\eightrm
128 \textfont1=\eightmi
129 \textfont2=\eightsy
130 \def\rm{\eightrm}
131 \def\bf{\eightbf}
132 \def\it{\eightit}
133 \def\tt{\eighttt}
135 % FIXME - Try to make things more A4 friendly
136 % \normalbaselineskip=.8\normalbaselineskip
137 \normalbaselineskip=.7\normalbaselineskip
138 \normallineskip=.8\normallineskip
139 \normallineskiplimit=.8\normallineskiplimit
140 \normalbaselines\rm %make definitions take effect
142 \if 2\ncolumns
143 \let\maxcolumn=b
144 \footline{\hss\rm\folio\hss}
145 \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
146 \else \if 3\ncolumns
147 \let\maxcolumn=c
148 \nopagenumbers
149 \else
150 \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
151 \errmessage{Illegal number of columns per page}
152 \fi\fi
154 \intercolumnskip=.46in
155 \def\abc{a}
156 \output={% %see The TeXbook page 257
157 % This next line is useful when designing the layout.
158 %\immediate\write16{Column \folio\abc\space starts with \firstmark}
159 \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
160 \else\if a\abc
161 \global\setbox\columna\columnbox \global\def\abc{b}
162 %% in case we never use \columnb (two-column mode)
163 \global\setbox\columnb\hbox to -\intercolumnskip{}
164 \else
165 \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
166 \def\multicolumnformat{\shipout\vbox{\makeheadline
167 \hbox{\box\columna\hskip\intercolumnskip
168 \box\columnb\hskip\intercolumnskip\columnbox}
169 \makefootline}\advancepageno}
170 \def\columnbox{\leftline{\pagebody}}
172 \def\bye{\par\vfill\supereject
173 \if a\abc \else\null\vfill\eject\fi
174 \if a\abc \else\null\vfill\eject\fi
175 \end}
178 % we won't be using math mode much, so redefine some of the characters
179 % we might want to talk about
180 %\catcode`\^=12
181 \catcode`\_=12
183 % we also need the tilde, for file names.
184 \catcode`\~=12
186 \chardef\\=`\\
187 \chardef\{=`\{
188 \chardef\}=`\}
190 \hyphenation{mini-buf-fer}
192 \parindent 0pt
193 \parskip 1ex plus .5ex minus .5ex
195 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
197 % newcolumn - force a new column. Use sparingly, probably only for
198 % the first column of a page, which should have a title anyway.
199 \outer\def\newcolumn{\vfill\eject}
201 % title - page title. Argument is title text.
202 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
204 % section - new major section. Argument is section name.
205 \outer\def\section#1{\par\filbreak
206 \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
207 \vskip 2ex plus 1ex minus 1.5ex}
209 \newdimen\keyindent
211 % beginindentedkeys...endindentedkeys - key definitions will be
212 % indented, but running text, typically used as headings to group
213 % definitions, will not.
214 \def\beginindentedkeys{\keyindent=1em}
215 \def\endindentedkeys{\keyindent=0em}
216 \endindentedkeys
218 % paralign - begin paragraph containing an alignment.
219 % If an \halign is entered while in vertical mode, a parskip is never
220 % inserted. Using \paralign instead of \halign solves this problem.
221 \def\paralign{\vskip\parskip\halign}
223 % \<...> - surrounds a variable name in a code example
224 \def\<#1>{{\it #1\/}}
226 % kbd - argument is characters typed literally. Like the Texinfo command.
227 \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
229 % beginexample...endexample - surrounds literal text, such a code example.
230 % typeset in a typewriter font with line breaks preserved
231 \def\beginexample{\par\leavevmode\begingroup
232 \obeylines\obeyspaces\parskip0pt\tt}
233 {\obeyspaces\global\let =\ }
234 \def\endexample{\endgroup}
236 % key - definition of a key.
237 % \key{description of key}{key-name}
238 % prints the description left-justified, and the key-name in a \kbd
239 % form near the right margin.
240 \def\key#1#2{\leavevmode\hbox to \hsize{\vtop
241 {\hsize=.75\hsize\rightskip=1em
242 \hskip\keyindent\relax#1}\kbd{#2}\hfil}}
244 \newbox\metaxbox
245 \setbox\metaxbox\hbox{\kbd{M-x }}
246 \newdimen\metaxwidth
247 \metaxwidth=\wd\metaxbox
249 % metax - definition of a M-x command.
250 % \metax{description of command}{M-x command-name}
251 % Tries to justify the beginning of the command name at the same place
252 % as \key starts the key name. (The "M-x " sticks out to the left.)
253 \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
254 {\hskip\keyindent\relax#1\hfil}%
255 \hskip -\metaxwidth minus 1fil
256 \kbd{#2}\hfil}}
258 % threecol - like "key" but with two key names.
259 % for example, one for doing the action backward, and one for forward.
260 \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
261 &\kbd{#3}\hfil\quad\cr}
263 %**end of header
266 \title{Org-Mode Reference Card (1/2)}
268 \centerline{(for version \orgversionnumber)}
270 \section{Getting Started}
272 %Put the following in your \kbd{~/.emacs}$^1$
273 \vskip -1mm
274 \beginexample%
275 %(autoload 'org-mode "org" "Org mode" t)
276 %(autoload 'org-diary "org" "Org mode diary entries")
277 %(autoload 'org-agenda "org" "Agenda from Org files" t)
278 %(autoload 'org-todo-list "org" "Global TODO list" t)
279 %(autoload 'org-store-link "org" "Store org link" t)
280 %(autoload 'orgtbl-mode "org" "Orgtbl minor mode" t)
281 %(autoload 'turn-on-orgtbl "org" "Orgtbl minor mode")
282 (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
283 (define-key global-map "\\C-cl" 'org-store-link)$^2$
284 (define-key global-map "\\C-ca" 'org-agenda)$^2$
285 \endexample
287 \metax{For the many customization options try}{M-x org-customize}
288 \metax{To read the on-line documentation try}{M-x org-info}
290 \section{Visibility Cycling}
292 \key{rotate current subtree between states}{TAB}
293 \key{rotate entire buffer between states}{S-TAB}
294 \key{show the whole file}{C-c C-a}
295 %\key{show branches}{C-c C-k}
297 \section{Motion}
299 \key{next heading}{C-c C-n}
300 \key{previous heading}{C-c C-p}
301 \key{next heading, same level}{C-c C-f}
302 \key{previous heading, same level}{C-c C-b}
303 \key{backward to higher level heading}{C-c C-u}
304 \key{jump to another place in document}{C-c C-j}
306 \section{Structure Editing}
308 \key{insert new heading/item at current level}{M-RET}
309 \key{insert new TODO entry}{M-S-RET}
311 \key{promote current heading up one level}{M-LEFT}
312 \key{demote current heading down one level}{M-RIGHT}
313 \key{promote current subtree up one level}{M-S-LEFT}
314 \key{demote current subtree down one level}{M-S-RIGHT}
316 \key{move subtree/list item up}{M-S-UP}
317 \key{move subtree/list item down}{M-S-DOWN}
318 \key{kill subtree}{C-c C-x C-w}
319 \key{copy subtree}{C-c C-x M-w}
320 \key{yank subtree}{C-c C-x C-y}
322 \key{archive subtree}{C-c \$}
323 To set archive location for current file, add a line like$^3$:
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$^2$}
334 \key{create sparse tree with all deadlines due}{C-c C-w}
335 \key{time sorted view of current org file}{C-c C-r}
336 %\key{agenda for the week}{C-c a$^2$}
337 %\key{agenda for date at cursor}{C-c C-o}
339 \section{Tags}
341 \key{set tags for current heading}{C-c C-c}
342 \key{realign tags in all headings}{C-u C-c C-c}
343 \key{create sparse tree with matching tags}{C-c \\}
344 \key{globally (agenda) match tags at cursor}{C-c C-o}
346 \section{TODO Items}
348 \key{rotate the state of the current item}{C-c C-t}
349 \key{view TODO items in a sparse tree}{C-c C-v}
350 \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
352 \key{set the priority of the current item}{C-c , [ABC]}
353 \key{remove priority cookie from current item}{C-c , SPC}
354 \key{raise priority of current item}{S-UP$^4$}
355 \key{lower priority of current item}{S-DOWN$^4$}
357 \key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
358 \key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
360 \section{Timestamps}
362 \key{prompt for date and insert timestamp}{C-c .}
363 \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
364 \key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
365 \key{insert DEADLINE timestamp}{C-c C-d}
366 \key{insert SCHEDULED timestamp}{C-c C-s}
367 \key{create sparse tree with all deadlines due}{C-c C-w}
368 \key{the time between 2 dates in a time range}{C-c C-y}
369 \key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^4$}
370 \key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^4$}
371 \key{access the calendar for the current date}{C-c >}
372 \key{insert timestamp matching date in calendar}{C-c <}
373 \key{access agenda for current date}{C-c C-o}
374 \key{Select date while prompted}{mouse-1/RET}
375 %\key{... select date in calendar}{mouse-1/RET}
376 %\key{... scroll calendar back/forward one month}{< / >}
377 %\key{... forward/backward one day}{S-LEFT/RIGHT}
378 %\key{... forward/backward one week}{S-UP/DOWN}
379 %\key{... forward/backward one month}{M-S-LEFT/RIGT}
381 \section{Links}
383 \key{globally store link to the current location}{C-c l$^2$}
384 \key{insert a link (TAB completes stored links)}{C-c C-l}
385 \key{insert file link with file name completion}{C-u C-c C-l}
386 \key{edit (also hidden part of) link at point}{C-c C-l}
388 \key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o}
389 \key{open link at point (3: in emacs)}{mouse-2/3}
390 %\key{open file links in emacs}{mouse-3}
391 \key{record a position in mark ring}{C-c \%}
392 \key{jump back to last followed link(s)}{C-c \&}
394 {\bf Internal Links}
396 \key{\kbd{<<My Target>>}}{\rm target}
397 \key{\kbd{<<<My Target>>>}}{\rm radio target$^3$}
398 \key{\kbd{[[*this text]]}}{\rm find headline}
399 \metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
400 \metax{\kbd{[[this text][description]]}}{\rm optional link text}
402 {\bf External Links}
404 \key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
405 \key{\kbd{file:papers/last.pdf}}{\rm file, relative}
406 \key{\kbd{file:projects.org::*that text}}{\rm find headline}
407 \key{\kbd{file:projects.org::find me}}{\rm find tgt/string}
408 \key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
409 \key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
410 \key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address}
411 \key{\kbd{news:comp.emacs}}{\rm Usenet group}
412 \key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
413 \key{\kbd{shell:ls *.org}}{\rm shell command}
414 \key{\kbd{gnus:group}}{\rm GNUS group}
415 \key{\kbd{gnus:group\#id}}{\rm GNUS message}
416 \key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
417 \key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
418 \metax{\kbd{[[external link][description]]}}{\rm optional link text}
419 %\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
421 \section{Tables}
423 %Org-mode has its own built-in intuitive table editor with unique
424 %capabilities.
426 {\bf Creating a table}
428 %\metax{insert a new Org-mode table}{M-x org-table-create}
429 \metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
430 \key{convert region to table}{C-c |}
431 \key{... separator at least 3 spaces}{C-3 C-c |}
433 {\bf Commands available inside tables}
435 The following commands work when the cursor is {\it inside a table}.
436 Outside of tables, the same keys may have other functionality.
438 {\bf Re-aligning and field motion}
440 \key{re-align the table without moving the cursor}{C-c C-c}
441 \key{re-align the table, move to next field}{TAB}
442 \key{move to previous field}{S-TAB}
443 \key{re-align the table, move to next row}{RET}
445 {\bf Row and column editing}
447 \key{move the current column left}{M-LEFT}
448 \key{move the current column right}{M-RIGHT}
449 \key{kill the current column}{M-S-LEFT}
450 \key{insert new column to left of cursor position}{M-S-RIGHT}
452 \key{move the current row up}{M-UP}
453 \key{move the current row down}{M-DOWN}
454 \key{kill the current row or horizontal line}{M-S-UP}
455 \key{insert new row above the current row}{M-S-DOWN}
456 \key{insert horizontal line below the current row}{C-c -}
457 \key{insert horizontal line above the current row}{C-u C-c -}
458 \key{sort lines in region}{C-c \^{}}
460 {\bf Regions}
462 \key{cut rectangular region}{C-c C-x C-w}
463 \key{copy rectangular region}{C-c C-x M-w}
464 \key{paste rectangular region}{C-c C-x C-y}
465 \key{fill paragraph across selected cells}{C-c C-q}
467 {\bf Calculations} (in combination with Emacs \kbd{calc} package)
469 \key{set and eval column formula}{C-c =}
470 \key{set and eval named-field formula}{C-u C-c =}
471 \key{edit formulas in separate buffer}{C-c '}
472 \key{re-apply all stored equations to current line}{C-c *}
473 \key{re-apply all stored equations to entire table}{C-u C-c *}
475 %\kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
476 %in lines starting with: {\tt | \# |}.
478 \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
480 \key{display column number cursor is in}{C-c ?}
481 \key{sum numbers in current column/rectangle}{C-c +}
482 \key{copy down with increment}{S-RET$^4$}
484 Formulas typed in field are executed by \kbd{TAB},
485 \kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
486 formula, \kbd{:=} a named-field formula.
488 \key{Example: Add Col1 and Col2}{=\$1+\$2}
489 \key{... with printf format specification}{=\$1+\$2;\%.2f}
490 \key{... with constants from constants.el}{=\$1/\$c/\$cm}
491 \key{sum from 3rd hline above to here}{:=vsum(\&III)}
492 \key{apply current column formula}{=}
494 {\bf Miscellaneous}
496 \key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
497 \key{edit the current field in a separate window}{C-c `}
498 \key{make current field fully visible}{C-u TAB}
499 \metax{export as tab-separated file}{M-x org-table-export}
500 \metax{import tab-separated file}{M-x org-table-import}
502 {\bf Tables created with the \kbd{table.el} package}
504 \key{insert a new \kbd{table.el} table}{C-c ~}
505 \key{recognize existing table.el table}{C-c C-c}
506 \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
508 \newcolumn
509 \title{Org-Mode Reference Card (2/2)}
511 \centerline{(for version \orgversionnumber)}
513 \section{Agenda Views}
515 \key{add/move current file to front of agenda}{C-c [}
516 \key{remove current file from your agenda}{C-c ]}
517 \key{cycle through agenda file list}{C-,}
519 \key{compile agenda for the current week}{C-c a a$^2$}
520 \key{compile global TODO list}{C-c a t$^2$}
521 \key{compile TODO list for specific keyword}{C-c a T$^2$}
522 \key{match tags in agenda files}{C-c a m$^2$}
523 \key{agenda for date at cursor}{C-c C-o}
524 \key{show timeline of current org file}{C-c C-r}
526 \vskip 1mm
527 To set categories, add lines like$^3$:
528 \vskip -1mm
529 \beginexample%
530 \#+CATEGORY: MyCateg
531 \endexample
533 {\bf Commands available in an agenda buffer}
535 {\bf View Org file}
537 \key{show original location of item}{SPC}
538 \key{... also available with}{mouse-3}
539 \key{show and recenter window}{L}
540 \key{goto original location in other window}{TAB}
541 \key{... also available with}{mouse-2}
542 \key{goto original location, delete other windows}{RET}
543 \key{toggle follow-mode}{f}
545 {\bf Change display}
547 \key{delete other windows}{o}
548 \key{switch to daily / weekly view}{d / w}
549 \key{toggle inclusion of diary entries}{D}
550 \key{toggle time grid for daily schedule}{g}
551 \key{toggle display of logbook entries}{l}
552 \key{refresh agenda buffer with any changes}{r}
553 \key{display the following \kbd{org-agenda-ndays}}{RIGHT}
554 \key{display the previous \kbd{org-agenda-ndays}}{LEFT}
555 \key{goto today}{.}
557 {\bf Remote editing}
559 \key{digit argument}{0-9}
560 \key{change state of current TODO item}{t}
561 \key{show tags of current headline}{T}
562 \key{set tags for current headline}{:}
563 \key{set priority of current item}{p}
564 \key{raise/lower priority of current item}{S-UP/DOWN$^4$}
565 %\key{lower priority of current item}{S-DOWN$^4$}
566 \key{display weighted priority of current item}{P}
567 \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^4$}
568 %\key{change timestamp to one day earlier}{S-LEFT$^4$}
569 %\key{change timestamp to one day later}{S-RIGHT$^4$}
570 \key{change timestamp to today}{>}
571 \key{insert new entry into diary}{i}
573 {\bf Calendar commands}
575 \key{find agenda cursor date in calendar}{c}
576 \key{compute agenda for calendar cursor date}{c}
577 \key{show phases of the moon}{M}
578 \key{show sunrise/sunset times}{S}
579 \key{show holidays}{H}
580 \key{convert date to other calendars}{C}
582 {\bf Quit and Exit}
584 \key{quit agenda, remove agenda buffer}{q}
585 \key{exit agenda, remove all agenda buffers}{x}
587 \section{Exporting}
589 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
590 in the current directory.
592 \key{export as ASCII file}{C-c C-x a}
593 \key{export visible text only (e.g. for printing)}{C-c C-x v}
594 \key{export as HTML file}{C-c C-x h}
595 \key{export as HTML and open in browser}{C-c C-x b}
596 \key{prefix arg sets nb. of headline levels, e.g.}{C-3 C-c C-x h}
598 \key{export as iCalendar file}{C-c C-x i}
599 \key{export all agenda files as iCalendar files}{C-c C-x C-i}
600 \key{combine all agenda files to single iCal file}{C-c C-x C-c}
602 \key{insert template of export options}{C-c C-x t}
604 \key{toggle fixed width for entry or region}{C-c :}
606 {\bf HTML formatting}
608 \key{make words {\bf bold}}{*bold*}
609 \key{make words {\it italic}}{/italic/}
610 \key{make words \underbar{underlined}}{_underlined_}
611 \key{sub- and superscripts}{x\^{}3, J_dust}
612 \key{\TeX{}-like macros}{\\alpha, \\to}
613 \key{typeset lines in fixed width font}{start with :}
614 \key{tables are exported as HTML tables}{start with |}
615 \key{links become HTML links}{http:... etc}
616 \key{include html tags}{@<b>...@</b>}
618 {\bf Export options}
620 Include additional information for export by putting these anywhere in the
621 org file. Use {\tt M-TAB} completion to make sure to get the right
622 keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
624 \key{the title to be shown}{\#+TITLE:}
625 \key{the author}{\#+AUTHOR:}
626 \key{authors email address}{\#+EMAIL:}
627 \key{language code for html}{\#+LANGUAGE:}
628 \key{free text description of file}{\#+TEXT:}
629 \key{... which can carry over multiple lines}{\#+TEXT:}
630 \key{settings for the export process - see below}{\#+OPTIONS:}
632 {\bf Settings for the OPTIONS line}
634 \key{set number of headline levels for export}{H:2}
635 \key{turn on/off section numbers}{num:t}
636 \key{turn on/off table of contents}{toc:t}
637 \key{turn on/off linebreak preservation}{\\n:nil}
638 \key{turn on/off quoted html tags}{@:t}
639 \key{turn on/off fixed width sections}{::t}
640 \key{turn on/off tables}{|:t}
641 \key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
642 \key{turn on/off emphasised text}{*:nil}
643 \key{turn on/off \TeX\ macros}{TeX:t}
645 {\bf Comments: Text not being exported}
647 Text before the first headline is not considered part of the document
648 and is therefore never exported.
649 Lines starting with \kbd{\#} are comments and are not exported.
650 Subtrees whose header starts with COMMENT are never exported.
652 \key{toggle COMMENT keyword on entry}{C-c ;}
654 \section{Completion}
656 In-buffer completion completes TODO keywords at headline start, TeX
657 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS
658 after ``{\tt :}'', and dictionary words elsewhere.
660 \key{Complete word at point}{M-TAB}
662 \newcolumn
664 \section{Calendar and Diary Integration}
666 To include entries from the Emacs diary in your Org-mode agenda:
667 \beginexample%
668 (setq org-agenda-include-diary t)
669 \endexample
671 To include the Org-mode agenda in the normal diary, make sure you're
672 using the fancy diary display
674 %\beginexample%
675 %(add-hook 'diary-display-hook 'fancy-diary-display)
676 %\endexample
678 and in the \kbd{~/diary} file add
680 \beginexample%
681 \&\%\%(org-diary)
682 \endexample
684 to include all the files listed in \kbd{org-agenda-files}. For more
685 selective file inclusion use a line for each file:
687 \beginexample%
688 \&\%\%(org-diary) ~/path/to/some/org-file.org
689 \endexample
691 \section{Remember-mode Integration}
693 See the manual for how to make remember.el use Org-mode links and
694 files. The note-finishing command \kbd{C-c C-c} will first prompt for
695 an org file. In the file, find a location with:
697 \key{rotate subtree visibility}{TAB}
698 \key{next heading}{DOWN}
699 \key{previous heading}{UP}
701 Insert the note with one of the following:
703 \key{as sublevel of heading at cursor}{RET}
704 \key{right here (cursor not on heading)}{RET}
705 \key{before current heading}{LEFT}
706 \key{after current heading}{RIGHT}
707 \key{shortcut to end of buffer (cursor at buf-start)}{RET}
708 \key{Abort}{q}
710 \section{CUA and pc-select compatibility}
712 Configure the variable {\tt org-CUA-compatibility} to make Org-mode
713 avoid the \kbd{S-<cursor>} bindings used by these modes. When set,
714 Org-mode will change the following keybindings (also in the agenda
715 buffer, but not during date selection). See note mark four$^4$
716 throughout the reference card.
717 %\vskip-mm
718 \beginexample
719 S-UP $\to$ M-p S-DOWN $\to$ M-n
720 S-LEFT $\to$ M-- S-RIGHT $\to$ M-+
721 S-RET $\to$ C-S-RET
722 \endexample
724 \section{Notes}
725 $^1$ The six autoload forms are only needed if Org-mode is not part of
726 Emacs, or an XEmacs package.
728 $^2$ This is only a suggestion for a binding of this command. Choose
729 you own key as shown under INSTALLATION.
731 $^3$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
732 press \kbd{C-c C-c} with the cursor still in the line to update.
734 $^4$ Keybinding affected by {\tt org-CUA-compatibility}.
736 \copyrightnotice
738 \bye
741 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290
743 %%% Local Variables:
744 %%% mode: latex
745 %%% TeX-master: t
746 %%% End: