Fix typo in `server-handle-delete-frame'; fix startup echo area message.
[emacs.git] / etc / orgcard.tex
blob0c25e4ef569a00662073736db62f92194485657f
1 % Reference Card for Org Mode 4.01
3 %**start of header
4 \newcount\columnsperpage
6 % This file can be printed with 1, 2, or 3 columns per page (see below).
7 % At the moment this card works quite nicely in 3 column format and
8 % currently takes 2 full pages. It is thus suited to producing one
9 % double-side page when printed.
11 % There are a couple of tweaks in the format of this card which make it work
12 % slightly better on A4 paper. The changes due, I think, to Stephen Eglen,
13 % are commented below. Revert the changes if you want letter sized paper.
15 % Try running something like
16 % tex org-mode-ref.tex; dvips -t landscape org-mode-ref.dvi
17 % to print the card
19 \columnsperpage=3
21 % Copyright (c) 2004 Philip Rooke, 2005 Free Software Foundation
23 % GNU Emacs is free software; you can redistribute it and/or modify
24 % it under the terms of the GNU General Public License as published by
25 % the Free Software Foundation; either version 2, or (at your option)
26 % any later version.
28 % GNU Emacs is distributed in the hope that it will be useful,
29 % but WITHOUT ANY WARRANTY; without even the implied warranty of
30 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 % GNU General Public License for more details.
33 % You should have received a copy of the GNU General Public License
34 % along with GNU Emacs; see the file COPYING. If not, write to
35 % the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
36 % Boston, MA 02111-1307, USA.
38 % This file is intended to be processed by plain TeX (TeX82).
40 % The final reference card has six columns, three on each side.
41 % This file can be used to produce it in any of three ways:
42 % 1 column per page
43 % produces six separate pages, each of which needs to be reduced to 80%.
44 % This gives the best resolution.
45 % 2 columns per page
46 % produces three already-reduced pages.
47 % You will still need to cut and paste.
48 % 3 columns per page
49 % produces two pages which must be printed sideways to make a
50 % ready-to-use 8.5 x 11 inch reference card.
51 % For this you need a dvi device driver that can print sideways.
52 % Which mode to use is controlled by setting \columnsperpage above.
54 % Author:
55 % Stephen Gildea
56 % Internet: gildea@stop.mail-abuse.org
58 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
59 % for their many good ideas.
61 \def\orgversionnumber{4.01}
62 \def\year{2005}
64 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
65 \centerline{\small \copyright\ 2004, 2005\ 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{}, \year}
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 %Put the following in your \kbd{~/.emacs}$^1$
274 \vskip -1mm
275 \beginexample%
276 %(autoload 'org-mode "org" "Org mode" t)
277 %(autoload 'org-diary "org" "Org mode diary entries")
278 %(autoload 'org-agenda "org" "Agenda from Org files" t)
279 %(autoload 'org-todo-list "org" "Global TODO list" t)
280 %(autoload 'org-store-link "org" "Store org link" t)
281 %(autoload 'orgtbl-mode "org" "Orgtbl minor mode" t)
282 %(autoload 'turn-on-orgtbl "org" "Orgtbl minor mode")
283 (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
284 (define-key global-map "\\C-cl" 'org-store-link)$^2$
285 (define-key global-map "\\C-ca" 'org-agenda)$^2$
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{show branches}{C-c C-k}
298 \section{Motion}
300 \key{next heading}{C-c C-n}
301 \key{previous heading}{C-c C-p}
302 \key{next heading, same level}{C-c C-f}
303 \key{previous heading, same level}{C-c C-b}
304 \key{backward to higher level heading}{C-c C-u}
305 \key{jump to another place in document}{C-c C-j}
307 \section{Structure Editing}
309 \key{insert new heading/item at current level}{M-RET}
310 \key{insert new TODO entry}{M-S-RET}
312 \key{promote current heading up one level}{M-LEFT}
313 \key{demote current heading down one level}{M-RIGHT}
314 \key{promote current subtree up one level}{M-S-LEFT}
315 \key{demote current subtree down one level}{M-S-RIGHT}
317 \key{move subtree/list item up}{M-S-UP}
318 \key{move subtree/list item down}{M-S-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}
323 \key{archive subtree}{C-c \$}
324 To set archive location for current file, add a line like$^3$:
325 \vskip -1mm
326 \beginexample%
327 \#+ARCHIVE: archfile::* Archived Tasks
328 \endexample
330 \section{Filtering and Sparse Trees}
332 \key{show sparse tree for all matches of a regexp}{C-c /}
333 \key{view TODO's in sparse tree}{C-c C-v}
334 \key{global TODO list in agenda mode}{C-c t$^2$}
335 \key{create sparse tree with all deadlines due}{C-c C-w}
336 \key{time sorted view of current org file}{C-c C-r}
337 %\key{agenda for the week}{C-c a$^2$}
338 %\key{agenda for date at cursor}{C-c C-o}
340 \section{Tags}
342 \key{set tags for current heading}{C-c C-c}
343 \key{realign tags in all headings}{C-u C-c C-c}
344 \key{create sparse tree with matching tags}{C-c \\}
345 \key{globally (agenda) match tags at cursor}{C-c C-o}
347 \section{TODO Items}
349 \key{rotate the state of the current item}{C-c C-t}
350 \key{view TODO items in a sparse tree}{C-c C-v}
351 \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
353 \key{set the priority of the current item}{C-c , [ABC]}
354 \key{remove priority cookie from current item}{C-c , SPC}
355 \key{raise priority of current item}{S-UP$^4$}
356 \key{lower priority of current item}{S-DOWN$^4$}
358 \vskip 1mm
359 per-file TODO workflow states: add line(s) like$^3$:
360 \vskip -1mm
361 \beginexample%
362 \#+SEQ_TODO: TODO PROCRASTINATE BLUFF DONE
363 \endexample
364 \vskip -1mm
365 per-file TODO keywords: add line(s) like$^3$:
366 \vskip -1mm
367 \beginexample%
368 \#+TYP_TODO: Phil home work DONE
369 \endexample
371 \section{Timestamps}
373 \key{prompt for date and insert timestamp}{C-c .}
374 \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
375 \key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
376 \key{insert DEADLINE timestamp}{C-c C-d}
377 \key{insert SCHEDULED timestamp}{C-c C-s}
378 \key{create sparse tree with all deadlines due}{C-c C-w}
379 \key{the time between 2 dates in a time range}{C-c C-y}
380 \key{change timestamp at cursor by $-1$ day}{S-LEFT$^4$}
381 \key{change timestamp at cursor by $+1$ day}{S-RIGHT$^4$}
382 \key{change year/month/day at cursor by $-1$}{S-DOWN$^4$}
383 \key{change year/month/day at cursor by $+1$}{S-UP$^4$}
384 \key{access the calendar for the current date}{C-c >}
385 \key{insert timestamp matching date in calendar}{C-c <}
386 \key{access agenda for current date}{C-c C-o}
387 \key{Select date while prompted}{mouse-1/RET}
388 %\key{... select date in calendar}{mouse-1/RET}
389 %\key{... scroll calendar back/forward one month}{< / >}
390 %\key{... forward/backward one day}{S-LEFT/RIGHT}
391 %\key{... forward/backward one week}{S-UP/DOWN}
392 %\key{... forward/backward one month}{M-S-LEFT/RIGT}
394 \section{Links}
396 \key{globally store link to the current location}{C-c l$^2$}
397 \key{insert a link (TAB completes stored links)}{C-c C-l}
398 \key{insert file link with file name completion}{C-u C-c C-l}
400 \key{open link at point}{C-c C-o}
401 \key{open file links in emacs}{C-u C-c C-o}
402 \key{open link at point}{mouse-2}
403 \key{open file links in emacs}{mouse-3}
405 {\bf Link types}
407 \key{\kbd{*CamelCaseWord}}{\rm search headline}
408 \key{\kbd{CamelCaseWord}}{\rm search in buffer}
409 \key{\kbd{<file:/home/dominik/img/mars.jpg>}}{\rm file, absolute}
410 \key{\kbd{<file:papers/last.pdf>}}{\rm file, relative}
411 \key{\kbd{<file:~/code/main.c:255>}}{\rm file with line nr.}
412 \key{\kbd{<file:projects.org::*CamelCaseWord>}}{\rm search headline}
413 \key{\kbd{<file:projects.org::find me>}}{\rm search string}
414 \key{\kbd{<file:projects.org::/regexp/>}}{\rm search regexp}
415 \key{\kbd{<http://www.astro.uva.nl/~dominik>}}{\rm on the web}
416 \key{\kbd{<mailto:adent@galaxy.net>}}{\rm EMail address}
417 \key{\kbd{<news:comp.emacs>}}{\rm Usenet group}
418 \key{\kbd{<bbdb:Richard Stallman>}}{\rm BBDB person}
419 \key{\kbd{<shell:ls *.org>}}{\rm shell command}
420 \key{\kbd{<gnus:group>}}{\rm GNUS group}
421 \key{\kbd{<gnus:group\#id>}}{\rm GNUS message}
422 \key{\kbd{<vm:folder>}}{\rm VM folder}
423 \key{\kbd{<vm:folder\#id>}}{\rm VM message}
424 % FIXME: would like to get this back in.
425 %\key{\kbd{<vm://myself@some.where.org/folder\#id>}}{\rm VM remote}
426 Wanderlust \kbd{<wl:...>} and RMAIL \kbd{<rmail:...>} like VM
427 %\key{\kbd{<wl:folder>}}{\rm Wanderlust f.}
428 %\key{\kbd{<wl:folder\#id>}}{\rm Wanderlust m.}
429 %\key{\kbd{<rmail:folder>}}{\rm RMAIL folder}
430 %\key{\kbd{<rmail:folder\#id>}}{\rm RMAIL msg}
432 \section{Tables}
434 %Org-mode has its own built-in intuitive table editor with unique
435 %capabilities.
437 {\bf Creating a table}
439 \metax{insert a new Org-mode table}{M-x org-table-create}
440 \metax{... or just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
441 \key{convert region to table}{C-c C-c}
442 \key{... separator at least 3 spaces}{C-3 C-c C-c}
443 %\key{... prompt for separator regexp}{C-u C-c C-c}
445 {\bf Commands available inside tables}
447 The following commands work when the cursor is {\it inside a table}.
448 Outside of tables, the same keys may have other functionality.
450 {\bf Re-aligning and field motion}
452 \key{re-align the table without moving the cursor}{C-c C-c}
453 \key{re-align the table, move to next field}{TAB}
454 \key{move to previous field}{S-TAB}
455 \key{re-align the table, move to next row}{RET}
457 {\bf Row and column editing}
459 \key{move the current column left}{M-LEFT}
460 \key{move the current column right}{M-RIGHT}
461 \key{kill the current column}{M-S-LEFT}
462 \key{insert new column to left of cursor position}{M-S-RIGHT}
464 \key{move the current row up}{M-UP}
465 \key{move the current row down}{M-DOWN}
466 \key{kill the current row or horizontal line}{M-S-UP}
467 \key{insert new row above the current row}{M-S-DOWN}
468 \key{insert horizontal line below the current row}{C-c -}
469 \key{insert horizontal line above the current row}{C-u C-c -}
470 \key{sort lines in region}{C-c \^{}}
472 {\bf Regions}
474 \key{cut rectangular region}{C-c C-x C-w}
475 \key{copy rectangular region}{C-c C-x M-w}
476 \key{paste rectangular region}{C-c C-x C-y}
477 \key{fill paragraph across selected cells}{C-c C-q}
479 {\bf Calculations}
481 These need the Emacs calc package installed.
483 \key{set and eval column formula}{C-c =}
484 \key{set and eval named-field formula}{C-u C-c =}
485 \key{edit formulas in separate buffer}{C-c '}
486 \key{re-apply all stored equations to current line}{C-c *}
487 \key{re-apply all stored equations to entire table}{C-u C-c *}
489 \kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
490 in lines starting with: {\tt | \# |}.
492 \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
494 \key{display column number cursor is in}{C-c ?}
495 \key{sum numbers in current column/rectangle}{C-c +}
496 \key{copy down with increment}{S-RET$^4$}
498 A formula can also be typed directly into into a field and will
499 executed by \kbd{TAB}, \kbd{RET} and \kbd{C-c C-c}. A leading \kbd{=}
500 introduces a column formula, \kbd{:=} a named-field formula.
502 \key{Example: Add Col1 and Col2}{=\$1+\$2}
503 \key{... with printf format specification}{=\$1+\$2;\%.2f}
504 \key{... with constants from constants.el}{=\$1/\$c/\$cm}
505 \key{sum from 3rd hline above to here}{:=vsum(\&III)}
506 \key{apply current column formula}{=}
508 {\bf Miscellaneous}
510 \key{toggle visibility of vertical lines}{C-c |}
511 \metax{export as tab-separated file}{M-x org-table-export}
512 \metax{import tab-separated file}{M-x org-table-import}
514 {\bf Tables created with the \kbd{table.el} package}
516 \key{insert a new \kbd{table.el} table}{C-c ~}
517 \key{recognize existing table.el table}{C-c C-c}
518 \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
520 \newcolumn
521 \title{Org-Mode Reference Card (2/2)}
523 \centerline{(for version \orgversionnumber)}
525 \section{Agenda Views}
527 \key{add/move current file to front of agenda}{C-c [}
528 \key{remove current file from your agenda}{C-c ]}
529 \key{cycle through agenda file list}{C-,}
531 \key{compile agenda for the current week}{C-c a a$^2$}
532 \key{compile global TODO list}{C-c a t$^2$}
533 \key{compile TODO list for specific keyword}{C-c a T$^2$}
534 \key{match tags in agenda files}{C-c a m$^2$}
535 \key{agenda for date at cursor}{C-c C-o}
536 \key{show timeline of current org file}{C-c C-r}
538 \vskip 1mm
539 To set categories, add lines like$^3$:
540 \vskip -1mm
541 \beginexample%
542 \#+CATEGORY: MyCateg
543 \endexample
545 {\bf Commands available in an agenda buffer}
547 {\bf View Org file}
549 \key{show original location of item}{SPC}
550 \key{... also available with}{mouse-3}
551 \key{show and recenter window}{L}
552 \key{goto original location in other window}{TAB}
553 \key{... also available with}{mouse-2}
554 \key{goto original location, delete other windows}{RET}
555 \key{toggle follow-mode}{f}
557 {\bf Change display}
559 \key{delete other windows}{o}
560 \key{switch to daily / weekly view}{d / w}
561 \key{toggle inclusion of diary entries}{D}
562 \key{toggle time grid for daily schedule}{g}
563 \key{toggle display of logbook entries}{l}
564 \key{refresh agenda buffer with any changes}{r}
565 \key{display the following \kbd{org-agenda-ndays}}{RIGHT}
566 \key{display the previous \kbd{org-agenda-ndays}}{LEFT}
567 \key{goto today}{.}
569 {\bf Remote editing}
571 \key{digit argument}{0-9}
572 \key{change state of current TODO item}{t}
573 \key{set tags for current headline}{:}
574 \key{set priority of current item}{p}
575 \key{raise priority of current item}{S-UP$^4$}
576 \key{lower priority of current item}{S-DOWN$^4$}
577 \key{display weighted priority of current item}{P}
578 \key{change timestamp to one day earlier}{S-LEFT$^4$}
579 \key{change timestamp to one day later}{S-RIGHT$^4$}
580 \key{change timestamp to today}{>}
581 \key{insert new entry into diary}{i}
583 {\bf Calendar commands}
585 \key{find agenda cursor date in calendar}{c}
586 \key{compute agenda for calendar cursor date}{c}
587 \key{show phases of the moon}{M}
588 \key{show sunrise/sunset times}{S}
589 \key{show holidays}{H}
590 \key{convert date to other calendars}{C}
592 {\bf Quit and Exit}
594 \key{quit agenda, remove agenda buffer}{q}
595 \key{exit agenda, remove all agenda buffers}{x}
597 \section{Exporting}
599 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
600 in the current directory.
602 \key{export as ASCII file}{C-c C-x a}
603 \key{export visible text only (e.g. for printing)}{C-c C-x v}
604 \key{export as HTML file}{C-c C-x h}
605 \key{export as HTML and open in browser}{C-c C-x b}
606 \key{prefix arg sets nb. of headline levels, e.g.}{C-3 C-c C-x h}
608 \key{export as iCalendar file}{C-c C-x i}
609 \key{export all agenda files as iCalendar files}{C-c C-x C-i}
610 \key{combine all agenda files to single iCal file}{C-c C-x C-c}
612 \key{insert template of export options}{C-c C-x t}
614 \key{toggle fixed width for entry or region}{C-c :}
616 {\bf HTML formatting}
618 \key{make words {\bf bold}}{*bold*}
619 \key{make words {\it italic}}{/italic/}
620 \key{make words \underbar{underlined}}{_underlined_}
621 \key{sub- and superscripts}{x\^{}3, J_dust}
622 \key{\TeX{}-like macros}{\\alpha, \\to}
623 \key{typeset lines in fixed width font}{start with :}
624 \key{tables are exported as HTML tables}{start with |}
625 \key{links become HTML links}{http:... etc}
626 \key{include html tags}{@<b>...@</b>}
628 {\bf Export options}
630 Include additional information for export by putting these anywhere in the
631 org file. Use {\tt M-TAB} completion to make sure to get the right
632 keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
634 \key{the title to be shown}{\#+TITLE:}
635 \key{the author}{\#+AUTHOR:}
636 \key{authors email address}{\#+EMAIL:}
637 \key{language code for html}{\#+LANGUAGE:}
638 \key{free text description of file}{\#+TEXT:}
639 \key{... which can carry over multiple lines}{\#+TEXT:}
640 \key{settings for the export process - see below}{\#+OPTIONS:}
642 {\bf Settings for the OPTIONS line}
644 \key{set number of headline levels for export}{H:2}
645 \key{turn on/off section numbers}{num:t}
646 \key{turn on/off table of contents}{toc:t}
647 \key{turn on/off linebreak preservation}{\\n:nil}
648 \key{turn on/off quoted html tags}{@:t}
649 \key{turn on/off fixed width sections}{::t}
650 \key{turn on/off tables}{|:t}
651 \key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
652 \key{turn on/off emphasised text}{*:nil}
653 \key{turn on/off \TeX\ macros}{TeX:t}
655 {\bf Comments: Text not being exported}
657 Text before the first headline is not considered part of the document
658 and is therefore never exported.
659 Lines starting with \kbd{\#} are comments and are not exported.
660 Subtrees whose header starts with COMMENT are never exported.
662 \key{toggle COMMENT keyword on entry}{C-c ;}
664 \section{Completion}
666 In-buffer completion completes TODO keywords at headline start, TeX
667 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS
668 after ``{\tt :}'', and dictionary words elsewhere.
670 \key{Complete word at point}{M-TAB}
672 \newcolumn
674 \section{Calendar and Diary Integration}
676 To include entries from the Emacs diary in your Org-mode agenda:
677 \beginexample%
678 (setq org-agenda-include-diary t)
679 \endexample
681 To include the Org-mode agenda in the normal diary, make sure you're
682 using the fancy diary display
684 %\beginexample%
685 %(add-hook 'diary-display-hook 'fancy-diary-display)
686 %\endexample
688 and in the \kbd{~/diary} file add
690 \beginexample%
691 \&\%\%(org-diary)
692 \endexample
694 to include all the files listed in \kbd{org-agenda-files}. For more
695 selective file inclusion use a line for each file:
697 \beginexample%
698 \&\%\%(org-diary) ~/path/to/some/org-file.org
699 \endexample
701 \section{Remember-mode Integration}
703 See the manual for how to make remember.el use Org-mode links and
704 files. The note-finishing command \kbd{C-c C-c} will first prompt for
705 an org file. In the file, find a location with:
707 \key{rotate subtree visibility}{TAB}
708 \key{next heading}{DOWN}
709 \key{previous heading}{UP}
711 Insert the note with one of the following:
713 \key{as sublevel of heading at cursor}{RET}
714 \key{right here (cursor not on heading)}{RET}
715 \key{before current heading}{LEFT}
716 \key{after current heading}{RIGHT}
717 \key{shortcut to end of buffer (cursor at buf-start)}{RET}
718 \key{Abort}{q}
720 \section{CUA and pc-select compatibility}
722 Configure the variable {\tt org-CUA-compatibility} to make Org-mode
723 avoid the \kbd{S-<cursor>} bindings used by these modes. When set,
724 Org-mode will change the following keybindings (also in the agenda
725 buffer, but not during date selection). See note mark four$^4$
726 throughout the reference card.
727 %\vskip-mm
728 \beginexample
729 S-UP $\to$ M-p S-DOWN $\to$ M-n
730 S-LEFT $\to$ M-- S-RIGHT $\to$ M-+
731 S-RET $\to$ C-S-RET
732 \endexample
734 \section{Notes}
735 $^1$ The six autoload forms are only needed if Org-mode is not part of
736 Emacs, or an XEmacs package.
738 $^2$ This is only a suggestion for a binding of this command. Choose
739 you own key as shown under INSTALLATION.
741 $^3$ After changing a \kbd{\#+KEYWORD} line, press \kbd{C-c C-c} with
742 the cursor still in a line to make Org-mode notice the change.
744 $^4$ Keybinding affected by {\tt org-CUA-compatibility}.
746 \copyrightnotice
748 \bye
751 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290
753 %%% Local Variables:
754 %%% mode: latex
755 %%% TeX-master: t
756 %%% End: