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