aboutsummaryrefslogtreecommitdiffstats
path: root/etc/orgcard.tex
diff options
context:
space:
mode:
Diffstat (limited to 'etc/orgcard.tex')
-rw-r--r--etc/orgcard.tex103
1 files changed, 38 insertions, 65 deletions
diff --git a/etc/orgcard.tex b/etc/orgcard.tex
index 45608ac1795..5a019328a1f 100644
--- a/etc/orgcard.tex
+++ b/etc/orgcard.tex
@@ -1,5 +1,5 @@
1% Reference Card for Org Mode 1% Reference Card for Org Mode
2\def\orgversionnumber{4.26} 2\def\orgversionnumber{4.36}
3\def\year{2006} 3\def\year{2006}
4% 4%
5%**start of header 5%**start of header
@@ -269,19 +269,11 @@ are preserved on all copies.
269 269
270\section{Getting Started} 270\section{Getting Started}
271% 271%
272%Put the following in your \kbd{~/.emacs}$^1$
273\vskip -1mm 272\vskip -1mm
274\beginexample% 273\beginexample%
275%(autoload 'org-mode "org" "Org mode" t)
276%(autoload 'org-diary "org" "Org mode diary entries")
277%(autoload 'org-agenda "org" "Agenda from Org files" t)
278%(autoload 'org-todo-list "org" "Global TODO list" t)
279%(autoload 'org-store-link "org" "Store org link" t)
280%(autoload 'orgtbl-mode "org" "Orgtbl minor mode" t)
281%(autoload 'turn-on-orgtbl "org" "Orgtbl minor mode")
282(add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode)) 274(add-to-list 'auto-mode-alist '("\\\\.org\$" . org-mode))
283(define-key global-map "\\C-cl" 'org-store-link)$^2$ 275(define-key global-map "\\C-cl" 'org-store-link)$^1$
284(define-key global-map "\\C-ca" 'org-agenda)$^2$ 276(define-key global-map "\\C-ca" 'org-agenda)$^1$
285\endexample 277\endexample
286% 278%
287\metax{For the many customization options try}{M-x org-customize} 279\metax{For the many customization options try}{M-x org-customize}
@@ -302,6 +294,7 @@ are preserved on all copies.
302\key{previous heading, same level}{C-c C-b} 294\key{previous heading, same level}{C-c C-b}
303\key{backward to higher level heading}{C-c C-u} 295\key{backward to higher level heading}{C-c C-u}
304\key{jump to another place in document}{C-c C-j} 296\key{jump to another place in document}{C-c C-j}
297\key{previous/next plain list item}{S-UP/DOWN$^3$}
305 298
306\section{Structure Editing} 299\section{Structure Editing}
307 300
@@ -320,7 +313,7 @@ are preserved on all copies.
320\key{yank subtree}{C-c C-x C-y} 313\key{yank subtree}{C-c C-x C-y}
321 314
322\key{archive subtree}{C-c \$} 315\key{archive subtree}{C-c \$}
323To set archive location for current file, add a line like$^3$: 316To set archive location for current file, add a line like$^2$:
324\vskip -1mm 317\vskip -1mm
325\beginexample% 318\beginexample%
326\#+ARCHIVE: archfile::* Archived Tasks 319\#+ARCHIVE: archfile::* Archived Tasks
@@ -330,10 +323,10 @@ To set archive location for current file, add a line like$^3$:
330 323
331\key{show sparse tree for all matches of a regexp}{C-c /} 324\key{show sparse tree for all matches of a regexp}{C-c /}
332\key{view TODO's in sparse tree}{C-c C-v} 325\key{view TODO's in sparse tree}{C-c C-v}
333\key{global TODO list in agenda mode}{C-c t$^2$} 326\key{global TODO list in agenda mode}{C-c t$^1$}
334\key{create sparse tree with all deadlines due}{C-c C-w} 327\key{create sparse tree with all deadlines due}{C-c C-w}
335\key{time sorted view of current org file}{C-c C-r} 328\key{time sorted view of current org file}{C-c C-r}
336%\key{agenda for the week}{C-c a$^2$} 329%\key{agenda for the week}{C-c a$^1$}
337%\key{agenda for date at cursor}{C-c C-o} 330%\key{agenda for date at cursor}{C-c C-o}
338 331
339\section{Tags} 332\section{Tags}
@@ -351,8 +344,8 @@ To set archive location for current file, add a line like$^3$:
351 344
352\key{set the priority of the current item}{C-c , [ABC]} 345\key{set the priority of the current item}{C-c , [ABC]}
353\key{remove priority cookie from current item}{C-c , SPC} 346\key{remove priority cookie from current item}{C-c , SPC}
354\key{raise priority of current item}{S-UP$^4$} 347\key{raise priority of current item}{S-UP$^3$}
355\key{lower priority of current item}{S-DOWN$^4$} 348\key{lower priority of current item}{S-DOWN$^3$}
356 349
357\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow} 350\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
358\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types} 351\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
@@ -366,8 +359,8 @@ To set archive location for current file, add a line like$^3$:
366\key{insert SCHEDULED timestamp}{C-c C-s} 359\key{insert SCHEDULED timestamp}{C-c C-s}
367\key{create sparse tree with all deadlines due}{C-c C-w} 360\key{create sparse tree with all deadlines due}{C-c C-w}
368\key{the time between 2 dates in a time range}{C-c C-y} 361\key{the time between 2 dates in a time range}{C-c C-y}
369\key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^4$} 362\key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$}
370\key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^4$} 363\key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$}
371\key{access the calendar for the current date}{C-c >} 364\key{access the calendar for the current date}{C-c >}
372\key{insert timestamp matching date in calendar}{C-c <} 365\key{insert timestamp matching date in calendar}{C-c <}
373\key{access agenda for current date}{C-c C-o} 366\key{access agenda for current date}{C-c C-o}
@@ -380,7 +373,7 @@ To set archive location for current file, add a line like$^3$:
380 373
381\section{Links} 374\section{Links}
382 375
383\key{globally store link to the current location}{C-c l$^2$} 376\key{globally store link to the current location}{C-c l$^1$}
384\key{insert a link (TAB completes stored links)}{C-c C-l} 377\key{insert a link (TAB completes stored links)}{C-c C-l}
385\key{insert file link with file name completion}{C-u C-c C-l} 378\key{insert file link with file name completion}{C-u C-c C-l}
386\key{edit (also hidden part of) link at point}{C-c C-l} 379\key{edit (also hidden part of) link at point}{C-c C-l}
@@ -388,13 +381,13 @@ To set archive location for current file, add a line like$^3$:
388\key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o} 381\key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o}
389\key{open link at point (3: in emacs)}{mouse-2/3} 382\key{open link at point (3: in emacs)}{mouse-2/3}
390%\key{open file links in emacs}{mouse-3} 383%\key{open file links in emacs}{mouse-3}
391\key{record a position in mark ring}{C-c \%} 384%\key{record a position in mark ring}{C-c \%}
392\key{jump back to last followed link(s)}{C-c \&} 385\key{jump back to last followed link(s)}{C-c \&}
393 386
394{\bf Internal Links} 387{\bf Internal Links}
395 388
396\key{\kbd{<<My Target>>}}{\rm target} 389\key{\kbd{<<My Target>>}}{\rm target}
397\key{\kbd{<<<My Target>>>}}{\rm radio target$^3$} 390\key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
398\key{\kbd{[[*this text]]}}{\rm find headline} 391\key{\kbd{[[*this text]]}}{\rm find headline}
399\metax{\kbd{[[this text]]}}{\rm find target or text in buffer} 392\metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
400\metax{\kbd{[[this text][description]]}}{\rm optional link text} 393\metax{\kbd{[[this text][description]]}}{\rm optional link text}
@@ -405,16 +398,18 @@ To set archive location for current file, add a line like$^3$:
405\key{\kbd{file:papers/last.pdf}}{\rm file, relative} 398\key{\kbd{file:papers/last.pdf}}{\rm file, relative}
406\key{\kbd{file:projects.org::*that text}}{\rm find headline} 399\key{\kbd{file:projects.org::*that text}}{\rm find headline}
407\key{\kbd{file:projects.org::find me}}{\rm find tgt/string} 400\key{\kbd{file:projects.org::find me}}{\rm find tgt/string}
408\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search} 401%\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
409\key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web} 402\key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
410\key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address} 403\key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address}
411\key{\kbd{news:comp.emacs}}{\rm Usenet group} 404\key{\kbd{news:comp.emacs}}{\rm Usenet group}
412\key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person} 405\key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
413\key{\kbd{shell:ls *.org}}{\rm shell command}
414\key{\kbd{gnus:group}}{\rm GNUS group} 406\key{\kbd{gnus:group}}{\rm GNUS group}
415\key{\kbd{gnus:group\#id}}{\rm GNUS message} 407\key{\kbd{gnus:group\#id}}{\rm GNUS message}
416\key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder} 408\key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
417\key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message} 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}
418\metax{\kbd{[[external link][description]]}}{\rm optional link text} 413\metax{\kbd{[[external link][description]]}}{\rm optional link text}
419%\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote} 414%\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
420 415
@@ -479,7 +474,7 @@ Outside of tables, the same keys may have other functionality.
479 474
480\key{display column number cursor is in}{C-c ?} 475\key{display column number cursor is in}{C-c ?}
481\key{sum numbers in current column/rectangle}{C-c +} 476\key{sum numbers in current column/rectangle}{C-c +}
482\key{copy down with increment}{S-RET$^4$} 477\key{copy down with increment}{S-RET$^3$}
483 478
484Formulas typed in field are executed by \kbd{TAB}, 479Formulas typed in field are executed by \kbd{TAB},
485\kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column 480\kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
@@ -516,15 +511,15 @@ formula, \kbd{:=} a named-field formula.
516\key{remove current file from your agenda}{C-c ]} 511\key{remove current file from your agenda}{C-c ]}
517\key{cycle through agenda file list}{C-,} 512\key{cycle through agenda file list}{C-,}
518 513
519\key{compile agenda for the current week}{C-c a a$^2$} 514\key{compile agenda for the current week}{C-c a a$^1$}
520\key{compile global TODO list}{C-c a t$^2$} 515\key{compile global TODO list}{C-c a t$^1$}
521\key{compile TODO list for specific keyword}{C-c a T$^2$} 516\key{compile TODO list for specific keyword}{C-c a T$^1$}
522\key{match tags in agenda files}{C-c a m$^2$} 517\key{match tags in agenda files}{C-c a m$^1$}
523\key{agenda for date at cursor}{C-c C-o} 518\key{agenda for date at cursor}{C-c C-o}
524\key{show timeline of current org file}{C-c C-r} 519\key{show timeline of current org file}{C-c C-r}
525 520
526\vskip 1mm 521\vskip 1mm
527To set categories, add lines like$^3$: 522To set categories, add lines like$^2$:
528\vskip -1mm 523\vskip -1mm
529\beginexample% 524\beginexample%
530\#+CATEGORY: MyCateg 525\#+CATEGORY: MyCateg
@@ -561,12 +556,10 @@ To set categories, add lines like$^3$:
561\key{show tags of current headline}{T} 556\key{show tags of current headline}{T}
562\key{set tags for current headline}{:} 557\key{set tags for current headline}{:}
563\key{set priority of current item}{p} 558\key{set priority of current item}{p}
564\key{raise/lower priority of current item}{S-UP/DOWN$^4$} 559\key{raise/lower priority of current item}{S-UP/DOWN$^3$}
565%\key{lower priority of current item}{S-DOWN$^4$}
566\key{display weighted priority of current item}{P} 560\key{display weighted priority of current item}{P}
567\key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^4$} 561\key{schedule/set deadline for this item}{C-c C-s/d}
568%\key{change timestamp to one day earlier}{S-LEFT$^4$} 562\key{change timestamp to one day earlier/later}{S-LEFT/RIGHT$^3$}
569%\key{change timestamp to one day later}{S-RIGHT$^4$}
570\key{change timestamp to today}{>} 563\key{change timestamp to today}{>}
571\key{insert new entry into diary}{i} 564\key{insert new entry into diary}{i}
572 565
@@ -629,8 +622,6 @@ keywords. {\tt M-TAB} again just after keyword is complete inserts examples.
629\key{... which can carry over multiple lines}{\#+TEXT:} 622\key{... which can carry over multiple lines}{\#+TEXT:}
630\key{settings for the export process - see below}{\#+OPTIONS:} 623\key{settings for the export process - see below}{\#+OPTIONS:}
631 624
632{\bf Settings for the OPTIONS line}
633
634\key{set number of headline levels for export}{H:2} 625\key{set number of headline levels for export}{H:2}
635\key{turn on/off section numbers}{num:t} 626\key{turn on/off section numbers}{num:t}
636\key{turn on/off table of contents}{toc:t} 627\key{turn on/off table of contents}{toc:t}
@@ -651,6 +642,13 @@ Subtrees whose header starts with COMMENT are never exported.
651 642
652\key{toggle COMMENT keyword on entry}{C-c ;} 643\key{toggle COMMENT keyword on entry}{C-c ;}
653 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
654\section{Completion} 652\section{Completion}
655 653
656In-buffer completion completes TODO keywords at headline start, TeX 654In-buffer completion completes TODO keywords at headline start, TeX
@@ -659,8 +657,6 @@ after ``{\tt :}'', and dictionary words elsewhere.
659 657
660\key{Complete word at point}{M-TAB} 658\key{Complete word at point}{M-TAB}
661 659
662\newcolumn
663
664\section{Calendar and Diary Integration} 660\section{Calendar and Diary Integration}
665 661
666To include entries from the Emacs diary in your Org-mode agenda: 662To include entries from the Emacs diary in your Org-mode agenda:
@@ -668,26 +664,6 @@ To include entries from the Emacs diary in your Org-mode agenda:
668(setq org-agenda-include-diary t) 664(setq org-agenda-include-diary t)
669\endexample 665\endexample
670 666
671To include the Org-mode agenda in the normal diary, make sure you're
672using the fancy diary display
673%
674%\beginexample%
675%(add-hook 'diary-display-hook 'fancy-diary-display)
676%\endexample
677%
678and in the \kbd{~/diary} file add
679
680\beginexample%
681\&\%\%(org-diary)
682\endexample
683
684to include all the files listed in \kbd{org-agenda-files}. For more
685selective file inclusion use a line for each file:
686
687\beginexample%
688\&\%\%(org-diary) ~/path/to/some/org-file.org
689\endexample
690
691\section{Remember-mode Integration} 667\section{Remember-mode Integration}
692 668
693See the manual for how to make remember.el use Org-mode links and 669See the manual for how to make remember.el use Org-mode links and
@@ -712,7 +688,7 @@ Insert the note with one of the following:
712Configure the variable {\tt org-CUA-compatibility} to make Org-mode 688Configure the variable {\tt org-CUA-compatibility} to make Org-mode
713avoid the \kbd{S-<cursor>} bindings used by these modes. When set, 689avoid the \kbd{S-<cursor>} bindings used by these modes. When set,
714Org-mode will change the following keybindings (also in the agenda 690Org-mode will change the following keybindings (also in the agenda
715buffer, but not during date selection). See note mark four$^4$ 691buffer, but not during date selection). See note mark four$^3$
716throughout the reference card. 692throughout the reference card.
717%\vskip-mm 693%\vskip-mm
718\beginexample 694\beginexample
@@ -722,16 +698,13 @@ S-RET $\to$ C-S-RET
722\endexample 698\endexample
723 699
724\section{Notes} 700\section{Notes}
725$^1$ The six autoload forms are only needed if Org-mode is not part of 701$^1$ This is only a suggestion for a binding of this command. Choose
726Emacs, or an XEmacs package.
727
728$^2$ This is only a suggestion for a binding of this command. Choose
729you own key as shown under INSTALLATION. 702you own key as shown under INSTALLATION.
730 703
731$^3$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line, 704$^2$ After changing a \kbd{\#+KEYWORD} or \kbd{<<<target>>>} line,
732press \kbd{C-c C-c} with the cursor still in the line to update. 705press \kbd{C-c C-c} with the cursor still in the line to update.
733 706
734$^4$ Keybinding affected by {\tt org-CUA-compatibility}. 707$^3$ Keybinding affected by {\tt org-CUA-compatibility}.
735 708
736\copyrightnotice 709\copyrightnotice
737 710