doc/orgcard.txt

   1 ================================================================================
   2 Org-Mode Reference Card (for version 6.10)
   3 ================================================================================
   4
   5 ================================================================================
   6 Getting Started
   7 ================================================================================
   8
   9 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
  10 (define-key global-map "\C-cl" 'org-store-link) [1]
  11 (define-key global-map "\C-ca" 'org-agenda) [1]
  12
  13 For the many customization options try            M-x org-customize
  14 To read the on-line documentation try             M-x org-info
  15
  16 ================================================================================
  17 Visibility Cycling
  18 ================================================================================
  19
  20 rotate current subtree between states             TAB
  21 rotate entire buffer between states               S-TAB
  22 restore property-dependent startup visibility     C-u C-u TAB
  23 show the whole file, including drawers            C-u C-u C-u TAB
  24 reveal context around point                       C-c C-r
  25
  26 ================================================================================
  27 Motion
  28 ================================================================================
  29
  30 next/previous heading                             C-c C-n/p
  31 next/previous heading, same level                 C-c C-f/b
  32 backward to higher level heading                  C-c C-u
  33 jump to another place in document                 C-c C-j
  34 previous/next plain list item                     S-UP/DOWN [3]
  35
  36 ================================================================================
  37 Structure Editing
  38 ================================================================================
  39
  40 insert new heading/item at current level          M-RET
  41 insert new heading after subtree                  C-RET
  42 insert new TODO entry/checkbox item               M-S-RET
  43 insert TODO entry/ckbx after subtree              C-S-RET
  44 promote/demote current heading up one level       M-LEFT/RIGHT
  45 promote/demote current subtree up one level       M-S-LEFT/RIGHT
  46 move subtree/list item up/down                    M-S-UP/DOWN
  47 refile subtree                                    C-c C-w
  48 kill subtree                                      C-c C-x C-w
  49 copy subtree                                      C-c C-x M-w
  50 yank subtree                                      C-c C-x C-y
  51 narrow buffer to current subtree                  C-x n s
  52 widen restriction to full buffer                  C-x n w
  53
  54 ================================================================================
  55 Archiving
  56 ================================================================================
  57
  58 toggle ARCHIVE tag                                C-c C-x C-a
  59 force cycling of an ARCHIVEd tree                 C-TAB
  60 move subtree to archive file                      C-c C-x C-s
  61
  62 ================================================================================
  63 Filtering and Sparse Trees
  64 ================================================================================
  65
  66 construct a sparse tree by various criteria       C-c /
  67 view TODO's in sparse tree                        C-c C-v
  68 global TODO list in agenda mode                   C-c a t [1]
  69 time sorted view of current org file              C-c a L
  70
  71 ================================================================================
  72 Tables
  73 ================================================================================
  74
  75 --------------------------------------------------------------------------------
  76 Creating a table
  77 --------------------------------------------------------------------------------
  78
  79 just start typing, e.g.                           |Name|Phone|Age RET |- TAB
  80 convert region to table                           C-c |
  81 ... separator at least 3 spaces                   C-3 C-c |
  82
  83 --------------------------------------------------------------------------------
  84 Commands available inside tables
  85 --------------------------------------------------------------------------------
  86
  87 The following commands work when the cursor is inside a table.  Outside of
  88 tables, the same keys may have other functionality.
  89
  90 --------------------------------------------------------------------------------
  91 Re-aligning and field motion
  92 --------------------------------------------------------------------------------
  93
  94 re-align the table without moving the cursor      C-c C-c
  95 re-align the table, move to next field            TAB
  96 move to previous field                            S-TAB
  97 re-align the table, move to next row              RET
  98
  99 --------------------------------------------------------------------------------
 100 Row and column editing
 101 --------------------------------------------------------------------------------
 102
 103 move the current column left                      M-LEFT/RIGHT
 104 kill the current column                           M-S-LEFT
 105 insert new column to left of cursor position      M-S-RIGHT
 106 move the current row up/down                      M-UP/DOWN
 107 kill the current row or horizontal line           M-S-UP
 108 insert new row above the current row              M-S-DOWN
 109 insert hline below (C-u : above) current row      C-c -
 110 sort lines in region                              C-c ^
 111
 112 --------------------------------------------------------------------------------
 113 Regions
 114 --------------------------------------------------------------------------------
 115
 116 cut rectangular region                            C-c C-x C-w
 117 copy rectangular region                           C-c C-x M-w
 118 paste rectangular region                          C-c C-x C-y
 119 fill paragraph across selected cells              C-c C-q
 120
 121 --------------------------------------------------------------------------------
 122 Miscellaneous
 123 --------------------------------------------------------------------------------
 124
 125 to limit column width to N characters, use        ...| <N> |...
 126 edit the current field in a separate window       C-c `
 127 make current field fully visible                  C-u TAB
 128 export as tab-separated file                      M-x org-table-export
 129 import tab-separated file                         M-x org-table-import
 130 sum numbers in current column/rectangle           C-c +
 131
 132 --------------------------------------------------------------------------------
 133 Tables created with the table.el package
 134 --------------------------------------------------------------------------------
 135
 136 insert a new table.el table                       C-c ~
 137 recognize existing table.el table                 C-c C-c
 138 convert table (Org-mode <-> table.el)             C-c ~
 139
 140 --------------------------------------------------------------------------------
 141 Spreadsheet
 142 --------------------------------------------------------------------------------
 143
 144 Formulas typed in field are executed by TAB, RET and C-c C-c.  = introduces a
 145 column formula, := a field formula.
 146
 147 Example: Add Col1 and Col2                        |=$1+$2 |
 148 ... with printf format specification              |=$1+$2;%.2f|
 149 ... with constants from constants.el              |=$1/$c/$cm |
 150 sum from 2nd to 3rd hline                         |:=vsum(@II..@III)|
 151 apply current column formula                      | = |
 152 set and eval column formula                       C-c =
 153 set and eval field formula                        C-u C-c =
 154 re-apply all stored equations to current line     C-c *
 155 re-apply all stored equations to entire table     C-u C-c *
 156 iterate table to stability                        C-u C-u C-c *
 157 rotate calculation mark through # * ! $           C-#
 158 show line, column, formula reference              C-c ?
 159 toggle coordinate grid                            C-c }
 160 toggle formula debugger                           C-c {
 161
 162 --------------------------------------------------------------------------------
 163 Formula Editor
 164 --------------------------------------------------------------------------------
 165
 166 edit formulas in separate buffer                  C-c '
 167 exit and install new formulas                     C-c C-c
 168 exit, install, and apply new formulas             C-u C-c C-c
 169 abort                                             C-c C-q
 170 toggle reference style                            C-c C-r
 171 pretty-print Lisp formula                         TAB
 172 complete Lisp symbol                              M-TAB
 173 shift reference point                             S-cursor
 174 shift test line for column references             M-up/down
 175 scroll the window showing the table               M-S-up/down
 176 toggle table coordinate grid                      C-c }
 177
 178 ================================================================================
 179 Links
 180 ================================================================================
 181
 182 globally store link to the current location       C-c l [1]
 183 insert a link (TAB completes stored links)        C-c C-l
 184 insert file link with file name completion        C-u C-c C-l
 185 edit (also hidden part of) link at point          C-c C-l
 186 open file links in emacs                          C-c C-o
 187 ... force open in emacs/other window              C-u C-c C-o
 188 open link at point                                mouse-1/2
 189 ... force open in emacs/other window              mouse-3
 190 record a position in mark ring                    C-c %
 191 jump back to last followed link(s)                C-c &
 192 find next link                                    C-c C-x C-n
 193 find previous link                                C-c C-x C-p
 194 edit code snippet of file at point                C-c '
 195
 196 --------------------------------------------------------------------------------
 197 Internal Links
 198 --------------------------------------------------------------------------------
 199
 200 <<My Target>>                                     target
 201 <<<My Target>>>                                   radio target [2]
 202 [[*this text]]                                    find headline
 203 [[this text]]                                     find target or text in buffer
 204 [[this text][description]]                        optional link text
 205
 206 --------------------------------------------------------------------------------
 207 External Links
 208 --------------------------------------------------------------------------------
 209
 210 file:/home/dominik/img/mars.jpg                   file, absolute
 211 file:papers/last.pdf                              file, relative
 212 file:projects.org::*that text                     find headline
 213 file:projects.org::find me                        find trgt/string
 214 http://www.astro.uva.nl/dominik                   on the web
 215 mailto:adent@galaxy.net                           Email address
 216 news:comp.emacs                                   Usenet group
 217 bbdb:Richard Stallman                             BBDB person
 218 gnus:group                                        GNUS group
 219 gnus:group#id                                     GNUS message
 220 vm|wl|mhe|rmail:folder                            Mail folder
 221 vm|wl|mhe|rmail:folder#id                         Mail message
 222 info:emacs:Regexps                                Info file:node
 223 shell:ls *.org                                    shell command
 224 elisp:(calendar)                                  elisp form
 225 [[external link][description]]                    optional link text
 226
 227 ================================================================================
 228 Completion
 229 ================================================================================
 230
 231 In-buffer completion completes TODO keywords at headline start, TeX macros
 232 after `\', option keywords after `#-â', TAGS after `:', and dictionary words
 233 elsewhere.
 234
 235 complete word at point                            M-TAB
 236
 237 ================================================================================
 238 TODO Items and Checkboxes
 239 ================================================================================
 240
 241 rotate the state of the current item              C-c C-t
 242 select next/previous state                        S-LEFT/RIGHT
 243 select next/previous set                          C-S-LEFT/RIGHT
 244 view TODO items in a sparse tree                  C-c C-v
 245 view 3rd TODO keyword's sparse tree               C-3 C-c C-v
 246 set the priority of the current item              C-c , [ABC]
 247 remove priority cookie from current item          C-c , SPC
 248 raise/lower priority of current item              S-UP/DOWN [3]
 249 insert new checkbox item in plain list            M-S-RET
 250 toggle checkbox(es) in region/entry/at point      C-c C-x C-b
 251 toggle checkbox at point                          C-c C-c
 252 checkbox statistics cookies                       insert [/] or [%]
 253 update checkbox statistics (C-u : whole file)     C-c #
 254
 255 ================================================================================
 256 Tags
 257 ================================================================================
 258
 259 set tags for current heading                      C-c C-q
 260 realign tags in all headings                      C-u C-c C-q
 261 create sparse tree with matching tags             C-c \
 262 globally (agenda) match tags at cursor            C-c C-o
 263
 264 \section{Properties and Column View}
 265
 266 \key{set property}{C-c C-x p}
 267 \key{special commands in property lines}{C-c C-c}
 268 \key{next/previous allowed value}{S-left/right}
 269 \key{turn on column view}{C-c C-x C-c}
 270 \key{capture columns view in dynamic block}{C-c C-x i}
 271
 272 \key{quit column view}{q}
 273 \key{next/previous allowed value}{S-left/right}
 274 \key{next/previous allowed value}{n / p}
 275 \key{edit value}{e}
 276 \key{edit allowed values list}{a}
 277 \key{show value}{v}
 278 \key{make column wider/narrower}{> / <}
 279 \key{move column left/right}{M-left/right}
 280 \key{add new column}{M-S-right}
 281 \key{Delete current column}{M-S-left}
 282
 283
 284
 285 ================================================================================
 286 Timestamps
 287 ================================================================================
 288
 289 prompt for date and insert timestamp              C-c .
 290 like C-c . but insert date and time format        C-u C-c .
 291 like C-c . but make stamp inactive                C-c !
 292 insert DEADLINE timestamp                         C-c C-d
 293 insert SCHEDULED timestamp                        C-c C-s
 294 create sparse tree with all deadlines due         C-c C-w
 295 the time between 2 dates in a time range          C-c C-y
 296 change timestamp at cursor by ±1 day              S-RIGHT/LEFT [3]
 297 change year/month/day at cursor by ±1             S-UP/DOWN [3]
 298 access the calendar for the current date          C-c >
 299 insert timestamp matching date in calendar        C-c <
 300 access agenda for current date                    C-c C-o
 301 select date while prompted                        mouse-1/RET
 302 toggle custom format display for dates/times      C-c C-x C-t
 303
 304 --------------------------------------------------------------------------------
 305 Clocking time
 306 --------------------------------------------------------------------------------
 307
 308 start clock on current item                       C-c C-x C-i
 309 stop clock on current item                        C-c C-x C-o
 310 cancel current clock                              C-c C-x C-x
 311 display total subtree times                       C-c C-x C-d
 312 remove displayed times                            C-c C-c
 313 insert/update table with clock report             C-c C-x C-r
 314
 315 ================================================================================
 316 Agenda Views
 317 ================================================================================
 318
 319 add/move current file to front of agenda          C-c [
 320 remove current file from your agenda              C-c ]
 321 cycle through agenda file list                    C-'
 322 compile agenda for the current week               C-c a a [1]
 323 compile global TODO list                          C-c a t [1]
 324 compile TODO list for specific keyword            C-c a T [1]
 325 match tags, TODO kwds and properties              C-c a m [1]
 326 match only in TODO entries                        C-c a M [1]
 327 find stuck projects                               C-c a # [1]
 328 show timeline of current org file                 C-c a L [1]
 329 configure custom commands                         C-c a C [1]
 330 configure stuck projects                          C-c a ! [1]
 331 agenda for date at cursor                         C-c C-o
 332
 333 To set categories, add lines like [2]:
 334 #+CATEGORY: MyCateg
 335
 336 --------------------------------------------------------------------------------
 337 Commands available in an agenda buffer
 338 --------------------------------------------------------------------------------
 339
 340 --------------------------------------------------------------------------------
 341 View Org file
 342 --------------------------------------------------------------------------------
 343
 344 show original location of item                    SPC/mouse-3
 345 show and recenter window                          L
 346 goto original location in other window            TAB/mouse-2
 347 goto original location, delete other windows      RET
 348 show subtree in indirect buffer, ded. frame       b
 349 toggle follow-mode                                f
 350
 351 --------------------------------------------------------------------------------
 352 Change display
 353 --------------------------------------------------------------------------------
 354
 355 delete other windows                              o
 356 switch to day/week/month/year view                d/w/m/y
 357 toggle inclusion of diary entries                 D
 358 toggle time grid for daily schedule               G
 359 toggle display of logbook entries                 l
 360 toggle inclusion of archived trees/files          v / C-u v}
 361 refresh agenda buffer with any changes            r / g
 362 filter agenda with repect to a tag                /
 363 save all org-mode buffers                         s
 364 display the next/previous day, week,...           RIGHT/LEFT
 365 goto today                                        .
 366
 367 --------------------------------------------------------------------------------
 368 Remote editing
 369 --------------------------------------------------------------------------------
 370
 371 digit argument                                    0-9
 372 change state of current TODO item                 t
 373 kill item and source                              C-k
 374 archive the subtree (file/tag/sibling)            $ / a / A
 375 show tags of current headline                     T
 376 set tags for current headline                     :
 377 set priority of current item                      p
 378 raise/lower priority of current item              S-UP/DOWN [3]
 379 display weighted priority of current item         P
 380 run an attachment command                         C-c C-a
 381 schedule/set deadline for this item               C-c C-s/d
 382 change timestamp to one day earlier/later         S-LEFT/RIGHT [3]
 383 change timestamp to today                         >
 384 insert new entry into diary                       i
 385 start/stop/cancel the clock in current item       I / O / X
 386 jump to running clock entry                       J
 387
 388
 389 --------------------------------------------------------------------------------
 390 Misc
 391 --------------------------------------------------------------------------------
 392
 393 Open link in current line                         C-c C-o
 394
 395 --------------------------------------------------------------------------------
 396 Calendar commands
 397 --------------------------------------------------------------------------------
 398
 399 find agenda cursor date in calendar               c
 400 compute agenda for calendar cursor date           c
 401 show phases of the moon                           M
 402 show sunrise/sunset times                         S
 403 show holidays                                     H
 404 convert date to other calendars                   C
 405
 406 --------------------------------------------------------------------------------
 407 Quit and Exit
 408 --------------------------------------------------------------------------------
 409
 410 quit agenda, remove agenda buffer                 q
 411 exit agenda, remove all agenda buffers            x
 412
 413 ================================================================================
 414 Calendar and Diary Integration
 415 ================================================================================
 416
 417 Include Emacs diary entries into Org-mode agenda with:
 418 (setq org-agenda-include-diary t)
 419
 420 ================================================================================
 421 LaTeX and cdlatex-mode
 422 ================================================================================
 423
 424 preview LaTeX fragment                            C-c C-x C-l
 425 expand abbreviation (cdlatex-mode)                TAB
 426 insert/modify math symbol (cdlatex-mode)          ` / '
 427
 428 ================================================================================
 429 Exporting and Publishing
 430 ================================================================================
 431
 432 Exporting creates files with extensions .txt and .html in the current
 433 directory.  Publishing puts the resulting file into some other place.
 434
 435 export/publish dispatcher                         C-c C-e
 436 export visible part only                          C-c C-e v
 437 insert template of export options                 C-c C-x t
 438 toggle fixed width for entry or region            C-c :
 439
 440 --------------------------------------------------------------------------------
 441 Comments: Text not being exported
 442 --------------------------------------------------------------------------------
 443
 444 Text before the first headline is not considered part of the document and is
 445 therefore never exported.  Lines starting with # are comments and are not
 446 exported.  Subtrees whose header starts with COMMENT are never exported.
 447
 448 toggle COMMENT keyword on entry                   C-c ;
 449
 450 ================================================================================
 451 Dynamic Blocks
 452 ================================================================================
 453
 454 update dynamic block at point                     C-c C-x C-u
 455 update all dynamic blocks                         C-u C-c C-x C-u
 456
 457 ================================================================================
 458 Notes
 459 ================================================================================
 460
 461 [1] This is only a suggestion for a binding of this command.  Choose you own
 462 key as shown under INSTALLATION.
 463
 464 [2] After changing a #+KEYWORD or <<<target>>> line, press C-c C-c with the
 465 cursor still in the line to update.
 466
 467 [3] Keybinding affected by org-CUA-compatibility.