1 % Reference Card for Org Mode 4.06
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
21 % Copyright (c) 2004 Philip Rooke, 2005, 2006 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)
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:
43 % produces six separate pages, each of which needs to be reduced to 80%.
44 % This gives the best resolution.
46 % produces three already-reduced pages.
47 % You will still need to cut and paste.
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.
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.06}
64 \def\shortcopyrightnotice{\vskip 1ex plus
2 fill
65 \centerline{\small \copyright\
2004,
2005,
2006\ Free Software Foundation, Inc.
66 Permissions on back. v
\orgversionnumber}}
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.
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
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
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
112 % FIXME - Try to make things more A4 friendly
118 \font\titlefont=cmbx10
\scaledmag2
119 \font\headingfont=cmbx10
\scaledmag1
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
145 \footline{\hss\rm\folio\hss}
146 \def\makefootline{\vskip 2in
\hsize=
6.86in
\line{\the\footline}}
151 \errhelp{You must set
\columnsperpage equal to
1,
2, or
3.
}
152 \errmessage{Illegal number of columns per page
}
155 \intercolumnskip=
.46in
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
}
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{}
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
179 % we won't be using math mode much, so redefine some of the characters
180 % we might want to talk about
184 % we also need the tilde, for file names.
191 \hyphenation{mini-buf-fer
}
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
}
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
}
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}}
246 \setbox\metaxbox\hbox{\kbd{M-x
}}
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
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}
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$
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$
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}
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$:
327 \#+ARCHIVE: archfile::* Archived Tasks
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}
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
}
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 \key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE
}}{\rm todo workflow
}
359 \key{\kbd{\#+TYP_TODO: Phil home work DONE
}}{\rm todo types
}
363 \key{prompt for date and insert timestamp
}{C-c .
}
364 \key{like
\kbd{C-c
} . but insert date and time format
}{C-u C-c .
}
365 \key{Like
\kbd{C-c .
} but make stamp inactive
}{C-c !
} % FIXME
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
}
370 \key{change timestamp at cursor by $-
1$ day
}{S-LEFT$^
4$
}
371 \key{change timestamp at cursor by $+
1$ day
}{S-RIGHT$^
4$
}
372 \key{change year/month/day at cursor by $-
1$
}{S-DOWN$^
4$
}
373 \key{change year/month/day at cursor by $+
1$
}{S-UP$^
4$
}
374 \key{access the calendar for the current date
}{C-c >
}
375 \key{insert timestamp matching date in calendar
}{C-c <
}
376 \key{access agenda for current date
}{C-c C-o
}
377 \key{Select date while prompted
}{mouse-
1/RET
}
378 %\key{... select date in calendar}{mouse-1/RET}
379 %\key{... scroll calendar back/forward one month}{< / >}
380 %\key{... forward/backward one day}{S-LEFT/RIGHT}
381 %\key{... forward/backward one week}{S-UP/DOWN}
382 %\key{... forward/backward one month}{M-S-LEFT/RIGT}
386 \key{globally store link to the current location
}{C-c l$^
2$
}
387 \key{insert a link (TAB completes stored links)
}{C-c C-l
}
388 \key{insert file link with file name completion
}{C-u C-c C-l
}
390 \key{open file links in emacs (
\kbd{C-u
} : in emacs)
}{C-c C-o
}
391 \key{open link at point (
3: in emacs)
}{mouse-
2/
3}
392 %\key{open file links in emacs}{mouse-3}
393 \key{record a position in mark ring
}{C-c \%
}
394 \key{jump back to last followed link(s)
}{C-c \&
}
398 \key{\kbd{<<My Target>>
}}{\rm target
}
399 \key{\kbd{<<<My Target>>>
}}{\rm radio target$^
3$
}
400 \key{\kbd{[[*this text
]]}}{\rm find headline
}
401 \metax{\kbd{[[this text
]]}}{\rm find target or text in buffer
}
405 \key{\kbd{<file:/home/dominik/img/mars.jpg>
}}{\rm file, absolute
}
406 \key{\kbd{<file:papers/last.pdf>
}}{\rm file, relative
}
407 \key{\kbd{<file:projects.org::*that text>
}}{\rm find headline
}
408 \key{\kbd{<file:projects.org::find me>
}}{\rm find tgt/string
}
409 \key{\kbd{<file:projects.org::/regexp/>
}}{\rm regexp search
}
410 \key{\kbd{<http://www.astro.uva.nl/~dominik>
}}{\rm on the web
}
411 \key{\kbd{<mailto:adent@galaxy.net>
}}{\rm EMail address
}
412 \key{\kbd{<news:comp.emacs>
}}{\rm Usenet group
}
413 \key{\kbd{<bbdb:Richard Stallman>
}}{\rm BBDB person
}
414 \key{\kbd{<shell:ls *.org>
}}{\rm shell command
}
415 \key{\kbd{<gnus:group>
}}{\rm GNUS group
}
416 \key{\kbd{<gnus:group\#id>
}}{\rm GNUS message
}
417 \key{\kbd{<vm|wl|mhe|rmail:folder>
}}{\rm Mail folder
}
418 \key{\kbd{<vm|wl|mhe|rmail:folder\#id>
}}{\rm Mail message
}
419 %\key{\kbd{<vm://myself@some.where.org/folder\#id>}}{\rm VM remote}
423 %Org-mode has its own built-in intuitive table editor with unique
426 {\bf Creating a table
}
428 \metax{insert a new Org-mode table
}{M-x org-table-create
}
429 \metax{... or just start typing, e.g.
}{|Name|Phone|Age RET |- TAB
}
430 \key{convert region to table
}{C-c C-c
}
431 \key{... separator at least
3 spaces
}{C-
3 C-c C-c
}
432 %\key{... prompt for separator regexp}{C-u C-c C-c}
434 {\bf Commands available inside tables
}
436 The following commands work when the cursor is
{\it inside a table
}.
437 Outside of tables, the same keys may have other functionality.
439 {\bf Re-aligning and field motion
}
441 \key{re-align the table without moving the cursor
}{C-c C-c
}
442 \key{re-align the table, move to next field
}{TAB
}
443 \key{move to previous field
}{S-TAB
}
444 \key{re-align the table, move to next row
}{RET
}
446 {\bf Row and column editing
}
448 \key{move the current column left
}{M-LEFT
}
449 \key{move the current column right
}{M-RIGHT
}
450 \key{kill the current column
}{M-S-LEFT
}
451 \key{insert new column to left of cursor position
}{M-S-RIGHT
}
453 \key{move the current row up
}{M-UP
}
454 \key{move the current row down
}{M-DOWN
}
455 \key{kill the current row or horizontal line
}{M-S-UP
}
456 \key{insert new row above the current row
}{M-S-DOWN
}
457 \key{insert horizontal line below the current row
}{C-c -
}
458 \key{insert horizontal line above the current row
}{C-u C-c -
}
459 \key{sort lines in region
}{C-c \^
{}}
463 \key{cut rectangular region
}{C-c C-x C-w
}
464 \key{copy rectangular region
}{C-c C-x M-w
}
465 \key{paste rectangular region
}{C-c C-x C-y
}
466 \key{fill paragraph across selected cells
}{C-c C-q
}
470 These need the Emacs calc package installed.
472 \key{set and eval column formula
}{C-c =
}
473 \key{set and eval named-field formula
}{C-u C-c =
}
474 \key{edit formulas in separate buffer
}{C-c '
}
475 \key{re-apply all stored equations to current line
}{C-c *
}
476 \key{re-apply all stored equations to entire table
}{C-u C-c *
}
478 \kbd{TAB
},
\kbd{RET
} and
\kbd{C-c C-c
} trigger automatic recalculation
479 in lines starting with:
{\tt | \# |
}.
481 \key{rotate calculation mark through \# * ! \^
\_ \$
}{C-\#
}
483 \key{display column number cursor is in
}{C-c ?
}
484 \key{sum numbers in current column/rectangle
}{C-c +
}
485 \key{copy down with increment
}{S-RET$^
4$
}
487 A formula can also be typed directly into into a field and will
488 executed by
\kbd{TAB
},
\kbd{RET
} and
\kbd{C-c C-c
}. A leading
\kbd{=
}
489 introduces a column formula,
\kbd{:=
} a named-field formula.
491 \key{Example: Add Col1 and Col2
}{=\$
1+\$
2}
492 \key{... with printf format specification
}{=\$
1+\$
2;\%
.2f
}
493 \key{... with constants from constants.el
}{=\$
1/\$c/\$cm
}
494 \key{sum from
3rd hline above to here
}{:=vsum(\&III)
}
495 \key{apply current column formula
}{=
}
499 \key{toggle visibility of vertical lines
}{C-c |
}
500 \metax{export as tab-separated file
}{M-x org-table-export
}
501 \metax{import tab-separated file
}{M-x org-table-import
}
503 {\bf Tables created with the
\kbd{table.el
} package
}
505 \key{insert a new
\kbd{table.el
} table
}{C-c ~
}
506 \key{recognize existing table.el table
}{C-c C-c
}
507 \key{convert table (Org-mode $
\leftrightarrow$ table.el)
}{C-c ~
}
510 \title{Org-Mode Reference Card (
2/
2)
}
512 \centerline{(for version
\orgversionnumber)
}
514 \section{Agenda Views
}
516 \key{add/move current file to front of agenda
}{C-c
[}
517 \key{remove current file from your agenda
}{C-c
]}
518 \key{cycle through agenda file list
}{C-,
}
520 \key{compile agenda for the current week
}{C-c a a$^
2$
}
521 \key{compile global TODO list
}{C-c a t$^
2$
}
522 \key{compile TODO list for specific keyword
}{C-c a T$^
2$
}
523 \key{match tags in agenda files
}{C-c a m$^
2$
}
524 \key{agenda for date at cursor
}{C-c C-o
}
525 \key{show timeline of current org file
}{C-c C-r
}
528 To set categories, add lines like$^
3$:
534 {\bf Commands available in an agenda buffer
}
538 \key{show original location of item
}{SPC
}
539 \key{... also available with
}{mouse-
3}
540 \key{show and recenter window
}{L
}
541 \key{goto original location in other window
}{TAB
}
542 \key{... also available with
}{mouse-
2}
543 \key{goto original location, delete other windows
}{RET
}
544 \key{toggle follow-mode
}{f
}
548 \key{delete other windows
}{o
}
549 \key{switch to daily / weekly view
}{d / w
}
550 \key{toggle inclusion of diary entries
}{D
}
551 \key{toggle time grid for daily schedule
}{g
}
552 \key{toggle display of logbook entries
}{l
}
553 \key{refresh agenda buffer with any changes
}{r
}
554 \key{display the following
\kbd{org-agenda-ndays
}}{RIGHT
}
555 \key{display the previous
\kbd{org-agenda-ndays
}}{LEFT
}
560 \key{digit argument
}{0-
9}
561 \key{change state of current TODO item
}{t
}
562 \key{show tags of current headline
}{T
}
563 \key{set tags for current headline
}{:
}
564 \key{set priority of current item
}{p
}
565 \key{raise/lower priority of current item
}{S-UP/DOWN$^
4$
}
566 %\key{lower priority of current item}{S-DOWN$^4$}
567 \key{display weighted priority of current item
}{P
}
568 \key{change timestamp to one day earlier/later
}{S-LEFT/RIGHT$^
4$
}
569 %\key{change timestamp to one day earlier}{S-LEFT$^4$}
570 %\key{change timestamp to one day later}{S-RIGHT$^4$}
571 \key{change timestamp to today
}{>
}
572 \key{insert new entry into diary
}{i
}
574 {\bf Calendar commands
}
576 \key{find agenda cursor date in calendar
}{c
}
577 \key{compute agenda for calendar cursor date
}{c
}
578 \key{show phases of the moon
}{M
}
579 \key{show sunrise/sunset times
}{S
}
580 \key{show holidays
}{H
}
581 \key{convert date to other calendars
}{C
}
585 \key{quit agenda, remove agenda buffer
}{q
}
586 \key{exit agenda, remove all agenda buffers
}{x
}
590 Exporting creates files with extensions
{\it .txt\/
} and
{\it .html\/
}
591 in the current directory.
593 \key{export as ASCII file
}{C-c C-x a
}
594 \key{export visible text only (e.g. for printing)
}{C-c C-x v
}
595 \key{export as HTML file
}{C-c C-x h
}
596 \key{export as HTML and open in browser
}{C-c C-x b
}
597 \key{prefix arg sets nb. of headline levels, e.g.
}{C-
3 C-c C-x h
}
599 \key{export as iCalendar file
}{C-c C-x i
}
600 \key{export all agenda files as iCalendar files
}{C-c C-x C-i
}
601 \key{combine all agenda files to single iCal file
}{C-c C-x C-c
}
603 \key{insert template of export options
}{C-c C-x t
}
605 \key{toggle fixed width for entry or region
}{C-c :
}
607 {\bf HTML formatting
}
609 \key{make words
{\bf bold
}}{*bold*
}
610 \key{make words
{\it italic
}}{/italic/
}
611 \key{make words
\underbar{underlined
}}{_underlined_
}
612 \key{sub- and superscripts
}{x\^
{}3, J_dust
}
613 \key{\TeX{}-like macros
}{\
\alpha, \
\to}
614 \key{typeset lines in fixed width font
}{start with :
}
615 \key{tables are exported as HTML tables
}{start with |
}
616 \key{links become HTML links
}{http:... etc
}
617 \key{include html tags
}{@<b>...@</b>
}
621 Include additional information for export by putting these anywhere in the
622 org file. Use
{\tt M-TAB
} completion to make sure to get the right
623 keywords.
{\tt M-TAB
} again just after keyword is complete inserts examples.
625 \key{the title to be shown
}{\#+TITLE:
}
626 \key{the author
}{\#+AUTHOR:
}
627 \key{authors email address
}{\#+EMAIL:
}
628 \key{language code for html
}{\#+LANGUAGE:
}
629 \key{free text description of file
}{\#+TEXT:
}
630 \key{... which can carry over multiple lines
}{\#+TEXT:
}
631 \key{settings for the export process - see below
}{\#+OPTIONS:
}
633 {\bf Settings for the OPTIONS line
}
635 \key{set number of headline levels for export
}{H:
2}
636 \key{turn on/off section numbers
}{num:t
}
637 \key{turn on/off table of contents
}{toc:t
}
638 \key{turn on/off linebreak preservation
}{\
\n:nil
}
639 \key{turn on/off quoted html tags
}{@:t
}
640 \key{turn on/off fixed width sections
}{::t
}
641 \key{turn on/off tables
}{|:t
}
642 \key{turn on/off
\TeX\ syntax for sub/super-scripts
}{\^
{}:t
}
643 \key{turn on/off emphasised text
}{*:nil
}
644 \key{turn on/off
\TeX\ macros
}{TeX:t
}
646 {\bf Comments: Text not being exported
}
648 Text before the first headline is not considered part of the
document
649 and is therefore never exported.
650 Lines starting with
\kbd{\#
} are comments and are not exported.
651 Subtrees whose header starts with COMMENT are never exported.
653 \key{toggle COMMENT keyword on entry
}{C-c ;
}
657 In-buffer completion completes TODO keywords at headline start, TeX
658 macros after ``
{\tt \\
}'', option keywords after ``
{\tt \#-
}'', TAGS
659 after ``
{\tt :
}'', and dictionary words elsewhere.
661 \key{Complete word at point
}{M-TAB
}
665 \section{Calendar and Diary Integration
}
667 To include entries from the Emacs diary in your Org-mode agenda:
669 (setq org-agenda-include-diary t)
672 To include the Org-mode agenda in the normal diary, make sure you're
673 using the fancy diary display
676 %(add-hook 'diary-display-hook 'fancy-diary-display)
679 and in the
\kbd{~/diary
} file add
685 to include all the files listed in
\kbd{org-agenda-files
}. For more
686 selective file inclusion use a line for each file:
689 \&\%\%(org-diary) ~/path/to/some/org-file.org
692 \section{Remember-mode Integration
}
694 See the manual for how to make remember.el use Org-mode links and
695 files. The note-finishing command
\kbd{C-c C-c
} will first prompt for
696 an org file. In the file, find a location with:
698 \key{rotate subtree visibility
}{TAB
}
699 \key{next heading
}{DOWN
}
700 \key{previous heading
}{UP
}
702 Insert the note with one of the following:
704 \key{as sublevel of heading at cursor
}{RET
}
705 \key{right here (cursor not on heading)
}{RET
}
706 \key{before current heading
}{LEFT
}
707 \key{after current heading
}{RIGHT
}
708 \key{shortcut to end of buffer (cursor at buf-start)
}{RET
}
711 \section{CUA and pc-select compatibility
}
713 Configure the variable
{\tt org-CUA-compatibility
} to make Org-mode
714 avoid the
\kbd{S-<cursor>
} bindings used by these modes. When set,
715 Org-mode will change the following keybindings (also in the agenda
716 buffer, but not during date selection). See note mark four$^
4$
717 throughout the reference card.
720 S-UP $
\to$ M-p S-DOWN $
\to$ M-n
721 S-LEFT $
\to$ M-- S-RIGHT $
\to$ M-+
726 $^
1$ The six autoload forms are only needed if Org-mode is not part of
727 Emacs, or an XEmacs package.
729 $^
2$ This is only a suggestion for a binding of this command. Choose
730 you own key as shown under INSTALLATION.
732 $^
3$ After changing a
\kbd{\#+KEYWORD
} or
\kbd{<<<target>>>
} line,
733 press
\kbd{C-c C-c
} with the cursor still in the line to update.
735 $^
4$ Keybinding affected by
{\tt org-CUA-compatibility
}.
742 % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290