org-mode/doc/orgcard.tex

693 lines
24 KiB
TeX
Raw Normal View History

2008-01-31 09:51:19 +00:00
% Reference Card for Org Mode
\input org-version.tex
2008-01-31 10:34:42 +00:00
2008-01-31 09:30:03 +00:00
%**start of header
\newcount\columnsperpage
2008-01-31 10:34:42 +00:00
\newcount\letterpaper
2008-01-31 09:30:03 +00:00
% This file can be printed with 1, 2, or 3 columns per page (see below).
2008-01-31 10:34:42 +00:00
% Specify how many you want here.
\columnsperpage=3
2008-01-31 09:30:03 +00:00
% Set letterpaper to 0 for A4 paper, 1 for letter (US) paper. Useful
% only when columnsperpage is 2 or 3.
\letterpaper=1
% PDF output layout. 0 for A4, 1 for letter (US), a `l' is added for
% a landscape layout.
\input pdflayout.sty
\pdflayout=(1l)
2008-01-31 09:30:03 +00:00
2008-01-31 10:34:42 +00:00
% Nothing else needs to be changed below this line.
% Copyright (C) 1987, 1993, 1996--1997, 2001--2024 Free Software
2013-01-08 14:26:04 +00:00
% Foundation, Inc.
2008-01-31 10:34:42 +00:00
% This document is free software: you can redistribute it and/or modify
2008-01-31 09:30:03 +00:00
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
2008-01-31 09:30:03 +00:00
% As a special additional permission, you may distribute reference cards
% printed, or formatted for printing, with the notice "Released under
% the terms of the GNU General Public License version 3 or later"
% instead of the usual distributed-under-the-GNU-GPL notice, and without
% a copy of the GPL itself.
% This document is distributed in the hope that it will be useful,
2008-01-31 09:30:03 +00:00
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
% You should have received a copy of the GNU General Public License
% along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
2008-01-31 09:30:03 +00:00
% This file is intended to be processed by plain TeX (TeX82).
%
% The final reference card has six columns, three on each side.
% This file can be used to produce it in any of three ways:
% 1 column per page
% produces six separate pages, each of which needs to be reduced to 80%.
% This gives the best resolution.
% 2 columns per page
% produces three already-reduced pages.
% You will still need to cut and paste.
% 3 columns per page
% produces two pages which must be printed sideways to make a
% ready-to-use 8.5 x 11 inch reference card.
% For this you need a dvi device driver that can print sideways.
% Which mode to use is controlled by setting \columnsperpage above.
%
2008-01-31 10:34:42 +00:00
% To compile and print this document:
% tex refcard.tex
% dvips -t landscape refcard.dvi
%
2008-01-31 09:30:03 +00:00
% Author:
% Stephen Gildea <stepheng+emacs@gildea.com>
2008-01-31 09:30:03 +00:00
%
% Thanks to Paul Rubin, Bob Chassell, Len Tower, and Richard Mlynarik
% for their many good ideas.
\def\shortcopyrightnotice{\vskip 1ex plus 2 fill
2008-01-31 10:34:04 +00:00
\centerline{\small \copyright\ \year\ Free Software Foundation, Inc.
2008-01-31 09:30:03 +00:00
Permissions on back. v\orgversionnumber}}
\def\copyrightnotice{
\vskip 1ex plus 100 fill\begingroup\small
\centerline{Copyright \copyright\ \year\ Free Software Foundation, Inc.}
2008-01-31 10:34:04 +00:00
\centerline{v\orgversionnumber{} for Org-Mode \orgversionnumber{}, \versionyear}
\centerline{Author: Philip Rooke}
2008-01-31 09:30:03 +00:00
\centerline{based on refcard design and format by Stephen Gildea}
\centerline{Released under the terms of the GNU General Public License}
\centerline{version 3 or later.}
2008-01-31 09:30:03 +00:00
\endgroup}
% make \bye not \outer so that the \def\bye in the \else clause below
% can be scanned without complaint.
\def\bye{\par\vfill\supereject\end}
2008-01-31 10:34:42 +00:00
\newdimen\intercolumnskip %horizontal space between columns
\newbox\columna %boxes to hold columns already built
2008-01-31 09:30:03 +00:00
\newbox\columnb
\def\ncolumns{\the\columnsperpage}
2008-01-31 10:34:42 +00:00
\message{[\ncolumns\space
2008-01-31 09:30:03 +00:00
column\if 1\ncolumns\else s\fi\space per page]}
\def\scaledmag#1{ scaled \magstep #1}
% This multi-way format was designed by Stephen Gildea October 1986.
% Note that the 1-column format is fontfamily-independent.
2008-01-31 10:34:42 +00:00
\if 1\ncolumns %one-column format uses normal size
2008-01-31 09:30:03 +00:00
\hsize 4in
\vsize 10in
\voffset -.7in
\font\titlefont=\fontname\tenbf \scaledmag3
\font\headingfont=\fontname\tenbf \scaledmag2
\font\smallfont=\fontname\sevenrm
\font\smallsy=\fontname\sevensy
\footline{\hss\folio}
\def\makefootline{\baselineskip10pt\hsize6.5in\line{\the\footline}}
2008-01-31 10:34:42 +00:00
\else %2 or 3 columns uses prereduced size
\hsize 3.2in
2008-01-31 10:34:42 +00:00
\if 1\the\letterpaper
\vsize 7.95in
\else
\vsize 7.65in
\fi
\hoffset -.75in
\voffset -.745in
2008-01-31 09:30:03 +00:00
\font\titlefont=cmbx10 \scaledmag2
\font\headingfont=cmbx10 \scaledmag1
\font\smallfont=cmr6
\font\smallsy=cmsy6
\font\eightrm=cmr8
\font\eightbf=cmbx8
\font\eightit=cmti8
\font\eighttt=cmtt8
\font\eightmi=cmmi8
\font\eightsy=cmsy8
\textfont0=\eightrm
\textfont1=\eightmi
\textfont2=\eightsy
\def\rm{\eightrm}
\def\bf{\eightbf}
\def\it{\eightit}
\def\tt{\eighttt}
2008-01-31 10:34:42 +00:00
\if 1\the\letterpaper
\normalbaselineskip=.8\normalbaselineskip
\else
\normalbaselineskip=.7\normalbaselineskip
\fi
2008-01-31 09:30:03 +00:00
\normallineskip=.8\normallineskip
\normallineskiplimit=.8\normallineskiplimit
2008-01-31 10:34:42 +00:00
\normalbaselines\rm %make definitions take effect
2008-01-31 09:30:03 +00:00
\if 2\ncolumns
\let\maxcolumn=b
\footline{\hss\rm\folio\hss}
\def\makefootline{\vskip 2in \hsize=6.86in\line{\the\footline}}
\else \if 3\ncolumns
\let\maxcolumn=c
\nopagenumbers
\else
\errhelp{You must set \columnsperpage equal to 1, 2, or 3.}
\errmessage{Illegal number of columns per page}
\fi\fi
\intercolumnskip=.46in
\def\abc{a}
2008-01-31 10:34:42 +00:00
\output={% %see The TeXbook page 257
2008-01-31 09:30:03 +00:00
% This next line is useful when designing the layout.
%\immediate\write16{Column \folio\abc\space starts with \firstmark}
\if \maxcolumn\abc \multicolumnformat \global\def\abc{a}
\else\if a\abc
2008-01-31 10:34:42 +00:00
\global\setbox\columna\columnbox \global\def\abc{b}
2008-01-31 09:30:03 +00:00
%% in case we never use \columnb (two-column mode)
\global\setbox\columnb\hbox to -\intercolumnskip{}
\else
2008-01-31 10:34:42 +00:00
\global\setbox\columnb\columnbox \global\def\abc{c}\fi\fi}
2008-01-31 09:30:03 +00:00
\def\multicolumnformat{\shipout\vbox{\makeheadline
\hbox{\box\columna\hskip\intercolumnskip
\box\columnb\hskip\intercolumnskip\columnbox}
\makefootline}\advancepageno}
\def\columnbox{\leftline{\pagebody}}
\def\bye{\par\vfill\supereject
\if a\abc \else\null\vfill\eject\fi
\if a\abc \else\null\vfill\eject\fi
2008-01-31 10:34:42 +00:00
\end}
2008-01-31 09:30:03 +00:00
\fi
% we won't be using math mode much, so redefine some of the characters
% we might want to talk about
%\catcode`\^=12
\catcode`\_=12
% we also need the tilde, for file names.
\catcode`\~=12
\chardef\\=`\\
\chardef\{=`\{
\chardef\}=`\}
\hyphenation{mini-buf-fer}
\parindent 0pt
\parskip 1ex plus .5ex minus .5ex
\def\small{\smallfont\textfont2=\smallsy\baselineskip=.8\baselineskip}
% newcolumn - force a new column. Use sparingly, probably only for
% the first column of a page, which should have a title anyway.
\outer\def\newcolumn{\vfill\eject}
% title - page title. Argument is title text.
\outer\def\title#1{{\titlefont\centerline{#1}}\vskip 1ex plus .5ex}
% section - new major section. Argument is section name.
\outer\def\section#1{\par\filbreak
\vskip 3ex plus 2ex minus 2ex {\headingfont #1}\mark{#1}%
\vskip 2ex plus 1ex minus 1.5ex}
\newdimen\keyindent
% beginindentedkeys...endindentedkeys - key definitions will be
% indented, but running text, typically used as headings to group
% definitions, will not.
\def\beginindentedkeys{\keyindent=1em}
\def\endindentedkeys{\keyindent=0em}
\endindentedkeys
% paralign - begin paragraph containing an alignment.
% If an \halign is entered while in vertical mode, a parskip is never
% inserted. Using \paralign instead of \halign solves this problem.
\def\paralign{\vskip\parskip\halign}
% \<...> - surrounds a variable name in a code example
\def\<#1>{{\it #1\/}}
% kbd - argument is characters typed literally. Like the Texinfo command.
2008-01-31 10:34:42 +00:00
\def\kbd#1{{\tt#1}\null} %\null so not an abbrev even if period follows
2008-01-31 09:30:03 +00:00
% beginexample...endexample - surrounds literal text, such a code example.
% typeset in a typewriter font with line breaks preserved
\def\beginexample{\par\leavevmode\begingroup
\obeylines\obeyspaces\parskip0pt\tt}
{\obeyspaces\global\let =\ }
\def\endexample{\endgroup}
% key - definition of a key.
% \key{description of key}{key-name}
% prints the description left-justified, and the key-name in a \kbd
% form near the right margin.
\def\key#1#2{\leavevmode\hbox to \hsize{\vtop
{\hsize=.75\hsize\rightskip=1em
\hskip\keyindent\relax#1}\kbd{#2}\hfil}}
\newbox\metaxbox
\setbox\metaxbox\hbox{\kbd{M-x }}
\newdimen\metaxwidth
\metaxwidth=\wd\metaxbox
% metax - definition of a M-x command.
% \metax{description of command}{M-x command-name}
% Tries to justify the beginning of the command name at the same place
% as \key starts the key name. (The "M-x " sticks out to the left.)
\def\metax#1#2{\leavevmode\hbox to \hsize{\hbox to .75\hsize
{\hskip\keyindent\relax#1\hfil}%
\hskip -\metaxwidth minus 1fil
\kbd{#2}\hfil}}
% threecol - like "key" but with two key names.
% for example, one for doing the action backward, and one for forward.
\def\threecol#1#2#3{\hskip\keyindent\relax#1\hfil&\kbd{#2}\hfil\quad
&\kbd{#3}\hfil\quad\cr}
%\def\noteone{{\small \hfill [1]}}
%\def\notetwo{{\small \hfill [2]}}
\def\noteone{{\small [1]}}
\def\notetwo{{\small [2]}}
2010-12-06 08:54:30 +00:00
2008-01-31 09:30:03 +00:00
%**end of header
\title{Org-Mode Reference Card}
2008-01-31 09:30:03 +00:00
\centerline{(for version \orgversionnumber)}
\section{Getting Started}
\metax{To read the on-line documentation try}{M-x org-info}
\section{Visibility Cycling}
\key{rotate current subtree between states}{TAB}
\key{rotate entire buffer between states}{S-TAB}
\key{restore property-dependent startup visibility}{C-u C-u TAB}
\metax{show the whole file, including drawers}{C-u C-u C-u TAB}
2008-01-31 10:32:56 +00:00
\key{reveal context around point}{C-c C-r}
\metax{toggle indented view}{M-x org-indent-mode}
2008-01-31 09:30:03 +00:00
\section{Motion}
2008-01-31 10:32:08 +00:00
\key{next/previous heading}{C-c C-n/p}
\key{next/previous heading, same level}{C-c C-f/b}
2008-01-31 09:30:03 +00:00
\key{backward to higher level heading}{C-c C-u}
\key{jump to another place in document}{C-c C-j}
2010-12-06 09:51:04 +00:00
\key{previous/next plain list item}{S-UP/DOWN\notetwo}
2008-01-31 09:30:03 +00:00
\section{Structure Editing}
\key{insert new heading/item at current level}{M-RET}
2008-01-31 10:36:18 +00:00
\key{insert new heading after subtree}{C-RET}
2008-01-31 10:32:13 +00:00
\key{insert new TODO entry/checkbox item}{M-S-RET}
\key{insert TODO entry/ckbx after subtree}{C-S-RET}
\key{turn (head)line into item, cycle item type}{C-c -}
\key{turn item/line into headline}{C-c *}
\key{promote/demote heading}{M-LEFT/RIGHT}
\metax{promote/demote current subtree}{M-S-LEFT/RIGHT}
\metax{move subtree/list item up/down}{M-UP/DOWN}
\metax{move the line at point up/down}{M-S-UP/DOWN}
\metax{sort subtree/region/plain-list}{C-c \^{}}
\metax{clone a subtree}{C-c C-x c}
\metax{copy visible parts of the region}{C-c C-x v}
\metax{kill/copy subtree}{C-c C-x C-w/M-w}
\metax{yank subtree}{C-c C-x C-y or C-y}
\metax{narrow buffer to subtree / widen}{C-x n s/w}
2008-01-31 09:30:03 +00:00
2010-12-06 08:54:30 +00:00
\section{Capture - Refile - Archiving}
\key{capture a new item (C-u C-u = goto last)}{C-c c \noteone}
\key{refile subtree (C-u C-u = goto last)}{C-c C-w}
\key{archive subtree using the default command}{C-c C-x C-a}
2008-01-31 10:33:37 +00:00
\key{move subtree to archive file}{C-c C-x C-s}
\key{toggle ARCHIVE tag / to ARCHIVE sibling}{C-c C-x a/A}
\key{force cycling of an ARCHIVEd tree}{C-c C-TAB}
2008-01-31 09:30:03 +00:00
\section{Filtering and Sparse Trees}
2008-01-31 10:37:51 +00:00
\key{construct a sparse tree by various criteria}{C-c /}
2010-05-12 06:12:01 +00:00
\key{view TODO's in sparse tree}{C-c / t/T}
2010-12-06 08:54:30 +00:00
\key{global TODO list in agenda mode}{C-c a t \noteone}
2008-01-31 09:30:03 +00:00
\section{Tables}
{\bf Creating a table}
2008-01-31 10:29:47 +00:00
%\metax{insert a new Org-mode table}{M-x org-table-create}
\metax{just start typing, e.g.}{|Name|Phone|Age RET |- TAB}
2008-01-31 10:30:56 +00:00
\key{convert region to table}{C-c |}
\key{... separator at least 3 spaces}{C-3 C-c |}
2008-01-31 09:30:03 +00:00
{\bf Commands available inside tables}
The following commands work when the cursor is {\it inside a table}.
Outside of tables, the same keys may have other functionality.
{\bf Re-aligning and field motion}
\key{re-align the table without moving the cursor}{C-c C-c}
\key{re-align the table, move to next field}{TAB}
\key{move to previous field}{S-TAB}
\key{re-align the table, move to next row}{RET}
\key{move to beginning/end of field}{M-a/e}
2008-01-31 09:30:03 +00:00
{\bf Row and column editing}
2008-01-31 10:34:42 +00:00
\key{move the current column left}{M-LEFT/RIGHT}
2008-01-31 09:30:03 +00:00
\key{kill the current column}{M-S-LEFT}
\key{insert new column to left of cursor position}{M-S-RIGHT}
2008-01-31 10:34:42 +00:00
\key{move the current row up/down}{M-UP/DOWN}
2008-01-31 09:30:03 +00:00
\key{kill the current row or horizontal line}{M-S-UP}
\key{insert new row above the current row}{M-S-DOWN}
2008-01-31 10:33:41 +00:00
\key{insert hline below (\kbd{C-u} : above) current row}{C-c -}
\key{insert hline and move to line below it}{C-c RET}
2008-01-31 09:30:03 +00:00
\key{sort lines in region}{C-c \^{}}
{\bf Regions}
\metax{cut/copy/paste rectangular region}{C-c C-x C-w/M-w/C-y}
%\key{copy rectangular region}{C-c C-x M-w}
%\key{paste rectangular region}{C-c C-x C-y}
2008-01-31 09:30:03 +00:00
{\bf Miscellaneous}
2008-01-31 10:30:56 +00:00
\key{to limit column width to \kbd{N} characters, use}{...| <N> |...}
2008-01-31 10:29:47 +00:00
\key{edit the current field in a separate window}{C-c `}
2008-01-31 10:30:30 +00:00
\key{make current field fully visible}{C-u TAB}
2008-01-31 09:30:03 +00:00
\metax{export as tab-separated file}{M-x org-table-export}
\metax{import tab-separated file}{M-x org-table-import}
2008-01-31 10:34:04 +00:00
\key{sum numbers in current column/rectangle}{C-c +}
2008-01-31 09:30:03 +00:00
{\bf Tables created with the \kbd{table.el} package}
\key{insert a new \kbd{table.el} table}{C-c ~}
\key{recognize existing table.el table}{C-c C-c}
\key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
2008-01-31 10:34:04 +00:00
{\bf Spreadsheet}
Formulas typed in field are executed by \kbd{TAB},
\kbd{RET} and \kbd{C-c C-c}. \kbd{=} introduces a column
formula, \kbd{:=} a field formula.
\key{Example: Add Col1 and Col2}{|=\$1+\$2 |}
\key{... with printf format specification}{|=\$1+\$2;\%.2f|}
\key{... with constants from constants.el}{|=\$1/\$c/\$cm |}
\metax{sum from 2nd to 3rd hline}{|:=vsum(@II..@III)|}
\key{apply current column formula}{| = |}
\key{set and eval column formula}{C-c =}
\key{set and eval field formula}{C-u C-c =}
\key{re-apply all stored equations to current line}{C-c *}
\key{re-apply all stored equations to entire table}{C-u C-c *}
\key{iterate table to stability}{C-u C-u C-c *}
\key{rotate calculation mark through \# * ! \^ \_ \$}{C-\#}
\key{show line, column, formula reference}{C-c ?}
\key{toggle grid / debugger}{C-c \}/\{}
2008-01-31 10:34:04 +00:00
2008-01-31 10:34:50 +00:00
\newcolumn
2008-01-31 10:34:04 +00:00
{\it Formula Editor}
\key{edit formulas in separate buffer}{C-c '}
\key{exit and install new formulas}{C-c C-c}
\key{exit, install, and apply new formulas}{C-u C-c C-c}
\key{abort}{C-c C-q}
\key{toggle reference style}{C-c C-r}
\key{pretty-print Lisp formula}{TAB}
\key{complete Lisp symbol}{M-TAB}
\key{shift reference point}{S-cursor}
\key{shift test line for column references}{M-up/down}
\key{scroll the window showing the table}{M-S-up/down}
\key{toggle table coordinate grid}{C-c \}}
2008-01-31 10:32:03 +00:00
\section{Links}
2010-12-06 08:54:30 +00:00
\key{globally store link to the current location}{C-c l \noteone}
2008-01-31 10:32:03 +00:00
\key{insert a link (TAB completes stored links)}{C-c C-l}
\key{insert file link with file name completion}{C-u C-c C-l}
\key{edit (also hidden part of) link at point}{C-c C-l}
2008-01-31 10:32:45 +00:00
\key{open file links in emacs}{C-c C-o}
\key{...force open in emacs/other window}{C-u C-c C-o}
\key{open link at point}{mouse-1/2}
\key{...force open in emacs/other window}{mouse-3}
\key{record a position in mark ring}{C-c \%}
2008-01-31 10:32:03 +00:00
\key{jump back to last followed link(s)}{C-c \&}
2008-07-29 15:26:44 +00:00
\key{find next link}{C-c C-x C-n}
\key{find previous link}{C-c C-x C-p}
\key{edit code snippet of file at point}{C-c '}
\key{toggle inline display of linked images}{C-c C-x C-v}
\section{Working with Code (Babel)}
\key{execute code block at point}{C-c C-c}
\key{open results of code block at point}{C-c C-o}
\key{check code block at point for errors}{C-c C-v c}
\key{insert a header argument with completion}{C-c C-v j}
babel: enhanced code block movement functions Thanks to Austin Frank for suggesting these features and to Jonathan Arkell for an implementation suggestion This commit - adds `org-babel-goto-named-result' for jumping to named results - adds TAB-completion to `org-babel-goto-named-src-block' - standardizes on "-src-" instead of "-source-" in all babel functions - adds `org-babel-[next/previous]-src-block' functions and keybindings - documents the above in orgcard.tex * doc/orgcard.tex: update documentation of babel keybindings * lisp/ob-exp.el (org-exp-res/src-name-cleanup): standardized on "-src-" instead of "-source-" * lisp/ob-keys.el (org-babel-key-bindings): updating keybindings for new movement functions * lisp/ob-lob.el (org-babel-lob-ingest): standardized on "-src-" instead of "-source-" * lisp/ob-ref.el (org-babel-ref-resolve-reference): standardized on "-src-" instead of "-source-" * lisp/ob-tangle.el (org-babel-tangle-collect-blocks): standardized on "-src-" instead of "-source-" * lisp/ob.el (org-babel-src-name-regexp): standardized on "-src-" instead of "-source-" (org-babel-src-name-w-name-regexp): adding regexp for matching source names along with their names (org-babel-get-src-block-info): using new named source block regexp (org-babel-result-regexp): adding optional whitespace after result regexp (org-babel-result-w-name-regexp): adding regexp for matching results which have names (org-babel-named-src-block-regexp-for-name): standardized on "-src-" instead of "-source-" (org-babel-map-src-blocks): standardized on "-src-" instead of "-source-" (org-babel-where-is-src-block-head): standardized on "-src-" instead of "-source-" (org-babel-goto-named-src-block): standardized on "-src-" instead of "-source-", also added completing read (org-babel-src-block-names): collects source block names from a file or the current buffer (org-babel-goto-named-result): function for jumping to a named result (org-babel-result-names): returns results names from a file or the current buffer (org-babel-next-src-block): jump to the next source block (org-babel-previous-src-block): jump to the previous source block
2010-07-12 04:35:58 +00:00
\key{view expanded body of code block at point}{C-c C-v v}
\key{view information about code block at point}{C-c C-v I}
\key{go to named code block}{C-c C-v g}
babel: enhanced code block movement functions Thanks to Austin Frank for suggesting these features and to Jonathan Arkell for an implementation suggestion This commit - adds `org-babel-goto-named-result' for jumping to named results - adds TAB-completion to `org-babel-goto-named-src-block' - standardizes on "-src-" instead of "-source-" in all babel functions - adds `org-babel-[next/previous]-src-block' functions and keybindings - documents the above in orgcard.tex * doc/orgcard.tex: update documentation of babel keybindings * lisp/ob-exp.el (org-exp-res/src-name-cleanup): standardized on "-src-" instead of "-source-" * lisp/ob-keys.el (org-babel-key-bindings): updating keybindings for new movement functions * lisp/ob-lob.el (org-babel-lob-ingest): standardized on "-src-" instead of "-source-" * lisp/ob-ref.el (org-babel-ref-resolve-reference): standardized on "-src-" instead of "-source-" * lisp/ob-tangle.el (org-babel-tangle-collect-blocks): standardized on "-src-" instead of "-source-" * lisp/ob.el (org-babel-src-name-regexp): standardized on "-src-" instead of "-source-" (org-babel-src-name-w-name-regexp): adding regexp for matching source names along with their names (org-babel-get-src-block-info): using new named source block regexp (org-babel-result-regexp): adding optional whitespace after result regexp (org-babel-result-w-name-regexp): adding regexp for matching results which have names (org-babel-named-src-block-regexp-for-name): standardized on "-src-" instead of "-source-" (org-babel-map-src-blocks): standardized on "-src-" instead of "-source-" (org-babel-where-is-src-block-head): standardized on "-src-" instead of "-source-" (org-babel-goto-named-src-block): standardized on "-src-" instead of "-source-", also added completing read (org-babel-src-block-names): collects source block names from a file or the current buffer (org-babel-goto-named-result): function for jumping to a named result (org-babel-result-names): returns results names from a file or the current buffer (org-babel-next-src-block): jump to the next source block (org-babel-previous-src-block): jump to the previous source block
2010-07-12 04:35:58 +00:00
\key{go to named result}{C-c C-v r}
\key{go to the head of the current code block}{C-c C-v u}
babel: enhanced code block movement functions Thanks to Austin Frank for suggesting these features and to Jonathan Arkell for an implementation suggestion This commit - adds `org-babel-goto-named-result' for jumping to named results - adds TAB-completion to `org-babel-goto-named-src-block' - standardizes on "-src-" instead of "-source-" in all babel functions - adds `org-babel-[next/previous]-src-block' functions and keybindings - documents the above in orgcard.tex * doc/orgcard.tex: update documentation of babel keybindings * lisp/ob-exp.el (org-exp-res/src-name-cleanup): standardized on "-src-" instead of "-source-" * lisp/ob-keys.el (org-babel-key-bindings): updating keybindings for new movement functions * lisp/ob-lob.el (org-babel-lob-ingest): standardized on "-src-" instead of "-source-" * lisp/ob-ref.el (org-babel-ref-resolve-reference): standardized on "-src-" instead of "-source-" * lisp/ob-tangle.el (org-babel-tangle-collect-blocks): standardized on "-src-" instead of "-source-" * lisp/ob.el (org-babel-src-name-regexp): standardized on "-src-" instead of "-source-" (org-babel-src-name-w-name-regexp): adding regexp for matching source names along with their names (org-babel-get-src-block-info): using new named source block regexp (org-babel-result-regexp): adding optional whitespace after result regexp (org-babel-result-w-name-regexp): adding regexp for matching results which have names (org-babel-named-src-block-regexp-for-name): standardized on "-src-" instead of "-source-" (org-babel-map-src-blocks): standardized on "-src-" instead of "-source-" (org-babel-where-is-src-block-head): standardized on "-src-" instead of "-source-" (org-babel-goto-named-src-block): standardized on "-src-" instead of "-source-", also added completing read (org-babel-src-block-names): collects source block names from a file or the current buffer (org-babel-goto-named-result): function for jumping to a named result (org-babel-result-names): returns results names from a file or the current buffer (org-babel-next-src-block): jump to the next source block (org-babel-previous-src-block): jump to the previous source block
2010-07-12 04:35:58 +00:00
\key{go to the next code block}{C-c C-v n}
\key{go to the previous code block}{C-c C-v p}
\key{demarcate a code block}{C-c C-v d}
\key{execute next key sequence in code edit buffer}{C-c C-v x}
\key{execute all code blocks in current buffer}{C-c C-v b}
\key{execute all code blocks in current subtree}{C-c C-v s}
\key{tangle code blocks in current file}{C-c C-v t}
\key{tangle code blocks in supplied file}{C-c C-v f}
\key{ingest all code blocks in supplied file into the Library of Babel}{C-c C-v i}
\key{switch to the session of the current code block}{C-c C-v z}
\key{load the current code block into a session}{C-c C-v l}
\key{view sha1 hash of the current code block}{C-c C-v a}
2008-01-31 10:32:03 +00:00
\section{Completion and Template Insertion}
2008-01-31 10:32:08 +00:00
In-buffer completion completes TODO keywords at headline start, TeX
macros after ``{\tt \\}'', option keywords after ``{\tt \#-}'', TAGS
after ``{\tt :}'', and dictionary words elsewhere.
\key{complete word at point}{M-TAB}
\key{structure template (insert or wrap region)}{C-c C-,}
2008-01-31 10:32:08 +00:00
\newcolumn
\title{Org-Mode Reference Card}
2008-01-31 10:32:08 +00:00
\centerline{(for version \orgversionnumber)}
2008-01-31 10:32:28 +00:00
\section{TODO Items and Checkboxes}
2008-01-31 10:32:03 +00:00
\key{rotate the state of the current item}{C-c C-t}
\metax{select next/previous state}{\quad\quad S-LEFT/RIGHT}
\metax{select next/previous set}{\quad\quad\quad C-S-LEFT/RIGHT}
\key{toggle ORDERED property}{C-c C-x o}
\key{view TODO items in a sparse tree}{C-c / t}
\key{view 3rd TODO keyword's sparse tree}{C-3 C-c / t}
2008-01-31 10:32:03 +00:00
\key{set the priority of the current item}{C-c , [ABC]}
\key{remove priority cookie from current item}{C-c , SPC}
2010-12-06 09:51:04 +00:00
\key{raise/lower priority of current item}{S-UP/DOWN\notetwo}
2008-01-31 10:32:03 +00:00
2008-01-31 10:32:28 +00:00
\key{insert new checkbox item in plain list}{M-S-RET}
\key{toggle checkbox(es) in region/entry/at point}{C-c C-x C-b}
\key{toggle checkbox at point}{C-c C-c}
%\metax{checkbox statistics cookies: insert {\tt [/]} or {\tt [\%]}}{}
2008-01-31 10:32:32 +00:00
\key{update checkbox statistics (\kbd{C-u} : whole file)}{C-c \#}
2008-01-31 10:32:28 +00:00
2008-01-31 10:32:08 +00:00
\section{Tags}
\key{set tags for current heading}{C-c C-q}
\key{realign tags in all headings}{C-u C-c C-q}
2008-01-31 10:32:08 +00:00
\key{create sparse tree with matching tags}{C-c \\}
\key{globally (agenda) match tags at cursor}{C-c C-o}
2008-01-31 10:35:14 +00:00
\section{Properties and Column View}
\key{set property/effort}{C-c C-x p/e}
2008-01-31 10:35:14 +00:00
\key{special commands in property lines}{C-c C-c}
\key{next/previous allowed value}{S-LEFT/RIGHT}
2008-01-31 10:35:14 +00:00
\key{turn on column view}{C-c C-x C-c}
\key{capture columns view in dynamic block}{C-c C-x x}
2008-01-31 10:35:14 +00:00
\key{quit column view}{q}
\key{show full value}{v}
2008-01-31 10:35:14 +00:00
\key{edit value}{e}
\metax{next/previous allowed value}{n/p or S-LEFT/RIGHT}
2008-01-31 10:35:14 +00:00
\key{edit allowed values list}{a}
\key{make column wider/narrower}{> / <}
\key{move column left/right}{M-LEFT/RIGHT}
\key{add new column}{M-S-RIGHT}
\key{Delete current column}{M-S-LEFT}
2008-01-31 10:35:14 +00:00
2008-01-31 10:32:03 +00:00
\section{Timestamps}
\key{prompt for date and insert timestamp}{C-c .}
\key{like \kbd{C-c .} but insert date and time format}{C-u C-c .}
\key{like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
2008-01-31 10:32:03 +00:00
\key{insert DEADLINE timestamp}{C-c C-d}
\key{insert SCHEDULED timestamp}{C-c C-s}
2008-01-31 10:37:51 +00:00
\key{create sparse tree with all deadlines due}{C-c / d}
2008-01-31 10:32:03 +00:00
\key{the time between 2 dates in a time range}{C-c C-y}
\metax{change timestamp at cursor $\pm 1$ day}{\quad\quad\quad\quad S-RIGHT/LEFT \notetwo}
\key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN \notetwo}
2008-01-31 10:32:03 +00:00
\key{access the calendar for the current date}{C-c >}
\key{insert timestamp matching date in calendar}{C-c <}
\key{access agenda for current date}{C-c C-o}
\key{select date while prompted}{mouse-1/RET}
2008-01-31 10:32:03 +00:00
%\key{... select date in calendar}{mouse-1/RET}
%\key{... scroll calendar back/forward one month}{< / >}
%\key{... forward/backward one day}{S-LEFT/RIGHT}
%\key{... forward/backward one week}{S-UP/DOWN}
2009-11-12 15:13:39 +00:00
%\key{... forward/backward one month}{M-S-LEFT/RIGHT}
\key{toggle custom format display for dates/times}{C-c C-x C-t}
2008-01-31 10:32:03 +00:00
2008-01-31 10:35:14 +00:00
\newcolumn
2008-01-31 10:34:14 +00:00
{\bf Clocking time}
2008-01-31 10:32:03 +00:00
\key{start clock on current item}{C-c C-x C-i}
\key{stop/cancel clock on current item}{C-c C-x C-o/x}
2008-01-31 10:32:03 +00:00
\key{display total subtree times}{C-c C-x C-d}
\key{remove displayed times}{C-c C-c}
\key{insert/update table with clock report}{C-c C-x C-x}
2008-01-31 10:32:08 +00:00
2008-01-31 09:30:03 +00:00
\section{Agenda Views}
\key{add/move current file to front of agenda}{C-c [}
\key{remove current file from your agenda}{C-c ]}
2008-01-31 10:33:37 +00:00
\key{cycle through agenda file list}{C-'}
2008-01-31 10:38:07 +00:00
\key{set/remove restriction lock}{C-c C-x </>}
2008-01-31 09:30:03 +00:00
2010-12-06 08:54:30 +00:00
\key{compile agenda for the current week}{C-c a a \noteone}
2010-12-06 09:54:30 +00:00
\key{compile global TODO list}{C-c a t \noteone}
2010-12-06 08:54:30 +00:00
\key{compile TODO list for specific keyword}{C-c a T \noteone}
\key{match tags, TODO kwds, properties}{C-c a m \noteone}
\key{match only in TODO entries}{C-c a M \noteone}
\key{find stuck projects}{C-c a \# \noteone}
\key{configure custom commands}{C-c a C \noteone}
%\key{configure stuck projects}{C-c a ! \noteone}
2008-01-31 09:30:03 +00:00
\key{agenda for date at cursor}{C-c C-o}
{\bf Commands available in an agenda buffer}
{\bf View Org file}
2008-01-31 10:33:05 +00:00
\key{show original location of item}{SPC/mouse-3}
%\key{... also available with}{mouse-3}
2008-01-31 09:30:03 +00:00
\key{show and recenter window}{L}
2008-01-31 10:33:05 +00:00
\key{goto original location in other window}{TAB/mouse-2}
%\key{... also available with}{mouse-2}
2008-01-31 09:30:03 +00:00
\key{goto original location, delete other windows}{RET}
\key{show subtree in indirect buffer, ded.\ frame}{C-c C-x b}
\key{toggle follow-mode}{F}
2008-01-31 09:30:03 +00:00
{\bf Change display}
\key{delete other windows}{o}
2009-11-12 15:13:39 +00:00
\key{view mode dispatcher}{v}
\key{switch to day/week/month/year/def view}{d w vm vy vSP}
2009-10-23 07:22:05 +00:00
\key{toggle diary entries / time grid / habits}{D / G / K}
\key{toggle entry text / clock report}{E / R}
\key{toggle display of logbook entries}{l / v l/L/c}
\key{toggle inclusion of archived trees/files}{v a/A}
\key{refresh agenda buffer with any changes}{r / g}
2009-11-12 15:13:39 +00:00
\key{filter with respect to a tag}{/}
2008-01-31 10:32:16 +00:00
\key{save all org-mode buffers}{s}
\key{display next/previous day,week,...}{f / b}
\key{goto today / some date (prompt)}{. / j}
2008-01-31 09:30:03 +00:00
{\bf Remote editing}
\key{digit argument}{0-9}
\key{change state of current TODO item}{t}
2008-01-31 10:33:05 +00:00
\key{kill item and source}{C-k}
\key{archive default}{\$ / a}
\key{refile the subtree}{C-c C-w}
\key{set/show tags of current headline}{: / T}
\key{set effort property (prefix=nth)}{e}
\key{set / compute priority of current item}{, / P}
2010-12-06 09:51:04 +00:00
\key{raise/lower priority of current item}{S-UP/DOWN\notetwo}
\key{run an attachment command}{C-c C-a}
2008-01-31 10:31:31 +00:00
\key{schedule/set deadline for this item}{C-c C-s/d}
2010-12-06 09:51:04 +00:00
\metax{change timestamp one day earlier/later}{S-LEFT/RIGHT\notetwo}
2008-01-31 09:30:03 +00:00
\key{change timestamp to today}{>}
\key{insert new entry into diary}{i}
2008-01-31 10:35:14 +00:00
\newcolumn
2008-01-31 10:36:29 +00:00
\key{start/stop/cancel the clock on current item}{I / O / X}
\key{jump to running clock entry}{J}
\key{mark / unmark / execute bulk action}{m / u / B}
2008-01-31 10:32:03 +00:00
2008-01-31 10:33:09 +00:00
{\bf Misc}
\key{follow one or offer all links in current entry}{C-c C-o}
2008-01-31 10:32:03 +00:00
2008-01-31 09:30:03 +00:00
{\bf Calendar commands}
\key{find agenda cursor date in calendar}{c}
\key{compute agenda for calendar cursor date}{c}
\key{show phases of the moon}{M}
\key{show sunrise/sunset times}{S}
\key{show holidays}{H}
\key{convert date to other calendars}{C}
{\bf Quit and Exit}
\key{quit agenda, remove agenda buffer}{q}
\key{exit agenda, remove all agenda buffers}{x}
2008-01-31 10:35:14 +00:00
\section{LaTeX and cdlatex-mode}
\key{preview LaTeX fragment}{C-c C-x C-l}
\key{expand abbreviation (cdlatex-mode)}{TAB}
\key{insert/modify math symbol (cdlatex-mode)}{` / '}
\key{insert citation using RefTeX}{C-c C-x [}
2008-01-31 10:35:14 +00:00
2008-01-31 10:32:03 +00:00
\section{Exporting and Publishing}
2008-01-31 09:30:03 +00:00
Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
2008-01-31 10:32:03 +00:00
in the current directory. Publishing puts the resulting file into
some other place.
2008-01-31 09:30:03 +00:00
2008-01-31 10:32:03 +00:00
\key{export/publish dispatcher}{C-c C-e}
2008-01-31 09:30:03 +00:00
\key{toggle asynchronous export}{C-c C-e C-a}
\key{toggle body/visible only export}{C-c C-e C-b/v}
\key{toggle subtree export}{C-c C-e C-s}
\key{insert template of export options}{C-c C-e \#}
2008-01-31 09:30:03 +00:00
\key{toggle fixed width for entry or region}{C-c :}
\key{toggle pretty display of scripts, entities}{C-c C-x {\tt\char`\\}}
2008-01-31 09:30:03 +00:00
Lines starting with \kbd{\#} and subtrees starting with COMMENT are
never exported.
2008-01-31 09:30:03 +00:00
\key{toggle COMMENT keyword on entry}{C-c ;}
2008-01-31 10:32:28 +00:00
\section{Dynamic Blocks}
\key{update dynamic block at point}{C-c C-x C-u}
\metax{update all dynamic blocks}{C-u C-c C-x C-u}
2008-01-31 09:30:03 +00:00
\section{Notes}
2010-12-06 08:54:30 +00:00
[1] This is only a suggestion for a binding of this command. Choose
2011-07-30 12:52:46 +00:00
your own key as shown under ACTIVATION.
2008-01-31 09:30:03 +00:00
2010-12-06 09:51:04 +00:00
[2] Keybinding affected by {\tt org-support-shift-select} and also
{\tt org-replace-disputed-keys}.
2008-01-31 09:30:03 +00:00
\copyrightnotice
\bye
2008-01-31 10:34:42 +00:00
% Local variables:
2016-10-02 17:07:26 +00:00
% compile-command: "pdftex orgcard"
2008-01-31 10:34:42 +00:00
% End: