comparison etc/orgcard.tex @ 71313:c4480c1636df

New keys for clocking work, Changed keys for export.
author Carsten Dominik <dominik@science.uva.nl>
date Sat, 10 Jun 2006 14:17:55 +0000
parents 4ea60a122f54
children 344bd72b1545
comparison
equal deleted inserted replaced
71312:e050af4a9e72 71313:c4480c1636df
1 % Reference Card for Org Mode 1 % Reference Card for Org Mode
2 \def\orgversionnumber{4.36} 2 \def\orgversionnumber{4.37}
3 \def\year{2006} 3 \def\year{2006}
4 % 4 %
5 %**start of header 5 %**start of header
6 \newcount\columnsperpage 6 \newcount\columnsperpage
7 7
334 \key{set tags for current heading}{C-c C-c} 334 \key{set tags for current heading}{C-c C-c}
335 \key{realign tags in all headings}{C-u C-c C-c} 335 \key{realign tags in all headings}{C-u C-c C-c}
336 \key{create sparse tree with matching tags}{C-c \\} 336 \key{create sparse tree with matching tags}{C-c \\}
337 \key{globally (agenda) match tags at cursor}{C-c C-o} 337 \key{globally (agenda) match tags at cursor}{C-c C-o}
338 338
339 \section{Tables}
340
341 %Org-mode has its own built-in intuitive table editor with unique
342 %capabilities.
343
344 {\bf Creating a table}
345
346 %\metax{insert a new Org-mode table}{M-x org-table-create}
347 \metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
348 \key{convert region to table}{C-c |}
349 \key{... separator at least 3 spaces}{C-3 C-c |}
350
351 {\bf Commands available inside tables}
352
353 The following commands work when the cursor is {\it inside a table}.
354 Outside of tables, the same keys may have other functionality.
355
356 {\bf Re-aligning and field motion}
357
358 \key{re-align the table without moving the cursor}{C-c C-c}
359 \key{re-align the table, move to next field}{TAB}
360 \key{move to previous field}{S-TAB}
361 \key{re-align the table, move to next row}{RET}
362
363 {\bf Row and column editing}
364
365 \key{move the current column left}{M-LEFT}
366 \key{move the current column right}{M-RIGHT}
367 \key{kill the current column}{M-S-LEFT}
368 \key{insert new column to left of cursor position}{M-S-RIGHT}
369
370 \key{move the current row up}{M-UP}
371 \key{move the current row down}{M-DOWN}
372 \key{kill the current row or horizontal line}{M-S-UP}
373 \key{insert new row above the current row}{M-S-DOWN}
374 \key{insert horizontal line below the current row}{C-c -}
375 \key{insert horizontal line above the current row}{C-u C-c -}
376 \key{sort lines in region}{C-c \^{}}
377
378 {\bf Regions}
379
380 \key{cut rectangular region}{C-c C-x C-w}
381 \key{copy rectangular region}{C-c C-x M-w}
382 \key{paste rectangular region}{C-c C-x C-y}
383 \key{fill paragraph across selected cells}{C-c C-q}
384
385 {\bf Calculations} (in combination with Emacs \kbd{calc} package)
386
387 \key{set and eval column formula}{C-c =}
388 \key{set and eval named-field formula}{C-u C-c =}
389 \key{edit formulas in separate buffer}{C-c '}
390 \key{re-apply all stored equations to current line}{C-c *}
391 \key{re-apply all stored equations to entire table}{C-u C-c *}
392
393 %\kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
394 %in lines starting with: {\tt | \# |}.
395
396 \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
397
398 \key{display column number cursor is in}{C-c ?}
399 \key{sum numbers in current column/rectangle}{C-c +}
400 \key{copy down with increment}{S-RET$^3$}
401
402 Formulas typed in field are executed by \kbd{TAB},
403 \kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
404 formula, \kbd{:=} a named-field formula.
405
406 \key{Example: Add Col1 and Col2}{=\$1+\$2}
407 \key{... with printf format specification}{=\$1+\$2;\%.2f}
408 \key{... with constants from constants.el}{=\$1/\$c/\$cm}
409 \key{sum from 3rd hline above to here}{:=vsum(\&III)}
410 \key{apply current column formula}{=}
411
412 {\bf Miscellaneous}
413
414 \key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
415 \key{edit the current field in a separate window}{C-c `}
416 \key{make current field fully visible}{C-u TAB}
417 \metax{export as tab-separated file}{M-x org-table-export}
418 \metax{import tab-separated file}{M-x org-table-import}
419
420 {\bf Tables created with the \kbd{table.el} package}
421
422 \key{insert a new \kbd{table.el} table}{C-c ~}
423 \key{recognize existing table.el table}{C-c C-c}
424 \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
425
426 \section{Links}
427
428 \key{globally store link to the current location}{C-c l$^1$}
429 \key{insert a link (TAB completes stored links)}{C-c C-l}
430 \key{insert file link with file name completion}{C-u C-c C-l}
431 \key{edit (also hidden part of) link at point}{C-c C-l}
432
433 \key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o}
434 \key{open link at point (3: in emacs)}{mouse-2/3}
435 %\key{open file links in emacs}{mouse-3}
436 %\key{record a position in mark ring}{C-c \%}
437 \key{jump back to last followed link(s)}{C-c \&}
438
439 {\bf Internal Links}
440
441 \key{\kbd{<<My Target>>}}{\rm target}
442 \key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
443 \key{\kbd{[[*this text]]}}{\rm find headline}
444 \metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
445 \metax{\kbd{[[this text][description]]}}{\rm optional link text}
446
447 {\bf External Links}
448
449 \key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
450 \key{\kbd{file:papers/last.pdf}}{\rm file, relative}
451 \key{\kbd{file:projects.org::*that text}}{\rm find headline}
452 \key{\kbd{file:projects.org::find me}}{\rm find tgt/string}
453 %\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
454 \key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
455 \key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address}
456 \key{\kbd{news:comp.emacs}}{\rm Usenet group}
457 \key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
458 \key{\kbd{gnus:group}}{\rm GNUS group}
459 \key{\kbd{gnus:group\#id}}{\rm GNUS message}
460 \key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
461 \key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
462 \key{\kbd{info:emacs:Regexps}}{\rm Info file:node}
463 \key{\kbd{shell:ls *.org}}{\rm shell command}
464 \key{\kbd{elisp:(calendar)}}{\rm elisp form}
465 \metax{\kbd{[[external link][description]]}}{\rm optional link text}
466 %\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
467
468
339 \section{TODO Items} 469 \section{TODO Items}
340 470
341 \key{rotate the state of the current item}{C-c C-t} 471 \key{rotate the state of the current item}{C-c C-t}
342 \key{view TODO items in a sparse tree}{C-c C-v} 472 \key{view TODO items in a sparse tree}{C-c C-v}
343 \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v} 473 \key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
369 %\key{... scroll calendar back/forward one month}{< / >} 499 %\key{... scroll calendar back/forward one month}{< / >}
370 %\key{... forward/backward one day}{S-LEFT/RIGHT} 500 %\key{... forward/backward one day}{S-LEFT/RIGHT}
371 %\key{... forward/backward one week}{S-UP/DOWN} 501 %\key{... forward/backward one week}{S-UP/DOWN}
372 %\key{... forward/backward one month}{M-S-LEFT/RIGT} 502 %\key{... forward/backward one month}{M-S-LEFT/RIGT}
373 503
374 \section{Links}
375
376 \key{globally store link to the current location}{C-c l$^1$}
377 \key{insert a link (TAB completes stored links)}{C-c C-l}
378 \key{insert file link with file name completion}{C-u C-c C-l}
379 \key{edit (also hidden part of) link at point}{C-c C-l}
380
381 \key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o}
382 \key{open link at point (3: in emacs)}{mouse-2/3}
383 %\key{open file links in emacs}{mouse-3}
384 %\key{record a position in mark ring}{C-c \%}
385 \key{jump back to last followed link(s)}{C-c \&}
386
387 {\bf Internal Links}
388
389 \key{\kbd{<<My Target>>}}{\rm target}
390 \key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
391 \key{\kbd{[[*this text]]}}{\rm find headline}
392 \metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
393 \metax{\kbd{[[this text][description]]}}{\rm optional link text}
394
395 {\bf External Links}
396
397 \key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
398 \key{\kbd{file:papers/last.pdf}}{\rm file, relative}
399 \key{\kbd{file:projects.org::*that text}}{\rm find headline}
400 \key{\kbd{file:projects.org::find me}}{\rm find tgt/string}
401 %\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
402 \key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
403 \key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address}
404 \key{\kbd{news:comp.emacs}}{\rm Usenet group}
405 \key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
406 \key{\kbd{gnus:group}}{\rm GNUS group}
407 \key{\kbd{gnus:group\#id}}{\rm GNUS message}
408 \key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
409 \key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
410 \key{\kbd{info:emacs:Regexps}}{\rm Info file:node}
411 \key{\kbd{shell:ls *.org}}{\rm shell command}
412 \key{\kbd{elisp:(calendar)}}{\rm elisp form}
413 \metax{\kbd{[[external link][description]]}}{\rm optional link text}
414 %\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
415
416 \section{Tables}
417
418 %Org-mode has its own built-in intuitive table editor with unique
419 %capabilities.
420
421 {\bf Creating a table}
422
423 %\metax{insert a new Org-mode table}{M-x org-table-create}
424 \metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
425 \key{convert region to table}{C-c |}
426 \key{... separator at least 3 spaces}{C-3 C-c |}
427
428 {\bf Commands available inside tables}
429
430 The following commands work when the cursor is {\it inside a table}.
431 Outside of tables, the same keys may have other functionality.
432
433 {\bf Re-aligning and field motion}
434
435 \key{re-align the table without moving the cursor}{C-c C-c}
436 \key{re-align the table, move to next field}{TAB}
437 \key{move to previous field}{S-TAB}
438 \key{re-align the table, move to next row}{RET}
439
440 {\bf Row and column editing}
441
442 \key{move the current column left}{M-LEFT}
443 \key{move the current column right}{M-RIGHT}
444 \key{kill the current column}{M-S-LEFT}
445 \key{insert new column to left of cursor position}{M-S-RIGHT}
446
447 \key{move the current row up}{M-UP}
448 \key{move the current row down}{M-DOWN}
449 \key{kill the current row or horizontal line}{M-S-UP}
450 \key{insert new row above the current row}{M-S-DOWN}
451 \key{insert horizontal line below the current row}{C-c -}
452 \key{insert horizontal line above the current row}{C-u C-c -}
453 \key{sort lines in region}{C-c \^{}}
454
455 {\bf Regions}
456
457 \key{cut rectangular region}{C-c C-x C-w}
458 \key{copy rectangular region}{C-c C-x M-w}
459 \key{paste rectangular region}{C-c C-x C-y}
460 \key{fill paragraph across selected cells}{C-c C-q}
461
462 {\bf Calculations} (in combination with Emacs \kbd{calc} package)
463
464 \key{set and eval column formula}{C-c =}
465 \key{set and eval named-field formula}{C-u C-c =}
466 \key{edit formulas in separate buffer}{C-c '}
467 \key{re-apply all stored equations to current line}{C-c *}
468 \key{re-apply all stored equations to entire table}{C-u C-c *}
469
470 %\kbd{TAB}, \kbd{RET} and \kbd{C-c C-c} trigger automatic recalculation
471 %in lines starting with: {\tt | \# |}.
472
473 \key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
474
475 \key{display column number cursor is in}{C-c ?}
476 \key{sum numbers in current column/rectangle}{C-c +}
477 \key{copy down with increment}{S-RET$^3$}
478
479 Formulas typed in field are executed by \kbd{TAB},
480 \kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
481 formula, \kbd{:=} a named-field formula.
482
483 \key{Example: Add Col1 and Col2}{=\$1+\$2}
484 \key{... with printf format specification}{=\$1+\$2;\%.2f}
485 \key{... with constants from constants.el}{=\$1/\$c/\$cm}
486 \key{sum from 3rd hline above to here}{:=vsum(\&III)}
487 \key{apply current column formula}{=}
488
489 {\bf Miscellaneous}
490
491 \key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
492 \key{edit the current field in a separate window}{C-c `}
493 \key{make current field fully visible}{C-u TAB}
494 \metax{export as tab-separated file}{M-x org-table-export}
495 \metax{import tab-separated file}{M-x org-table-import}
496
497 {\bf Tables created with the \kbd{table.el} package}
498
499 \key{insert a new \kbd{table.el} table}{C-c ~}
500 \key{recognize existing table.el table}{C-c C-c}
501 \key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
502 504
503 \newcolumn 505 \newcolumn
504 \title{Org-Mode Reference Card (2/2)} 506 \title{Org-Mode Reference Card (2/2)}
505 507
506 \centerline{(for version \orgversionnumber)} 508 \centerline{(for version \orgversionnumber)}
509
510 \section{Clocking Time}
511
512 \key{start clock on current item}{C-c C-x C-i}
513 \key{stop clock on current item}{C-c C-x C-o}
514 \key{cancel current clock}{C-c C-x C-x}
515 \key{display total subtree times}{C-c C-x C-d}
516 \key{remove displayed times}{C-c C-c}
507 517
508 \section{Agenda Views} 518 \section{Agenda Views}
509 519
510 \key{add/move current file to front of agenda}{C-c [} 520 \key{add/move current file to front of agenda}{C-c [}
511 \key{remove current file from your agenda}{C-c ]} 521 \key{remove current file from your agenda}{C-c ]}
561 \key{schedule/set deadline for this item}{C-c C-s/d} 571 \key{schedule/set deadline for this item}{C-c C-s/d}
562 \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$} 572 \key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
563 \key{change timestamp to today}{>} 573 \key{change timestamp to today}{>}
564 \key{insert new entry into diary}{i} 574 \key{insert new entry into diary}{i}
565 575
576 \key{Start the clock on current item (clock-in)}{I}
577 \key{Stop the clock (clock-out)}{O}
578 \key{Cancel current clock}{X}
579
580 \newcolumn
581
566 {\bf Calendar commands} 582 {\bf Calendar commands}
567 583
568 \key{find agenda cursor date in calendar}{c} 584 \key{find agenda cursor date in calendar}{c}
569 \key{compute agenda for calendar cursor date}{c} 585 \key{compute agenda for calendar cursor date}{c}
570 \key{show phases of the moon}{M} 586 \key{show phases of the moon}{M}
575 {\bf Quit and Exit} 591 {\bf Quit and Exit}
576 592
577 \key{quit agenda, remove agenda buffer}{q} 593 \key{quit agenda, remove agenda buffer}{q}
578 \key{exit agenda, remove all agenda buffers}{x} 594 \key{exit agenda, remove all agenda buffers}{x}
579 595
580 \section{Exporting} 596 \section{Exporting and Publishing}
581 597
582 Exporting creates files with extensions {\it .txt\/} and {\it .html\/} 598 Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
583 in the current directory. 599 in the current directory. Publishing puts the resulting file into
584 600 some other place.
585 \key{export as ASCII file}{C-c C-x a} 601
586 \key{export visible text only (e.g. for printing)}{C-c C-x v} 602 \key{export/publish dispatcher}{C-c C-e}
587 \key{export as HTML file}{C-c C-x h} 603
588 \key{export as HTML and open in browser}{C-c C-x b} 604 \key{export visible part only}{C-c C-e v}
589 \key{prefix arg sets nb. of headline levels, e.g.}{C-3 C-c C-x h}
590
591 \key{export as iCalendar file}{C-c C-x i}
592 \key{export all agenda files as iCalendar files}{C-c C-x C-i}
593 \key{combine all agenda files to single iCal file}{C-c C-x C-c}
594
595 \key{insert template of export options}{C-c C-x t} 605 \key{insert template of export options}{C-c C-x t}
596
597 \key{toggle fixed width for entry or region}{C-c :} 606 \key{toggle fixed width for entry or region}{C-c :}
598 607
599 {\bf HTML formatting} 608 {\bf HTML formatting}
600 609
601 \key{make words {\bf bold}}{*bold*} 610 \key{make words {\bf bold}}{*bold*}
639 and is therefore never exported. 648 and is therefore never exported.
640 Lines starting with \kbd{\#} are comments and are not exported. 649 Lines starting with \kbd{\#} are comments and are not exported.
641 Subtrees whose header starts with COMMENT are never exported. 650 Subtrees whose header starts with COMMENT are never exported.
642 651
643 \key{toggle COMMENT keyword on entry}{C-c ;} 652 \key{toggle COMMENT keyword on entry}{C-c ;}
644
645
646 \section{Publishing (requires org-publish.el)}
647 \key{publishcurrent file}{C-c C-e C-f}
648 \key{publish current project}{C-c C-e C-p}
649 \key{publish project (prompted for)}{C-c C-e C-c}
650 \key{publish all projects}{C-c C-e C-a}
651 653
652 \section{Completion} 654 \section{Completion}
653 655
654 In-buffer completion completes TODO keywords at headline start, TeX 656 In-buffer completion completes TODO keywords at headline start, TeX
655 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS 657 macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS