orgcard.tex 25.8 KB
Newer Older
1
% Reference Card for Org Mode
2
\def\orgversionnumber{6.14}
3
\def\versionyear{2008}          % latest update
4
\def\year{2008}                 % latest copyright year
5

6 7
%**start of header
\newcount\columnsperpage
Carsten Dominik's avatar
Carsten Dominik committed
8
\newcount\letterpaper
9 10

% This file can be printed with 1, 2, or 3 columns per page (see below).
Carsten Dominik's avatar
Carsten Dominik committed
11
% Specify how many you want here.
12

Carsten Dominik's avatar
Carsten Dominik committed
13
\columnsperpage=3
14

15
% Set letterpapaer to 0 for A4 paper, 1 for letter (US) paper.  Useful
Carsten Dominik's avatar
Carsten Dominik committed
16
% only when columnsperpage is 2 or 3.
17

Carsten Dominik's avatar
Carsten Dominik committed
18
\letterpaper=0
19

Carsten Dominik's avatar
Carsten Dominik committed
20
% Nothing else needs to be changed below this line.
21 22
% Copyright (C) 1987, 1993, 1996, 1997, 2001, 2002, 2003, 2004, 2005,
%   2006, 2007, 2008  Free Software Foundation, Inc.
Carsten Dominik's avatar
Carsten Dominik committed
23 24

% This file is part of GNU Emacs.
25

26
% GNU Emacs is free software: you can redistribute it and/or modify
27
% it under the terms of the GNU General Public License as published by
28 29
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
30 31 32 33 34 35 36

% GNU Emacs is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.

% You should have received a copy of the GNU General Public License
37
% along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

% This file is intended to be processed by plain TeX (TeX82).
%
% The final reference card has six columns, three on each side.
% This file can be used to produce it in any of three ways:
% 1 column per page
%    produces six separate pages, each of which needs to be reduced to 80%.
%    This gives the best resolution.
% 2 columns per page
%    produces three already-reduced pages.
%    You will still need to cut and paste.
% 3 columns per page
%    produces two pages which must be printed sideways to make a
%    ready-to-use 8.5 x 11 inch reference card.
%    For this you need a dvi device driver that can print sideways.
% Which mode to use is controlled by setting \columnsperpage above.
%
Carsten Dominik's avatar
Carsten Dominik committed
55 56 57 58
% To compile and print this document:
% tex refcard.tex
% dvips -t landscape refcard.dvi
%
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
% Author:
%  Stephen Gildea
%  Internet: gildea@stop.mail-abuse.org
%
% Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
% for their many good ideas.

\def\shortcopyrightnotice{\vskip 1ex plus 2 fill
  \centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
  Permissions on back.  v\orgversionnumber}}

\def\copyrightnotice{
\vskip 1ex plus 100 fill\begingroup\small
\centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
\centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \versionyear}
\centerline{Author: Philip Rooke}
\centerline{based on refcard design and format by Stephen Gildea}

Permission is granted to make and distribute copies of
this card provided the copyright notice and this permission notice
are preserved on all copies.

\endgroup}

% make \bye not \outer so that the \def\bye in the \else clause below
% can be scanned without complaint.
\def\bye{\par\vfill\supereject\end}

Carsten Dominik's avatar
Carsten Dominik committed
87 88
\newdimen\intercolumnskip	%horizontal space between columns
\newbox\columna			%boxes to hold columns already built
89 90 91 92
\newbox\columnb

\def\ncolumns{\the\columnsperpage}

Carsten Dominik's avatar
Carsten Dominik committed
93
\message{[\ncolumns\space
94 95 96 97 98 99
  column\if 1\ncolumns\else s\fi\space per page]}

\def\scaledmag#1{ scaled \magstep #1}

% This multi-way format was designed by Stephen Gildea October 1986.
% Note that the 1-column format is fontfamily-independent.
Carsten Dominik's avatar
Carsten Dominik committed
100
\if 1\ncolumns			%one-column format uses normal size
101 102 103 104 105 106 107 108 109 110
  \hsize 4in
  \vsize 10in
  \voffset -.7in
  \font\titlefont=\fontname\tenbf \scaledmag3
  \font\headingfont=\fontname\tenbf \scaledmag2
  \font\smallfont=\fontname\sevenrm
  \font\smallsy=\fontname\sevensy

  \footline{\hss\folio}
  \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
Carsten Dominik's avatar
Carsten Dominik committed
111 112
\else				%2 or 3 columns uses prereduced size
  \if 1\the\letterpaper
Carsten Dominik's avatar
Carsten Dominik committed
113
     \hsize 3.2in
Carsten Dominik's avatar
Carsten Dominik committed
114
     \vsize 7.95in
Carsten Dominik's avatar
Carsten Dominik committed
115 116
     \hoffset -.75in
     \voffset -.745in
Carsten Dominik's avatar
Carsten Dominik committed
117
  \else
Carsten Dominik's avatar
Carsten Dominik committed
118
     \hsize 3.2in
Carsten Dominik's avatar
Carsten Dominik committed
119
     \vsize 7.65in
Carsten Dominik's avatar
Carsten Dominik committed
120 121
     \hoffset -.25in
     \voffset -.745in
Carsten Dominik's avatar
Carsten Dominik committed
122
  \fi
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
  \font\titlefont=cmbx10 \scaledmag2
  \font\headingfont=cmbx10 \scaledmag1
  \font\smallfont=cmr6
  \font\smallsy=cmsy6
  \font\eightrm=cmr8
  \font\eightbf=cmbx8
  \font\eightit=cmti8
  \font\eighttt=cmtt8
  \font\eightmi=cmmi8
  \font\eightsy=cmsy8
  \textfont0=\eightrm
  \textfont1=\eightmi
  \textfont2=\eightsy
  \def\rm{\eightrm}
  \def\bf{\eightbf}
  \def\it{\eightit}
  \def\tt{\eighttt}
Carsten Dominik's avatar
Carsten Dominik committed
140 141 142 143 144
  \if 1\the\letterpaper
     \normalbaselineskip=.8\normalbaselineskip
  \else
     \normalbaselineskip=.7\normalbaselineskip
  \fi
145 146
  \normallineskip=.8\normallineskip
  \normallineskiplimit=.8\normallineskiplimit
Carsten Dominik's avatar
Carsten Dominik committed
147
  \normalbaselines\rm		%make definitions take effect
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162

  \if 2\ncolumns
    \let\maxcolumn=b
    \footline{\hss\rm\folio\hss}
    \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
  \else \if 3\ncolumns
    \let\maxcolumn=c
    \nopagenumbers
  \else
    \errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
    \errmessage{Illegal number of columns per page}
  \fi\fi

  \intercolumnskip=.46in
  \def\abc{a}
Carsten Dominik's avatar
Carsten Dominik committed
163
  \output={%			%see The TeXbook page 257
164 165 166 167
      % This next line is useful when designing the layout.
      %\immediate\write16{Column \folio\abc\space starts with \firstmark}
      \if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
      \else\if a\abc
Carsten Dominik's avatar
Carsten Dominik committed
168
	\global\setbox\columna\columnbox \global\def\abc{b}
169 170 171
        %% in case we never use \columnb (two-column mode)
        \global\setbox\columnb\hbox to -\intercolumnskip{}
      \else
Carsten Dominik's avatar
Carsten Dominik committed
172
	\global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
173 174 175 176 177 178 179 180 181
  \def\multicolumnformat{\shipout\vbox{\makeheadline
      \hbox{\box\columna\hskip\intercolumnskip
        \box\columnb\hskip\intercolumnskip\columnbox}
      \makefootline}\advancepageno}
  \def\columnbox{\leftline{\pagebody}}

  \def\bye{\par\vfill\supereject
    \if a\abc \else\null\vfill\eject\fi
    \if a\abc \else\null\vfill\eject\fi
Carsten Dominik's avatar
Carsten Dominik committed
182
    \end}
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
\fi

% we won't be using math mode much, so redefine some of the characters
% we might want to talk about
%\catcode`\^=12
\catcode`\_=12

% we also need the tilde, for file names.
\catcode`\~=12

\chardef\\=`\\
\chardef\{=`\{
\chardef\}=`\}

\hyphenation{mini-buf-fer}

\parindent 0pt
\parskip 1ex plus .5ex minus .5ex

\def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}

% newcolumn - force a new column.  Use sparingly, probably only for
% the first column of a page, which should have a title anyway.
\outer\def\newcolumn{\vfill\eject}

% title - page title.  Argument is title text.
\outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}

% section - new major section.  Argument is section name.
\outer\def\section#1{\par\filbreak
  \vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
  \vskip 2ex plus 1ex minus 1.5ex}

\newdimen\keyindent

% beginindentedkeys...endindentedkeys - key definitions will be
% indented, but running text, typically used as headings to group
% definitions, will not.
\def\beginindentedkeys{\keyindent=1em}
\def\endindentedkeys{\keyindent=0em}
\endindentedkeys

% paralign - begin paragraph containing an alignment.
% If an \halign is entered while in vertical mode, a parskip is never
% inserted.  Using \paralign instead of \halign solves this problem.
\def\paralign{\vskip\parskip\halign}

% \<...> - surrounds a variable name in a code example
\def\<#1>{{\it #1\/}}

% kbd - argument is characters typed literally.  Like the Texinfo command.
Carsten Dominik's avatar
Carsten Dominik committed
234
\def\kbd#1{{\tt#1}\null}	%\null so not an abbrev even if period follows
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

% beginexample...endexample - surrounds literal text, such a code example.
% typeset in a typewriter font with line breaks preserved
\def\beginexample{\par\leavevmode\begingroup
  \obeylines\obeyspaces\parskip0pt\tt}
{\obeyspaces\global\let =\ }
\def\endexample{\endgroup}

% key - definition of a key.
% \key{description of key}{key-name}
% prints the description left-justified, and the key-name in a \kbd
% form near the right margin.
\def\key#1#2{\leavevmode\hbox to \hsize{\vtop
  {\hsize=.75\hsize\rightskip=1em
  \hskip\keyindent\relax#1}\kbd{#2}\hfil}}

\newbox\metaxbox
\setbox\metaxbox\hbox{\kbd{M-x }}
\newdimen\metaxwidth
\metaxwidth=\wd\metaxbox

% metax - definition of a M-x command.
% \metax{description of command}{M-x command-name}
% Tries to justify the beginning of the command name at the same place
% as \key starts the key name.  (The "M-x " sticks out to the left.)
\def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
  {\hskip\keyindent\relax#1\hfil}%
  \hskip -\metaxwidth minus 1fil
  \kbd{#2}\hfil}}

% threecol - like "key" but with two key names.
% for example, one for doing the action backward, and one for forward.
\def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
  &\kbd{#3}\hfil\quad\cr}

%**end of header


\title{Org-Mode Reference Card (1/2)}

\centerline{(for version \orgversionnumber)}

\section{Getting Started}
%
\vskip -1mm
\beginexample%
(add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
(define-key global-map "\\C-cl" 'org-store-link)$^1$
(define-key global-map "\\C-ca" 'org-agenda)$^1$
\endexample
%
\metax{For the many customization options try}{M-x org-customize}
\metax{To read the on-line documentation try}{M-x org-info}

\section{Visibility Cycling}

\key{rotate current subtree between states}{TAB}
\key{rotate entire buffer between states}{S-TAB}
293 294
\key{restore property-dependent startup visibility}{C-u C-u TAB}
\metax{show the whole file, including drawers}{C-u C-u C-u TAB}
295 296 297 298 299 300 301 302 303 304 305 306 307
\key{reveal context around point}{C-c C-r}

\section{Motion}

\key{next/previous heading}{C-c C-n/p}
\key{next/previous heading, same level}{C-c C-f/b}
\key{backward to higher level heading}{C-c C-u}
\key{jump to another place in document}{C-c C-j}
\key{previous/next plain list item}{S-UP/DOWN$^3$}

\section{Structure Editing}

\key{insert new heading/item at current level}{M-RET}
308
\key{insert new heading after subtree}{C-RET}
309
\key{insert new TODO entry/checkbox item}{M-S-RET}
310
\key{insert TODO entry/ckbx after subtree}{C-S-RET}
311

312 313
\key{promote/demote heading}{M-LEFT/RIGHT}
\metax{promote/demote current subtree}{M-S-LEFT/RIGHT}
314 315

\key{move subtree/list item up/down}{M-S-UP/DOWN}
316
\key{refile subtree}{C-c C-w}
317 318
\key{kill subtree}{C-c C-x C-w}
\key{copy subtree}{C-c C-x M-w}
319
\metax{yank subtree}{C-c C-x C-y or C-y}
320
\key{narrow buffer to current subtree}{C-x n s}
321
\key{widen restriction to full buffer}{C-x n w}
322 323 324

\section{Archiving}

325
\key{toggle ARCHIVE tag}{C-c C-x a}
326
\key{force cycling of an ARCHIVEd tree}{C-TAB}
327 328
\key{move to Attic Sibling}{C-c C-x A}
%\metax{mark fully done children}{C-u C-c C-x C-a}
329
\key{move subtree to archive file}{C-c C-x C-s}
Carsten Dominik's avatar
Carsten Dominik committed
330 331 332 333 334 335
%\metax{move all fully done children}{C-u C-c C-x C-s}
%To set archive location for current file, add a line like$^2$:
%\vskip -1mm
%\beginexample%
%\#+ARCHIVE: archfile::* Archived Tasks
%\endexample
336 337 338

\section{Filtering and Sparse Trees}

339 340
% FIXME: this is garbage
\key{construct a sparse tree by various criteria}{C-c /}
341
\key{view TODO's in sparse tree}{C-c C-v}
342
\key{global TODO list in agenda mode}{C-c a t$^1$}
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
\key{time sorted view of current org file}{C-c a L}
%\key{agenda for the week}{C-c a$^1$}
%\key{agenda for date at cursor}{C-c C-o}

\section{Tables}

{\bf Creating a table}

%\metax{insert a new Org-mode table}{M-x org-table-create}
\metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
\key{convert region to table}{C-c |}
\key{... separator at least 3 spaces}{C-3 C-c |}

{\bf Commands available inside tables}

The following commands work when the cursor is {\it inside a table}.
Outside of tables, the same keys may have other functionality.

{\bf Re-aligning and field motion}

\key{re-align the table without moving the cursor}{C-c C-c}
\key{re-align the table, move to next field}{TAB}
\key{move to previous field}{S-TAB}
\key{re-align the table, move to next row}{RET}

{\bf Row and column editing}

Carsten Dominik's avatar
Carsten Dominik committed
370
\key{move the current column left}{M-LEFT/RIGHT}
371 372 373
\key{kill the current column}{M-S-LEFT}
\key{insert new column to left of cursor position}{M-S-RIGHT}

Carsten Dominik's avatar
Carsten Dominik committed
374
\key{move the current row up/down}{M-UP/DOWN}
375 376
\key{kill the current row or horizontal line}{M-S-UP}
\key{insert new row above the current row}{M-S-DOWN}
377
\key{insert hline below (\kbd{C-u} : above) current row}{C-c -}
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
\key{sort lines in region}{C-c \^{}}

{\bf Regions}

\key{cut rectangular region}{C-c C-x C-w}
\key{copy rectangular region}{C-c C-x M-w}
\key{paste rectangular region}{C-c C-x C-y}
\key{fill paragraph across selected cells}{C-c C-q}

{\bf Miscellaneous}

\key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
\key{edit the current field in a separate window}{C-c `}
\key{make current field fully visible}{C-u TAB}
\metax{export as tab-separated file}{M-x org-table-export}
\metax{import tab-separated file}{M-x org-table-import}
Carsten Dominik's avatar
Carsten Dominik committed
394
\key{sum numbers in current column/rectangle}{C-c +}
395 396 397 398 399 400 401

{\bf Tables created with the \kbd{table.el} package}

\key{insert a new \kbd{table.el} table}{C-c ~}
\key{recognize existing table.el table}{C-c C-c}
\key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}

Carsten Dominik's avatar
Carsten Dominik committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
{\bf Spreadsheet}

Formulas typed in field are executed by \kbd{TAB},
\kbd{RET} and \kbd{C-c C-c}.  \kbd{=} introduces a column
formula, \kbd{:=} a field formula.

\key{Example: Add Col1 and Col2}{|=\$1+\$2      |}
\key{... with printf format specification}{|=\$1+\$2;\%.2f|}
\key{... with constants from constants.el}{|=\$1/\$c/\$cm |}
\metax{sum from 2nd to 3rd hline}{|:=vsum(@II..@III)|}
\key{apply current column formula}{| = |}

\key{set and eval column formula}{C-c =}
\key{set and eval field formula}{C-u C-c =}
\key{re-apply all stored equations to current line}{C-c *}
\key{re-apply all stored equations to entire table}{C-u C-c *}
\key{iterate table to stability}{C-u C-u C-c *}
\key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
\key{show line, column, formula reference}{C-c ?}
\key{toggle coordinate grid}{C-c \}}
\key{toggle formula debugger}{C-c \{}

Carsten Dominik's avatar
Carsten Dominik committed
424
\newcolumn
Carsten Dominik's avatar
Carsten Dominik committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438
{\it Formula Editor}

\key{edit formulas in separate buffer}{C-c '}
\key{exit and install new formulas}{C-c C-c}
\key{exit, install, and apply new formulas}{C-u C-c C-c}
\key{abort}{C-c C-q}
\key{toggle reference style}{C-c C-r}
\key{pretty-print Lisp formula}{TAB}
\key{complete Lisp symbol}{M-TAB}
\key{shift reference point}{S-cursor}
\key{shift test line for column references}{M-up/down}
\key{scroll the window showing the table}{M-S-up/down}
\key{toggle table coordinate grid}{C-c \}}

439 440 441 442 443 444 445 446 447 448 449 450 451
\section{Links}

\key{globally store link to the current location}{C-c l$^1$}
\key{insert a link (TAB completes stored links)}{C-c C-l}
\key{insert file link with file name completion}{C-u C-c C-l}
\key{edit (also hidden part of) link at point}{C-c C-l}

\key{open file links in emacs}{C-c C-o}
\key{...force open in emacs/other window}{C-u C-c C-o}
\key{open link at point}{mouse-1/2}
\key{...force open in emacs/other window}{mouse-3}
\key{record a position in mark ring}{C-c \%}
\key{jump back to last followed link(s)}{C-c \&}
452 453 454
\key{find next link}{C-c C-x C-n}
\key{find previous link}{C-c C-x C-p}
\key{edit code snippet of file at point}{C-c '}
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
{\bf Internal Links}

\key{\kbd{<<My Target>>}}{\rm target}
\key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
\key{\kbd{[[*this text]]}}{\rm find headline}
\metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
\metax{\kbd{[[this text][description]]}}{\rm optional link text}

{\bf External Links}

\key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
\key{\kbd{file:papers/last.pdf}}{\rm file, relative}
\key{\kbd{file:projects.org::*that text}}{\rm find headline}
\key{\kbd{file:projects.org::find me}}{\rm find trgt/string}
%\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
\key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
\key{\kbd{mailto:adent@galaxy.net}}{\rm Email address}
\key{\kbd{news:comp.emacs}}{\rm Usenet group}
\key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
\key{\kbd{gnus:group}}{\rm GNUS group}
\key{\kbd{gnus:group\#id}}{\rm GNUS message}
\key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
\key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
\key{\kbd{info:emacs:Regexps}}{\rm Info file:node}
\key{\kbd{shell:ls *.org}}{\rm shell command}
\key{\kbd{elisp:(calendar)}}{\rm elisp form}
\metax{\kbd{[[external link][description]]}}{\rm optional link text}
%\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}


Carsten Dominik's avatar
Carsten Dominik committed
485
% \section{Remember-mode Integration}
486

Carsten Dominik's avatar
Carsten Dominik committed
487 488 489
% See the manual for how to make remember.el use Org-mode links and
% files.  The note-finishing command \kbd{C-c C-c} will first prompt for
% an org file. In the file, find a location with:
490

Carsten Dominik's avatar
Carsten Dominik committed
491 492 493
% \key{rotate subtree visibility}{TAB}
% \key{next heading}{DOWN}
% \key{previous heading}{UP}
494

Carsten Dominik's avatar
Carsten Dominik committed
495
% Insert the note with one of the following: 
496

Carsten Dominik's avatar
Carsten Dominik committed
497 498 499 500 501 502
% \key{as sublevel of heading at cursor}{RET}
% \key{right here (cursor not on heading)}{RET}
% \key{before current heading}{LEFT}
% \key{after current heading}{RIGHT}
% \key{shortcut to end of buffer (cursor at buf-start)}{RET}
% \key{Abort}{q}
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520

\section{Completion}

In-buffer completion completes TODO keywords at headline start, TeX
macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS
after  ``{\tt :}'', and dictionary words elsewhere.

\key{Complete word at point}{M-TAB}


\newcolumn
\title{Org-Mode Reference Card (2/2)}

\centerline{(for version \orgversionnumber)}

\section{TODO Items and Checkboxes}

\key{rotate the state of the current item}{C-c C-t}
Carsten Dominik's avatar
Carsten Dominik committed
521 522
\metax{select next/previous state}{S-LEFT/RIGHT}
\metax{select next/previous set}{C-S-LEFT/RIGHT}
523 524 525 526 527
\key{view TODO items in a sparse tree}{C-c C-v}
\key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}

\key{set the priority of the current item}{C-c , [ABC]}
\key{remove priority cookie from current item}{C-c , SPC}
Carsten Dominik's avatar
Carsten Dominik committed
528 529
\key{raise/lower priority of current item}{S-UP/DOWN$^3$}
%\key{lower priority of current item}{S-DOWN$^3$}
530

Carsten Dominik's avatar
Carsten Dominik committed
531 532
%\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
%\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
533 534 535 536 537 538 539 540 541

\key{insert new checkbox item in plain list}{M-S-RET}
\key{toggle checkbox(es) in region/entry/at point}{C-c C-x C-b}
\key{toggle checkbox at point}{C-c C-c}
\metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{}
\key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#}

\section{Tags}

542 543
\key{set tags for current heading}{C-c C-q}
\key{realign tags in all headings}{C-u C-c C-q}
544 545 546
\key{create sparse tree with matching tags}{C-c \\}
\key{globally (agenda) match tags at cursor}{C-c C-o}

Carsten Dominik's avatar
Carsten Dominik committed
547 548
\section{Properties and Column View}

549
\key{set property}{C-c C-x p}
Carsten Dominik's avatar
Carsten Dominik committed
550 551 552
\key{special commands in property lines}{C-c C-c}
\key{next/previous allowed value}{S-left/right}
\key{turn on column view}{C-c C-x C-c}
553
\key{capture columns view in dynamic block}{C-c C-x i}
Carsten Dominik's avatar
Carsten Dominik committed
554 555 556 557 558 559 560 561 562 563 564 565 566

\key{quit column view}{q}
\key{next/previous allowed value}{S-left/right}
\key{next/previous allowed value}{n / p}
\key{edit value}{e}
\key{edit allowed values list}{a}
\key{show value}{v}
\key{make column wider/narrower}{> / <}
\key{move column left/right}{M-left/right}
\key{add new column}{M-S-right}
\key{Delete current column}{M-S-left}


567 568 569 570 571 572 573
\section{Timestamps}

\key{prompt for date and insert timestamp}{C-c .}
\key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
\key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
\key{insert DEADLINE timestamp}{C-c C-d}
\key{insert SCHEDULED timestamp}{C-c C-s}
574
\key{create sparse tree with all deadlines due}{C-c / d}
575 576 577 578 579 580 581 582 583 584 585 586 587 588
\key{the time between 2 dates in a time range}{C-c C-y}
\key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$}
\key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$}
\key{access the calendar for the current date}{C-c >}
\key{insert timestamp matching date in calendar}{C-c <}
\key{access agenda for current date}{C-c C-o}
\key{Select date while prompted}{mouse-1/RET}
%\key{... select date in calendar}{mouse-1/RET}
%\key{... scroll calendar back/forward one month}{< / >}
%\key{... forward/backward one day}{S-LEFT/RIGHT}
%\key{... forward/backward one week}{S-UP/DOWN}
%\key{... forward/backward one month}{M-S-LEFT/RIGT}
\key{Toggle custom format display for dates/times}{C-c C-x C-t}

Carsten Dominik's avatar
Carsten Dominik committed
589 590
\newcolumn

Carsten Dominik's avatar
Carsten Dominik committed
591
{\bf Clocking time}
592 593 594 595 596 597 598 599 600 601 602 603

\key{start clock on current item}{C-c C-x C-i}
\key{stop clock on current item}{C-c C-x C-o}
\key{cancel current clock}{C-c C-x C-x}
\key{display total subtree times}{C-c C-x C-d}
\key{remove displayed times}{C-c C-c}
\key{insert/update table with clock report}{C-c C-x C-r}

\section{Agenda Views}

\key{add/move current file to front of agenda}{C-c [}
\key{remove current file from your agenda}{C-c ]}
604
\key{cycle through agenda file list}{C-'}
605
\key{set/remove restriction lock}{C-c C-x </>}
606 607 608 609

\key{compile agenda for the current week}{C-c a a$^1$}
\key{compile global TODO list}{C-c a t$^1$}
\key{compile TODO list for specific keyword}{C-c a T$^1$}
610
\key{match tags, TODO kwds, properties}{C-c a m$^1$}
611
\key{match only in TODO entries}{C-c a M$^1$}
612
\key{find stuck projects}{C-c a \#$^1$}
613 614
\key{show timeline of current org file}{C-c a L$^1$}
\key{configure custom commands}{C-c a C$^1$}
615
%\key{configure stuck projects}{C-c a !$^1$}
616 617 618 619 620 621 622 623 624 625 626 627
\key{agenda for date at cursor}{C-c C-o}

{\bf Commands available in an agenda buffer}

{\bf View Org file}

\key{show original location of item}{SPC/mouse-3}
%\key{... also available with}{mouse-3}
\key{show and recenter window}{L}
\key{goto original location in other window}{TAB/mouse-2}
%\key{... also available with}{mouse-2}
\key{goto original location, delete other windows}{RET}
628
\key{show subtree in indirect buffer, ded.\ frame}{b}
629 630 631 632 633
\key{toggle follow-mode}{f}

{\bf Change display}

\key{delete other windows}{o}
Carsten Dominik's avatar
Carsten Dominik committed
634
\key{switch to day/week/month/year view}{d w m y}
635
\key{toggle inclusion of diary entries}{D}
636
\key{toggle time grid for daily schedule}{G}
637
\key{toggle display of logbook entries}{l}
638
\key{toggle inclusion of archived trees/files}{v / C-u v}
639
\key{refresh agenda buffer with any changes}{r / g}
640
\key{filter with repect to a tag}{/}
641
\key{save all org-mode buffers}{s}
642
\key{display next/previous day,week,...}{RIGHT/LEFT}
643 644 645 646 647 648 649
\key{goto today}{.}

{\bf Remote editing}

\key{digit argument}{0-9}
\key{change state of current TODO item}{t}
\key{kill item and source}{C-k}
650
\key{archive the subtree (file/tag/sibling)}{\$ / a / A}
651
\key{show tags of current headline}{T}
652
\key{set tags for current headline/region}{:}
653 654 655
\key{set priority of current item}{p}
\key{raise/lower priority of current item}{S-UP/DOWN$^3$}
\key{display weighted priority of current item}{P}
656
\key{run an attachment command}{C-c C-a}
657 658 659 660 661
\key{schedule/set deadline for this item}{C-c C-s/d}
\key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
\key{change timestamp to today}{>}
\key{insert new entry into diary}{i}

Carsten Dominik's avatar
Carsten Dominik committed
662
\newcolumn
663 664
\key{start/stop/cancel the clock on current item}{I / O / X}
\key{jump to running clock entry}{J}
665

666
{\bf Misc}
667

668 669
\key{Open link in current line}{C-c C-o}

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
{\bf Calendar commands}

\key{find agenda cursor date in calendar}{c}
\key{compute agenda for calendar cursor date}{c}
\key{show phases of the moon}{M}
\key{show sunrise/sunset times}{S}
\key{show holidays}{H}
\key{convert date to other calendars}{C}

{\bf Quit and Exit}

\key{quit agenda, remove agenda buffer}{q}
\key{exit agenda, remove all agenda buffers}{x}

\section{Calendar and Diary Integration}

Include Emacs diary entries into Org-mode agenda with:
\beginexample%
(setq org-agenda-include-diary t)
\endexample

Carsten Dominik's avatar
Carsten Dominik committed
691 692 693 694 695 696
\section{LaTeX and cdlatex-mode}

\key{preview LaTeX fragment}{C-c C-x C-l}
\key{Expand abbreviation (cdlatex-mode)}{TAB}
\key{Insert/modify math symbol (cdlatex-mode)}{` / '}

697 698 699 700 701 702 703 704 705 706 707 708
\section{Exporting and Publishing}

Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
in the current directory.  Publishing puts the resulting file into
some other place.

\key{export/publish dispatcher}{C-c C-e}

\key{export visible part only}{C-c C-e v}
\key{insert template of export options}{C-c C-x t}
\key{toggle fixed width for entry or region}{C-c :}

Carsten Dominik's avatar
Carsten Dominik committed
709 710 711 712 713 714 715 716 717 718 719
%{\bf HTML formatting}

%\key{make words {\bf bold}}{*bold*}
%\key{make words {\it italic}}{/italic/}
%\key{make words \underbar{underlined}}{_underlined_}
%\key{sub- and superscripts}{x\^{}3, J_dust}
%\key{\TeX{}-like macros}{\\alpha, \\to}
%\key{typeset lines in fixed width font}{start with :}
%\key{tables are exported as HTML tables}{start with |}
%\key{links become HTML links}{http:... etc}
%\key{include html tags}{@<b>...@</b>}
720

721 722 723 724 725 726 727 728 729 730 731 732 733
%{\bf Export options}
%
%Include additional information for export by putting these anywhere in the
%org file.  Use {\tt M-TAB} completion to make sure to get the right
%keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
%
%\key{the title to be shown}{\#+TITLE:}
%\key{the author}{\#+AUTHOR:}
%\key{authors email address}{\#+EMAIL:}
%\key{language code for html}{\#+LANGUAGE:}
%\key{free text description of file}{\#+TEXT:}
%\key{... which can carry over multiple lines}{\#+TEXT:}
%\key{settings for the export process}{\#+OPTIONS:}
734 735 736 737 738 739 740 741 742

%\key{set number of headline levels for export}{H:2}
%\key{turn on/off section numbers}{num:t}
%\key{turn on/off table of contents}{toc:t}
%\key{turn on/off linebreak preservation}{\\n:nil}
%\key{turn on/off quoted html tags}{@:t}
%\key{turn on/off fixed width sections}{::t}
%\key{turn on/off tables}{|:t}
%\key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t}
743
%\key{turn on/off emphasised text}{*:nil}
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
%\key{turn on/off \TeX\ macros}{TeX:t}

{\bf Comments: Text not being exported}

Text before the first headline is not considered part of the document
and is therefore never exported.
Lines starting with \kbd{\#} are comments and are not exported.
Subtrees whose header starts with COMMENT are never exported.

\key{toggle COMMENT keyword on entry}{C-c ;}

\section{Dynamic Blocks}

\key{update dynamic block at point}{C-c C-x C-u}
\metax{update all dynamic blocks}{C-u C-c C-x C-u}

\section{Notes}
$^1$ This is only a suggestion for a binding of this command.  Choose
762
your own key as shown under INSTALLATION.
763 764 765 766 767 768 769 770 771 772

$^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
press \kbd{C-c C-c} with the cursor still in the line to update.

$^3$ Keybinding affected by {\tt org-CUA-compatibility}.

\copyrightnotice

\bye

Carsten Dominik's avatar
Carsten Dominik committed
773
% Local variables:
774
% compile-command: "tex refcard"
Carsten Dominik's avatar
Carsten Dominik committed
775
% End:
776 777

% arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290