org-mode/orgcard.tex

751 lines
25 KiB
TeX
Raw Normal View History

2008-01-31 04:51:19 -05:00
% Reference Card for Org Mode
2008-01-31 05:33:00 -05:00
\def\orgversionnumber{4.55}
2008-01-31 04:51:19 -05:00
\def\year{2006}
2008-01-31 05:32:41 -05:00
%
2008-01-31 04:30:03 -05:00
%**start of header
\newcount\columnsperpage
% This file can be printed with 1, 2, or 3 columns per page (see below).
% At the moment this card works quite nicely in 3 column format and
% currently takes 2 full pages. It is thus suited to producing one
% double-side page when printed.
% There are a couple of tweaks in the format of this card which make it work
% slightly better on A4 paper. The changes due, I think, to Stephen Eglen,
% are commented below. Revert the changes if you want letter sized paper.
% Try running something like
% tex org-mode-ref.tex; dvips -t landscape org-mode-ref.dvi
% to print the card
\columnsperpage=3
% Copyright (c) 2004 Philip Rooke, 2005, 2006 Free Software Foundation
% GNU Emacs is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2, or (at your option)
% any later version.
% 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
% along with GNU Emacs; see the file COPYING. If not, write to
% the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
% Boston, MA 02111-1307, USA.
% 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.
%
% 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\ 2004, 2005, 2006\ 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{}, \year}
\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}
\newdimen\intercolumnskip %horizontal space between columns
\newbox\columna %boxes to hold columns already built
\newbox\columnb
\def\ncolumns{\the\columnsperpage}
\message{[\ncolumns\space
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.
\if 1\ncolumns %one-column format uses normal size
\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}}
\else %2 or 3 columns uses prereduced size
\hsize 3.2in
% FIXME - Try to make things more A4 friendly
% \vsize 7.95in
\vsize 7.65in
% \hoffset -.75in
\hoffset -.25in
\voffset -.745in
\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}
% FIXME - Try to make things more A4 friendly
% \normalbaselineskip=.8\normalbaselineskip
\normalbaselineskip=.7\normalbaselineskip
\normallineskip=.8\normallineskip
\normallineskiplimit=.8\normallineskiplimit
\normalbaselines\rm %make definitions take effect
\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}
\output={% %see The TeXbook page 257
% 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
\global\setbox\columna\columnbox \global\def\abc{b}
%% in case we never use \columnb (two-column mode)
\global\setbox\columnb\hbox to -\intercolumnskip{}
\else
\global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
\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
\end}
\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.
\def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
% 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))
2008-01-31 05:31:37 -05:00
(define-key global-map "\\C-cl" 'org-store-link)$^1$
(define-key global-map "\\C-ca" 'org-agenda)$^1$
2008-01-31 04:30:03 -05:00
\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}
\key{show the whole file}{C-c C-a}
2008-01-31 05:32:56 -05:00
\key{reveal context around point}{C-c C-r}
2008-01-31 04:30:03 -05:00
%\key{show branches}{C-c C-k}
\section{Motion}
2008-01-31 05:32:08 -05:00
\key{next/previous heading}{C-c C-n/p}
\key{next/previous heading, same level}{C-c C-f/b}
2008-01-31 04:30:03 -05:00
\key{backward to higher level heading}{C-c C-u}
\key{jump to another place in document}{C-c C-j}
2008-01-31 05:31:51 -05:00
\key{previous/next plain list item}{S-UP/DOWN$^3$}
2008-01-31 04:30:03 -05:00
\section{Structure Editing}
\key{insert new heading/item at current level}{M-RET}
2008-01-31 05:32:13 -05:00
\key{insert new TODO entry/checkbox item}{M-S-RET}
2008-01-31 04:30:03 -05:00
\key{promote current heading up one level}{M-LEFT}
\key{demote current heading down one level}{M-RIGHT}
\key{promote current subtree up one level}{M-S-LEFT}
\key{demote current subtree down one level}{M-S-RIGHT}
2008-01-31 05:32:08 -05:00
\key{move subtree/list item up/down}{M-S-UP/DOWN}
2008-01-31 04:30:03 -05:00
\key{kill subtree}{C-c C-x C-w}
\key{copy subtree}{C-c C-x M-w}
\key{yank subtree}{C-c C-x C-y}
2008-01-31 05:32:08 -05:00
\key{narrow buffer to current subtree}{C-x n s}
2008-01-31 04:30:03 -05:00
2008-01-31 05:32:08 -05:00
\section{Archiving}
\key{toggle ARCHIVE tag}{C-c C-x C-a}
2008-01-31 05:32:28 -05:00
\metax{mark fully done children}{C-u C-c C-x C-a}
\key{force cycling of an ARCHIVEd tree}{C-TAB}
\key{move subtree to archive file}{C-c \$}
2008-01-31 05:32:08 -05:00
\key{move all fully done children}{C-u C-c \$}
2008-01-31 05:31:37 -05:00
To set archive location for current file, add a line like$^2$:
2008-01-31 04:30:03 -05:00
\vskip -1mm
\beginexample%
\#+ARCHIVE: archfile::* Archived Tasks
\endexample
\section{Filtering and Sparse Trees}
\key{show sparse tree for all matches of a regexp}{C-c /}
\key{view TODO's in sparse tree}{C-c C-v}
2008-01-31 05:31:37 -05:00
\key{global TODO list in agenda mode}{C-c t$^1$}
2008-01-31 04:30:03 -05:00
\key{create sparse tree with all deadlines due}{C-c C-w}
2008-01-31 05:32:32 -05:00
\key{time sorted view of current org file}{C-c a L}
2008-01-31 05:31:37 -05:00
%\key{agenda for the week}{C-c a$^1$}
2008-01-31 04:30:03 -05:00
%\key{agenda for date at cursor}{C-c C-o}
\section{Tables}
{\bf Creating a table}
2008-01-31 05:29:47 -05:00
%\metax{insert a new Org-mode table}{M-x org-table-create}
\metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
2008-01-31 05:30:56 -05:00
\key{convert region to table}{C-c |}
\key{... separator at least 3 spaces}{C-3 C-c |}
2008-01-31 04:30:03 -05:00
{\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}
\key{move the current column left}{M-LEFT}
\key{move the current column right}{M-RIGHT}
\key{kill the current column}{M-S-LEFT}
\key{insert new column to left of cursor position}{M-S-RIGHT}
\key{move the current row up}{M-UP}
\key{move the current row down}{M-DOWN}
\key{kill the current row or horizontal line}{M-S-UP}
\key{insert new row above the current row}{M-S-DOWN}
\key{insert horizontal line below the current row}{C-c -}
\key{insert horizontal line above the current row}{C-u C-c -}
\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}
2008-01-31 05:30:56 -05:00
{\bf Calculations} (in combination with Emacs \kbd{calc} package)
2008-01-31 04:30:03 -05:00
\key{set and eval column formula}{C-c =}
\key{set and eval named-field formula}{C-u C-c =}
\key{edit formulas in separate buffer}{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 *}
2008-01-31 05:30:56 -05:00
%\kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
%in lines starting with: {\tt | \# |}.
2008-01-31 04:30:03 -05:00
\key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
\key{display column number cursor is in}{C-c ?}
\key{sum numbers in current column/rectangle}{C-c +}
2008-01-31 05:31:37 -05:00
\key{copy down with increment}{S-RET$^3$}
2008-01-31 04:30:03 -05:00
2008-01-31 05:30:30 -05:00
Formulas typed in field are executed by \kbd{TAB},
\kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
formula, \kbd{:=} a named-field formula.
2008-01-31 04:30:03 -05:00
\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}
\key{sum from 3rd hline above to here}{:=vsum(\&III)}
\key{apply current column formula}{=}
{\bf Miscellaneous}
2008-01-31 05:30:56 -05:00
\key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
2008-01-31 05:29:47 -05:00
\key{edit the current field in a separate window}{C-c `}
2008-01-31 05:30:30 -05:00
\key{make current field fully visible}{C-u TAB}
2008-01-31 04:30:03 -05:00
\metax{export as tab-separated file}{M-x org-table-export}
\metax{import tab-separated file}{M-x org-table-import}
{\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 ~}
2008-01-31 05:32:03 -05:00
\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}
2008-01-31 05:32:45 -05:00
\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 \%}
2008-01-31 05:32:03 -05:00
\key{jump back to last followed link(s)}{C-c \&}
{\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}
2008-01-31 05:32:28 -05:00
\key{\kbd{file:projects.org::find me}}{\rm find trgt/string}
2008-01-31 05:32:03 -05:00
%\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
\key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
2008-01-31 05:32:28 -05:00
\key{\kbd{mailto:adent@galaxy.net}}{\rm Email address}
2008-01-31 05:32:03 -05:00
\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}
2008-01-31 05:32:08 -05:00
\section{Remember-mode Integration}
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:
\key{rotate subtree visibility}{TAB}
\key{next heading}{DOWN}
\key{previous heading}{UP}
Insert the note with one of the following:
\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}
\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)}
2008-01-31 05:32:28 -05:00
\section{TODO Items and Checkboxes}
2008-01-31 05:32:03 -05:00
\key{rotate the state of the current item}{C-c C-t}
\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}
\key{raise priority of current item}{S-UP$^3$}
\key{lower priority of current item}{S-DOWN$^3$}
\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
2008-01-31 05:32:28 -05:00
\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 [\%]}}{}
2008-01-31 05:32:32 -05:00
\key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#}
2008-01-31 05:32:28 -05:00
2008-01-31 05:32:08 -05:00
\section{Tags}
\key{set tags for current heading}{C-c C-c}
\key{realign tags in all headings}{C-u C-c C-c}
\key{create sparse tree with matching tags}{C-c \\}
\key{globally (agenda) match tags at cursor}{C-c C-o}
2008-01-31 05:32:03 -05:00
\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}
\key{create sparse tree with all deadlines due}{C-c C-w}
\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}
2008-01-31 05:32:52 -05:00
\key{Toggle custom format display for dates/times}{C-c C-x C-t}
2008-01-31 05:32:03 -05:00
\section{Clocking Time}
\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}
2008-01-31 05:32:08 -05:00
2008-01-31 05:32:03 -05:00
\key{display total subtree times}{C-c C-x C-d}
\key{remove displayed times}{C-c C-c}
2008-01-31 05:32:08 -05:00
\key{insert/update table with clock report}{C-c C-x C-r}
\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)}{` / '}
2008-01-31 05:32:03 -05:00
2008-01-31 04:30:03 -05:00
\section{Agenda Views}
\key{add/move current file to front of agenda}{C-c [}
\key{remove current file from your agenda}{C-c ]}
\key{cycle through agenda file list}{C-,}
2008-01-31 05:31:37 -05:00
\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$}
\key{match tags in agenda files}{C-c a m$^1$}
2008-01-31 05:32:32 -05:00
\key{match tags in TODO entries}{C-c a M$^1$}
\key{show timeline of current org file}{C-c a L$^1$}
\key{configure custom commands}{C-c a C$^1$}
2008-01-31 04:30:03 -05:00
\key{agenda for date at cursor}{C-c C-o}
\vskip 1mm
2008-01-31 05:31:37 -05:00
To set categories, add lines like$^2$:
2008-01-31 04:30:03 -05:00
\vskip -1mm
\beginexample%
\#+CATEGORY: MyCateg
\endexample
{\bf Commands available in an agenda buffer}
{\bf View Org file}
\key{show original location of item}{SPC}
\key{... also available with}{mouse-3}
\key{show and recenter window}{L}
\key{goto original location in other window}{TAB}
\key{... also available with}{mouse-2}
\key{goto original location, delete other windows}{RET}
\key{toggle follow-mode}{f}
{\bf Change display}
\key{delete other windows}{o}
\key{switch to daily / weekly view}{d / w}
\key{toggle inclusion of diary entries}{D}
\key{toggle time grid for daily schedule}{g}
\key{toggle display of logbook entries}{l}
\key{refresh agenda buffer with any changes}{r}
2008-01-31 05:32:16 -05:00
\key{save all org-mode buffers}{s}
2008-01-31 04:30:03 -05:00
\key{display the following \kbd{org-agenda-ndays}}{RIGHT}
\key{display the previous \kbd{org-agenda-ndays}}{LEFT}
\key{goto today}{.}
{\bf Remote editing}
\key{digit argument}{0-9}
\key{change state of current TODO item}{t}
\key{show tags of current headline}{T}
\key{set tags for current headline}{:}
2008-01-31 05:32:08 -05:00
\key{toggle ARCHIVE tag}{a}
2008-01-31 04:30:03 -05:00
\key{set priority of current item}{p}
2008-01-31 05:31:37 -05:00
\key{raise/lower priority of current item}{S-UP/DOWN$^3$}
2008-01-31 04:30:03 -05:00
\key{display weighted priority of current item}{P}
2008-01-31 05:31:31 -05:00
\key{schedule/set deadline for this item}{C-c C-s/d}
2008-01-31 05:31:37 -05:00
\key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
2008-01-31 04:30:03 -05:00
\key{change timestamp to today}{>}
\key{insert new entry into diary}{i}
2008-01-31 05:32:03 -05:00
\key{Start the clock on current item (clock-in)}{I}
\key{Stop the clock (clock-out)}{O}
\key{Cancel current clock}{X}
2008-01-31 04:30:03 -05:00
{\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}
2008-01-31 05:32:08 -05:00
\section{Calendar and Diary Integration}
2008-01-31 05:32:20 -05:00
Include Emacs diary entries into Org-mode agenda with:
2008-01-31 05:32:08 -05:00
\beginexample%
(setq org-agenda-include-diary t)
\endexample
2008-01-31 05:32:03 -05:00
\section{Exporting and Publishing}
2008-01-31 04:30:03 -05:00
Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
2008-01-31 05:32:03 -05:00
in the current directory. Publishing puts the resulting file into
some other place.
2008-01-31 04:30:03 -05:00
2008-01-31 05:32:03 -05:00
\key{export/publish dispatcher}{C-c C-e}
2008-01-31 04:30:03 -05:00
2008-01-31 05:32:03 -05:00
\key{export visible part only}{C-c C-e v}
2008-01-31 04:30:03 -05:00
\key{insert template of export options}{C-c C-x t}
\key{toggle fixed width for entry or region}{C-c :}
{\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>}
{\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:}
2008-01-31 05:32:08 -05:00
%\key{settings for the export process - see below}{\#+OPTIONS:}
\key{settings for the export process}{\#+OPTIONS:}
%\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}
%\key{turn on/off emphasised text}{*:nil}
%\key{turn on/off \TeX\ macros}{TeX:t}
2008-01-31 04:30:03 -05:00
{\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 ;}
2008-01-31 05:32:08 -05:00
%\section{CUA and pc-select compatibility}%
2008-01-31 04:30:03 -05:00
2008-01-31 05:32:08 -05:00
%Configure the variable {\tt org-CUA-compatibility} to make Org-mode
%avoid the \kbd{S-<cursor>} bindings used by these modes. When set,
%Org-mode will change the following keybindings (also in the agenda
%buffer, but not during date selection). See note mark four$^3$
%throughout the reference card.
%%\vskip-mm
%\beginexample
%S-UP $\to$ M-p S-DOWN $\to$ M-n
%S-LEFT $\to$ M-- S-RIGHT $\to$ M-+
%S-RET $\to$ C-S-RET
%\endexample
2008-01-31 04:30:03 -05:00
2008-01-31 05:32:28 -05:00
\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}
2008-01-31 04:30:03 -05:00
\section{Notes}
2008-01-31 05:31:37 -05:00
$^1$ This is only a suggestion for a binding of this command. Choose
2008-01-31 04:30:03 -05:00
you own key as shown under INSTALLATION.
2008-01-31 05:31:37 -05:00
$^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
2008-01-31 04:30:03 -05:00
press \kbd{C-c C-c} with the cursor still in the line to update.
2008-01-31 05:31:37 -05:00
$^3$ Keybinding affected by {\tt org-CUA-compatibility}.
2008-01-31 04:30:03 -05:00
\copyrightnotice
\bye
% arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290
%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End: