orgcard.tex 25 KB

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