(mouse-highlight-priority, x-lost-selection-functions, zmacs-regions):
[emacs.git] / etc / orgcard.tex
blob22a85c7f8d4c2a849b0c8368e1111ac0f6f6fe60
1 % Reference Card for Org Mode 3.14
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 most of 2 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
22 % Coypright (C) 2005 Free Software Foundation, Inc.
24 % GNU Emacs is free software; you can redistribute it and/or modify
25 % it under the terms of the GNU General Public License as published by
26 % the Free Software Foundation; either version 2, or (at your option)
27 % any later version.
29 % GNU Emacs is distributed in the hope that it will be useful,
30 % but WITHOUT ANY WARRANTY; without even the implied warranty of
31 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 % GNU General Public License for more details.
34 % You should have received a copy of the GNU General Public License
35 % along with GNU Emacs; see the file COPYING. If not, write to
36 % the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
37 % Boston, MA 02111-1307, USA.
39 % This file is intended to be processed by plain TeX (TeX82).
41 % The final reference card has six columns, three on each side.
42 % This file can be used to produce it in any of three ways:
43 % 1 column per page
44 % produces six separate pages, each of which needs to be reduced to 80%.
45 % This gives the best resolution.
46 % 2 columns per page
47 % produces three already-reduced pages.
48 % You will still need to cut and paste.
49 % 3 columns per page
50 % produces two pages which must be printed sideways to make a
51 % ready-to-use 8.5 x 11 inch reference card.
52 % For this you need a dvi device driver that can print sideways.
53 % Which mode to use is controlled by setting \columnsperpage above.
55 % Author:
56 % Stephen Gildea
57 % Internet: gildea@stop.mail-abuse.org
59 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
60 % for their many good ideas.
62 \def\orgversionnumber{3.14}
63 \def\year{2005}
65 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill
66 \centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
67 Permissions on back. v\orgversionnumber}}
69 \def\copyrightnotice{
70 \vskip 1ex plus 100 fill\begingroup\small
71 \centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
72 \centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \year}
73 \centerline{Author: Philip Rooke}
74 \centerline{based on refcard design and format by Stephen Gildea}
76 Permission is granted to make and distribute copies of
77 this card provided the copyright notice and this permission notice
78 are preserved on all copies.
80 \endgroup}
82 % make \bye not \outer so that the \def\bye in the \else clause below
83 % can be scanned without complaint.
84 \def\bye{\par\vfill\supereject\end}
86 \newdimen\intercolumnskip %horizontal space between columns
87 \newbox\columna %boxes to hold columns already built
88 \newbox\columnb
90 \def\ncolumns{\the\columnsperpage}
92 \message{[\ncolumns\space
93 column\if 1\ncolumns\else s\fi\space per page]}
95 \def\scaledmag#1{ scaled \magstep #1}
97 % This multi-way format was designed by Stephen Gildea October 1986.
98 % Note that the 1-column format is fontfamily-independent.
99 \if 1\ncolumns %one-column format uses normal size
100 \hsize 4in
101 \vsize 10in
102 \voffset -.7in
103 \font\titlefont=\fontname\tenbf \scaledmag3
104 \font\headingfont=\fontname\tenbf \scaledmag2
105 \font\smallfont=\fontname\sevenrm
106 \font\smallsy=\fontname\sevensy
108 \footline{\hss\folio}
109 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
110 \else %2 or 3 columns uses prereduced size
111 \hsize 3.2in
113 % FIXME - Try to make things more A4 friendly
114 % \vsize 7.95in
115 \vsize 7.65in
116 % \hoffset -.75in
117 \hoffset -.25in
118 \voffset -.745in
119 \font\titlefont=cmbx10 \scaledmag2
120 \font\headingfont=cmbx10 \scaledmag1
121 \font\smallfont=cmr6
122 \font\smallsy=cmsy6
123 \font\eightrm=cmr8
124 \font\eightbf=cmbx8
125 \font\eightit=cmti8
126 \font\eighttt=cmtt8
127 \font\eightmi=cmmi8
128 \font\eightsy=cmsy8
129 \textfont0=\eightrm
130 \textfont1=\eightmi
131 \textfont2=\eightsy
132 \def\rm{\eightrm}
133 \def\bf{\eightbf}
134 \def\it{\eightit}
135 \def\tt{\eighttt}
137 % FIXME - Try to make things more A4 friendly
138 % \normalbaselineskip=.8\normalbaselineskip
139 \normalbaselineskip=.7\normalbaselineskip
140 \normallineskip=.8\normallineskip
141 \normallineskiplimit=.8\normallineskiplimit
142 \normalbaselines\rm %make definitions take effect
144 \if 2\ncolumns
145 \let\maxcolumn=b
146 \footline{\hss\rm\folio\hss}
147 \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
148 \else \if 3\ncolumns
149 \let\maxcolumn=c
150 \nopagenumbers
151 \else
152 \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
153 \errmessage{Illegal number of columns per page}
154 \fi\fi
156 \intercolumnskip=.46in
157 \def\abc{a}
158 \output={% %see The TeXbook page 257
159 % This next line is useful when designing the layout.
160 %\immediate\write16{Column \folio\abc\space starts with \firstmark}
161 \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
162 \else\if a\abc
163 \global\setbox\columna\columnbox \global\def\abc{b}
164 %% in case we never use \columnb (two-column mode)
165 \global\setbox\columnb\hbox to -\intercolumnskip{}
166 \else
167 \global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
168 \def\multicolumnformat{\shipout\vbox{\makeheadline
169 \hbox{\box\columna\hskip\intercolumnskip
170 \box\columnb\hskip\intercolumnskip\columnbox}
171 \makefootline}\advancepageno}
172 \def\columnbox{\leftline{\pagebody}}
174 \def\bye{\par\vfill\supereject
175 \if a\abc \else\null\vfill\eject\fi
176 \if a\abc \else\null\vfill\eject\fi
177 \end}
180 % we won't be using math mode much, so redefine some of the characters
181 % we might want to talk about
182 %\catcode`\^=12
183 \catcode`\_=12
185 % we also need the tilde, for file names.
186 \catcode`\~=12
188 \chardef\\=`\\
189 \chardef\{=`\{
190 \chardef\}=`\}
192 \hyphenation{mini-buf-fer}
194 \parindent 0pt
195 \parskip 1ex plus .5ex minus .5ex
197 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
199 % newcolumn - force a new column. Use sparingly, probably only for
200 % the first column of a page, which should have a title anyway.
201 \outer\def\newcolumn{\vfill\eject}
203 % title - page title. Argument is title text.
204 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
206 % section - new major section. Argument is section name.
207 \outer\def\section#1{\par\filbreak
208 \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
209 \vskip 2ex plus 1ex minus 1.5ex}
211 \newdimen\keyindent
213 % beginindentedkeys...endindentedkeys - key definitions will be
214 % indented, but running text, typically used as headings to group
215 % definitions, will not.
216 \def\beginindentedkeys{\keyindent=1em}
217 \def\endindentedkeys{\keyindent=0em}
218 \endindentedkeys
220 % paralign - begin paragraph containing an alignment.
221 % If an \halign is entered while in vertical mode, a parskip is never
222 % inserted. Using \paralign instead of \halign solves this problem.
223 \def\paralign{\vskip\parskip\halign}
225 % \<...> - surrounds a variable name in a code example
226 \def\<#1>{{\it #1\/}}
228 % kbd - argument is characters typed literally. Like the Texinfo command.
229 \def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
231 % beginexample...endexample - surrounds literal text, such a code example.
232 % typeset in a typewriter font with line breaks preserved
233 \def\beginexample{\par\leavevmode\begingroup
234 \obeylines\obeyspaces\parskip0pt\tt}
235 {\obeyspaces\global\let =\ }
236 \def\endexample{\endgroup}
238 % key - definition of a key.
239 % \key{description of key}{key-name}
240 % prints the description left-justified, and the key-name in a \kbd
241 % form near the right margin.
242 \def\key#1#2{\leavevmode\hbox to \hsize{\vtop
243 {\hsize=.75\hsize\rightskip=1em
244 \hskip\keyindent\relax#1}\kbd{#2}\hfil}}
246 \newbox\metaxbox
247 \setbox\metaxbox\hbox{\kbd{M-x }}
248 \newdimen\metaxwidth
249 \metaxwidth=\wd\metaxbox
251 % metax - definition of a M-x command.
252 % \metax{description of command}{M-x command-name}
253 % Tries to justify the beginning of the command name at the same place
254 % as \key starts the key name. (The "M-x " sticks out to the left.)
255 \def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
256 {\hskip\keyindent\relax#1\hfil}%
257 \hskip -\metaxwidth minus 1fil
258 \kbd{#2}\hfil}}
260 % threecol - like "key" but with two key names.
261 % for example, one for doing the action backward, and one for forward.
262 \def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
263 &\kbd{#3}\hfil\quad\cr}
265 %**end of header
268 \title{Org-Mode Reference Card (1/2)}
270 \centerline{(for version \orgversionnumber)}
272 \section{Getting Started}
274 Put the following in your \kbd{~/.emacs}$^1$
275 \vskip -1mm
276 \beginexample%
277 (autoload 'org-mode "org" "Org mode" t)
278 (autoload 'org-diary "org" "Org mode diary entries")
279 (autoload 'org-agenda "org" "Agenda from Org files" 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 at same level as current}{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 up}{M-S-UP}
318 \key{move subtree down}{M-S-DOWN}
319 \key{kill subtree}{C-c C-h C-w}
320 \key{copy subtree}{C-c C-h M-w}
321 \key{yank subtree}{C-c C-h 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{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$1$}
337 \key{agenda for date at cursor}{C-c C-o}
339 \section{TODO Items}
341 \key{rotate the state of the current item}{C-c C-t}
342 \key{view TODO items in a sparse tree}{C-c C-v}
344 \key{set the priority of the current item}{C-c , [ABC]}
345 \key{remove priority cookie from current item}{C-c , SPC}
346 \key{raise priority of current item}{S-UP$^4$}
347 \key{lower priority of current item}{S-DOWN$^4$}
349 \vskip 1mm
350 per-file TODO workflow states: add line(s) like$^3$:
351 \vskip -1mm
352 \beginexample%
353 \#+SEQ_TODO: TODO PROCRASTINATE BLUFF DONE
354 \endexample
355 \vskip -1mm
356 per-file TODO keywords: add line(s) like$^3$:
357 \vskip -1mm
358 \beginexample%
359 \#+TYP_TODO: Phil home work DONE
360 \endexample
362 \section{Timestamps}
364 \key{prompt for date and insert timestamp}{C-c .}
365 \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
366 \key{insert DEADLINE timestamp}{C-c C-d}
367 \key{insert SCHEDULED timestamp}{C-c C-s}
368 \key{create sparse tree with all deadlines due}{C-c C-w}
369 \key{the time between 2 dates in a time range}{C-c C-y}
371 \key{change timestamp at cursor by $-1$ day}{S-LEFT$^4$}
372 \key{change timestamp at cursor by $+1$ day}{S-RIGHT$^4$}
373 \key{change year/month/day at cursor by $-1$}{S-DOWN$^4$}
374 \key{change year/month/day at cursor by $+1$}{S-UP$^4$}
376 \key{access the calendar for the current date}{C-c >}
377 \key{insert timestamp matching date in calendar}{C-c <}
378 \key{access agenda for current date}{C-c C-o}
380 \key{While prompted for a date:}{}
381 \key{... select date in calendar}{mouse-1/RET}
382 \key{... scroll calendar back/forward one month}{< / >}
383 \key{... forward/backward one day}{S-LEFT/RIGHT}
384 \key{... forward/backward one week}{S-UP/DOWN}
385 \key{... forward/backward one month}{M-S-LEFT/RIGT}
387 \section{Links}
389 \key{globally store link to the current location}{C-c l$^2$}
390 \key{insert a link (TAB completes stored links)}{C-c C-l}
391 \key{insert file link with file name completion}{C-u C-c C-l}
393 \key{open link at point}{C-c C-o}
394 \key{open file links in emacs}{C-u C-c C-o}
395 \key{open link at point}{mouse-2}
396 \key{open file links in emacs}{mouse-3}
398 {\bf Link types}
400 \key{\kbd{<http://www.astro.uva.nl/~dominik>}}{\rm on the web}
401 \key{\kbd{<mailto:adent@galaxy.net>}}{\rm EMail address}
402 \key{\kbd{<news:comp.emacs>}}{\rm Usenet group}
403 \key{\kbd{<file:/home/dominik/img/mars.jpg>}}{\rm file, absolute}
404 \key{\kbd{<file:papers/last.pdf>}}{\rm file, relative}
405 \key{\kbd{<file:~/code/main.c:255>}}{\rm file with line nr.}
406 \key{\kbd{<bbdb:Richard Stallman>}}{\rm BBDB person}
407 \key{\kbd{<shell:ls *.org>}}{\rm shell command}
408 \key{\kbd{<gnus:group>}}{\rm GNUS group}
409 \key{\kbd{<gnus:group\#id>}}{\rm GNUS message}
410 \key{\kbd{<vm:folder>}}{\rm VM folder}
411 \key{\kbd{<vm:folder\#id>}}{\rm VM message}
412 \key{\kbd{<vm://myself@some.where.org/folder\#id>}}{\rm VM remote}
413 Wanderlust \kbd{<wl:...>} and RMAIL \kbd{<rmail:...>} like VM
414 %\key{\kbd{<wl:folder>}}{\rm Wanderlust f.}
415 %\key{\kbd{<wl:folder\#id>}}{\rm Wanderlust m.}
416 %\key{\kbd{<rmail:folder>}}{\rm RMAIL folder}
417 %\key{\kbd{<rmail:folder\#id>}}{\rm RMAIL msg}
419 \section{Tables}
421 %Org-mode has its own built-in intuitive table editor with unique
422 %capabilities.
424 {\bf Creating a table}
426 \metax{insert a new Org-mode table}{M-x org-table-create}
427 \metax{... or just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
428 \key{convert region to table}{C-c C-c}
429 \key{... separator at least 3 spaces}{C-3 C-c C-c}
430 %\key{... prompt for separator regexp}{C-u C-c C-c}
432 {\bf Commands available inside tables}
434 The following commands work when the cursor is {\it inside a table}.
435 Outside of tables, the same keys may have other functionality.
437 {\bf Re-aligning and field motion}
439 \key{re-align the table without moving the cursor}{C-c C-c}
440 \key{re-align the table, move to next field}{TAB}
441 \key{move to previous field}{S-TAB}
442 \key{re-align the table, move to next row}{RET}
444 {\bf Row and column editing}
446 \key{move the current column left}{M-LEFT}
447 \key{move the current column right}{M-RIGHT}
448 \key{kill the current column}{M-S-LEFT}
449 \key{insert new column to left of cursor position}{M-S-RIGHT}
451 \key{move the current row up}{M-UP}
452 \key{move the current row down}{M-DOWN}
453 \key{kill the current row or horizontal line}{M-S-UP}
454 \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 -}
459 {\bf Regions}
461 \key{cut rectangular region}{C-c C-h C-w}
462 \key{copy rectangular region}{C-c C-h M-w}
463 \key{paste rectangular region}{C-c C-h C-y}
464 \key{fill paragraph across selected cells}{C-c C-q}
466 {\bf Calculations}
468 Except for the summation commands, these need the Emacs calc package
469 installed.
471 \key{set and eval column formula}{C-c =}
472 \key{set and eval named-field formula}{C-u C-c =}
473 \key{edit formulas in separate buffer}{C-c '}
474 \key{re-apply all stored equations to current line}{C-c *}
475 \key{re-apply all stored equations to entire table}{C-u C-c *}
477 \kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
478 in lines starting with: {\tt | \# |}.
480 \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
482 \key{display column number cursor is in}{C-c ?}
483 \key{sum numbers in current column/rectangle}{C-c +}
484 \key{copy down with increment}{S-RET$^4$}
486 A formula can also be typed directly into into a field and will
487 executed by \kbd{TAB}, \kbd{RET} and \kbd{C-c C-c}. A leading \kbd{=}
488 introduces a column formula, \kbd{:=} a named-field formula.
490 \key{Example: Add Col1 and Col2}{=\$1+\$2}
491 \key{... with printf format specification}{=\$1+\$2;\%.2f}
492 \key{... with constants from constants.el}{=\$1/\$c/\$cm}
493 \key{sum from 3rd hline above to here}{:=vsum(\&III)}
494 \key{apply current column formula}{=}
496 {\bf Miscellaneous}
498 \key{toggle visibility of vertical lines}{C-c |}
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{Timeline and Agenda}
515 \key{show timeline of current org file}{C-c C-r}
516 \key{... include past dates}{C-u C-c C-r}
518 \key{add current file to your agenda}{C-c [}
519 \key{remove current file from your agenda}{C-c ]}
520 \key{compile agenda for the current week}{C-c a$^2$}
521 \key{agenda for date at cursor}{C-c C-o}
522 \vskip 1mm
523 To set category for current file, add line$^3$:
524 \vskip -1mm
525 \beginexample%
526 \#+CATEGORY: MyCateg
527 \endexample
529 {\bf Commands available in an agenda buffer}
531 The agenda buffer is electric: single key presses execute commands.
533 {\bf View org file}
535 \key{show original location of item}{SPC}
536 \key{... also available with}{mouse-3}
537 \key{show and recenter window}{l}
538 \key{goto original location in other window}{TAB}
539 \key{... also available with}{mouse-2}
540 \key{goto original location, delete other windows}{RET}
541 \key{toggle follow-mode}{f}
543 {\bf Change display}
545 \key{delete other windows}{o}
546 \key{switch to weekly view}{w}
547 \key{switch to daily view}{d}
548 \key{toggle inclusion of diary entries}{D}
549 \key{toggle time grid for daily schedule}{g}
550 \key{refresh agenda buffer with any changes}{r}
551 \key{display the following \kbd{org-agenda-ndays}}{RIGHT}
552 \key{display the previous \kbd{org-agenda-ndays}}{LEFT}
553 \key{goto today}{.}
555 {\bf Remote editing}
557 \key{digit argument}{0-9}
559 \key{change state of current TODO item}{t}
560 \key{set priority of current item}{p}
561 \key{raise priority of current item}{S-UP$^4$}
562 \key{lower priority of current item}{S-DOWN$^4$}
563 \key{display weighted priority of current item}{P}
565 \key{change timestamp to one day earlier}{S-LEFT$^4$}
566 \key{change timestamp to one day later}{S-RIGHT$^4$}
567 \key{change timestamp to today}{>}
569 \key{insert new entry into diary}{i}
571 {\bf Calendar commands}
573 \key{find agenda cursor date in calendar}{c}
574 \key{compute agenda for calendar cursor date}{c}
575 \key{show phases of the moon}{M}
576 \key{show sunrise/sunset times}{S}
577 \key{show holidays}{H}
578 \key{convert date to other calendars}{C}
580 {\bf Quit and Exit}
582 \key{quit agenda, remove agenda buffer}{q}
583 \key{exit agenda, remove all agenda buffers}{x}
585 \section{Exporting}
587 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
588 in the current directory.
590 \key{export as ASCII file}{C-c C-x a}
591 \key{export visible text only (e.g. for printing)}{C-c C-x v}
592 \key{export as HTML file}{C-c C-x h}
593 \key{export as HTML and open in browser}{C-c C-x C-h}
594 \key{prefix arg sets nb. of headline levels, e.g.}{C-3 C-c C-x h}
596 \key{insert template of export options}{C-c C-x t}
598 \key{toggle fixed width for line or region}{C-c :}
600 {\bf HTML formatting}
602 \key{make words {\bf bold}}{*bold*}
603 \key{make words {\it italic}}{/italic/}
604 \key{make words \underbar{underlined}}{_underlined_}
605 \key{sub- and superscripts}{x\^{}3, J_dust}
606 \key{\TeX{}-like macros}{\\alpha, \\to}
607 \key{typeset lines in fixed width font}{start with :}
608 \key{tables are exported as HTML tables}{start with |}
609 \key{links become HTML links}{http:... etc}
610 \key{include html tags}{@<b>...@</b>}
612 {\bf Export options}
614 Include additional information for export by putting these anywhere in the
615 org file. Use {\tt M-TAB} completion to make sure to get the right
616 keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
618 \key{the title to be shown}{\#+TITLE:}
619 \key{the author}{\#+AUTHOR:}
620 \key{authors email address}{\#+EMAIL:}
621 \key{language code for html}{\#+LANGUAGE:}
622 \key{free text description of file}{\#+TEXT:}
623 \key{... which can carry over multiple lines}{\#+TEXT:}
624 \key{settings for the export process - see below}{\#+OPTIONS:}
626 {\bf Settings for the OPTIONS line}
628 \key{set number of headline levels for export}{H:2}
629 \key{turn on/off section numbers}{num:t}
630 \key{turn on/off table of contents}{toc:t}
631 \key{turn on/off linebreak preservation}{\\n:nil}
632 \key{turn on/off quoted html tags}{@:t}
633 \key{turn on/off fixed width sections}{::t}
634 \key{turn on/off tables}{|:t}
635 \key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
636 \key{turn on/off emphasised text}{*:nil}
637 \key{turn on/off \TeX\ macros}{TeX:t}
639 {\bf Comments: Text not being exported}
641 Text before the first headline is not considered part of the document
642 and is therefore never exported.
643 Lines starting with \kbd{\#} are comments and are not exported.
644 Subtrees whose header starts with COMMENT are never exported.
646 \key{toggle COMMENT keyword on entry}{C-c ;}
648 \section{Completion}
650 In-buffer completion completes TODO keywords at headline start, TeX
651 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', and
652 dictionary words elsewhere.
654 \key{Complete word at point}{M-TAB}
656 \newcolumn
658 \section{Calendar and Diary Integration}
660 To include entries from the Emacs diary in your Org-mode agenda:
661 \beginexample%
662 (setq org-agenda-include-diary t)
663 \endexample
665 To include your Org-mode agenda in your normal diary, make sure you're
666 using the fancy diary display
668 %\beginexample%
669 %(add-hook 'diary-display-hook 'fancy-diary-display)
670 %\endexample
672 and in your \kbd{~/diary} file add
674 \beginexample%
675 \&\%\%(org-diary)
676 \endexample
678 to include all the files listed in \kbd{org-agenda-files}. For more
679 selective file inclusion use a line for each file:
681 \beginexample%
682 \&\%\%(org-diary) ~/path/to/some/org-file.org
683 \endexample
685 \section{Remember-mode Integration}
687 See the manual for how to make remember.el use Org-mode links and
688 files. The note-finishing command \kbd{C-c C-c} will first prompt for
689 an org file. In the file, find a location with:
691 \key{rotate subtree visibility}{TAB}
692 \key{next heading}{DOWN}
693 \key{previous heading}{UP}
695 Insert the note with one of the following:
697 \key{as sublevel of heading at cursor}{RET}
698 \key{right here (cursor not on heading)}{RET}
699 \key{before current heading}{LEFT}
700 \key{after current heading}{RIGHT}
701 \key{shortcut to end of buffer (cursor at buf-start)}{RET}
702 \key{Abort}{q}
704 \section{CUA and pc-select compatibility}
706 Configure the variable {\tt org-CUA-compatibility} to make Org-mode
707 avoid the \kbd{S-<cursor>} bindings used by these modes. When set,
708 Org-mode will change the following keybindings (also in the agenda
709 buffer, but not during date selection). See note mark four$^4$
710 throughout the reference card.
711 %\vskip-mm
712 \beginexample
713 S-UP $\to$ M-p S-DOWN $\to$ M-n
714 S-LEFT $\to$ M-- S-RIGHT $\to$ M-+
715 S-RET $\to$ C-S-RET
716 \endexample
718 \section{Notes}
719 $^1$ The six autoload forms are only needed if Org-mode is not part of
720 Emacs, or an XEmacs package.
722 $^2$ This is only a suggestion for a binding of this command. Choose
723 you own key as shown under INSTALLATION.
725 $^3$ After changing a \kbd{\#+KEYWORD} line, press \kbd{C-c C-c} with
726 the cursor still in a line to make Org-mode notice the change.
728 $^4$ Keybinding affected by {\tt org-CUA-compatibility}.
730 \copyrightnotice
732 \bye
734 % Local variables:
735 % compile-command: "tex ord-mode-ref"
736 % TeX-master: t
737 % End:
739 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290