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