diff options
| author | Glenn Morris | 2007-02-22 04:24:52 +0000 |
|---|---|---|
| committer | Glenn Morris | 2007-02-22 04:24:52 +0000 |
| commit | 6f4632925ee37fc07b1cba2d3a3e08042ae39c04 (patch) | |
| tree | 7cad872041b789b354f7dab42fd9268e6b5e30ba | |
| parent | 9be91f0f453e75f083ba111e10998de87a470d4d (diff) | |
| download | emacs-6f4632925ee37fc07b1cba2d3a3e08042ae39c04.tar.gz emacs-6f4632925ee37fc07b1cba2d3a3e08042ae39c04.zip | |
Restore deleted file following copyright assignment.
| -rw-r--r-- | etc/orgcard.tex | 752 |
1 files changed, 752 insertions, 0 deletions
diff --git a/etc/orgcard.tex b/etc/orgcard.tex new file mode 100644 index 00000000000..3cd90c474e4 --- /dev/null +++ b/etc/orgcard.tex | |||
| @@ -0,0 +1,752 @@ | |||
| 1 | % Reference Card for Org Mode | ||
| 2 | \def\orgversionnumber{4.56} | ||
| 3 | \def\versionyear{2006} % latest update | ||
| 4 | \def\year{2007} % latest copyright year | ||
| 5 | % | ||
| 6 | %**start of header | ||
| 7 | \newcount\columnsperpage | ||
| 8 | |||
| 9 | % This file can be printed with 1, 2, or 3 columns per page (see below). | ||
| 10 | % At the moment this card works quite nicely in 3 column format and | ||
| 11 | % currently takes 2 full pages. It is thus suited to producing one | ||
| 12 | % double-side page when printed. | ||
| 13 | |||
| 14 | % There are a couple of tweaks in the format of this card which make it work | ||
| 15 | % slightly better on A4 paper. The changes due, I think, to Stephen Eglen, | ||
| 16 | % are commented below. Revert the changes if you want letter sized paper. | ||
| 17 | |||
| 18 | % Try running something like | ||
| 19 | % tex org-mode-ref.tex; dvips -t landscape org-mode-ref.dvi | ||
| 20 | % to print the card | ||
| 21 | |||
| 22 | \columnsperpage=3 | ||
| 23 | |||
| 24 | % Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc. | ||
| 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 | % the Free Software Foundation; either version 2, or (at your option) | ||
| 29 | % any later version. | ||
| 30 | |||
| 31 | % GNU Emacs is distributed in the hope that it will be useful, | ||
| 32 | % but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 33 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 34 | % GNU General Public License for more details. | ||
| 35 | |||
| 36 | % You should have received a copy of the GNU General Public License | ||
| 37 | % along with GNU Emacs; see the file COPYING. If not, write to | ||
| 38 | % the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | ||
| 39 | % Boston, MA 02111-1307, USA. | ||
| 40 | |||
| 41 | % This file is intended to be processed by plain TeX (TeX82). | ||
| 42 | % | ||
| 43 | % The final reference card has six columns, three on each side. | ||
| 44 | % This file can be used to produce it in any of three ways: | ||
| 45 | % 1 column per page | ||
| 46 | % produces six separate pages, each of which needs to be reduced to 80%. | ||
| 47 | % This gives the best resolution. | ||
| 48 | % 2 columns per page | ||
| 49 | % produces three already-reduced pages. | ||
| 50 | % You will still need to cut and paste. | ||
| 51 | % 3 columns per page | ||
| 52 | % produces two pages which must be printed sideways to make a | ||
| 53 | % ready-to-use 8.5 x 11 inch reference card. | ||
| 54 | % For this you need a dvi device driver that can print sideways. | ||
| 55 | % Which mode to use is controlled by setting \columnsperpage above. | ||
| 56 | % | ||
| 57 | % Author: | ||
| 58 | % Stephen Gildea | ||
| 59 | % Internet: gildea@stop.mail-abuse.org | ||
| 60 | % | ||
| 61 | % Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik | ||
| 62 | % for their many good ideas. | ||
| 63 | |||
| 64 | \def\shortcopyrightnotice{\vskip 1ex plus 2 fill | ||
| 65 | \centerline{\small \copyright\ \year\ 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{}, \versionyear} | ||
| 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 | \vskip -1mm | ||
| 274 | \beginexample% | ||
| 275 | (add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode)) | ||
| 276 | (define-key global-map "\\C-cl" 'org-store-link)$^1$ | ||
| 277 | (define-key global-map "\\C-ca" 'org-agenda)$^1$ | ||
| 278 | \endexample | ||
| 279 | % | ||
| 280 | \metax{For the many customization options try}{M-x org-customize} | ||
| 281 | \metax{To read the on-line documentation try}{M-x org-info} | ||
| 282 | |||
| 283 | \section{Visibility Cycling} | ||
| 284 | |||
| 285 | \key{rotate current subtree between states}{TAB} | ||
| 286 | \key{rotate entire buffer between states}{S-TAB} | ||
| 287 | \key{show the whole file}{C-c C-a} | ||
| 288 | \key{reveal context around point}{C-c C-r} | ||
| 289 | %\key{show branches}{C-c C-k} | ||
| 290 | |||
| 291 | \section{Motion} | ||
| 292 | |||
| 293 | \key{next/previous heading}{C-c C-n/p} | ||
| 294 | \key{next/previous heading, same level}{C-c C-f/b} | ||
| 295 | \key{backward to higher level heading}{C-c C-u} | ||
| 296 | \key{jump to another place in document}{C-c C-j} | ||
| 297 | \key{previous/next plain list item}{S-UP/DOWN$^3$} | ||
| 298 | |||
| 299 | \section{Structure Editing} | ||
| 300 | |||
| 301 | \key{insert new heading/item at current level}{M-RET} | ||
| 302 | \key{insert new TODO entry/checkbox item}{M-S-RET} | ||
| 303 | |||
| 304 | \key{promote current heading up one level}{M-LEFT} | ||
| 305 | \key{demote current heading down one level}{M-RIGHT} | ||
| 306 | \key{promote current subtree up one level}{M-S-LEFT} | ||
| 307 | \key{demote current subtree down one level}{M-S-RIGHT} | ||
| 308 | |||
| 309 | \key{move subtree/list item up/down}{M-S-UP/DOWN} | ||
| 310 | \key{kill subtree}{C-c C-x C-w} | ||
| 311 | \key{copy subtree}{C-c C-x M-w} | ||
| 312 | \key{yank subtree}{C-c C-x C-y} | ||
| 313 | \key{narrow buffer to current subtree}{C-x n s} | ||
| 314 | |||
| 315 | \section{Archiving} | ||
| 316 | |||
| 317 | \key{toggle ARCHIVE tag}{C-c C-x C-a} | ||
| 318 | \metax{mark fully done children}{C-u C-c C-x C-a} | ||
| 319 | \key{force cycling of an ARCHIVEd tree}{C-TAB} | ||
| 320 | \key{move subtree to archive file}{C-c \$} | ||
| 321 | \key{move all fully done children}{C-u C-c \$} | ||
| 322 | To set archive location for current file, add a line like$^2$: | ||
| 323 | \vskip -1mm | ||
| 324 | \beginexample% | ||
| 325 | \#+ARCHIVE: archfile::* Archived Tasks | ||
| 326 | \endexample | ||
| 327 | |||
| 328 | \section{Filtering and Sparse Trees} | ||
| 329 | |||
| 330 | \key{show sparse tree for all matches of a regexp}{C-c /} | ||
| 331 | \key{view TODO's in sparse tree}{C-c C-v} | ||
| 332 | \key{global TODO list in agenda mode}{C-c t$^1$} | ||
| 333 | \key{create sparse tree with all deadlines due}{C-c C-w} | ||
| 334 | \key{time sorted view of current org file}{C-c a L} | ||
| 335 | %\key{agenda for the week}{C-c a$^1$} | ||
| 336 | %\key{agenda for date at cursor}{C-c C-o} | ||
| 337 | |||
| 338 | \section{Tables} | ||
| 339 | |||
| 340 | {\bf Creating a table} | ||
| 341 | |||
| 342 | %\metax{insert a new Org-mode table}{M-x org-table-create} | ||
| 343 | \metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB} | ||
| 344 | \key{convert region to table}{C-c |} | ||
| 345 | \key{... separator at least 3 spaces}{C-3 C-c |} | ||
| 346 | |||
| 347 | {\bf Commands available inside tables} | ||
| 348 | |||
| 349 | The following commands work when the cursor is {\it inside a table}. | ||
| 350 | Outside of tables, the same keys may have other functionality. | ||
| 351 | |||
| 352 | {\bf Re-aligning and field motion} | ||
| 353 | |||
| 354 | \key{re-align the table without moving the cursor}{C-c C-c} | ||
| 355 | \key{re-align the table, move to next field}{TAB} | ||
| 356 | \key{move to previous field}{S-TAB} | ||
| 357 | \key{re-align the table, move to next row}{RET} | ||
| 358 | |||
| 359 | {\bf Row and column editing} | ||
| 360 | |||
| 361 | \key{move the current column left}{M-LEFT} | ||
| 362 | \key{move the current column right}{M-RIGHT} | ||
| 363 | \key{kill the current column}{M-S-LEFT} | ||
| 364 | \key{insert new column to left of cursor position}{M-S-RIGHT} | ||
| 365 | |||
| 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 | |||
| 374 | {\bf Regions} | ||
| 375 | |||
| 376 | \key{cut rectangular region}{C-c C-x C-w} | ||
| 377 | \key{copy rectangular region}{C-c C-x M-w} | ||
| 378 | \key{paste rectangular region}{C-c C-x C-y} | ||
| 379 | \key{fill paragraph across selected cells}{C-c C-q} | ||
| 380 | |||
| 381 | {\bf Calculations} (in combination with Emacs \kbd{calc} package) | ||
| 382 | |||
| 383 | \key{set and eval column formula}{C-c =} | ||
| 384 | \key{set and eval named-field formula}{C-u C-c =} | ||
| 385 | \key{edit formulas in separate buffer}{C-c '} | ||
| 386 | \key{re-apply all stored equations to current line}{C-c *} | ||
| 387 | \key{re-apply all stored equations to entire table}{C-u C-c *} | ||
| 388 | |||
| 389 | %\kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation | ||
| 390 | %in lines starting with: {\tt | \# |}. | ||
| 391 | |||
| 392 | \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#} | ||
| 393 | |||
| 394 | \key{display column number cursor is in}{C-c ?} | ||
| 395 | \key{sum numbers in current column/rectangle}{C-c +} | ||
| 396 | \key{copy down with increment}{S-RET$^3$} | ||
| 397 | |||
| 398 | Formulas typed in field are executed by \kbd{TAB}, | ||
| 399 | \kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column | ||
| 400 | formula, \kbd{:=} a named-field formula. | ||
| 401 | |||
| 402 | \key{Example: Add Col1 and Col2}{=\$1+\$2} | ||
| 403 | \key{... with printf format specification}{=\$1+\$2;\%.2f} | ||
| 404 | \key{... with constants from constants.el}{=\$1/\$c/\$cm} | ||
| 405 | \key{sum from 3rd hline above to here}{:=vsum(\&III)} | ||
| 406 | \key{apply current column formula}{=} | ||
| 407 | |||
| 408 | {\bf Miscellaneous} | ||
| 409 | |||
| 410 | \key{to limit column width to \kbd{N} characters, use}{...| <N> |...} | ||
| 411 | \key{edit the current field in a separate window}{C-c `} | ||
| 412 | \key{make current field fully visible}{C-u TAB} | ||
| 413 | \metax{export as tab-separated file}{M-x org-table-export} | ||
| 414 | \metax{import tab-separated file}{M-x org-table-import} | ||
| 415 | |||
| 416 | {\bf Tables created with the \kbd{table.el} package} | ||
| 417 | |||
| 418 | \key{insert a new \kbd{table.el} table}{C-c ~} | ||
| 419 | \key{recognize existing table.el table}{C-c C-c} | ||
| 420 | \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~} | ||
| 421 | |||
| 422 | \section{Links} | ||
| 423 | |||
| 424 | \key{globally store link to the current location}{C-c l$^1$} | ||
| 425 | \key{insert a link (TAB completes stored links)}{C-c C-l} | ||
| 426 | \key{insert file link with file name completion}{C-u C-c C-l} | ||
| 427 | \key{edit (also hidden part of) link at point}{C-c C-l} | ||
| 428 | |||
| 429 | \key{open file links in emacs}{C-c C-o} | ||
| 430 | \key{...force open in emacs/other window}{C-u C-c C-o} | ||
| 431 | \key{open link at point}{mouse-1/2} | ||
| 432 | \key{...force open in emacs/other window}{mouse-3} | ||
| 433 | \key{record a position in mark ring}{C-c \%} | ||
| 434 | \key{jump back to last followed link(s)}{C-c \&} | ||
| 435 | |||
| 436 | {\bf Internal Links} | ||
| 437 | |||
| 438 | \key{\kbd{<<My Target>>}}{\rm target} | ||
| 439 | \key{\kbd{<<<My Target>>>}}{\rm radio target$^2$} | ||
| 440 | \key{\kbd{[[*this text]]}}{\rm find headline} | ||
| 441 | \metax{\kbd{[[this text]]}}{\rm find target or text in buffer} | ||
| 442 | \metax{\kbd{[[this text][description]]}}{\rm optional link text} | ||
| 443 | |||
| 444 | {\bf External Links} | ||
| 445 | |||
| 446 | \key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute} | ||
| 447 | \key{\kbd{file:papers/last.pdf}}{\rm file, relative} | ||
| 448 | \key{\kbd{file:projects.org::*that text}}{\rm find headline} | ||
| 449 | \key{\kbd{file:projects.org::find me}}{\rm find trgt/string} | ||
| 450 | %\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search} | ||
| 451 | \key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web} | ||
| 452 | \key{\kbd{mailto:adent@galaxy.net}}{\rm Email address} | ||
| 453 | \key{\kbd{news:comp.emacs}}{\rm Usenet group} | ||
| 454 | \key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person} | ||
| 455 | \key{\kbd{gnus:group}}{\rm GNUS group} | ||
| 456 | \key{\kbd{gnus:group\#id}}{\rm GNUS message} | ||
| 457 | \key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder} | ||
| 458 | \key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message} | ||
| 459 | \key{\kbd{info:emacs:Regexps}}{\rm Info file:node} | ||
| 460 | \key{\kbd{shell:ls *.org}}{\rm shell command} | ||
| 461 | \key{\kbd{elisp:(calendar)}}{\rm elisp form} | ||
| 462 | \metax{\kbd{[[external link][description]]}}{\rm optional link text} | ||
| 463 | %\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote} | ||
| 464 | |||
| 465 | |||
| 466 | \section{Remember-mode Integration} | ||
| 467 | |||
| 468 | See the manual for how to make remember.el use Org-mode links and | ||
| 469 | files. The note-finishing command \kbd{C-c C-c} will first prompt for | ||
| 470 | an org file. In the file, find a location with: | ||
| 471 | |||
| 472 | \key{rotate subtree visibility}{TAB} | ||
| 473 | \key{next heading}{DOWN} | ||
| 474 | \key{previous heading}{UP} | ||
| 475 | |||
| 476 | Insert the note with one of the following: | ||
| 477 | |||
| 478 | \key{as sublevel of heading at cursor}{RET} | ||
| 479 | \key{right here (cursor not on heading)}{RET} | ||
| 480 | \key{before current heading}{LEFT} | ||
| 481 | \key{after current heading}{RIGHT} | ||
| 482 | \key{shortcut to end of buffer (cursor at buf-start)}{RET} | ||
| 483 | \key{Abort}{q} | ||
| 484 | |||
| 485 | \section{Completion} | ||
| 486 | |||
| 487 | In-buffer completion completes TODO keywords at headline start, TeX | ||
| 488 | macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS | ||
| 489 | after ``{\tt :}'', and dictionary words elsewhere. | ||
| 490 | |||
| 491 | \key{Complete word at point}{M-TAB} | ||
| 492 | |||
| 493 | |||
| 494 | \newcolumn | ||
| 495 | \title{Org-Mode Reference Card (2/2)} | ||
| 496 | |||
| 497 | \centerline{(for version \orgversionnumber)} | ||
| 498 | |||
| 499 | \section{TODO Items and Checkboxes} | ||
| 500 | |||
| 501 | \key{rotate the state of the current item}{C-c C-t} | ||
| 502 | \key{view TODO items in a sparse tree}{C-c C-v} | ||
| 503 | \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v} | ||
| 504 | |||
| 505 | \key{set the priority of the current item}{C-c , [ABC]} | ||
| 506 | \key{remove priority cookie from current item}{C-c , SPC} | ||
| 507 | \key{raise priority of current item}{S-UP$^3$} | ||
| 508 | \key{lower priority of current item}{S-DOWN$^3$} | ||
| 509 | |||
| 510 | \key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow} | ||
| 511 | \key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types} | ||
| 512 | |||
| 513 | \key{insert new checkbox item in plain list}{M-S-RET} | ||
| 514 | \key{toggle checkbox(es) in region/entry/at point}{C-c C-x C-b} | ||
| 515 | \key{toggle checkbox at point}{C-c C-c} | ||
| 516 | \metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{} | ||
| 517 | \key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#} | ||
| 518 | |||
| 519 | \section{Tags} | ||
| 520 | |||
| 521 | \key{set tags for current heading}{C-c C-c} | ||
| 522 | \key{realign tags in all headings}{C-u C-c C-c} | ||
| 523 | \key{create sparse tree with matching tags}{C-c \\} | ||
| 524 | \key{globally (agenda) match tags at cursor}{C-c C-o} | ||
| 525 | |||
| 526 | \section{Timestamps} | ||
| 527 | |||
| 528 | \key{prompt for date and insert timestamp}{C-c .} | ||
| 529 | \key{like \kbd{C-c} . but insert date and time format}{C-u C-c .} | ||
| 530 | \key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME | ||
| 531 | \key{insert DEADLINE timestamp}{C-c C-d} | ||
| 532 | \key{insert SCHEDULED timestamp}{C-c C-s} | ||
| 533 | \key{create sparse tree with all deadlines due}{C-c C-w} | ||
| 534 | \key{the time between 2 dates in a time range}{C-c C-y} | ||
| 535 | \key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$} | ||
| 536 | \key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$} | ||
| 537 | \key{access the calendar for the current date}{C-c >} | ||
| 538 | \key{insert timestamp matching date in calendar}{C-c <} | ||
| 539 | \key{access agenda for current date}{C-c C-o} | ||
| 540 | \key{Select date while prompted}{mouse-1/RET} | ||
| 541 | %\key{... select date in calendar}{mouse-1/RET} | ||
| 542 | %\key{... scroll calendar back/forward one month}{< / >} | ||
| 543 | %\key{... forward/backward one day}{S-LEFT/RIGHT} | ||
| 544 | %\key{... forward/backward one week}{S-UP/DOWN} | ||
| 545 | %\key{... forward/backward one month}{M-S-LEFT/RIGT} | ||
| 546 | \key{Toggle custom format display for dates/times}{C-c C-x C-t} | ||
| 547 | |||
| 548 | |||
| 549 | \section{Clocking Time} | ||
| 550 | |||
| 551 | \key{start clock on current item}{C-c C-x C-i} | ||
| 552 | \key{stop clock on current item}{C-c C-x C-o} | ||
| 553 | \key{cancel current clock}{C-c C-x C-x} | ||
| 554 | |||
| 555 | \key{display total subtree times}{C-c C-x C-d} | ||
| 556 | \key{remove displayed times}{C-c C-c} | ||
| 557 | \key{insert/update table with clock report}{C-c C-x C-r} | ||
| 558 | |||
| 559 | \section{LaTeX and cdlatex-mode} | ||
| 560 | |||
| 561 | \key{preview LaTeX fragment}{C-c C-x C-l} | ||
| 562 | \key{Expand abbreviation (cdlatex-mode)}{TAB} | ||
| 563 | \key{Insert/modify math symbol (cdlatex-mode)}{` / '} | ||
| 564 | |||
| 565 | \section{Agenda Views} | ||
| 566 | |||
| 567 | \key{add/move current file to front of agenda}{C-c [} | ||
| 568 | \key{remove current file from your agenda}{C-c ]} | ||
| 569 | \key{cycle through agenda file list}{C-,} | ||
| 570 | |||
| 571 | \key{compile agenda for the current week}{C-c a a$^1$} | ||
| 572 | \key{compile global TODO list}{C-c a t$^1$} | ||
| 573 | \key{compile TODO list for specific keyword}{C-c a T$^1$} | ||
| 574 | \key{match tags in agenda files}{C-c a m$^1$} | ||
| 575 | \key{match tags in TODO entries}{C-c a M$^1$} | ||
| 576 | \key{show timeline of current org file}{C-c a L$^1$} | ||
| 577 | \key{configure custom commands}{C-c a C$^1$} | ||
| 578 | \key{agenda for date at cursor}{C-c C-o} | ||
| 579 | |||
| 580 | \vskip 1mm | ||
| 581 | To set categories, add lines like$^2$: | ||
| 582 | \vskip -1mm | ||
| 583 | \beginexample% | ||
| 584 | \#+CATEGORY: MyCateg | ||
| 585 | \endexample | ||
| 586 | |||
| 587 | {\bf Commands available in an agenda buffer} | ||
| 588 | |||
| 589 | {\bf View Org file} | ||
| 590 | |||
| 591 | \key{show original location of item}{SPC/mouse-3} | ||
| 592 | %\key{... also available with}{mouse-3} | ||
| 593 | \key{show and recenter window}{L} | ||
| 594 | \key{goto original location in other window}{TAB/mouse-2} | ||
| 595 | %\key{... also available with}{mouse-2} | ||
| 596 | \key{goto original location, delete other windows}{RET} | ||
| 597 | \key{toggle follow-mode}{f} | ||
| 598 | |||
| 599 | {\bf Change display} | ||
| 600 | |||
| 601 | \key{delete other windows}{o} | ||
| 602 | \key{switch to daily / weekly view}{d / w} | ||
| 603 | \key{toggle inclusion of diary entries}{D} | ||
| 604 | \key{toggle time grid for daily schedule}{g} | ||
| 605 | \key{toggle display of logbook entries}{l} | ||
| 606 | \key{refresh agenda buffer with any changes}{r} | ||
| 607 | \key{save all org-mode buffers}{s} | ||
| 608 | \key{display the following \kbd{org-agenda-ndays}}{RIGHT} | ||
| 609 | \key{display the previous \kbd{org-agenda-ndays}}{LEFT} | ||
| 610 | \key{goto today}{.} | ||
| 611 | |||
| 612 | {\bf Remote editing} | ||
| 613 | |||
| 614 | \key{digit argument}{0-9} | ||
| 615 | \key{change state of current TODO item}{t} | ||
| 616 | \key{kill item and source}{C-k} | ||
| 617 | \key{show tags of current headline}{T} | ||
| 618 | \key{set tags for current headline}{:} | ||
| 619 | \key{toggle ARCHIVE tag}{a} | ||
| 620 | \key{set priority of current item}{p} | ||
| 621 | \key{raise/lower priority of current item}{S-UP/DOWN$^3$} | ||
| 622 | \key{display weighted priority of current item}{P} | ||
| 623 | \key{schedule/set deadline for this item}{C-c C-s/d} | ||
| 624 | \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$} | ||
| 625 | \key{change timestamp to today}{>} | ||
| 626 | \key{insert new entry into diary}{i} | ||
| 627 | |||
| 628 | \key{Start the clock on current item (clock-in)}{I} | ||
| 629 | \key{Stop the clock (clock-out)}{O} | ||
| 630 | \key{Cancel current clock}{X} | ||
| 631 | |||
| 632 | |||
| 633 | {\bf Calendar commands} | ||
| 634 | |||
| 635 | \key{find agenda cursor date in calendar}{c} | ||
| 636 | \key{compute agenda for calendar cursor date}{c} | ||
| 637 | \key{show phases of the moon}{M} | ||
| 638 | \key{show sunrise/sunset times}{S} | ||
| 639 | \key{show holidays}{H} | ||
| 640 | \key{convert date to other calendars}{C} | ||
| 641 | |||
| 642 | {\bf Quit and Exit} | ||
| 643 | |||
| 644 | \key{quit agenda, remove agenda buffer}{q} | ||
| 645 | \key{exit agenda, remove all agenda buffers}{x} | ||
| 646 | |||
| 647 | \section{Calendar and Diary Integration} | ||
| 648 | |||
| 649 | Include Emacs diary entries into Org-mode agenda with: | ||
| 650 | \beginexample% | ||
| 651 | (setq org-agenda-include-diary t) | ||
| 652 | \endexample | ||
| 653 | |||
| 654 | \section{Exporting and Publishing} | ||
| 655 | |||
| 656 | Exporting creates files with extensions {\it .txt\/} and {\it .html\/} | ||
| 657 | in the current directory. Publishing puts the resulting file into | ||
| 658 | some other place. | ||
| 659 | |||
| 660 | \key{export/publish dispatcher}{C-c C-e} | ||
| 661 | |||
| 662 | \key{export visible part only}{C-c C-e v} | ||
| 663 | \key{insert template of export options}{C-c C-x t} | ||
| 664 | \key{toggle fixed width for entry or region}{C-c :} | ||
| 665 | |||
| 666 | {\bf HTML formatting} | ||
| 667 | |||
| 668 | \key{make words {\bf bold}}{*bold*} | ||
| 669 | \key{make words {\it italic}}{/italic/} | ||
| 670 | \key{make words \underbar{underlined}}{_underlined_} | ||
| 671 | \key{sub- and superscripts}{x\^{}3, J_dust} | ||
| 672 | \key{\TeX{}-like macros}{\\alpha, \\to} | ||
| 673 | \key{typeset lines in fixed width font}{start with :} | ||
| 674 | \key{tables are exported as HTML tables}{start with |} | ||
| 675 | \key{links become HTML links}{http:... etc} | ||
| 676 | \key{include html tags}{@<b>...@</b>} | ||
| 677 | |||
| 678 | {\bf Export options} | ||
| 679 | |||
| 680 | Include additional information for export by putting these anywhere in the | ||
| 681 | org file. Use {\tt M-TAB} completion to make sure to get the right | ||
| 682 | keywords. {\tt M-TAB} again just after keyword is complete inserts examples. | ||
| 683 | |||
| 684 | \key{the title to be shown}{\#+TITLE:} | ||
| 685 | \key{the author}{\#+AUTHOR:} | ||
| 686 | \key{authors email address}{\#+EMAIL:} | ||
| 687 | \key{language code for html}{\#+LANGUAGE:} | ||
| 688 | \key{free text description of file}{\#+TEXT:} | ||
| 689 | \key{... which can carry over multiple lines}{\#+TEXT:} | ||
| 690 | %\key{settings for the export process - see below}{\#+OPTIONS:} | ||
| 691 | \key{settings for the export process}{\#+OPTIONS:} | ||
| 692 | |||
| 693 | %\key{set number of headline levels for export}{H:2} | ||
| 694 | %\key{turn on/off section numbers}{num:t} | ||
| 695 | %\key{turn on/off table of contents}{toc:t} | ||
| 696 | %\key{turn on/off linebreak preservation}{\\n:nil} | ||
| 697 | %\key{turn on/off quoted html tags}{@:t} | ||
| 698 | %\key{turn on/off fixed width sections}{::t} | ||
| 699 | %\key{turn on/off tables}{|:t} | ||
| 700 | %\key{turn on/off \TeX\ syntax for sub/super-scripts}{\^{}:t} | ||
| 701 | %\key{turn on/off emphasised text}{*:nil} | ||
| 702 | %\key{turn on/off \TeX\ macros}{TeX:t} | ||
| 703 | |||
| 704 | {\bf Comments: Text not being exported} | ||
| 705 | |||
| 706 | Text before the first headline is not considered part of the document | ||
| 707 | and is therefore never exported. | ||
| 708 | Lines starting with \kbd{\#} are comments and are not exported. | ||
| 709 | Subtrees whose header starts with COMMENT are never exported. | ||
| 710 | |||
| 711 | \key{toggle COMMENT keyword on entry}{C-c ;} | ||
| 712 | |||
| 713 | |||
| 714 | %\section{CUA and pc-select compatibility}% | ||
| 715 | |||
| 716 | %Configure the variable {\tt org-CUA-compatibility} to make Org-mode | ||
| 717 | %avoid the \kbd{S-<cursor>} bindings used by these modes. When set, | ||
| 718 | %Org-mode will change the following keybindings (also in the agenda | ||
| 719 | %buffer, but not during date selection). See note mark four$^3$ | ||
| 720 | %throughout the reference card. | ||
| 721 | %%\vskip-mm | ||
| 722 | %\beginexample | ||
| 723 | %S-UP $\to$ M-p S-DOWN $\to$ M-n | ||
| 724 | %S-LEFT $\to$ M-- S-RIGHT $\to$ M-+ | ||
| 725 | %S-RET $\to$ C-S-RET | ||
| 726 | %\endexample | ||
| 727 | |||
| 728 | \section{Dynamic Blocks} | ||
| 729 | |||
| 730 | \key{update dynamic block at point}{C-c C-x C-u} | ||
| 731 | \metax{update all dynamic blocks}{C-u C-c C-x C-u} | ||
| 732 | |||
| 733 | \section{Notes} | ||
| 734 | $^1$ This is only a suggestion for a binding of this command. Choose | ||
| 735 | you own key as shown under INSTALLATION. | ||
| 736 | |||
| 737 | $^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line, | ||
| 738 | press \kbd{C-c C-c} with the cursor still in the line to update. | ||
| 739 | |||
| 740 | $^3$ Keybinding affected by {\tt org-CUA-compatibility}. | ||
| 741 | |||
| 742 | \copyrightnotice | ||
| 743 | |||
| 744 | \bye | ||
| 745 | |||
| 746 | |||
| 747 | % arch-tag: 139f6750-5cfc-49ca-92b5-237fe5795290 | ||
| 748 | |||
| 749 | %%% Local Variables: | ||
| 750 | %%% mode: latex | ||
| 751 | %%% TeX-master: t | ||
| 752 | %%% End: | ||