Mercurial > emacs
comparison etc/orgcard.tex @ 63845:6ef67fb45efd
New files, the reference card for org-mode.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Wed, 29 Jun 2005 09:45:38 +0000 |
parents | |
children | 132196e8c5eb |
comparison
equal
deleted
inserted
replaced
63844:0b93c09db258 | 63845:6ef67fb45efd |
---|---|
1 % Reference Card for Org Mode 3.12 | |
2 % | |
3 %**start of header | |
4 \newcount\columnsperpage | |
5 | |
6 % This file can be printed with 1, 2, or 3 columns per page (see below). | |
7 % At the moment this card works quite nicely in 3 column format and | |
8 % currently takes most of 2 pages. It is thus suited to producing one | |
9 % double-side page when printed. | |
10 | |
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 | |
15 % Try running something like | |
16 % tex org-mode-ref.tex; dvips -t landscape org-mode-ref.dvi | |
17 % to print the card | |
18 | |
19 \columnsperpage=3 | |
20 | |
21 % Copyright (c) 2004 Philip Rooke, 2005 Free Software Foundation | |
22 | |
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) | |
26 % any later version. | |
27 | |
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. | |
32 | |
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. | |
37 | |
38 % This file is intended to be processed by plain TeX (TeX82). | |
39 % | |
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: | |
42 % 1 column per page | |
43 % produces six separate pages, each of which needs to be reduced to 80%. | |
44 % This gives the best resolution. | |
45 % 2 columns per page | |
46 % produces three already-reduced pages. | |
47 % You will still need to cut and paste. | |
48 % 3 columns per page | |
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. | |
53 % | |
54 % Author: | |
55 % Stephen Gildea | |
56 % Internet: gildea@stop.mail-abuse.org | |
57 % | |
58 % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik | |
59 % for their many good ideas. | |
60 | |
61 \def\orgversionnumber{3.12} | |
62 \def\year{2005} | |
63 | |
64 \def\shortcopyrightnotice{\vskip 1ex plus 2 fill | |
65 \centerline{\small \copyright\ 2004, 2005\ Free Software Foundation, Inc. | |
66 Permissions on back. v\orgversionnumber}} | |
67 | |
68 \def\copyrightnotice{ | |
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} | |
74 | |
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. | |
78 | |
79 \endgroup} | |
80 | |
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} | |
84 | |
85 \newdimen\intercolumnskip %horizontal space between columns | |
86 \newbox\columna %boxes to hold columns already built | |
87 \newbox\columnb | |
88 | |
89 \def\ncolumns{\the\columnsperpage} | |
90 | |
91 \message{[\ncolumns\space | |
92 column\if 1\ncolumns\else s\fi\space per page]} | |
93 | |
94 \def\scaledmag#1{ scaled \magstep #1} | |
95 | |
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 | |
99 \hsize 4in | |
100 \vsize 10in | |
101 \voffset -.7in | |
102 \font\titlefont=\fontname\tenbf \scaledmag3 | |
103 \font\headingfont=\fontname\tenbf \scaledmag2 | |
104 \font\smallfont=\fontname\sevenrm | |
105 \font\smallsy=\fontname\sevensy | |
106 | |
107 \footline{\hss\folio} | |
108 \def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}} | |
109 \else %2 or 3 columns uses prereduced size | |
110 \hsize 3.2in | |
111 | |
112 % FIXME - Try to make things more A4 friendly | |
113 % \vsize 7.95in | |
114 \vsize 7.65in | |
115 % \hoffset -.75in | |
116 \hoffset -.25in | |
117 \voffset -.745in | |
118 \font\titlefont=cmbx10 \scaledmag2 | |
119 \font\headingfont=cmbx10 \scaledmag1 | |
120 \font\smallfont=cmr6 | |
121 \font\smallsy=cmsy6 | |
122 \font\eightrm=cmr8 | |
123 \font\eightbf=cmbx8 | |
124 \font\eightit=cmti8 | |
125 \font\eighttt=cmtt8 | |
126 \font\eightmi=cmmi8 | |
127 \font\eightsy=cmsy8 | |
128 \textfont0=\eightrm | |
129 \textfont1=\eightmi | |
130 \textfont2=\eightsy | |
131 \def\rm{\eightrm} | |
132 \def\bf{\eightbf} | |
133 \def\it{\eightit} | |
134 \def\tt{\eighttt} | |
135 | |
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 | |
142 | |
143 \if 2\ncolumns | |
144 \let\maxcolumn=b | |
145 \footline{\hss\rm\folio\hss} | |
146 \def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}} | |
147 \else \if 3\ncolumns | |
148 \let\maxcolumn=c | |
149 \nopagenumbers | |
150 \else | |
151 \errhelp{You must set \columnsperpage equal to 1, 2, or 3.} | |
152 \errmessage{Illegal number of columns per page} | |
153 \fi\fi | |
154 | |
155 \intercolumnskip=.46in | |
156 \def\abc{a} | |
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} | |
161 \else\if a\abc | |
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{} | |
165 \else | |
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}} | |
172 | |
173 \def\bye{\par\vfill\supereject | |
174 \if a\abc \else\null\vfill\eject\fi | |
175 \if a\abc \else\null\vfill\eject\fi | |
176 \end} | |
177 \fi | |
178 | |
179 % we won't be using math mode much, so redefine some of the characters | |
180 % we might want to talk about | |
181 %\catcode`\^=12 | |
182 \catcode`\_=12 | |
183 | |
184 % we also need the tilde, for file names. | |
185 \catcode`\~=12 | |
186 | |
187 \chardef\\=`\\ | |
188 \chardef\{=`\{ | |
189 \chardef\}=`\} | |
190 | |
191 \hyphenation{mini-buf-fer} | |
192 | |
193 \parindent 0pt | |
194 \parskip 1ex plus .5ex minus .5ex | |
195 | |
196 \def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip} | |
197 | |
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} | |
201 | |
202 % title - page title. Argument is title text. | |
203 \outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex} | |
204 | |
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} | |
209 | |
210 \newdimen\keyindent | |
211 | |
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} | |
217 \endindentedkeys | |
218 | |
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} | |
223 | |
224 % \<...> - surrounds a variable name in a code example | |
225 \def\<#1>{{\it #1\/}} | |
226 | |
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 | |
229 | |
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} | |
236 | |
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}} | |
244 | |
245 \newbox\metaxbox | |
246 \setbox\metaxbox\hbox{\kbd{M-x }} | |
247 \newdimen\metaxwidth | |
248 \metaxwidth=\wd\metaxbox | |
249 | |
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 | |
257 \kbd{#2}\hfil}} | |
258 | |
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} | |
263 | |
264 %**end of header | |
265 | |
266 | |
267 \title{Org-Mode Reference Card (1/2)} | |
268 | |
269 \centerline{(for version \orgversionnumber)} | |
270 | |
271 \section{Getting Started} | |
272 % | |
273 Put the following in your \kbd{~/.emacs}$^1$ | |
274 \vskip -1mm | |
275 \beginexample% | |
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-store-link "org" "Store org link" t) | |
280 (autoload 'orgtbl-mode "org" "Orgtbl minor mode" t) | |
281 (autoload 'turn-on-orgtbl "org" "Orgtbl minor mode") | |
282 (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode)) | |
283 (define-key global-map "\\C-cl" 'org-store-link)$^2$ | |
284 (define-key global-map "\\C-ca" 'org-agenda)$^2$ | |
285 \endexample | |
286 % | |
287 \metax{For the many customization options try}{M-x org-customize} | |
288 \metax{To read the on-line documentation try}{M-x org-info} | |
289 | |
290 \section{Visibility Cycling} | |
291 | |
292 \key{rotate current subtree between states}{TAB} | |
293 \key{rotate entire buffer between states}{S-TAB} | |
294 \key{show the whole file}{C-c C-a} | |
295 %\key{show branches}{C-c C-k} | |
296 | |
297 \section{Motion} | |
298 | |
299 \key{next heading}{C-c C-n} | |
300 \key{previous heading}{C-c C-p} | |
301 \key{next heading, same level}{C-c C-f} | |
302 \key{previous heading, same level}{C-c C-b} | |
303 \key{backward to higher level heading}{C-c C-u} | |
304 \key{jump to another place in document}{C-c C-j} | |
305 | |
306 \section{Structure Editing} | |
307 | |
308 \key{insert new heading at same level as current}{M-RET} | |
309 \key{insert new TODO entry}{M-S-RET} | |
310 | |
311 \key{promote current heading up one level}{M-LEFT} | |
312 \key{demote current heading down one level}{M-RIGHT} | |
313 \key{promote current subtree up one level}{M-S-LEFT} | |
314 \key{demote current subtree down one level}{M-S-RIGHT} | |
315 | |
316 \key{move subtree up}{M-S-UP} | |
317 \key{move subtree down}{M-S-DOWN} | |
318 \key{kill subtree}{C-c C-h C-w} | |
319 \key{copy subtree}{C-c C-h M-w} | |
320 \key{yank subtree}{C-c C-h C-y} | |
321 | |
322 \key{archive subtree}{C-c \$} | |
323 To set archive location for current file, add a line like$^3$: | |
324 \vskip -1mm | |
325 \beginexample% | |
326 \#+ARCHIVE: archfile::* Archived Tasks | |
327 \endexample | |
328 | |
329 \section{Filtering and Sparse Trees} | |
330 | |
331 \key{show sparse tree for all matches of a regexp}{C-c /} | |
332 \key{view TODO's in sparse tree}{C-c C-v} | |
333 \key{create sparse tree with all deadlines due}{C-c C-w} | |
334 \key{time sorted view of current org file}{C-c C-r} | |
335 \key{agenda for the week}{C-c a$1$} | |
336 \key{agenda for date at cursor}{C-c C-o} | |
337 | |
338 \section{TODO Items} | |
339 | |
340 \key{rotate the state of the current item}{C-c C-t} | |
341 \key{view TODO items in a sparse tree}{C-c C-v} | |
342 | |
343 \key{set the priority of the current item}{C-c , [ABC]} | |
344 \key{remove priority cookie from current item}{C-c , SPC} | |
345 \key{raise priority of current item}{S-UP$^4$} | |
346 \key{lower priority of current item}{S-DOWN$^4$} | |
347 | |
348 \vskip 1mm | |
349 per-file TODO workflow states: add line(s) like$^3$: | |
350 \vskip -1mm | |
351 \beginexample% | |
352 \#+SEQ_TODO: TODO PROCRASTINATE BLUFF DONE | |
353 \endexample | |
354 \vskip -1mm | |
355 per-file TODO keywords: add line(s) like$^3$: | |
356 \vskip -1mm | |
357 \beginexample% | |
358 \#+TYP_TODO: Phil home work DONE | |
359 \endexample | |
360 | |
361 \section{Timestamps} | |
362 | |
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{insert DEADLINE timestamp}{C-c C-d} | |
366 \key{insert SCHEDULED timestamp}{C-c C-s} | |
367 \key{create sparse tree with all deadlines due}{C-c C-w} | |
368 \key{the time between 2 dates in a time range}{C-c C-y} | |
369 | |
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 | |
375 \key{access the calendar for the current date}{C-c >} | |
376 \key{insert timestamp matching date in calendar}{C-c <} | |
377 \key{access agenda for current date}{C-c C-o} | |
378 | |
379 \key{While prompted for a date:}{} | |
380 \key{... select date in calendar}{mouse-1/RET} | |
381 \key{... scroll calendar back/forward one month}{< / >} | |
382 \key{... forward/backward one day}{S-LEFT/RIGHT} | |
383 \key{... forward/backward one week}{S-UP/DOWN} | |
384 \key{... forward/backward one month}{M-S-LEFT/RIGT} | |
385 | |
386 \section{Links} | |
387 | |
388 \key{globally store link to the current location}{C-c l$^2$} | |
389 \key{insert a link (TAB completes stored links)}{C-c C-l} | |
390 \key{insert file link with file name completion}{C-u C-c C-l} | |
391 | |
392 \key{open link at point}{C-c C-o} | |
393 \key{open file links in emacs}{C-u C-c C-o} | |
394 \key{open link at point}{mouse-2} | |
395 \key{open file links in emacs}{mouse-3} | |
396 | |
397 {\bf Link types} | |
398 | |
399 \key{\kbd{<http://www.astro.uva.nl/~dominik>}}{\rm on the web} | |
400 \key{\kbd{<mailto:adent@galaxy.net>}}{\rm EMail address} | |
401 \key{\kbd{<news:comp.emacs>}}{\rm Usenet group} | |
402 \key{\kbd{<file:/home/dominik/img/mars.jpg>}}{\rm file, absolute} | |
403 \key{\kbd{<file:papers/last.pdf>}}{\rm file, relative} | |
404 \key{\kbd{<file:~/code/main.c:255>}}{\rm file with line nr.} | |
405 \key{\kbd{<bbdb:Richard Stallman>}}{\rm BBDB person} | |
406 \key{\kbd{<shell:ls *.org>}}{\rm shell command} | |
407 \key{\kbd{<gnus:group>}}{\rm GNUS group} | |
408 \key{\kbd{<gnus:group\#id>}}{\rm GNUS message} | |
409 \key{\kbd{<vm:folder>}}{\rm VM folder} | |
410 \key{\kbd{<vm:folder\#id>}}{\rm VM message} | |
411 \key{\kbd{<vm://myself@some.where.org/folder\#id>}}{\rm VM remote} | |
412 Wanderlust \kbd{<wl:...>} and RMAIL \kbd{<rmail:...>} like VM | |
413 %\key{\kbd{<wl:folder>}}{\rm Wanderlust f.} | |
414 %\key{\kbd{<wl:folder\#id>}}{\rm Wanderlust m.} | |
415 %\key{\kbd{<rmail:folder>}}{\rm RMAIL folder} | |
416 %\key{\kbd{<rmail:folder\#id>}}{\rm RMAIL msg} | |
417 | |
418 \section{Tables} | |
419 | |
420 %Org-mode has its own built-in intuitive table editor with unique | |
421 %capabilities. | |
422 | |
423 {\bf Creating a table} | |
424 | |
425 \metax{insert a new Org-mode table}{M-x org-table-create} | |
426 \metax{... or just start typing, e.g.}{|Name|Phone|Age RET |- TAB} | |
427 \key{convert region to table}{C-c C-c} | |
428 \key{... separator at least 3 spaces}{C-3 C-c C-c} | |
429 %\key{... prompt for separator regexp}{C-u C-c C-c} | |
430 | |
431 {\bf Commands available inside tables} | |
432 | |
433 The following commands work when the cursor is {\it inside a table}. | |
434 Outside of tables, the same keys may have other functionality. | |
435 | |
436 {\bf Re-aligning and field motion} | |
437 | |
438 \key{re-align the table without moving the cursor}{C-c C-c} | |
439 \key{re-align the table, move to next field}{TAB} | |
440 \key{move to previous field}{S-TAB} | |
441 \key{re-align the table, move to next row}{RET} | |
442 | |
443 {\bf Row and column editing} | |
444 | |
445 \key{move the current column left}{M-LEFT} | |
446 \key{move the current column right}{M-RIGHT} | |
447 \key{kill the current column}{M-S-LEFT} | |
448 \key{insert new column to left of cursor position}{M-S-RIGHT} | |
449 | |
450 \key{move the current row up}{M-UP} | |
451 \key{move the current row down}{M-DOWN} | |
452 \key{kill the current row or horizontal line}{M-S-UP} | |
453 \key{insert new row above the current row}{M-S-DOWN} | |
454 | |
455 \key{insert horizontal line below the current row}{C-c -} | |
456 \key{insert horizontal line above the current row}{C-u C-c -} | |
457 | |
458 {\bf Regions} | |
459 | |
460 \key{cut rectangular region}{C-c C-h C-w} | |
461 \key{copy rectangular region}{C-c C-h M-w} | |
462 \key{paste rectangular region}{C-c C-h C-y} | |
463 \key{fill paragraph across selected cells}{C-c C-q} | |
464 | |
465 {\bf Calculations} | |
466 | |
467 Except for the summation commands, these need the Emacs calc package | |
468 installed. | |
469 | |
470 \key{replace current field with result of formula}{C-c =} | |
471 \key{... same calculation for rest of column}{C-u C-c =} | |
472 \key{re-apply all stored equations to current line}{C-c *} | |
473 \key{re-apply all stored equations to entire table}{C-u C-c *} | |
474 | |
475 \kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation | |
476 in lines starting with: {\tt | \# |}. | |
477 | |
478 \key{rotate recalculation mark through \# * ! \$}{C-\#} | |
479 | |
480 \key{display column number cursor is in}{C-c ?} | |
481 \key{sum numbers in current column/rectangle}{C-c +} | |
482 \key{copy down with increment}{S-RET$^4$} | |
483 | |
484 A formula can also be typed directly into into a field. It will be | |
485 executed by \kbd{TAB}, \kbd{RET} and \kbd{C-c C-c}: | |
486 | |
487 \key{Example: Add Col1 and Col2}{=\$1+\$2} | |
488 \key{... with printf format specification}{=\$1+\$2;\%.2f} | |
489 \key{... with constants from constants.el}{=\$1/\$c/\$cm} | |
490 \key{Apply current (for this column) formula}{=} | |
491 \key{Sum all numbers above/left of cursor}{=sum / =sumh} | |
492 \key{Sum just the 3 fields closest to cursor}{=sum3/=sumh3} | |
493 | |
494 {\bf Miscellaneous} | |
495 | |
496 \key{toggle visibility of vertical lines}{C-c |} | |
497 \metax{export as tab-separated file}{M-x org-table-export} | |
498 \metax{import tab-separated file}{M-x org-table-import} | |
499 | |
500 {\bf Tables created with the \kbd{table.el} package} | |
501 | |
502 \key{insert a new \kbd{table.el} table}{C-c ~} | |
503 \key{recognize existing table.el table}{C-c C-c} | |
504 \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~} | |
505 | |
506 \newcolumn | |
507 \title{Org-Mode Reference Card (2/2)} | |
508 | |
509 \centerline{(for version \orgversionnumber)} | |
510 | |
511 \section{Timeline and Agenda} | |
512 | |
513 \key{show timeline of current org file}{C-c C-r} | |
514 \key{... include past dates}{C-u C-c C-r} | |
515 | |
516 \key{add current file to your agenda}{C-c [} | |
517 \key{remove current file from your agenda}{C-c ]} | |
518 \key{compile agenda for the current week}{C-c a$^2$} | |
519 \key{agenda for date at cursor}{C-c C-o} | |
520 \vskip 1mm | |
521 To set category for current file, add line$^3$: | |
522 \vskip -1mm | |
523 \beginexample% | |
524 \#+CATEGORY: MyCateg | |
525 \endexample | |
526 | |
527 {\bf Commands available in an agenda buffer} | |
528 | |
529 The agenda buffer is electric: single key presses execute commands. | |
530 | |
531 {\bf View org file} | |
532 | |
533 \key{show original location of item}{SPC} | |
534 \key{... also available with}{mouse-3} | |
535 \key{show and recenter window}{l} | |
536 \key{goto original location in other window}{TAB} | |
537 \key{... also available with}{mouse-2} | |
538 \key{goto original location, delete other windows}{RET} | |
539 \key{toggle follow-mode}{f} | |
540 | |
541 {\bf Change display} | |
542 | |
543 \key{delete other windows}{o} | |
544 \key{switch to weekly view}{w} | |
545 \key{switch to daily view}{d} | |
546 \key{toggle inclusion of diary entries}{D} | |
547 \key{toggle time grid for daily schedule}{g} | |
548 \key{refresh agenda buffer with any changes}{r} | |
549 \key{display the following \kbd{org-agenda-ndays}}{RIGHT} | |
550 \key{display the previous \kbd{org-agenda-ndays}}{LEFT} | |
551 \key{goto today}{.} | |
552 | |
553 {\bf Remote editing} | |
554 | |
555 \key{digit argument}{0-9} | |
556 | |
557 \key{change state of current TODO item}{t} | |
558 \key{set priority of current item}{p} | |
559 \key{raise priority of current item}{S-UP$^4$} | |
560 \key{lower priority of current item}{S-DOWN$^4$} | |
561 \key{display weighted priority of current item}{P} | |
562 | |
563 \key{change timestamp to one day earlier}{S-LEFT$^4$} | |
564 \key{change timestamp to one day later}{S-RIGHT$^4$} | |
565 \key{change timestamp to today}{>} | |
566 | |
567 \key{insert new entry into diary}{i} | |
568 | |
569 {\bf Calendar commands} | |
570 | |
571 \key{find agenda cursor date in calendar}{c} | |
572 \key{compute agenda for calendar cursor date}{c} | |
573 \key{show phases of the moon}{M} | |
574 \key{show sunrise/sunset times}{S} | |
575 \key{show holidays}{H} | |
576 \key{convert date to other calendars}{C} | |
577 | |
578 {\bf Quit and Exit} | |
579 | |
580 \key{quit agenda, remove agenda buffer}{q} | |
581 \key{exit agenda, remove all agenda buffers}{x} | |
582 | |
583 \section{Exporting} | |
584 | |
585 Exporting creates files with extensions {\it .txt\/} and {\it .html\/} | |
586 in the current directory. | |
587 | |
588 \key{export as ASCII file}{C-c C-x a} | |
589 \key{export visible text only (e.g. for printing)}{C-c C-x v} | |
590 \key{export as HTML file}{C-c C-x h} | |
591 \key{export as HTML and open in browser}{C-c C-x C-h} | |
592 \key{prefix arg sets nb. of headline levels, e.g.}{C-3 C-c C-x h} | |
593 | |
594 \key{insert template of export options}{C-c C-x t} | |
595 | |
596 \key{toggle fixed width for line or region}{C-c :} | |
597 | |
598 {\bf HTML formatting} | |
599 | |
600 \key{make words {\bf bold}}{*bold*} | |
601 \key{make words {\it italic}}{/italic/} | |
602 \key{make words \underbar{underlined}}{_underlined_} | |
603 \key{sub- and superscripts}{x\^{}3, J_dust} | |
604 \key{\TeX{}-like macros}{\\alpha, \\to} | |
605 \key{typeset lines in fixed width font}{start with :} | |
606 \key{tables are exported as HTML tables}{start with |} | |
607 \key{links become HTML links}{http:... etc} | |
608 \key{include html tags}{@<b>...@</b>} | |
609 | |
610 {\bf Export options} | |
611 | |
612 Include additional information for export by putting these anywhere in the | |
613 org file. Use {\tt M-TAB} completion to make sure to get the right | |
614 keywords. {\tt M-TAB} again just after keyword is complete inserts examples. | |
615 | |
616 \key{the title to be shown}{\#+TITLE:} | |
617 \key{the author}{\#+AUTHOR:} | |
618 \key{authors email address}{\#+EMAIL:} | |
619 \key{language code for html}{\#+LANGUAGE:} | |
620 \key{free text description of file}{\#+TEXT:} | |
621 \key{... which can carry over multiple lines}{\#+TEXT:} | |
622 \key{settings for the export process - see below}{\#+OPTIONS:} | |
623 | |
624 {\bf Settings for the OPTIONS line} | |
625 | |
626 \key{set number of headline levels for export}{H:2} | |
627 \key{turn on/off section numbers}{num:t} | |
628 \key{turn on/off table of contents}{toc:t} | |
629 \key{turn on/off linebreak preservation}{\\n:nil} | |
630 \key{turn on/off quoted html tags}{@:t} | |
631 \key{turn on/off fixed width sections}{::t} | |
632 \key{turn on/off tables}{|:t} | |
633 \key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t} | |
634 \key{turn on/off emphasised text}{*:nil} | |
635 \key{turn on/off \TeX\ macros}{TeX:t} | |
636 | |
637 {\bf Comments: Text not being exported} | |
638 | |
639 Text before the first headline is not considered part of the document | |
640 and is therefore never exported. | |
641 Lines starting with \kbd{\#} are comments and are not exported. | |
642 Subtrees whose header starts with COMMENT are never exported. | |
643 | |
644 \key{toggle COMMENT keyword on entry}{C-c ;} | |
645 | |
646 \section{Completion} | |
647 | |
648 In-buffer completion completes TODO keywords at headline start, TeX | |
649 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', | |
650 keyword formulas after ``{\tt =}'', and dictionary words elsewhere. | |
651 | |
652 \key{Complete word at point}{M-TAB} | |
653 | |
654 \newcolumn | |
655 | |
656 \section{Calendar and Diary Integration} | |
657 | |
658 To include entries from the Emacs diary in your Org-mode agenda: | |
659 \beginexample% | |
660 (setq org-agenda-include-diary t) | |
661 \endexample | |
662 | |
663 To include your Org-mode agenda in your normal diary, make sure you're | |
664 using the fancy diary display | |
665 % | |
666 %\beginexample% | |
667 %(add-hook 'diary-display-hook 'fancy-diary-display) | |
668 %\endexample | |
669 % | |
670 and in your \kbd{~/diary} file add | |
671 | |
672 \beginexample% | |
673 \&\%\%(org-diary) | |
674 \endexample | |
675 | |
676 to include all the files listed in \kbd{org-agenda-files}. For more | |
677 selective file inclusion use a line for each file: | |
678 | |
679 \beginexample% | |
680 \&\%\%(org-diary) ~/path/to/some/org-file.org | |
681 \endexample | |
682 | |
683 \section{Remember-mode Integration} | |
684 | |
685 See the manual for how to make remember.el use Org-mode links and | |
686 files. The note-finishing command \kbd{C-c C-c} will first prompt for | |
687 an org file. In the file, find a location with: | |
688 | |
689 \key{rotate subtree visibility}{TAB} | |
690 \key{next heading}{DOWN} | |
691 \key{previous heading}{UP} | |
692 | |
693 Insert the note with one of the following: | |
694 | |
695 \key{as sublevel of heading at cursor}{RET} | |
696 \key{right here (cursor not on heading)}{RET} | |
697 \key{before current heading}{LEFT} | |
698 \key{after current heading}{RIGHT} | |
699 \key{shortcut to end of buffer (cursor at buf-start)}{RET} | |
700 \key{Abort}{q} | |
701 | |
702 \section{CUA and pc-select compatibility} | |
703 | |
704 Configure the variable {\tt org-CUA-compatibility} to make Org-mode | |
705 avoid the \kbd{S-<cursor>} bindings used by these modes. When set, | |
706 Org-mode will change the following keybindings (also in the agenda | |
707 buffer, but not during date selection). See note mark four$^4$ | |
708 throughout the reference card. | |
709 %\vskip-mm | |
710 \beginexample | |
711 S-UP $\to$ M-p S-DOWN $\to$ M-n | |
712 S-LEFT $\to$ M-- S-RIGHT $\to$ M-+ | |
713 S-RET $\to$ C-S-RET | |
714 \endexample | |
715 | |
716 \section{Notes} | |
717 $^1$ The six autoload forms are only needed if Org-mode is not part of | |
718 Emacs, or an XEmacs package. | |
719 | |
720 $^2$ This is only a suggestion for a binding of this command. Choose | |
721 you own key as shown under INSTALLATION. | |
722 | |
723 $^3$ After changing a \kbd{\#+KEYWORD} line, press \kbd{C-c C-c} with | |
724 the cursor still in a line to make Org-mode notice the change. | |
725 | |
726 $^4$ Keybinding affected by {\tt org-CUA-compatibility}. | |
727 | |
728 \copyrightnotice | |
729 | |
730 \bye | |
731 | |
732 % Local variables: | |
733 % compile-command: "tex ord-mode-ref" | |
734 % TeX-master: t | |
735 % End: |