diff options
Diffstat (limited to 'doc/misc')
41 files changed, 28485 insertions, 27491 deletions
diff --git a/doc/misc/Makefile.in b/doc/misc/Makefile.in index d627055ae1d..7982c0dc5ae 100644 --- a/doc/misc/Makefile.in +++ b/doc/misc/Makefile.in @@ -22,6 +22,8 @@ SHELL = @SHELL@ # Where to find the source code. $(srcdir) will be the doc/misc subdirectory # of the source tree. This is set by configure's '--srcdir' option. srcdir=@srcdir@ +top_srcdir = @top_srcdir@ +top_builddir = @top_builddir@ ## Where the output files go. ## Note that all the Info targets build the Info files in srcdir. @@ -82,11 +84,23 @@ INFO_INSTALL = $(INFO_COMMON) $(DOCMISC_W32) ## because the info files are pre-built in release tarfiles. INFO_TARGETS = $(INFO_COMMON) efaq-w32 +## Some manuals have their source in .org format. +## This is discouraged because the .texi files it generates +## are not as well formatted as handwritten ones. +ORG_SETUP = $(wildcard ${srcdir}/*-setup.org) +ORG_SRC = $(filter-out ${ORG_SETUP},$(wildcard ${srcdir}/*.org)) +TEXI_FROM_ORG = ${ORG_SRC:.org=.texi} + # There are some naming differences between the info targets and the other # targets, so let's resolve them here. TARGETS_1 = $(INFO_INSTALL:ccmode=cc-mode) TARGETS = $(TARGETS_1:info.info=info) +texi_sources = $(addsuffix .texi,${TARGETS}) +texi_notgen = $(filter-out $(notdir ${TEXI_FROM_ORG}),${texi_sources}) +texi_and_org = $(notdir ${ORG_SRC}) ${texi_notgen} +SOURCES = $(sort ${texi_and_org}) + DVI_TARGETS = $(TARGETS:=.dvi) HTML_TARGETS = $(TARGETS:=.html) PDF_TARGETS = $(TARGETS:=.pdf) @@ -96,13 +110,7 @@ TEXI2DVI = texi2dvi TEXI2PDF = texi2pdf DVIPS = dvips -# 'make' verbosity. -AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ - -AM_V_GEN = $(am__v_GEN_@AM_V@) -am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) -am__v_GEN_0 = @echo " GEN " $@; -am__v_GEN_1 = +-include ${top_builddir}/src/verbose.mk ENVADD = $(AM_V_GEN)TEXINPUTS="$(srcdir):$(emacsdir):$(TEXINPUTS)" \ MAKEINFO="$(MAKEINFO) $(MAKEINFO_OPTS)" @@ -110,7 +118,7 @@ ENVADD = $(AM_V_GEN)TEXINPUTS="$(srcdir):$(emacsdir):$(TEXINPUTS)" \ gfdl = ${srcdir}/doclicense.texi style = ${emacsdir}/docstyle.texi -.PHONY: info dvi html pdf ps echo-info $(INFO_TARGETS) +.PHONY: info dvi html pdf ps echo-info echo-sources $(INFO_TARGETS) ## Prevent implicit rule triggering for foo.info. .SUFFIXES: @@ -126,6 +134,9 @@ echo-info: @echo "$(INFO_INSTALL) " | \ sed -e 's|[^ ]*/||g' -e 's/\.info//g' -e "s/ */.info /g" +echo-sources: + @echo ${SOURCES} + dvi: $(DVI_TARGETS) html: $(HTML_TARGETS) @@ -221,6 +232,30 @@ gnus.pdf: $(gnus_deps) ${buildinfodir}/tramp.info tramp.html: ${srcdir}/trampver.texi +abs_top_builddir = @abs_top_builddir@ +EMACS = ${abs_top_builddir}/src/emacs +emacs = "${EMACS}" -batch --no-site-file --no-site-lisp --eval '(setq load-prefer-newer t)' + +# Generated .texi files go in srcdir so they can be included in the +# release tarfile along with the others. +# Work in srcdir (and use abs_top_builddir) so that +setupfile and +# things like org-setup's "version" macro work. Sigh. +define org_template + $(1:.org=.texi): $(1) ${top_srcdir}/lisp/org/ox-texinfo.el + $${AM_V_GEN}cd "$${srcdir}" && $${emacs} -l ox-texinfo \ + -f org-texinfo-export-to-texinfo-batch $$(notdir $$<) $$(notdir $$@) +endef + +$(foreach orgfile,${ORG_SRC},$(eval $(call org_template,$(orgfile)))) + +## foo.org depends on foo-setup.org, if the latter exists. +define org_setup_template + $(1:-setup.org=.texi): $(1) +endef + +$(foreach orgfile,${ORG_SETUP},$(eval $(call org_setup_template,$(orgfile)))) + + .PHONY: mostlyclean clean distclean bootstrap-clean maintainer-clean mostlyclean: @@ -245,7 +280,13 @@ infoclean: $(buildinfodir)/$${file}-[1-9][0-9]; \ done -bootstrap-clean maintainer-clean: distclean infoclean +.PHONY: orgclean + +orgclean: + rm -f ${TEXI_FROM_ORG} + +bootstrap-clean maintainer-clean: distclean infoclean orgclean + rm -f TAGS .PHONY: install-dvi install-html install-pdf install-ps install-doc @@ -295,4 +336,20 @@ uninstall-pdf: uninstall-doc: uninstall-dvi uninstall-html uninstall-pdf uninstall-ps +ETAGS = ../../lib-src/etags${EXEEXT} + +${ETAGS}: FORCE + $(MAKE) -C $(dir $@) $(notdir $@) + +texifiles = $(wildcard ${srcdir}/*.texi) + +TAGS: ${ETAGS} $(texifiles) + $(AM_V_GEN)${ETAGS} $(texifiles) + +tags: TAGS +.PHONY: tags + +FORCE: +.PHONY: FORCE + ### Makefile ends here diff --git a/doc/misc/autotype.texi b/doc/misc/autotype.texi index 72ba73697d3..5f9dc01d33f 100644 --- a/doc/misc/autotype.texi +++ b/doc/misc/autotype.texi @@ -579,7 +579,7 @@ table: @vindex skeleton-transformation Insert string or character. Literal strings and characters are passed through @code{skeleton-transformation} when that is non-@code{nil}. -@item @code{?\n} +@item @code{\n} @c ??? something seems very wrong here. Insert a newline and align under current line, but not if this is the last element of a skeleton and the newline would be inserted at end of diff --git a/doc/misc/bovine.texi b/doc/misc/bovine.texi index 780f0addb59..9bfb117d1a5 100644 --- a/doc/misc/bovine.texi +++ b/doc/misc/bovine.texi @@ -78,13 +78,13 @@ The @dfn{bovine} parser is the original @semantic{} parser, and is an implementation of an @acronym{LL} parser. It is good for simple languages. It has many conveniences making grammar writing easy. The conveniences make it less powerful than a Bison-like @acronym{LALR} -parser. For more information, @inforef{Top, The Wisent Parser Manual, +parser. For more information, @pxref{Top,, Wisent Parser Development, wisent}. Bovine @acronym{LL} grammars are stored in files with a @file{.by} extension. When compiled, the contents is converted into a file of the form @file{NAME-by.el}. This, in turn is byte compiled. -@inforef{top, Grammar Framework Manual, grammar-fw}. +@xref{top,, Grammar Framework Manual, grammar-fw}. @ifnottex @insertcopying @@ -105,7 +105,8 @@ the form @file{NAME-by.el}. This, in turn is byte compiled. In Bison, one and only one nonterminal is designated as the ``start'' symbol. In @semantic{}, one or more nonterminals can be designated as the ``start'' symbol. They are declared following the @code{%start} -keyword separated by spaces. @inforef{start Decl, ,grammar-fw}. +keyword separated by spaces. @xref{start Decl,, Grammar Framework +Manual, grammar-fw}. If no @code{%start} keyword is used in a grammar, then the very first is used. Internally the first start nonterminal is targeted by the @@ -115,7 +116,8 @@ parser harness. To find locally defined variables, the local context handler needs to parse the body of functional code. The @code{scopestart} declaration specifies the name of a nonterminal used as the goal to parse a local -context, @inforef{scopestart Decl, ,grammar-fw}. Internally the +context, @pxref{scopestart Decl,, Grammar Framework Manual, +grammar-fw}. Internally the scopestart nonterminal is targeted by the reserved symbol @code{bovine-inner-scope}, so it can be found by the parser harness. @@ -124,7 +126,7 @@ scopestart nonterminal is targeted by the reserved symbol The rules are what allow the compiler to create tags from a language file. Once the setup is done in the prologue, you can start writing -rules. @inforef{Grammar Rules, ,grammar-fw}. +rules. @xref{Grammar Rules,, Grammar Framework Manual, grammar-fw}. @example @var{result} : @var{components1} @var{optional-semantic-action1}) @@ -146,8 +148,8 @@ A particular @var{result} written into your grammar becomes the parser's goal. It is designated by a @code{%start} statement (@pxref{Starting Rules}). The value returned by the associated @var{optional-semantic-action} is the parser's result. It should be -a tree of @semantic{} @dfn{tags}, @inforef{Semantic Tags, , -semantic-appdev}. +a tree of @semantic{} @dfn{tags}, @pxref{Semantic Tags,, Semantic +Application Development, semantic-appdev}. @var{components} is made up of symbols. A symbol such as @code{FOO} means that a syntactic token of class @code{FOO} must be matched. @@ -170,8 +172,9 @@ For instance: @end example Means that @code{FOO} is a reserved language keyword, matched as such -by looking up into a keyword table, @inforef{keyword Decl, -,grammar-fw}. This is because @code{"foo"} will be converted to +by looking up into a keyword table, @pxref{keyword Decl,, Grammar +Framework Manual, grammar-fw}. This is because @code{"foo"} will be +converted to @code{FOO} in the lexical analysis stage. Thus the symbol @code{FOO} won't be available any other way. @@ -383,8 +386,8 @@ Is an optional set of labeled values such as @code{:constant-flag t :parent Create a tag with @var{name} of respectively the class @code{variable}, @code{function}, @code{type}, @code{include}, @code{package}, and @code{code}. -See @inforef{Creating Tags, , semantic-appdev} for the lisp -functions these translate into. +See @ref{Creating Tags,, Semantic Application Development, +semantic-appdev}, for the lisp functions these translate into. @end table If the symbol @code{%quotemode backquote} is specified, then use diff --git a/doc/misc/calc.texi b/doc/misc/calc.texi index c4ccea3caf4..e11267e7a20 100644 --- a/doc/misc/calc.texi +++ b/doc/misc/calc.texi @@ -588,7 +588,7 @@ there are Quick mode, Keypad mode, and Embedded mode. * Other C-x * Commands:: @end menu -@node Starting Calc, The Standard Interface, Using Calc, Using Calc +@node Starting Calc @subsection Starting Calc @noindent @@ -619,7 +619,7 @@ type the full command (like @kbd{calc-keypad}) and press Return. The same commands (like @kbd{C-x * c} or @kbd{C-x * *}) that start the Calculator also turn it off if it is already on. -@node The Standard Interface, Quick Mode Overview, Starting Calc, Using Calc +@node The Standard Interface @subsection The Standard Calc Interface @noindent @@ -713,7 +713,7 @@ switch you to the Calc Trail window. So @kbd{C-x * o} is a handy way to switch out of Calc momentarily to edit your file; you can then type @kbd{C-x * c} to switch back into Calc when you are done. -@node Quick Mode Overview, Keypad Mode Overview, The Standard Interface, Using Calc +@node Quick Mode Overview @subsection Quick Mode (Overview) @noindent @@ -736,7 +736,7 @@ go into regular Calc (with @kbd{C-x * c}) to change the mode settings. @c [fix-ref Quick Calculator mode] @xref{Quick Calculator}, for further information. -@node Keypad Mode Overview, Standalone Operation, Quick Mode Overview, Using Calc +@node Keypad Mode Overview @subsection Keypad Mode (Overview) @noindent @@ -814,7 +814,7 @@ left, the stack in the lower right, and the trail on top. @c [fix-ref Keypad Mode] @xref{Keypad Mode}, for further information. -@node Standalone Operation, Embedded Mode Overview, Keypad Mode Overview, Using Calc +@node Standalone Operation @subsection Standalone Operation @noindent @@ -841,7 +841,7 @@ In standalone operation, quitting the Calculator (by pressing @kbd{q} or clicking on the keypad @key{EXIT} button) quits Emacs itself. -@node Embedded Mode Overview, Other C-x * Commands, Standalone Operation, Using Calc +@node Embedded Mode Overview @subsection Embedded Mode (Overview) @noindent @@ -972,7 +972,7 @@ A slope of one-third corresponds to an angle of 18.4349488229 degrees. @c [fix-ref Embedded Mode] @xref{Embedded Mode}, for full details. -@node Other C-x * Commands, , Embedded Mode Overview, Using Calc +@node Other C-x * Commands @subsection Other @kbd{C-x *} Commands @noindent @@ -1329,7 +1329,7 @@ Calc. * Answers to Exercises:: @end menu -@node Basic Tutorial, Arithmetic Tutorial, Tutorial, Tutorial +@node Basic Tutorial @section Basic Tutorial @noindent @@ -1344,7 +1344,7 @@ to control various modes of the Calculator. * Modes Tutorial:: Common mode-setting commands. @end menu -@node RPN Tutorial, Algebraic Tutorial, Basic Tutorial, Basic Tutorial +@node RPN Tutorial @subsection RPN Calculations and the Stack @cindex RPN notation @@ -1738,7 +1738,7 @@ Another common idiom is @kbd{M-0 @key{DEL}}, which clears the stack. (The @kbd{M-0} numeric prefix tells @key{DEL} to operate on the entire stack.) -@node Algebraic Tutorial, Undo Tutorial, RPN Tutorial, Basic Tutorial +@node Algebraic Tutorial @subsection Algebraic-Style Calculations @noindent @@ -2038,7 +2038,7 @@ You can also ``unstore'' a variable when you are through with it: We will encounter formulas involving variables and functions again when we discuss the algebra and calculus features of the Calculator. -@node Undo Tutorial, Modes Tutorial, Algebraic Tutorial, Basic Tutorial +@node Undo Tutorial @subsection Undo and Redo @noindent @@ -2175,7 +2175,7 @@ new number. This works for formulas, vectors, and all other types of values you can put on the stack. The @kbd{`} key also works during entry of a number or algebraic formula. -@node Modes Tutorial, , Undo Tutorial, Basic Tutorial +@node Modes Tutorial @subsection Mode-Setting Commands @noindent @@ -2655,7 +2655,7 @@ again when we change to Fraction mode. All @samp{=>} expressions on the stack are recomputed every time you change any mode that might affect their values. -@node Arithmetic Tutorial, Vector/Matrix Tutorial, Basic Tutorial, Tutorial +@node Arithmetic Tutorial @section Arithmetic Tutorial @noindent @@ -3041,7 +3041,7 @@ like @code{pv}, @code{rate}, and @code{sln}). @xref{Binary Functions}, to read about the commands for operating on binary numbers (like @code{and}, @code{xor}, and @code{lsh}). -@node Vector/Matrix Tutorial, Types Tutorial, Arithmetic Tutorial, Tutorial +@node Vector/Matrix Tutorial @section Vector/Matrix Tutorial @noindent @@ -3056,7 +3056,7 @@ a vector as a list of objects. * List Tutorial:: @end menu -@node Vector Analysis Tutorial, Matrix Tutorial, Vector/Matrix Tutorial, Vector/Matrix Tutorial +@node Vector Analysis Tutorial @subsection Vector Analysis @noindent @@ -3181,7 +3181,7 @@ probabilities for the particle to be at the corresponding positions. Find the average position of the particle. @xref{Vector Answer 2, 2}. (@bullet{}) -@node Matrix Tutorial, List Tutorial, Vector Analysis Tutorial, Vector/Matrix Tutorial +@node Matrix Tutorial @subsection Matrices @noindent @@ -3507,7 +3507,7 @@ $$ @noindent @xref{Matrix Answer 3, 3}. (@bullet{}) -@node List Tutorial, , Matrix Tutorial, Vector/Matrix Tutorial +@node List Tutorial @subsection Vectors as Lists @noindent @@ -4214,7 +4214,7 @@ walk to walk a unit distance, but in a random direction, at each step. (Hint: The @code{sincos} function returns a vector of the cosine and sine of an angle.) @xref{List Answer 14, 14}. (@bullet{}) -@node Types Tutorial, Algebra Tutorial, Vector/Matrix Tutorial, Tutorial +@node Types Tutorial @section Types Tutorial @noindent @@ -4738,7 +4738,7 @@ Power Pill he eats doubles his speed. How many Power Pills can he swallow and still travel legally on most US highways? @xref{Types Answer 15, 15}. (@bullet{}) -@node Algebra Tutorial, Programming Tutorial, Types Tutorial, Tutorial +@node Algebra Tutorial @section Algebra and Calculus Tutorial @noindent @@ -4751,7 +4751,7 @@ formulas. * Rewrites Tutorial:: @end menu -@node Basic Algebra Tutorial, Rewrites Tutorial, Algebra Tutorial, Algebra Tutorial +@node Basic Algebra Tutorial @subsection Basic Algebra @noindent @@ -5246,7 +5246,7 @@ details and examples. @c hard exercise: simplify (2^(n r) - 2^(r*(n - 1))) / (2^r - 1) 2^(n - 1) @c to 2^((n-1)*(r-1)). -@node Rewrites Tutorial, , Basic Algebra Tutorial, Algebra Tutorial +@node Rewrites Tutorial @subsection Rewrite Rules @noindent @@ -5687,7 +5687,7 @@ a nasty surprise when you use Calc to balance your checkbook!) @xref{Rewrite Rules}, for the whole story on rewrite rules. -@node Programming Tutorial, Answers to Exercises, Algebra Tutorial, Tutorial +@node Programming Tutorial @section Programming Tutorial @noindent @@ -6346,7 +6346,7 @@ The rest of this manual tells the whole story. @c Volume II of this manual, the @dfn{Calc Reference}, tells the whole story. @page -@node Answers to Exercises, , Programming Tutorial, Tutorial +@node Answers to Exercises @section Answers to Exercises @noindent @@ -6433,7 +6433,7 @@ This section includes answers to all the exercises in the Calc tutorial. \gdef\chapternofonts{\let\write=\skipwrite\oldchapternofonts} @end tex -@node RPN Answer 1, RPN Answer 2, Answers to Exercises, Answers to Exercises +@node RPN Answer 1 @subsection RPN Tutorial Exercise 1 @noindent @@ -6443,7 +6443,7 @@ The result is @texline @math{1 - (2 \times (3 + 4)) = -13}. @infoline @expr{1 - (2 * (3 + 4)) = -13}. -@node RPN Answer 2, RPN Answer 3, RPN Answer 1, Answers to Exercises +@node RPN Answer 2 @subsection RPN Tutorial Exercise 2 @noindent @@ -6500,7 +6500,7 @@ advantage of using only three stack levels. But since Calc's stack can grow arbitrarily large this isn't really an issue. Which method you choose is purely a matter of taste. -@node RPN Answer 3, RPN Answer 4, RPN Answer 2, Answers to Exercises +@node RPN Answer 3 @subsection RPN Tutorial Exercise 3 @noindent @@ -6531,7 +6531,7 @@ Similarly, @kbd{M-@key{TAB}} gives you access to the number in level 3. @end group @end smallexample -@node RPN Answer 4, Algebraic Answer 1, RPN Answer 3, Answers to Exercises +@node RPN Answer 4 @subsection RPN Tutorial Exercise 4 @noindent @@ -6569,7 +6569,7 @@ enough that Calc provides a special key, @kbd{M-@key{DEL}}, to do just that. @kbd{M-@key{DEL}} is just like @kbd{@key{TAB} @key{DEL}}, except that it doesn't exhibit the ``feature'' that tripped poor Joe.) -@node Algebraic Answer 1, Algebraic Answer 2, RPN Answer 4, Answers to Exercises +@node Algebraic Answer 1 @subsection Algebraic Entry Tutorial Exercise 1 @noindent @@ -6582,7 +6582,7 @@ Or, RPN style, @kbd{0.5 ^}. a closer equivalent, since @samp{9^0.5} yields @expr{3.0} whereas @samp{sqrt(9)} and @samp{9^1:2} yield the exact integer @expr{3}.) -@node Algebraic Answer 2, Algebraic Answer 3, Algebraic Answer 1, Answers to Exercises +@node Algebraic Answer 2 @subsection Algebraic Entry Tutorial Exercise 2 @noindent @@ -6591,7 +6591,7 @@ name with @samp{1+y} as its argument. Assigning a value to a variable has no relation to a function by the same name. Joe needed to use an explicit @samp{*} symbol here: @samp{2 x*(1+y)}. -@node Algebraic Answer 3, Modes Answer 1, Algebraic Answer 2, Answers to Exercises +@node Algebraic Answer 3 @subsection Algebraic Entry Tutorial Exercise 3 @noindent @@ -6608,11 +6608,12 @@ multiply infinity by zero, Calc uses another special new symbol to show that the answer is ``indeterminate.'' @xref{Infinities}, for further discussion of infinite and indeterminate values. -@node Modes Answer 1, Modes Answer 2, Algebraic Answer 3, Answers to Exercises +@node Modes Answer 1 @subsection Modes Tutorial Exercise 1 @noindent -Calc always stores its numbers in decimal, so even though one-third has +Calc always stores its floating-point numbers in decimal, +so even though one-third has an exact base-3 representation (@samp{3#0.1}), it is still stored as 0.3333333 (chopped off after 12 or however many decimal digits) inside the calculator's memory. When this inexact number is converted back @@ -6668,7 +6669,7 @@ in binary, octal, or hexadecimal is also exact in decimal, so the kinds of problems we saw in this exercise are likely to be severe only when you use a relatively unusual radix like 3. -@node Modes Answer 2, Modes Answer 3, Modes Answer 1, Answers to Exercises +@node Modes Answer 2 @subsection Modes Tutorial Exercise 2 If the radix is 15 or higher, we can't use the letter @samp{e} to mark @@ -6688,7 +6689,7 @@ it by the floating-point @samp{16#1.23}). While this wouldn't normally matter for display purposes, it could give you a nasty surprise if you copied that number into a file and later moved it back into Calc. -@node Modes Answer 3, Modes Answer 4, Modes Answer 2, Answers to Exercises +@node Modes Answer 3 @subsection Modes Tutorial Exercise 3 @noindent @@ -6730,7 +6731,7 @@ exactly was the quantity 45 degrees, so the precision must be raised before anything is done after the number 45 has been entered in order for the higher precision to be meaningful. -@node Modes Answer 4, Arithmetic Answer 1, Modes Answer 3, Answers to Exercises +@node Modes Answer 4 @subsection Modes Tutorial Exercise 4 @noindent @@ -6751,7 +6752,7 @@ Also, rational numbers cannot express the results of all calculations. There is no fractional form for the square root of two, so if you type @w{@kbd{2 Q}}, Calc has no choice but to give you a floating-point answer. -@node Arithmetic Answer 1, Arithmetic Answer 2, Modes Answer 4, Answers to Exercises +@node Arithmetic Answer 1 @subsection Arithmetic Tutorial Exercise 1 @noindent @@ -6771,7 +6772,7 @@ produces the exact fraction @expr{123456789:2}, which can be rounded down by the @kbd{F} command without ever switching to floating-point format. -@node Arithmetic Answer 2, Vector Answer 1, Arithmetic Answer 1, Answers to Exercises +@node Arithmetic Answer 2 @subsection Arithmetic Tutorial Exercise 2 @noindent @@ -6783,7 +6784,7 @@ or (when in Fraction mode) the reciprocal of an integer. But there is no efficient way to search the space of all possible rational numbers for an exact answer, so Calc doesn't try. -@node Vector Answer 1, Vector Answer 2, Arithmetic Answer 2, Answers to Exercises +@node Vector Answer 1 @subsection Vector Tutorial Exercise 1 @noindent @@ -6803,7 +6804,7 @@ by its length: @kbd{@key{RET} A /}. The final @kbd{A} command shows that the normalized vector does indeed have unit length. -@node Vector Answer 2, Matrix Answer 1, Vector Answer 1, Answers to Exercises +@node Vector Answer 2 @subsection Vector Tutorial Exercise 2 @noindent @@ -6812,14 +6813,14 @@ positions times their corresponding probabilities. This is the definition of the dot product operation. So all you need to do is to put the two vectors on the stack and press @kbd{*}. -@node Matrix Answer 1, Matrix Answer 2, Vector Answer 2, Answers to Exercises +@node Matrix Answer 1 @subsection Matrix Tutorial Exercise 1 @noindent The trick is to multiply by a vector of ones. Use @kbd{r 4 [1 1 1] *} to get the row sum. Similarly, use @kbd{[1 1] r 4 *} to get the column sum. -@node Matrix Answer 2, Matrix Answer 3, Matrix Answer 1, Answers to Exercises +@node Matrix Answer 2 @subsection Matrix Tutorial Exercise 2 @ifnottex @@ -6865,7 +6866,7 @@ mode: Type @kbd{d N} to return to Normal display mode afterwards. -@node Matrix Answer 3, List Answer 1, Matrix Answer 2, Answers to Exercises +@node Matrix Answer 3 @subsection Matrix Tutorial Exercise 3 @noindent @@ -6983,7 +6984,7 @@ the original system of equations to see how well they match. This is reasonably close to our original @expr{B} vector, @expr{[6, 2, 3, 11]}. -@node List Answer 1, List Answer 2, Matrix Answer 3, Answers to Exercises +@node List Answer 1 @subsection List Tutorial Exercise 1 @noindent @@ -7015,7 +7016,7 @@ vector. @end group @end smallexample -@node List Answer 2, List Answer 3, List Answer 1, Answers to Exercises +@node List Answer 2 @subsection List Tutorial Exercise 2 @noindent @@ -7098,7 +7099,7 @@ arithmetic functions! In fact, there is a built-in @kbd{a F} command that does least-squares fits. @xref{Curve Fitting}. -@node List Answer 3, List Answer 4, List Answer 2, Answers to Exercises +@node List Answer 3 @subsection List Tutorial Exercise 3 @noindent @@ -7142,7 +7143,7 @@ how many numbers are in this list. Then we could type: You could also type @kbd{& ^} to take the reciprocal of 9 and then raise the number to that power.) -@node List Answer 4, List Answer 5, List Answer 3, Answers to Exercises +@node List Answer 4 @subsection List Tutorial Exercise 4 @noindent @@ -7182,7 +7183,7 @@ The first divisor function is the sum of the divisors. Once again, the last two steps just compute a dot product for which a simple @kbd{*} would have worked equally well. -@node List Answer 5, List Answer 6, List Answer 4, Answers to Exercises +@node List Answer 5 @subsection List Tutorial Exercise 5 @noindent @@ -7221,14 +7222,14 @@ Incidentally, Calc provides the @dfn{Möbius μ} function which is zero if and only if its argument is square-free. It would be a much more convenient way to do the above test in practice. -@node List Answer 6, List Answer 7, List Answer 5, Answers to Exercises +@node List Answer 6 @subsection List Tutorial Exercise 6 @noindent First use @kbd{v x 6 @key{RET}} to get a list of integers, then @kbd{V M v x} to get a list of lists of integers! -@node List Answer 7, List Answer 8, List Answer 6, Answers to Exercises +@node List Answer 7 @subsection List Tutorial Exercise 7 @noindent @@ -7301,7 +7302,7 @@ triangular list. since each element of the main vector is itself a small vector, @kbd{V R +} computes the sum of its elements.) -@node List Answer 8, List Answer 9, List Answer 7, Answers to Exercises +@node List Answer 8 @subsection List Tutorial Exercise 8 @noindent @@ -7390,7 +7391,7 @@ The output from @kbd{a X} is a vector containing the value of @expr{x} that maximizes the function, and the function's value at that maximum. As you can see, our simple search got quite close to the right answer. -@node List Answer 9, List Answer 10, List Answer 8, Answers to Exercises +@node List Answer 9 @subsection List Tutorial Exercise 9 @noindent @@ -7512,7 +7513,7 @@ Another way to do this final step would be to reduce the formula @end group @end smallexample -@node List Answer 10, List Answer 11, List Answer 9, Answers to Exercises +@node List Answer 10 @subsection List Tutorial Exercise 10 @noindent @@ -7543,7 +7544,7 @@ Here's a more correct method: @end group @end smallexample -@node List Answer 11, List Answer 12, List Answer 10, Answers to Exercises +@node List Answer 11 @subsection List Tutorial Exercise 11 @noindent @@ -7610,7 +7611,7 @@ will be slightly different from the one shown here!) If you typed @kbd{v .} and @kbd{t .} before, type them again to return to full-sized display of vectors. -@node List Answer 12, List Answer 13, List Answer 11, Answers to Exercises +@node List Answer 12 @subsection List Tutorial Exercise 12 @noindent @@ -7721,7 +7722,7 @@ exercise 10, of Knuth's @emph{Art of Computer Programming}, volume II. If you typed @kbd{v .} and @kbd{t .} before, type them again to return to full-sized display of vectors. -@node List Answer 13, List Answer 14, List Answer 12, Answers to Exercises +@node List Answer 13 @subsection List Tutorial Exercise 13 @noindent @@ -7861,7 +7862,7 @@ Later in the tutorial we will encounter @dfn{modulo forms}, which basically automate the idea of reducing every intermediate result modulo some value @var{m}. -@node List Answer 14, Types Answer 1, List Answer 13, Answers to Exercises +@node List Answer 14 @subsection List Tutorial Exercise 14 We want to use @kbd{H V U} to nest a function which adds a random @@ -7926,7 +7927,7 @@ and in the second we could use polar complex numbers with random phase angles. (This exercise was first suggested in this form by Randal Schwartz.) -@node Types Answer 1, Types Answer 2, List Answer 14, Answers to Exercises +@node Types Answer 1 @subsection Types Tutorial Exercise 1 @noindent @@ -7970,7 +7971,7 @@ Notice that we didn't need to re-round the number when we reduced the precision. Remember, arithmetic operations always round their inputs to the current precision before they begin. -@node Types Answer 2, Types Answer 3, Types Answer 1, Answers to Exercises +@node Types Answer 2 @subsection Types Tutorial Exercise 2 @noindent @@ -8006,7 +8007,7 @@ input. As in the @expr{1 / 0} case, Calc will only use infinities here if you have turned on Infinite mode. Otherwise, it will treat @samp{ln(0)} as an error. -@node Types Answer 3, Types Answer 4, Types Answer 2, Answers to Exercises +@node Types Answer 3 @subsection Types Tutorial Exercise 3 @noindent @@ -8028,7 +8029,7 @@ for infinities (only the direction counts, not the ``size''); but Calc is careful to write @code{nan} any time this simple model is unable to tell what the true answer is. -@node Types Answer 4, Types Answer 5, Types Answer 3, Answers to Exercises +@node Types Answer 4 @subsection Types Tutorial Exercise 4 @smallexample @@ -8057,7 +8058,7 @@ The average song length is two minutes and 47.4 seconds. @noindent The album would be 53 minutes and 6 seconds long. -@node Types Answer 5, Types Answer 6, Types Answer 4, Answers to Exercises +@node Types Answer 5 @subsection Types Tutorial Exercise 5 @noindent @@ -8109,7 +8110,7 @@ Et voilà, September 13, 1991 is a Friday. @noindent And the answer to our original question: 242 days to go. -@node Types Answer 6, Types Answer 7, Types Answer 5, Answers to Exercises +@node Types Answer 6 @subsection Types Tutorial Exercise 6 @noindent @@ -8155,7 +8156,7 @@ of course, that the algorithm for computing leap years remains unchanged for that long. @xref{Date Forms}, for some interesting background information in that regard.) -@node Types Answer 7, Types Answer 8, Types Answer 6, Answers to Exercises +@node Types Answer 7 @subsection Types Tutorial Exercise 7 @noindent @@ -8200,7 +8201,7 @@ well as a vector. This saves us some retyping of numbers. @noindent Thus the volume is 6316 cubic centimeters, within about 11 percent. -@node Types Answer 8, Types Answer 9, Types Answer 7, Answers to Exercises +@node Types Answer 8 @subsection Types Tutorial Exercise 8 @noindent @@ -8232,7 +8233,7 @@ It may be disappointing to hear ``the answer lies somewhere between minus infinity and plus infinity, inclusive,'' but that's the best that interval arithmetic can do in this case. -@node Types Answer 9, Types Answer 10, Types Answer 8, Answers to Exercises +@node Types Answer 9 @subsection Types Tutorial Exercise 9 @smallexample @@ -8256,7 +8257,7 @@ for different numbers. The same issue arises when you try to square an error form. -@node Types Answer 10, Types Answer 11, Types Answer 9, Answers to Exercises +@node Types Answer 10 @subsection Types Tutorial Exercise 10 @noindent @@ -8304,7 +8305,7 @@ numbers it does an exact test; for large numbers it uses a variant of the Fermat test we used here. You can use @kbd{k p} repeatedly to prove that a large integer is prime with any desired probability. -@node Types Answer 11, Types Answer 12, Types Answer 10, Answers to Exercises +@node Types Answer 11 @subsection Types Tutorial Exercise 11 @noindent @@ -8352,7 +8353,7 @@ HMS form: The @kbd{=} key is necessary to evaluate the symbol @samp{pi} to the actual number 3.14159... -@node Types Answer 12, Types Answer 13, Types Answer 11, Answers to Exercises +@node Types Answer 12 @subsection Types Tutorial Exercise 12 @noindent @@ -8382,13 +8383,13 @@ each. @noindent No matter how long it is, the album will fit nicely on one CD. -@node Types Answer 13, Types Answer 14, Types Answer 12, Answers to Exercises +@node Types Answer 13 @subsection Types Tutorial Exercise 13 @noindent Type @kbd{' 1 yr @key{RET} u c s @key{RET}}. The answer is 31557600 seconds. -@node Types Answer 14, Types Answer 15, Types Answer 13, Answers to Exercises +@node Types Answer 14 @subsection Types Tutorial Exercise 14 @noindent @@ -8422,7 +8423,7 @@ Thus a signal could take up to 81 percent of a clock cycle just to go from one place to another inside the computer, assuming the signal could actually attain the full speed of light. Pretty tight! -@node Types Answer 15, Algebra Answer 1, Types Answer 14, Answers to Exercises +@node Types Answer 15 @subsection Types Tutorial Exercise 15 @noindent @@ -8456,7 +8457,7 @@ answer, assuming that each successive pill doubles his speed. @noindent Thus Sam can take up to 14 pills without a worry. -@node Algebra Answer 1, Algebra Answer 2, Types Answer 15, Answers to Exercises +@node Algebra Answer 1 @subsection Algebra Tutorial Exercise 1 @noindent @@ -8468,7 +8469,7 @@ simplified to @samp{abs(x)}, but for general complex arguments even that is not safe. (@xref{Declarations}, for a way to tell Calc that @expr{x} is known to be real.) -@node Algebra Answer 2, Algebra Answer 3, Algebra Answer 1, Answers to Exercises +@node Algebra Answer 2 @subsection Algebra Tutorial Exercise 2 @noindent @@ -8511,7 +8512,7 @@ familiar form. Sure enough, our answer (multiplied by a suitable constant) is the same as the original polynomial. -@node Algebra Answer 3, Algebra Answer 4, Algebra Answer 2, Answers to Exercises +@node Algebra Answer 3 @subsection Algebra Tutorial Exercise 3 @smallexample @@ -8574,7 +8575,7 @@ same as the original polynomial. @end group @end smallexample -@node Algebra Answer 4, Rewrites Answer 1, Algebra Answer 3, Answers to Exercises +@node Algebra Answer 4 @subsection Algebra Tutorial Exercise 4 @noindent @@ -8644,7 +8645,7 @@ same thing. @noindent Wow! That's even better than the result from the Taylor series method. -@node Rewrites Answer 1, Rewrites Answer 2, Algebra Answer 4, Answers to Exercises +@node Rewrites Answer 1 @subsection Rewrites Tutorial Exercise 1 @noindent @@ -8696,7 +8697,7 @@ The multiply-by-conjugate rule turns out to be useful in many different circumstances, such as when the denominator involves sines and cosines or the imaginary constant @code{i}. -@node Rewrites Answer 2, Rewrites Answer 3, Rewrites Answer 1, Answers to Exercises +@node Rewrites Answer 2 @subsection Rewrites Tutorial Exercise 2 @noindent @@ -8732,7 +8733,7 @@ help keep this from happening by accident would be to use something like @samp{ZzFib} instead of @code{fib} as the name of the three-argument function. -@node Rewrites Answer 3, Rewrites Answer 4, Rewrites Answer 2, Answers to Exercises +@node Rewrites Answer 3 @subsection Rewrites Tutorial Exercise 3 @noindent @@ -8754,7 +8755,7 @@ to it. While this may seem odd, it's just as valid a solution as the on the lefthand side, so that the rule matches the actual variable @samp{x} rather than letting @samp{x} stand for something else.) -@node Rewrites Answer 4, Rewrites Answer 5, Rewrites Answer 3, Answers to Exercises +@node Rewrites Answer 4 @subsection Rewrites Tutorial Exercise 4 @noindent @@ -8827,7 +8828,7 @@ will not get into an infinite loop. Calc will not be able to prove the symbol @samp{x} is either even or odd, so none of the rules will apply and the rewrites will stop right away. -@node Rewrites Answer 5, Rewrites Answer 6, Rewrites Answer 4, Answers to Exercises +@node Rewrites Answer 5 @subsection Rewrites Tutorial Exercise 5 @noindent @@ -8851,7 +8852,7 @@ Here we have taken advantage of the fact that earlier rules always match before later rules; @samp{nterms(x)} will only be tried if we already know that @samp{x} is not a sum. -@node Rewrites Answer 6, Programming Answer 1, Rewrites Answer 5, Answers to Exercises +@node Rewrites Answer 6 @subsection Rewrites Tutorial Exercise 6 @noindent @@ -8926,7 +8927,7 @@ for a way to do this in Calc, although for something as involved as this it would probably be better to write the formatting routine in Lisp.) -@node Programming Answer 1, Programming Answer 2, Rewrites Answer 6, Answers to Exercises +@node Programming Answer 1 @subsection Programming Tutorial Exercise 1 @noindent @@ -8939,7 +8940,7 @@ to be used within @code{ninteg}. The exact keystrokes are @kbd{Z F s Si @key{RET} @key{RET} C-b C-b @key{DEL} @key{DEL} @key{RET} y}. (The @kbd{C-b C-b @key{DEL} @key{DEL}} are what fix the argument list.) -@node Programming Answer 2, Programming Answer 3, Programming Answer 1, Answers to Exercises +@node Programming Answer 2 @subsection Programming Tutorial Exercise 2 @noindent @@ -8956,7 +8957,7 @@ which is just what we want: @kbd{C-x ( M-- 3 n C-x )}. Just for kicks, let's also do it algebraically: @w{@kbd{C-x ( ' -$$$, $$, $ @key{RET} C-x )}}. -@node Programming Answer 3, Programming Answer 4, Programming Answer 2, Answers to Exercises +@node Programming Answer 3 @subsection Programming Tutorial Exercise 3 @noindent @@ -8992,13 +8993,13 @@ next command.) Using algebraic entry: @kbd{C-x ( ' index($) @key{RET} C-x )}. -@node Programming Answer 4, Programming Answer 5, Programming Answer 3, Answers to Exercises +@node Programming Answer 4 @subsection Programming Tutorial Exercise 4 @noindent Here's one way: @kbd{C-x ( @key{RET} V R + @key{TAB} v l / C-x )}. -@node Programming Answer 5, Programming Answer 6, Programming Answer 4, Answers to Exercises +@node Programming Answer 5 @subsection Programming Tutorial Exercise 5 @smallexample @@ -9014,7 +9015,7 @@ Here's one way: @kbd{C-x ( @key{RET} V R + @key{TAB} v l / C-x )}. @noindent This answer is quite accurate. -@node Programming Answer 6, Programming Answer 7, Programming Answer 5, Answers to Exercises +@node Programming Answer 6 @subsection Programming Tutorial Exercise 6 @noindent @@ -9043,7 +9044,7 @@ number (a 209-digit integer!)@: in about 10 steps; even though the @kbd{Z < ... Z >} solution had much simpler steps, it would have required so many steps that it would not have been practical. -@node Programming Answer 7, Programming Answer 8, Programming Answer 6, Answers to Exercises +@node Programming Answer 7 @subsection Programming Tutorial Exercise 7 @noindent @@ -9084,7 +9085,7 @@ loop counter exceeds 4. Thus we find that the 30th harmonic number is 3.99, and the 31st harmonic number is 4.02. -@node Programming Answer 8, Programming Answer 9, Programming Answer 7, Answers to Exercises +@node Programming Answer 8 @subsection Programming Tutorial Exercise 8 @noindent @@ -9200,7 +9201,7 @@ Also, of course, @kbd{a R} is a built-in command that uses Newton's method (among others) to look for numerical solutions to any equation. @xref{Root Finding}. -@node Programming Answer 9, Programming Answer 10, Programming Answer 8, Answers to Exercises +@node Programming Answer 9 @subsection Programming Tutorial Exercise 9 @noindent @@ -9323,7 +9324,7 @@ C-x ) @end group @end example -@node Programming Answer 10, Programming Answer 11, Programming Answer 9, Answers to Exercises +@node Programming Answer 10 @subsection Programming Tutorial Exercise 10 @noindent @@ -9421,7 +9422,7 @@ C-x ( 1 + 0 @key{RET} 1 C-u v x ' x @key{RET} @key{TAB} V M ^ * C-x ) @end group @end example -@node Programming Answer 11, Programming Answer 12, Programming Answer 10, Answers to Exercises +@node Programming Answer 11 @subsection Programming Tutorial Exercise 11 @noindent @@ -9526,7 +9527,7 @@ first, because @code{read-kbd-macro} doesn't need to execute the definition as it reads it in. For this reason, @code{C-x * m} is often the easiest way to create recursive programs in Calc. -@node Programming Answer 12, , Programming Answer 11, Answers to Exercises +@node Programming Answer 12 @subsection Programming Tutorial Exercise 12 @noindent @@ -9567,7 +9568,7 @@ the last rule. @c [reference] -@node Introduction, Data Types, Tutorial, Top +@node Introduction @chapter Introduction @noindent @@ -9592,7 +9593,7 @@ numeric entry, undo, numeric prefix arguments, etc. * Troubleshooting Commands:: @end menu -@node Basic Commands, Help Commands, Introduction, Introduction +@node Basic Commands @section Basic Commands @noindent @@ -9761,7 +9762,7 @@ the stack but resets everything else to its initial state; with a negative prefix argument, @kbd{C-x * 0} preserves the contents of the stack but resets everything else to its default state. -@node Help Commands, Stack Basics, Basic Commands, Introduction +@node Help Commands @section Help Commands @noindent @@ -9906,7 +9907,7 @@ distribution, and warranty information about Calc. These work by pulling up the appropriate parts of the ``Copying'' or ``Reporting Bugs'' sections of the manual. -@node Stack Basics, Numeric Entry, Help Commands, Introduction +@node Stack Basics @section Stack Basics @noindent @@ -9958,7 +9959,7 @@ The @key{TAB} key swaps the top two objects on the stack. @xref{Stack and Trail}, for descriptions of these and other stack-related commands. -@node Numeric Entry, Algebraic Entry, Stack Basics, Introduction +@node Numeric Entry @section Numeric Entry @noindent @@ -9995,7 +9996,7 @@ data types. @xref{Data Types}. During numeric entry, the only editing key available is @key{DEL}. -@node Algebraic Entry, Quick Calculator, Numeric Entry, Introduction +@node Algebraic Entry @section Algebraic Entry @noindent @@ -10113,7 +10114,7 @@ is being pushed on the stack. Thus @kbd{' 1+2 @key{RET}} pushes 3 on the stack, but @kbd{' 1+2 @key{LFD}} pushes the formula @expr{1+2}; you might then press @kbd{=} when it is time to evaluate this formula. -@node Quick Calculator, Prefix Arguments, Algebraic Entry, Introduction +@node Quick Calculator @section ``Quick Calculator'' Mode @noindent @@ -10182,7 +10183,7 @@ or computing the answer than the full Calculator; the name ``quick'' merely refers to the fact that it's much less hassle to use for small calculations. -@node Prefix Arguments, Undo, Quick Calculator, Introduction +@node Prefix Arguments @section Numeric Prefix Arguments @noindent @@ -10230,7 +10231,7 @@ to the fourth power and set the precision to that value. Conversely, if you have typed a numeric prefix argument the @kbd{~} key pushes it onto the stack in the form of an integer. -@node Undo, Error Messages, Prefix Arguments, Introduction +@node Undo @section Undoing Mistakes @noindent @@ -10288,7 +10289,7 @@ It is also possible to recall previous results or inputs using the trail. The standard Emacs @kbd{C-_} undo key is recognized as a synonym for @kbd{U}. -@node Error Messages, Multiple Calculators, Undo, Introduction +@node Error Messages @section Error Messages @noindent @@ -10319,7 +10320,7 @@ after your computation finishes.) By default, this occurs only for @emph{all} messages automatically, or to report none automatically (so that you must always press @kbd{w} yourself to see the messages). -@node Multiple Calculators, Troubleshooting Commands, Error Messages, Introduction +@node Multiple Calculators @section Multiple Calculators @noindent @@ -10346,7 +10347,7 @@ the stack and mode settings of the buffer being quit as the new defaults. There is only one trail buffer, @file{*Calc Trail*}, used by all Calculator buffers. -@node Troubleshooting Commands, , Multiple Calculators, Introduction +@node Troubleshooting Commands @section Troubleshooting Commands @noindent @@ -10363,7 +10364,7 @@ to a bug or deficiency in Calc. * Debugging Calc:: @end menu -@node Autoloading Problems, Recursion Depth, Troubleshooting Commands, Troubleshooting Commands +@node Autoloading Problems @subsection Autoloading Problems @noindent @@ -10380,7 +10381,7 @@ If this happens, the easiest workaround is to type @kbd{C-x * L} loaded right away. This will cause Emacs to take up a lot more memory than it would otherwise, but it's guaranteed to fix the problem. -@node Recursion Depth, Caches, Autoloading Problems, Troubleshooting Commands +@node Recursion Depth @subsection Recursion Depth @noindent @@ -10408,7 +10409,7 @@ The default value is 1000. These commands also double or halve @code{max-specpdl-size}, another internal Lisp recursion limit. The minimum value for this limit is 600. -@node Caches, Debugging Calc, Recursion Depth, Troubleshooting Commands +@node Caches @subsection Caches @noindent @@ -10437,7 +10438,7 @@ If you suspect a Calculator cache has become corrupt, you can use the The @kbd{C-x * 0} (with the zero key) command also resets caches along with all other aspects of the Calculator's state. -@node Debugging Calc, , Caches, Troubleshooting Commands +@node Debugging Calc @subsection Debugging Calc @noindent @@ -10490,7 +10491,7 @@ error. After you have executed @code{calc-pass-errors}, Lisp errors will be reported correctly but the user-friendly message will be lost. -@node Data Types, Stack and Trail, Introduction, Top +@node Data Types @chapter Data Types @noindent @@ -10525,7 +10526,7 @@ matrices, or algebraic formulas. * Formulas:: @end menu -@node Integers, Fractions, Data Types, Data Types +@node Integers @section Integers @noindent @@ -10551,7 +10552,7 @@ to set the default radix for display of integers. Numbers of any radix may be entered at any time. If you press @kbd{#} at the beginning of a number, the current display radix is used. -@node Fractions, Floats, Integers, Data Types +@node Fractions @section Fractions @noindent @@ -10572,7 +10573,7 @@ Non-decimal fractions are entered and displayed as @samp{@var{radix}#@var{num}:@var{denom}} (or in the analogous three-part form). The numerator and denominator always use the same radix. -@node Floats, Complex Numbers, Fractions, Data Types +@node Floats @section Floats @noindent @@ -10646,7 +10647,7 @@ the letter @samp{e} is a digit, so scientific notation must be written out, e.g., @samp{16#123.4567*16^2}. The first two exercises of the Modes Tutorial explore some of the properties of non-decimal floats. -@node Complex Numbers, Infinities, Floats, Data Types +@node Complex Numbers @section Complex Numbers @noindent @@ -10684,7 +10685,7 @@ A complex result in which the imaginary part is zero (or the phase angle is 0 or 180 degrees or @cpi{} radians) is automatically converted to a real number. -@node Infinities, Vectors and Matrices, Complex Numbers, Data Types +@node Infinities @section Infinities @noindent @@ -10771,7 +10772,7 @@ expressions are @samp{inf - inf} and @samp{inf ^ 0}. Also, Infinities are especially useful as parts of @dfn{intervals}. @xref{Interval Forms}. -@node Vectors and Matrices, Strings, Infinities, Data Types +@node Vectors and Matrices @section Vectors and Matrices @noindent @@ -10813,7 +10814,7 @@ to build @samp{[a, b, c]}, @samp{cvec(a, n, m)} to build an matrix of @samp{a}s, and @samp{index(n)} to build a vector of integers from 1 to @samp{n}. -@node Strings, HMS Forms, Vectors and Matrices, Data Types +@node Strings @section Strings @noindent @@ -10890,7 +10891,7 @@ the resulting string is breakable across multiple lines if it doesn't fit all on one line. Potential break points occur at every space character in the string. -@node HMS Forms, Date Forms, Strings, Data Types +@node HMS Forms @section HMS Forms @noindent @@ -10952,7 +10953,7 @@ two HMS forms produces a real-valued ratio of the two angles. Just for kicks, @kbd{M-x calc-time} pushes the current time of day on the stack as an HMS form. -@node Date Forms, Modulo Forms, HMS Forms, Data Types +@node Date Forms @section Date Forms @noindent @@ -11108,7 +11109,7 @@ for California time. The same is usually true of Julian day counts.) The built-in @kbd{t U} command performs these conversions. -@node Modulo Forms, Error Forms, Date Forms, Data Types +@node Modulo Forms @section Modulo Forms @noindent @@ -11192,7 +11193,7 @@ You can use @kbd{v p} and @kbd{%} to modify modulo forms. The algebraic function @samp{makemod(a, m)} builds the modulo form @w{@samp{a mod m}}. -@node Error Forms, Interval Forms, Modulo Forms, Data Types +@node Error Forms @section Error Forms @noindent @@ -11307,7 +11308,7 @@ the mean and the error should be HMS forms if either one is. @tindex sdev The algebraic function @samp{sdev(a, b)} builds the error form @samp{a +/- b}. -@node Interval Forms, Incomplete Objects, Error Forms, Data Types +@node Interval Forms @section Interval Forms @noindent @@ -11422,7 +11423,7 @@ should yield the interval @samp{[1..2]} again, but in fact it yields the (slightly too small) interval @samp{[1..1.9999999]} due to roundoff error. -@node Incomplete Objects, Variables, Interval Forms, Data Types +@node Incomplete Objects @section Incomplete Objects @noindent @@ -11485,7 +11486,7 @@ the @code{calc-dots} command. If you find incomplete entry distracting, you may wish to enter vectors and complex numbers as algebraic formulas by pressing the apostrophe key. -@node Variables, Formulas, Incomplete Objects, Data Types +@node Variables @section Variables @noindent @@ -11556,7 +11557,7 @@ a value into any of these special variables. @xref{Store and Recall}, for a discussion of commands dealing with variables. -@node Formulas, , Variables, Data Types +@node Formulas @section Formulas @noindent @@ -11714,7 +11715,7 @@ formats. @xref{Algebra}, for commands for manipulating formulas symbolically. -@node Stack and Trail, Mode Settings, Data Types, Top +@node Stack and Trail @chapter Stack and Trail Commands @noindent @@ -11729,7 +11730,7 @@ type, such as numbers, vectors, formulas, and incomplete objects.) * Keep Arguments:: @end menu -@node Stack Manipulation, Editing Stack Entries, Stack and Trail, Stack and Trail +@node Stack Manipulation @section Stack Manipulation Commands @noindent @@ -11858,7 +11859,7 @@ the line containing @samp{30}, @kbd{C-u 2 C-x C-t} creates @samp{10 40 20 30 50}. With an argument of 0, @kbd{C-x C-t} will switch the stack objects at the levels determined by the point and the mark. -@node Editing Stack Entries, Trail Commands, Stack Manipulation, Stack and Trail +@node Editing Stack Entries @section Editing Stack Entries @noindent @@ -11912,7 +11913,7 @@ The @kbd{`} key also works during numeric or algebraic entry. The text entered so far is moved to the @file{*Calc Edit*} buffer for more extensive editing than is convenient in the minibuffer. -@node Trail Commands, Keep Arguments, Editing Stack Entries, Stack and Trail +@node Trail Commands @section Trail Commands @noindent @@ -12033,7 +12034,7 @@ kills the @var{n} lines below or above the selected one. The @kbd{t .} (@code{calc-full-trail-vectors}) command is described elsewhere; @pxref{Vector and Matrix Formats}. -@node Keep Arguments, , Trail Commands, Stack and Trail +@node Keep Arguments @section Keep Arguments @noindent @@ -12076,7 +12077,7 @@ onto the stack. Note that the order of things on the stack will be different than with @kbd{K}: @kbd{2 @key{RET} 3 + M-@key{RET}} leaves @samp{5 2 3} on the stack instead of @samp{2 3 5}. @xref{Undo}. -@node Mode Settings, Arithmetic, Stack and Trail, Top +@node Mode Settings @chapter Mode Settings @noindent @@ -12097,7 +12098,7 @@ the @emph{appearance} or @emph{interpretation} of the stack's contents. * Calc Mode Line:: @end menu -@node General Mode Commands, Precision, Mode Settings, Mode Settings +@node General Mode Commands @section General Mode Commands @noindent @@ -12179,7 +12180,7 @@ the @kbd{z} and @kbd{Z} prefix keys are always distinct. Also, the @kbd{h} prefix is not affected by this mode. Press @kbd{m S} again to disable shifted-prefix mode. -@node Precision, Inverse and Hyperbolic, General Mode Commands, Mode Settings +@node Precision @section Precision @noindent @@ -12236,7 +12237,7 @@ would round this to 150 cents, i.e., $1.50. @xref{Floats}, for still more on floating-point precision and related issues. -@node Inverse and Hyperbolic, Calculation Modes, Precision, Mode Settings +@node Inverse and Hyperbolic @section Inverse and Hyperbolic Flags @noindent @@ -12279,7 +12280,7 @@ to subtract and keep arguments). Another Calc prefix flag, @kbd{K} (keep-arguments), is discussed elsewhere. @xref{Keep Arguments}. -@node Calculation Modes, Simplification Modes, Inverse and Hyperbolic, Mode Settings +@node Calculation Modes @section Calculation Modes @noindent @@ -12299,7 +12300,7 @@ The @samp{m a} (@code{calc-algebraic-mode}) command is described elsewhere * Working Message:: @end menu -@node Angular Modes, Polar Mode, Calculation Modes, Calculation Modes +@node Angular Modes @subsection Angular Modes @noindent @@ -12330,7 +12331,7 @@ and @kbd{m h} (@code{calc-hms-mode}) commands control the angular mode. The current angular mode is displayed on the Emacs mode line. The default angular mode is Degrees. -@node Polar Mode, Fraction Mode, Angular Modes, Calculation Modes +@node Polar Mode @subsection Polar Mode @noindent @@ -12347,7 +12348,7 @@ The @kbd{m p} (@code{calc-polar-mode}) command toggles complex-number preference between rectangular and polar forms. In Polar mode, all of the above example situations would produce polar complex numbers. -@node Fraction Mode, Infinite Mode, Polar Mode, Calculation Modes +@node Fraction Mode @subsection Fraction Mode @noindent @@ -12373,7 +12374,7 @@ At any time you can use @kbd{c f} (@code{calc-float}) to convert a fraction to a float, or @kbd{c F} (@code{calc-fraction}) to convert a float to a fraction. @xref{Conversions}. -@node Infinite Mode, Symbolic Mode, Fraction Mode, Calculation Modes +@node Infinite Mode @subsection Infinite Mode @noindent @@ -12413,7 +12414,7 @@ single symbol, @samp{0}. One consequence of this is that, while you might expect @samp{1 / -0 = -inf}, actually @samp{1 / -0} is equivalent to @samp{1 / 0}, which is equal to positive @code{inf}. -@node Symbolic Mode, Matrix Mode, Infinite Mode, Calculation Modes +@node Symbolic Mode @subsection Symbolic Mode @noindent @@ -12446,7 +12447,7 @@ contains, you can use the key sequence @kbd{m s a v m s} (this uses @code{calc-alg-evaluate}, which resimplifies but doesn't evaluate variables.) -@node Matrix Mode, Automatic Recomputation, Symbolic Mode, Calculation Modes +@node Matrix Mode @subsection Matrix and Scalar Modes @noindent @@ -12518,7 +12519,7 @@ of the formula without affecting the rest just select that part, change into Scalar mode and press @kbd{=} to resimplify the part under this mode, then change back to Matrix mode before deselecting. -@node Automatic Recomputation, Working Message, Matrix Mode, Calculation Modes +@node Automatic Recomputation @subsection Automatic Recomputation @noindent @@ -12542,7 +12543,7 @@ To update @samp{=>} operators in an Embedded buffer while automatic recomputation is off, use @w{@kbd{C-x * u}}. @xref{Embedded Mode}. -@node Working Message, , Automatic Recomputation, Calculation Modes +@node Working Message @subsection Working Messages @noindent @@ -12569,7 +12570,7 @@ considerably, experiments have shown that their impact is actually quite small. But if your terminal is slow you may find that it helps to turn the messages off. -@node Simplification Modes, Declarations, Calculation Modes, Mode Settings +@node Simplification Modes @section Simplification Modes @noindent @@ -12650,7 +12651,7 @@ A common technique is to set the simplification mode down to the lowest amount of simplification you will allow to be applied automatically, then use manual commands like @kbd{a s} and @kbd{c c} (@code{calc-clean}) to perform higher types of simplifications on demand. -@node Declarations, Display Modes, Simplification Modes, Mode Settings +@node Declarations @section Declarations @noindent @@ -12665,7 +12666,7 @@ take the fully general situation into account. * Functions for Declarations:: @end menu -@node Declaration Basics, Kinds of Declarations, Declarations, Declarations +@node Declaration Basics @subsection Declaration Basics @noindent @@ -12730,7 +12731,7 @@ are explicitly declared without @code{real} in some other row. The @kbd{s d} command declares @code{All} if you give a blank response to the variable-name prompt. -@node Kinds of Declarations, Functions for Declarations, Declaration Basics, Declarations +@node Kinds of Declarations @subsection Kinds of Declarations @noindent @@ -12920,7 +12921,7 @@ using a variable for a new purpose, it is best to use @kbd{s d} or @kbd{s D} to check to make sure you don't still have an old declaration for the variable that will conflict with its new meaning. -@node Functions for Declarations, , Kinds of Declarations, Declarations +@node Functions for Declarations @subsection Functions for Declarations @noindent @@ -13059,7 +13060,7 @@ provably scalar, and @samp{!dscalar(a)} is ``true'' only if @code{a} is provably non-scalar; both are ``false'' if there is insufficient information to tell. -@node Display Modes, Language Modes, Declarations, Mode Settings +@node Display Modes @section Display Modes @noindent @@ -13104,7 +13105,7 @@ words, @kbd{I d s} is equivalent to @kbd{H d s d @key{RET} H d (@var{old mode})} * Labels:: @end menu -@node Radix Modes, Grouping Digits, Display Modes, Display Modes +@node Radix Modes @subsection Radix Modes @noindent @@ -13189,7 +13190,7 @@ to will be represented using Calc's usual notation (in the appropriate radix). -@node Grouping Digits, Float Formats, Radix Modes, Display Modes +@node Grouping Digits @subsection Grouping Digits @noindent @@ -13227,7 +13228,7 @@ if re-read in textual form, say by the use of @kbd{C-x * y} and @kbd{C-x * g}. the @samp{\,} separator, which doesn't interfere with parsing because it is ignored by @TeX{} language mode. -@node Float Formats, Complex Formats, Grouping Digits, Display Modes +@node Float Formats @subsection Float Formats @noindent @@ -13293,7 +13294,7 @@ may wish to change this to a comma. Note that this is only a display style; on entry, periods must always be used to denote floating-point numbers, and commas to separate elements in a list. -@node Complex Formats, Fraction Formats, Float Formats, Display Modes +@node Complex Formats @subsection Complex Formats @noindent @@ -13324,7 +13325,7 @@ to @samp{(2,3)}. Other commands (like @code{calc-sin}) will @emph{not} interpret the formula @samp{2 + 3 * i} as a complex number. @xref{Variables}, under ``special constants.'' -@node Fraction Formats, HMS Formats, Complex Formats, Display Modes +@node Fraction Formats @subsection Fraction Formats @noindent @@ -13361,7 +13362,7 @@ The fraction format does not affect the way fractions or integers are stored, only the way they appear on the screen. The fraction format never affects floats. -@node HMS Formats, Date Formats, Fraction Formats, Display Modes +@node HMS Formats @subsection HMS Formats @noindent @@ -13388,7 +13389,7 @@ The @kbd{'} key is recognized as ``minutes'' only if @kbd{@@} (or @kbd{h} or @kbd{o}) has already been pressed; otherwise it means to switch to algebraic entry. -@node Date Formats, Truncating the Stack, HMS Formats, Display Modes +@node Date Formats @subsection Date Formats @noindent @@ -13419,7 +13420,7 @@ functions, your date formats should avoid using the @samp{#} character. * Standard Date Formats:: @end menu -@node ISO 8601, Date Formatting Codes, Date Formats, Date Formats +@node ISO 8601 @subsubsection ISO 8601 @noindent @@ -13497,7 +13498,7 @@ and seconds can be omitted, and decimals can be added. If a date with a time is represented, they should be separated by a literal ``T'', so noon on December 13, 2012 can be represented as 2012-12-13T12:00. -@node Date Formatting Codes, Free-Form Dates, ISO 8601, Date Formats +@node Date Formatting Codes @subsubsection Date Formatting Codes @noindent @@ -13688,7 +13689,7 @@ The ``j,'' ``J,'' and ``U'' formats do not make any time zone adjustment. They effectively use @samp{julian(x,0)} and @samp{unixtime(x,0)} to make the conversion; @pxref{Date Arithmetic}. -@node Free-Form Dates, Standard Date Formats, Date Formatting Codes, Date Formats +@node Free-Form Dates @subsubsection Free-Form Dates @noindent @@ -13754,7 +13755,7 @@ minus sign on the year value. If you always enter a four-digit year, and use a name instead of a number for the month, there is no danger of ambiguity. -@node Standard Date Formats, , Free-Form Dates, Date Formats +@node Standard Date Formats @subsubsection Standard Date Formats @noindent @@ -13797,7 +13798,7 @@ command (@pxref{Mode Settings}). @samp{IYYY-Iww-w<Thh:mm:ss>} (ISO 8601 week numbering format) @end table -@node Truncating the Stack, Justification, Date Formats, Display Modes +@node Truncating the Stack @subsection Truncating the Stack @noindent @@ -13832,7 +13833,7 @@ The @kbd{d [} (@code{calc-truncate-up}) and @kbd{d ]} (@code{calc-truncate-down}) commands move the @samp{.} up or down one line at a time (or several lines with a prefix argument). -@node Justification, Labels, Truncating the Stack, Display Modes +@node Justification @subsection Justification @noindent @@ -13893,7 +13894,7 @@ when positioning by explicit origins and widths. In the latter case, the display is formatted as specified, and then uniformly shifted over four spaces to fit the line numbers. -@node Labels, , Justification, Display Modes +@node Labels @subsection Labels @noindent @@ -13924,7 +13925,7 @@ document (possibly using Embedded mode). The equations would typically be centered, and the equation numbers would be on the left or right as you prefer. -@node Language Modes, Modes Variable, Display Modes, Mode Settings +@node Language Modes @section Language Modes @noindent @@ -13977,7 +13978,7 @@ shifted letter key. * Syntax Tables:: @end menu -@node Normal Language Modes, C FORTRAN Pascal, Language Modes, Language Modes +@node Normal Language Modes @subsection Normal Language Modes @noindent @@ -14079,7 +14080,7 @@ all four modes, and unformatted notation works in any language mode (except that Mathematica mode expects square brackets instead of parentheses). -@node C FORTRAN Pascal, TeX and LaTeX Language Modes, Normal Language Modes, Language Modes +@node C FORTRAN Pascal @subsection C, FORTRAN, and Pascal Modes @noindent @@ -14154,7 +14155,7 @@ modes will use upper-case letters exclusively for display, and will convert to lower-case on input. With a negative prefix, these modes convert to lower-case for display and input. -@node TeX and LaTeX Language Modes, Eqn Language Mode, C FORTRAN Pascal, Language Modes +@node TeX and LaTeX Language Modes @subsection @TeX{} and @LaTeX{} Language Modes @noindent @@ -14574,7 +14575,7 @@ $$ \pmatrix{ {a \over b} & 0 \cr 0 & 2^{(x + 1)} } $$ @sp 2 @end iftex -@node Eqn Language Mode, Yacas Language Mode, TeX and LaTeX Language Modes, Language Modes +@node Eqn Language Mode @subsection Eqn Language Mode @noindent @@ -14650,7 +14651,7 @@ The words @code{lcol} and @code{rcol} are recognized as synonyms for @code{ccol} during input, and are generated instead of @code{ccol} if the matrix justification mode so specifies. -@node Yacas Language Mode, Maxima Language Mode, Eqn Language Mode, Language Modes +@node Yacas Language Mode @subsection Yacas Language Mode @noindent @@ -14680,7 +14681,7 @@ use square brackets. If, for example, @samp{A} represents the list @samp{@{a,2,c,4@}}, then @samp{A[3]} would equal @samp{c}. -@node Maxima Language Mode, Giac Language Mode, Yacas Language Mode, Language Modes +@node Maxima Language Mode @subsection Maxima Language Mode @noindent @@ -14705,7 +14706,7 @@ Maxima uses square brackets for lists and vectors, and matrices are written as calls to the function @code{matrix}, given the row vectors of the matrix as arguments. Square brackets are also used as subscripts. -@node Giac Language Mode, Mathematica Language Mode, Maxima Language Mode, Language Modes +@node Giac Language Mode @subsection Giac Language Mode @noindent @@ -14730,7 +14731,7 @@ Calc reads @samp{2 .. 3} as the closed interval @samp{[2 .. 3]} and writes any kind of interval as @samp{2 .. 3}. This means you cannot see the difference between an open and a closed interval while in Giac mode. -@node Mathematica Language Mode, Maple Language Mode, Giac Language Mode, Language Modes +@node Mathematica Language Mode @subsection Mathematica Language Mode @noindent @@ -14753,7 +14754,7 @@ Non-decimal numbers are written, e.g., @samp{16^^7fff}. Floating-point numbers in scientific notation are written @samp{1.23*10.^3}. Subscripts use double square brackets: @samp{a[[i]]}. -@node Maple Language Mode, Compositions, Mathematica Language Mode, Language Modes +@node Maple Language Mode @subsection Maple Language Mode @noindent @@ -14787,7 +14788,7 @@ Among things not currently handled by Calc's Maple mode are the various quote symbols, procedures and functional operators, and inert (@samp{&}) operators. -@node Compositions, Syntax Tables, Maple Language Mode, Language Modes +@node Compositions @subsection Compositions @noindent @@ -14823,7 +14824,7 @@ the language modes. * User-Defined Compositions:: @end menu -@node Composition Basics, Horizontal Compositions, Compositions, Compositions +@node Composition Basics @subsubsection Composition Basics @noindent @@ -14964,7 +14965,7 @@ in a function call), then the break points in that @code{bstring} will be on the same level as the break points of the surrounding object. -@node Horizontal Compositions, Vertical Compositions, Composition Basics, Compositions +@node Horizontal Compositions @subsubsection Horizontal Compositions @noindent @@ -15008,7 +15009,7 @@ formats as @samp{2 (a + b c + (d = e))}. The baseline of a horizontal composition is the same as the baselines of the component compositions, which are all aligned. -@node Vertical Compositions, Other Compositions, Horizontal Compositions, Compositions +@node Vertical Compositions @subsubsection Vertical Compositions @noindent @@ -15129,7 +15130,7 @@ Like @code{choriz}, the vertical compositions accept a second argument which gives the precedence to use when formatting the components. Vertical compositions do not support separator strings. -@node Other Compositions, Information about Compositions, Vertical Compositions, Compositions +@node Other Compositions @subsubsection Other Compositions @noindent @@ -15223,7 +15224,7 @@ b - @end group @end example -@node Information about Compositions, User-Defined Compositions, Other Compositions, Compositions +@node Information about Compositions @subsubsection Information about Compositions @noindent @@ -15265,7 +15266,7 @@ For @samp{a / b} in Big mode, @code{cascent} returns 2 and @code{cdescent} returns 1. The only formula for which @code{cascent} will return zero is @samp{cvspace(0)} or equivalents. -@node User-Defined Compositions, , Information about Compositions, Compositions +@node User-Defined Compositions @subsubsection User-Defined Compositions @noindent @@ -15396,7 +15397,7 @@ produce a large, unwieldy integer. You can save your display formats permanently using the @kbd{Z P} command (@pxref{Creating User Keys}). -@node Syntax Tables, , Compositions, Language Modes +@node Syntax Tables @subsection Syntax Tables @noindent @@ -15426,7 +15427,7 @@ the syntax tables along with the other mode settings; * Conditional Syntax Rules:: @end menu -@node Syntax Table Basics, Precedence in Syntax Tables, Syntax Tables, Syntax Tables +@node Syntax Table Basics @subsubsection Syntax Table Basics @noindent @@ -15574,7 +15575,7 @@ respectively). Finally, the notation @samp{%%} anywhere in a syntax table causes the rest of the line to be ignored as a comment. -@node Precedence in Syntax Tables, Advanced Syntax Patterns, Syntax Table Basics, Syntax Tables +@node Precedence in Syntax Tables @subsubsection Precedence @noindent @@ -15609,7 +15610,7 @@ can create a right-associative operator. standard Calc operators. For the precedences of operators in other language modes, look in the Calc source file @file{calc-lang.el}. -@node Advanced Syntax Patterns, Conditional Syntax Rules, Precedence in Syntax Tables, Syntax Tables +@node Advanced Syntax Patterns @subsubsection Advanced Syntax Patterns @noindent @@ -15729,7 +15730,7 @@ backs up and tries the other alternative. Thus Calc has ``partial'' backtracking. A fully backtracking parser would go on to make sure the rest of the pattern matched before finalizing the choice. -@node Conditional Syntax Rules, , Advanced Syntax Patterns, Syntax Tables +@node Conditional Syntax Rules @subsubsection Conditional Syntax Rules @noindent @@ -15803,7 +15804,7 @@ Normal language mode for editing expressions in syntax rules, so we must use regular Calc notation for the interval @samp{[b..c]} that will correspond to the Maple mode interval @samp{1..10}. -@node Modes Variable, Calc Mode Line, Language Modes, Mode Settings +@node Modes Variable @section The @code{Modes} Variable @noindent @@ -15905,7 +15906,7 @@ would not work for fixed-point mode, but it wouldn't be hard to do a full emulation with the help of the @kbd{Z [} and @kbd{Z ]} programming commands. @xref{Conditionals in Macros}.) -@node Calc Mode Line, , Modes Variable, Mode Settings +@node Calc Mode Line @section The Calc Mode Line @noindent @@ -16124,7 +16125,7 @@ Stack is truncated (@kbd{d t}; @pxref{Truncating the Stack}). In addition, the symbols @code{Active} and @code{~Active} can appear as minor modes on an Embedded buffer's mode line. @xref{Embedded Mode}. -@node Arithmetic, Scientific Functions, Mode Settings, Top +@node Arithmetic @chapter Arithmetic Functions @noindent @@ -16154,7 +16155,7 @@ interpret a prefix argument. * Binary Functions:: @end menu -@node Basic Arithmetic, Integer Truncation, Arithmetic, Arithmetic +@node Basic Arithmetic @section Basic Arithmetic @noindent @@ -16511,7 +16512,7 @@ way floating-point numbers work. Incrementing a date/time form adjusts it by a certain number of seconds. Incrementing a pure date form adjusts it by a certain number of days. -@node Integer Truncation, Complex Number Functions, Basic Arithmetic, Arithmetic +@node Integer Truncation @section Integer Truncation @noindent @@ -16634,7 +16635,7 @@ and @kbd{f Q} (integer square root) commands, which are analogous to @kbd{/}, @kbd{B}, and @kbd{Q}, respectively, except that they take integer arguments and return the result rounded down to an integer. -@node Complex Number Functions, Conversions, Integer Truncation, Arithmetic +@node Complex Number Functions @section Complex Number Functions @noindent @@ -16702,7 +16703,7 @@ The @kbd{v u} (@code{calc-unpack}) command takes the complex number (or other composite object) on the top of the stack and unpacks it into its separate components. -@node Conversions, Date Arithmetic, Complex Number Functions, Arithmetic +@node Conversions @section Conversions @noindent @@ -16865,7 +16866,7 @@ you wouldn't want it automatically converted to a 100-digit integer). With the Hyperbolic flag, @kbd{H c c} and @kbd{H c 0} through @kbd{H c 9} operate non-pervasively [@code{clean}]. -@node Date Arithmetic, Financial Functions, Conversions, Arithmetic +@node Date Arithmetic @section Date Arithmetic @noindent @@ -16889,11 +16890,11 @@ additional argument from the top of the stack. @menu * Date Conversions:: * Date Functions:: -* Time Zones:: * Business Days:: +* Time Zones:: @end menu -@node Date Conversions, Date Functions, Date Arithmetic, Date Arithmetic +@node Date Conversions @subsection Date Conversions @noindent @@ -16981,7 +16982,7 @@ zone is used for that prompt. You can also answer the first prompt with @kbd{$} to take the two time zone names from the stack (and the date to be converted from the third stack level). -@node Date Functions, Business Days, Date Conversions, Date Arithmetic +@node Date Functions @subsection Date Functions @noindent @@ -17145,7 +17146,7 @@ serves this purpose. Similarly, instead of @code{incday} and @xref{Basic Arithmetic}, for the @kbd{f ]} [@code{incr}] command which can adjust a date/time form by a certain number of seconds. -@node Business Days, Time Zones, Date Functions, Date Arithmetic +@node Business Days @subsection Business Days @noindent @@ -17288,7 +17289,7 @@ any date form and returns 1 if that date falls on a weekend or holiday, as defined in @code{Holidays}, or 0 if the date is a business day. -@node Time Zones, , Business Days, Date Arithmetic +@node Time Zones @subsection Time Zones @noindent @@ -17510,7 +17511,7 @@ daylight saving time (e.g., @code{PDT} or @code{PST}) the the algorithms described above are used. If @var{zone} is omitted, the computation is done for the current time zone. -@node Financial Functions, Binary Functions, Date Arithmetic, Arithmetic +@node Financial Functions @section Financial Functions @noindent @@ -17537,7 +17538,7 @@ of this section to make sure the functions have the meaning you expect. * Definitions of Financial Functions:: @end menu -@node Percentages, Future Value, Financial Functions, Financial Functions +@node Percentages @subsection Percentages @kindex M-% @@ -17602,7 +17603,7 @@ in the second case, we're decreasing by 20% of 50.) The effect of @kbd{40 @key{RET} 50 b %} is to compute @expr{(50-40)/40}, converting the answer to percentage form as if by @kbd{c %}. -@node Future Value, Present Value, Percentages, Financial Functions +@node Future Value @subsection Future Value @noindent @@ -17664,7 +17665,7 @@ now counting the payment at year five (which, since it didn't have a chance to earn interest, counts as $1000). Indeed, @expr{5569.96 = 5870.73 - 1300.78 + 1000} (give or take a bit of roundoff error). -@node Present Value, Related Financial Functions, Future Value, Financial Functions +@node Present Value @subsection Present Value @noindent @@ -17748,7 +17749,7 @@ The @kbd{I b N} [@code{npvb}] command computes the net present value where payments occur at the beginning of each interval rather than at the end. -@node Related Financial Functions, Depreciation Functions, Present Value, Financial Functions +@node Related Financial Functions @subsection Related Financial Functions @noindent @@ -17836,7 +17837,7 @@ this rate is known as the @dfn{internal rate of return}. The @kbd{I b I} [@code{irrb}] command computes the internal rate of return assuming payments occur at the beginning of each period. -@node Depreciation Functions, Definitions of Financial Functions, Related Financial Functions, Financial Functions +@node Depreciation Functions @subsection Depreciation Functions @noindent @@ -17907,7 +17908,7 @@ Summing columns with @kbd{V R : +} yields @expr{[10000, 10000, 10000]}; the total depreciation in any method is (by definition) the difference between the cost and the salvage value. -@node Definitions of Financial Functions, , Depreciation Functions, Financial Functions +@node Definitions of Financial Functions @subsection Definitions @noindent @@ -18061,7 +18062,7 @@ and the depreciation is zero for all subsequent periods. The @code{ddb} function returns the amount the book value decreased in the specified period. -@node Binary Functions, , Financial Functions, Arithmetic +@node Binary Functions @section Binary Number Functions @noindent @@ -18251,7 +18252,7 @@ unpack; type @kbd{31 @key{TAB} -} to replace each bit-number in the set with 31 minus that bit-number; type @kbd{b p} to pack the set back into a binary integer. -@node Scientific Functions, Matrix Functions, Arithmetic, Top +@node Scientific Functions @chapter Scientific Functions @noindent @@ -18318,7 +18319,7 @@ interpret a prefix argument. * Probability Distribution Functions:: @end menu -@node Logarithmic Functions, Trigonometric and Hyperbolic Functions, Scientific Functions, Scientific Functions +@node Logarithmic Functions @section Logarithmic Functions @noindent @@ -18412,7 +18413,7 @@ The @kbd{f L} (@code{calc-lnp1}) [@code{lnp1}] command computes @infoline @expr{ln(x+1)}, producing a more accurate answer when @expr{x} is close to zero. -@node Trigonometric and Hyperbolic Functions, Advanced Math Functions, Logarithmic Functions, Scientific Functions +@node Trigonometric and Hyperbolic Functions @section Trigonometric/Hyperbolic Functions @noindent @@ -18589,7 +18590,7 @@ counterparts, which are also available separately as @code{calc-sech} [@code{sech}], @code{calc-csch} [@code{csch}] and @code{calc-coth} [@code{coth}]. (These commands do not accept the Inverse flag.) -@node Advanced Math Functions, Branch Cuts, Trigonometric and Hyperbolic Functions, Scientific Functions +@node Advanced Math Functions @section Advanced Mathematical Functions @noindent @@ -18726,7 +18727,7 @@ Calc's implementation of the Bessel functions currently limits the precision to 8 digits, and may not be exact even to that precision. Use with care! -@node Branch Cuts, Random Numbers, Advanced Math Functions, Scientific Functions +@node Branch Cuts @section Branch Cuts and Principal Values @noindent @@ -18870,7 +18871,7 @@ The ``advanced math'' functions (gamma, Bessel, etc.@:) are also defined for general complex arguments, but their branch cuts and principal values are not rigorously specified at present. -@node Random Numbers, Combinatorial Functions, Branch Cuts, Scientific Functions +@node Random Numbers @section Random Numbers @noindent @@ -18888,9 +18889,7 @@ Each possible value @expr{N} appears with equal probability. With no numeric prefix argument, the @kbd{k r} command takes its argument from the stack instead. Once again, if this is a positive integer @expr{M} -the result is a random integer less than @expr{M}. However, note that -while numeric prefix arguments are limited to six digits or so, an @expr{M} -taken from the stack can be arbitrarily large. If @expr{M} is negative, +the result is a random integer less than @expr{M}. If @expr{M} is negative, the result is a random integer in the range @texline @math{M < N \le 0}. @infoline @expr{M < N <= 0}. @@ -19000,7 +18999,7 @@ elements of this vector. @xref{Matrix Functions}. * Random Number Generator:: (Complete description of Calc's algorithm) @end menu -@node Random Number Generator, , Random Numbers, Random Numbers +@node Random Number Generator @subsection Random Number Generator Calc's random number generator uses several methods to ensure that @@ -19098,7 +19097,7 @@ The Gaussian random numbers generated by @samp{random(0.0)} use the generates a pair of Gaussian random numbers at a time, so only every other call to @samp{random(0.0)} will require significant calculations. -@node Combinatorial Functions, Probability Distribution Functions, Random Numbers, Scientific Functions +@node Combinatorial Functions @section Combinatorial Functions @noindent @@ -19314,7 +19313,7 @@ distinct factors, this is @expr{(-1)^k}. If the input number has any duplicate factors (i.e., can be divided by the same prime more than once), the result is zero. -@node Probability Distribution Functions, , Combinatorial Functions, Scientific Functions +@node Probability Distribution Functions @section Probability Distribution Functions @noindent @@ -19465,7 +19464,7 @@ Since the distribution functions are monotonic, @kbd{a R} is guaranteed to be able to find a solution given any initial guess. @xref{Numerical Solutions}. -@node Matrix Functions, Algebra, Scientific Functions, Top +@node Matrix Functions @chapter Vector/Matrix Functions @noindent @@ -19493,7 +19492,7 @@ vector of matrices, and so on.) * Vector and Matrix Formats:: @end menu -@node Packing and Unpacking, Building Vectors, Matrix Functions, Matrix Functions +@node Packing and Unpacking @section Packing and Unpacking @noindent @@ -19713,7 +19712,7 @@ Subscript notation is a useful way to extract a particular part of an object. For example, to get the numerator of a rational number, you can use @samp{unpack(-10, @var{x})_1}. -@node Building Vectors, Extracting Elements, Packing and Unpacking, Matrix Functions +@node Building Vectors @section Building Vectors @noindent @@ -19881,7 +19880,7 @@ representing the remainder of the vector. Thus the vector Also, @samp{head([a, b, c, d]) = a}, @samp{tail([a, b, c, d]) = [b, c, d]}, @samp{rhead([a, b, c, d]) = [a, b, c]}, and @samp{rtail([a, b, c, d]) = d}. -@node Extracting Elements, Manipulating Vectors, Building Vectors, Matrix Functions +@node Extracting Elements @section Extracting Vector Elements @noindent @@ -19987,7 +19986,7 @@ produces @samp{[a, d, e]}. It is always true that @code{subvec} and @xref{Selecting Subformulas}, for an alternative way to operate on vectors one element at a time. -@node Manipulating Vectors, Vector and Matrix Arithmetic, Extracting Elements, Matrix Functions +@node Manipulating Vectors @section Manipulating Vectors @noindent @@ -20219,7 +20218,7 @@ operation across the two vectors. @xref{Logical Operations}. Note that the @code{? :} operation also discussed there allows other types of masking using vectors. -@node Vector and Matrix Arithmetic, Set Operations, Manipulating Vectors, Matrix Functions +@node Vector and Matrix Arithmetic @section Vector and Matrix Arithmetic @noindent @@ -20341,7 +20340,7 @@ elements of the matrix. The @kbd{V K} (@code{calc-kron}) [@code{kron}] command computes the Kronecker product of two matrices. -@node Set Operations, Statistical Operations, Vector and Matrix Arithmetic, Matrix Functions +@node Set Operations @section Set Operations using Vectors @noindent @@ -20531,7 +20530,7 @@ representation @texline (@math{2^{100}}, a 31-digit integer, in this case). @infoline (@expr{2^100}, a 31-digit integer, in this case). -@node Statistical Operations, Reducing and Mapping, Set Operations, Matrix Functions +@node Statistical Operations @section Statistical Operations on Vectors @noindent @@ -20560,7 +20559,7 @@ probability distribution functions. * Paired-Sample Statistics:: @end menu -@node Single-Variable Statistics, Paired-Sample Statistics, Statistical Operations, Statistical Operations +@node Single-Variable Statistics @subsection Single-Variable Statistics @noindent @@ -20829,7 +20828,7 @@ arguments, interpreted in the same way as the other functions in this section. For example, @samp{vflat(1, [2, [3, 4]], 5)} returns @samp{[1, 2, 3, 4, 5]}. -@node Paired-Sample Statistics, , Single-Variable Statistics, Statistical Operations +@node Paired-Sample Statistics @subsection Paired-Sample Statistics @noindent @@ -20890,7 +20889,7 @@ between sample or population statistics here.) $$ r_{x\!y} = { \sigma_{x\!y}^2 \over \sigma_x^2 \sigma_y^2 } $$ @end tex -@node Reducing and Mapping, Vector and Matrix Formats, Statistical Operations, Matrix Functions +@node Reducing and Mapping @section Reducing and Mapping Vectors @noindent @@ -20920,7 +20919,7 @@ While @kbd{V A} is useful in some cases, you will usually find that either * Generalized Products:: @end menu -@node Specifying Operators, Mapping, Reducing and Mapping, Reducing and Mapping +@node Specifying Operators @subsection Specifying Operators @noindent @@ -21071,7 +21070,7 @@ a function, since the name @code{gcd} corresponds to the Lisp variable automatically makes this translation, so you don't have to worry about it.) -@node Mapping, Reducing, Specifying Operators, Reducing and Mapping +@node Mapping @subsection Mapping @noindent @@ -21168,7 +21167,7 @@ mapping command. The default @kbd{V M} always means map-by-elements. @xref{Storing Variables}, for the @kbd{s m} command which modifies a variable's stored value using a @kbd{V M}-like operator. -@node Reducing, Nesting and Fixed Points, Mapping, Reducing and Mapping +@node Reducing @subsection Reducing @noindent @@ -21249,7 +21248,7 @@ The commands @kbd{C-x * :} and @kbd{C-x * _} are equivalent to typing @kbd{V R : +} or @kbd{V R _ +}, respectively, to sum the columns or rows of the matrix. @xref{Grabbing From Buffers}. -@node Nesting and Fixed Points, Generalized Products, Reducing, Reducing and Mapping +@node Nesting and Fixed Points @subsection Nesting and Fixed Points @noindent @@ -21329,7 +21328,7 @@ computes the square root of @samp{A} given the initial guess @samp{B}, stopping when the result is correct within the specified tolerance, or when 20 steps have been taken, whichever is sooner. -@node Generalized Products, , Nesting and Fixed Points, Reducing and Mapping +@node Generalized Products @subsection Generalized Products @kindex v O @@ -21366,7 +21365,7 @@ use @kbd{$} twice to take both operator formulas from the stack, the first (multiplicative) operator is taken from the top of the stack and the second (additive) operator is taken from second-to-top. -@node Vector and Matrix Formats, , Reducing and Mapping, Matrix Functions +@node Vector and Matrix Formats @section Vector and Matrix Display Formats @noindent @@ -21513,7 +21512,7 @@ line. This mode causes all vectors, whether matrices or not, to be displayed with a single element per line. Sub-vectors within the vectors will still use the normal linear form. -@node Algebra, Units, Matrix Functions, Top +@node Algebra @chapter Algebra @noindent @@ -21553,7 +21552,7 @@ of these modes. You may also wish to select Big display mode (@kbd{d B}). * Rewrite Rules:: @end menu -@node Selecting Subformulas, Algebraic Manipulation, Algebra, Algebra +@node Selecting Subformulas @section Selecting Sub-Formulas @noindent @@ -21579,7 +21578,7 @@ on one element of a vector in-place, simply select that element as a * Rearranging with Selections:: @end menu -@node Making Selections, Changing Selections, Selecting Subformulas, Selecting Subformulas +@node Making Selections @subsection Making Selections @noindent @@ -21740,7 +21739,7 @@ position. The @kbd{j c} (@code{calc-clear-selections}) command unselects all stack elements. -@node Changing Selections, Displaying Selections, Making Selections, Selecting Subformulas +@node Changing Selections @subsection Changing Selections @noindent @@ -21829,7 +21828,7 @@ The Info @kbd{m} command is somewhat similar to Calc's @kbd{j s} and @kbd{j l}; in each case, you can jump directly to a sub-component of the hierarchy simply by pointing to it with the cursor. -@node Displaying Selections, Operating on Selections, Changing Selections, Selecting Subformulas +@node Displaying Selections @subsection Displaying Selections @noindent @@ -21860,7 +21859,7 @@ and the selected sub-formula will be highlighted by using a more noticeable face (@code{calc-selected-face}) instead of @samp{#} signs. (@pxref{Customizing Calc}.) -@node Operating on Selections, Rearranging with Selections, Displaying Selections, Selecting Subformulas +@node Operating on Selections @subsection Operating on Selections @noindent @@ -22017,7 +22016,7 @@ to be simplified. @end group @end smallexample -@node Rearranging with Selections, , Operating on Selections, Selecting Subformulas +@node Rearranging with Selections @subsection Rearranging Formulas using Selections @noindent @@ -22266,7 +22265,7 @@ The @kbd{j "} (@code{calc-sel-expand-formula}) command is to @kbd{a "} You can use the @kbd{j r} (@code{calc-rewrite-selection}) command to define other algebraic operations on sub-formulas. @xref{Rewrite Rules}. -@node Algebraic Manipulation, Simplifying Formulas, Selecting Subformulas, Algebra +@node Algebraic Manipulation @section Algebraic Manipulation @noindent @@ -22430,7 +22429,7 @@ evaluated immediately, even if its arguments are variables, so if you wish to put a call to @code{subst} onto the stack you must turn the default simplifications off first (with @kbd{m O}). -@node Simplifying Formulas, Polynomials, Algebraic Manipulation, Algebra +@node Simplifying Formulas @section Simplifying Formulas @noindent @@ -22479,7 +22478,7 @@ combinations of @samp{sinh}s and @samp{cosh}s before simplifying. * Simplification of Units:: @end menu -@node Basic Simplifications, Algebraic Simplifications, Simplifying Formulas, Simplifying Formulas +@node Basic Simplifications @subsection Basic Simplifications @noindent @@ -22809,7 +22808,7 @@ Most other Calc functions have few if any basic simplifications defined, aside of course from evaluation when the arguments are suitable numbers. -@node Algebraic Simplifications, Unsafe Simplifications, Basic Simplifications, Simplifying Formulas +@node Algebraic Simplifications @subsection Algebraic Simplifications @noindent @@ -23042,7 +23041,7 @@ all simplified to 0, but @expr{x > 3} is simplified to 1. By a similar analysis, @expr{abs(x) >= 0} is simplified to 1, as is @expr{x^2 >= 0} if @expr{x} is known to be real. -@node Unsafe Simplifications, Simplification of Units, Algebraic Simplifications, Simplifying Formulas +@node Unsafe Simplifications @subsection ``Unsafe'' Simplifications @noindent @@ -23135,7 +23134,7 @@ on whether you believe @expr{x} is positive or negative). The @kbd{a M /} command can be used to divide a factor out of both sides of an inequality. -@node Simplification of Units, , Unsafe Simplifications, Simplifying Formulas +@node Simplification of Units @subsection Simplification of Units @noindent @@ -23220,7 +23219,7 @@ that have angular units like @code{rad} or @code{arcmin} are simplified by converting to base units (radians), then evaluating with the angular mode temporarily set to radians. -@node Polynomials, Calculus, Simplifying Formulas, Algebra +@node Polynomials @section Polynomials A @dfn{polynomial} is a sum of terms which are coefficients times @@ -23444,7 +23443,7 @@ polynomial routines used in the above commands. @xref{Decomposing Polynomials}, for several useful functions for extracting the individual coefficients of a polynomial. -@node Calculus, Solving Equations, Polynomials, Algebra +@node Calculus @section Calculus @noindent @@ -23462,7 +23461,7 @@ readable way. * Taylor Series:: @end menu -@node Differentiation, Integration, Calculus, Calculus +@node Differentiation @subsection Differentiation @noindent @@ -23520,7 +23519,7 @@ Various higher-order derivatives can be formed in the obvious way, e.g., @samp{f'@var{}'2'3(x,y,z)} (@code{f} differentiated with respect to each argument once). -@node Integration, Customizing the Integrator, Differentiation, Calculus +@node Integration @subsection Integration @noindent @@ -23607,7 +23606,7 @@ table-lookup solutions of integrals. You might then wish to define rewrite rules for integration by parts, various kinds of substitutions, and so on. @xref{Rewrite Rules}. -@node Customizing the Integrator, Numerical Integration, Integration, Calculus +@node Customizing the Integrator @subsection Customizing the Integrator @noindent @@ -23733,7 +23732,7 @@ of times until no further changes are possible. Rewriting by finished, not at every step as for @code{IntegRules} and @code{IntegSimpRules}. -@node Numerical Integration, Taylor Series, Customizing the Integrator, Calculus +@node Numerical Integration @subsection Numerical Integration @noindent @@ -23771,7 +23770,7 @@ The integral of @samp{1/sqrt(x)} from 0 to 1 exists (it can be found by Calc's symbolic integrator, for example), but @kbd{a I} will fail because the integrand goes to infinity at one of the endpoints. -@node Taylor Series, , Numerical Integration, Calculus +@node Taylor Series @subsection Taylor Series @noindent @@ -23792,7 +23791,7 @@ If the @kbd{a i} command is unable to find a symbolic integral for a function, you can get an approximation by integrating the function's Taylor series. -@node Solving Equations, Numerical Solutions, Calculus, Algebra +@node Solving Equations @section Solving Equations @noindent @@ -23836,7 +23835,7 @@ another formula with @expr{x} set equal to @expr{y/3 - 2}. * Decomposing Polynomials:: @end menu -@node Multiple Solutions, Solving Systems of Equations, Solving Equations, Solving Equations +@node Multiple Solutions @subsection Multiple Solutions @noindent @@ -23950,7 +23949,7 @@ formula on the stack with Symbolic mode temporarily off.) Naturally, @kbd{a P} can only provide numerical roots if the polynomial coefficients are all numbers (real or complex). -@node Solving Systems of Equations, Decomposing Polynomials, Multiple Solutions, Solving Equations +@node Solving Systems of Equations @subsection Solving Systems of Equations @noindent @@ -24017,7 +24016,7 @@ Another way to deal with certain kinds of overdetermined systems of equations is the @kbd{a F} command, which does least-squares fitting to satisfy the equations. @xref{Curve Fitting}. -@node Decomposing Polynomials, , Solving Systems of Equations, Solving Equations +@node Decomposing Polynomials @subsection Decomposing Polynomials @noindent @@ -24161,7 +24160,7 @@ if necessary) by its content. If the input polynomial has rational coefficients, the result will have integer coefficients in simplest terms. -@node Numerical Solutions, Curve Fitting, Solving Equations, Algebra +@node Numerical Solutions @section Numerical Solutions @noindent @@ -24180,7 +24179,7 @@ on numerical data.) * Numerical Systems of Equations:: @end menu -@node Root Finding, Minimization, Numerical Solutions, Numerical Solutions +@node Root Finding @subsection Root Finding @noindent @@ -24256,7 +24255,7 @@ form on the stack, it will normally display an explanation for why no root was found. If you miss this explanation, press @kbd{w} (@code{calc-why}) to get it back. -@node Minimization, Numerical Systems of Equations, Root Finding, Numerical Solutions +@node Minimization @subsection Minimization @noindent @@ -24328,7 +24327,7 @@ the initial guess is a complex number the variable will be minimized over the complex numbers; if it is real or an interval it will be minimized over the reals. -@node Numerical Systems of Equations, , Minimization, Numerical Solutions +@node Numerical Systems of Equations @subsection Systems of Equations @noindent @@ -24354,7 +24353,7 @@ multidimensional @kbd{a R}, the formula being minimized should still be a single formula, @emph{not} a vector. Beware that multidimensional minimization is currently @emph{very} slow. -@node Curve Fitting, Summations, Numerical Solutions, Algebra +@node Curve Fitting @section Curve Fitting @noindent @@ -24380,7 +24379,7 @@ plotted after the formula is determined. This will be indicated by a * Interpolation:: @end menu -@node Linear Fits, Polynomial and Multilinear Fits, Curve Fitting, Curve Fitting +@node Linear Fits @subsection Linear Fits @noindent @@ -24546,7 +24545,7 @@ vector of @expr{y} values. If there is only one independent variable, the @expr{x} values can be either a one-row matrix or a plain vector, in which case the @kbd{C-u} prefix is the same as a @w{@kbd{C-u 2}} prefix. -@node Polynomial and Multilinear Fits, Error Estimates for Fits, Linear Fits, Curve Fitting +@node Polynomial and Multilinear Fits @subsection Polynomial and Multilinear Fits @noindent @@ -24661,7 +24660,7 @@ would enter @kbd{a F ' 2.3 + a x}. Another class of models that will work but must be entered by hand are multinomial fits, e.g., @expr{a + b x + c y + d x^2 + e y^2 + f x y}. -@node Error Estimates for Fits, Standard Nonlinear Models, Polynomial and Multilinear Fits, Curve Fitting +@node Error Estimates for Fits @subsection Error Estimates for Fits @noindent @@ -24822,7 +24821,7 @@ in the input, and thus there is no redundant information left over to use for a confidence test. @end enumerate -@node Standard Nonlinear Models, Curve Fitting Details, Error Estimates for Fits, Curve Fitting +@node Standard Nonlinear Models @subsection Standard Nonlinear Models @noindent @@ -25006,7 +25005,7 @@ Fourier analysis, which is beyond the scope of the @kbd{a F} command. (Unfortunately, Calc does not currently have any facilities for taking Fourier and related transforms.) -@node Curve Fitting Details, Interpolation, Standard Nonlinear Models, Curve Fitting +@node Curve Fitting Details @subsection Curve Fitting Details @noindent @@ -25398,7 +25397,7 @@ linearizer was unable to put the model into the required form. The @code{efit} (corresponding to @kbd{H a F}) and @code{xfit} (for @kbd{I a F}) functions are completely analogous. -@node Interpolation, , Curve Fitting Details, Curve Fitting +@node Interpolation @subsection Polynomial Interpolation @kindex a p @@ -25455,7 +25454,7 @@ used by @kbd{H a p}. (The algorithm never generates these coefficients explicitly, and quotients of polynomials are beyond @w{@kbd{a F}}'s capabilities to fit.) -@node Summations, Logical Operations, Curve Fitting, Algebra +@node Summations @section Summations @noindent @@ -25616,7 +25615,7 @@ like @code{sum} and @code{prod}, but its result is simply a vector of the results. For example, @samp{table(a_i, i, 1, 7, 2)} produces @samp{[a_1, a_3, a_5, a_7]}. -@node Logical Operations, Rewrite Rules, Summations, Algebra +@node Logical Operations @section Logical Operations @noindent @@ -25994,7 +25993,7 @@ declarations are used when deciding whether a formula is true; it returns 0 when @code{dnonzero} would return 0 or leave itself in symbolic form.) -@node Rewrite Rules, , Logical Operations, Algebra +@node Rewrite Rules @section Rewrite Rules @noindent @@ -26036,7 +26035,7 @@ Calc formulas. * Examples of Rewrite Rules:: @end menu -@node Entering Rewrite Rules, Basic Rewrite Rules, Rewrite Rules, Rewrite Rules +@node Entering Rewrite Rules @subsection Entering Rewrite Rules @noindent @@ -26102,7 +26101,7 @@ Calc also accepts an obsolete notation for rules, as vectors @samp{[@var{old}, @var{new}]}. But because it is easily confused with a vector of two rules, the use of this notation is no longer recommended. -@node Basic Rewrite Rules, Conditional Rewrite Rules, Entering Rewrite Rules, Rewrite Rules +@node Basic Rewrite Rules @subsection Basic Rewrite Rules @noindent @@ -26146,7 +26145,7 @@ throughout the target formula until no further changes are possible (up to a limit of 100 times). Use @kbd{C-u 1 a r} to make only one change at a time. -@node Conditional Rewrite Rules, Algebraic Properties of Rewrite Rules, Basic Rewrite Rules, Rewrite Rules +@node Conditional Rewrite Rules @subsection Conditional Rewrite Rules @noindent @@ -26229,7 +26228,7 @@ the condition @samp{1} is always true (nonzero) so it has no effect on the functioning of the rule. (The rewrite compiler will ensure that it doesn't even impact the speed of matching the rule.) -@node Algebraic Properties of Rewrite Rules, Other Features of Rewrite Rules, Conditional Rewrite Rules, Rewrite Rules +@node Algebraic Properties of Rewrite Rules @subsection Algebraic Properties of Rewrite Rules @noindent @@ -26568,7 +26567,7 @@ In this example, we are still allowing the pattern-matcher to use all the algebra it can muster, but the righthand side will always simplify to a literal addition like @samp{f((-y) + x)}. -@node Other Features of Rewrite Rules, Composing Patterns in Rewrite Rules, Algebraic Properties of Rewrite Rules, Rewrite Rules +@node Other Features of Rewrite Rules @subsection Other Features of Rewrite Rules @noindent @@ -26970,7 +26969,7 @@ rule remembers only every fourth result. Note that @samp{remember(1)} is equivalent to @samp{remember}, and @samp{remember(0)} has no effect. @end table -@node Composing Patterns in Rewrite Rules, Nested Formulas with Rewrite Rules, Other Features of Rewrite Rules, Rewrite Rules +@node Composing Patterns in Rewrite Rules @subsection Composing Patterns in Rewrite Rules @noindent @@ -27139,7 +27138,7 @@ disastrous: since @code{a} was unbound so far, the pattern @samp{a} would have matched anything at all, and the pattern @samp{!!!a} therefore would @emph{not} have matched anything at all! -@node Nested Formulas with Rewrite Rules, Multi-Phase Rewrite Rules, Composing Patterns in Rewrite Rules, Rewrite Rules +@node Nested Formulas with Rewrite Rules @subsection Nested Formulas with Rewrite Rules @noindent @@ -27223,7 +27222,7 @@ integer, or @samp{inf} or @samp{-inf}. If @var{n} is omitted the @code{iterations} value from the rule set is used; if both are omitted, 100 is used. -@node Multi-Phase Rewrite Rules, Selections with Rewrite Rules, Nested Formulas with Rewrite Rules, Rewrite Rules +@node Multi-Phase Rewrite Rules @subsection Multi-Phase Rewrite Rules @noindent @@ -27344,7 +27343,7 @@ rules were finished, some components might be put away into vectors before they had a chance to recombine. By putting these rules in two separate phases, this problem is neatly avoided. -@node Selections with Rewrite Rules, Matching Commands, Multi-Phase Rewrite Rules, Rewrite Rules +@node Selections with Rewrite Rules @subsection Selections with Rewrite Rules @noindent @@ -27417,7 +27416,7 @@ purpose rules with @samp{select( )} hints inside them so that they will ``do the right thing'' in both @kbd{a r} and @kbd{j r}, both with and without selections. -@node Matching Commands, Automatic Rewrites, Selections with Rewrite Rules, Rewrite Rules +@node Matching Commands @subsection Matching Commands @noindent @@ -27469,7 +27468,7 @@ the meta-variables instead of the number 1. For example, @samp{vmatches(f(1,2), f(a,b))} returns @samp{[a := 1, b := 2]}. If the match fails, the function returns the number 0. -@node Automatic Rewrites, Debugging Rewrites, Matching Commands, Rewrite Rules +@node Automatic Rewrites @subsection Automatic Rewrites @noindent @@ -27643,7 +27642,7 @@ also apply @code{EvalRules} and @code{AlgSimpRules}. The variable @code{IntegSimpRules} contains simplification rules that are used only during integration by @kbd{a i}. -@node Debugging Rewrites, Examples of Rewrite Rules, Automatic Rewrites, Rewrite Rules +@node Debugging Rewrites @subsection Debugging Rewrites @noindent @@ -27663,7 +27662,7 @@ buffer (with @kbd{C-x k *Trace* @key{RET}}). If you leave it in existence and forget about it, all your future rewrite commands will be needlessly slow. -@node Examples of Rewrite Rules, , Debugging Rewrites, Rewrite Rules +@node Examples of Rewrite Rules @subsection Examples of Rewrite Rules @noindent @@ -27753,7 +27752,7 @@ results in the four-argument form, just append the two items of the rule set. (But remember that multi-phase rule sets don't work in @code{EvalRules}.) -@node Units, Store and Recall, Algebra, Top +@node Units @chapter Operating on Units @noindent @@ -27772,7 +27771,7 @@ begin with the @kbd{u} prefix key. * Musical Notes:: @end menu -@node Basic Operations on Units, The Units Table, Units, Units +@node Basic Operations on Units @section Basic Operations on Units @noindent @@ -27977,7 +27976,7 @@ is also the actual name of another unit; @samp{1e-15 t} would normally be considered a ``femto-ton,'' but it is written as @samp{1000 at} (1000 atto-tons) instead because @code{ft} would be confused with feet. -@node The Units Table, Predefined Units, Basic Operations on Units, Units +@node The Units Table @section The Units Table @noindent @@ -28034,7 +28033,7 @@ for the expression @samp{62 km^2 g / s^2 mol K}, the description is command uses the English descriptions that appear in the righthand column of the Units Table. -@node Predefined Units, User-Defined Units, The Units Table, Units +@node Predefined Units @section Predefined Units @noindent @@ -28131,7 +28130,7 @@ really is unitless.) @c Describe angular units, luminosity vs. steradians problem. -@node User-Defined Units, Logarithmic Units, Predefined Units, Units +@node User-Defined Units @section User-Defined Units @noindent @@ -28215,7 +28214,7 @@ was already a set of user-defined units in your Calc init file, it is replaced by the new set. (@xref{General Mode Commands}, for a way to tell Calc to use a different file for the Calc init file.) -@node Logarithmic Units, Musical Notes, User-Defined Units, Units +@node Logarithmic Units @section Logarithmic Units The units @code{dB} (decibels) and @code{Np} (nepers) are logarithmic @@ -28454,7 +28453,7 @@ number; the @kbd{l /} (@code{calc-lu-divide}) [@code{lupdiv}] and unit by a number. Note that the reference quantities don't play a role in this arithmetic. -@node Musical Notes, , Logarithmic Units, Units +@node Musical Notes @section Musical Notes Calc can convert between musical notes and their associated @@ -28522,7 +28521,7 @@ notation @code{B_3 + 99.9962592773 cents}; with the default value of @code{1}, Calc converts @code{261.625 Hz} to @code{C_4}. -@node Store and Recall, Graphics, Units, Top +@node Store and Recall @chapter Storing and Recalling @noindent @@ -28539,7 +28538,7 @@ to variables use the @kbd{s} prefix key. * Evaluates-To Operator:: @end menu -@node Storing Variables, Recalling Variables, Store and Recall, Store and Recall +@node Storing Variables @section Storing Variables @noindent @@ -28767,7 +28766,7 @@ stored in the Calc variable @code{pi}. If one of the other special variables, @code{inf}, @code{uinf} or @code{nan}, is given a value, its original behavior can be restored by voiding it with @kbd{s u}. -@node Recalling Variables, Operations on Variables, Storing Variables, Store and Recall +@node Recalling Variables @section Recalling Variables @noindent @@ -28790,7 +28789,7 @@ latter will produce an error message. The @kbd{r} prefix may be followed by a digit, so that @kbd{r 9} is equivalent to @kbd{s r 9}. -@node Operations on Variables, Let Command, Recalling Variables, Store and Recall +@node Operations on Variables @section Other Operations on Variables @noindent @@ -28947,7 +28946,7 @@ omits the same set of variables as @w{@kbd{s p @key{RET}}}; the difference is that @kbd{s i} will store the variables in any buffer, and it also stores in a more human-readable format.) -@node Let Command, Evaluates-To Operator, Operations on Variables, Store and Recall +@node Let Command @section The Let Command @noindent @@ -28985,7 +28984,7 @@ example, letting @expr{n=2} in @samp{f(n pi)} with @kbd{a b} will produce @samp{f(2 pi)}, whereas @kbd{s l} would give @samp{f(6.28)} since the evaluation step will also evaluate @code{pi}. -@node Evaluates-To Operator, , Let Command, Store and Recall +@node Evaluates-To Operator @section The Evaluates-To Operator @noindent @@ -29111,7 +29110,7 @@ and value from the stack and replaces them with an assignment. @TeX{} language output. The @dfn{eqn} mode gives similar treatment to @samp{=>}. -@node Graphics, Kill and Yank, Store and Recall, Top +@node Graphics @chapter Graphics @noindent @@ -29142,7 +29141,7 @@ POSIX-compatible terminal. * Devices:: @end menu -@node Basic Graphics, Three Dimensional Graphics, Graphics, Graphics +@node Basic Graphics @section Basic Graphics @noindent @@ -29228,7 +29227,7 @@ to use @kbd{g c} if you don't want to---if you give another @kbd{g f} or @kbd{g p} command later on, it will reuse the existing graphics window if there is one. -@node Three Dimensional Graphics, Managing Curves, Basic Graphics, Graphics +@node Three Dimensional Graphics @section Three-Dimensional Graphics @kindex g F @@ -29296,7 +29295,7 @@ helix (a three-dimensional spiral). As for @kbd{g f}, each of ``x'', ``y'', and ``z'' may instead be variables containing the relevant data. -@node Managing Curves, Graphics Options, Three Dimensional Graphics, Graphics +@node Managing Curves @section Managing Curves @noindent @@ -29455,7 +29454,7 @@ Provided everything is set up properly, @kbd{g p} will plot to the screen unless you have specified otherwise and @kbd{g P} will always plot to the printer. -@node Graphics Options, Devices, Managing Curves, Graphics +@node Graphics Options @section Graphics Options @noindent @@ -29621,7 +29620,7 @@ lines, and the third curve to have lines in style 3. Point styles will still be assigned automatically, but you could store another vector in @code{PointStyles} to define them, too. -@node Devices, , Graphics Options, Graphics +@node Devices @section Graphical Devices @noindent @@ -29814,7 +29813,7 @@ except that it also views the @file{*Gnuplot Trail*} buffer so that you can see the process being killed. This is better if you are killing GNUPLOT because you think it has gotten stuck. -@node Kill and Yank, Keypad Mode, Graphics, Top +@node Kill and Yank @chapter Kill and Yank Functions @noindent @@ -29834,7 +29833,7 @@ work with Calc from a regular editing buffer. @xref{Embedded Mode}. * X Cut and Paste:: @end menu -@node Killing From Stack, Yanking Into Stack, Kill and Yank, Kill and Yank +@node Killing From Stack @section Killing from the Stack @noindent @@ -29878,7 +29877,7 @@ with no argument copies only the number itself into the kill ring, whereas @kbd{C-k} with a prefix argument of 1 copies the number with its trailing newline. -@node Yanking Into Stack, Saving Into Registers, Killing From Stack, Kill and Yank +@node Yanking Into Stack @section Yanking into the Stack @noindent @@ -29910,7 +29909,7 @@ allow the text being yanked to be read in a different base (such as if the text is an algebraic expression), then the prefix will have no effect. -@node Saving Into Registers, Inserting From Registers, Yanking Into Stack, Kill and Yank +@node Saving Into Registers @section Saving into Registers @noindent @@ -29944,7 +29943,7 @@ region to the beginning of the register contents. Both commands take @kbd{C-u} arguments, which will cause the region to be deleted after being added to the register. -@node Inserting From Registers, Grabbing From Buffers, Saving Into Registers, Kill and Yank +@node Inserting From Registers @section Inserting from Registers @noindent @kindex r i @@ -29956,7 +29955,7 @@ within Calc, then the full internal structure of the contents will be inserted into the Calculator, otherwise whatever text is in the register is reparsed and then inserted into the Calculator. -@node Grabbing From Buffers, Yanking Into Buffers, Inserting From Registers, Kill and Yank +@node Grabbing From Buffers @section Grabbing from Other Buffers @noindent @@ -30073,7 +30072,7 @@ handy way to find the product of a vector or matrix of numbers. @xref{Statistical Operations}. Another approach would be to use an explicit column reduction command, @kbd{V R : *}. -@node Yanking Into Buffers, X Cut and Paste, Grabbing From Buffers, Kill and Yank +@node Yanking Into Buffers @section Yanking into Other Buffers @noindent @@ -30127,7 +30126,7 @@ The @kbd{C-x * y} key sequence is equivalent to @kbd{y} except that it can be typed anywhere, not just in Calc. This provides an easy way to guarantee that Calc knows which editing buffer you want to use! -@node X Cut and Paste, , Yanking Into Buffers, Kill and Yank +@node X Cut and Paste @section X Cut and Paste @noindent @@ -30156,7 +30155,7 @@ whole line. So you can usually transfer a single number into Calc just by double-clicking on it in the shell, then middle-clicking in the Calc window. -@node Keypad Mode, Embedded Mode, Kill and Yank, Top +@node Keypad Mode @chapter Keypad Mode @noindent @@ -30208,7 +30207,7 @@ original buffer. * Keypad Modes Menu:: @end menu -@node Keypad Main Menu, Keypad Functions Menu, Keypad Mode, Keypad Mode +@node Keypad Main Menu @section Main Menu @smallexample @@ -30339,7 +30338,7 @@ running standalone (the @code{full-calc-keypad} command appeared in the command line that started Emacs), then @kbd{OFF} is replaced with @kbd{EXIT}; clicking on this actually exits Emacs itself. -@node Keypad Functions Menu, Keypad Binary Menu, Keypad Main Menu, Keypad Mode +@node Keypad Functions Menu @section Functions Menu @smallexample @@ -30382,7 +30381,7 @@ same limit as last time. @key{NXTP} finds the next prime after a number. @kbd{INV NXTP} finds the previous prime. -@node Keypad Binary Menu, Keypad Vectors Menu, Keypad Functions Menu, Keypad Mode +@node Keypad Binary Menu @section Binary Menu @smallexample @@ -30415,7 +30414,7 @@ and allows you to enter a new word size. You can respond to the prompt using either the keyboard or the digits and @key{ENTER} from the keypad. The initial word size is 32 bits. -@node Keypad Vectors Menu, Keypad Modes Menu, Keypad Binary Menu, Keypad Mode +@node Keypad Vectors Menu @section Vectors Menu @smallexample @@ -30497,7 +30496,7 @@ With @key{INV}, @key{HYP}, or @key{INV} and @key{HYP}, the @kbd{"x"} key pushes the variable names @expr{y}, @expr{z}, and @expr{t}, respectively. -@node Keypad Modes Menu, , Keypad Vectors Menu, Keypad Mode +@node Keypad Modes Menu @section Modes Menu @smallexample @@ -30553,7 +30552,7 @@ The @key{STO} and @key{RCL} keys are analogous to @kbd{s t} and variables are not available in Keypad mode.) You can also use, for example, @kbd{STO + 3} to add to register 3. -@node Embedded Mode, Programming, Keypad Mode, Top +@node Embedded Mode @chapter Embedded Mode @noindent @@ -30570,7 +30569,7 @@ linked to the stack and this copying is taken care of automatically. * Customizing Embedded Mode:: @end menu -@node Basic Embedded Mode, More About Embedded Mode, Embedded Mode, Embedded Mode +@node Basic Embedded Mode @section Basic Embedded Mode @noindent @@ -30734,7 +30733,7 @@ own Undo command (typed before you turn Embedded mode back off) will not do you any good, because as far as Calc is concerned you haven't done anything with this formula yet. -@node More About Embedded Mode, Assignments in Embedded Mode, Basic Embedded Mode, Embedded Mode +@node More About Embedded Mode @section More About Embedded Mode @noindent @@ -30918,7 +30917,7 @@ embedded formula at the current point as if by @kbd{`} (@code{calc-edit}). Embedded mode does not have to be enabled for this to work. Press @kbd{C-c C-c} to finish the edit, or @kbd{C-x k} to cancel. -@node Assignments in Embedded Mode, Mode Settings in Embedded Mode, More About Embedded Mode, Embedded Mode +@node Assignments in Embedded Mode @section Assignments in Embedded Mode @noindent @@ -31144,7 +31143,7 @@ Operator}. When you turn automatic recomputation back on, the stack will be updated but the Embedded buffer will not; you must use @kbd{C-x * u} to update the buffer by hand. -@node Mode Settings in Embedded Mode, Customizing Embedded Mode, Assignments in Embedded Mode, Embedded Mode +@node Mode Settings in Embedded Mode @section Mode Settings in Embedded Mode @kindex m e @@ -31289,7 +31288,7 @@ annotations at all. When Embedded mode is not enabled, mode-recording modes except for @code{Save} have no effect. -@node Customizing Embedded Mode, , Mode Settings in Embedded Mode, Embedded Mode +@node Customizing Embedded Mode @section Customizing Embedded Mode @noindent @@ -31441,7 +31440,7 @@ is simply a newline, @code{"\n"}, but may be different for different major modes. If you change this, it is a good idea still to end with a newline so that mode annotations will appear on lines by themselves. -@node Programming, Copying, Embedded Mode, Top +@node Programming @chapter Programming @noindent @@ -31492,7 +31491,7 @@ described elsewhere; @pxref{User-Defined Compositions}.) * Lisp Definitions:: @end menu -@node Creating User Keys, Keyboard Macros, Programming, Programming +@node Creating User Keys @section Creating User Keys @noindent @@ -31567,7 +31566,7 @@ of a user key. This works for keys that have been defined by either keyboard macros or formulas; further details are contained in the relevant following sections. -@node Keyboard Macros, Invocation Macros, Creating User Keys, Programming +@node Keyboard Macros @section Programming with Keyboard Macros @noindent @@ -31610,7 +31609,7 @@ analogous to those provided by a traditional programmable calculator. * Queries in Macros:: @end menu -@node Naming Keyboard Macros, Conditionals in Macros, Keyboard Macros, Keyboard Macros +@node Naming Keyboard Macros @subsection Naming Keyboard Macros @noindent @@ -31660,7 +31659,7 @@ of spelled-out keystrokes and defines it as the current keyboard macro. It is a convenient way to define a keyboard macro that has been stored in a file, or to define a macro without executing it at the same time. -@node Conditionals in Macros, Loops in Macros, Naming Keyboard Macros, Keyboard Macros +@node Conditionals in Macros @subsection Conditionals in Keyboard Macros @noindent @@ -31736,7 +31735,7 @@ If Calc gets stuck while skipping characters during the definition of a macro, type @kbd{Z C-g} to cancel the definition. (Typing plain @kbd{C-g} actually adds a @kbd{C-g} keystroke to the macro.) -@node Loops in Macros, Local Values in Macros, Conditionals in Macros, Keyboard Macros +@node Loops in Macros @subsection Loops in Keyboard Macros @noindent @@ -31829,7 +31828,7 @@ as easily as in a macro definition. @xref{Conditionals in Macros}, for some additional notes about conditional and looping commands. -@node Local Values in Macros, Queries in Macros, Loops in Macros, Keyboard Macros +@node Local Values in Macros @subsection Local Values in Macros @noindent @@ -31894,7 +31893,7 @@ The contents of the stack and trail, values of non-quick variables, and other settings such as the language mode and the various display modes, are @emph{not} affected by @kbd{Z `} and @kbd{Z '}. -@node Queries in Macros, , Local Values in Macros, Keyboard Macros +@node Queries in Macros @subsection Queries in Keyboard Macros @c @noindent @@ -31934,7 +31933,7 @@ keyboard input during a keyboard macro. In particular, you can use any Calculator operations interactively before pressing @kbd{C-M-c} to return control to the keyboard macro. -@node Invocation Macros, Algebraic Definitions, Keyboard Macros, Programming +@node Invocation Macros @section Invocation Macros @kindex C-x * z @@ -31967,7 +31966,7 @@ The @kbd{m m} command saves the last invocation macro defined by @kbd{Z I} along with all the other Calc mode settings. @xref{General Mode Commands}. -@node Algebraic Definitions, Lisp Definitions, Invocation Macros, Programming +@node Algebraic Definitions @section Programming with Formulas @noindent @@ -32079,7 +32078,7 @@ default simplifications cures this problem: The definition will be stored in symbolic form without ever activating the @code{deriv} function. Press @kbd{m D} to turn the default simplifications back on afterwards. -@node Lisp Definitions, , Algebraic Definitions, Programming +@node Lisp Definitions @section Programming with Lisp @noindent @@ -32115,7 +32114,7 @@ for the true Lisp enthusiast. * Internals:: @end menu -@node Defining Functions, Defining Simple Commands, Lisp Definitions, Lisp Definitions +@node Defining Functions @subsection Defining New Functions @noindent @@ -32240,7 +32239,7 @@ as the value of a function. You can use @code{return} anywhere inside the body of the function. @end itemize -Non-integer numbers (and extremely large integers) cannot be included +Non-integer numbers cannot be included directly into a @code{defmath} definition. This is because the Lisp reader will fail to parse them long before @code{defmath} ever gets control. Instead, use the notation, @samp{:"3.1415"}. In fact, any algebraic @@ -32336,7 +32335,7 @@ property are @code{defmath} calls, @code{define-key} calls that modify the Calc key map, and any calls that redefine things defined inside Calc. Ordinary @code{defun}s need not be enclosed with @code{calc-define}. -@node Defining Simple Commands, Defining Stack Commands, Defining Functions, Lisp Definitions +@node Defining Simple Commands @subsection Defining New Simple Commands @noindent @@ -32374,7 +32373,7 @@ This expands to the pair of definitions, @noindent where in this case the latter function would never really be used! Note -that since the Calculator stores small integers as plain Lisp integers, +that since the Calculator stores integers as plain Lisp integers, the @code{math-add} function will work just as well as the native @code{+} even when the intent is to operate on native Lisp integers. @@ -32498,7 +32497,7 @@ decreases the precision. (run-hooks 'calc-check-defines) @end smallexample -@node Defining Stack Commands, Argument Qualifiers, Defining Simple Commands, Lisp Definitions +@node Defining Stack Commands @subsection Defining New Stack-Based Commands @noindent @@ -32600,7 +32599,7 @@ number of objects to remove from the stack and pass to the function. In this case, the integer @var{num} serves as a default number of arguments to be used when no prefix is supplied. -@node Argument Qualifiers, Example Definitions, Defining Stack Commands, Lisp Definitions +@node Argument Qualifiers @subsection Argument Qualifiers @noindent @@ -32643,8 +32642,8 @@ Like @samp{integer}, but the argument must be non-negative. @item fixnum @findex fixnum -Like @samp{integer}, but the argument must fit into a native Lisp integer, -which on most systems means less than 2^23 in absolute value. The +Like @samp{integer}, but the argument must fit into a native Lisp fixnum, +which on most systems means less than 2^61 in absolute value. The argument is converted into Lisp-integer form if necessary. @item float @@ -32687,7 +32686,7 @@ expands to which performs the necessary checks and conversions before executing the body of the function. -@node Example Definitions, Calling Calc from Your Programs, Argument Qualifiers, Lisp Definitions +@node Example Definitions @subsection Example Definitions @noindent @@ -32700,7 +32699,7 @@ These programs make use of some of the Calculator's internal functions; * Sine Example:: @end menu -@node Bit Counting Example, Sine Example, Example Definitions, Example Definitions +@node Bit Counting Example @subsubsection Bit-Counting @noindent @@ -32740,51 +32739,7 @@ Emacs Lisp function: count)) @end smallexample -If the input numbers are large, this function involves a fair amount -of arithmetic. A binary right shift is essentially a division by two; -recall that Calc stores integers in decimal form so bit shifts must -involve actual division. - -To gain a bit more efficiency, we could divide the integer into -@var{n}-bit chunks, each of which can be handled quickly because -they fit into Lisp integers. It turns out that Calc's arithmetic -routines are especially fast when dividing by an integer less than -1000, so we can set @var{n = 9} bits and use repeated division by 512: - -@smallexample -(defmath bcount ((natnum n)) - (interactive 1 "bcnt") - (let ((count 0)) - (while (not (fixnump n)) - (let ((qr (idivmod n 512))) - (setq count (+ count (bcount-fixnum (cdr qr))) - n (car qr)))) - (+ count (bcount-fixnum n)))) - -(defun bcount-fixnum (n) - (let ((count 0)) - (while (> n 0) - (setq count (+ count (logand n 1)) - n (ash n -1))) - count)) -@end smallexample - -@noindent -Note that the second function uses @code{defun}, not @code{defmath}. -Because this function deals only with native Lisp integers (``fixnums''), -it can use the actual Emacs @code{+} and related functions rather -than the slower but more general Calc equivalents which @code{defmath} -uses. - -The @code{idivmod} function does an integer division, returning both -the quotient and the remainder at once. Again, note that while it -might seem that @samp{(logand n 511)} and @samp{(ash n -9)} are -more efficient ways to split off the bottom nine bits of @code{n}, -actually they are less efficient because each operation is really -a division by 512 in disguise; @code{idivmod} allows us to do the -same thing with a single division by 512. - -@node Sine Example, , Bit Counting Example, Example Definitions +@node Sine Example @subsubsection The Sine Function @noindent @@ -32868,7 +32823,7 @@ it carefully as shown in this second example. For quick-and-dirty programs, when you know that your own use of the sine function will never encounter a large argument, a simpler program like the first one shown is fine. -@node Calling Calc from Your Programs, Internals, Example Definitions, Lisp Definitions +@node Calling Calc from Your Programs @subsection Calling Calc from Your Lisp Programs @noindent @@ -33042,9 +32997,7 @@ in this case it would be easier to call the low-level @code{math-add} function in Calc, if you can remember its name. In particular, note that a plain Lisp integer is acceptable to Calc -as a raw object. (All Lisp integers are accepted on input, but -integers of more than six decimal digits are converted to ``big-integer'' -form for output. @xref{Data Type Formats}.) +as a raw object. When it comes time to display the object, just use @samp{(calc-eval a)} to format it as a string. @@ -33264,7 +33217,7 @@ Note the use of @code{insert-before-markers} when changing between ``F'' and ``C'', so that the character winds up before the cursor instead of after it. -@node Internals, , Calling Calc from Your Programs, Lisp Definitions +@node Internals @subsection Calculator Internals @noindent @@ -33304,35 +33257,15 @@ you can't prove this file will already be loaded. * Hooks:: @end menu -@node Data Type Formats, Interactive Lisp Functions, Internals, Internals +@node Data Type Formats @subsubsection Data Type Formats @noindent -Integers are stored in either of two ways, depending on their magnitude. -Integers less than one million in absolute value are stored as standard -Lisp integers. This is the only storage format for Calc data objects -which is not a Lisp list. - -Large integers are stored as lists of the form @samp{(bigpos @var{d0} -@var{d1} @var{d2} @dots{})} for sufficiently large positive integers -(where ``sufficiently large'' depends on the machine), or -@samp{(bigneg @var{d0} @var{d1} @var{d2} @dots{})} for negative -integers. Each @var{d} is a base-@expr{10^n} ``digit'' (where again, -@expr{n} depends on the machine), a Lisp integer from 0 to -99@dots{}9. The least significant digit is @var{d0}; the last digit, -@var{dn}, which is always nonzero, is the most significant digit. For -example, the integer @mathit{-12345678} might be stored as -@samp{(bigneg 678 345 12)}. - -The distinction between small and large integers is entirely hidden from -the user. In @code{defmath} definitions, the Lisp predicate @code{integerp} -returns true for either kind of integer, and in general both big and small -integers are accepted anywhere the word ``integer'' is used in this manual. -If the distinction must be made, native Lisp integers are called @dfn{fixnums} -and large integers are called @dfn{bignums}. +Integers are stored as standard Lisp integers. This is the only +storage format for Calc data objects which is not a Lisp list. Fractions are stored as a list of the form, @samp{(frac @var{n} @var{d})} -where @var{n} is an integer (big or small) numerator, @var{d} is an +where @var{n} is an integer numerator, @var{d} is an integer denominator greater than one, and @var{n} and @var{d} are relatively prime. Note that fractions where @var{d} is one are automatically converted to plain integers by all math routines; fractions where @var{d} is negative @@ -33341,7 +33274,7 @@ are normalized by negating the numerator and denominator. Floating-point numbers are stored in the form, @samp{(float @var{mant} @var{exp})}, where @var{mant} (the ``mantissa'') is an integer less than @samp{10^@var{p}} in absolute value (@var{p} represents the current -precision), and @var{exp} (the ``exponent'') is a fixnum. The value of +precision), and @var{exp} (the ``exponent'') is an integer. The value of the float is @samp{@var{mant} * 10^@var{exp}}. For example, the number @mathit{-3.14} is stored as @samp{(float -314 -2) = -314*10^-2}. Other constraints are that the number 0.0 is always stored as @samp{(float 0 0)}, and, @@ -33444,7 +33377,7 @@ functions which are the outer-level call in an expression whose value is about to be pushed on the stack; this feature is considered obsolete and is not used by any built-in Calc functions.) -@node Interactive Lisp Functions, Stack Lisp Functions, Data Type Formats, Internals +@node Interactive Lisp Functions @subsubsection Interactive Functions @noindent @@ -33505,7 +33438,7 @@ i.e., if the Inverse (@kbd{I} key) flag was set. This predicate is the analogous function for the @kbd{H} key. @end defun -@node Stack Lisp Functions, Predicates, Interactive Lisp Functions, Internals +@node Stack Lisp Functions @subsubsection Stack-Oriented Functions @noindent @@ -33692,7 +33625,7 @@ is suppressed, but a flag is set so that the entire stack will be refreshed rather than just the top few elements when the macro finishes.) @end defun -@node Predicates, Computational Lisp Functions, Stack Lisp Functions, Internals +@node Predicates @subsubsection Predicates @noindent @@ -33736,7 +33669,7 @@ Returns true if @var{x} is an integer of any size. @end defun @defun fixnump x -Returns true if @var{x} is a native Lisp integer. +Returns true if @var{x} is a native Lisp fixnum. @end defun @defun natnump x @@ -33744,7 +33677,7 @@ Returns true if @var{x} is a nonnegative integer of any size. @end defun @defun fixnatnump x -Returns true if @var{x} is a nonnegative Lisp integer. +Returns true if @var{x} is a nonnegative Lisp fixnum. @end defun @defun num-integerp x @@ -33899,7 +33832,7 @@ converted to @samp{(math-equal x y)}. @defun equal-int x n Returns true if @var{x} and @var{n} are numerically equal, where @var{n} -is a fixnum which is not a multiple of 10. This will automatically be +is an integer which is not a multiple of 10. This will automatically be used by @code{defmath} in place of the more general @code{math-equal} whenever possible. @end defun @@ -33960,7 +33893,7 @@ This signals an error that will be reported as a floating-point overflow. This signals a floating-point underflow. @end defun -@node Computational Lisp Functions, Vector Lisp Functions, Predicates, Internals +@node Computational Lisp Functions @subsubsection Computational Functions @noindent @@ -33980,12 +33913,8 @@ respectively, instead. @defun normalize val (Full form: @code{math-normalize}.) -Reduce the value @var{val} to standard form. For example, if @var{val} -is a fixnum, it will be converted to a bignum if it is too large, and -if @var{val} is a bignum it will be normalized by clipping off trailing -(i.e., most-significant) zero digits and converting to a fixnum if it is -small. All the various data types are similarly converted to their standard -forms. Variables are left alone, but function calls are actually evaluated +Reduce the value @var{val} to standard form. +Variables are left alone, but function calls are actually evaluated in formulas. For example, normalizing @samp{(+ 2 (calcFunc-abs -4))} will return 6. @@ -34098,9 +34027,9 @@ integer rather than truncating. @end defun @defun fixnum n -Return the integer @var{n} as a fixnum, i.e., a native Lisp integer. -If @var{n} is outside the permissible range for Lisp integers (usually -24 binary bits) the result is undefined. +Return the integer @var{n} as a fixnum, i.e., a small Lisp integer. +If @var{n} is outside the permissible range for Lisp fixnums (usually +62 binary bits) the result is undefined. @end defun @defun sqr x @@ -34304,7 +34233,7 @@ it returns 1 or 3. If @var{n} is anything else, this function returns @code{nil}. @end defun -@node Vector Lisp Functions, Symbolic Lisp Functions, Computational Lisp Functions, Internals +@node Vector Lisp Functions @subsubsection Vector Functions @noindent @@ -34441,7 +34370,7 @@ is true, with the side effect of exchanging the first two rows of @var{m}. @end defun -@node Symbolic Lisp Functions, Formatting Lisp Functions, Vector Lisp Functions, Internals +@node Symbolic Lisp Functions @subsubsection Symbolic Functions @noindent @@ -35012,7 +34941,7 @@ Return a copy of @var{expr} with everything but units variables replaced by ones. @end defun -@node Formatting Lisp Functions, Hooks, Symbolic Lisp Functions, Internals +@node Formatting Lisp Functions @subsubsection I/O and Formatting Functions @noindent @@ -35158,7 +35087,7 @@ If composition @var{c} is a ``flat'' composition, return the last @comment @noindent @comment (This section is currently unfinished.) -@node Hooks, , Formatting Lisp Functions, Internals +@node Hooks @subsubsection Hooks @noindent @@ -35313,15 +35242,15 @@ used the first time, your hook should add a variable to the list and also call @code{make-local-variable} itself. @end defvar -@node Copying, GNU Free Documentation License, Programming, Top +@node Copying @appendix GNU GENERAL PUBLIC LICENSE @include gpl.texi -@node GNU Free Documentation License, Customizing Calc, Copying, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Customizing Calc, Reporting Bugs, GNU Free Documentation License, Top +@node Customizing Calc @appendix Customizing Calc The usual prefix for Calc is the key sequence @kbd{C-x *}. If you wish @@ -35715,7 +35644,7 @@ choose from, or the user can enter their own date. The default value of @code{calc-gregorian-switch} is @code{nil}. @end defvar -@node Reporting Bugs, Summary, Customizing Calc, Top +@node Reporting Bugs @appendix Reporting Bugs @noindent @@ -35740,7 +35669,7 @@ The latest version of Calc is available from Savannah, in the Emacs repository. See @uref{https://savannah.gnu.org/projects/emacs}. @c [summary] -@node Summary, Key Index, Reporting Bugs, Top +@node Summary @appendix Calc Summary @noindent @@ -37011,12 +36940,12 @@ grabs the @var{n}th mode value only. @c [end-summary] -@node Key Index, Command Index, Summary, Top +@node Key Index @unnumbered Index of Key Sequences @printindex ky -@node Command Index, Function Index, Key Index, Top +@node Command Index @unnumbered Index of Calculator Commands Since all Calculator commands begin with the prefix @samp{calc-}, the @@ -37026,7 +36955,7 @@ types @samp{calc-} for you. Thus, @kbd{x last-args} is short for @printindex pg -@node Function Index, Concept Index, Command Index, Top +@node Function Index @unnumbered Index of Algebraic Functions This is a list of built-in functions and operators usable in algebraic @@ -37039,12 +36968,12 @@ Calc keystrokes and can also be found in the Calc Summary. @printindex tp -@node Concept Index, Variable Index, Function Index, Top +@node Concept Index @unnumbered Concept Index @printindex cp -@node Variable Index, Lisp Function Index, Concept Index, Top +@node Variable Index @unnumbered Index of Variables The variables in this list that do not contain dashes are accessible @@ -37056,7 +36985,7 @@ in your Calc init file or @file{.emacs} file. @printindex vr -@node Lisp Function Index, , Variable Index, Top +@node Lisp Function Index @unnumbered Index of Lisp Math Functions The following functions are meant to be used with @code{defmath}, not diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 24ab4b773c6..98ded68e713 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi @@ -219,10 +219,9 @@ or can be downloaded from @url{https://savannah.gnu.org/projects/emacs/}. @summarycontents @contents -@node Top, Introduction, (dir), (dir) -@comment node-name, next, previous, up @ifnottex +@node Top @top @ccmode{} @ccmode{} is a GNU Emacs mode for editing files containing C, C++, @@ -360,8 +359,7 @@ Custom Macros @end detailmenu @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Introduction, Overview, Top, Top -@comment node-name, next, previous, up +@node Introduction @chapter Introduction @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -420,7 +418,7 @@ also like to thank all the @ccmode{} victims who help enormously during the early beta stages of @ccmode{}'s development. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Overview, Getting Started, Introduction, Top +@node Overview @comment node-name, next, previous, up@cindex organization of the manual @chapter Overview of the Manual @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -489,8 +487,7 @@ project: whether for updating @ccmode{} or submitting bug reports. Finally, there are the customary indices. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Getting Started, Commands, Overview, Top -@comment node-name, next, previous, up +@node Getting Started @chapter Getting Started @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -601,8 +598,7 @@ where @samp{XX} is the minor release number. @end deffn @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Commands, Font Locking, Getting Started, Top -@comment node-name, next, previous, up +@node Commands @chapter Commands @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -638,7 +634,7 @@ structures. @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Indentation Commands, Comment Commands, Commands, Commands +@node Indentation Commands @comment node-name, next, previous,up @section Indentation Commands @cindex indentation @@ -817,8 +813,7 @@ often (in seconds) progress messages are to be displayed. @end defopt @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Comment Commands, Movement Commands, Indentation Commands, Commands -@comment node-name, next, previous, up +@node Comment Commands @section Comment Commands @cindex comments (insertion of) @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -886,8 +881,7 @@ lines. @end table @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Movement Commands, Filling and Breaking, Comment Commands, Commands -@comment node-name, next, previous, up +@node Movement Commands @section Movement Commands @cindex movement @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1042,7 +1036,7 @@ Movement}. They might be removed from a future release of @ccmode{}. @end table @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Filling and Breaking, Minor Modes, Movement Commands, Commands +@node Filling and Breaking @comment node-name, next, previous, up @section Filling and Line Breaking Commands @cindex text filling @@ -1136,8 +1130,7 @@ line break. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Minor Modes, Electric Keys, Filling and Breaking, Commands -@comment node-name, next, previous, up +@node Minor Modes @section Minor Modes @cindex Minor Modes @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1257,8 +1250,7 @@ value will turn it (or them) off. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Electric Keys, Auto-newlines, Minor Modes, Commands -@comment node-name, next, previous, up +@node Electric Keys @section Electric Keys and Keywords @cindex electric characters @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1437,8 +1429,7 @@ modes except IDL mode, since CORBA IDL doesn't have any statements. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Auto-newlines, Hungry WS Deletion, Electric Keys, Commands -@comment node-name, next, previous, up +@node Auto-newlines @section Auto-newline Insertion @cindex auto-newline @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1493,8 +1484,7 @@ clean-ups listed by key. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Hungry WS Deletion, Subword Movement, Auto-newlines, Commands -@comment node-name, next, previous, up +@node Hungry WS Deletion @section Hungry Deletion of Whitespace @cindex hungry-deletion @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1651,8 +1641,7 @@ trouble with this in GNU Emacs. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Subword Movement, Other Commands, Hungry WS Deletion, Commands -@comment node-name, next, previous, up +@node Subword Movement @section Subword Movement and Editing @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1744,8 +1733,7 @@ As a bonus, you can also use @code{subword-mode} in non-@ccmode{} buffers by typing @kbd{M-x subword-mode}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Other Commands, , Subword Movement, Commands -@comment node-name, next, previous, up +@node Other Commands @section Other Commands @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1842,8 +1830,7 @@ ask for help in the standard (X)Emacs forums. @end table @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Font Locking, Config Basics, Commands, Top -@comment node-name, next, previous, up +@node Font Locking @chapter Font Locking @cindex font locking @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1874,8 +1861,7 @@ sections apply to the other languages. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Font Locking Preliminaries, Faces, Font Locking, Font Locking -@comment node-name, next, previous, up +@node Font Locking Preliminaries @section Font Locking Preliminaries @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -1972,8 +1958,7 @@ recognize types. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Faces, Doc Comments, Font Locking Preliminaries, Font Locking -@comment node-name, next, previous, up +@node Faces @section Faces @cindex faces @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2071,8 +2056,7 @@ since those aren't syntactic errors in themselves. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Doc Comments, Wrong Comment Style, Faces, Font Locking -@comment node-name, next, previous, up +@node Doc Comments @section Documentation Comments @cindex documentation comments @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2156,7 +2140,7 @@ If you add support for another doc comment style, please consider contributing it: send a note to @email{bug-cc-mode@@gnu.org}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Wrong Comment Style, Misc Font Locking, Doc Comments, Font Locking +@node Wrong Comment Style @comment node-name, next, previous, up @section Marking ``Wrong'' style comments @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2178,7 +2162,7 @@ which aren't of the default style will be fontified with @end defvar @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Misc Font Locking, AWK Mode Font Locking, Wrong Comment Style, Font Locking +@node Misc Font Locking @comment node-name, next, previous, up @section Miscellaneous Font Locking @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2233,7 +2217,7 @@ section only applies when CC Mode cannot disambiguate a construct in any other way. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node AWK Mode Font Locking, , Misc Font Locking, Font Locking +@node AWK Mode Font Locking @comment node-name, next, previous, up @section AWK Mode Font Locking @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2294,7 +2278,7 @@ escaped newline. The @samp{\} is highlighted. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Config Basics, Custom Filling and Breaking, Font Locking, Top +@node Config Basics @comment node-name, next, previous, up @chapter Configuration Basics @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2486,8 +2470,7 @@ have it enabled by default by placing the following in your @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node CC Hooks, Style Variables, Config Basics, Config Basics -@comment node-name, next, previous, up +@node CC Hooks @section Hooks @cindex mode hooks @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2560,8 +2543,7 @@ file. @end example @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Style Variables, Styles, CC Hooks, Config Basics -@comment node-name, next, previous, up +@node Style Variables @section Style Variables @cindex styles @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2648,8 +2630,7 @@ Commas});@* (@pxref{Custom Macros}). @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Styles, , Style Variables, Config Basics -@comment node-name, next, previous, up +@node Styles @section Styles @cindex styles @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2683,8 +2664,7 @@ already formatted piece of your code, @ref{Guessing the Style}. @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Built-in Styles, Choosing a Style, Styles, Styles -@comment node-name, next, previous, up +@node Built-in Styles @subsection Built-in Styles @cindex styles, built-in @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2761,8 +2741,7 @@ afterwards. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Choosing a Style, Adding Styles, Built-in Styles, Styles -@comment node-name, next, previous, up +@node Choosing a Style @subsection Choosing a Style @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2819,8 +2798,7 @@ string. @end defvar @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Adding Styles, Guessing the Style, Choosing a Style, Styles -@comment node-name, next, previous, up +@node Adding Styles @subsection Adding and Amending Styles @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -2907,8 +2885,7 @@ should not be changed directly; use @code{c-add-style} instead. @end defvar @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Guessing the Style, File Styles, Adding Styles, Styles -@comment node-name, next, previous, up +@node Guessing the Style @subsection Guessing the Style @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3030,8 +3007,7 @@ these offsets or the parent style name. @end table @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node File Styles, , Guessing the Style, Styles -@comment node-name, next, previous, up +@node File Styles @subsection File Styles @cindex styles, file local @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3079,8 +3055,7 @@ mode hooks (@pxref{CC Hooks}). Any individual setting of a variable will override one made through @code{c-file-style} or @code{c-file-offsets}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Custom Filling and Breaking, Custom Auto-newlines, Config Basics, Top -@comment node-name, next, previous, up +@node Custom Filling and Breaking @chapter Customizing Filling and Line Breaking @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3298,8 +3273,7 @@ as one comment, and the rest of the paragraph handling code inconsistent behavior. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Custom Auto-newlines, Clean-ups, Custom Filling and Breaking, Top -@comment node-name, next, previous, up +@node Custom Auto-newlines @chapter Customizing Auto-newlines @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3354,8 +3328,7 @@ circumstances. @xref{Clean-ups}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Hanging Braces, Hanging Colons, Custom Auto-newlines, Custom Auto-newlines -@comment node-name, next, previous, up +@node Hanging Braces @section Hanging Braces @cindex hanging braces @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3504,8 +3477,7 @@ themselves. @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Custom Braces, , Hanging Braces, Hanging Braces -@comment node-name, next, previous, up +@node Custom Braces @subsection Custom Brace Hanging @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3592,8 +3564,7 @@ In all other cases, it returns the list @samp{(before after)} so that the brace appears on a line by itself. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Hanging Colons, Hanging Semicolons and Commas, Hanging Braces, Custom Auto-newlines -@comment node-name, next, previous, up +@node Hanging Colons @section Hanging Colons @cindex hanging colons @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3635,8 +3606,7 @@ them are controlled by a different mechanism, called @dfn{clean-ups} in @ccmode{}. @xref{Clean-ups}, for details. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Hanging Semicolons and Commas, , Hanging Colons, Custom Auto-newlines -@comment node-name, next, previous, up +@node Hanging Semicolons and Commas @section Hanging Semicolons and Commas @cindex hanging semicolons @cindex hanging commas @@ -3715,8 +3685,7 @@ newlines after semicolons inside one-line inline method definitions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Clean-ups, Indentation Engine Basics, Custom Auto-newlines, Top -@comment node-name, next, previous, up +@node Clean-ups @chapter Clean-ups @cindex clean-ups @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -3968,8 +3937,7 @@ situation if you just want a literal @samp{/} inserted. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Indentation Engine Basics, Customizing Indentation, Clean-ups, Top -@comment node-name, next, previous, up +@node Indentation Engine Basics @chapter Indentation Engine Basics @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4028,8 +3996,7 @@ of the variables associated with indentation, not even @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Syntactic Analysis, Syntactic Symbols, Indentation Engine Basics, Indentation Engine Basics -@comment node-name, next, previous, up +@node Syntactic Analysis @section Syntactic Analysis @cindex syntactic analysis @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4187,8 +4154,7 @@ anchor position. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Syntactic Symbols, Indentation Calculation, Syntactic Analysis, Indentation Engine Basics -@comment node-name, next, previous, up +@node Syntactic Symbols @section Syntactic Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4435,8 +4401,7 @@ Java. @ref{Java Symbols}. @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Function Symbols, Class Symbols, Syntactic Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Function Symbols @subsection Function Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4478,8 +4443,7 @@ isn't much special about them. Note however that line 8 is given on the previous line. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Class Symbols, Conditional Construct Symbols, Function Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Class Symbols @subsection Class related Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4625,8 +4589,7 @@ Here, line 1 is analyzed as a @code{topmost-intro}, but lines 2 and 3 are both analyzed as @code{template-args-cont} lines. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Conditional Construct Symbols, Switch Statement Symbols, Class Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Conditional Construct Symbols @subsection Conditional Construct Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4693,8 +4656,7 @@ the same line as the preceding close brace, that line would still have @code{block-close} syntax. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Switch Statement Symbols, Brace List Symbols, Conditional Construct Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Switch Statement Symbols @subsection Switch Statement Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4729,8 +4691,7 @@ is treated slightly differently since it contains a brace that opens a block; it is given @code{statement-case-open} syntax. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Brace List Symbols, External Scope Symbols, Switch Statement Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Brace List Symbols @subsection Brace List Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4796,8 +4757,7 @@ giving @code{brace-list-entry} an offset of @code{brace-list-entry} anchored on the @samp{1} of line 8. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node External Scope Symbols, Paren List Symbols, Brace List Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node External Scope Symbols @subsection External Scope Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4860,8 +4820,7 @@ that isn't the case for historical reasons.} @end table @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Paren List Symbols, Literal Symbols, External Scope Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Paren List Symbols @subsection Parenthesis (Argument) List Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -4920,8 +4879,7 @@ parenthesis that opens an argument list, appearing on a separate line, is assigned the @code{statement-cont} syntax instead. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Literal Symbols, Multiline Macro Symbols, Paren List Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Literal Symbols @subsection Comment String Label and Macro Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5009,8 +4967,7 @@ Line 17 is assigned @code{stream-op} syntax. @end itemize @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Multiline Macro Symbols, Objective-C Method Symbols, Literal Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Multiline Macro Symbols @subsection Multiline Macro Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5050,8 +5007,7 @@ macros.}. @xref{Custom Macros}, for more info about the treatment of macros. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Objective-C Method Symbols, Java Symbols, Multiline Macro Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Objective-C Method Symbols @subsection Objective-C Method Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5077,8 +5033,7 @@ assigned @code{objc-method-args-cont} syntax. Lines 5 and 6 are both assigned @code{objc-method-call-cont} syntax. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Java Symbols, Statement Block Symbols, Objective-C Method Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Java Symbols @subsection Java Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5115,8 +5070,7 @@ syntax due to it being a continuation of a variable declaration where preceding the declaration is an annotation. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Statement Block Symbols, K&R Symbols, Java Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node Statement Block Symbols @subsection Statement Block Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5194,8 +5148,7 @@ example above. The other similar special function, @code{gauge}, is handled like this too. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node K&R Symbols, , Statement Block Symbols, Syntactic Symbols -@comment node-name, next, previous, up +@node K&R Symbols @subsection K&R Symbols @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5221,8 +5174,7 @@ syntax. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Indentation Calculation, , Syntactic Symbols, Indentation Engine Basics -@comment node-name, next, previous, up +@node Indentation Calculation @section Indentation Calculation @cindex indentation @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5320,8 +5272,7 @@ minibuffer when you hit @kbd{TAB}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Customizing Indentation, Custom Macros, Indentation Engine Basics, Top -@comment node-name, next, previous, up +@node Customizing Indentation @chapter Customizing Indentation @cindex customization, indentation @cindex indentation @@ -5367,8 +5318,7 @@ indentation. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node c-offsets-alist, Interactive Customization, Customizing Indentation, Customizing Indentation -@comment node-name, next, previous, up +@node c-offsets-alist @section c-offsets-alist @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5536,8 +5486,7 @@ it doesn't work well with some of the alignment functions that return @code{c-strict-syntax-p} set to @code{nil}.}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Interactive Customization, Line-Up Functions, c-offsets-alist, Customizing Indentation -@comment node-name, next, previous, up +@node Interactive Customization @section Interactive Customization @cindex customization, interactive @cindex interactive customization @@ -5644,8 +5593,7 @@ for that syntactic element. @c End of MOVE THIS BIT. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Line-Up Functions, Custom Line-Up, Interactive Customization, Customizing Indentation -@comment node-name, next, previous, up +@node Line-Up Functions @section Line-Up Functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5718,8 +5666,7 @@ Works with: @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Brace/Paren Line-Up, List Line-Up, Line-Up Functions, Line-Up Functions -@comment node-name, next, previous, up +@node Brace/Paren Line-Up @subsection Brace and Parenthesis Line-Up Functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -5975,8 +5922,7 @@ and @code{inextern-lang}. @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node List Line-Up, Operator Line-Up, Brace/Paren Line-Up, Line-Up Functions -@comment node-name, next, previous, up +@node List Line-Up @subsection List Line-Up Functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6300,8 +6246,7 @@ the current line with the colon on the previous line. @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Operator Line-Up, Comment Line-Up, List Line-Up, Line-Up Functions -@comment node-name, next, previous, up +@node Operator Line-Up @subsection Operator Line-Up Functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6468,8 +6413,7 @@ lineup functions. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Comment Line-Up, Misc Line-Up, Operator Line-Up, Line-Up Functions -@comment node-name, next, previous, up +@node Comment Line-Up @subsection Comment Line-Up Functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6578,8 +6522,7 @@ expressions. @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Misc Line-Up, , Comment Line-Up, Line-Up Functions -@comment node-name, next, previous, up +@node Misc Line-Up @subsection Miscellaneous Line-Up Functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6780,8 +6723,7 @@ the_larch, @hereFn{c-lineup-topmost-intro-cont} @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Custom Line-Up, Other Indentation, Line-Up Functions, Customizing Indentation -@comment node-name, next, previous, up +@node Custom Line-Up @section Custom Line-Up Functions @cindex customization, indentation functions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6896,8 +6838,7 @@ any syntactic symbol that appears in @code{c-offsets-alist} can have a custom line-up function associated with it. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Other Indentation, , Custom Line-Up, Customizing Indentation -@comment node-name, next, previous, up +@node Other Indentation @section Other Special Indentations @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6948,8 +6889,7 @@ functions to this hook, not remove them. @xref{Style Variables}. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Custom Macros, Odds and Ends, Customizing Indentation, Top -@comment node-name, next, previous, up +@node Custom Macros @chapter Customizing Macros @cindex macros @cindex preprocessor directives @@ -6997,7 +6937,7 @@ Macros}. @end menu @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Macro Backslashes, Macros with ;, Custom Macros, Custom Macros +@node Macro Backslashes @comment node-name, next, previous, up @section Customizing Macro Backslashes @cindex @code{#define} @@ -7045,7 +6985,7 @@ get aligned only when you explicitly invoke the command @end defopt @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Macros with ;, Noise Macros, Macro Backslashes, Custom Macros +@node Macros with ; @comment node-name, next, previous, up @section Macros with semicolons @cindex macros with semicolons @@ -7103,8 +7043,7 @@ initialization code, after the mode hooks have run. @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Noise Macros, Indenting Directives, Macros with ;, Custom Macros -@comment node-name, next, previous, up +@node Noise Macros @section Noise Macros @cindex noise macros @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7160,8 +7099,7 @@ after the mode hooks have run. @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Indenting Directives, , Noise Macros, Custom Macros -@comment node-name, next, previous, up +@node Indenting Directives @section Indenting Directives @cindex Indenting Directives @cindex Indenting #pragma @@ -7202,8 +7140,7 @@ depends on that variable. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Odds and Ends, Sample Init File, Custom Macros, Top -@comment node-name, next, previous, up +@node Odds and Ends @chapter Odds and Ends @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7246,8 +7183,7 @@ anchoring position to indent the line in that case. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Sample Init File, Performance Issues, Odds and Ends, Top -@comment node-name, next, previous, up +@node Sample Init File @appendix Sample Init File @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7305,8 +7241,7 @@ to change some of the actual values. @end verbatim @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Performance Issues, Limitations and Known Bugs, Sample Init File, Top -@comment node-name, next, previous, up +@node Performance Issues @appendix Performance Issues @cindex performance @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7414,8 +7349,7 @@ more info. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Limitations and Known Bugs, FAQ, Performance Issues, Top -@comment node-name, next, previous, up +@node Limitations and Known Bugs @appendix Limitations and Known Bugs @cindex limitations @cindex bugs @@ -7480,8 +7414,7 @@ early on: @end itemize @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node FAQ, Updating CC Mode, Limitations and Known Bugs, Top -@comment node-name, next, previous, up +@node FAQ @appendix Frequently Asked Questions @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7609,8 +7542,7 @@ there since it's got its own system to keep track of blocks. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Updating CC Mode, Mailing Lists and Bug Reports, FAQ, Top -@comment node-name, next, previous, up +@node Updating CC Mode @appendix Getting the Latest CC Mode Release @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7629,8 +7561,7 @@ compatibility, etc.@: are all available on the web site: @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Mailing Lists and Bug Reports, GNU Free Documentation License, Updating CC Mode, Top -@comment node-name, next, previous, up +@node Mailing Lists and Bug Reports @appendix Mailing Lists and Submitting Bug Reports @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7673,15 +7604,14 @@ to the Usenet newsgroups @code{gnu.emacs.sources}, @code{comp.emacs}, @c There is no newsgroup for Pike. :-( -@node GNU Free Documentation License, Command and Function Index, Mailing Lists and Bug Reports, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi @c Removed the tentative node "Mode Initialization" from here, 2005/8/27. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Command and Function Index, Variable Index, GNU Free Documentation License, Top -@comment node-name, next, previous, up +@node Command and Function Index @unnumbered Command and Function Index @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7695,8 +7625,7 @@ Since most @ccmode{} commands are prepended with the string @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Variable Index, Concept and Key Index, Command and Function Index, Top -@comment node-name, next, previous, up +@node Variable Index @unnumbered Variable Index @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -7710,8 +7639,7 @@ Since most @ccmode{} variables are prepended with the string @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Concept and Key Index, , Variable Index, Top -@comment node-name, next, previous, up +@node Concept and Key Index @unnumbered Concept and Key Index @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index 7464ba2eb1d..c89e0e75f85 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi @@ -2084,14 +2084,15 @@ This clause also accepts optional @samp{from @var{pos}} and @samp{to @var{pos}} terms, limiting the clause to overlays which overlap the specified region. -@item for @var{var} being the intervals [of @var{buffer}] @dots{} -This clause iterates over all intervals of a buffer with constant -text properties. The variable @var{var} will be bound to conses -of start and end positions, where one start position is always equal -to the previous end position. The clause allows @code{of}, +@item for @var{var} being the intervals [of @var{object}] @dots{} +This clause iterates over all intervals of a buffer or string with +constant text properties. The variable @var{var} will be bound to +conses of start and end positions, where one start position is always +equal to the previous end position. The clause allows @code{of}, @code{from}, @code{to}, and @code{property} terms, where the latter term restricts the search to just the specified property. The -@code{of} term may specify either a buffer or a string. +@code{of} term may specify either a buffer or a string. @xref{Text +Properties,,,elisp}. @item for @var{var} being the frames This clause iterates over all Emacs frames. The clause @code{screens} is @@ -2238,7 +2239,7 @@ were non-@code{nil}, the loop returns @code{t}: @item never @var{condition} This clause is like @code{always}, except that the loop returns -@code{t} if any conditions were false, or @code{nil} otherwise. +@code{t} if all conditions were false, or @code{nil} otherwise. @item thereis @var{condition} This clause stops the loop when the specified form is non-@code{nil}; diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index a53f879c961..a0f316f8480 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi @@ -67,7 +67,7 @@ modify this GNU manual.'' @contents -@node Top, EDE Project Concepts, (dir), (dir) +@node Top @top EDE @comment node-name, next, previous, up @@ -95,7 +95,7 @@ learn and adopt GNU ways of doing things. * GNU Free Documentation License:: The license for this documentation. @end menu -@node EDE Project Concepts, EDE Mode, Top, Top +@node EDE Project Concepts @chapter @ede{} Project Concepts @ede{} is a generic interface for managing projects. It specifies a @@ -130,7 +130,7 @@ of search to files in a single target, or to discover the location of documentation or interface files. @ede{} can provide this information. -@node EDE Mode, Quick Start, EDE Project Concepts, Top +@node EDE Mode @chapter @ede{} Mode @ede{} is implemented as a minor mode, which augments other modes such @@ -147,7 +147,7 @@ bar. This menu provides several menu items for high-level @ede{} commands. These menu items, and their corresponding keybindings, are independent of the type of project you are actually working on. -@node Quick Start, Creating a project, EDE Mode, Top +@node Quick Start @chapter Quick Start Once you have @ede{} enabled, you can create a project. This chapter @@ -443,7 +443,7 @@ C-c . R @key{RET} @key{RET} If your program takes command line arguments, you can type them in when it offers the command line you want to use to run your program. -@node Creating a project, Modifying your project, Quick Start, Top +@node Creating a project @chapter Creating a project To create a new project, first visit a file that you want to include @@ -488,7 +488,7 @@ the top-most project's makefile as a starting place for the build. How the toplevel project handles subprojects in the build process is dependent on that project's type. -@node Modifying your project, Building and Debugging, Creating a project, Top +@node Modifying your project @chapter Modifying your project In this chapter, we describe the generic features for manipulating @@ -504,7 +504,7 @@ detailed information about exactly what these features do. * EDE Project Features:: @end menu -@node Add/Remove target, Add/Remove files, Modifying your project, Modifying your project +@node Add/Remove target @section Add/Remove target To create a new target, type @kbd{C-c . t} (@code{ede-new-target}) or @@ -520,7 +520,7 @@ To remove a target from the project, type @kbd{M-x ede-delete-target}, or use the @samp{Remove Target} menu item in the @samp{Project Options} submenu. -@node Add/Remove files, Customize Features, Add/Remove target, Modifying your project +@node Add/Remove files @section Add/Remove files To add the current file to an existing target, type @kbd{C-c . a} @@ -541,7 +541,7 @@ not wish to add the file to any target, you can choose @samp{none}. You can customize this behavior with the variable @command{ede-auto-add-method}. -@node Customize Features, Project Local Variables, Add/Remove files, Modifying your project +@node Customize Features @section Customize Features A project, and its targets, are objects using the @samp{EIEIO} object @@ -561,7 +561,7 @@ object, you can edit the file by typing @kbd{C-c . e} (@code{ede-edit-file-target}). You should ``rescan'' the project afterwards (@pxref{Miscellaneous commands}). -@node Project Local Variables, EDE Project Features, Customize Features, Modifying your project +@node Project Local Variables @section Project Local Variables EDE projects can store and manager project local variables. The @@ -598,7 +598,7 @@ the format is an association list. For example: (compile-command . "make -f MyCustomMakefile all"))) @end example -@node EDE Project Features, , Project Local Variables, Modifying your project +@node EDE Project Features @section EDE Project Features This section details user facing features of an @ede{} @samp{Make} @@ -618,7 +618,7 @@ additional details. * Configurations:: @end menu -@node Changing Compilers and Flags, Configurations, EDE Project Features, EDE Project Features +@node Changing Compilers and Flags @subsection Changing Compilers and Flags Targets that build stuff need compilers. To change compilers, you @@ -638,7 +638,7 @@ see what commands are inserted. Once you have determined the variable you need to modify, you can add a configuration for it. @xref{Configurations}. -@node Configurations, , Changing Compilers and Flags, EDE Project Features +@node Configurations @subsection Configurations Configurations specify different ways to build a project. For @@ -658,7 +658,7 @@ block for ``configurations''. Add a new named configuration here. To switch between different active configurations, modify the ``configuration default'' slot. -@node Building and Debugging, Miscellaneous commands, Modifying your project, Top +@node Building and Debugging @chapter Building and Debugging @ede{} provides the following ``project-aware'' compilation and @@ -677,7 +677,7 @@ Build a distribution file for your project. These commands are also available from the @samp{Development} menu. -@node Miscellaneous commands, Extending EDE, Building and Debugging, Top +@node Miscellaneous commands @chapter Miscellaneous commands If you opt to go in and edit @ede{} project files directly---for @@ -716,7 +716,7 @@ To activate the speedbar in this mode, type @kbd{C-c . s} * Simple projects:: Projects @ede{} doesn't manage. @end menu -@node Make and Automake projects, Automake direct projects, Miscellaneous commands, Miscellaneous commands +@node Make and Automake projects @section Make and Automake projects A project of @samp{ede-project} type creates a file called @@ -728,7 +728,7 @@ in @samp{Makefile} mode, then this project will autogenerate a routines will also import and maintain a configure.am script and a host of other files required by Automake. -@node Automake direct projects, Simple projects, Make and Automake projects, Miscellaneous commands +@node Automake direct projects @section Automake direct projects The project type that reads @file{Makefile.am} directly is derived @@ -738,7 +738,7 @@ distributed independently. This mode eventually became @ede{}. The not generate them automatically, or create new ones. As such, it is useful as a browsing tool, or as maintenance in managing file lists. -@node Simple projects, , Automake direct projects, Miscellaneous commands +@node Simple projects @section Simple Projects There is a wide array of simple projects. In this case a simple @@ -756,7 +756,7 @@ belonging to a project, but doesn't provide many features of a typical * Custom Locate:: Customizing how to locate files in a simple project @end menu -@node ede-cpp-root, ede-emacs, Simple projects, Simple projects +@node ede-cpp-root @subsection ede-cpp-root The @code{ede-cpp-root} project type allows you to create a single @@ -897,7 +897,7 @@ of project. @xref{ede-cpp-root-project}, for details about the class that defines the @code{ede-cpp-root} project type. -@node ede-emacs, ede-linux, ede-cpp-root, Simple projects +@node ede-emacs @subsection ede-emacs The @code{ede-emacs} project automatically identifies an Emacs source @@ -906,7 +906,7 @@ tree, and enables EDE project mode for it. It pre-populates the C Preprocessor symbol map for correct parsing, and has an optimized include file identification function. -@node ede-linux, ede-generic-project, ede-emacs, Simple projects +@node ede-linux @subsection ede-linux The @code{ede-linux} project will automatically identify a Linux @@ -921,7 +921,7 @@ directory and its architecture, respectively. The default is to assume that the build happens in the source directory and to auto-detect the architecture; if the auto-detection fails, you will be asked. -@node ede-generic-project, Custom Locate, ede-linux, Simple projects +@node ede-generic-project @subsection ede-generic-project The @code{ede-generic-project} is a project system that makes it easy @@ -972,7 +972,7 @@ This example project will detect any directory with the file Customization of the project will allow you to make build and debug commands more precise. -@node Custom Locate, , ede-generic-project, Simple projects +@node Custom Locate @subsection Custom Locate The various simple project styles all have one major drawback, which @@ -1014,7 +1014,7 @@ simple example. More on idutils and cscope is in the CEDET manual, and they each have their own section. -@node Extending EDE, GNU Free Documentation License, Miscellaneous commands, Top +@node Extending EDE @chapter Extending @ede{} This chapter is intended for users who want to write new parts or fix @@ -1069,7 +1069,7 @@ examples. * Compilers:: Details of compiler classes. @end menu -@node Development Overview, Detecting a Project, Extending EDE, Extending EDE +@node Development Overview @section Development Overview @ede{} is made up of a series of classes implemented with @eieio{}. @@ -1161,7 +1161,7 @@ Here is a high-level UML diagram for the @ede{} system created with @cogre{}.. @end example -@node Detecting a Project, User interface methods, Development Overview, Extending EDE +@node Detecting a Project @section Detecting a Project Project detection happens with the list of @code{ede-project-autoload} @@ -1226,7 +1226,7 @@ to the global list of all projects. All subprojects are then created and assembled into the project data structures. -@node User interface methods, Base project methods, Detecting a Project, Extending EDE +@node User interface methods @section User interface methods These methods are core behaviors associated with user commands. @@ -1258,7 +1258,7 @@ Make a distribution (tar archive) of the project. Rescan a project file, changing the data in the existing objects. @end table -@node Base project methods, Sourcecode objects, User interface methods, Extending EDE +@node Base project methods @section Base project methods These methods are important for querying base information from project @@ -1296,7 +1296,7 @@ stored in. List all documentation a project or target is responsible for. @end table -@node Sourcecode objects, Compiler and Linker objects, Base project methods, Extending EDE +@node Sourcecode objects @section Sourcecode objects @ede{} projects track source file / target associates via source code @@ -1342,7 +1342,7 @@ In this case, the garbage pattern is the same. @xref{Sourcecode}. -@node Compiler and Linker objects, Project, Sourcecode objects, Extending EDE +@node Compiler and Linker objects @section Compiler and Linker objects In order for a target to create a @file{Makefile}, it must know how to @@ -1403,7 +1403,7 @@ See @file{ede-proj-obj.el} for examples of the combination. @defindex sc @defindex cm -@node Project, Targets, Compiler and Linker objects, Extending EDE +@node Project @section Project @menu @@ -1417,7 +1417,7 @@ See @file{ede-proj-obj.el} for examples of the combination. * ede-step-project:: @end menu -@node ede-project-placeholder, ede-project, Project, Project +@node ede-project-placeholder @subsection ede-project-placeholder @pjindex ede-project-placeholder @@ -1503,7 +1503,7 @@ Make sure placeholder @var{THIS} is replaced with the real thing, and pass throu Make sure placeholder @var{THIS} is replaced with the real thing, and pass through. @end deffn -@node ede-project, ede-cpp-root-project, ede-project-placeholder, Project +@node ede-project @subsection ede-project @pjindex ede-project @@ -1789,7 +1789,7 @@ Retrieves the slot @code{menu} from an object of class @code{ede-project} Commit change to local variables in @var{PROJ}. @end deffn -@node ede-cpp-root-project, ede-simple-project, ede-project, Project +@node ede-cpp-root-project @subsection ede-cpp-root-project @pjindex ede-cpp-root-project @@ -1911,7 +1911,7 @@ Within this project @var{PROJ}, find the file @var{NAME}. This knows details about or source tree. @end deffn -@node ede-simple-project, ede-simple-base-project, ede-cpp-root-project, Project +@node ede-simple-project @subsection ede-simple-project @pjindex ede-simple-project @@ -1941,7 +1941,7 @@ No children Commit any change to @var{PROJ} to its file. @end deffn -@node ede-simple-base-project, ede-proj-project, ede-simple-project, Project +@node ede-simple-base-project @subsection ede-simple-base-project @pjindex ede-simple-base-project @@ -1971,7 +1971,7 @@ This one project could control a tree of subdirectories. @table @asis @end table -@node ede-proj-project, project-am-makefile, ede-simple-base-project, Project +@node ede-proj-project @subsection ede-proj-project @pjindex ede-proj-project @@ -2161,7 +2161,7 @@ Return a list of files that constitutes a distribution of @var{THIS} project. Commit change to local variables in @var{PROJ}. @end deffn -@node project-am-makefile, ede-step-project, ede-proj-project, Project +@node project-am-makefile @subsection project-am-makefile @pjindex project-am-makefile @@ -2203,7 +2203,7 @@ Despite the fact that this is a method, it depends on the current buffer being in order to provide a smart default target type. @end deffn -@node ede-step-project, , project-am-makefile, Project +@node ede-step-project @subsection ede-step-project @pjindex ede-step-project @@ -2328,7 +2328,7 @@ Return a list of files that constitutes a distribution of @var{THIS} project. Commit change to local variables in @var{PROJ}. @end deffn -@node Targets, Sourcecode, Project, Extending EDE +@node Targets @section Targets @menu @@ -2356,7 +2356,7 @@ Commit change to local variables in @var{PROJ}. @end menu -@node ede-target, ede-proj-target, Targets, Targets +@node ede-target @subsection ede-target @tgindex ede-target @@ -2565,7 +2565,7 @@ Return the name of @var{THIS} target, suitable for make or debug style commands. Retrieves the slot @code{menu} from an object of class @code{ede-target} @end deffn -@node ede-proj-target, ede-proj-target-makefile, ede-target, Targets +@node ede-proj-target @subsection ede-proj-target @tgindex ede-proj-target @@ -2754,7 +2754,7 @@ sources variable. @end deffn -@node ede-proj-target-makefile, semantic-ede-proj-target-grammar, ede-proj-target, Targets +@node ede-proj-target-makefile @subsection ede-proj-target-makefile @tgindex ede-proj-target-makefile @@ -2852,7 +2852,7 @@ Return a list of configuration variables from @var{THIS}. Use @var{CONFIGURATION} as the current configuration to query. @end deffn -@node semantic-ede-proj-target-grammar, ede-proj-target-makefile-objectcode, ede-proj-target-makefile, Targets +@node semantic-ede-proj-target-grammar @subsection semantic-ede-proj-target-grammar @tgindex semantic-ede-proj-target-grammar @@ -2906,7 +2906,7 @@ Argument @var{THIS} is the target that should insert stuff. @end deffn -@node ede-proj-target-makefile-objectcode, ede-proj-target-makefile-archive, semantic-ede-proj-target-grammar, Targets +@node ede-proj-target-makefile-objectcode @subsection ede-proj-target-makefile-objectcode @tgindex ede-proj-target-makefile-objectcode @@ -2968,7 +2968,7 @@ Argument @var{THIS} is the target to get sources from. @end deffn -@node ede-proj-target-makefile-archive, ede-proj-target-makefile-program, ede-proj-target-makefile-objectcode, Targets +@node ede-proj-target-makefile-archive @subsection ede-proj-target-makefile-archive @tgindex ede-proj-target-makefile-archive @@ -3011,7 +3011,7 @@ Makefile.am generator, so use it to add this important bin program. @end deffn -@node ede-proj-target-makefile-program, ede-proj-target-makefile-shared-object, ede-proj-target-makefile-archive, Targets +@node ede-proj-target-makefile-program @subsection ede-proj-target-makefile-program @tgindex ede-proj-target-makefile-program @@ -3090,7 +3090,7 @@ Insert bin_PROGRAMS variables needed by target @var{THIS}. @end deffn -@node ede-proj-target-makefile-shared-object, ede-proj-target-elisp, ede-proj-target-makefile-program, Targets +@node ede-proj-target-makefile-shared-object @subsection ede-proj-target-makefile-shared-object @tgindex ede-proj-target-makefile-shared-object @@ -3150,7 +3150,7 @@ Makefile.am generator, so use it to add this important bin program. @end deffn -@node ede-proj-target-elisp, ede-proj-target-elisp-autoloads, ede-proj-target-makefile-shared-object, Targets +@node ede-proj-target-elisp @subsection ede-proj-target-elisp @tgindex ede-proj-target-elisp @@ -3226,7 +3226,7 @@ There are standards in Elisp files specifying how the version string is found, such as a @code{-version} variable, or the standard header. @end deffn -@node ede-proj-target-elisp-autoloads, ede-proj-target-makefile-miscelaneous, ede-proj-target-elisp, Targets +@node ede-proj-target-elisp-autoloads @subsection ede-proj-target-elisp-autoloads @tgindex ede-proj-target-elisp-autoloads @@ -3341,7 +3341,7 @@ sources variable. @end deffn -@node ede-proj-target-makefile-miscelaneous, ede-proj-target-makefile-info, ede-proj-target-elisp-autoloads, Targets +@node ede-proj-target-makefile-miscelaneous @subsection ede-proj-target-makefile-miscelaneous @tgindex ede-proj-target-makefile-miscelaneous @@ -3397,7 +3397,7 @@ Return a list of files which @var{THIS} target depends on. @end deffn -@node ede-proj-target-makefile-info, ede-proj-target-scheme, ede-proj-target-makefile-miscelaneous, Targets +@node ede-proj-target-makefile-info @subsection ede-proj-target-makefile-info @tgindex ede-proj-target-makefile-info @@ -3483,7 +3483,7 @@ Does the usual for Makefile mode, but splits source into two variables when working in Automake mode. @end deffn -@node ede-proj-target-scheme, project-am-target, ede-proj-target-makefile-info, Targets +@node ede-proj-target-scheme @subsection ede-proj-target-scheme @tgindex ede-proj-target-scheme @@ -3527,7 +3527,7 @@ Tweak the configure file (current buffer) to accommodate @var{THIS}. @end deffn -@node project-am-target, project-am-objectcode, ede-proj-target-scheme, Targets +@node project-am-target @subsection project-am-target @tgindex project-am-target @@ -3565,7 +3565,7 @@ Run the current project in the debugger. Edit the target associated w/ this file. @end deffn -@node project-am-objectcode, project-am-program, project-am-target, Targets +@node project-am-objectcode @subsection project-am-objectcode @tgindex project-am-objectcode @@ -3610,7 +3610,7 @@ Default target to use when compiling an object code target. There are no default header files. @end deffn -@node project-am-program, project-am-header-noinst, project-am-objectcode, Targets +@node project-am-program @subsection project-am-program @tgindex project-am-program @@ -3648,7 +3648,7 @@ Additional LD args. @end table @end table -@node project-am-header-noinst, project-am-header-inst, project-am-program, Targets +@node project-am-header-noinst @subsection project-am-header-noinst @tgindex project-am-header-noinst @@ -3681,7 +3681,7 @@ No children Return the default macro to 'edit' for this object. @end deffn -@node project-am-header-inst, project-am-lisp, project-am-header-noinst, Targets +@node project-am-header-inst @subsection project-am-header-inst @tgindex project-am-header-inst @@ -3714,7 +3714,7 @@ No children Return the default macro to 'edit' for this object. @end deffn -@node project-am-lisp, project-am-texinfo, project-am-header-inst, Targets +@node project-am-lisp @subsection project-am-lisp @tgindex project-am-lisp @@ -3744,7 +3744,7 @@ No children Return the default macro to 'edit' for this object. @end deffn -@node project-am-texinfo, project-am-man, project-am-lisp, Targets +@node project-am-texinfo @subsection project-am-texinfo @tgindex project-am-texinfo @@ -3795,7 +3795,7 @@ Documentation is not for object @var{THIS}, but is provided by @var{THIS} for ot files in the project. @end deffn -@node project-am-man, , project-am-texinfo, Targets +@node project-am-man @comment node-name, next, previous, up @subsection project-am-man @tgindex project-am-man @@ -3826,7 +3826,7 @@ No children Return the default macro to 'edit' for this object type. @end deffn -@node Sourcecode, Compilers, Targets, Extending EDE +@node Sourcecode @section Sourcecode The source code type is an object designed to associated files with @@ -3837,7 +3837,7 @@ targets. @end menu -@node ede-sourcecode, , Sourcecode, Sourcecode +@node ede-sourcecode @subsection ede-sourcecode @scindex ede-sourcecode @@ -3934,7 +3934,7 @@ Return non-@code{nil} if @var{THIS} will take @var{FILENAME} as an auxiliary . Return non-@code{nil} if @var{THIS} will take @var{FILENAME} as an auxiliary . @end deffn -@node Compilers, , Sourcecode, Extending EDE +@node Compilers @section Compilers The compiler object is designed to associate source code with @@ -3950,7 +3950,7 @@ compile commands. @end menu -@node ede-compilation-program, ede-compiler, Compilers, Compilers +@node ede-compilation-program @subsection ede-compilation-program @cmindex ede-compilation-program @@ -4061,7 +4061,7 @@ Tweak the configure file (current buffer) to accommodate @var{THIS}. @end deffn -@node ede-compiler, ede-object-compiler, ede-compilation-program, Compilers +@node ede-compiler @subsection ede-compiler @cmindex ede-compiler @@ -4169,7 +4169,7 @@ Return a string based on @var{THIS} representing a make object variable. @end deffn -@node ede-object-compiler, ede-linker, ede-compiler, Compilers +@node ede-object-compiler @subsection ede-object-compiler @cmindex ede-object-compiler @@ -4212,7 +4212,7 @@ A variable dedicated to dependency generation. Insert variables needed by the compiler @var{THIS}. @end deffn -@node ede-linker, , ede-object-compiler, Compilers +@node ede-linker @subsection ede-linker @cmindex ede-linker @@ -4274,7 +4274,7 @@ For example, C code uses .o on unix, and Emacs Lisp uses .elc. @end table @end table -@node GNU Free Documentation License, , Extending EDE, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi diff --git a/doc/misc/efaq-w32.texi b/doc/misc/efaq-w32.texi index 2abde2c2843..6eff88b76e3 100644 --- a/doc/misc/efaq-w32.texi +++ b/doc/misc/efaq-w32.texi @@ -370,11 +370,10 @@ On Windows, the @file{.emacs} file may be called @file{_emacs} for backward compatibility with DOS and FAT filesystems where filenames could not start with a dot. Some users prefer to continue using such a name due to historical problems various Windows tools had in the -past with file names that begin with a dot. In Emacs 22 and later, -the init file may also be called @file{.emacs.d/init.el}. Many of the -other files that are created by lisp packages are now stored in the -@file{.emacs.d} directory too, so this keeps all your Emacs related -files in one place. +past with file names that begin with a dot. The init file may also be +called @file{.emacs.d/init.el}. Many of the other files that are +created by Lisp packages are stored in the @file{.emacs.d} directory +too, which keeps all your Emacs related files in one place. All the files mentioned above should go in your @env{HOME} directory. The @env{HOME} directory is determined by following the steps below: diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi index f26ae637788..d66c12f9fc3 100644 --- a/doc/misc/efaq.texi +++ b/doc/misc/efaq.texi @@ -323,8 +323,8 @@ Free Software Foundation, and related organizations. @menu * Real meaning of copyleft:: -* Guidelines for newsgroup postings:: -* Newsgroup archives:: +* Guidelines for mailing list postings:: +* Mailing list archives:: * Reporting bugs:: * Unsubscribing from Emacs lists:: * Contacting the FSF:: @@ -343,9 +343,10 @@ There has never been a copyright infringement case involving the GPL to set any precedents. Although legal actions have been brought against companies for violating the terms of the GPL, so far all have been settled out of court (in favor of the plaintiffs). Please take any -discussion regarding this issue to the newsgroup -@uref{news:gnu.misc.discuss}, which was created to hold the extensive -flame wars on the subject. +discussion regarding this issue to +@uref{https://lists.gnu.org/mailman/listinfo/gnu-misc-discuss, the +gnu-misc-discuss mailing list}, which was created to hold the +extensive flame wars on the subject. RMS writes: @@ -359,49 +360,60 @@ distribute any version of Emacs or a related program, and give the recipients the same freedom that you enjoyed. @end quotation -@node Guidelines for newsgroup postings -@section What are appropriate messages for the various Emacs newsgroups? +@node Guidelines for mailing list postings +@section What are appropriate messages for the various Emacs mailing lists? @cindex Newsgroups, appropriate messages for @cindex GNU newsgroups, appropriate messages for +@cindex GNU mailing lists, appropriate messages for @cindex Usenet groups, appropriate messages for @cindex Mailing lists, appropriate messages for -@cindex Posting messages to newsgroups +@cindex Posting messages to mailing lists @cindex GNU mailing lists The Emacs mailing lists are described at @uref{https://savannah.gnu.org/mail/?group=emacs, the Emacs Savannah -page}. Some of them are gatewayed to newsgroups. - -The newsgroup @uref{news:comp.emacs} is for discussion of Emacs programs -in general. The newsgroup @uref{news:gnu.emacs.help} is specifically -for GNU Emacs. It therefore makes no sense to cross-post to both -groups, since only one can be appropriate to any question. - -Messages advocating ``non-free'' software are considered unacceptable on -any of the @code{gnu.*} newsgroups except for @uref{news:gnu.misc.discuss}, -which was created to hold the extensive flame-wars on the subject. -``Non-free'' software includes any software for which the end user can't -freely modify the source code and exchange enhancements. Be careful to -remove the @code{gnu.*} groups from the @samp{Newsgroups:} line when -posting a followup that recommends such software. - -@uref{news:gnu.emacs.bug} is a place where bug reports appear, but avoid -posting bug reports to this newsgroup directly (@pxref{Reporting bugs}). - -@node Newsgroup archives -@section Where can I get old postings to @uref{news:gnu.emacs.help} and other GNU groups? -@cindex Archived postings from @code{gnu.emacs.help} -@cindex Usenet archives for GNU groups -@cindex Old Usenet postings for GNU groups +page}. + +Messages advocating ``non-free'' software are considered unacceptable +on any of the GNU mailing lists, except for +@url{https://lists.gnu.org/mailman/listinfo/gnu-misc-discuss, the +gnu-misc-discuss mailing list} which was created to hold the extensive +flame-wars on the subject. + +``Non-free'' software includes any software for which the end user +can't freely modify the source code and exchange enhancements. Be +careful to remove any GNU mailing lists from @samp{Cc:} when posting a +reply that recommends such software. + +@url{https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, The +bug-gnu-emacs list} is a place where bug reports appear, but we +recommend using the commands @kbd{M-x report-emacs-bug} or @kbd{M-x +submit-emacs-patch} if at all possible (@pxref{Reporting bugs}). + +Some GNU mailing lists are gatewayed to (Usenet) newsgroups. +For example, sending an email to +@url{https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, The +bug-gnu-emacs list} has the effect of posting on the newsgroup +@uref{news:gnu.emacs.help}). + +Finally, we recommend reading the +@url{https://www.gnu.org/philosophy/kind-communication.html, GNU Kind +Communications Guidelines} before posting to any GNU lists or +newsgroups. + +@node Mailing list archives +@section Where can I read archives for @code{help-gnu-emacs} and other GNU lists? +@cindex Archived postings from @code{help-gnu-emacs} +@cindex Old mailing list posts for GNU lists +@cindex Mailing list archives for GNU lists The FSF has maintained archives of all of the GNU mailing lists for many years, although there may be some unintentional gaps in coverage. The archive can be browsed over the web at @uref{https://lists.gnu.org/r/, the GNU mail archive}. -Web-based Usenet search services, such as -@uref{https://groups.google.com/groups/dir?q=gnu&, Google}, also -archive the @code{gnu.*} groups. +Some web-based Usenet search services also archive the @code{gnu.*} +newsgroups. @node Reporting bugs @section Where should I report bugs and other problems with Emacs? @@ -414,39 +426,25 @@ The correct way to report Emacs bugs is to use the command @kbd{M-x report-emacs-bug}. It sets up a mail buffer with the essential information and the correct e-mail address, @email{bug-gnu-emacs@@gnu.org}. -Anything sent there also appears in the -newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of -news to submit the bug report. This ensures a reliable return address -so you can be contacted for further details. Be sure to read the ``Bugs'' section of the Emacs manual before reporting a bug! The manual describes in detail how to submit a useful bug report (@pxref{Bugs, , Reporting Bugs, emacs, The GNU Emacs Manual}). (@xref{Emacs manual}, if you don't know how to read the manual.) -RMS says: - -@quotation Sending bug reports to -@url{https://lists.gnu.org/mailman/listinfo/help-gnu-emacs, -the help-gnu-emacs mailing list} -(which has the effect of posting on @uref{news:gnu.emacs.help}) is -undesirable because it takes the time of an unnecessarily large group -of people, most of whom are just users and have no idea how to fix -these problem. -@url{https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, The -bug-gnu-emacs list} reaches a much smaller group of people who are +@url{https://lists.gnu.org/mailman/listinfo/help-gnu-emacs, the +help-gnu-emacs mailing list} is undesirable because it takes the time +of an unnecessarily large group of people, most of whom are just users +and have no idea how to fix these +problem. @url{https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs, +The bug-gnu-emacs list} reaches a much smaller group of people who are more likely to know what to do and have expressed a wish to receive more messages about Emacs than the others. -@end quotation - -RMS says it is sometimes fine to post to @uref{news:gnu.emacs.help}: -@quotation If you have reported a bug and you don't hear about a possible fix, then after a suitable delay (such as a week) it is okay to post on -@code{gnu.emacs.help} asking if anyone can help you. -@end quotation +@code{help-gnu-emacs@@gnu.org} asking if anyone can help you. If you are unsure whether you have found a bug, consider the following non-exhaustive list, courtesy of RMS: @@ -458,6 +456,11 @@ is a bug. If Lisp code does not do what the documentation says it does, that is a bug. @end quotation +Anything sent to @email{bug-gnu-emacs@@gnu.org} also appears in the +newsgroup @uref{news:gnu.emacs.bug}, but please use e-mail instead of +news to submit the bug report. This ensures a reliable return address +so you can be contacted for further details. + @node Unsubscribing from Emacs lists @section How do I unsubscribe from a mailing list? @cindex Unsubscribing from GNU mailing lists @@ -1516,6 +1519,7 @@ of files from Macintosh, Microsoft, and Unix platforms. * Documentation for etags:: * Disabling backups:: * Disabling auto-save-mode:: +* Not writing files to the current directory:: * Going to a line by number:: * Modifying pull-down menus:: * Deleting menus and menu options:: @@ -2617,6 +2621,39 @@ such as @file{/tmp}. To disable or change how @code{auto-save-mode} works, @pxref{Auto Save,,, emacs, The GNU Emacs Manual}. +@node Not writing files to the current directory +@section Making Emacs write all auxiliary files somewhere else +@cindex Writing all auxiliary files to the same directory + +By default, Emacs may create many new files in the directory where +you're editing a file. If you're editing the file +@file{/home/user/foo.txt}, Emacs will create the lock file +@file{/home/user/.#foo.txt}, the auto-save file +@file{/home/user/#foo.txt#}, and when you save the file, Emacs will +create the backup file @file{/home/user/foo.txt~}. (The first two +files are deleted when you save the file.) + +This may be inconvenient in some setups, so Emacs has mechanisms for +changing the locations of all these files. + +@table @code +@item auto-save-file-name-transforms (@pxref{Auto-Saving,,,elisp, GNU Emacs Lisp Reference Manual}). +@item lock-file-name-transforms (@pxref{File Locks,,,elisp, GNU Emacs Lisp Reference Manual}). +@item backup-directory-alist (@pxref{Making Backups,,,elisp, GNU Emacs Lisp Reference Manual}). +@end table + +For instance, to write all these things to +@file{~/.emacs.d/aux/}: + +@lisp +(setq lock-file-name-transforms + '(("\\`/.*/\\([^/]+\\)\\'" "~/.emacs.d/aux/\\1" t))) +(setq auto-save-file-name-transforms + '(("\\`/.*/\\([^/]+\\)\\'" "~/.emacs.d/aux/\\1" t))) +(setq backup-directory-alist + '((".*" . "~/.emacs.d/aux/"))) +@end lisp + @node Going to a line by number @section How can I go to a certain line given its number? @cindex Going to a line by number @@ -3526,10 +3563,8 @@ installing any nonfree software, we recommend for your freedom's sake that you stay away from it. The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources, -GNU Emacs sources mailing list}, which is gatewayed to the -@uref{news:gnu.emacs.sources, Emacs sources newsgroup} (although the -connection between the two can be unreliable) is an official place -where people can post or announce their extensions to Emacs. +GNU Emacs sources mailing list} is an official place where people can +post or announce their extensions to Emacs. The @uref{https://emacswiki.org, Emacs Wiki} contains pointers to some additional extensions. @uref{https://wikemacs.org, WikEmacs} is an diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index 4952e909902..63b42827311 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi @@ -115,10 +115,10 @@ Each class can have methods, which are defined like this: (cl-defmethod call-person ((pers person) &optional scriptname) "Dial the phone for the person PERS. Execute the program SCRIPTNAME to dial the phone." - (message "Dialing the phone for %s" (oref pers name)) + (message "Dialing the phone for %s" (slot-value pers 'name)) (shell-command (concat (or scriptname "dialphone.sh") " " - (oref pers phone)))) + (slot-value pers 'phone)))) @end example @noindent @@ -693,16 +693,43 @@ for each slot. For example: @node Accessing Slots @chapter Accessing Slots -There are several ways to access slot values in an object. The naming -and argument-order conventions are similar to those used for -referencing vectors (@pxref{Vectors,,,elisp,GNU Emacs Lisp Reference -Manual}). +There are several ways to access slot values in an object. +The following accessors are defined by CLOS to reference or modify +slot values, and use the previously mentioned set/ref routines. + +@defun slot-value object slot +@anchor{slot-value} +This function retrieves the value of @var{slot} from @var{object}. + +This is a generalized variable that can be used with @code{setf} to +modify the value stored in @var{slot}. @xref{Generalized +Variables,,,elisp,GNU Emacs Lisp Reference Manual}. +@end defun + +@defun set-slot-value object slot value +@anchor{set-slot-value} +This function sets the value of @var{slot} from @var{object}. + +This is not a CLOS function, but is the obsolete setter for +@code{slot-value} used by the @code{setf} macro. It is therefore +recommended to use @w{@code{(setf (slot-value @var{object} @var{slot}) +@var{value})}} instead. +@end defun + +@defun slot-makeunbound object slot +This function unbinds @var{slot} in @var{object}. Referencing an +unbound slot can signal an error. +@end defun + +The following accessors follow a naming and argument-order conventions +are similar to those used for referencing vectors +(@pxref{Vectors,,,elisp,GNU Emacs Lisp Reference Manual}). @defmac oref obj slot @anchor{oref} This macro retrieves the value stored in @var{obj} in the named -@var{slot}. Slot names are determined by @code{defclass} which -creates the slot. +@var{slot}. Unlike @code{slot-value}, the symbol for @var{slot} must +not be quoted. This is a generalized variable that can be used with @code{setf} to modify the value stored in @var{slot}. @xref{Generalized @@ -737,35 +764,6 @@ changed, this can be arranged by simply executing this bit of code: @end example @end defmac -The following accessors are defined by CLOS to reference or modify -slot values, and use the previously mentioned set/ref routines. - -@defun slot-value object slot -@anchor{slot-value} -This function retrieves the value of @var{slot} from @var{object}. -Unlike @code{oref}, the symbol for @var{slot} must be quoted. - -This is a generalized variable that can be used with @code{setf} to -modify the value stored in @var{slot}. @xref{Generalized -Variables,,,elisp,GNU Emacs Lisp Reference Manual}. -@end defun - -@defun set-slot-value object slot value -@anchor{set-slot-value} -This function sets the value of @var{slot} from @var{object}. Unlike -@code{oset}, the symbol for @var{slot} must be quoted. - -This is not a CLOS function, but is the obsolete setter for -@code{slot-value} used by the @code{setf} macro. It is therefore -recommended to use @w{@code{(setf (slot-value @var{object} @var{slot}) -@var{value})}} instead. -@end defun - -@defun slot-makeunbound object slot -This function unbinds @var{slot} in @var{object}. Referencing an -unbound slot can signal an error. -@end defun - @defun object-add-to-list object slot item &optional append @anchor{object-add-to-list} In OBJECT's @var{slot}, add @var{item} to the list of elements. @@ -807,7 +805,7 @@ Where each @var{var} is the local variable given to the associated variable name of the same name as the slot. @example -(defclass myclass () (x :initform 1)) +(defclass myclass () ((x :initform 1))) (setq mc (make-instance 'myclass)) (with-slots (x) mc x) => 1 (with-slots ((something x)) mc something) => 1 @@ -981,8 +979,8 @@ the @code{subclass} specializer with @code{cl-defmethod}: new)) @end example -The first argument of a static method will be a class rather than an -object. Use the functions @code{oref-default} or @code{oset-default} which +The argument of a static method will be a class rather than an object. +Use the functions @code{oref-default} or @code{oset-default} which will work on a class. A class's @code{make-instance} method is defined as a static @@ -1238,12 +1236,6 @@ of CLOS. Return the list of public slots for @var{obj}. @end defun -@defun class-slot-initarg class slot -For the given @var{class} return an :initarg associated with -@var{slot}. Not all slots have initargs, so the return value can be -@code{nil}. -@end defun - @node Base Classes @chapter Base Classes @@ -1656,8 +1648,8 @@ Method invoked when an attempt to access a slot in @var{object} fails. that was requested, and optional @var{new-value} is the value that was desired to be set. -This method is called from @code{oref}, @code{oset}, and other functions which -directly reference slots in EIEIO objects. +This method is called from @code{slot-value}, @code{set-slot-value}, +and other functions which directly reference slots in EIEIO objects. The default method signals an error of type @code{invalid-slot-name}. @xref{Signals}. diff --git a/doc/misc/emacs-mime.texi b/doc/misc/emacs-mime.texi index 0cf5ba96506..7cd3e5f5828 100644 --- a/doc/misc/emacs-mime.texi +++ b/doc/misc/emacs-mime.texi @@ -1870,6 +1870,11 @@ A customizable list of viewers that take preference over Interface functions: @table @code +@item mailcap-view-file +@findex mailcap-view-file +Prompt for a file name, and start a viewer applicable for the file +type in question. + @item mailcap-parse-mailcaps @findex mailcap-parse-mailcaps @vindex mailcap-prefer-mailcap-viewers diff --git a/doc/misc/epa.texi b/doc/misc/epa.texi index cca0d300fa7..e777771cf73 100644 --- a/doc/misc/epa.texi +++ b/doc/misc/epa.texi @@ -42,7 +42,7 @@ modify this GNU manual.'' @contents -@node Top, Overview, (dir), (dir) +@node Top @top EasyPG Assistant user's manual EasyPG Assistant is an Emacs user interface to GNU Privacy Guard @@ -60,8 +60,8 @@ called EasyPG Library. * Overview:: * Quick start:: * Commands:: -* Caching Passphrases:: * GnuPG version compatibility:: +* Caching Passphrases:: * Bug Reports:: * GNU Free Documentation License:: The license for this documentation. * Key Index:: @@ -69,7 +69,7 @@ called EasyPG Library. * Variable Index:: @end menu -@node Overview, Quick start, Top, Top +@node Overview @chapter Overview EasyPG Assistant provides the following features. @@ -83,7 +83,7 @@ EasyPG Assistant provides the following features. @item Automatic encryption/decryption of *.gpg files. @end itemize -@node Quick start, Commands, Overview, Top +@node Quick start @chapter Quick start EasyPG Assistant commands are prefixed by @samp{epa-}. For example, @@ -94,13 +94,15 @@ EasyPG Assistant commands are prefixed by @samp{epa-}. For example, @item To create a cleartext signature of the region, type @kbd{M-x epa-sign-region} @item To encrypt a file, type @kbd{M-x epa-encrypt-file} + +@item To query a key server for keys, type @kbd{M-x epa-search-keys} @end itemize EasyPG Assistant provides several cryptographic features which can be integrated into other Emacs functionalities. For example, automatic encryption/decryption of @file{*.gpg} files. -@node Commands, GnuPG version compatibility, Quick start, Top +@node Commands @chapter Commands This chapter introduces various commands for typical use cases. @@ -112,9 +114,10 @@ This chapter introduces various commands for typical use cases. * Dired integration:: * Mail-mode integration:: * Encrypting/decrypting gpg files:: +* Querying a key server:: @end menu -@node Key management, Cryptographic operations on regions, Commands, Commands +@node Key management @section Key management Probably the first step of using EasyPG Assistant is to browse your keyring. @kbd{M-x epa-list-keys} is corresponding to @samp{gpg @@ -197,7 +200,7 @@ Delete selected keys. If @var{allow-secret} is non-@code{nil}, it also delete the secret keys. @end deffn -@node Cryptographic operations on regions, Cryptographic operations on files, Key management, Commands +@node Cryptographic operations on regions @section Cryptographic operations on regions @deffn Command epa-decrypt-region start end @@ -242,7 +245,7 @@ also ask you whether or not to sign the text before encryption and if you answered yes, it will let you select the signing keys. @end deffn -@node Cryptographic operations on files, Dired integration, Cryptographic operations on regions, Commands +@node Cryptographic operations on files @section Cryptographic operations on files @deffn Command epa-decrypt-file file &optional output @@ -263,7 +266,7 @@ select signing keys, and then a signature type. Encrypt @var{file}. It will let you select recipients. @end deffn -@node Dired integration, Mail-mode integration, Cryptographic operations on files, Commands +@node Dired integration @section Dired integration EasyPG Assistant extends Dired Mode for GNU Emacs to allow users to @@ -302,7 +305,7 @@ Encrypt marked files. @end table -@node Mail-mode integration, Encrypting/decrypting gpg files, Dired integration, Commands +@node Mail-mode integration @section Mail-mode integration EasyPG Assistant provides a minor mode @code{epa-mail-mode} to help @@ -357,7 +360,7 @@ With prefix argument, asks you to select the recipients interactively, whether to sign, and which key(s) to sign with. @end table -@node Encrypting/decrypting gpg files, , Mail-mode integration, Commands +@node Encrypting/decrypting gpg files @section Encrypting/decrypting gpg files By default, every file whose name ends with @file{.gpg} will be treated as encrypted. That is, when you open such a file, the @@ -440,7 +443,22 @@ If non-@code{nil}, disable auto-saving when opening an encrypted file. The default value is @code{t}. @end defvar -@node GnuPG version compatibility, Caching Passphrases, Commands, Top +@node Querying a key server +@section Querying a key server + +The @code{epa-search-keys} command can be used to query a +@acronym{GPG} key server. Emacs will then pop up a buffer that lists +the matches, and you can then fetch (and add) keys to your personal +key ring. + +In the key search buffer, you can use the @kbd{f} command to mark keys +for fetching, and then @kbd{x} to fetch the keys (and incorporate them +into your key ring). + +The @code{epa-keyserver} variable says which server to query. + + +@node GnuPG version compatibility @chapter GnuPG version compatibility As of February 2016, there are three active branches of GnuPG: 2.1, @@ -472,7 +490,7 @@ specifically, with 2.0 (as of 2.0.29), there is no way to avoid the graphical prompt. @end itemize -@node Caching Passphrases, Bug Reports, GnuPG version compatibility, Top +@node Caching Passphrases @chapter Caching Passphrases Typing passphrases is a troublesome task if you frequently open and @@ -512,7 +530,7 @@ To set up elisp passphrase cache, set @code{epa-file-cache-passphrase-for-symmetric-encryption}. @xref{Encrypting/decrypting gpg files}. -@node Bug Reports, GNU Free Documentation License, Caching Passphrases, Top +@node Bug Reports @chapter Bug Reports Bugs and problems with EasyPG Assistant are actively worked on by the @@ -534,19 +552,19 @@ Before reporting the bug, you should set @code{epg-debug} in the of the @file{ *epg-debug*} buffer. Note that the first letter of the buffer name is a whitespace. -@node GNU Free Documentation License, Key Index, Bug Reports, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi -@node Key Index, Function Index, GNU Free Documentation License, Top +@node Key Index @unnumbered Key Index @printindex ky -@node Function Index, Variable Index, Key Index, Top +@node Function Index @unnumbered Function Index @printindex fn -@node Variable Index, , Function Index, Top +@node Variable Index @unnumbered Variable Index @printindex vr diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index d635cac5abb..10ced678e1d 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -131,21 +131,30 @@ customize-variable @key{RET} erc-modules @key{RET}}. @node Sample Session @section Sample Session -This is an example ERC session which shows how to connect to the #emacs -channel on Freenode. Another IRC channel on Freenode that may be of -interest is #erc, which is a channel where ERC users and developers hang -out. +This is an example ERC session which shows how to connect to the +#emacs channel on Libera.Chat. Another IRC channel on Libera.Chat +that may be of interest is #erc, which is a channel where ERC users +and developers hang out. These channels used to live on the Freenode +IRC network until June 2021, when they---along with the official IRC +channels of the GNU Project, the Free Software Foundation, and many +other free software communities---relocated to the Libera.Chat network +in the aftermath of changes in governance and policies of Freenode in +May and June 2021. GNU and FSF's announcements about this are at +@uref{https://lists.gnu.org/archive/html/info-gnu/2021-06/msg00005.html}, +@uref{https://lists.gnu.org/archive/html/info-gnu/2021-06/msg00007.html}, +and +@uref{https://lists.gnu.org/archive/html/info-gnu-emacs/2021-06/msg00000.html}. @itemize @bullet -@item Connect to Freenode +@item Connect to Libera.Chat -Run @kbd{M-x erc}. Use ``chat.freenode.net'' as the IRC server, -``6667'' as the port, and choose a nickname. +Run @kbd{M-x erc}. Use ``irc.libera.chat as the IRC server, ``6667'' +as the port, and choose a nickname. @item Get used to the interface -Switch to the ``chat.freenode.net:6667'' buffer, if you're not already +Switch to the ``irc.libera.chat:6667'' buffer, if you're not already there. You will see first some messages about checking for ident, and then a bunch of other messages that describe the current IRC server. @@ -158,13 +167,13 @@ background. If the latter, switch to the ``#emacs'' buffer. You will see the channel topic and a list of the people who are currently on the channel. -@item Register your nickname with Freenode +@item Register your nickname with Libera.Chat If you would like to be able to talk with people privately on the -Freenode network, you will have to ``register'' your nickname. To do -so, switch to the ``chat.freenode.net:6667'' buffer and type ``/msg -NickServ register <password>'', replacing ``<password>'' with your -desired password. It should tell you that the operation was +Libera.Chat network, you will have to ``register'' your nickname. +To do so, switch to the ``irc.libera.chat:6667'' buffer and type +``/msg NickServ register <password>'', replacing ``<password>'' with +your desired password. It should tell you that the operation was successful. @item Talk to people in the channel @@ -514,15 +523,85 @@ Non-interactively, it takes the following keyword arguments. That is, if called with the following arguments, @var{server} and @var{full-name} will be set to those values, whereas -@code{erc-compute-port}, @code{erc-compute-nick} and -@code{erc-compute-full-name} will be invoked for the values of the other -parameters. +@code{erc-compute-port} and @code{erc-compute-nick} will be invoked +for the values of the other parameters. @example -(erc :server "chat.freenode.net" :full-name "Harry S Truman") +(erc :server "irc.libera.chat" :full-name "J. Random Hacker") @end example @end defun +To connect securely over an encrypted TLS connection, use @kbd{M-x +erc-tls}. + +@defun erc-tls +Select connection parameters and run ERC over TLS@. +Non-interactively, it takes the following keyword arguments. + +@itemize @bullet +@item @var{server} +@item @var{port} +@item @var{nick} +@item @var{password} +@item @var{full-name} +@item @var{client-certificate} +@end itemize + +That is, if called with the following arguments, @var{server} and +@var{full-name} will be set to those values, whereas +@code{erc-compute-port} and @code{erc-compute-nick} will be invoked +for the values of the other parameters, and @code{client-certificate} +will be @code{nil}. + +@example +(erc-tls :server "irc.libera.chat" :full-name "J. Random Hacker") +@end example + +To use a certificate with @code{erc-tls}, specify the optional +@var{client-certificate} keyword argument, whose value should be as +described in the documentation of @code{open-network-stream}: if +non-@code{nil}, it should either be a list where the first element is +the file name of the private key corresponding to a client certificate +and the second element is the file name of the client certificate +itself to use when connecting over TLS, or @code{t}, which means that +@code{auth-source} will be queried for the private key and the +certificate. Authenticating using a TLS client certificate is also +referred to as ``CertFP'' (Certificate Fingerprint) authentication by +various IRC networks. + +Examples of use: + +@example +(erc-tls :server "irc.libera.chat" :port 6697 + :client-certificate + '("/home/bandali/my-cert.key" + "/home/bandali/my-cert.crt")) +@end example + +@example +(erc-tls :server "irc.libera.chat" :port 6697 + :client-certificate + `(,(expand-file-name "~/cert-libera.key") + ,(expand-file-name "~/cert-libera.crt"))) +@end example + +@example +(erc-tls :server "irc.libera.chat" :port 6697 + :client-certificate t) +@end example + +In the case of @code{:client-certificate t}, you will need to add a +line like the following to your authinfo file +(e.g. @file{~/.authinfo.gpg}): + +@example +machine irc.libera.chat key /home/bandali/my-cert.key cert /home/bandali/my-cert.crt +@end example + +@xref{Help for users,,,auth, Emacs auth-source Library}, for more on the +@file{.authinfo}/@file{.netrc} backend of @code{auth-source}. +@end defun + @subheading Server @defun erc-compute-server &optional server @@ -692,11 +771,10 @@ stuff, to the current ERC buffer." (erc-send-message (concat "@{Uptime@} [" uname-output "]")))) -;; This causes ERC to connect to the Freenode network upon hitting +;; This causes ERC to connect to the Libera.Chat network upon hitting ;; C-c e f. Replace MYNICK with your IRC nick. (global-set-key "\C-cef" (lambda () (interactive) - (erc :server "chat.freenode.net" - :port "6667" + (erc :server "irc.libera.chat" :port "6667" :nick "MYNICK"))) ;; This causes ERC to connect to the IRC server on your own machine (if @@ -716,13 +794,15 @@ stuff, to the current ERC buffer." ;;; Options -;; Join the #emacs and #erc channels whenever connecting to Freenode. -(setq erc-autojoin-channels-alist '(("freenode.net" "#emacs" "#erc"))) +;; Join the #emacs and #erc channels whenever connecting to +;; Libera.Chat. +(setq erc-autojoin-channels-alist + '(("Libera.Chat" "#emacs" "#erc"))) ;; Rename server buffers to reflect the current network name instead -;; of SERVER:PORT (e.g., "freenode" instead of "chat.freenode.net:6667"). -;; This is useful when using a bouncer like ZNC where you have multiple -;; connections to the same server. +;; of SERVER:PORT (e.g., "Libera.Chat" instead of +;; "irc.libera.chat:6667"). This is useful when using a bouncer like +;; ZNC where you have multiple connections to the same server. (setq erc-rename-buffers t) ;; Interpret mIRC-style color commands in IRC chats @@ -762,7 +842,7 @@ If non, @code{nil}, this is a list of IRC networks and message types to hide, e.g.: @example -(setq erc-network-hide-list (("freenode" "JOIN" "PART" "QUIT") +(setq erc-network-hide-list (("Libera.Chat" "JOIN" "PART" "QUIT") ("OFTC" "JOIN" "PART"")) @end example @end defopt @@ -811,7 +891,7 @@ You can ask questions about using ERC on the Emacs mailing list, @uref{https://lists.gnu.org/mailman/listinfo/help-gnu-emacs}. @item -You can visit the IRC Freenode channel @samp{#emacs}. Many of the +You can visit the IRC Libera.Chat channel @samp{#emacs}. Many of the contributors are frequently around and willing to answer your questions. diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi index a4e2cb506a3..fafdb8c4eb4 100644 --- a/doc/misc/ert.texi +++ b/doc/misc/ert.texi @@ -347,6 +347,10 @@ emacs -batch -l ert -l my-tests.el \ -eval '(ert-run-tests-batch-and-exit "to-match")' @end example +By default, ERT test failure summaries are quite brief in batch +mode--only the names of the failed tests are listed. If the +EMACS_TEST_VERBOSE environment variable is set, the failure summaries +will also include the data from the failing test. @node Test Selectors @section Test Selectors diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi index e106f39cdd9..fc2e3f3b111 100644 --- a/doc/misc/eshell.texi +++ b/doc/misc/eshell.texi @@ -515,8 +515,8 @@ below the @code{completion-cycle-threshold}), press @kbd{M-?}. @subsection pcomplete Pcomplete, short for programmable completion, is the completion library originally written for Eshell, but usable for command -completion@footnote{Command completion as opposed to code completion, -which is a beyond the scope of pcomplete.} in other modes. +completion@footnote{Command completion, as opposed to code completion, +which is beyond the scope of pcomplete.} in other modes. Completions are defined as functions (with @code{defun}) named @code{pcomplete/COMMAND}, where @code{COMMAND} is the name of the diff --git a/doc/misc/eww.texi b/doc/misc/eww.texi index 6e82a97030e..cc546a92d63 100644 --- a/doc/misc/eww.texi +++ b/doc/misc/eww.texi @@ -124,17 +124,25 @@ which part of the document contains the ``readable'' text, and will only display this part. This usually gets rid of menus and the like. @findex eww-toggle-fonts -@findex shr-use-fonts +@vindex shr-use-fonts @kindex F The @kbd{F} command (@code{eww-toggle-fonts}) toggles whether to use variable-pitch fonts or not. This sets the @code{shr-use-fonts} variable. @findex eww-toggle-colors -@findex shr-use-colors -@kindex F +@vindex shr-use-colors +@kindex M-C The @kbd{M-C} command (@code{eww-toggle-colors}) toggles whether to use HTML-specified colors or not. This sets the @code{shr-use-colors} variable. +@findex eww-toggle-images +@vindex shr-inhibit-images +@kindex M-I +@cindex Image Display + The @kbd{M-I} command (@code{eww-toggle-images}, capital letter i) +toggles whether to display images or not. This also sets the +@code{shr-inhibit-images} variable. + @findex eww-download @vindex eww-download-directory @kindex d @@ -305,6 +313,11 @@ of the width and height. If Emacs supports image scaling (ImageMagick support required) then larger images are scaled down. You can block specific images completely by customizing @code{shr-blocked-images}. +@vindex shr-inhibit-images + You can control image display by customizing +@code{shr-inhibit-images}. If this variable is @code{nil}, display +the ``ALT'' text of images instead. + @vindex shr-color-visible-distance-min @vindex shr-color-visible-luminance-min @cindex Contrast diff --git a/doc/misc/forms.texi b/doc/misc/forms.texi index 3d7ac96cc24..15fcd97c5b9 100644 --- a/doc/misc/forms.texi +++ b/doc/misc/forms.texi @@ -6,6 +6,7 @@ @setfilename ../../info/forms.info @settitle Forms Mode User's Manual @include docstyle.texi +@include emacsver.texi @syncodeindex vr cp @syncodeindex fn cp @syncodeindex ky cp @@ -47,7 +48,7 @@ modify this GNU manual.'' @sp 4 @center Forms-Mode version 2 @sp 1 -@center for GNU Emacs 22.1 +@center for GNU Emacs @value{EMACSVER} @sp 1 @center April 2007 @sp 5 diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 4c29976c05e..28bee11d2bd 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -160,13 +160,7 @@ Where and how to get Gnus? @subsubheading Answer -Gnus is released independent from releases of Emacs. Therefore, the -version bundled with Emacs might not be up to date (e.g., Gnus 5.9 -bundled with Emacs 21 is outdated). -You can get the latest released version of Gnus from -@uref{https://www.gnus.org/dist/gnus.tar.gz} -or from -@uref{https://ftp.gnus.org/pub/gnus/gnus.tar.gz}. +Gnus is bundled with Emacs. @node FAQ 1-4 @subsubheading Question 1.4 @@ -1941,13 +1935,13 @@ when you're online. Let's talk about Unix systems first: For the news part, the easiest solution is a small nntp server like -@uref{http://www.leafnode.org/, Leafnode} or +@uref{https://www.leafnode.org/, Leafnode} or @uref{http://patrik.iki.fi/sn/, sn}, of course you can also install a full featured news server like @uref{https://www.isc.org/othersoftware/, inn}. Then you want to fetch your Mail, popular choices -are @uref{http://www.fetchmail.info/, fetchmail} +are @uref{https://www.fetchmail.info/, fetchmail} and @uref{http://pyropus.ca/software/getmail/, getmail}. You should tell those to write the mail to your disk and Gnus to read it from there. Last but not least the mail @@ -2144,7 +2138,7 @@ I need real-time help, where to find it? @subsubheading Answer -Point your IRC client to chat.freenode.net, channel #gnus. +Point your IRC client to irc.libera.chat, channel #gnus. @node FAQ 9 - Tuning Gnus @subsection Tuning Gnus diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 5a79cbc08fc..5f3fba00df7 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -815,7 +815,7 @@ Various * Undo:: Some actions can be undone. * Predicate Specifiers:: Specifying predicates. * Moderation:: What to do if you're a moderator. -* Image Enhancements:: Modern versions of Emacs can display images. +* Image Enhancements:: Emacs can display images. * Fuzzy Matching:: What's the big fuzz? * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email. * Spam Package:: A package for filtering and processing spam. @@ -2318,19 +2318,18 @@ commands listed in @ref{Browse Foreign Server} at hand. @itemx u @kindex S t @r{(Group)} @kindex u @r{(Group)} -@findex gnus-group-unsubscribe-current-group -@c @icon{gnus-group-unsubscribe} -Toggle subscription to the current group -(@code{gnus-group-unsubscribe-current-group}). +@findex gnus-group-toggle-subscription-at-point +@c @icon{gnus-group-toggle-subscription-at-point} +Toggle subscription to group under point +(@code{gnus-group-toggle-subscription-at-point}). @item S s @itemx U @kindex S s @r{(Group)} @kindex U @r{(Group)} -@findex gnus-group-unsubscribe-group -Prompt for a group to subscribe, and then subscribe it. If it was -subscribed already, unsubscribe it instead -(@code{gnus-group-unsubscribe-group}). +@findex gnus-group-toggle-subscription +Prompt for group, and toggle its subscription. +(@code{gnus-group-toggle-subscription}). @item S k @itemx C-k @@ -2583,25 +2582,28 @@ with the process mark and then execute the command. @itemx M m @kindex M m @r{(Group)} @findex gnus-group-mark-group -Set the mark on the current group (@code{gnus-group-mark-group}). +Toggle the process mark for the current group +(@code{gnus-group-mark-group}).@* +If @code{gnus-process-mark-toggle} is @code{nil}, set the process mark +for the current group. @item M-# @kindex M-# @r{(Group)} @itemx M u @kindex M u @r{(Group)} @findex gnus-group-unmark-group -Remove the mark from the current group +Remove the process mark, if any, from the current group (@code{gnus-group-unmark-group}). @item M U @kindex M U @r{(Group)} @findex gnus-group-unmark-all-groups -Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). +Remove the process mark from all groups (@code{gnus-group-unmark-all-groups}). @item M w @kindex M w @r{(Group)} @findex gnus-group-mark-region -Mark all groups between point and mark (@code{gnus-group-mark-region}). +Mark groups in region (@code{gnus-group-mark-region}). @item M b @kindex M b @r{(Group)} @@ -3733,10 +3735,10 @@ Enter the current group (@code{gnus-browse-select-group}). @item u @kindex u @r{(Browse)} -@findex gnus-browse-unsubscribe-current-group +@findex gnus-browse-toggle-subscription @vindex gnus-browse-subscribe-newsgroup-method -Unsubscribe to the current group, or, as will be the case here, -subscribe to it (@code{gnus-browse-unsubscribe-current-group}). You +Toggle subscription of the current group +(@code{gnus-browse-toggle-subscription}). You can affect the way the new group is entered into the Group buffer using the variable @code{gnus-browse-subscribe-newsgroup-method}. See @pxref{Subscription Methods} for available options. @@ -4041,9 +4043,11 @@ Toggle hiding empty topics @item T # @kindex T # @r{(Topic)} @findex gnus-topic-mark-topic -Mark all groups in the current topic with the process mark +Toggle the process mark for all groups in the current topic (@code{gnus-topic-mark-topic}). This command works recursively on -sub-topics unless given a prefix. +sub-topics unless given a prefix.@* +If @code{gnus-process-mark-toggle} is @code{nil}, set the process mark +for the current topic. @item T M-# @kindex T M-# @r{(Topic)} @@ -4121,6 +4125,8 @@ Visibility. Level. @item g Number of groups in the topic. +@item G +Number of groups in the topic and all its subtopics. @item a Number of unread articles in the topic. @item A @@ -4139,6 +4145,25 @@ The default is 2. The @code{gnus-topic-display-empty-topics} says whether to display even topics that have no unread articles in them. The default is @code{t}. +@vindex gnus-topic-display-predicate +If @code{gnus-topic-display-predicate} is non-@code{nil}, it should be +a function that says whether the topic is to be displayed or not. +The function will be called with one parameter (the name of the topic) +and should return non-@code{nil} is the topic is to be displayed. + +For instance, if you don't even want to be reminded that work exists +outside of office hours, you can gather all the work-related groups +into a topic called @samp{"Work"}, and then say something like the +following: + +@lisp +(setq gnus-topic-display-predicate + (lambda (name) + (or (not (equal name "Work")) + (< 090000 + (string-to-number (format-time-string "%H%M%S")) + 170000)))) +@end lisp @node Topic Sorting @subsection Topic Sorting @@ -5230,8 +5255,23 @@ Newsgroups:full @end example to the end of her @file{overview.fmt} file, then you can use that just -as you would the extra headers from the mail groups. +as you would the extra headers from the mail groups. Otherwise, you +have to disable fetching headers with @samp{XOVER}: + +@lisp +(setq nntp-nov-is-evil t + gnus-nov-is-evil t) +@end lisp + +Be aware, though, that this will make entering an @acronym{NNTP} group +much, much slower, so this is not recommended. +One particular scenario in which it can be desirable to not use +@samp{XOVER} is for @code{nnvirtual} groups in order to support +limiting by extra headers (e.g., by the newsgroup of its component +groups). Because group parameters are not inherited, a separate +select method for the component groups with the appropriate +@code{nov-is-evil} set as a method variable is required. @node Summary Buffer Mode Line @subsection Summary Buffer Mode Line @@ -6608,14 +6648,16 @@ articles into the cache. For more information, @kindex # @r{(Summary)} @kindex M P p @r{(Summary)} @findex gnus-summary-mark-as-processable -Mark the current article with the process mark -(@code{gnus-summary-mark-as-processable}). -@findex gnus-summary-unmark-as-processable +Toggle the process mark for the current article +(@code{gnus-summary-mark-as-processable}).@* +If @code{gnus-process-mark-toggle} is @code{nil}, set the process mark +for the current article. @item M P u @itemx M-# @kindex M P u @r{(Summary)} @kindex M-# @r{(Summary)} +@findex gnus-summary-unmark-as-processable Remove the process mark, if any, from the current article (@code{gnus-summary-unmark-as-processable}). @@ -7503,6 +7545,7 @@ Matching}). @findex gnus-thread-sort-by-author @findex gnus-thread-sort-by-recipient @findex gnus-thread-sort-by-number +@findex gnus-thread-sort-by-newsgroups @findex gnus-thread-sort-by-random @vindex gnus-thread-sort-functions @findex gnus-thread-sort-by-most-recent-number @@ -7520,6 +7563,7 @@ predicate functions include @code{gnus-thread-sort-by-number}, @code{gnus-thread-sort-by-score}, @code{gnus-thread-sort-by-most-recent-number}, @code{gnus-thread-sort-by-most-recent-date}, +@code{gnus-thread-sort-by-newsgroups} and @code{gnus-thread-sort-by-random} and @code{gnus-thread-sort-by-total-score}. @@ -7581,6 +7625,7 @@ tickles your fancy. @findex gnus-article-sort-by-score @findex gnus-article-sort-by-subject @findex gnus-article-sort-by-author +@findex gnus-article-sort-by-newsgroups @findex gnus-article-sort-by-random @findex gnus-article-sort-by-number @findex gnus-article-sort-by-most-recent-number @@ -7592,8 +7637,8 @@ different functions for article comparison. Available sorting predicate functions are @code{gnus-article-sort-by-number}, @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date}, -@code{gnus-article-sort-by-random}, and -@code{gnus-article-sort-by-score}. +@code{gnus-article-sort-by-newsgroups}, @code{gnus-article-sort-by-random}, +and @code{gnus-article-sort-by-score}. If you want to sort an unthreaded summary display by subject, you could say something like: @@ -10381,6 +10426,17 @@ Sort by article ``readedness'' marks (@code{gnus-summary-sort-by-marks}). @findex gnus-summary-sort-by-score Sort by score (@code{gnus-summary-sort-by-score}). +@item C-c C-s C-u +@kindex C-c C-s C-u @r{(Summary)} +@findex gnus-summary-sort-by-newsgroups +Sort by newsgroups (@code{gnus-summary-sort-by-newsgroups}). + +@item C-c C-s C-x +@kindex C-c C-s C-x @r{(Summary)} +@findex gnus-summary-sort-by-extra +Prompts for extra header to sort by (@code{gnus-summary-sort-by-extra}). +An error will be raised if no sort functions for the header are defined. + @item C-c C-s C-r @kindex C-c C-s C-r @r{(Summary)} @findex gnus-summary-sort-by-random @@ -10553,13 +10609,15 @@ Here are the available keystrokes when using pick mode: @item . @kindex . @r{(Pick)} @findex gnus-pick-article-or-thread -Pick the article or thread on the current line -(@code{gnus-pick-article-or-thread}). If the variable +Pick the article or thread on the current line or unpick it if is +already picked (@code{gnus-pick-article-or-thread}). If the variable @code{gnus-thread-hide-subtree} is true, then this key selects the entire thread when used at the first article of the thread. Otherwise, it selects just the article. If given a numerical prefix, go to that thread or article and pick it. (The line number is normally displayed -at the beginning of the summary pick lines.) +at the beginning of the summary pick lines.) If +@code{gnus-process-mark-toggle} is @code{nil}, this key will pick an +article or thread. @item @key{SPC} @kindex SPC @r{(Pick)} @@ -14477,7 +14535,8 @@ this should be set to @code{anonymous}. If this variable isn't set, the normal login methods will be used. If you wish to specify a specific login method to be used, you can set this variable to either @code{login} (the traditional @acronym{IMAP} login method), -@code{plain} or @code{cram-md5}. +@code{plain}, @code{cram-md5} or @code{xoauth2}. (The latter method +requires using the @file{oauth2.el} library.) @item nnimap-expunge When to expunge deleted messages. If @code{never}, deleted articles @@ -14515,6 +14574,17 @@ names. If your IMAP mailboxes are called something like @samp{INBOX} and @samp{INBOX.Lists.emacs}, but you'd like the nnimap group names to be @samp{INBOX} and @samp{Lists.emacs}, you should enable this option. +@item nnimap-keepalive-intervals +By default, nnimap will send occasional @samp{NOOP} (keepalive) +commands to the server, to keep the connection alive. This option +governs how often that happens. It is a cons of two integers, +representing seconds: first how often to run the keepalive check, and +the second how many seconds of user inactivity are required to +actually send the command. The default, @code{(900 . 300)}, means run +the check every fifteen minutes and, if the user has been inactive for +five minutes, send the keepalive command. Set to @code{nil} to +disable keepalive commands altogether. + @end table @@ -16237,7 +16307,7 @@ cleaning up the headers. Functions that can be used include: Clear leading white space that ``helpful'' listservs have added to the headers to make them look nice. Aaah. -(Note that this function works on both the header on the body of all +(Note that this function works on both the header and the body of all messages, so it is a potentially dangerous function to use (if a body of a message contains something that looks like a header line). So rather than fix the bug, it is of course the right solution to make it @@ -16269,7 +16339,6 @@ Translate all @samp{@key{TAB}} characters into @samp{@key{SPC}} characters. @item nnmail-ignore-broken-references @findex nnmail-ignore-broken-references -@c @findex nnmail-fix-eudora-headers @cindex Eudora @cindex Pegasus Some mail user agents (e.g., Eudora and Pegasus) produce broken @@ -16359,9 +16428,8 @@ If you start using any of the mail back ends, they have the annoying habit of assuming that you want to read mail with them. This might not be unreasonable, but it might not be what you want. -If you set @code{mail-sources} and @code{nnmail-spool-file} to -@code{nil}, none of the back ends will ever attempt to read incoming -mail, which should help. +If you set @code{mail-sources} to @code{nil}, none of the back ends +will ever attempt to read incoming mail, which should help. @vindex nnbabyl-get-new-mail @vindex nnmbox-get-new-mail @@ -17968,7 +18036,7 @@ This creates a group including all flagged messages from all groups on two IMAP servers, "home" and "work". And one last example. Here is a function that runs a search query to -find all message that have been received recently from certain groups: +find all messages that have been received recently from certain groups: @lisp (defun my-recent-email (args) @@ -19357,6 +19425,9 @@ and dormant. If @code{nil} (which is the default), only read articles are eligible for expiry, and unread, ticked and dormant articles will be kept indefinitely. +The last (i.e., newest) article in a group will normally not be +expired (due to internal book-keeping reasons). + If you find that some articles eligible for expiry are never expired, perhaps some Gnus Agent files are corrupted. There's are special commands, @code{gnus-agent-regenerate} and @@ -22504,7 +22575,7 @@ to you, using @kbd{G b u} and updating the group will usually fix this. * Predicate Specifiers:: Specifying predicates. * Moderation:: What to do if you're a moderator. * Fetching a Group:: Starting Gnus just to read a group. -* Image Enhancements:: Modern versions of Emacs can display images. +* Image Enhancements:: Emacs can display images. * Fuzzy Matching:: What's the big fuzz? * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email. * Spam Package:: A package for filtering and processing spam. @@ -23667,9 +23738,8 @@ It takes the group name as a parameter. @node Image Enhancements @section Image Enhancements -Emacs 21@footnote{Emacs 21 on MS Windows doesn't -support images, Emacs 22 does.} and up are able to display pictures and -stuff, so Gnus has taken advantage of that. +Emacs is able to display pictures and stuff, so Gnus has taken +advantage of that. @menu * X-Face:: Display a funky, teensy black-and-white image. @@ -26810,9 +26880,10 @@ but at the common table.@* If you want to investigate the person responsible for this outrage, you can point your (feh!) web browser to -@uref{https://quimby.gnus.org/}. This is also the primary -distribution point for the new and spiffy versions of Gnus, and is -known as The Site That Destroys Newsrcs And Drives People Mad. +@uref{https://quimby.gnus.org/}. This used to be the primary +distribution point for the new and spiffy versions of Gnus, and was +known as The Site That Destroys Newsrcs And Drives People Mad, but +these days Gnus is developed in the Emacs repository. During the first extended alpha period of development, the new Gnus was called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for diff --git a/doc/misc/message.texi b/doc/misc/message.texi index be6c9a419b2..c0e3dfae12d 100644 --- a/doc/misc/message.texi +++ b/doc/misc/message.texi @@ -540,6 +540,7 @@ better than you do. @node System Mailer Setup @section System Mailer Setup @cindex mailto: +@cindex System Mailer Emacs can be set up as the system mailer, so that Emacs is opened when you click on @samp{mailto:} links in other programs. @@ -548,10 +549,11 @@ How this is done varies from system to system, but commonly there's a way to set the default application for a @acronym{MIME} type, and the relevant type here is @samp{x-scheme-handler/mailto;}. -The application to start should be @samp{"emacs -f message-mailto %u"}. +The application to start should be @w{@samp{emacs -f message-mailto %u}}. This will start Emacs, and then run the @code{message-mailto} command. It will parse the given @acronym{URL}, and set up a Message -buffer with the given parameters. +buffer with the given parameters. If you prefer to use emacsclient, +use @w{@samp{emacsclient -e '(message-mailto "%u")'}} as the application. For instance, @samp{mailto:larsi@@gnus.org?subject=This+is+a+test} will open a Message buffer with the @samp{To:} header filled in with @@ -1790,8 +1792,89 @@ member list with elements @code{CC} and @code{To}, then @code{message-carefully-insert-headers} will not insert a @code{To} header when the message is already @code{CC}ed to the recipient. +@item message-syntax-checks +@vindex message-syntax-checks +Controls what syntax checks should not be performed on outgoing posts. +To disable checking of long signatures, for instance, add + +@lisp +(signature . disabled) +@end lisp + +to this list. + +Valid checks are: + +@table @code +@item approved +@cindex approved +Check whether the article has an @code{Approved} header, which is +something only moderators should include. +@item continuation-headers +Check whether there are continuation header lines that don't begin with +whitespace. +@item control-chars +Check for invalid characters. +@item empty +Check whether the article is empty. +@item existing-newsgroups +Check whether the newsgroups mentioned in the @code{Newsgroups} and +@code{Followup-To} headers exist. +@item from +Check whether the @code{From} header seems nice. +@item illegible-text +Check whether there is any non-printable character in the body. +@item invisible-text +Check whether there is any invisible text in the buffer. +@item long-header-lines +Check for too long header lines. +@item long-lines +@cindex long lines +Check for too long lines in the body. +@item message-id +Check whether the @code{Message-ID} looks syntactically ok. +@item multiple-headers +Check for the existence of multiple equal headers. +@item new-text +Check whether there is any new text in the messages. +@item newsgroups +Check whether the @code{Newsgroups} header exists and is not empty. +@item quoting-style +Check whether text follows last quoted portion. +@item repeated-newsgroups +Check whether the @code{Newsgroups} and @code{Followup-To} headers +contains repeated group names. +@item reply-to +Check whether the @code{Reply-To} header looks ok. +@item sender +@cindex Sender +Insert a new @code{Sender} header if the @code{From} header looks odd. +@item sendsys +@cindex sendsys +Check for the existence of version and sendsys commands. +@item shoot +Check whether the domain part of the @code{Message-ID} header looks ok. +@item shorten-followup-to +Check whether to add a @code{Followup-To} header to shorten the number +of groups to post to. +@item signature +Check the length of the signature. +@item size +Check for excessive size. +@item subject +Check whether the @code{Subject} header exists and is not empty. +@item subject-cmsg +Check the subject for commands. +@item valid-newsgroups +Check whether the @code{Newsgroups} and @code{Followup-To} headers +are valid syntactically. @end table +All these conditions are checked by default, except for @code{sender} +for which the check is disabled by default if +@code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}). + +@end table @node Mail Headers @section Mail Headers @@ -2001,7 +2084,7 @@ This optional header will be computed by Message. @vindex user-mail-address @findex system-name @cindex Sun -@cindex i-did-not-set--mail-host-address--so-tickle-me +@cindex mail-host-address-is-not-set This required header will be generated by Message. A unique ID will be created based on the date, time, user name (for the local part) and the domain part. For the domain part, message will look (in this order) at @@ -2070,88 +2153,6 @@ Other variables for customizing outgoing news articles: @table @code -@item message-syntax-checks -@vindex message-syntax-checks -Controls what syntax checks should not be performed on outgoing posts. -To disable checking of long signatures, for instance, add - -@lisp -(signature . disabled) -@end lisp - -to this list. - -Valid checks are: - -@table @code -@item approved -@cindex approved -Check whether the article has an @code{Approved} header, which is -something only moderators should include. -@item continuation-headers -Check whether there are continuation header lines that don't begin with -whitespace. -@item control-chars -Check for invalid characters. -@item empty -Check whether the article is empty. -@item existing-newsgroups -Check whether the newsgroups mentioned in the @code{Newsgroups} and -@code{Followup-To} headers exist. -@item from -Check whether the @code{From} header seems nice. -@item illegible-text -Check whether there is any non-printable character in the body. -@item invisible-text -Check whether there is any invisible text in the buffer. -@item long-header-lines -Check for too long header lines. -@item long-lines -@cindex long lines -Check for too long lines in the body. -@item message-id -Check whether the @code{Message-ID} looks syntactically ok. -@item multiple-headers -Check for the existence of multiple equal headers. -@item new-text -Check whether there is any new text in the messages. -@item newsgroups -Check whether the @code{Newsgroups} header exists and is not empty. -@item quoting-style -Check whether text follows last quoted portion. -@item repeated-newsgroups -Check whether the @code{Newsgroups} and @code{Followup-To} headers -contains repeated group names. -@item reply-to -Check whether the @code{Reply-To} header looks ok. -@item sender -@cindex Sender -Insert a new @code{Sender} header if the @code{From} header looks odd. -@item sendsys -@cindex sendsys -Check for the existence of version and sendsys commands. -@item shoot -Check whether the domain part of the @code{Message-ID} header looks ok. -@item shorten-followup-to -Check whether to add a @code{Followup-To} header to shorten the number -of groups to post to. -@item signature -Check the length of the signature. -@item size -Check for excessive size. -@item subject -Check whether the @code{Subject} header exists and is not empty. -@item subject-cmsg -Check the subject for commands. -@item valid-newsgroups -Check whether the @code{Newsgroups} and @code{Followup-To} headers -are valid syntactically. -@end table - -All these conditions are checked by default, except for @code{sender} -for which the check is disabled by default if -@code{message-insert-canlock} is non-@code{nil} (@pxref{Canceling News}). - @item message-ignored-news-headers @vindex message-ignored-news-headers Regexp of headers to be removed before posting. The default is@* diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index 308ea3f34c9..a7c1fed29cb 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi @@ -78,7 +78,7 @@ Public License.'' @html <!-- @end html -@node Top, Preface, (dir), (dir) +@node Top @top The MH-E Manual @html --> @@ -197,7 +197,7 @@ History of MH-E --> @end html -@node Preface, Conventions, Top, Top +@node Preface @unnumbered Preface @cindex Emacs @@ -272,7 +272,7 @@ Bill Wohler <@i{wohler at newt.com}>@* 8 February 1995@* 24 February 2006 -@node Conventions, Getting Started, Preface, Top +@node Conventions @chapter GNU Emacs Terms and Conventions @cindex Emacs @@ -513,7 +513,7 @@ you enter something in the minibuffer, but then you change your mind, type @kbd{C-g} and you'll be back where you started. If you want to exit Emacs entirely, use @kbd{C-x C-c}. -@node Getting Started, Tour Through MH-E, Conventions, Top +@node Getting Started @chapter Getting Started @cindex MH-E, versions @@ -658,7 +658,7 @@ after these variables have been set. This hook can be used the change the value of these variables if you need to run with different values between MH and MH-E. -@node Tour Through MH-E, Using This Manual, Getting Started, Top +@node Tour Through MH-E @chapter Tour Through MH-E @cindex introduction @@ -684,7 +684,7 @@ get the big picture, and then you can read the manual as you wish. * More About MH-E:: @end menu -@node Sending Mail Tour, Reading Mail Tour, Tour Through MH-E, Tour Through MH-E +@node Sending Mail Tour @section Sending Mail @cindex MH-Letter mode @@ -750,7 +750,7 @@ more complete help with the @kbd{C-h m} (@code{describe-mode}) command.}, but at this time we'll only use @kbd{C-c C-c} to send your message. Type @kbd{C-c C-c} now. That's all there is to it! -@node Reading Mail Tour, Processing Mail Tour, Sending Mail Tour, Tour Through MH-E +@node Reading Mail Tour @section Receiving Mail @cindex @command{inc} @@ -823,7 +823,7 @@ This is a test message to get the wheels churning... If you typed a long message, you can view subsequent pages with @key{SPC} and previous pages with @key{DEL}. -@node Processing Mail Tour, Leaving MH-E, Reading Mail Tour, Tour Through MH-E +@node Processing Mail Tour @section Processing Mail @cindex processing mail @@ -949,7 +949,7 @@ available via the prefix characters, type the prefix character followed by a @kbd{?}, for example, @kbd{F ?}. More complete help is available with the @kbd{C-h m} (@code{describe-mode}) command. -@node Leaving MH-E, More About MH-E, Processing Mail Tour, Tour Through MH-E +@node Leaving MH-E @section Leaving MH-E @cindex Emacs, quitting @@ -988,7 +988,7 @@ already exists, so you can use @samp{folders -recurse -fast} in a script to copy all of your messages into a single file, or using the @samp{-file} argument, a file for each folder. -@node More About MH-E, , Leaving MH-E, Tour Through MH-E +@node More About MH-E @section More About MH-E These are the basic commands to get you going, but there are plenty @@ -1054,7 +1054,7 @@ Place messages in a file (@pxref{Files and Pipes}). Remember that you can also use MH commands when you're not running MH-E (and when you are!). -@node Using This Manual, Incorporating Mail, Tour Through MH-E, Top +@node Using This Manual @chapter Using This Manual This chapter begins the meat of the manual which goes into more detail @@ -1150,7 +1150,7 @@ your initials. (Unless, of course, your initials happen to be @emph{mh}!) * Folder Selection:: @end menu -@node Options, Ranges, Using This Manual, Using This Manual +@node Options @section Options @cindex Emacs, customizing @@ -1210,7 +1210,7 @@ function. Try entering @kbd{M-x customize-group @key{RET} mh the MH-E customization groups. Another way to view the MH-E customization group is to use @kbd{M-x mh-customize @key{RET}}. -@node Ranges, Folder Selection, Options, Using This Manual +@node Ranges @section Ranges @c Sync with mh-folder-mode docstring. @@ -1279,7 +1279,7 @@ interpret input such as @samp{200} as @samp{last:200} if the default). If you need to scan just the message 200, then use the range @samp{200:1} or @samp{200-200}. -@node Folder Selection, , Ranges, Using This Manual +@node Folder Selection @section Folder Selection @cindex completion, folders @@ -1359,7 +1359,7 @@ folder name used is suggested. This is useful if you get mail from various people for whom you have an alias, but file them all in the same project folder. -@node Incorporating Mail, Reading Mail, Using This Manual, Top +@node Incorporating Mail @chapter Incorporating Your Mail @cindex @samp{Folder} menu @@ -1535,7 +1535,7 @@ the message numbers from outside of MH-E. @end group @end smalllisp -@node Reading Mail, Folders, Incorporating Mail, Top +@node Reading Mail @chapter Reading Your Mail @cindex @samp{+inbox} @@ -2003,7 +2003,7 @@ detail in the following sections. * Miscellaneous Commands and Options:: @end menu -@node Viewing, Viewing Attachments, Reading Mail, Reading Mail +@node Viewing @section Viewing Your Mail @findex mh-header-display @@ -2276,7 +2276,7 @@ of @code{"@{show-%s@} %d"} yields a mode line of -----@{show-+inbox@} 4 (MH-Show)--Bot-------------------------------- @end smallexample -@node Viewing Attachments, HTML, Viewing, Reading Mail +@node Viewing Attachments @section Viewing Attachments @cindex attachments @@ -2516,7 +2516,7 @@ Article Buttons} and in the @cite{The Gnus Manual}. @end ifnotinfo -@node HTML, Digests, Viewing Attachments, Reading Mail +@node HTML @section HTML @cindex HTML @@ -2670,7 +2670,7 @@ buffer, including HTML buffers. (global-set-key [S-mouse-2] 'browse-url-at-mouse) @end smalllisp -@node Digests, Reading PGP, HTML, Reading Mail +@node Digests @section Digests @cindex digests @@ -2714,7 +2714,7 @@ preceded with a @samp{>} so that your reply can't create the @samp{To:} field yourself. This is described later (@pxref{Editing Drafts}). -@node Reading PGP, Printing, Digests, Reading Mail +@node Reading PGP @section Signed and Encrypted Messages @cindex GPG @@ -2848,7 +2848,7 @@ See @cite{The PGG Manual}}. @end ifhtml -@node Printing, Files and Pipes, Reading PGP, Reading Mail +@node Printing @section Printing Your Mail @cindex printing @@ -2933,7 +2933,7 @@ If you do this, do not delete the message until it is printed or else the output may be truncated. These options are not used by the commands @kbd{P p} or @kbd{P f}. -@node Files and Pipes, Navigating, Printing, Reading Mail +@node Files and Pipes @section Files and Pipes @cindex files @@ -2993,7 +2993,7 @@ through @command{uuencode} or @command{shar}. For example, you can extract the contents of the current buffer in your home directory by typing @kbd{M-x mh-store-buffer @key{RET} ~ @key{RET}}. -@node Navigating, Miscellaneous Commands and Options, Files and Pipes, Reading Mail +@node Navigating @section Navigating @cindex moving between messages @@ -3094,7 +3094,7 @@ The hook @code{mh-delete-msg-hook} is called after you mark a message for deletion. For example, a past maintainer of MH-E used this once when he kept statistics on his mail usage. -@node Miscellaneous Commands and Options, , Navigating, Reading Mail +@node Miscellaneous Commands and Options @section Miscellaneous Commands and Options This section contains a few more miscellaneous commands and options. @@ -3207,7 +3207,7 @@ displayed or @code{mh-rmail} is run, and the MH-E window configuration is shown. Otherwise, the MH-E window configuration is saved and the original configuration is displayed. -@node Folders, Sending Mail, Reading Mail, Top +@node Folders @chapter Organizing Your Mail with Folders @cindex @samp{Folder} menu @@ -3842,7 +3842,7 @@ running dired on my mail directory (@kbd{M-x dired @key{RET} ~/Mail @key{RET}}), moving my cursor to @samp{out} and using the command @kbd{R} (@code{dired-do-rename}). -@node Sending Mail, Editing Drafts, Folders, Top +@node Sending Mail @chapter Sending Mail @cindex sending mail @@ -4002,7 +4002,7 @@ more detail in the following sections. * Editing Again:: @end menu -@node Composing, Replying, Sending Mail, Sending Mail +@node Composing @section Composing @cindex @file{.emacs} @@ -4125,7 +4125,7 @@ is that you can write a function to write and send the message for you. This function is passed three arguments: the contents of the @samp{To:}, @samp{Subject:}, and @samp{Cc:} header fields. -@node Replying, Forwarding, Composing, Sending Mail +@node Replying @section Replying to Mail @cindex @command{mhl} @@ -4221,7 +4221,7 @@ buffer by turning off the option @code{mh-reply-show-message-flag}. If you wish to customize the header or other parts of the reply draft, please see @command{repl}(1) and @code{mh-format}(5). -@node Forwarding, Redistributing, Replying, Sending Mail +@node Forwarding @section Forwarding Mail @cindex @command{forw} @@ -4283,7 +4283,7 @@ and creates a subject header field of: Subject: Greg DesBrisay: Re: 49er football @end smallexample -@node Redistributing, Editing Again, Forwarding, Sending Mail +@node Redistributing @section Redistributing Your Mail @cindex @command{dist} @@ -4323,7 +4323,7 @@ a message that has been redistributed before, turn off this option. The hook @code{mh-annotate-msg-hook} is run after annotating the message and scan line (@pxref{Sending Mail}). -@node Editing Again, , Redistributing, Sending Mail +@node Editing Again @section Editing Old Drafts and Bounced Messages @cindex @file{draft} @@ -4359,7 +4359,7 @@ the message for editing by removing the @i{Mailer-Daemon} envelope and unneeded header fields. Fix whatever addressing problem you had, and send the message again with @kbd{C-c C-c}. -@node Editing Drafts, Aliases, Sending Mail, Top +@node Editing Drafts @chapter Editing a Draft @cindex @samp{Letter} menu @@ -4754,7 +4754,7 @@ detail in the following sections. * Killing Draft:: @end menu -@node Editing Message, Inserting Letter, Editing Drafts, Editing Drafts +@node Editing Message @section Editing the Message @cindex @samp{Bcc} header field @@ -4929,7 +4929,7 @@ the first period in the paragraph above, the result would be this: @end group @end smallexample -@node Inserting Letter, Inserting Messages, Editing Message, Editing Drafts +@node Inserting Letter @section Inserting Letter to Which You're Replying @cindex inserting messages @@ -5055,7 +5055,7 @@ For example, if you use the hook function @code{trivial-cite}} (which is NOT part of Emacs), set @code{mh-yank-behavior} to @samp{Body and Header}. -@node Inserting Messages, Signature, Inserting Letter, Editing Drafts +@node Inserting Messages @section Inserting Messages @cindex inserting messages @@ -5081,7 +5081,7 @@ left intact, the message is not indented, and @samp{> } is not inserted before each line. This command leaves the mark before the letter and point after it. -@node Signature, Picture, Inserting Messages, Editing Drafts +@node Signature @section Inserting Your Signature @cindex signature @@ -5136,7 +5136,7 @@ function used to insert the signature with The signature can also be inserted using Identities. @xref{Identities}. -@node Picture, Adding Attachments, Signature, Editing Drafts +@node Picture @section Inserting Your Picture @cindex @file{.face} @@ -5186,7 +5186,7 @@ defined by this option doesn't exist. @xref{Viewing}, to see how these header fields are displayed in MH-E. -@node Adding Attachments, Sending PGP, Picture, Editing Drafts +@node Adding Attachments @section Adding Attachments @cindex @command{mhbuild} @@ -5530,7 +5530,7 @@ prefix argument (as in @kbd{C-u C-c C-e}). The hook @code{mh-mh-to-mime-hook} is called after the message has been formatted by @kbd{C-c C-e}. -@node Sending PGP, Checking Recipients, Adding Attachments, Editing Drafts +@node Sending PGP @section Signing and Encrypting Messages @cindex signing messages @@ -5621,7 +5621,7 @@ all messages I encrypt are encrypted with my public key as well. If you keep a copy of all of your outgoing mail with a @samp{Fcc:} header field, this setting is vital so that you can read the mail you write! -@node Checking Recipients, Sending Message, Sending PGP, Editing Drafts +@node Checking Recipients @section Checking Recipients @cindex @file{*MH-E Recipients*} @@ -5640,7 +5640,7 @@ you can check the actual address(es) in the alias. A new buffer named @uref{@value{MH-BOOK-HOME}/senove.html#WhaPro, What now?---and the whatnow Program} in the MH book.}. -@node Sending Message, Killing Draft, Checking Recipients, Editing Drafts +@node Sending Message @section Sending a Message @cindex buffers, @file{*MH-E Mail Delivery*} @@ -5678,7 +5678,7 @@ in the MH book.} is installed under a different name, use The hook @code{mh-annotate-msg-hook} is run after annotating the message and scan line (@pxref{Sending Mail}). -@node Killing Draft, , Sending Message, Editing Drafts +@node Killing Draft @section Killing the Draft @cindex killing draft @@ -5692,7 +5692,7 @@ command @kbd{C-c C-q} (@code{mh-fully-kill-draft}) to kill the draft buffer and delete the draft message. Use the command @kbd{C-x k} (@code{kill-buffer}) if you don't want to delete the draft message. -@node Aliases, Identities, Editing Drafts, Top +@node Aliases @chapter Aliases @cindex aliases @@ -6019,7 +6019,7 @@ Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}). @end ifhtml -@node Identities, Speedbar, Aliases, Top +@node Identities @chapter Identities @cindex identities @@ -6256,7 +6256,7 @@ example, @samp{:signature}), and the action @samp{'remove} or @samp{'add}. If the action is @samp{'add}, an additional argument containing the value for the field is given. -@node Speedbar, Menu Bar, Identities, Top +@node Speedbar @chapter The Speedbar @cindex folder navigation @@ -6354,7 +6354,7 @@ Selected folder face. Selected folder face when folder contains unread messages. @end vtable -@node Menu Bar, Tool Bar, Speedbar, Top +@node Menu Bar @chapter The Menu Bar @cindex @samp{Folder} menu @@ -6414,7 +6414,7 @@ manual in two ways: all of the menu items are listed alphabetically, and you can also browse all of the items under the index entry @samp{menu item}. -@node Tool Bar, Searching, Menu Bar, Top +@node Tool Bar @chapter The Tool Bar @cindex tool bar @@ -6498,7 +6498,7 @@ variable is set to anything other than @samp{Same As Default Tool Bar} and the default tool bar is in a different location, then two tool bars will be displayed: the MH-E tool bar and the default tool bar. -@node Searching, Threading, Tool Bar, Top +@node Searching @chapter Searching Through Messages @cindex @samp{Search} menu @@ -7037,7 +7037,7 @@ MH-Search buffer. Instead, you simply enter a regular expression in the minibuffer. For help in constructing regular expressions, see your man page for @command{grep}. -@node Threading, Limits, Searching, Top +@node Threading @chapter Viewing Message Threads @cindex threading @@ -7166,7 +7166,7 @@ ensure that the byte-compiled version appears first in the installed MH-E yourself, please refer to the installation directions in the file @file{README} in the distribution.}. -@node Limits, Sequences, Threading, Top +@node Limits @chapter Limiting Display @cindex limits @@ -7274,7 +7274,7 @@ command to limit the display to messages in a range (@pxref{Ranges}). Each limit can be undone in turn with the @kbd{/ w} (@code{mh-widen}) command. Give this command a prefix argument to remove all limits. -@node Sequences, Junk, Limits, Top +@node Sequences @chapter Using Sequences @cindex @samp{Sequence} menu @@ -7383,8 +7383,8 @@ The name of the MH sequence for ticked messages (default: @samp{'tick}). @item mh-update-sequences-after-mh-show-flag On means flush MH sequences to disk after message is shown (default: @samp{on}). -@item mh-whitelist-preserves-sequences-flag -On means that sequences are preserved when messages are whitelisted +@item mh-allowlist-preserves-sequences-flag +On means that sequences are preserved when messages are allowlisted (default: @samp{on}). @end vtable @@ -7528,7 +7528,7 @@ command dealing with sequences is @command{mark}@footnote{See the section @uref{@value{MH-BOOK-HOME}/mmbwm.html, Make Message Bookmarks with mark} in the MH book.}. -@node Junk, Miscellaneous, Sequences, Top +@node Junk @chapter Dealing With Junk Mail @cindex Marshall Rose @@ -7540,17 +7540,17 @@ Marshall Rose once wrote a paper on MH entitled, @cite{How to process could be entitled, @cite{How to process 1000 spams a day and still get some real work done}. -@cindex blacklisting +@cindex blocklisting @cindex ham @cindex viruses -@cindex whitelisting +@cindex allowlisting @cindex worms We use the terms @dfn{junk mail} and @dfn{spam} interchangeably for any unwanted message which includes spam, @dfn{viruses}, and @dfn{worms}. The opposite of spam is @dfn{ham}. The act of classifying -a sender as one who sends junk mail is called @dfn{blacklisting}; the -opposite is called @dfn{whitelisting}. +a sender as one who sends junk mail is called @dfn{blocklisting}; the +opposite is called @dfn{allowlisting}. @table @kbd @kindex J ? @@ -7560,14 +7560,14 @@ Display cheat sheet for the commands of the current prefix in minibuffer (@code{mh-prefix-help}). @c ------------------------- @kindex J b -@findex mh-junk-blacklist +@findex mh-junk-blocklist @item J b -Blacklist range as spam (@code{mh-junk-blacklist}). +Blocklist range as spam (@code{mh-junk-blocklist}). @c ------------------------- -@kindex J w -@findex mh-junk-whitelist -@item J w -Whitelist range as ham (@code{mh-junk-whitelist}). +@kindex J a +@findex mh-junk-allowlist +@item J a +Allowlist range as ham (@code{mh-junk-allowlist}). @c ------------------------- @item @code{mh-spamassassin-identify-spammers} Identify spammers who are repeat offenders. @@ -7597,31 +7597,31 @@ The following option in the @samp{mh-sequences} customization group is also available. @vtable @code -@item mh-whitelist-preserves-sequences-flag -On means that sequences are preserved when messages are whitelisted +@item mh-allowlist-preserves-sequences-flag +On means that sequences are preserved when messages are allowlisted (default: @samp{on}). @end vtable The following hooks are available. @vtable @code -@item mh-blacklist-msg-hook -Hook run by @kbd{J b} (@code{mh-junk-blacklist}) after marking each -message for blacklisting (default: @code{nil}). +@item mh-blocklist-msg-hook +Hook run by @kbd{J b} (@code{mh-junk-blocklist}) after marking each +message for blocklisting (default: @code{nil}). @c ------------------------- -@item mh-whitelist-msg-hook -Hook run by @kbd{J w} (@code{mh-junk-whitelist}) after marking each -message for whitelisting (default @samp{nil}). +@item mh-allowlist-msg-hook +Hook run by @kbd{J a} (@code{mh-junk-allowlist}) after marking each +message for allowlisting (default @samp{nil}). @end vtable The following faces are available. @vtable @code -@item mh-folder-blacklisted -Blacklisted message face. +@item mh-folder-blocklisted +Blocklisted message face. @c ------------------------- -@item mh-folder-whitelisted -Whitelisted message face +@item mh-folder-allowlisted +Allowlisted message face @end vtable @cindex SpamProbe @@ -7647,21 +7647,21 @@ example, you have both SpamAssassin and bogofilter installed and you want to use bogofilter, then you can set this option to @samp{Bogofilter}. -@findex mh-junk-blacklist +@findex mh-junk-blocklist @kindex J b @vindex mh-junk-disposition -The command @kbd{J b} (@code{mh-junk-blacklist}) trains the spam +The command @kbd{J b} (@code{mh-junk-blocklist}) trains the spam program in use with the content of the range (@pxref{Ranges}) and then handles the message(s) as specified by the option @code{mh-junk-disposition}. By default, this option is set to @samp{Delete Spam} but you can also specify the name of the folder which is useful for building a corpus of spam for training purposes. -@findex mh-junk-whitelist -@kindex J w +@findex mh-junk-allowlist +@kindex J a -In contrast, the command @kbd{J w} (@code{mh-junk-whitelist}) +In contrast, the command @kbd{J a} (@code{mh-junk-allowlist}) reclassifies a range of messages (@pxref{Ranges}) as ham if it were incorrectly classified as spam. It then refiles the message into the @file{+inbox} folder. @@ -7671,12 +7671,12 @@ incorrectly classified as spam. It then refiles the message into the @cindex @samp{Previous-Sequence} MH profile component @cindex sequence, @samp{cur} @cindex sequence, @samp{Previous-Sequence} -@vindex mh-whitelist-preserves-sequences-flag +@vindex mh-allowlist-preserves-sequences-flag If a message is in any sequence (except @samp{Previous-Sequence:} and -@samp{cur}) when it is whitelisted, then it will still be in those +@samp{cur}) when it is allowlisted, then it will still be in those sequences in the destination folder. If this behavior is not desired, -then turn off the option @code{mh-whitelist-preserves-sequences-flag}. +then turn off the option @code{mh-allowlist-preserves-sequences-flag}. @cindex @file{*MH-E Log*} @cindex buffers, @file{*MH-E Log*} @@ -7687,7 +7687,7 @@ By default, the programs are run in the foreground, but this can be slow when junking large numbers of messages. If you have enough memory or don't junk that many messages at the same time, you might try turning on the option @code{mh-junk-background}. @footnote{Note that -the option @code{mh-junk-background} is used as the @code{display} +the option @code{mh-junk-background} is used as the @code{destination} argument in the call to @code{call-process}. Therefore, turning on this option means setting its value to @samp{0}. You can also set its value to @samp{t} to direct the programs' output to the @file{*MH-E @@ -7756,33 +7756,33 @@ the @samp{+spam} folder for later review. The major weakness of rules-based filters is a plethora of false positives so it is worthwhile to check. -@findex mh-junk-blacklist -@findex mh-junk-whitelist +@findex mh-junk-blocklist +@findex mh-junk-allowlist @kindex J b -@kindex J w +@kindex J a If SpamAssassin classifies a message incorrectly, or is unsure, you can -use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and -@kbd{J w} (@code{mh-junk-whitelist}). +use the MH-E commands @kbd{J b} (@code{mh-junk-blocklist}) and +@kbd{J a} (@code{mh-junk-allowlist}). @cindex @command{sa-learn} @cindex @file{.spamassassin/user_prefs} @cindex files, @file{.spamassassin/user_prefs} -The command @kbd{J b} (@code{mh-junk-blacklist}) adds a +The command @kbd{J b} (@code{mh-junk-blocklist}) adds a @samp{blacklist_from} entry to @file{~/spamassassin/user_prefs}, deletes the message, and sends the message to the Razor, so that others might not see this spam. If the @command{sa-learn} command is available, the message is also recategorized as spam. -The command@kbd{J w} (@code{mh-junk-whitelist}) adds a +The command@kbd{J a} (@code{mh-junk-allowlist}) adds a @samp{whitelist_from} rule to @samp{~/.spamassassin/user_prefs}. If the @command{sa-learn} command is available, the message is also recategorized as ham. Over time, you'll observe that the same host or domain occurs repeatedly in the @samp{blacklist_from} entries, so you might think -that you could avoid future spam by blacklisting all mail from a +that you could avoid future spam by blocklisting all mail from a particular domain. The utility function @code{mh-spamassassin-identify-spammers} helps you do precisely that. This function displays a frequency count of the hosts and domains in @@ -7796,7 +7796,7 @@ blacklist_from *@@*amazingoffersdirect2u.com @end smallexample In versions of SpamAssassin (2.50 and on) that support a Bayesian -classifier, @kbd{J b} @code{(mh-junk-blacklist}) uses the program +classifier, @kbd{J b} @code{(mh-junk-blocklist}) uses the program @command{sa-learn} to recategorize the message as spam. Neither MH-E, nor SpamAssassin, rebuilds the database after adding words, so you will need to run @samp{sa-learn --rebuild} periodically. This can be @@ -7856,14 +7856,14 @@ spam/. spam/unsure/. @end smallexample -@findex mh-junk-blacklist -@findex mh-junk-whitelist +@findex mh-junk-blocklist +@findex mh-junk-allowlist @kindex J b -@kindex J w +@kindex J a If bogofilter classifies a message incorrectly, or is unsure, you can -use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J -w} (@code{mh-junk-whitelist}) to update bogofilter's training. +use the MH-E commands @kbd{J b} (@code{mh-junk-blocklist}) and +@kbd{J a} (@code{mh-junk-allowlist}) to update bogofilter's training. The @cite{Bogofilter FAQ} suggests that you run the following occasionally to shrink the database: @@ -7908,14 +7908,14 @@ SCORE=| spamprobe receive spam/. @end smallexample -@findex mh-junk-blacklist -@findex mh-junk-whitelist +@findex mh-junk-blocklist +@findex mh-junk-allowlist @kindex J b -@kindex J w +@kindex J a If SpamProbe classifies a message incorrectly, you can use the MH-E -commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J w} -(@code{mh-junk-whitelist}) to update SpamProbe's training. +commands @kbd{J b} (@code{mh-junk-blocklist}) and @kbd{J a} +(@code{mh-junk-allowlist}) to update SpamProbe's training. @subheading Other Things You Can Do @@ -7966,7 +7966,7 @@ spam/unreadable/. spam/unreadable/. @end smallexample -@node Miscellaneous, Scan Line Formats, Junk, Top +@node Miscellaneous @chapter Miscellaneous Commands, Variables, and Buffers This chapter covers the following command and the various MH-E @@ -8053,7 +8053,7 @@ it is hidden because the first character in the name is a space. You'll generally not have any need for this buffer. @end table -@node Scan Line Formats, Procmail, Miscellaneous, Top +@node Scan Line Formats @appendix Scan Line Formats @cindex scan line formats @@ -8521,7 +8521,7 @@ Finally, add the following to delete and refile messages. This is just a bare minimum; it's best to adjust all of the regular expressions to ensure that MH-E and highlighting perform well. -@node Procmail, Odds and Ends, Scan Line Formats, Top +@node Procmail @appendix Reading Mailing Lists Effectively @cindex @command{procmail} @@ -8680,7 +8680,7 @@ example above, you would tell Gnus about it the first time only with @kbd{G m gnucash @key{RET} nnml @key{RET}}. In MH-E, this folder is known as @samp{+gnucash}. -@node Odds and Ends, History, Procmail, Top +@node Odds and Ends @appendix Odds and Ends This appendix covers a few topics that don't fit elsewhere. Here I @@ -8694,7 +8694,7 @@ I also point out some additional sources of information. * Getting MH-E:: @end menu -@node Bug Reports, Mailing Lists, Odds and Ends, Odds and Ends +@node Bug Reports @appendixsec Bug Reports @cindex bugs @@ -8708,7 +8708,7 @@ to do that it shouldn't be a restriction for you. Please include the output of @kbd{M-x mh-version} (@pxref{Miscellaneous}) in any bug report you send unless you're 110% positive we won't ask for it. -@node Mailing Lists, MH FAQ and Support, Bug Reports, Odds and Ends +@node Mailing Lists @appendixsec MH-E Mailing Lists @cindex SourceForge @@ -8721,7 +8721,7 @@ the archives at @uref{https://sourceforge.net/p/mh-e/mailman/, SourceForge}. Do not report bugs on these lists; please submit them via SourceForge (@pxref{Bug Reports}). -@node MH FAQ and Support, Getting MH-E, Mailing Lists, Odds and Ends +@node MH FAQ and Support @appendixsec MH FAQ and Support @cindex FAQ @@ -8740,7 +8740,7 @@ You can find FAQs on MH-E by searching for @i{labels:support} on the Tickets} page on SourceForge. If you don't find the answer to your question, file a ticket and your question will become a new FAQ! -@node Getting MH-E, , MH FAQ and Support, Odds and Ends +@node Getting MH-E @appendixsec Getting MH-E @cindex MH-E, obtaining @@ -8795,7 +8795,7 @@ also contains doc and contrib packages. The former is the latest release of this manual, and the latter contains a few contributed packages you might find useful. -@node History, GFDL, Odds and Ends, Top +@node History @appendix History of MH-E @cindex Bill Wohler @@ -8826,7 +8826,7 @@ lives today. * From Bill Wohler:: @end menu -@node From Brian Reid, From Jim Larus, History, History +@node From Brian Reid @appendixsec From Brian Reid @cindex Brian Reid @@ -8858,7 +8858,7 @@ the ideas as well. Perhaps one day, MH-E will again resemble MHE Brian Reid, June 1994 -@node From Jim Larus, From Stephen Gildea, From Brian Reid, History +@node From Jim Larus @appendixsec From Jim Larus @cindex Jim Larus @@ -8904,7 +8904,7 @@ since then. Jim Larus, June 1994 -@node From Stephen Gildea, From Bill Wohler, From Jim Larus, History +@node From Stephen Gildea @appendixsec From Stephen Gildea @cindex Gildea, Stephen @@ -8946,7 +8946,7 @@ version 5 was released. Stephen Gildea, June 1994 -@node From Bill Wohler, , From Stephen Gildea, History +@node From Bill Wohler @appendixsec From Bill Wohler @cindex Wohler, Bill @@ -8993,27 +8993,27 @@ new features and several bug fixes. Bill Wohler, August 2008 -@node GFDL, GPL, History, Top +@node GFDL @appendix GNU Free Documentation License @include doclicense.texi -@node GPL, Key Index, GFDL, Top +@node GPL @appendix GNU General Public License @include gpl.texi -@node Key Index, Command Index, GPL, Top +@node Key Index @unnumbered Key (Character) Index @printindex ky -@node Command Index, Option Index, Key Index, Top +@node Command Index @unnumbered Command Index @printindex fn -@node Option Index, Concept Index, Command Index, Top +@node Option Index @unnumbered Option (Variable) Index @printindex vr -@node Concept Index, , Option Index, Top +@node Concept Index @unnumbered Concept Index @printindex cp diff --git a/doc/misc/modus-themes.org b/doc/misc/modus-themes.org new file mode 100644 index 00000000000..5bb230f892a --- /dev/null +++ b/doc/misc/modus-themes.org @@ -0,0 +1,4677 @@ +#+title: Modus themes for GNU Emacs +#+author: Protesilaos Stavrou +#+email: info@protesilaos.com +#+language: en +#+options: ':t toc:nil author:t email:t num:t +#+startup: content + +#+macro: stable-version 1.5.0 +#+macro: release-date 2021-07-15 +#+macro: development-version 1.6.0-dev +#+macro: file @@texinfo:@file{@@$1@@texinfo:}@@ +#+macro: space @@texinfo:@: @@ +#+macro: kbd @@texinfo:@kbd{@@$1@@texinfo:}@@ + +#+texinfo_filename: modus-themes.info +#+texinfo_dir_category: Emacs misc features +#+texinfo_dir_title: Modus Themes: (modus-themes) +#+texinfo_dir_desc: Highly accessible themes (WCAG AAA) +#+texinfo_header: @set MAINTAINERSITE @uref{https://protesilaos.com,maintainer webpage} +#+texinfo_header: @set MAINTAINER Protesilaos Stavrou +#+texinfo_header: @set MAINTAINEREMAIL @email{info@protesilaos.com} +#+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:info@protesilaos.com,contact the maintainer} + +#+texinfo: @insertcopying + +This manual, written by Protesilaos Stavrou, describes the customization +options for the ~modus-operandi~ and ~modus-vivendi~ themes, and provides +every other piece of information pertinent to them. + +The documentation furnished herein corresponds to stable version +{{{stable-version}}}, released on {{{release-date}}}. Any reference to a newer +feature which does not yet form part of the latest tagged commit, is +explicitly marked as such. + +Current development target is {{{development-version}}}. + +#+toc: headlines 8 insert TOC here, with eight headline levels + +* COPYING +:properties: +:copying: t +:custom_id: h:b14c3fcb-13dd-4144-9d92-2c58b3ed16d3 +:end: + +Copyright (C) 2020-2021 Free Software Foundation, Inc. + +#+begin_quote +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover Texts being “A GNU Manual,” and +with the Back-Cover Texts as in (a) below. A copy of the license is +included in the section entitled “GNU Free Documentation License.” + +(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and +modify this GNU manual.” +#+end_quote + +* Overview +:properties: +:custom_id: h:f0f3dbcb-602d-40cf-b918-8f929c441baf +:end: + +The Modus themes are designed for accessible readability. They conform +with the highest standard for color contrast between any given +combination of background and foreground values. This corresponds to +the WCAG AAA standard, which specifies a minimum rate of distance in +relative luminance of 7:1. + +Modus Operandi (~modus-operandi~) is a light theme, while Modus Vivendi +(~modus-vivendi~) is dark. Each theme's color palette is designed to meet +the needs of the numerous interfaces that are possible in the Emacs +computing environment. + +The overarching objective of this project is to always offer accessible +color combinations. There shall never be a compromise on this +principle. If there arises an inescapable trade-off between readability +and stylistic considerations, we will always opt for the former. + +To ensure that users have a consistently accessible experience, the +themes strive to achieve as close to full face coverage as possible +([[#h:a9c8f29d-7f72-4b54-b74b-ddefe15d6a19][Face coverage]]). + +Furthermore, the themes are designed to empower users with red-green +color deficiency (deuteranopia). This is achieved through customization +options which have the effect of replacing all relevant instances of +green with a variant of blue ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). + +Starting with version 0.12.0 and onwards, the themes are built into GNU +Emacs. + +** How do the themes look like +:properties: +:custom_id: h:69b92089-069c-4ba1-9d94-cc3415fc4f87 +:end: +#+cindex: Screenshots + +Check the web page with [[https://protesilaos.com/modus-themes-pictures/][the screen shots]]. There are lots of scenarios +on display that draw attention to details and important aspects in the +design of the themes. They also showcase the numerous customization +options. + +[[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization options]]. + +** Learn about the latest changes +:properties: +:custom_id: h:2cc37c36-6c1a-48b2-a010-1050b270ee18 +:end: +#+cindex: Changelog + +Please refer to the [[https://protesilaos.com/modus-themes-changelog][web page with the change log]]. It is comprehensive +and covers everything that goes into every tagged release of the themes. + +* Installation +:properties: +:custom_id: h:1af85373-7f81-4c35-af25-afcef490c111 +:end: + +The Modus themes are distributed with Emacs starting with version 28.1. +On older versions of Emacs, they can be installed using Emacs' package +manager or manually from their code repository. There also exist +packages for distributions of GNU/Linux. + +** Install manually from source +:properties: +:custom_id: h:da3414b7-1426-46b8-8e76-47b845b76fd0 +:end: + +In the following example, we are assuming that your Emacs files are +stored in =~/.emacs.d= and that you want to place the Modus themes in +=~/.emacs.d/modus-themes=. + +1. Get the source and store it in the desired path by running the + following in the command line shell: + +: $ git clone https://gitlab.com/protesilaos/modus-themes.git ~/.emacs.d/modus-themes + +2. Add that path to your known Elisp libraries' list, by placing this + snippet of Emacs Lisp in your init file (e.g. {{{file(init.el)}}}): + +#+begin_src emacs-lisp +(add-to-list 'load-path "~/.emacs.d/modus-themes") +#+end_src + +The themes are now ready to be used: [[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]. + +** Install from the archives +:properties: +:custom_id: h:c4b10085-149f-43e2-bd4d-347f33aee054 +:end: + +The ~modus-themes~ package is available from the GNU ELPA archive, which +is configured by default. + +Prior to querying any package archive, make sure to have updated the +index, with {{{kbd(M-x package-refresh-contents)}}}. Then all you need to do +is type {{{kbd(M-x package-install)}}} and specify the ~modus-themes~. + +Note that older versions of the themes used to be distributed as +standalone packages. This practice has been discontinued starting with +version 1.0.0 of this project. + +Once installed, the themes are ready to be used: [[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]. + +** Install on GNU/Linux +:properties: +:custom_id: h:da640eb1-95dd-4e86-bb4e-1027b27885f0 +:end: + +The themes are also available from the archives of some distributions of +GNU/Linux. These should correspond to a tagged release rather than +building directly from the latest Git commit. It all depends on the +distro's packaging policies. + +*** Debian 11 Bullseye +:properties: +:custom_id: h:7e570360-9ee6-4bc5-8c04-9dc11418a3e4 +:end: + +The themes are part of Debian 11 Bullseye. Get them with: + +#+begin_src sh +sudo apt install elpa-modus-themes +#+end_src + +They are now ready to be used: [[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]. + +*** GNU Guix +:properties: +:custom_id: h:a4ca52cd-869f-46a5-9e16-4d9665f5b88e +:end: + +Users of Guix can get the themes with this command: + +#+begin_src sh +guix package -i emacs-modus-themes +#+end_src + +They are now ready to be used: [[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]. + +* Enable and load +:properties: +:custom_id: h:3f3c3728-1b34-437d-9d0c-b110f5b161a9 +:end: +#+findex: modus-themes-load-themes +#+findex: modus-themes-toggle +#+findex: modus-themes-load-operandi +#+findex: modus-themes-load-vivendi +#+cindex: Essential configuration +#+vindex: modus-themes-after-load-theme-hook + +Users of the built-in themes can load and automatically enable the theme +of their preference by adding either form to their init file: + +#+begin_src emacs-lisp +(load-theme 'modus-operandi) ; Light theme +(load-theme 'modus-vivendi) ; Dark theme +#+end_src + +This is all one needs. + +Users of packaged variants of the themes must add a few more lines to +ensure that everything works as intended. First, one has to require the +main library before loading either theme: + +#+begin_src emacs-lisp +(require 'modus-themes) +#+end_src + +Then it is recommended to load the individual theme files with the +helper function ~modus-themes-load-themes~: + +#+begin_src emacs-lisp +;; Load the theme files before enabling a theme (else you get an error). +(modus-themes-load-themes) +#+end_src + +Once the libraries that define the themes are enabled, one can activate +a theme with either of the following expressions: + +#+begin_src emacs-lisp +(modus-themes-load-operandi) ; Light theme +;; OR +(modus-themes-load-vivendi) ; Dark theme +#+end_src + +Changes to the available customization options must always be evaluated +before loading a theme ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). An exception to this +norm is when using the various Custom interfaces or with commands like +{{{kbd(M-x customize-set-variable)}}}, which automatically reload the theme by +default ([[#h:9001527a-4e2c-43e0-98e8-3ef72d770639][Option for inhibiting theme reload]]). This is how a basic setup +could look like: + +#+begin_src emacs-lisp +(require 'modus-themes) + +;; Your customisations here. For example: +(setq modus-themes-bold-constructs t + modus-themes-mode-line '3d) + +;; Load the theme files before enabling a theme (else you get an error). +(modus-themes-load-themes) + +;; Enable the theme of your preference: +(modus-themes-load-operandi) + +;; Optionally add a key binding for the toggle between the themes: +(define-key global-map (kbd "<f5>") #'modus-themes-toggle) +#+end_src + +[[#h:e979734c-a9e1-4373-9365-0f2cd36107b8][Sample configuration for use-package]]. + +With those granted, bear in mind a couple of technical points on +~modus-themes-load-operandi~ and ~modus-themes-load-vivendi~, as well as +~modus-themes-toggle~ which relies on them: + +1. Those functions call ~load-theme~. Some users prefer to opt for + ~enable-theme~ instead ([[#h:e68560b3-7fb0-42bc-a151-e015948f8a35][Differences between loading and enabling]]). + +2. The functions will run the ~modus-themes-after-load-theme-hook~ as + their final step. This can be employed for bespoke configurations + ([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization (do-it-yourself)]]). Experienced users may not + wish to rely on such a hook and the functions that run it: they may + prefer a custom solution ([[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]). + +** Sample configuration for use-package +:properties: +:custom_id: h:e979734c-a9e1-4373-9365-0f2cd36107b8 +:end: +#+cindex: use-package configuration + +It is common for Emacs users to rely on ~use-package~ for declaring +package configurations in their setup. We use this as an example: + +#+begin_src emacs-lisp +(use-package modus-themes + :ensure ; omit this to use the built-in themes + :init + ;; Add all your customizations prior to loading the themes + (setq modus-themes-italic-constructs t + modus-themes-bold-constructs nil + modus-themes-region '(bg-only no-extend)) + + ;; Load the theme files before enabling a theme (else you get an error). + (modus-themes-load-themes) + :config + ;; Load the theme of your choice: + (modus-themes-load-operandi) ;; OR (modus-themes-load-vivendi) + :bind ("<f5>" . modus-themes-toggle)) +#+end_src + +[[#h:e68560b3-7fb0-42bc-a151-e015948f8a35][Differences between loading and enabling]]. + +Note: make sure not to customize the variable ~custom-theme-load-path~ +or ~custom-theme-directory~ after the themes' package declaration. That +will lead to failures in loading the files. If either or both of those +variables need to be changed, their values should be defined before the +package declaration of the themes. + +** Differences between loading and enabling +:properties: +:custom_id: h:e68560b3-7fb0-42bc-a151-e015948f8a35 +:end: +#+cindex: load-theme VS enable-theme + +The reason we recommend ~load-theme~ instead of the other option of +~enable-theme~ is that the former does a kind of "reset" on the face +specs. It quite literally loads (or re-loads) the theme. Whereas the +latter simply puts an already loaded theme at the top of the list of +enabled items, re-using whatever state was last loaded. + +As such, ~load-theme~ reads all customizations that may happen during +any given Emacs session: even after the initial setup of a theme. +Examples are calls to ~custom-set-faces~, as well as new values assigned +to the options the Modus themes provide ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). + +Our tests show that ~enable-theme~ does not read such variables anew, so +it might appear to the unsuspecting user that the themes are somehow +broken whenever they try to assign a new value to a customization option +or some face. + +This "reset" that ~load-theme~ conducts does, however, come at the cost +of being somewhat slower than ~enable-theme~. Users who have a stable +setup and who seldom update their variables during a given Emacs +session, are better off using something like this: + +#+begin_src emacs-lisp +(require 'modus-themes) +(load-theme 'modus-operandi t t) +(load-theme 'modus-vivendi t t) + +(enable-theme 'modus-operandi) ;; OR (enable-theme 'modus-vivendi) +#+end_src + +[[#h:e979734c-a9e1-4373-9365-0f2cd36107b8][Sample configuration for use-package]]. + +With the above granted, other sections of the manual discuss how to +configure custom faces, where ~load-theme~ is expected, though +~enable-theme~ could still apply in stable setups: + +[[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]. + +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. + +* Customization Options +:properties: +:custom_id: h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f +:end: + +The Modus themes are highly configurable, though they should work well +without any further tweaks. By default, all customization options are +set to nil, unless otherwise noted in this manual. + +Remember that all customization options must be evaluated before loading +a theme ([[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]). + +Below is a summary of what you will learn in the subsequent sections of +this manual. + +#+begin_src emacs-lisp +(setq modus-themes-italic-constructs t + modus-themes-bold-constructs nil + modus-themes-no-mixed-fonts nil + modus-themes-subtle-line-numbers nil + modus-themes-success-deuteranopia t + modus-themes-inhibit-reload t ; only applies to `customize-set-variable' and related + + modus-themes-fringes nil ; {nil,'subtle,'intense} + + ;; Options for `modus-themes-lang-checkers' are either nil (the + ;; default), or a list of properties that may include any of those + ;; symbols: `straight-underline', `text-also', `background', + ;; `intense' + modus-themes-lang-checkers nil + + ;; Options for `modus-themes-mode-line' are either nil, or a list + ;; that can combine any of `3d' OR `moody', `borderless', + ;; `accented'. The variable's doc string shows all possible + ;; combinations. + modus-themes-mode-line '(3d accented) + + ;; Options for `modus-themes-syntax' are either nil (the default), + ;; or a list of properties that may include any of those symbols: + ;; `faint', `yellow-comments', `green-strings', `alt-syntax' + modus-themes-syntax nil + + ;; Options for `modus-themes-hl-line' are either nil (the default), + ;; or a list of properties that may include any of those symbols: + ;; `accented', `underline', `intense' + modus-themes-hl-line '(underline accented) + + ;; Options for `modus-themes-paren-match' are either nil (the + ;; default), or a list of properties that may include any of those + ;; symbols: `bold', `intense', `underline' + modus-themes-paren-match '(bold intense) + + ;; Options for `modus-themes-links' are either nil (the default), + ;; or a list of properties that may include any of those symbols: + ;; `neutral-underline' OR `no-underline', `faint' OR `no-color', + ;; `bold', `italic', `background' + modus-themes-links '(neutral-underline background) + + ;; Options for `modus-themes-prompts' are either nil (the + ;; default), or a list of properties that may include any of those + ;; symbols: `background', `bold', `gray', `intense', `italic' + modus-themes-prompts '(intense bold) + + modus-themes-completions 'moderate ; {nil,'moderate,'opinionated} + + modus-themes-mail-citations nil ; {nil,'faint,'monochrome} + + ;; Options for `modus-themes-region' are either nil (the default), + ;; or a list of properties that may include any of those symbols: + ;; `no-extend', `bg-only', `accented' + modus-themes-region '(bg-only no-extend) + + ;; Options for `modus-themes-diffs': nil, 'desaturated, + ;; 'bg-only, 'deuteranopia, 'fg-only-deuteranopia + modus-themes-diffs 'fg-only-deuteranopia + + modus-themes-org-blocks 'gray-background ; {nil,'gray-background,'tinted-background} + + modus-themes-org-agenda ; this is an alist: read the manual or its doc string + '((header-block . (variable-pitch scale-title)) + (header-date . (grayscale workaholic bold-today)) + (scheduled . uniform) + (habit . traffic-light-deuteranopia)) + + modus-themes-headings ; this is an alist: read the manual or its doc string + '((1 . (overline background)) + (2 . (rainbow overline)) + (t . (no-bold))) + + modus-themes-variable-pitch-ui nil + modus-themes-variable-pitch-headings t + modus-themes-scale-headings t + modus-themes-scale-1 1.1 + modus-themes-scale-2 1.15 + modus-themes-scale-3 1.21 + modus-themes-scale-4 1.27 + modus-themes-scale-title 1.33) +#+end_src + +** Option for inhibiting theme reload +:properties: +:alt_title: Custom reload theme +:description: Toggle auto-reload of the theme when setting custom variables +:custom_id: h:9001527a-4e2c-43e0-98e8-3ef72d770639 +:end: +#+vindex: modus-themes-inhibit-reload + +Symbol: ~modus-themes-inhibit-reload~ + +Possible values: + +1. ~nil~ +2. ~t~ (default) + +By default, customizing a theme-related user option through the Custom +interfaces or with {{{kbd(M-x customize-set-variable)}}} will not reload the +currently active Modus theme. + +Enable this behaviour by setting this variable to ~nil~. + +** Option for color-coding success state (deuteranopia) +:properties: +:alt_title: Success' color-code +:description: Toggle blue color for success or done states +:custom_id: h:3ed03a48-20d8-4ce7-b214-0eb7e4c79abe +:end: +#+vindex: modus-themes-success-deuteranopia + +Symbol: ~modus-themes-success-deuteranopia~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +The default is to colorise all faces that denote "success", "done", or +similar with a variant of green. + +With a non-nil value (~t~), use variants of blue instead of green. This +is meant to empower users with red-green color deficiency. + +The present customization option should apply to all contexts where +there can be a color-coded distinction between success and failure, +to-do and done, and so on. + +Diffs, which have a red/green dichotomy by default, can also be +configured to conform with deuteranopia. + +[[#h:ea7ac54f-5827-49bd-b09f-62424b3b6427][Option for diff buffer looks]]. + +** Option for more bold constructs +:properties: +:alt_title: Bold constructs +:description: Toggle bold constructs in code +:custom_id: h:b25714f6-0fbe-41f6-89b5-6912d304091e +:end: +#+vindex: modus-themes-bold-constructs + +Symbol: ~modus-themes-bold-constructs~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +The default is to use a bold typographic weight only when it is +required. + +With a non-nil value (~t~) display several syntactic constructs in bold +weight. This concerns keywords and other important aspects of code +syntax. It also affects certain mode line indicators and command-line +prompts. + +Advanced users may also want to configure the exact attributes of the +~bold~ face. + +[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. + +** Option for more italic constructs +:properties: +:alt_title: Italic constructs +:description: Toggle italic font constructs in code +:custom_id: h:977c900d-0d6d-4dbb-82d9-c2aae69543d6 +:end: +#+vindex: modus-themes-italic-constructs + +Symbol: ~modus-themes-italic-constructs~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +The default is to not use slanted text forms (italics) unless it is +absolutely necessary. + +With a non-nil value (~t~) choose to render more faces in italics. This +typically affects documentation strings and code comments. + +Advanced users may also want to configure the exact attributes of the +~italic~ face. + +[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. + +** Option for syntax highlighting +:properties: +:alt_title: Syntax styles +:description: Choose the overall aesthetic of code syntax +:custom_id: h:c119d7b2-fcd4-4e44-890e-5e25733d5e52 +:end: +#+vindex: modus-themes-syntax + +Symbol: ~modus-themes-syntax~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ ~faint~ ++ ~yellow-comments~ ++ ~green-strings~ ++ ~alt-syntax~ + +The default (a ~nil~ value or an empty list) is to use a balanced +combination of colors on the cyan-blue-magenta side of the spectrum. +There is little to no use of greens, yellows, and reds. Comments are +gray, strings are blue colored, doc strings are a shade of cyan, while +color combinations are designed to avoid exaggerations. + +The property ~faint~ fades the saturation of all applicable colors, where +that is possible or appropriate. + +The property ~yellow-comments~ applies a yellow color to comments. + +The property ~green-strings~ applies a green color to strings and a green +tint to doc strings. + +The property ~alt-syntax~ changes the combination of colors beyond strings +and comments, so that the effective palette is broadened to provide +greater variety relative to the default. + +Combinations of any of those properties are expressed as a list, like in +these examples: + +#+begin_src emacs-lisp +(faint) +(green-strings yellow-comments) +(alt-syntax green-strings yellow-comments) +(faint alt-syntax green-strings yellow-comments) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-syntax '(faint alt-syntax)) +#+end_src + +Independent of this variable, users may also control the use of a bold +weight or italic text: ~modus-themes-bold-constructs~ and +~modus-themes-italic-constructs~. + +[[#h:b25714f6-0fbe-41f6-89b5-6912d304091e][Option for more bold constructs]]. + +[[#h:977c900d-0d6d-4dbb-82d9-c2aae69543d6][Option for more italic constructs]]. + +** Option for no font mixing +:properties: +:alt_title: No mixed fonts +:description: Toggle mixing of font families +:custom_id: h:115e6c23-ee35-4a16-8cef-e2fcbb08e28b +:end: +#+vindex: modus-themes-no-mixed-fonts + +Symbol: ~modus-themes-no-mixed-fonts~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +By default, the themes configure some spacing-sensitive faces like Org +tables and code blocks to always inherit from the ~fixed-pitch~ face. +This is to ensure that those constructs remain monospaced even when +users opt for a mode that remaps typeface families, such as the built-in +{{{kbd(M-x variable-pitch-mode)}}}. Otherwise the layout would appear +broken, due to how spacing is done. To disable this behaviour, set the +option to ~t~. + +Users may prefer to use another package for handling mixed typeface +configurations, rather than letting the theme do it, perhaps because a +purpose-specific package has extra functionality. Two possible options +are ~org-variable-pitch~ and ~mixed-pitch~. + +[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + +** Option for links +:properties: +:alt_title: Link styles +:description: Choose among several styles, with or without underline +:custom_id: h:c119d7b2-fcd4-4e44-890e-5e25733d5e52 +:end: +#+vindex: modus-themes-links + +Symbol: ~modus-themes-links~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ Underline style: + - ~neutral-underline~ + - ~no-underline~ ++ Text coloration: + - ~faint~ + - ~no-color~ ++ ~bold~ ++ ~italic~ ++ ~background~ + +The default (a ~nil~ value or an empty list) is a prominent text color, +typically blue, with an underline of the same color. + +For the style of the underline, a ~neutral-underline~ property turns the +color of the line into a subtle gray, while the ~no-underline~ property +removes the line altogether. If both of those are set, the latter takes +precedence. + +For text coloration, a ~faint~ property desaturates the color of the text +and the underline, unless the underline is affected by the +aforementioned properties. While a ~no-color~ property removes the color +from the text. If both of those are set, the latter takes precedence. + +A ~bold~ property applies a heavy typographic weight to the text of the +link. + +An ~italic~ property adds a slant to the link's text (italic or oblique +forms, depending on the typeface). + +A ~background~ property applies a subtle tinted background color. + +In case both ~no-underline~ and ~no-color~ are set, then a subtle gray +background is applied to all links. This can still be combined with the +~bold~ and ~italic~ properties. + +Combinations of any of those properties are expressed as a list, +like in these examples: + +#+begin_src emacs-lisp +(faint) +(no-underline faint) +(no-color no-underline bold) +(italic bold background no-color no-underline) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-links '(neutral-underline background)) +#+end_src + +The placement of the underline, meaning its proximity to the text, is +controlled by ~x-use-underline-position-properties~, +~x-underline-at-descent-line~, ~underline-minimum-offset~. Please refer to +their documentation strings. + +** Option for command prompt styles +:properties: +:alt_title: Command prompts +:description: Choose among plain, subtle, or intense prompts +:custom_id: h:db5a9a7c-2928-4a28-b0f0-6f2b9bd52ba1 +:end: +#+vindex: modus-themes-prompts + +Symbol: ~modus-themes-prompts~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ ~background~ ++ ~bold~ ++ ~gray~ ++ ~intense~ ++ ~italic~ + +The default (a ~nil~ value or an empty list) means to only use a subtle +accented foreground color. + +The property ~background~ applies a background color to the prompt's text. +By default, this is a subtle accented value. + +The property ~intense~ makes the foreground color more prominent. If the +~background~ property is also set, it amplifies the value of the +background as well. + +The property ~gray~ changes the prompt's colors to grayscale. This +affects the foreground and, if the ~background~ property is also set, the +background. Its effect is subtle, unless it is combined with the +~intense~ property. + +The property ~bold~ makes the text use a bold typographic weight. +Similarly, ~italic~ adds a slant to the font's forms (italic or oblique +forms, depending on the typeface). + +Combinations of any of those properties are expressed as a list, like in +these examples: + +#+begin_src emacs-lisp +(intense) +(bold intense) +(intense bold gray) +(intense background gray bold) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-prompts '(background gray)) +#+end_src + +** Option for mode line presentation +:properties: +:alt_title: Mode line +:description: Choose among several styles, with or without borders +:custom_id: h:27943af6-d950-42d0-bc23-106e43f50a24 +:end: +#+vindex: modus-themes-mode-line + +Symbol: ~modus-themes-mode-line~ + +Possible values, which can be expressed as a list of combinations of box +effect, color, and border visibility: + ++ Overall style: + - ~3d~ + - ~moody~ ++ ~accented~ ++ ~borderless~ + +The default (a nil value or an empty list) is a two-dimensional +rectangle with a border around it. The active and the inactive +mode lines use different shades of grayscale values for the +background, foreground, border. + +The ~3d~ property applies a three-dimensional effect to the +active mode line. The inactive mode lines remain two-dimensional +and are toned down a bit, relative to the default style. + +The ~moody~ property optimizes the mode line for use with the +library of the same name (hereinafter referred to as 'Moody'). +In practice, it removes the box effect and replaces it with +underline and overline properties. It also tones down the +inactive mode lines. Despite its intended purpose, this option +can also be used without the Moody library (please consult the +themes' manual on this point for more details). If both ~3d~ and +~moody~ properties are set, the latter takes precedence. + +The ~borderless~ property removes the color of the borders. It +does not actually remove the borders, but only makes their color +the same as the background, effectively creating some padding. + +The ~accented~ property ensures that the active mode line uses a +colored background instead of the standard shade of gray. + +Combinations of any of those properties are expressed as a list, +like in these examples: + +#+begin_src emacs-lisp +(accented) +(borderless 3d) +(moody accented borderless) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-prompts '(borderless accented)) +#+end_src + +Note that Moody does not expose any faces that the themes could style +directly. Instead it re-purposes existing ones to render its tabs and +ribbons. As such, there may be cases where the contrast ratio falls +below the 7:1 target that the themes conform with (WCAG AAA). To hedge +against this, we configure a fallback foreground for the ~moody~ property, +which will come into effect when the background of the mode line changes +to something less accessible, such as Moody ribbons (read the doc string +of ~set-face-attribute~, specifically ~:distant-foreground~). This fallback +is activated when Emacs determines that the background and foreground of +the given construct are too close to each other in terms of color +distance. In practice, users will need to experiment with the variable +~face-near-same-color-threshold~ to trigger the effect. We find that a +value of =45000= shall suffice, contrary to the default =30000=. Though for +the combinations that involve the ~accented~ and ~moody~ properties, as +mentioned above, that should be raised up to =70000=. Do not set it too +high, because it has the adverse effect of always overriding the default +colors (which have been carefully designed to be highly accessible). + +Furthermore, because Moody expects an underline and overline instead of +a box style, it is advised to set ~x-underline-at-descent-line~ to a +non-nil value. + +** Option for completion framework aesthetics +:properties: +:alt_title: Completion UIs +:description: Choose among standard, moderate, or opinionated looks +:custom_id: h:f1c20c02-7b34-4c35-9c65-99170efb2882 +:end: +#+vindex: modus-themes-completions + +Symbol: ~modus-themes-completions~ + +Possible values: + +1. ~nil~ (default) +2. ~moderate~ +3. ~opinionated~ + +This is a special option that has different effects depending on the +completion UI. The interfaces can be grouped in two categories, based +on their default aesthetics: (i) those that only or mostly use +foreground colors for their interaction model, and (ii) those that +combine background and foreground values for some of their metaphors. +The former category encompasses Icomplete, Ido, Selectrum, Vertico, as +well as pattern matching styles like Orderless and Flx. The latter +covers Helm, Ivy, and Sallet. + +A value of ~nil~ (the default) will simply respect the metaphors of each +completion framework. + +Option ~moderate~ applies a combination of background and foreground that +is fairly subtle. For Icomplete and friends this constitutes a +departure from their default aesthetics, however the difference is +small. While Helm, Ivy et al appear slightly different than their +original looks, as they are toned down a bit. + +Option ~opinionated~ uses color combinations that refashion the completion +UI. For the Icomplete camp this means that intense background and +foreground combinations are used: in effect their looks emulate those of +Helm, Ivy and co. in their original style. Whereas the other group of +packages will revert to an even more nuanced aesthetic with some +additional changes to the choice of hues. + +To appreciate the scope of this customization option, you should spend +some time with every one of the ~nil~ (default), ~moderate~, and ~opinionated~ +possibilities. + +** Option for mail citations +:properties: +:alt_title: Mail citations +:description: Choose among colorful, desaturated, monochrome citations +:custom_id: h:5a12765d-0ba0-4a75-ab11-e35d3bbb317d +:end: +#+vindex: modus-themes-mail-citations + +Symbol: ~modus-themes-mail-citations~ + +Possible values: + +1. ~nil~ (default) +2. ~faint~ +3. ~monochrome~ + +By default, citations in email-related buffers apply contrasting hues to +different levels of depth in cited text. The colors are fairly easy to +tell apart. + +A value of ~faint~ makes all citation levels less intense, while retaining +the default style of contrasting hues (albeit very subtle ones). + +Option ~monochrome~ turns all citations in to a uniform shade of gray. + +Whatever the value assigned to this variable, citations in emails are +controlled by typographic elements or indentation, which the themes do +not touch. + +** Option for fringe visibility +:properties: +:alt_title: Fringes +:description: Choose among invisible, subtle, or intense fringe styles +:custom_id: h:1983c3fc-74f6-44f3-b917-967c403bebae +:end: +#+vindex: modus-themes-fringes + +Symbol: ~modus-themes-fringes~ + +Possible values: + +1. ~nil~ (default) +2. ~subtle~ +3. ~intense~ + +The default is to use the same color as that of the main background, +meaning that the fringes are not obvious though they still occupy the +space given to them by ~fringe-mode~. + +Options ~subtle~ and ~intense~ apply a gray background, making the fringes +visible. The difference between the two is one of degree, as their +names imply. + +** Option for language checkers +:properties: +:alt_title: Language checkers +:description: Control the style of language checkers/linters +:custom_id: h:4b13743a-8ebf-4d2c-a043-cceba10b1eb4 +:end: +#+vindex: modus-themes-lang-checkers + +Symbol: ~modus-themes-lang-checkers~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ ~straight-underline~ ++ ~text-also~ ++ ~background~ ++ ~intense~ + +The default (a ~nil~ value or an empty list) applies a color-coded +underline to the affected text, while it leaves the original foreground +intact. If the display spec of Emacs has support for it, the +underline's style is that of a wave, otherwise it is a straight line. + +The property ~straight-underline~ ensures that the underline under the +affected text is always drawn as a straight line. + +The property ~text-also~ applies the same color of the underline to the +affected text. + +The property ~background~ adds a color-coded background. + +The property ~intense~ amplifies the applicable colors if ~background~ +and/or ~text-only~ are set. If ~intense~ is set on its own, then it implies +~text-only~. + +To disable fringe indicators for Flymake or Flycheck, refer to variables +~flymake-fringe-indicator-position~ and ~flycheck-indication-mode~, +respectively. + +Combinations of any of those properties can be expressed in a +list, as in those examples: + +#+begin_src emacs-lisp +(background) +(straight-underline intense) +(background text-also straight-underline) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-lang-checkers '(text-also background)) +#+end_src + +NOTE: The placement of the straight underline, though not the wave +style, is controlled by the built-in variables ~underline-minimum-offset~, +~x-underline-at-descent-line~, ~x-use-underline-position-properties~. + +** Option for line highlighting (hl-line-mode) +:properties: +:alt_title: Line highlighting +:description: Choose style of current line (hl-line-mode) +:custom_id: h:1dba1cfe-d079-4c13-a810-f768e8789177 +:end: +#+vindex: modus-themes-hl-line + +Symbol: ~modus-themes-hl-line~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ ~accented~ ++ ~intense~ ++ ~underline~ + +The default (a ~nil~ value or an empty list) is a subtle gray background +color. + +The property ~accented~ changes the background to a colored variant. + +An ~underline~ property draws a line below the highlighted area. Its +color is similar to the background, so gray by default or an accent +color when ~accented~ is also set. + +An ~intense~ property amplifies the colors in use, which may be both the +background and the underline. + +Combinations of any of those properties are expressed as a list, like in +these examples: + +#+begin_src emacs-lisp +(intense) +(underline intense) +(accented intense underline) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-hl-line '(underline accented)) +#+end_src + +Set ~x-underline-at-descent-line~ to a non-nil value for better results +with underlines. + +This style affects several packages that enable ~hl-line-mode~, such as +=elfeed=, =notmuch=, and =mu4e=. + +** Option for line numbers (display-line-numbers-mode) +:properties: +:alt_title: Line numbers +:description: Toggle subtle style for line numbers +:custom_id: h:8c4a6230-2e43-4aa2-a631-3b7179392e09 +:end: +#+vindex: modus-themes-subtle-line-numbers + +Symbol: ~modus-themes-subtle-line-numbers~ + +Possible value: + +1. ~nil~ (default) +2. ~t~ + +The default style for ~display-line-numbers-mode~ and its global variant +is to apply a subtle gray background to the line numbers. The current +line has a more pronounced background and foreground combination to +bring more attention to itself. + +Similarly, the faces for ~display-line-numbers-major-tick~ and its +counterpart ~display-line-numbers-minor-tick~ use appropriate styles that +involve a bespoke background and foreground combination. + +With a non-nil value (~t~), line numbers have no background of their own. +Instead they retain the primary background of the theme, blending with +the rest of the buffer. Foreground values for all relevant faces are +updated to accommodate this aesthetic. + +** Option for parenthesis matching (show-paren-mode) +:properties: +:alt_title: Matching parentheses +:description: Choose between various styles for matching delimiters/parentheses +:custom_id: h:e66a7e4d-a512-4bc7-9f86-fbbb5923bf37 +:end: +#+vindex: modus-themes-paren-match + +Symbol: ~modus-themes-paren-match~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ ~bold~ ++ ~intense~ ++ ~underline~ + +The default (a ~nil~ value or an empty list) is a subtle background color. + +The ~bold~ property adds a bold weight to the characters of the matching +delimiters. + +The ~intense~ property applies a more prominent background color to the +delimiters. + +The ~underline~ property draws a straight line under the affected text. + +Combinations of any of those properties are expressed as a list, like in +these examples: + +#+begin_src emacs-lisp +(bold) +(underline intense) +(bold intense underline) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-paren-match '(bold intense)) +#+end_src + +This customization variable affects the built-in ~show-paren-mode~ and the +=smartparens= package. + +** Option for active region +:properties: +:alt_title: Active region +:description: Choose between various styles for the active region +:custom_id: h:60798063-b4ad-45ea-b9a7-ff7b5c0ab74c +:end: +#+vindex: modus-themes-region + +Symbol: ~modus-themes-region~ + +Possible values are expressed as a list of properties (default is ~nil~ or +an empty list). The list can include any of the following symbols: + ++ ~no-extend~ ++ ~bg-only~ ++ ~accented~ + +The default (a ~nil~ value or an empty list) is a prominent gray +background that overrides all foreground colors in the area it +encompasses. Its reach extends to the edge of the window. + +The ~no-extend~ property limits the region to the end of the line, so that +it does not reach the edge of the window. + +The ~bg-only~ property makes the region's background color more subtle to +allow the underlying text to retain its foreground colors. + +The ~accented~ property applies a more colorful background to the region. + +Combinations of any of those properties are expressed as a list, like in +these examples: + +#+begin_src emacs-lisp +(no-extend) +(bg-only accented) +(accented bg-only no-extend) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-region '(bg-only no-extend)) +#+end_src + +** Option for diff buffer looks +:properties: +:alt_title: Diffs +:description: Choose among intense, desaturated, or text-only diffs +:custom_id: h:ea7ac54f-5827-49bd-b09f-62424b3b6427 +:end: +#+vindex: modus-themes-diffs + +Symbol: ~modus-themes-diffs~ + +Possible values: + +1. ~nil~ (default) +2. ~desaturated~ +3. ~bg-only~ +4. ~deuteranopia~ +5. ~fg-only-deuteranopia~ + +The default (~nil~) uses fairly intense color combinations for diffs, by +applying prominently colored backgrounds, with appropriate foregrounds. + +Option ~desaturated~ follows the same principles as with the default +(~nil~), though it tones down all relevant colors. + +Option ~bg-only~ applies a background but does not override the text's +foreground. This makes it suitable for a non-nil value passed to +~diff-font-lock-syntax~ (note: Magit does not support syntax highlighting +in diffs---last checked on 2021-04-21). + +Option ~deuteranopia~ is like the default (~nil~) in terms of using +prominently colored backgrounds, except that it also accounts for +red-green color defficiency by replacing all instances of green with +colors on the blue side of the spectrum. Other stylistic changes are +made in the interest of optimizing for such a use-case. + +Option ~fg-only-deuteranopia~ removes all colored backgrounds, except from +word-wise or refined changes. Instead, it only uses color-coded +foreground values to differentiate between added, removed, and changed +lines. If a background is necessary to denote context, a subtle +grayscale value is applied. The color used for added lines is a variant +of blue to account for red-green color defficiency but also because +green text alone is hard to discern in the diff's context (hard for our +accessibility purposes). The ~fg-only~ option that existed in older +versions of the themes is now an alias of ~fg-only-deuteranopia~, in the +interest of backward compatibility. + +** Option for org-mode block styles +:properties: +:alt_title: Org mode blocks +:description: Choose among plain, gray, or tinted backgrounds +:custom_id: h:b7e328c0-3034-4db7-9cdf-d5ba12081ca2 +:end: +#+vindex: modus-themes-org-blocks + +Symbol: ~modus-themes-org-blocks~ + +Possible values: + +1. ~nil~ (default) +2. ~gray-background~ (value ~grayscale~ exists for backward compatibility) +3. ~tinted-background~ (value ~rainbow~ exists for backward compatibility) + +The default means that the block has no distinct background of its own +and uses the one that applies to the rest of the buffer. + +Option ~gray-background~ applies a subtle gray background to the block's +contents. It also affects the begin and end lines of the block: their +background extends to the edge of the window for Emacs version >= 27 +where the ~:extend~ keyword is recognized by ~set-face-attribute~ (this is +contingent on the variable ~org-fontify-whole-block-delimiter-line~). + +Option ~tinted-background~ uses a slightly colored background for the +contents of the block. The exact color will depend on the programming +language and is controlled by the variable ~org-src-block-faces~ (refer to +the theme's source code for the current association list). For this to +take effect, Org must be restarted with {{{kbd(M-x org-mode-restart)}}}. + +Code blocks use their major mode's colors only when the variable +~org-src-fontify-natively~ is non-nil. While quote/verse blocks require +setting ~org-fontify-quote-and-verse-blocks~ to a non-nil value. + +[[#h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50][Update Org block delimiter fontification]]. + +Older versions of the themes provided options ~grayscale~ (or ~greyscale~) +and ~rainbow~. Those will continue to work as they are aliases for +~gray-background~ and ~tinted-background~, respectively. + +** Option for Org agenda constructs +:properties: +:alt_title: Org agenda +:description: Control each element in the presentation of the agenda +:custom_id: h:68f481bc-5904-4725-a3e6-d7ecfa7c3dbc +:end: +#+vindex: modus-themes-org-agenda + +Symbol: ~modus-themes-org-agenda~ + +This is an alist that accepts a =(key . value)= combination. Some values +are specified as a list. Here is a sample, followed by a description of +all possible combinations: + +#+begin_src emacs-lisp +(setq modus-themes-org-agenda + '((header-block . (variable-pitch scale-title)) + (header-date . (grayscale workaholic bold-today)) + (scheduled . uniform) + (habit . traffic-light))) +#+end_src + +A ~header-block~ key applies to elements that concern the headings which +demarcate blocks in the structure of the agenda. By default (a ~nil~ +value) those are rendered in a bold typographic weight, plus a height +that is slightly taller than the default font size. Acceptable values +come in the form of a list that can include either or both of those +properties: + +- ~variable-pitch~ to use a proportionately spaced typeface; +- ~scale-title~ to increase the size to the number assigned to + ~modus-themes-scale-title~ ([[#h:6868baa1-beba-45ed-baa5-5fd68322ccb3][Control the scale of headings]]) or ~no-scale~ + to make the font use the same height as the rest of the buffer. + +In case both ~scale-title~ and ~no-scale~ are in the list, the latter takes +precedence. + +Example usage: + +#+begin_src emacs-lisp +(header-block . nil) +(header-block . (scale-title)) +(header-block . (no-scale)) +(header-block . (variable-pitch scale-title)) +#+end_src + +A ~header-date~ key covers date headings. Dates use only a foreground +color by default (a ~nil~ value), with weekdays and weekends having a +slight difference in hueness. The current date has an added gray +background. This key accepts a list of values that can include any of +the following properties: + +- ~grayscale~ to make weekdays use the main foreground color and + weekends a more subtle gray; +- ~workaholic~ to make weekdays and weekends look the same in + terms of color; +- ~bold-today~ to apply a bold typographic weight to the current + date; +- ~bold-all~ to render all date headings in a bold weight. + +For example: + +#+begin_src emacs-lisp +(header-date . nil) +(header-date . (workaholic)) +(header-date . (grayscale bold-all)) +(header-date . (grayscale workaholic)) +(header-date . (grayscale workaholic bold-today)) +#+end_src + +A ~scheduled~ key applies to tasks with a scheduled date. By default (a +~nil~ value), those use varying shades of yellow to denote (i) a past or +current date and (ii) a future date. Valid values are symbols: + +- nil (default); +- ~uniform~ to make all scheduled dates the same color; +- ~rainbow~ to use contrasting colors for past, present, future + scheduled dates. + +For example: + +#+begin_src emacs-lisp +(scheduled . nil) +(scheduled . uniform) +(scheduled . rainbow) +#+end_src + +A ~habit~ key applies to the ~org-habit~ graph. All possible value are +passed as a symbol. Those are: + +- The default (~nil~) is meant to conform with the original aesthetic of + ~org-habit~. It employs all four color codes that correspond to the + org-habit states---clear, ready, alert, and overdue---while + distinguishing between their present and future variants. This + results in a total of eight colors in use: red, yellow, green, blue, + in tinted and shaded versions. They cover the full set of information + provided by the ~org-habit~ consistency graph. +- ~simplified~ is like the default except that it removes the dichotomy + between current and future variants by applying uniform color-coded + values. It applies a total of four colors: red, yellow, green, blue. + They produce a simplified consistency graph that is more legible (or + less busy) than the default. The intent is to shift focus towards the + distinction between the four states of a habit task, rather than each + state's present/future outlook. +- ~traffic-light~ further reduces the available colors to red, yellow, and + green. As in ~simplified~, present and future variants appear + uniformly, but differently from it, the ~clear~ state is rendered in a + green hue, instead of the original blue. This is meant to capture the + use-case where a habit task being too early is less important than it + being too late. The difference between ready and clear states is + attenuated by painting both of them using shades of green. This + option thus highlights the alert and overdue states. +- ~traffic-light-deuteranopia~ is like the ~traffic-light~ except its three + colors are red, yellow, and blue to be suitable for users with + red-green color deficiency (deuteranopia). + +For example: + +#+begin_src emacs-lisp +(habit . nil) +(habit . simplified) +(habit . traffic-light) +#+end_src + +Putting it all together, the alist can look like this: + +#+begin_src emacs-lisp +'((header-block . (scale-title variable-pitch)) + (header-date . (grayscale workaholic bold-today)) + (scheduled . uniform) + (habit . traffic-light)) + +;; Or else: +(setq modus-themes-org-agenda + '((header-block . (scale-title variable-pitch)) + (header-date . (grayscale workaholic bold-today)) + (scheduled . uniform) + (habit . traffic-light))) +#+end_src + +** Option for the headings' overall style +:properties: +:alt_title: Heading styles +:description: Choose among several styles, also per heading level +:custom_id: h:271eff19-97aa-4090-9415-a6463c2f9ae1 +:end: +#+vindex: modus-themes-headings + +Symbol: ~modus-themes-headings~ + +This is an alist that accepts a =(key . list-of-values)= combination. The +key is either a number, representing the heading's level or ~t~, which +pertains to the fallback style. The list of values covers symbols that +refer to properties, as described below. Here is a sample, followed by +a presentation of all available properties: + +#+begin_src emacs-lisp +(setq modus-themes-headings + '((1 . (background overline)) + (2 . (overline rainbow)) + (t . (monochrome)))) +#+end_src + +Properties: + ++ ~rainbow~ ++ ~overline~ ++ ~background~ ++ ~no-bold~ ++ ~monochrome~ + +By default (a ~nil~ value for this variable), all headings have a bold +typographic weight and use a desaturated text color. + +A ~rainbow~ property makes the text color more saturated. + +An ~overline~ property draws a line above the area of the heading. + +A ~background~ property adds a subtle tinted color to the background of +the heading. + +A ~no-bold~ property removes the bold weight from the heading's text. + +A ~monochrome~ property makes all headings the same base color, which is +that of the default for the active theme (black/white). When ~background~ +is also set, ~monochrome~ changes its color to gray. If both ~monochrome~ +and ~rainbow~ are set, the former takes precedence. + +Combinations of any of those properties are expressed as a list, like in +these examples: + +#+begin_src emacs-lisp +(no-bold) +(rainbow background) +(overline monochrome no-bold) +#+end_src + +The order in which the properties are set is not significant. + +In user configuration files the form may look like this: + +#+begin_src emacs-lisp +(setq modus-themes-headings + '((1 . (background overline rainbow)) + (2 . (background overline)) + (t . (overline no-bold)))) +#+end_src + +When defining the styles per heading level, it is possible to pass a +non-nil value (~t~) instead of a list of properties. This will retain the +original aesthetic for that level. For example: + +#+begin_src emacs-lisp +(setq modus-themes-headings + '((1 . t) ; keep the default style + (2 . (background overline)) + (t . (rainbow)))) ; style for all other headings + +(setq modus-themes-headings + '((1 . (background overline)) + (2 . (rainbow no-bold)) + (t . t))) ; default style for all other levels +#+end_src + +For Org users, the extent of the heading depends on the variable +~org-fontify-whole-heading-line~. This affects the ~overline~ and +~background~ properties. Depending on the version of Org, there may be +others, such as ~org-fontify-done-headline~. + +[[#h:075eb022-37a6-41a4-a040-cc189f6bfa1f][Option for scaled headings]]. + +[[#h:97caca76-fa13-456c-aef1-a2aa165ea274][Option for variable-pitch font in headings]]. + +** Option for scaled headings +:properties: +:alt_title: Scaled headings +:description: Toggle scaling of headings +:custom_id: h:075eb022-37a6-41a4-a040-cc189f6bfa1f +:end: +#+vindex: modus-themes-scale-headings + +Symbol: ~modus-themes-scale-headings~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +The default is to use the same size for headings and paragraph text. + +With a non-nil value (~t~) make headings larger in height relative to the +main text. This is noticeable in modes like Org, Markdown, and Info. + +*** Control the scale of headings +:properties: +:alt_title: Scaled heading sizes +:description: Specify rate of increase for scaled headings +:custom_id: h:6868baa1-beba-45ed-baa5-5fd68322ccb3 +:end: + +In addition to the toggle for enabling scaled headings, users can also +specify a number of their own. + ++ If it is a floating point, say, =1.5=, it is interpreted as a multiple + of the base font size. This is the recommended method, because it + will always adapt to changes in the base font size, such as while + using the ~text-scale-adjust~ command. + ++ If it is an integer, it is read as an absolute font height that is + 1/10 of the typographic point size. Thus a value of =18pt= must be + expressed as =180=. Setting an absolute value is discouraged, as it + will break the layout in cases where the base font size must change, + such as with the ~text-scale-adjust~ command ([[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations]]). + While we discourage using absolute values, we still provide for this + option for users who do not need to perform text-scaling operations or + who are content with whatever discrepancies in height. + +Below are the variables in their default values, using the floating +point paradigm. The numbers are very conservative, but one is free to +change them to their liking, such as =1.2=, =1.4=, =1.6=, =1.8=, =2.0=---or use a +resource for finding a consistent scale: + +#+begin_src emacs-lisp +(setq modus-themes-scale-1 1.05 + modus-themes-scale-2 1.1 + modus-themes-scale-3 1.15 + modus-themes-scale-4 1.2 + modus-themes-scale-title 1.3) +#+end_src + +As for the application of that scale, the variables that range from +~modus-themes-scale-1~ up to ~modus-themes-scale-4~ apply to regular +headings within the context of the given major mode. The former is the +smallest, while the latter is the largest. "Regular headings" are those +that have a standard syntax for their scale, such as Org mode's eight +levels of asterisks or Markdown's six columns. + +Whereas ~modus-themes-scale-title~ is applied to special headings that do +not conform with the aforementioned syntax, yet which are expected to be +larger than the largest value on that implied scale or at least have +some unique purpose in the buffer. Put concretely, Org's =#+title= meta +datum is not part of the eight levels of headings in an Org file, yet is +supposed to signify the primary header. Similarly, the Org Agenda's +structure headings are not part of a recognisable scale and so they also +get ~modus-themes-scale-title~ ([[#h:68f481bc-5904-4725-a3e6-d7ecfa7c3dbc][Option for Org agenda constructs]]). + +Users who wish to maintain scaled headings for the normal syntax while +preventing special headings from standing out, can assign a value of =1.0= +to ~modus-themes-scale-title~ to make it the same as body text (or +whatever value would render it indistinguishable from the desired point +of reference). + +Note that in earlier versions of Org, scaling would only increase the +size of the heading, but not of keywords that were added to it, like +"TODO". The issue has been fixed upstream: +<https://protesilaos.com/codelog/2020-09-24-org-headings-adapt/>. + +** Option for variable-pitch font in UI elements +:properties: +:alt_title: UI typeface +:description: Toggle the use of variable-pitch across the User Interface +:custom_id: h:16cf666c-5e65-424c-a855-7ea8a4a1fcac +:end: +#+vindex: modus-themes-variable-pitch-ui + +Symbol: ~modus-themes-variable-pitch-ui~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +This option concerns User Interface elements that are under the direct +control of Emacs. In particular: the mode line, header line, tab bar, +and tab line. + +The default is to use the same font as the rest of Emacs, which usually +is a monospaced family. + +With a non-nil value (~t~) apply a proportionately spaced typeface. This +is done by assigning the ~variable-pitch~ face to the relevant items. + +[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + +** Option for variable-pitch font in headings +:properties: +:alt_title: Headings' typeface +:description: Toggle the use of variable-pitch in headings +:custom_id: h:97caca76-fa13-456c-aef1-a2aa165ea274 +:end: +#+vindex: modus-themes-variable-pitch-headings + +Symbol: ~modus-themes-variable-pitch-headings~ + +Possible values: + +1. ~nil~ (default) +2. ~t~ + +The default is to use the main font family, which typically is +monospaced. + +With a non-nil value (~t~) apply a proportionately spaced typeface, else +"variable-pitch", to headings (such as in Org mode). + +[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + +* Advanced customization (do-it-yourself) +:properties: +:custom_id: h:f4651d55-8c07-46aa-b52b-bed1e53463bb +:end: + +Unlike the predefined customization options which follow a clear pattern +of allowing the user to quickly specify their preference, the themes +also provide a more flexible, albeit difficult, mechanism to control +things with precision ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). + +This section is of interest only to users who are prepared to maintain +their own local tweaks and who are willing to deal with any possible +incompatibilities between versioned releases of the themes. As such, +they are labelled as "do-it-yourself" or "DIY". + +** Per-theme customization settings (DIY) +:properties: +:custom_id: h:a897b302-8e10-4a26-beab-3caaee1e1193 +:end: + +If you prefer to maintain different customization options between the +two themes, it is best you write your own functions that first set those +options and then load the relevant theme. The following code does +exactly that by simply differentiating the two themes on the choice of +bold constructs in code syntax (enabled for one, disabled for the +other). + +#+begin_src emacs-lisp +(defun my-demo-modus-operandi () + (interactive) + (setq modus-themes-bold-constructs t) ; ENABLE bold + (modus-themes-load-operandi)) + +(defun my-demo-modus-vivendi () + (interactive) + (setq modus-themes-bold-constructs nil) ; DISABLE bold + (modus-themes-load-vivendi)) + +(defun my-demo-modus-themes-toggle () + (if (eq (car custom-enabled-themes) 'modus-operandi) + (my-demo-modus-vivendi) + (my-demo-modus-operandi))) +#+end_src + +Then assign ~my-demo-modus-themes-toggle~ to a key instead of the +equivalent the themes provide. + +For a more elaborate design, it is better to inspect the source code of +~modus-themes-toggle~ and relevant functions. + +** Case-by-case face specs using the themes' palette (DIY) +:properties: +:custom_id: h:1487c631-f4fe-490d-8d58-d72ffa3bd474 +:end: +#+findex: modus-themes-color +#+findex: modus-themes-color-alts +#+cindex: Extracting individual colors + +This section is about tweaking individual faces. If you plan to do +things at scale, consult the next section: [[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Set multiple faces]]. + +We already covered in previous sections how to toggle between the themes +and how to configure options prior to loading. We also explained that +some of the functions made available to users will fire up a hook that +can be used to pass tweaks in the post-theme-load phase. + +Now assume you wish to change a single face, say, the ~cursor~. And you +would like to get the standard "blue" color value of the active Modus +theme, whether it is Modus Operandi or Modus Vivendi. To do that, you +can use the ~modus-themes-color~ function. It accepts a symbol that is +associated with a color in ~modus-themes-operandi-colors~ and +~modus-themes-vivendi-colors~. Like this: + +#+begin_src emacs-lisp +(modus-themes-color 'blue) +#+end_src + +The function always extracts the color value of the active Modus theme. + +#+begin_src emacs-lisp +(progn + (load-theme 'modus-operandi t) + (modus-themes-color 'blue)) ; "#0031a9" for `modus-operandi' + +(progn + (load-theme 'modus-vivendi t) + (modus-themes-color 'blue)) ; "#2fafff" for `modus-vivendi' +#+end_src + +Do {{{kbd(C-h v)}}} on the aforementioned variables to check all the available +symbols that can be passed to this function. + +With that granted, let us expand the example to actually change the +~cursor~ face's background property. We employ the built-in function of +~set-face-attribute~: + +#+begin_src emacs-lisp +(set-face-attribute 'cursor nil :background (modus-themes-color 'blue)) +#+end_src + +If you evaluate this form, your cursor will become blue. But if you +change themes, such as with ~modus-themes-toggle~, your edits will be +lost, because the newly loaded theme will override the ~:background~ +attribute you had assigned to that face. + +For such changes to persist, we need to make them after loading the +theme. So we rely on ~modus-themes-after-load-theme-hook~, which gets +called from ~modus-themes-load-operandi~, ~modus-themes-load-vivendi~, as +well as the command ~modus-themes-toggle~. Here is a sample function that +tweaks two faces and then gets added to the hook: + +#+begin_src emacs-lisp +(defun my-modus-themes-custom-faces () + (set-face-attribute 'cursor nil :background (modus-themes-color 'blue)) + (set-face-attribute 'font-lock-type-face nil :foreground (modus-themes-color 'magenta-alt))) + +(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) +#+end_src + +[[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]. + +Using this principle, it is possible to override the styles of faces +without having to find color values for each case. + +Another application is to control the precise weight for bold +constructs. This is particularly useful if your typeface has several +variants such as "heavy", "extrabold", "semibold". All you have to do +is edit the ~bold~ face. For example: + +#+begin_src emacs-lisp +(set-face-attribute 'bold nil :weight 'semibold) +#+end_src + +Remember to use the custom function and hook combo we demonstrated +above. Because the themes do not hard-wire a specific weight, this +simple form is enough to change the weight of all bold constructs +throughout the interface. + +Finally, there are cases where you want to tweak colors though wish to +apply different ones to each theme, say, a blue hue for Modus Operandi +and a shade of red for Modus Vivendi. To this end, we provide +~modus-themes-color-alts~ as a convenience function to save you from the +trouble of writing separate wrappers for each theme. It still returns a +single value by querying either of ~modus-themes-operandi-colors~ and +~modus-themes-vivendi-colors~, only here you pass the two keys you want, +first for ~modus-operandi~ then ~modus-vivendi~. + +Take the previous example with the ~cursor~ face: + +#+begin_src emacs-lisp +;; Blue for `modus-operandi' and red for `modus-vivendi' +(set-face-attribute 'cursor nil :background (modus-themes-color-alts 'blue 'red)) +#+end_src + +** Face specs at scale using the themes' palette (DIY) +:properties: +:custom_id: h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae +:end: +#+findex: modus-themes-with-colors +#+cindex: Extracting colors en masse + +The examples here are for large scale operations. For simple, one-off +tweaks, you may prefer the approach documented in the previous section +([[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]). + +The ~modus-themes-with-colors~ macro lets you retrieve multiple color +values by employing the backquote/backtick and comma notation. The +values are stored in the alists ~modus-themes-operandi-colors~ and +~modus-themes-vivendi-colors~, while the macro always queries that of the +active Modus theme. + +Here is an abstract example that just returns a list of color values +while ~modus-operandi~ is enabled: + +#+begin_src emacs-lisp +(modus-themes-with-colors + (list fg-main + blue-faint + magenta + magenta-alt-other + cyan-alt-other + fg-special-cold + blue-alt + magenta-faint + cyan + fg-main + green-faint + red-alt-faint + blue-alt-faint + fg-special-warm + cyan-alt + blue)) +;; => +;; ("#000000" "#002f88" "#721045" "#5317ac" +;; "#005a5f" "#093060" "#2544bb" "#752f50" +;; "#00538b" "#000000" "#104410" "#702f00" +;; "#003f78" "#5d3026" "#30517f" "#0031a9") +#+end_src + +Getting a list of colors may have its applications, though what you are +most likely interested in is how to use those variables to configure +several faces at once. To do so we can rely on the built-in +~custom-set-faces~ function, which sets face specifications for the +special ~user~ theme. That "theme" gets applied on top of regular themes +like ~modus-operandi~ and ~modus-vivendi~. + +This is how it works: + +#+begin_src emacs-lisp +(modus-themes-with-colors + (custom-set-faces + `(cursor ((,class :background ,blue))) + `(mode-line ((,class :background ,yellow-nuanced-bg + :foreground ,yellow-nuanced-fg))) + `(mode-line-inactive ((,class :background ,blue-nuanced-bg + :foreground ,blue-nuanced-fg))))) +#+end_src + +The above snippet will immediately refashion the faces it names once it +is evaluated. However, if you switch between the Modus themes, say, +from ~modus-operandi~ to ~modus-vivendi~, the colors will not get updated to +match those of the new theme. To make things work across the themes, we +need to employ the same technique we discussed in the previous section, +namely, to pass our changes at the post-theme-load phase via a hook. + +The themes provide the ~modus-themes-after-load-theme-hook~, which gets +called from ~modus-themes-load-operandi~, ~modus-themes-load-vivendi~, as +well as the command ~modus-themes-toggle~. With this knowledge, you can +wrap the macro in a function and then assign that function to the hook. +Thus: + +#+begin_src emacs-lisp +(defun my-modus-themes-custom-faces () + (modus-themes-with-colors + (custom-set-faces + `(cursor ((,class :background ,blue))) + `(mode-line ((,class :background ,yellow-nuanced-bg + :foreground ,yellow-nuanced-fg))) + `(mode-line-inactive ((,class :background ,blue-nuanced-bg + :foreground ,blue-nuanced-fg)))))) + +(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) +#+end_src + +[[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]. + +To discover the faces defined by all loaded libraries, you may do +{{{kbd(M-x list-faces-display)}}}. Be warned that when you ~:inherit~ a face +you are introducing an implicit dependency, so try to avoid doing so for +libraries other than the built-in {{{file(faces.el)}}} (or at least understand +that things may break if you inherit from a yet-to-be-loaded face). + +Also bear in mind that these examples are meant to work with the Modus +themes. If you are cycling between multiple themes you may encounter +unforeseen issues, such as the colors of the Modus themes being applied +to a non-Modus item. + +Finally, note that you can still use other functions where those make +sense. For example, the ~modus-themes-color-alts~ that was discussed in +the previous section. Adapt the above example like this: + +#+begin_src emacs-lisp +... +(modus-themes-with-colors + (custom-set-faces + `(cursor ((,class :background ,(modus-themes-color-alts 'blue 'green)))) + ...)) +#+end_src + +** Remap face with local value (DIY) +:properties: +:custom_id: h:7a93cb6f-4eca-4d56-a85c-9dcd813d6b0f +:end: +#+cindex: Remapping faces + +There are cases where we need to change the buffer-local attributes of a +face. This might be because we have our own minor mode that re-uses a +face for a particular purpose, such as a line selection tool that +activates ~hl-line-mode~, but we wish to keep it distinct from other +buffers. This is where ~face-remap-add-relative~ can be applied and may +be combined with ~modus-themes-with-colors~ to deliver consistent results. + +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. + +In this example we will write a simple interactive function that adjusts +the background color of the ~region~ face. This is the sample code: + +#+begin_src emacs-lisp +(defvar my-rainbow-region-colors + (modus-themes-with-colors + `((red . ,red-subtle-bg) + (green . ,green-subtle-bg) + (yellow . ,yellow-subtle-bg) + (blue . ,blue-subtle-bg) + (magenta . ,magenta-subtle-bg) + (cyan . ,cyan-subtle-bg))) + "Sample list of color values for `my-rainbow-region'.") + +(defun my-rainbow-region (color) + "Remap buffer-local attribute of `region' using COLOR." + (interactive + (list + (completing-read "Pick a color: " my-rainbow-region-colors))) + (face-remap-add-relative + 'region + `( :background ,(alist-get (intern color) my-rainbow-region-colors) + :foreground ,(face-attribute 'default :foreground)))) +#+end_src + +When ~my-rainbow-region~ is called interactively, it prompts for a color +to use. The list of candidates is drawn from the car of each +association in ~my-rainbow-region-colors~ (so "red", "green", etc.). + +To extend this principle, we may write wrapper functions that pass a +color directly. Those can be useful in tandem with hooks. Consider +this example: + +#+begin_src emacs-lisp +(defun my-rainbow-region-magenta () + (my-rainbow-region 'magenta)) + +(add-hook 'diff-mode-hook #'my-rainbow-region-magenta) +#+end_src + +Whenever we enter a ~diff-mode~ buffer, we now get a magenta-colored +region. + +Perhaps you may wish to generalise those findings in to a set of +functions that also accept an arbitrary face. We shall leave the +experimentation up to you. + +** Cycle through arbitrary colors (DIY) +:properties: +:custom_id: h:77dc4a30-b96a-4849-85a8-fee3c2995305 +:end: +#+cindex: Cycle colors + +Users may opt to customize individual faces of the themes to accommodate +their particular needs. One such case is with the color intensity of +comments, specifically the foreground of ~font-lock-comment-face~. The +Modus themes set that to a readable value, in accordance with their +accessibility objective, though users may prefer to lower the overall +contrast on an on-demand basis. + +One way to achieve this is to design a command that cycles through three +distinct levels of intensity, though the following can be adapted to any +kind of cyclic behaviour, such as to switch between red, green, and +blue. + +In the following example, we employ the ~modus-themes-color~ function +which reads a symbol that represents an entry in the active theme's +color palette ([[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]). +Those are stored in ~my-modus-themes-comment-colors~. + +#+begin_src emacs-lisp +(defvar my-modus-themes-comment-colors + ;; We are abusing the palette here, as those colors have their own + ;; purpose in the palette, so please ignore the semantics of their + ;; names. + '((low . bg-region) + (medium . bg-tab-inactive-alt) + (high . fg-alt)) + "Alist of levels of intensity mapped to color palette entries. +The entries are found in `modus-themes-operandi-colors' or +`modus-themes-vivendi-colors'.") + +(defvar my-modus-themes--adjust-comment-color-state nil + "The cyclic state of `my-modus-themes-adjust-comment-color'. +For internal use.") + +(defun my-modus-themes--comment-foreground (degree state) + "Set `font-lock-comment-face' foreground. +Use `my-modus-themes-comment-colors' to extract the color value +for each level of intensity. + +This is complementary to `my-modus-themes-adjust-comment-color'." + (let ((palette-colors my-modus-themes-comment-colors)) + (set-face-foreground + 'font-lock-comment-face + (modus-themes-color (alist-get degree palette-colors))) + (setq my-modus-themes--adjust-comment-color-state state) + (message "Comments are set to %s contrast" degree))) + +(defun my-modus-themes-adjust-comment-color () + "Cycle through levels of intensity for comments. +The levels are determined by `my-modus-themes-comment-colors'." + (interactive) + (pcase my-modus-themes--adjust-comment-color-state + ('nil + (my-modus-themes--comment-foreground 'low 1)) + (1 + (my-modus-themes--comment-foreground 'medium 2)) + (_ + (my-modus-themes--comment-foreground 'high nil)))) +#+end_src + +With the above, {{{kbd(M-x my-modus-themes-adjust-comment-color)}}} will cycle +through the three levels of intensity that have been specified. + +Another approach is to not read from the active theme's color palette +and instead provide explicit color values, either in hexadecimal RGB +notation (like =#123456=) or as the names that are displayed in the output +of {{{kbd(M-x list-colors-display)}}}. In this case, the alist with the +colors will have to account for the active theme, so as to set the +appropriate colors. While this introduces a bit more complexity, it +ultimately offers greater flexibility on the choice of colors for such a +niche functionality (so there is no need to abuse the palette of the +active Modus theme): + +#+begin_src emacs-lisp +(defvar my-modus-themes-comment-colors + '((light . ((low . "gray75") + (medium . "gray50") + (high . "#505050"))) ; the default for `modus-operandi' + + (dark . ((low . "gray25") + (medium . "gray50") + (high . "#a8a8a8")))) ; the default for `modus-vivendi' + "Alist of levels of intensity mapped to color values. +For such colors, consult the command `list-colors-display'. Pass +the name of a color or its hex value.") + +(defvar my-modus-themes--adjust-comment-color-state nil + "The cyclic state of `my-modus-themes-adjust-comment-color'. +For internal use.") + +(defun my-modus-themes--comment-foreground (degree state) + "Set `font-lock-comment-face' foreground. +Use `my-modus-themes-comment-colors' to extract the color value +for each level of intensity. + +This is complementary to `my-modus-themes-adjust-comment-color'." + (let* ((colors my-modus-themes-comment-colors) + (levels (pcase (car custom-enabled-themes) + ('modus-operandi (alist-get 'light colors)) + ('modus-vivendi (alist-get 'dark colors))))) + (set-face-foreground + 'font-lock-comment-face + (alist-get degree levels)) + (setq my-modus-themes--adjust-comment-color-state state) + (message "Comments are set to %s contrast" degree))) + +(defun my-modus-themes-adjust-comment-color () + "Cycle through levels of intensity for comments. +The levels are determined by `my-modus-themes-comment-colors'." + (interactive) + (pcase my-modus-themes--adjust-comment-color-state + ('nil + (my-modus-themes--comment-foreground 'low 1)) + (1 + (my-modus-themes--comment-foreground 'medium 2)) + (_ + (my-modus-themes--comment-foreground 'high nil)))) +#+end_src + +The effect of the above configurations on ~font-lock-comment-face~ is +global. To make it buffer-local, one must tweak the code to employ the +function ~face-remap-add-relative~ ([[#h:7a93cb6f-4eca-4d56-a85c-9dcd813d6b0f][Remap face with local value]]). + +So this form in ~my-modus-themes--comment-foreground~: + +#+begin_src emacs-lisp +;; example 1 +(... + (set-face-foreground + 'font-lock-comment-face + (modus-themes-color (alist-get degree palette-colors))) + ...) + +;; example 2 +(... + (set-face-foreground + 'font-lock-comment-face + (alist-get degree levels)) + ...) +#+end_src + +Must become this: + +#+begin_src emacs-lisp +;; example 1 +(... + (face-remap-add-relative + 'font-lock-comment-face + `(:foreground ,(modus-themes-color (alist-get degree palette-colors)))) + ...) + +;; example 2 +(... + (face-remap-add-relative + 'font-lock-comment-face + `(:foreground ,(alist-get degree levels))) + ...) +#+end_src + +** Override colors (DIY) +:properties: +:custom_id: h:307d95dd-8dbd-4ece-a543-10ae86f155a6 +:end: +#+vindex: modus-themes-operandi-color-overrides +#+vindex: modus-themes-vivendi-color-overrides +#+cindex: Change a theme's colors + +The themes provide a mechanism for overriding their color values. This +is controlled by the variables ~modus-themes-operandi-color-overrides~ and +~modus-themes-vivendi-color-overrides~, which are alists that should +mirror a subset of the associations in ~modus-themes-operandi-colors~ and +~modus-themes-vivendi-colors~ respectively. As with all customisations, +overriding must be done before loading the affected theme. + +Let us approach the present topic one step at a time. Here is a +simplified excerpt of the default palette for Modus Operandi with some +basic background values that apply to buffers and the mode line +(remember to inspect the actual value to find out all the associations +that can be overridden): + +#+begin_src emacs-lisp +(defconst modus-themes-operandi-colors + '((bg-main . "#ffffff") + (bg-dim . "#f8f8f8") + (bg-alt . "#f0f0f0") + (bg-active . "#d7d7d7") + (bg-inactive . "#efefef"))) +#+end_src + +As one can tell, we bind a key to a hexadecimal RGB color value. Now +say we wish to override those specific values and have our changes +propagate to all faces that use those keys. We could write something +like this, which adds a subtle ochre tint: + +#+begin_src emacs-lisp +(setq modus-themes-operandi-color-overrides + '((bg-main . "#fefcf4") + (bg-dim . "#faf6ef") + (bg-alt . "#f7efe5") + (bg-active . "#e8dfd1") + (bg-inactive . "#f6ece5"))) +#+end_src + +Once this is evaluated, any subsequent loading of ~modus-operandi~ will +use those values instead of the defaults. No further intervention is +required. + +To reset the changes, we apply this and reload the theme: + +#+begin_src emacs-lisp +(setq modus-themes-operandi-color-overrides nil) +#+end_src + +Users who wish to leverage such a mechanism can opt to implement it +on-demand by means of a global minor mode. The following snippet covers +both themes and expands to some more assosiations in the palette: + +#+begin_src emacs-lisp +(define-minor-mode my-modus-themes-tinted + "Tweak some Modus themes colors." + :init-value nil + :global t + (if my-modus-themes-tinted + (setq modus-themes-operandi-color-overrides + '((bg-main . "#fefcf4") + (bg-dim . "#faf6ef") + (bg-alt . "#f7efe5") + (bg-hl-line . "#f4f0e3") + (bg-active . "#e8dfd1") + (bg-inactive . "#f6ece5") + (bg-region . "#c6bab1") + (bg-header . "#ede3e0") + (bg-tab-bar . "#dcd3d3") + (bg-tab-active . "#fdf6eb") + (bg-tab-inactive . "#c8bab8") + (fg-unfocused . "#55556f")) + modus-themes-vivendi-color-overrides + '((bg-main . "#100b17") + (bg-dim . "#161129") + (bg-alt . "#181732") + (bg-hl-line . "#191628") + (bg-active . "#282e46") + (bg-inactive . "#1a1e39") + (bg-region . "#393a53") + (bg-header . "#202037") + (bg-tab-bar . "#262b41") + (bg-tab-active . "#120f18") + (bg-tab-inactive . "#3a3a5a") + (fg-unfocused . "#9a9aab"))) + (setq modus-themes-operandi-color-overrides nil + modus-themes-vivendi-color-overrides nil))) +#+end_src + +With this in place, one can invoke {{{kbd(M-x my-modus-themes-tinted)}}} and +then load the Modus theme of their choice. The new palette subset will +come into effect: subtle ochre tints for Modus Operandi and night sky +shades for Modus Vivendi. Switching between the two themes, such as +with {{{kbd(M-x modus-themes-toggle)}}} will also use the overrides. + +Given that this is a user-level customisation, one is free to implement +whatever color values they desire, even if the possible combinations +fall below the minimum 7:1 contrast ratio that governs the design of the +themes (the WCAG AAA legibility standard). Alternatively, this can also +be done programmatically ([[#h:4589acdc-2505-41fc-9f5e-699cfc45ab00][Override color saturation]]). + +For manual interventions it is advised to inspect the source code of +~modus-themes-operandi-colors~ and ~modus-themes-vivendi-colors~ for the +inline commentary: it explains what the intended use of each palette +subset is. + +Furthermore, users may benefit from the ~modus-themes-contrast~ function +that we provide: [[#h:02e25930-e71a-493d-828a-8907fc80f874][test color combinations]]. It measures the contrast +ratio between two color values, so it can help in overriding the palette +(or a subset thereof) without making the end result inaccessible. + +** Override color saturation (DIY) +:properties: +:custom_id: h:4589acdc-2505-41fc-9f5e-699cfc45ab00 +:end: +#+cindex: Change a theme's color saturation + +In the previous section we documented how one can override color values +manually ([[#h:307d95dd-8dbd-4ece-a543-10ae86f155a6][Override colors]]). Here we use a programmatic approach which +leverages the built-in ~color-saturate-name~ function to adjust the +saturation of all color values used by the active Modus theme. Our goal +is to prepare a counterpart of the active theme's palette that holds +modified color values, adjusted for a percent change in saturation. A +positive number amplifies the effect, while a negative one will move +towards a grayscale spectrum. + +We start with a function that can be either called from Lisp or invoked +interactively. In the former scenario, we pass to it the rate of change +we want. While in the latter, a minibuffer prompt asks for a number to +apply the desired effect. In either case, we intend to assign anew the +value of ~modus-themes-operandi-color-overrides~ (light theme) and the +same for ~modus-themes-vivendi-color-overrides~ (dark theme). + +#+begin_src emacs-lisp +(defun my-modus-themes-saturate (percent) + "Saturate current Modus theme palette overrides by PERCENT." + (interactive + (list (read-number "Saturation by percent: "))) + (let* ((theme (modus-themes--current-theme)) + (palette (pcase theme + ('modus-operandi modus-themes-operandi-colors) + ('modus-vivendi modus-themes-vivendi-colors) + (_ (error "No Modus theme is active")))) + (overrides (pcase theme + ('modus-operandi 'modus-themes-operandi-color-overrides) + ('modus-vivendi 'modus-themes-vivendi-color-overrides) + (_ (error "No Modus theme is active"))))) + (let (name cons colors) + (dolist (cons palette) + (setq name (color-saturate-name (cdr cons) percent)) + (setq name (format "%s" name)) + (setq cons `(,(car cons) . ,name)) + (push cons colors)) + (set overrides colors)) + (pcase theme + ('modus-operandi (modus-themes-load-operandi)) + ('modus-vivendi (modus-themes-load-vivendi))))) + +;; sample Elisp calls (or call `my-modus-themes-saturate' interactively) +(my-modus-themes-saturate 50) +(my-modus-themes-saturate -75) +#+end_src + +Using the above has an immediate effect, as it reloads the active Modus +theme. + +The =my-modus-themes-saturate= function stores new color values in the +variables =modus-themes-operandi-color-overrides= and +=modus-themes-vivendi-color-overrides=, meaning that it undoes changes +implemented by the user on individual colors. To have both automatic +saturation adjustment across the board and retain per-case edits to the +palette, some tweaks to the above function are required. For example: + +#+begin_src emacs-lisp +(defvar my-modus-themes-vivendi-extra-color-overrides + '((fg-main . "#ead0c0") + (bg-main . "#050515")) + "My bespoke colors for `modus-vivendi'.") + +(defvar my-modus-themes-operandi-extra-color-overrides + '((fg-main . "#1a1a1a") + (bg-main . "#fefcf4")) + "My bespoke colors for `modus-operandi'.") + +(defun my-modus-themes-saturate (percent) + "Saturate current Modus theme palette overrides by PERCENT. +Preserve the color values stored in +`my-modus-themes-operandi-extra-color-overrides', +`my-modus-themes-vivendi-extra-color-overrides'." + (interactive + (list (read-number "Saturation by percent: "))) + (let* ((theme (modus-themes--current-theme)) + (palette (pcase theme + ('modus-operandi modus-themes-operandi-colors) + ('modus-vivendi modus-themes-vivendi-colors) + (_ (error "No Modus theme is active")))) + (overrides (pcase theme + ('modus-operandi 'modus-themes-operandi-color-overrides) + ('modus-vivendi 'modus-themes-vivendi-color-overrides) + (_ (error "No Modus theme is active")))) + (extra-overrides (pcase theme + ('modus-operandi my-modus-themes-operandi-extra-color-overrides) + ('modus-vivendi my-modus-themes-vivendi-extra-color-overrides) + (_ (error "No Modus theme is active"))))) + (let (name cons colors) + (dolist (cons palette) + (setq name (color-saturate-name (cdr cons) percent)) + (setq name (format "%s" name)) + (setq cons `(,(car cons) . ,name)) + (push cons colors)) + (set overrides (append extra-overrides colors))) + (pcase theme + ('modus-operandi (modus-themes-load-operandi)) + ('modus-vivendi (modus-themes-load-vivendi))))) +#+end_src + +To disable the effect, one must reset the aforementioned variables of +the themes to ~nil~. Or specify a command for it, such as by taking +inspiration from the ~modus-themes-toggle~ we already provide: + +#+begin_src emacs-lisp +(defun my-modus-themes-revert-overrides () + "Reset palette overrides and reload active Modus theme." + (interactive) + (setq modus-themes-operandi-color-overrides nil + modus-themes-vivendi-color-overrides nil) + (pcase (modus-themes--current-theme) + ('modus-operandi (modus-themes-load-operandi)) + ('modus-vivendi (modus-themes-load-vivendi)))) +#+end_src + +** Font configurations for Org and others (DIY) +:properties: +:custom_id: h:defcf4fc-8fa8-4c29-b12e-7119582cc929 +:end: +#+cindex: Font configurations + +The themes are designed to cope well with mixed font configurations. + +[[#h:115e6c23-ee35-4a16-8cef-e2fcbb08e28b][Option for no font mixing]]. + +This mostly concerns ~org-mode~ and ~markdown-mode~, though expect to find +it elsewhere like in ~Info-mode~. + +In practice it means that the user can safely opt for a more +prose-friendly proportionately spaced typeface as their default, while +letting spacing-sensitive elements like tables and inline code always +use a monospaced font, by inheriting from the ~fixed-pitch~ face. + +Users can try the built-in {{{kbd(M-x variable-pitch-mode)}}} to see the +effect in action. + +To make everything use your desired font families, you need to configure +the ~variable-pitch~ (proportional spacing) and ~fixed-pitch~ (monospaced) +faces respectively. It may also be convenient to set your main typeface +by configuring the ~default~ face the same way. + +Put something like this in your initialization file (also consider +reading the doc string of ~set-face-attribute~): + +#+begin_src emacs-lisp +;; Main typeface +(set-face-attribute 'default nil :family "DejaVu Sans Mono" :height 110) + +;; Proportionately spaced typeface +(set-face-attribute 'variable-pitch nil :family "DejaVu Serif" :height 1.0) + +;; Monospaced typeface +(set-face-attribute 'fixed-pitch nil :family "DejaVu Sans Mono" :height 1.0) +#+end_src + +The next section shows how to make those work in a more elaborate setup +that is robust to changes between the Modus themes. + +[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. + +Note the differences in the ~:height~ property. The ~default~ face must +specify an absolute value, which is the point size × 10. So if you want +to use a font at point size =11=, you set the height to =110=.[fn:: ~:height~ +values do not need to be rounded to multiples of ten: the likes of =115= +are perfectly valid—some typefaces will change to account for those +finer increments.] Whereas every other face must have a value that is +relative to the default, represented as a floating point (if you use an +integer, then that means an absolute height). This is of paramount +importance: it ensures that all fonts can scale gracefully when using +something like the ~text-scale-adjust~ command which only operates on the +base font size (i.e. the ~default~ face's absolute height). + +[[#h:e6c5451f-6763-4be7-8fdb-b4706a422a4c][Note for EWW and Elfeed fonts (SHR fonts)]]. + +** Configure bold and italic faces (DIY) +:properties: +:custom_id: h:2793a224-2109-4f61-a106-721c57c01375 +:end: +#+cindex: Bold and italic fonts + +The Modus themes do not hardcode a ~:weight~ or ~:slant~ attribute in the +thousands of faces they cover. Instead, they configure the generic +faces called ~bold~ and ~italic~ to use the appropriate styles and then +instruct all relevant faces that require emphasis to inherit from them. + +This practically means that users can change the particularities of what +it means for a construct to be bold/italic, by tweaking the ~bold~ and +~italic~ faces. Cases where that can be useful include: + ++ The default typeface does not have a variant with slanted glyphs + (e.g. Fira Mono/Code as of this writing on 2021-07-07), so the user + wants to add another family for the italics, such as Hack. + ++ The typeface of choice provides a multitude of weights and the user + prefers the light one by default. To prevent the bold weight from + being too heavy compared to the light one, they opt to make ~bold~ use a + semibold weight. + ++ The typeface distinguishes between oblique and italic forms by + providing different font variants (the former are just slanted + versions of the upright forms, while the latter have distinguishing + features as well). In this case, the user wants to specify the font + that applies to the ~italic~ face. + +To achieve those effects, one must first be sure that the fonts they use +have support for those features. It then is a matter of following the +instructions for all face tweaks. + +[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + +In this example, we set the default font family to Fira Code, while we +choose to render italics in the Hack typeface (obviously you need to +pick fonts that work well together): + +#+begin_src emacs-lisp +(set-face-attribute 'default nil :family "Fira Code" :height 110) +(set-face-attribute 'italic nil :family "Hack") +#+end_src + +And here we play with different weights, using Source Code Pro: + +#+begin_src emacs-lisp +(set-face-attribute 'default nil :family "Source Code Pro" :height 110 :weight 'light) +(set-face-attribute 'bold nil :weight 'semibold) +#+end_src + +To reset the font family, one can use this: + +#+begin_src emacs-lisp +(set-face-attribute 'italic nil :family 'unspecified) +#+end_src + +To ensure that the effects persist after switching between the Modus +themes (such as with {{{kbd(M-x modus-themes-toggle)}}}), the user needs to +write their configurations to a function and hook it up to the +~modus-themes-after-load-theme-hook~. This is necessary because the +themes set the default styles of faces (otherwise changing themes would +not be possible). + +[[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]. + +This is a minimal setup to preserve font configurations across theme +load phases. For a more permanent setup, it is better to employ the +~custom-set-faces~ function: ~set-face-attribute~ works just fine, though it +is more convenient for quick previews or for smaller scale operations +(~custom-set-faces~ follows the format used in the source code of the +themes). + +#+begin_src emacs-lisp +;; our generic function +(defun my-modes-themes-bold-italic-faces () + (set-face-attribute 'default nil :family "Source Code Pro" :height 110) + (set-face-attribute 'bold nil :weight 'semibold)) + +;; or use this if you configure a lot of face and attributes and +;; especially if you plan to use `modus-themes-with-colors', as shown +;; elsewhere in the manual +(defun my-modes-themes-bold-italic-faces () + (custom-set-faces + '(default ((t :family "Source Code Pro" :height 110))) + '(bold ((t :weight semibold))))) + +;; and here is the hook +(add-hook 'modus-themes-after-load-theme-hook #'my-modes-themes-bold-italic-faces) +#+end_src + +** Custom Org user faces (DIY) +:properties: +:custom_id: h:89f0678d-c5c3-4a57-a526-668b2bb2d7ad +:end: +#+cindex: Org extra faces + +Users of ~org-mode~ have the option to configure various keywords and +priority cookies to better match their workflow. User options are +~org-todo-keyword-faces~ and ~org-priority-faces~. + +As those are meant to be custom faces, it is futile to have the themes +guess what each user wants to use, which keywords to target, and so on. +Instead, we can provide guidelines on how to customize things to one's +liking with the intent of retaining the overall aesthetic of the themes. + +Please bear in mind that the end result of those is not controlled by +the active Modus theme but by how Org maps faces to its constructs. +Editing those while ~org-mode~ is active requires re-initialization of the +mode with {{{kbd(M-x org-mode-restart)}}} for changes to take effect. + +Let us assume you wish to visually differentiate your keywords. You +have something like this: + +#+begin_src emacs-lisp +(setq org-todo-keywords + '((sequence "TODO(t)" "|" "DONE(D)" "CANCEL(C)") + (sequence "MEET(m)" "|" "MET(M)") + (sequence "STUDY(s)" "|" "STUDIED(S)") + (sequence "WRITE(w)" "|" "WROTE(W)"))) +#+end_src + +You could then use a variant of the following to inherit from a face +that uses the styles you want and also to preserve the properties +applied by the ~org-todo~ face (in case there is a difference between the +two): + +#+begin_src emacs-lisp +(setq org-todo-keyword-faces + '(("MEET" . '(font-lock-preprocessor-face org-todo)) + ("STUDY" . '(font-lock-variable-name-face org-todo)) + ("WRITE" . '(font-lock-type-face org-todo)))) +#+end_src + +This will refashion the keywords you specify, while letting the other +items in ~org-todo-keywords~ use their original styles (which are defined +in the ~org-todo~ and ~org-done~ faces). + +If you want back the defaults, try specifying just the ~org-todo~ face: + +#+begin_src emacs-lisp +(setq org-todo-keyword-faces + '(("MEET" . org-todo) + ("STUDY" . org-todo) + ("WRITE" . org-todo))) +#+end_src + +When you inherit from multiple faces, you need to quote the list as +shown further above. The order is significant: the first entry is +applied on top of the second, overriding any properties that are +explicitly set for both of them: any property that is not specified is +not overridden, so, for example, if ~org-todo~ has a background and a +foreground, while ~font-lock-type-face~ only has a foreground, the merged +face will include the background of the former and the foreground of the +latter. If you do not want to blend multiple faces, you do not need a +quoted list. A pattern of =keyword . face= will suffice. + +Both approaches can be used simultaneously, as illustrated in this +configuration of the priority cookies: + +#+begin_src emacs-lisp +(setq org-priority-faces + '((?A . '(org-scheduled-today org-priority)) + (?B . org-priority) + (?C . '(shadow org-priority)))) +#+end_src + +To find all the faces that are loaded in your current Emacs session, use +{{{kbd(M-x list-faces-display)}}}. Try {{{kbd(M-x describe-variable)}}} as well and +then specify the name of each of those Org variables demonstrated above. +Their documentation strings will offer you further guidance. + +Recall that the themes let you retrieve a color from their palette. Do +it if you plan to control face attributes. + +[[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Custom face specs using the themes' palette]]. + +[[#h:02e25930-e71a-493d-828a-8907fc80f874][Check color combinations]]. + +** Update Org block delimiter fontification (DIY) +:properties: +:custom_id: h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50 +:end: + +As noted in the section about ~modus-themes-org-blocks~, Org contains a +variable that determines whether the block's begin and end lines are +extended to the edge of the window ([[#h:b7e328c0-3034-4db7-9cdf-d5ba12081ca2][Option for org-mode block styles]]). +The variable is ~org-fontify-whole-block-delimiter-line~. + +Users who change the style of Org blocks from time to time may prefer to +automatically update delimiter line fontification, such as with the +following setup: + +#+begin_src emacs-lisp +(defun my-modus-themes-org-fontify-block-delimiter-lines () + "Match `org-fontify-whole-block-delimiter-line' to theme style. +Run this function at the post theme load phase, such as with the +`modus-themes-after-load-theme-hook'." + (if (eq modus-themes-org-blocks 'gray-background) + (setq org-fontify-whole-block-delimiter-line t) + (setq org-fontify-whole-block-delimiter-line nil))) + +(add-hook 'modus-themes-after-load-theme-hook + #'my-modus-themes-org-fontify-block-delimiter-lines) +#+end_src + +Then {{{kbd(M-x org-mode-restart)}}} for changes to take effect, though manual +intervention can be circumvented by tweaking the function thus: + +#+begin_src emacs-lisp +(defun my-modus-themes-org-fontify-block-delimiter-lines () + "Match `org-fontify-whole-block-delimiter-line' to theme style. +Run this function at the post theme load phase, such as with the +`modus-themes-after-load-theme-hook'." + (if (eq modus-themes-org-blocks 'gray-background) + (setq org-fontify-whole-block-delimiter-line t) + (setq org-fontify-whole-block-delimiter-line nil)) + (when (derived-mode-p 'org-mode) + (font-lock-flush))) +#+end_src + +** Measure color contrast (DIY) +:properties: +:custom_id: h:02e25930-e71a-493d-828a-8907fc80f874 +:end: +#+findex: modus-themes-contrast +#+findex: modus-themes-wcag-formula +#+cindex: Color contrast + +The themes provide the functions ~modus-themes-wcag-formula~ and +~modus-themes-contrast~. The former is a direct implementation of the +WCAG formula: <https://www.w3.org/TR/WCAG20-TECHS/G18.html>. It +calculates the relative luminance of a color value that is expressed in +hexadecimal RGB notation. While the latter function is just a +convenient wrapper for comparing the relative luminance between two +colors. + +In practice, one needs to work only with ~modus-themes-contrast~. It +accepts two color values and returns their contrast ratio. Values range +from 1 to 21 (lowest to highest). The themes are designed to always be +equal or higher than 7 for each combination of background and foreground +that they use (this is the WCAG AAA standard---the most demanding of its +kind). + +A couple of examples (rounded numbers): + +#+begin_src emacs-lisp +;; Pure white with pure green +(modus-themes-contrast "#ffffff" "#00ff00") +;; => 1.37 +;; That is an outright inaccessible combo + +;; Pure black with pure green +(modus-themes-contrast "#000000" "#00ff00") +;; => 15.3 +;; That is is a highly accessible combo +#+end_src + +It does not matter which color value comes first. The ratio is always +the same. + +If one does not wish to read all the decimal points, it is possible to +try something like this: + +#+begin_src emacs-lisp +(format "%0.2f" (modus-themes-contrast "#000000" "#00ff00")) +#+end_src + +While it is fine to perform such calculations on a case-by-case basis, +it is preferable to implement formulas and tables for more demanding +tasks. Such instruments are provided by ~org-mode~ or ~orgtbl-mode~, both +of which are built into Emacs. Below is such a table that derives the +contrast ratio of all colors in the first column (pure red, green, blue) +relative to the color specified in the first row of the second column +(pure white) and rounds the results: + +#+begin_example +| | #ffffff | +|---------+---------| +| #ff0000 | 4.00 | +| #00ff00 | 1.37 | +| #0000ff | 8.59 | +#+tblfm: $2='(modus-themes-contrast $1 @1$2);%0.2f +#+end_example + +To measure color contrast one needs to start from a known value. This +typically is the background. The Modus themes define an expanded +palette in large part because certain colors are only meant to be used +in combination with some others. Consult the source code for the +minutia and relevant commentary. + +Such knowledge may prove valuable while attempting to override some of +the themes' colors: [[#h:307d95dd-8dbd-4ece-a543-10ae86f155a6][Override colors]]. + +** Load theme depending on time of day (DIY) +:properties: +:custom_id: h:1d1ef4b4-8600-4a09-993c-6de3af0ddd26 +:end: + +While we do provide ~modus-themes-toggle~ to manually switch between the +themes, users may also set up their system to perform such a task +automatically at sunrise and sunset. + +This can be accomplished by specifying the coordinates of one's location +using the built-in {{{file(solar.el)}}} and then configuring the =circadian= +package: + +#+begin_src emacs-lisp +(use-package solar ; built-in + :config + (setq calendar-latitude 35.17 + calendar-longitude 33.36)) + +(use-package circadian ; you need to install this + :ensure + :after solar + (setq circadian-themes '((:sunrise . modus-operandi) + (:sunset . modus-vivendi))) + (circadian-setup)) +#+end_src + +** Backdrop for pdf-tools (DIY) +:properties: +:custom_id: h:ff69dfe1-29c0-447a-915c-b5ff7c5509cd +:end: +#+cindex: Remapping pdf-tools backdrop + +Most PDF files use a white background for their page, making it +impossible to discern the file's boundaries in the buffer while using +the Modus Operandi theme. To introduce a distinction between the +buffer's backdrop and the PDF page's background, the former must be +rendered as some shade of gray. Ideally, ~pdf-tools~ would provide a face +that the themes could support directly, though this does not seem to be +the case for the time being. We must thus employ the face remapping +technique that is documented elsewhere in this document to change the +buffer-local value of the ~default~ face. + +[[#h:7a93cb6f-4eca-4d56-a85c-9dcd813d6b0f][Remap face with local value]]. + +To remap the buffer's backdrop, we start with a function like this one: + +#+begin_src emacs-lisp +(defun my-pdf-tools-backdrop () + (face-remap-add-relative + 'default + `(:background ,(modus-themes-color 'bg-alt)))) + +(add-hook 'pdf-tools-enabled-hook #'my-pdf-tools-backdrop) +#+end_src + +The idea is to assign that function to a hook that gets called when +~pdf-tools~ renders the document: ~pdf-tools-enabled-hook~. This is enough +when you only use one theme. However it has the downside of setting the +background color value only at render time. In other words, the face +remapping function does not get evaluated anew whenever the theme +changes, such as upon invoking {{{kbd(M-x modus-themes-toggle)}}}. + +To have our face remapping adapt gracefully while switching between the +Modus themes, we need to also account for the current theme and control +the activation of ~pdf-view-midnight-minor-mode~. To which end we arrive +at something like the following, which builds on the above example: + +#+begin_src emacs-lisp +(defun my-pdf-tools-backdrop () + (face-remap-add-relative + 'default + `(:background ,(modus-themes-color 'bg-alt)))) + +(defun my-pdf-tools-midnight-mode-toggle () + (when (derived-mode-p 'pdf-view-mode) + (if (eq (car custom-enabled-themes) 'modus-vivendi) + (pdf-view-midnight-minor-mode 1) + (pdf-view-midnight-minor-mode -1)) + (my-pdf-tools-backdrop))) + +(add-hook 'pdf-tools-enabled-hook #'my-pdf-tools-midnight-mode-toggle) +(add-hook 'modus-themes-after-load-theme-hook #'my-pdf-tools-midnight-mode-toggle) +#+end_src + +With those in place, PDFs have a distinct backdrop for their page, while +they automatically switch to their dark mode when ~modus-themes-toggle~ is +called from inside a buffer whose major-mode is ~pdf-view-mode~. + +** A theme-agnostic hook for theme loading (DIY) +:properties: +:custom_id: h:86f6906b-f090-46cc-9816-1fe8aeb38776 +:end: + +The themes are designed with the intent to be useful to Emacs users of +varying skill levels, from beginners to experts. This means that we try +to make things easier by not expecting anyone reading this document to +be proficient in Emacs Lisp or programming in general. + +Such a case is with the use of the ~modus-themes-after-load-theme-hook~, +which runs after ~modus-themes-toggle~, ~modus-themes-load-operandi~, or +~modus-themes-load-vivendi~ is evaluated. We recommend using that hook +for advanced customizations, because (1) we know for sure that it is +available once the themes are loaded, and (2) anyone consulting this +manual, especially the sections on enabling and loading the themes, will +be in a good position to benefit from that hook. + +Advanced users who have a need to switch between the Modus themes and +other items will find that such a hook does not meet their requirements: +it only works with the Modus themes and only with the aforementioned +functions. + +A theme-agnostic setup can be configured thus: + +#+begin_src emacs-lisp +(defvar after-enable-theme-hook nil + "Normal hook run after enabling a theme.") + +(defun run-after-enable-theme-hook (&rest _args) + "Run `after-enable-theme-hook'." + (run-hooks 'after-enable-theme-hook)) + +(advice-add 'enable-theme :after #'run-after-enable-theme-hook) +#+end_src + +This creates the ~after-enable-theme-hook~ and makes it run after each +call to ~enable-theme~, which means that it will work for all themes and +also has the benefit that it does not depend on functions such as +~modus-themes-toggle~ and the others mentioned above. ~enable-theme~ is +called internally by ~load-theme~, so the hook works everywhere. + +Now this specific piece of Elisp may be simple for experienced users, +but it is not easy to read for newcomers, including the author of the +Modus themes for the first several months of their time as an Emacs +user. Hence our hesitation to recommend it as part of the standard +setup of the Modus themes (it is generally a good idea to understand +what the implications are of advising a function). + +* Face coverage +:properties: +:custom_id: h:a9c8f29d-7f72-4b54-b74b-ddefe15d6a19 +:end: + +The Modus themes try to provide as close to full face coverage as +possible. This is necessary to ensure a consistently accessible reading +experience across all available interfaces. + +** Full support for packages or face groups +:properties: +:alt_title: Supported packages +:description: Full list of covered face groups +:custom_id: h:60ed4275-60d6-49f8-9287-9a64e54bea0e +:end: +#+cindex: Explicitly supported packages + +This list will always be updated to reflect the current state of the +project. The idea is to offer an overview of the known status of all +affected face groups. The items with an appended asterisk =*= tend to +have lots of extensions, so the "full support" may not be 100% true… + ++ ace-window ++ ag ++ alert ++ all-the-icons ++ annotate ++ anzu ++ apropos ++ apt-sources-list ++ artbollocks-mode ++ auctex and TeX ++ auto-dim-other-buffers ++ avy ++ awesome-tray ++ bbdb ++ binder ++ bm ++ bongo ++ boon ++ bookmark ++ breakpoint (provided by the built-in {{{file(gdb-mi.el)}}} library) ++ buffer-expose ++ calendar and diary ++ calfw ++ centaur-tabs ++ cfrs ++ change-log and log-view (such as ~vc-print-log~, ~vc-print-root-log~) ++ cider ++ circe ++ color-rg ++ column-enforce-mode ++ company-mode* ++ company-posframe ++ compilation-mode ++ completions ++ consult ++ corfu ++ counsel* ++ counsel-css ++ counsel-org-capture-string ++ cov ++ cperl-mode ++ css-mode ++ csv-mode ++ ctrlf ++ custom (what you get with {{{kbd(M-x customize)}}}) ++ dap-mode ++ dashboard (emacs-dashboard) ++ deadgrep ++ debbugs ++ define-word ++ deft ++ dictionary ++ diff-hl ++ diff-mode ++ dim-autoload ++ dir-treeview ++ dired ++ dired-async ++ dired-git ++ dired-git-info ++ dired-narrow ++ dired-subtree ++ diredc ++ diredfl ++ diredp (dired+) ++ disk-usage ++ display-fill-column-indicator-mode ++ doom-modeline ++ dynamic-ruler ++ easy-jekyll ++ easy-kill ++ ebdb ++ ediff ++ eglot ++ el-search ++ eldoc-box ++ elfeed ++ elfeed-score ++ embark ++ emms ++ enh-ruby-mode (enhanced-ruby-mode) ++ epa ++ equake ++ erc ++ eros ++ ert ++ eshell ++ eshell-fringe-status ++ eshell-git-prompt ++ eshell-prompt-extras (epe) ++ eshell-syntax-highlighting ++ evil* (evil-mode) ++ evil-goggles ++ evil-snipe ++ evil-visual-mark-mode ++ eww ++ exwm ++ eyebrowse ++ fancy-dabbrev ++ flycheck ++ flycheck-color-mode-line ++ flycheck-indicator ++ flycheck-posframe ++ flymake ++ flyspell ++ flyspell-correct ++ flx ++ freeze-it ++ frog-menu ++ focus ++ fold-this ++ font-lock (generic syntax highlighting) ++ forge ++ fountain (fountain-mode) ++ geiser ++ git-commit ++ git-gutter (and variants) ++ git-lens ++ git-rebase ++ git-timemachine ++ git-walktree ++ gnus ++ gotest ++ golden-ratio-scroll-screen ++ helm* ++ helm-ls-git ++ helm-switch-shell ++ helm-xref ++ helpful ++ highlight-blocks ++ highlight-defined ++ highlight-escape-sequences (~hes-mode~) ++ highlight-indentation ++ highlight-numbers ++ highlight-symbol ++ highlight-tail ++ highlight-thing ++ hl-defined ++ hl-fill-column ++ hl-line-mode ++ hl-todo ++ hydra ++ hyperlist ++ ibuffer ++ icomplete ++ icomplete-vertical ++ ido-mode ++ iedit ++ iflipb ++ imenu-list ++ indium ++ info ++ info-colors ++ interaction-log ++ ioccur ++ isearch, occur, etc. ++ isl (isearch-light) ++ ivy* ++ ivy-posframe ++ jira (org-jira) ++ journalctl-mode ++ js2-mode ++ julia ++ jupyter ++ kaocha-runner ++ keycast ++ ledger-mode ++ line numbers (~display-line-numbers-mode~ and global variant) ++ lsp-mode ++ lsp-ui ++ macrostep ++ magit ++ magit-imerge ++ make-mode ++ man ++ marginalia ++ markdown-mode ++ markup-faces (~adoc-mode~) ++ mentor ++ messages ++ minibuffer-line ++ minimap ++ mmm-mode ++ mode-line ++ mood-line ++ moody ++ mpdel ++ mu4e ++ mu4e-conversation ++ multiple-cursors ++ neotree ++ no-emoji ++ notmuch ++ num3-mode ++ nxml-mode ++ objed ++ orderless ++ org* ++ org-journal ++ org-noter ++ org-pomodoro ++ org-recur ++ org-roam ++ org-superstar ++ org-table-sticky-header ++ org-tree-slide ++ org-treescope ++ origami ++ outline-mode ++ outline-minor-faces ++ package (what you get with {{{kbd(M-x list-packages)}}}) ++ page-break-lines ++ pandoc-mode ++ paradox ++ paren-face ++ parrot ++ pass ++ pdf-tools ++ persp-mode ++ perspective ++ phi-grep ++ phi-search ++ pkgbuild-mode ++ pomidor ++ popup ++ powerline ++ powerline-evil ++ prism ([[#h:a94272e0-99da-4149-9e80-11a7e67a2cf2][Note for prism.el]]) ++ proced ++ prodigy ++ pulse ++ quick-peek ++ racket-mode ++ rainbow-blocks ++ rainbow-identifiers ++ rainbow-delimiters ++ rcirc ++ recursion-indicator ++ regexp-builder (also known as ~re-builder~) ++ rg (rg.el) ++ ripgrep ++ rmail ++ ruler-mode ++ sallet ++ selectrum ++ selectrum-prescient ++ semantic ++ sesman ++ shell-script-mode ++ shortdoc ++ show-paren-mode ++ shr ++ side-notes ++ sieve-mode ++ skewer-mode ++ smart-mode-line ++ smartparens ++ smerge ++ solaire ++ spaceline ++ speedbar ++ spell-fu ++ spray ++ stripes ++ suggest ++ switch-window ++ swiper ++ swoop ++ sx ++ symbol-overlay ++ syslog-mode ++ tab-bar-groups ++ tab-bar-mode ++ tab-line-mode ++ table (built-in table.el) ++ telega ++ telephone-line ++ terraform-mode ++ term ++ tomatinho ++ transient (pop-up windows such as Magit's) ++ trashed ++ treemacs ++ tty-menu ++ tuareg ++ typescript ++ undo-tree ++ vc (vc-dir.el, vc-hooks.el) ++ vc-annotate (the output of {{{kbd(C-x v g)}}}) ++ vdiff ++ vertico ++ vimish-fold ++ visible-mark ++ visual-regexp ++ volatile-highlights ++ vterm ++ wcheck-mode ++ web-mode ++ wgrep ++ which-function-mode ++ which-key ++ whitespace-mode ++ window-divider-mode ++ winum ++ writegood-mode ++ woman ++ xah-elisp-mode ++ xref ++ xterm-color (and ansi-colors) ++ yaml-mode ++ yasnippet ++ ztree + +Plus many other miscellaneous faces that are provided by the upstream +GNU Emacs distribution. + +** Indirectly covered packages +:properties: +:custom_id: h:2cb359c7-3a84-4262-bab3-dcdc1d0034d7 +:end: +#+cindex: Implicitly supported packages + +These do not require any extra styles because they are configured to +inherit from some basic faces or their dependencies which are directly +supported by the themes. + ++ counsel-notmuch ++ edit-indirect ++ evil-owl ++ fortran-mode ++ goggles ++ i3wm-config-mode ++ perl-mode ++ php-mode ++ rjsx-mode ++ swift-mode ++ tab-bar-echo-area + +* Notes on individual packages +:properties: +:custom_id: h:4c4d901a-84d7-4f20-bd99-0808c2b06eba +:end: + +This section covers information that may be of interest to users of +individual packages. + +** Note on avy hints +:properties: +:custom_id: h:2fdce705-6de7-44e6-ab7f-18f59af99e01 +:end: + +Hints can appear everywhere, in wildly varying contexts, hence, their +appearance, by necessity, is a compromise. However, there are various +options for making them stand out. First is dimming the surroundings: + +#+begin_src emacs-lisp +(setq avy-background t) +#+end_src + +Dimming works well when you find it difficult to spot hints, any hint. +Second is limiting the number of faces used by hints: + +#+begin_src emacs-lisp +(setq avy-lead-faces + '(avy-lead-face + avy-lead-face-1 + avy-lead-face-1 + avy-lead-face-1 + avy-lead-face-1)) +#+end_src + +Limiting the number of faces works well with longer hints when you find +it difficult to identify individual hints, especially with hints +touching each other. The first character of the hint will have an +intense color, the remaining ones the same neutral color. + +Third is preferring commands that produce fewer candidates. Fewer hints +is less noise: ~avy-goto-char-timer~ is an excellent alternative to +~avy-goto-char~. + +** Note on calendar.el weekday and weekend colors +:properties: +:custom_id: h:b2db46fb-32f4-44fd-8e11-d2b261cf51ae +:end: + +By default, the {{{kbd(M-x calendar)}}} interface differentiates weekdays from +weekends by applying a gray color to the former and a faint red to the +latter. The idea for this approach is that the weekend should serve as +a subtle warning that no work is supposed to be done on that day, per +the design of traditional calendars. + +Users who prefer all days to look the same can configure the variable +~calendar-weekend-days~ to either use gray of weekdays or the faint red of +weekends uniformly. + +#+begin_src emacs-lisp +;; All are treated like weekdays (gray color) +(setq calendar-weekend-days nil) + +;; All are treated like weekends (red-faint color) +(setq calendar-weekend-days (number-sequence 0 6)) + +;; The default marks the Saturday and Sunday as the weekend +(setq calendar-weekend-days '(0 6)) +#+end_src + +For changes to take effect, the Calendar buffer needs to be generated +anew. + +** Note on underlines in compilation buffers +:properties: +:custom_id: h:420f5a33-c7a9-4112-9b04-eaf2cbad96bd +:end: + +Various buffers that produce compilation results or run tests on code +apply an underline to the file names they reference or to relevant +messages. Users may consider this unnecessary or excessive. + +To outright disable the effect, use this: + +#+begin_src emacs-lisp +(setq compilation-message-face nil) +#+end_src + +If some element of differentiation is still desired, a good option is to +render the affected text using the ~italic~ face: + +#+begin_src emacs-lisp +(setq compilation-message-face 'italic) +#+end_src + +[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. + +** Note on inline Latex in Org buffers +:properties: +:custom_id: h:dd8478da-f56a-45cd-b199-b836c85c3c5a +:end: + +Org can work with inline latex and related syntax. To actually fontify +those constructs, set the variable ~org-highlight-latex-and-related~ to +the desired list of values (per its doc string). For example: + +#+begin_src emacs-lisp +(setq org-highlight-latex-and-related '(latex script)) +#+end_src + +Remember to use {{{kbd(M-x org-mode-restart)}}} for changes to take effect. + +** Note on dimmer.el +:properties: +:custom_id: h:8eb4b758-d318-4480-9ead-357a571beb93 +:end: + +The {{{file(dimmer.el)}}} library by Neil Okamoto can be configured to +automatically dim the colors of inactive Emacs windows. To guarantee +consistent results with the Modus themes, we suggest some tweaks to the +default styles, such as in this minimal setup: + +#+begin_src emacs-lisp +(use-package dimmer + :config + (setq dimmer-fraction 0.3) + (setq dimmer-adjustment-mode :foreground) + (setq dimmer-use-colorspace :rgb) + + (dimmer-mode 1)) +#+end_src + +Of the above, we strongly recommend the RGB color space because it is +the one that remains faithful to the hueness of the colors used by the +themes. Whereas the default CIELAB space has a tendency to distort +colors in addition to applying the dim effect, which can be somewhat +disorienting. + +The value of the ~dimmer-fraction~ has been selected empirically. Users +might prefer to tweak it further (increasing it makes the dim effect +more pronounced). + +Changing the ~dimmer-adjustment-mode~ is a matter of preference. Though +because the Modus themes use black and white as their base colors, any +other value for that variable will turn the main background gray. This +inadvertently leads to the opposite of the intended utility of this +package: it draws too much attention to unfocused windows. + +** Note on display-fill-column-indicator-mode +:properties: +:custom_id: h:2a602816-bc1b-45bf-9675-4cbbd7bf6cab +:end: + +While designing the style for ~display-fill-column-indicator-mode~, we +stayed close to the mode's defaults: to apply a subtle foreground color +to the ~fill-column-indicator~ face, which blends well with the rest of +theme and is consistent with the role of that mode. This is to not +upset the expectations of users. + +Nevertheless, ~display-fill-column-indicator-mode~ has some known +limitations pertaining to its choice of using typographic characters to +draw its indicator. What should be a continuous vertical line might +appear as a series of dashes in certain contexts or under specific +conditions: a non-default value for ~line-spacing~, scaled and/or +variable-pitch headings have been observed to cause this effect. + +Given that we cannot control such factors, it may be better for affected +users to deviate from the default style of the ~fill-column-indicator~ +face. Instead of setting a foreground color, one could use a background +and have the foreground be indistinguishable from it. For example: + +#+begin_src emacs-lisp +(modus-themes-with-colors + (custom-set-faces + `(fill-column-indicator ((,class :background ,bg-inactive + :foreground ,bg-inactive))))) +#+end_src + +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. + +** Note on mmm-mode.el background colors +:properties: +:custom_id: h:99cf0d6c-e478-4e26-9932-3bf3427d13f6 +:end: + +The faces used by {{{file(mmm-mode.el)}}} are expected to have a colorful +background, while they should not touch any foreground value. The idea +is that they must not interfere with existing fontification. Those +background colors need to be distinct from each other, such as an +unambiguous red juxtaposed with a clear blue. + +While this design may be internally consistent with the raison d'être of +that library, it inevitably produces inaccessible color combinations. + +There are two competing goals at play: + +1. Legibility of the text, understood as the contrast ratio between the + background and the foreground. + +2. Semantic precision of each face which entails faithfulness to + color-coding of the underlying background. + +As the Modus themes are designed with the express purpose of conforming +with the first point, we have to forgo the apparent color-coding of the +background elements. Instead we use subtle colors that do not undermine +the legibility of the affected text while they still offer a sense of +added context. + +Users who might prefer to fall below the minimum 7:1 contrast ratio in +relative luminance (the accessibility target we conform with), can opt +to configure the relevant faces on their own. + +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. + +This example uses more vivid background colors, though it comes at the +very high cost of degraded legibility. + +#+begin_src emacs-lisp +(modus-themes-with-colors + (custom-set-faces + `(mmm-cleanup-submode-face ((,class :background ,yellow-refine-bg))) + `(mmm-code-submode-face ((,class :background ,bg-active))) + `(mmm-comment-submode-face ((,class :background ,blue-refine-bg))) + `(mmm-declaration-submode-face ((,class :background ,cyan-refine-bg))) + `(mmm-default-submode-face ((,class :background ,bg-alt))) + `(mmm-init-submode-face ((,class :background ,magenta-refine-bg))) + `(mmm-output-submode-face ((,class :background ,red-refine-bg))) + `(mmm-special-submode-face ((,class :background ,green-refine-bg))))) +#+end_src + +** Note on prism.el +:properties: +:alt_title: Note for prism +:custom_id: h:a94272e0-99da-4149-9e80-11a7e67a2cf2 +:end: + +This package by Adam Porter, aka "alphapapa" or "github-alphapapa", +implements an alternative to the typical coloration of code. Instead of +highlighting the syntactic constructs, it applies color to different +levels of depth in the code structure. + +As {{{file(prism.el)}}} offers a broad range of customisations, we cannot +style it directly at the theme level: that would run contrary to the +spirit of the package. Instead, we may offer preset color schemes. +Those should offer a starting point for users to adapt to their needs. + +In the following code snippets, we employ the ~modus-themes-with-colors~ +macro: [[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. + +These are the minimum recommended settings with 16 colors: + +#+begin_src emacs-lisp +(setq prism-num-faces 16) + +(prism-set-colors + :desaturations '(0) ; do not change---may lower the contrast ratio + :lightens '(0) ; same + :colors (modus-themes-with-colors + (list fg-main + magenta + cyan-alt-other + magenta-alt-other + blue + magenta-alt + cyan-alt + red-alt-other + green + fg-main + cyan + yellow + blue-alt + red-alt + green-alt-other + fg-special-warm))) +#+end_src + +With 8 colors: + +#+begin_src emacs-lisp +(setq prism-num-faces 8) + +(prism-set-colors + :desaturations '(0) ; do not change---may lower the contrast ratio + :lightens '(0) ; same + :colors (modus-themes-with-colors + (list fg-special-cold + magenta + magenta-alt-other + cyan-alt-other + fg-main + blue-alt + red-alt-other + cyan))) +#+end_src + +And this is with 4 colors, which produces results that are the closest +to the themes' default aesthetic: + +#+begin_src emacs-lisp +(setq prism-num-faces 4) + +(prism-set-colors + :desaturations '(0) ; do not change---may lower the contrast ratio + :lightens '(0) ; same + :colors (modus-themes-with-colors + (list fg-main + cyan-alt-other + magenta-alt-other + magenta))) +#+end_src + +If you need to apply desaturation and lightening, you can use what the +{{{file(prism.el)}}} documentation recommends, like this (adapting to the +examples with the 4, 8, 16 colors): + +#+begin_src emacs-lisp +(prism-set-colors + :desaturations (cl-loop for i from 0 below 16 collect (* i 2.5)) + :lightens (cl-loop for i from 0 below 16 collect (* i 2.5)) + :colors (modus-themes-with-colors + (list fg-main + cyan-alt-other + magenta-alt-other + magenta))) +#+end_src + +** Note on god-mode.el +:properties: +:alt_title: Note for god-mode +:custom_id: h:4da1d515-3e05-47ef-9e45-8251fc7e986a +:end: + +The ~god-mode~ library does not provide faces that could be configured by +the Modus themes. Users who would like to get some visual feedback on +the status of {{{kbd(M-x god-mode)}}} are instead encouraged by upstream to +set up their own configurations, such as by changing the ~mode-line~ face +([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization (do-it-yourself)]]). This is an adaptation of the +approach followed in the upstream README: + +#+begin_src emacs-lisp +(defun my-god-mode-update-mode-line () + "Make `mode-line' blue if God local mode is active." + (modus-themes-with-colors + (if god-local-mode + (set-face-attribute 'mode-line nil + :foreground blue-active + :background bg-active-accent + :box blue) + (set-face-attribute 'mode-line nil + :foreground fg-active + :background bg-active + :box fg-alt)))) + +(add-hook 'post-command-hook 'my-god-mode-update-mode-line) +#+end_src + +We employ the ~modus-themes-with-colors~ which provides access to color +variables defined by the active theme. Its use is covered elsewhere in +this manual ([[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]). As for the +attributes that can be passed to each face, start by consulting the +documentation string of ~set-face-attribute~. + +** Note on company-mode overlay pop-up +:properties: +:custom_id: h:20cef8c4-d11f-4053-8b2c-2872925780b1 +:end: + +By default, the ~company-mode~ pop-up that lists completion candidates is +drawn using an overlay. This creates alignment issues every time it is +placed above a piece of text that has a different height than the +default. + +The solution recommended by the project's maintainer is to use an +alternative front-end for drawing the pop-up which draws child frames +instead of overlays.[fn:: +https://github.com/company-mode/company-mode/issues/1010][fn:: +https://github.com/tumashu/company-posframe/] + +** Note on ERC escaped color sequences +:properties: +:custom_id: h:98bdf319-1e32-4469-8a01-771200fba65c +:end: + +The built-in IRC client ~erc~ has the ability to colorise any text using +escape sequences that start with =^C= (inserted with {{{kbd(C-q C-c)}}}) and are +followed by a number for the foreground and background.[fn:: This page +explains the basics, though it is not specific to Emacs: +https://www.mirc.com/colors.html] Possible numbers are 0-15, with the +first entry being the foreground and the second the background, +separated by a comma. Like this =^C1,6=. The minimum setup is this: + +#+begin_src emacs-lisp +(add-to-list 'erc-modules 'irccontrols) +(setq erc-interpret-controls-p t + erc-interpret-mirc-color t) +#+end_src + +As this allows users the chance to make arbitrary combinations, it is +impossible to guarantee a consistently high contrast ratio. All we can +we do is provide guidance on the combinations that satisfy the +accessibility standard of the themes: + ++ Modus Operandi :: Use foreground color 1 for all backgrounds from + 2-15. Like so: {{{kbd(C-q C-c1,N)}}} where =N= is the background. + ++ Modus Vivendi :: Use foreground color 0 for all backgrounds from + 2-13. Use foreground =1= for backgrounds 14, 15. + +Colors 0 and 1 are white and black respectively. So combine them +together, if you must. + +** Note on powerline or spaceline +:properties: +:custom_id: h:9130a8ba-d8e3-41be-a58b-3cb1eb7b6d17 +:end: + +Both Powerline and Spaceline package users will likely need to use the +command ~powerline-reset~ whenever they make changes to their themes +and/or mode line setup. + +** Note on SHR colors +:properties: +:custom_id: h:4cc767dc-ffef-4c5c-9f10-82eb7b8921bf +:end: + +Emacs' HTML rendering library ({{{file(shr.el)}}}) may need explicit +configuration to respect the theme's colors instead of whatever +specifications the webpage provides. + +Consult {{{kbd(C-h v shr-use-colors)}}}. + +** Note on EWW and Elfeed fonts (SHR fonts) +:properties: +:custom_id: h:e6c5451f-6763-4be7-8fdb-b4706a422a4c +:end: + +EWW and Elfeed rely on the Simple HTML Renderer to display their +content. The {{{file(shr.el)}}} library contains the variable ~shr-use-fonts~ +that controls whether the text in the buffer is set to a ~variable-pitch~ +typeface (proportionately spaced) or if just retains whatever the +default font family is. Its default value is non-nil, which means that +~variable-pitch~ is applied. + +[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + +** Note on Helm grep +:properties: +:custom_id: h:d28879a2-8e4b-4525-986e-14c0f873d229 +:end: + +There is one face from the Helm package that is meant to highlight the +matches of a grep or grep-like command (=ag= or =ripgrep=). It is +~helm-grep-match~. However, this face can only apply when the user does +not pass =--color=always= as a command-line option for their command. + +Here is the docstring for that face, which is defined in the +{{{file(helm-grep.el)}}} library (you can always visit the source code with +{{{kbd(M-x find-library)}}}). + +#+begin_quote +Face used to highlight grep matches. Have no effect when grep backend +use "--color=" +#+end_quote + +The user must either remove =--color= from the flags passed to the grep +function, or explicitly use =--color=never= (or equivalent). Helm +provides user-facing customization options for controlling the grep +function's parameters, such as ~helm-grep-default-command~ and +~helm-grep-git-grep-command~. + +When =--color=always= is in effect, the grep output will use red text in +bold letter forms to present the matching part in the list of +candidates. That style still meets the contrast ratio target of >= 7:1 +(accessibility standard WCAG AAA), because it draws the reference to +ANSI color number 1 (red) from the already-supported array of +~ansi-color-names-vector~. + +** Note on vc-annotate-background-mode +:properties: +:custom_id: h:5095cbd1-e17a-419c-93e8-951c186362a3 +:end: + +Due to the unique way ~vc-annotate~ ({{{kbd(C-x v g)}}}) applies colors, support +for its background mode (~vc-annotate-background-mode~) is disabled at the +theme level. + +Normally, such a drastic measure should not belong in a theme: assuming +the user's preferences is bad practice. However, it has been deemed +necessary in the interest of preserving color contrast accessibility +while still supporting a useful built-in tool. + +If there actually is a way to avoid such a course of action, without +prejudice to the accessibility standard of this project, then please +report as much or send patches ([[#h:9c3cd842-14b7-44d7-84b2-a5c8bc3fc3b1][Contributing]]). + +** Note on pdf-tools link hints +:properties: +:custom_id: h:2659d13e-b1a5-416c-9a89-7c3ce3a76574 +:end: + +Hints are drawn by [[https://imagemagick.org/][ImageMagick]], not Emacs, i.e., ImageMagick doesn't +know about the hint face unless you tell ImageMagick about it. By +default, only the foreground and background color attributes are +passed. The below snippet adds to those the various font attributes. As +it queries various faces, specifically ~pdf-links-read-link~ and the faces +it inherits, it needs to be added to your initialization file after +you've customized any faces. + +#+begin_src emacs-lisp +(use-package pdf-links + :config + (let ((spec + (apply #'append + (mapcar + (lambda (name) + (list name + (face-attribute 'pdf-links-read-link + name nil 'default))) + '(:family :width :weight :slant))))) + (setq pdf-links-read-link-convert-commands + `("-density" "96" + "-family" ,(plist-get spec :family) + "-stretch" ,(let* ((width (plist-get spec :width)) + (name (symbol-name width))) + (replace-regexp-in-string "-" "" + (capitalize name))) + "-weight" ,(pcase (plist-get spec :weight) + ('ultra-light "Thin") + ('extra-light "ExtraLight") + ('light "Light") + ('semi-bold "SemiBold") + ('bold "Bold") + ('extra-bold "ExtraBold") + ('ultra-bold "Black") + (_weight "Normal")) + "-style" ,(pcase (plist-get spec :slant) + ('italic "Italic") + ('oblique "Oblique") + (_slant "Normal")) + "-pointsize" "%P" + "-undercolor" "%f" + "-fill" "%b" + "-draw" "text %X,%Y '%c'")))) +#+end_src + +* Frequently Asked Questions (FAQ) +:properties: +:custom_id: h:b3384767-30d3-4484-ba7f-081729f03a47 +:end: +#+cindex: Frequently Asked Questions (FAQ) + +In this section we provide answers related to some aspects of the Modus +themes' design and application. + +** Is the contrast ratio about adjacent colors? +:properties: +:custom_id: h:5ce7ae2e-9348-4e55-b4cf-9302345b1826 +:end: +#+cindex: Contrast between adjacent colors + +The minimum contrast ratio in relative luminance that the themes conform +with always refers to any given combination of background and foreground +colors. If we have some blue colored text next to a magenta one, both +against a white background, we do not mean to imply that blue:magenta is +7:1 in terms of relative luminance. Rather, we state that blue:white +and magenta:white each are 7:1 or higher. + +The point of reference is always the background. Because colors have +about the same minimum distance in luminance from their backdrop, they +necessarily are fairly close to each other in this measure. A possible +blue:magenta combination would naturally be around 1:1 in contrast of +the sort here considered. + +To differentiate between sequential colors, we rely on hueness by +mapping contrasting hues to adjacent constructs, while avoiding +exaggerations. A blue next to a magenta can be told apart regardless of +their respective contrast ratio against their common background. +Exceptions would be tiny characters in arguably not so realistic cases, +such as two dots drawn side-by-side which for some reason would need to +be colored differently. They would still be legible though, which is +the primary objective of the Modus themes. + +** What does it mean to avoid exaggerations? +:properties: +:custom_id: h:44284e1f-fab8-4c4f-92f0-544728a7c91e +:end: +#+cindex: Avoiding exaggerations in design + +The Modus themes are designed with restraint, so that their default +looks do not overdo it with the application of color. + +[[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]. + +This is the non-quantifiable aspect of the themes' design: the artistic +part, if you will. There are a lot of cases where color can be used +inconsiderately, without accounting for layout, typographic, or other +properties of the presentation. For example, two headings with distinct +markers, such as leading asterisks in Org buffers, do not have to have +highly contrasting hues between them in order to be told apart: the +added element of contrast in hueness does not contribute significantly +more to the distinction between the headings than colors whose hues are +relatively closer to each other in the color space. + +Exaggerations can be hard to anticipate or identify. Multiple shades of +blue and magenta in the same context may not seem optimal: one might +think that it would be better to use highly contrasting hues to ensure +that all colors stand out, such as by placing blue next to yellow, next +to magenta, and green. That would, however, be a case of design for its +own sake; a case where color is being applied without consideration of +its end results in the given context. Too many contrasting hues in +close proximity force an erratic rate to how the eye jumps from one +piece of text to the next. Whereas multiple shades of, say, blue and +magenta can suffice to tell things apart and avoid excess coloration: a +harmonious rhythm. + +** Why are colors mostly variants of blue, magenta, cyan? +:properties: +:custom_id: h:0b26cb47-9733-4cb1-87d9-50850cb0386e +:end: +#+cindex: Innate color qualities of the palette + +Due to the innate properties of color, some options are better than +others for the accessibility purposes of the themes, the stylistic +consistency between ~modus-operandi~ and ~modus-vivendi~, and the avoidance +of exaggerations in design. + +[[#h:44284e1f-fab8-4c4f-92f0-544728a7c91e][What does it mean to avoid exaggerations?]] + +What we describe as color is a function of three distinct channels of +light: red, green, blue. In hexadecimal RGB notation, a color value is +read as three pairs of red, green, and blue light: =#RRGGBB=. Of those +three, the most luminant is green, while the least luminant is blue. + +The three basic colors represent each of the channels of light. They +can be intermixed to give us six colors: red and green derive yellow, +green and blue make cyan, red and blue turn into magenta. + +We can test the luminance of each of those against white and black to +get a sense of how not all colors are equally good for accessibility +(white is =#ffffff=, which means that all three light channels are fully +luminated, while black is =#000000= meaning that no light is present +(notwithstanding display technology)). + +#+begin_example +| Name | | #ffffff | #000000 | +|---------+---------+---------+---------| +| red | #ff0000 | 4.00 | 5.25 | +| yellow | #ffff00 | 1.07 | 19.56 | +| green | #00ff00 | 1.37 | 15.30 | +| cyan | #00ffff | 1.25 | 16.75 | +| blue | #0000ff | 8.59 | 2.44 | +| magenta | #ff00ff | 3.14 | 6.70 | +#+end_example + +[[#h:02e25930-e71a-493d-828a-8907fc80f874][Measure color contrast]]. + +By reading this table we learn that every color that has a high level of +green light (green, yellow, cyan) is virtually unreadable against a +white background and, conversely, can be easily read against black. + +We can then infer that red and blue, in different combinations, with +green acting as calibrator for luminance, will give us fairly moderate +colors that pass the 7:1 target. Blue with a bit of green produce +appropriate variants of cyan. Similarly, blue combined with some red +and hints of green give us suitable shades of purple. + +Due to the need of maintaining some difference in hueness between +adjacent colors, it is not possible to make red, green, and yellow the +primary colors, because blue could not be used to control their +luminance and, thus the relevant space would shrink considerably. + +[[#h:5ce7ae2e-9348-4e55-b4cf-9302345b1826][Is the contrast ratio about adjacent colors?]] + +This phenomenon is best illustrated by the following table that measures +the relative luminance of shades of red, yellow, magenta against white: + +#+begin_example +| | #ffffff | +|---------+---------| +| #990000 | 8.92 | +| #995500 | 5.75 | +| #990099 | 7.46 | +#+end_example + +We notice that equal values of red and blue light in =#990099= (magenta +shade) do not lead to a considerable change in luminance compared with +=#990000= (red variant). Whereas less amount of green light in =#995500= +leads to a major drop in luminance relative to white. It follows that +using the green channel of light to calibrate the luminance of colors is +more effective than trying to do the same with either red or blue (the +latter is the least effective in that regard). + +When we need to work with several colors, it is always better to have +sufficient manoeuvring space, especially since we cannot pick arbitrary +colors but only those that satisfy the accessibility objectives of the +themes. + +As for why we do not mostly use green, yellow, cyan for the dark theme, +it is because those colors are far more luminant than their counterparts +on the other side of the spectrum, so to ensure that they all have about +the same contrast ratios we would have to alter their hueness +considerably. In short, the effect would not be optimal as it would +lead to exaggerations. Plus, it would make ~modus-vivendi~ look +completely different than ~modus-operandi~, to the effect that the two +could not be properly considered part of the same project. + +** What is the best setup for legibility? +:properties: +:custom_id: h:f60cc2ae-129d-47c0-9849-4f6bbd87d8be +:end: +#+cindex: General setup for readability + +The Modus themes can be conceptually simplified as combinations of color +values that account for relative luminance and inner harmony. Those +qualities do not guarantee that every end-user will have the same +experience, due to differences between people, but also because of +variances in hardware capabilities and configurations. For the purposes +of this document, we may only provide suggestions pertaining to the +latter case. + +~modus-operandi~ is best used outdoors or in a room that either gets +direct sunlight or has plenty of light. Whereas ~modus-vivendi~ works +better when there is not a lot of sunshine or the room has a source of +light, preferably a faint or warm one. It is possible to use +~modus-operandi~ at night and ~modus-vivendi~ during the day, though that +will depend on several variables, such as one's overall perception of +color, the paint on the walls and how that contributes to the impression +of lightness in the room, the sense of space within the eye's peripheral +vision, hardware specifications, and environmental factors. + +In general, an additional source of light other than that of the monitor +can help reduce eye strain: the eyes are more relaxed when they do not +have to focus on one point to gather light. + +The monitor's display settings must be accounted for. Gamma values, in +particular, need to be calibrated to neither amplify nor distort the +perception of black. Same principle for sharpness, brightness, and +contrast as determined by the hardware, which all have an effect on how +text is read on the screen. + +There are software level methods on offer, such as the XrandR utility +for the X Window System (X.org), which can make gamma corrections for +each of the three channels of light (red, green, blue). For example: + +: xrandr --output LVDS1 --brightness 1.0 --gamma 0.76:0.75:0.68 + +Typography is another variable. Some font families are blurry at small +point sizes. Others may have a regular weight that is lighter (thiner) +than that of their peers which may, under certain circumstances, cause a +halo effect around each glyph. + +The gist is that legibility cannot be fully solved at the theme level. +The color combinations may have been optimized for accessibility, though +the remaining contributing factors in each case need to be considered in +full. + +* Contributing +:properties: +:custom_id: h:9c3cd842-14b7-44d7-84b2-a5c8bc3fc3b1 +:end: + +This section documents the canonical sources of the themes and the ways +in which you can contribute to their ongoing development. + +** Sources of the themes +:properties: +:custom_id: h:89504f1c-c9a1-4bd9-ab39-78fd0eddb47c +:end: +#+cindex: Sources of the themes + +The ~modus-operandi~ and ~modus-vivendi~ themes are built into Emacs. +Currently they are in Emacs' git main branch (trunk), which is tracking +the next development release target. + +The source code of the themes is [[https://gitlab.com/protesilaos/modus-themes/][available on Gitlab]], for the time +being. A [[https://github.com/protesilaos/modus-themes/][mirror on Github]] is also on offer. + +An HTML version of this manual is provided as an extension of the +[[https://protesilaos.com/modus-themes/][author's personal website]] (does not rely on any non-free code). + +** Issues you can help with +:properties: +:custom_id: h:6536c8d5-3f98-43ab-a787-b94120e735e8 +:end: +#+cindex: Contributing + +A few tasks you can help with: + ++ Suggest refinements to packages that are covered. ++ Report packages not covered thus far. ++ Report bugs, inconsistencies, shortcomings. ++ Help expand the documentation of covered-but-not-styled packages. ++ Suggest refinements to the color palette. ++ Help expand this document or any other piece of documentation. ++ Merge requests for code refinements. + +[[#h:111773e2-f26f-4b68-8c4f-9794ca6b9633][Patches require copyright assignment to the FSF]]. + +It is preferable that your feedback includes some screenshots, GIFs, or +short videos, as well as further instructions to reproduce a given +setup. Though this is not a requirement. + +Whatever you do, bear in mind the overarching objective of the Modus +themes: to keep a contrast ratio that is greater or equal to 7:1 between +background and foreground colors. If a compromise is ever necessary +between aesthetics and accessibility, it shall always be made in the +interest of the latter. + +** Patches require copyright assignment to the FSF +:properties: +:custom_id: h:111773e2-f26f-4b68-8c4f-9794ca6b9633 +:end: + +Code contributions are most welcome. For any major edit (more than 15 +lines, or so, in aggregate per person), you need to make a copyright +assignment to the Free Software Foundation. This is necessary because +the themes are part of the upstream Emacs distribution: the FSF must at +all times be in a position to enforce the GNU General Public License. + +Copyright assignment is a simple process. Check the request form below +(please adapt it accordingly). You must write an email to the address +mentioned in the form and then wait for the FSF to send you a legal +agreement. Sign the document and file it back to them. This could all +happen via email and take about a week. You are encouraged to go +through this process. You only need to do it once. It will allow you +to make contributions to Emacs in general. + +#+begin_example text +Please email the following information to assign@gnu.org, and we +will send you the assignment form for your past and future changes. + +Please use your full legal name (in ASCII characters) as the subject +line of the message. +---------------------------------------------------------------------- +REQUEST: SEND FORM FOR PAST AND FUTURE CHANGES + +[What is the name of the program or package you're contributing to?] + +GNU Emacs + +[Did you copy any files or text written by someone else in these changes? +Even if that material is free software, we need to know about it.] + +Copied a few snippets from the same files I edited. Their author, +Protesilaos Stavrou, has already assigned copyright to the Free Software +Foundation. + +[Do you have an employer who might have a basis to claim to own +your changes? Do you attend a school which might make such a claim?] + + +[For the copyright registration, what country are you a citizen of?] + + +[What year were you born?] + + +[Please write your email address here.] + + +[Please write your postal address here.] + + + + + +[Which files have you changed so far, and which new files have you written +so far?] + +#+end_example + +* Acknowledgements +:properties: +:custom_id: h:95c3da23-217f-404e-b5f3-56c75760ebcf +:end: +#+cindex: Contributors + +The Modus themes are a collective effort. Every bit of work matters. + ++ Author/maintainer :: Protesilaos Stavrou. + ++ Contributions to code or documentation :: Anders Johansson, Basil + L.{{{space()}}} Contovounesios, Carlo Zancanaro, Eli Zaretskii, Fritz Grabo, + Kostadin Ninev, Madhavan Krishnan, Markus Beppler, Matthew Stevenson, + Mauro Aranda, Nicolas De Jaeghere, Philip Kaludercic, Rudolf + Adamkovič, Shreyas Ragavan, Stefan Kangas, Vincent Murphy, Xinglu + Chen. + ++ Ideas and user feedback :: Aaron Jensen, Adam Spiers, Adrian Manea, + Alex Griffin, Alex Peitsinis, Alexey Shmalko, Alok Singh, Anders + Johansson, André Alexandre Gomes, Arif Rezai, Basil L.{{{space()}}} + Contovounesios, Burgess Chang, Christian Tietze, Christopher Dimech, + Damien Cassou, Daniel Mendler, Dario Gjorgjevski, David Edmondson, + Davor Rotim, Divan Santana, Emanuele Michele Alberto Monterosso, + Farasha Euker, Gautier Ponsinet, Gerry Agbobada, Gianluca Recchia, + Gustavo Barros, Hörmetjan Yiltiz, Ilja Kocken, Iris Garcia, Jeremy + Friesen, Jerry Zhang, John Haman, Joshua O'Connor, Kevin Fleming, + Kévin Le Gouguec, Kostadin Ninev, Len Trigg, Manuel Uberti, Mark + Burton, Markus Beppler, Mauro Aranda, Michael Goldenberg, Morgan + Smith, Murilo Pereira, Nicky van Foreest, Nicolas De Jaeghere, Paul + Poloskov, Pengji Zhang, Pete Kazmier, Peter Wu, Philip Kaludercic, + Pierre Téchoueyres, Roman Rudakov, Ryan Phillips, Rudolf Adamkovič, + Sam Kleinman, Shreyas Ragavan, Simon Pugnet, Tassilo Horn, Thibaut + Verron, Thomas Heartman, Trey Merkley, Togan Muftuoglu, Toon Claes, + Uri Sharf, Utkarsh Singh, Vincent Foley. As well as users: Ben, + CsBigDataHub1, Emacs Contrib, Eugene, Fourchaux, Fredrik, Moesasji, + Nick, TheBlob42, Trey, bepolymathe, doolio, fleimgruber, iSeeU, + jixiuf, okamsn, pRot0ta1p. + ++ Packaging :: Basil L.{{{space()}}} Contovounesios, Eli Zaretskii, Glenn + Morris, Mauro Aranda, Richard Stallman, Stefan Kangas (core Emacs), + Stefan Monnier (GNU Elpa), André Alexandre Gomes, Dimakakos Dimos, + Morgan Smith, Nicolas Goaziou (Guix), Dhavan Vaidya (Debian). + ++ Inspiration for certain features :: Bozhidar Batsov (zenburn-theme), + Fabrice Niessen (leuven-theme). + +Special thanks, in no particular order, to Manuel Uberti, Gustavo +Barros, and Omar Antolín Camarena for their long time contributions and +insightful commentary. + +* Meta +:properties: +:custom_id: h:13752581-4378-478c-af17-165b6e76bc1b +:end: +#+cindex: Development notes + +If you are curious about the principles that govern the development of +this project read the essay [[https://protesilaos.com/codelog/2020-03-17-design-modus-themes-emacs/][On the design of the Modus themes]] +(2020-03-17). + +Here are some more publications for those interested in the kind of work +that goes into this project (sometimes the commits also include details +of this sort): + ++ [[https://protesilaos.com/codelog/2020-05-10-modus-operandi-palette-review/][Modus Operandi theme subtle palette review]] (2020-05-10) ++ [[https://protesilaos.com/codelog/2020-06-13-modus-vivendi-palette-review/][Modus Vivendi theme subtle palette review]] (2020-06-13) ++ [[https://protesilaos.com/codelog/2020-07-04-modus-themes-faint-colours/][Modus themes: new "faint syntax" option]] (2020-07-04) ++ [[https://protesilaos.com/codelog/2020-07-08-modus-themes-nuanced-colours/][Modus themes: major review of "nuanced" colours]] (2020-07-08) ++ [[https://protesilaos.com/codelog/2020-09-14-modus-themes-review-blues/][Modus themes: review of blue colours]] (2020-09-14) ++ [[https://protesilaos.com/codelog/2020-12-27-modus-themes-review-rainbow-delimiters/][Modus themes: review rainbow-delimiters faces]] (2020-12-27) ++ [[https://protesilaos.com/codelog/2021-01-11-modus-themes-review-select-faint-colours/][Modus themes: review of select "faint" colours]] (2021-01-11) ++ [[https://protesilaos.com/codelog/2021-02-25-modus-themes-diffs-deuteranopia/][The Modus themes now cover deuteranopia in diffs]] (2021-02-25) + +And here are the canonical sources of this project's documentation: + ++ Manual :: <https://protesilaos.com/modus-themes> ++ Change Log :: <https://protesilaos.com/modus-themes-changelog> ++ Screenshots :: <https://protesilaos.com/modus-themes-pictures> + +* GNU Free Documentation License +:properties: +:appendix: t +:custom_id: h:3077c3d2-7f90-4228-8f0a-73124f4026f6 +:end: + +#+texinfo: @include doclicense.texi + +#+begin_export html +<pre> + + GNU Free Documentation License + Version 1.3, 3 November 2008 + + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The "publisher" means any person or entity that distributes copies of +the Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no +other conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to +give them a chance to provide you with an updated version of the +Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements". + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the rules +of this License for verbatim copying of each of the documents in all +other respects. + +You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert a +copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the +GNU Free Documentation License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. See +https://www.gnu.org/licenses/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +"Massive Multiauthor Collaboration" (or "MMC") contained in the site +means any set of copyrightable works thus published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in +part, as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole or +in part into the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +</pre> +#+end_export + +#+html: <!-- + +* Indices +:properties: +:custom_id: h:55104b26-8e94-46cf-9975-43ea00316489 +:end: + +** Function index +:properties: +:index: fn +:custom_id: h:6bec5005-529c-4521-ae05-3d990baffb5b +:end: + +** Variable index +:properties: +:index: vr +:custom_id: h:16ad8df6-b015-40a9-9259-03d4f7a23ee4 +:end: + +** Concept index +:properties: +:index: cp +:custom_id: h:6aa7a656-884b-4c39-b759-087e412eec13 +:end: + +#+html: --> diff --git a/doc/misc/modus-themes.texi b/doc/misc/modus-themes.texi deleted file mode 100644 index b16aece2ee5..00000000000 --- a/doc/misc/modus-themes.texi +++ /dev/null @@ -1,2834 +0,0 @@ -\input texinfo @c -*- texinfo -*- -@c %**start of header -@setfilename ../../info/modus-themes.info -@settitle Modus themes for GNU Emacs -@include docstyle.texi -@documentencoding UTF-8 -@documentlanguage en -@c %**end of header - -@include emacsver.texi - -@dircategory Emacs misc features -@direntry -* Modus Themes: (modus-themes). Highly accessible themes (WCAG AAA). -@end direntry - -@finalout -@titlepage -@title Modus themes for GNU Emacs -@author Protesilaos Stavrou (@email{info@@protesilaos.com}) -@end titlepage - -@ifnottex -@node Top -@top Modus themes for GNU Emacs - -This manual, written by Protesilaos Stavrou, describes the customization -options for the @samp{modus-operandi} and @samp{modus-vivendi} themes, and provides -every other piece of information pertinent to them. - -The documentation furnished herein corresponds to version 0.13.0, -released on 2020-10-08. Any reference to a newer feature which does -not yet form part of the latest tagged commit, is explicitly marked as -such. - -Copyright (C) 2020--2021 Free Software Foundation, Inc. - -@quotation -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation License, -Version 1.3 or any later version published by the Free Software -Foundation; with no Invariant Sections, with no Front-Cover Texts, -and with no Back-Cover Texts. - -@end quotation - -@end ifnottex - -@menu -* Overview:: -* Installation:: -* Enable and load:: -* Customization Options:: -* Advanced customization (do-it-yourself):: -* Face coverage:: -* Notes for individual packages:: -* Contributing:: -* Acknowledgements:: -* Meta:: -* External projects (ports):: -* GNU Free Documentation License:: - -@detailmenu ---- The Detailed Node Listing --- - -Overview - -* How do the themes look like:: -* Learn about the latest changes:: - -Installation - -* Install from the archives:: -* Install on GNU/Linux:: - -Install on GNU/Linux - -* Debian 11 Bullseye:: -* GNU Guix:: - -Enable and load - -* Load automatically:: -* Load at a given time or at sunset/sunrise:: -* Toggle between the themes on demand:: -* Configure options prior to loading:: - -Customization Options - -* Bold constructs:: Toggle bold constructs in code -* Slanted constructs:: Toggle slanted constructs (italics) in code -* Syntax highlighting:: Toggle subtle coloration in programming modes -* No mixed fonts:: Toggle mixing of font families -* Link underline:: Toggle underlined text in links -* Command prompts:: Choose among plain, subtle, or intense prompts -* Mode line:: Choose among plain, three-dimension, or moody-compliant styles -* Completion UIs:: Choose among standard, moderate, or opinionated looks -* Fringes:: Choose among plain, subtle, or intense fringe visibility -* Line highlighting:: Toggle intense style for current line highlighting -* Matching parentheses:: Toggle intense style for matching delimiters/parentheses -* Diffs:: Choose among intense, desaturated, or text-only diffs -* Org mode blocks:: Choose among plain, greyscale, or rainbow styles -* Heading styles:: Choose among several styles, also per heading level -* Scaled headings:: Toggle scaling of headings -* Headings' font:: Toggle proportionately spaced fonts in headings - -Scaled headings - -* Scaled heading sizes:: Specify rate of increase for scaled headings - -Advanced customization (do-it-yourself) - -* Tweak colors (DIY):: Declare your own palette overrides -* Font configs (DIY):: Optimise for mixed typeface buffers -* Org user faces (DIY):: Extend styles for org-mode keywords and priorities - -Face coverage - -* Supported packages:: Full list of covered face groups -* Covered indirectly:: -* Will NOT be supported:: - -Notes for individual packages - -* Note on company-mode overlay pop-up:: -* Note for ERC escaped color sequences:: -* Note for powerline or spaceline:: -* Note on shr colors:: -* Note for Helm grep:: -* Note on vc-annotate-background-mode:: - -Contributing - -* Sources of the themes:: -* Issues you can help with:: -* Merge requests:: Legal considerations for code patches - -@end detailmenu -@end menu - -@node Overview -@chapter Overview - -The Modus themes are designed for accessible readability. They conform -with the highest standard for color contrast between any given -combination of background and foreground values. This corresponds to -the WCAG AAA standard, which specifies a minimum rate of distance in -relative luminance of 7:1. - -Modus Operandi (@samp{modus-operandi}) is a light theme, while Modus Vivendi -(@samp{modus-vivendi}) is dark. Each theme's color palette is designed to -meet the needs of the numerous interfaces that are possible in the Emacs -computing environment. - -The overarching objective of this project is to always offer accessible -color combinations. There shall never be a compromise on this -principle. If there arises an inescapable trade-off between readability -and stylistic considerations, we will always opt for the former. - -To ensure that users have a consistently accessible experience, the -themes strive to achieve as close to full face coverage as possible -(see @ref{Face coverage}). - -Starting with version 0.12.0 and onwards, the themes are built into GNU -Emacs (current version is 0.13.0). - -@menu -* How do the themes look like:: -* Learn about the latest changes:: -@end menu - -@node How do the themes look like -@section How do the themes look like - -Check the web page with @uref{https://protesilaos.com/modus-themes-pictures/, the screen shots}. There are lots of scenarios on -display that draw attention to details and important aspects in the -design of the themes. They also showcase the numerous customization -options. - -@xref{Customization Options}. - -@node Learn about the latest changes -@section Learn about the latest changes - -Please refer to the @uref{https://protesilaos.com/modus-themes-changelog, web page with the change log}. It is comprehensive -and covers everything that goes into every tagged release of the themes. - -@node Installation -@chapter Installation - -The Modus themes are distributed with Emacs starting with version 28.1. -On older versions of Emacs, they can be installed using Emacs' package -manager or manually from their code repository. - -Modus Operandi (light theme) and Modus Vivendi (dark) are normally -distributed as standalone packages in Emacs-specific archives. There -also exist packages for GNU/Linux distributions. - -@menu -* Install from the archives:: -* Install on GNU/Linux:: -@end menu - -@node Install from the archives -@section Install from the archives - -@samp{modus-operandi-theme} and @samp{modus-vivendi-theme} are -available from the GNU ELPA archive, which is configured by default. - -Prior to querying any package archive, make sure to have updated the -index, with @samp{M-x package-refresh-contents}. Then all you need to do is -type @samp{M-x package-install} and specify the theme of your choice. - -@node Install on GNU/Linux -@section Install on GNU/Linux - -The themes are also available from the archives of some GNU/Linux -distributions. These should correspond to a tagged release rather than -building directly from the latest Git commit. It all depends on the -distro's packaging policies. - -@menu -* Debian 11 Bullseye:: -* GNU Guix:: -@end menu - -@node Debian 11 Bullseye -@subsection Debian 11 Bullseye - -The two themes are distributed as a single package for Debian and its -derivatives. Currently in the unstable and testing suites and should be -available in time for Debian 11 Bullseye (next stable). - -Get them with: - -@example -sudo apt install elpa-modus-themes -@end example - -@node GNU Guix -@subsection GNU Guix - -Users of either the Guix System (the distro) or just Guix (the package -manager) can get each theme as a standalone package. - -@example -guix package -i emacs-modus-operandi-theme -@end example - -And/or: - -@example -guix package -i emacs-modus-vivendi-theme -@end example - -@node Enable and load -@chapter Enable and load - -This section documents how to load the theme of your choice and how to -further control its initialization. It also includes some sample code -snippets that could help you in the task, especially if you intend to -use both Modus Operandi and Modus Vivendi. - -@menu -* Load automatically:: -* Load at a given time or at sunset/sunrise:: -* Toggle between the themes on demand:: -* Configure options prior to loading:: -@end menu - -@node Load automatically -@section Load automatically - -A simple way to load the theme from your Emacs initialization file is to -include either of the following expressions: - -@lisp -(load-theme 'modus-operandi t) ; Light theme -(load-theme 'modus-vivendi t) ; Dark theme -@end lisp - -Make sure to remove any other theme that is being loaded, otherwise you -might run into unexpected issues. - -Note that you can always @samp{M-x disable-theme} and specify an item. The -command does exactly what its name suggests. To deactivate all enabled -themes at once, in case you have multiple of them enabled, you may -evaluate the expression: - -@lisp -(mapc #'disable-theme custom-enabled-themes) -@end lisp - -@node Load at a given time or at sunset/sunrise -@section Load at a given time or at sunset/sunrise - -It is possible to schedule a time during the day at or after which a -given theme will be loaded.@footnote{Contributed on Reddit by user @samp{b3n} -@uref{https://www.reddit.com/r/emacs/comments/gdtqov/weekly_tipstricketc_thread/fq9186h/}.} - -@lisp -;; Light for the day -(load-theme 'modus-operandi t t) -(run-at-time "05:00" (* 60 60 24) - (lambda () - (enable-theme 'modus-operandi))) - -;; Dark for the night -(load-theme 'modus-vivendi t t) -(run-at-time "21:00" (* 60 60 24) - (lambda () - (enable-theme 'modus-vivendi))) -@end lisp - -A modified version of the above technique is to use the sunrise and -sunset as references, instead of specifying a fixed hour value.@footnote{Contributed directly by André Alexandre Gomes @uref{https://gitlab.com/aadcg}.} -If you set @samp{calendar-latitude} and @samp{calendar-longitude} (defined in the -built-in @samp{solar.el} library---read it with @samp{M-x find-library}), you can -automatically switch between both themes at the appropriate time-of-day. -Note that @emph{those calendar variables need to be set before loading the -themes}. - -@lisp -;; Define coordinates -(setq calendar-latitude 35.17 - calendar-longitude 33.36) - -;; Light at sunrise -(load-theme 'modus-operandi t t) -(run-at-time (nth 1 (split-string (sunrise-sunset))) - (* 60 60 24) - (lambda () - (enable-theme 'modus-operandi))) - -;; Dark at sunset -(load-theme 'modus-vivendi t t) -(run-at-time (nth 4 (split-string (sunrise-sunset))) - (* 60 60 24) - (lambda () - (enable-theme 'modus-vivendi))) -@end lisp - -For the sake of completeness, the @samp{load-theme} call in these snippets is -slightly different than the one shown in @ref{Load automatically}, because it -does not enable the theme directly: the subsequent @samp{enable-theme} does -that when needed. - -@node Toggle between the themes on demand -@section Toggle between the themes on demand - -With both themes available, it is possible to design a simple command to -switch between them on demand. - -@lisp -(defun modus-themes-toggle () - "Toggle between `modus-operandi' and `modus-vivendi' themes." - (interactive) - (if (eq (car custom-enabled-themes) 'modus-operandi) - (progn - (disable-theme 'modus-operandi) - (load-theme 'modus-vivendi t)) - (disable-theme 'modus-vivendi) - (load-theme 'modus-operandi t))) -@end lisp - -You could use @samp{(mapc #'disable-theme custom-enabled-themes)} instead of -disabling a single target, but you get the idea. - -@node Configure options prior to loading -@section Configure options prior to loading - -If you plan to use both themes and wish to apply styles consistently -(see @ref{Customization Options}), you could define wrapper functions around -the standard @samp{load-theme} command. These extend the simple function we -presented in @ref{Toggle between the themes on demand}. - -Here is a comprehensive setup (the values assigned to the variables are -just for the sake of this demonstration):@footnote{The @samp{defmacro} and @samp{dolist} -method were contributed on Reddit by user @samp{b3n}, -@uref{https://www.reddit.com/r/emacs/comments/gqsz8u/weekly_tipstricketc_thread/fsfakhg/}.} - -@lisp -(defmacro modus-themes-format-sexp (sexp &rest objects) - `(eval (read (format ,(format "%S" sexp) ,@@objects)))) - -(dolist (theme '("operandi" "vivendi")) - (modus-themes-format-sexp - (defun modus-%1$s-theme-load () - (setq modus-%1$s-theme-slanted-constructs t - modus-%1$s-theme-bold-constructs t - modus-%1$s-theme-fringes 'subtle ; @{nil,'subtle,'intense@} - modus-%1$s-theme-mode-line '3d ; @{nil,'3d,'moody@} - modus-%1$s-theme-faint-syntax nil - modus-%1$s-theme-intense-hl-line nil - modus-%1$s-theme-intense-paren-match nil - modus-%1$s-theme-no-link-underline t - modus-%1$s-theme-no-mixed-fonts nil - modus-%1$s-theme-prompts nil ; @{nil,'subtle,'intense@} - modus-%1$s-theme-completions 'moderate ; @{nil,'moderate,'opinionated@} - modus-%1$s-theme-diffs nil ; @{nil,'desaturated,'fg-only@} - modus-%1$s-theme-org-blocks 'greyscale ; @{nil,'greyscale,'rainbow@} - modus-%1$s-theme-headings ; Read further below in the manual for this one - '((1 . section) - (2 . line) - (t . rainbow-line-no-bold)) - modus-%1$s-theme-variable-pitch-headings nil - modus-%1$s-theme-scale-headings t - modus-%1$s-theme-scale-1 1.1 - modus-%1$s-theme-scale-2 1.15 - modus-%1$s-theme-scale-3 1.21 - modus-%1$s-theme-scale-4 1.27 - modus-%1$s-theme-scale-5 1.33) - (load-theme 'modus-%1$s t)) - theme)) - -(defun modus-themes-toggle () - "Toggle between `modus-operandi' and `modus-vivendi' themes." - (interactive) - (if (eq (car custom-enabled-themes) 'modus-operandi) - (progn - (disable-theme 'modus-operandi) - (modus-vivendi-theme-load)) - (disable-theme 'modus-vivendi) - (modus-operandi-theme-load))) -@end lisp - -@node Customization Options -@chapter Customization Options - -The Modus themes are highly configurable, though they should work well -without any further tweaks. - -By default, all customization options are set to @samp{nil}. - -All customization options need to be evaluated before loading their -theme (@pxref{Enable and load}). - -@menu -* Bold constructs:: Toggle bold constructs in code -* Slanted constructs:: Toggle slanted constructs (italics) in code -* Syntax highlighting:: Toggle subtle coloration in programming modes -* No mixed fonts:: Toggle mixing of font families -* Link underline:: Toggle underlined text in links -* Command prompts:: Choose among plain, subtle, or intense prompts -* Mode line:: Choose among plain, three-dimension, or moody-compliant styles -* Completion UIs:: Choose among standard, moderate, or opinionated looks -* Fringes:: Choose among plain, subtle, or intense fringe visibility -* Line highlighting:: Toggle intense style for current line highlighting -* Matching parentheses:: Toggle intense style for matching delimiters/parentheses -* Diffs:: Choose among intense, desaturated, or text-only diffs -* Org mode blocks:: Choose among plain, greyscale, or rainbow styles -* Heading styles:: Choose among several styles, also per heading level -* Scaled headings:: Toggle scaling of headings -* Headings' font:: Toggle proportionately spaced fonts in headings -@end menu - -@node Bold constructs -@section Option for more bold constructs - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-bold-constructs} -@item -@samp{modus-vivendi-theme-bold-constructs} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Display several constructs in bold weight. This concerns keywords and -other important aspects of code syntax. It also affects certain mode -line indicators and command-line prompts. - -The default is to only use a bold weight when it is required. - -Additionally, and while not necessary, to define the precise weight for -bold constructs, you can change the typographic intensity of the @samp{bold} -face. The standard is a bold weight. It requires no further -intervention. Assuming though that your typeface of choice supports a -``semibold'' weight, adding the following snippet to your init file should -suffice. - -@lisp -(set-face-attribute 'bold nil :weight 'semibold) -@end lisp - -Note that if you are switching themes, you need to re-evaluate this -expression after the new theme is loaded. - -@node Slanted constructs -@section Option for more slanted constructs - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-slanted-constructs} -@item -@samp{modus-vivendi-theme-slanted-constructs} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Choose to render more faces in slanted text (italics). This typically -affects documentation strings and code comments. - -The default is to not use italics unless it is absolutely necessary. - -@node Syntax highlighting -@section Option for faint code syntax highlighting - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-faint-syntax} -@item -@samp{modus-vivendi-theme-faint-syntax} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Use less saturated colors in programming modes for highlighting code -syntax. The default is to use saturated colors. - -This option essentially affects the font-lock faces, so it may also have -implications in other places that are hard-wired to rely directly on -them instead of specifying their own faces (which could inherit from -font-lock if that is the intent). The author is aware of @samp{vc-dir} as a -case in point. - -@node No mixed fonts -@section Option for no font mixing - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-no-mixed-fonts} -@item -@samp{modus-vivendi-theme-no-mixed-fonts} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -By default, the themes configure some spacing-sensitive faces, such as -Org tables and code blocks, to always inherit from the @samp{fixed-pitch} face. -This is to ensure that those constructs remain monospaced when users opt -for something like the built-in @kbd{M-x variable-pitch-mode}. Otherwise the -layout would appear broken. To disable this behaviour, set the option -to @samp{t}. - -Users may prefer to use another package for handling mixed typeface -configurations, rather than letting the theme do it, perhaps because a -purpose-specific package has extra functionality. Two possible options -are @samp{org-variable-pitch} and @samp{mixed-pitch}. - -@node Link underline -@section Option for no link underline - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-no-link-underline} -@item -@samp{modus-vivendi-theme-no-link-underline} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Remove the underline effect from links, symbolic links, and buttons. -The default is to apply an underline. - -@node Command prompts -@section Option for command prompt styles - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-prompts} -@item -@samp{modus-vivendi-theme-prompts} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{subtle} -@item -@samp{intense} -@end enumerate - -The symbols ``subtle'' and ``intense'' will apply a combination of accented -background and foreground to the minibuffer and other REPL prompts (like -@samp{M-x shell} and @samp{M-x eshell}). The difference between the two is that the -latter has a more pronounced/noticeable effect than the former. - -The default does not use any background for such prompts, while relying -exclusively on an accented foreground color. - -@node Mode line -@section Option for mode line presentation - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-mode-line} -@item -@samp{modus-vivendi-theme-mode-line} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{3d} -@item -@samp{moody} -@end enumerate - -The default value (@samp{nil}) produces a two-dimensional effect both for the -active and inactive modelines. The differences between the two are -limited to distinct shades of greyscale values, with the active being -more intense than the inactive. - -A @samp{3d} symbol will make the active modeline look like a three-dimensional -rectangle. Inactive modelines remain 2D, though they are slightly toned -down relative to the default. This aesthetic is the same as what you -get when you run Emacs without any customizations (@kbd{emacs -Q} on the -command line). - -While @samp{moody} removes all box effects from the modelines and applies -underline and overline properties instead. It also tones down a bit the -inactive modelines. This is meant to optimize things for use with the -@uref{https://github.com/tarsius/moody, moody package} (hereinafter referred to as ``Moody''), though it can work -fine even without it. - -Note that Moody does not expose any faces that the themes could style -directly. Instead it re-purposes existing ones to render its tabs and -ribbons. As such, there may be cases where the contrast ratio falls -below the 7:1 target that the themes conform with (WCAG AAA). To hedge -against this, we configure a fallback foreground for the @samp{moody} option, -which will come into effect when the background of the modeline changes -to something less accessible, such as Moody ribbons (read the doc string -of @samp{set-face-attribute}, specifically @samp{:distant-foreground}). This fallback -comes into effect when Emacs determines that the background and -foreground of the given construct are too close to each other in terms -of color distance. In effect, users would need to experiment with the -variable @samp{face-near-same-color-threshold} to trigger the fallback color. -We find that a value of @samp{45000} would suffice, contrary to the default -@samp{30000}. Do not set the value too high, because that would have the -adverse effect of always overriding the default color (which has been -carefully designed to be highly accessible). - -Furthermore, because Moody expects an underline and overline instead of -a box style, it is recommended you also include this in your setup: - -@lisp -(setq x-underline-at-descent-line t) -@end lisp - -@node Completion UIs -@section Option for completion framework aesthetics - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-completions} -@item -@samp{modus-vivendi-theme-completions} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{moderate} -@item -@samp{opinionated} -@end enumerate - -This is a special option that has different effects depending on the -completion UI@. The interfaces can be grouped in two categories, based -on their default aesthetics: (i) those that only or mostly use -foreground colors for their interaction model, and (ii) those that -combine background and foreground values for some of their metaphors. -The former category encompasses Icomplete, Ido, Selectrum as well as -pattern matching styles like Orderless and Flx. The latter covers Helm, -Ivy, and similar. - -A value of @samp{nil} will respect the metaphors of each completion framework. - -The symbol @samp{moderate} will apply a combination of background and -foreground that is fairly subtle. For Icomplete and friends this -constitutes a departure from their default aesthetics, however the -difference is small. While Helm et al will appear slightly different -than their original looks, as they are toned down a bit. - -The symbol @samp{opinionated} will apply color combinations that refashion the -completion UI@. For the Icomplete camp this means that intense -background and foreground combinations are used: in effect their looks -emulate those of Ivy and co. in their original style. Whereas the other -group of packages will revert to an even more nuanced aesthetic with -some additional changes to the choice of hues. - -To appreciate the scope of this customization option, you should spend -some time with every one of the @samp{nil} (default), @samp{moderate}, and @samp{opinionated} -possibilities. - -@node Fringes -@section Option for fringe visibility - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-fringes} -@item -@samp{modus-vivendi-theme-fringes} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{subtle} -@item -@samp{intense} -@end enumerate - -The ``subtle'' symbol will apply a greyscale background that is visible, -yet close enough to the main background color. While the ``intense'' -symbol will use a more noticeable greyscale background. - -The default is to use the same color as that of the main background, -meaning that the fringes are not obvious though they still occupy the -space given to them by @samp{fringe-mode}. - -@node Line highlighting -@section Option for line highlighting (hl-line-mode) - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-intense-hl-line} -@item -@samp{modus-vivendi-theme-intense-hl-line} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Draw the current line of @samp{hl-line-mode} or its global equivalent in a more -prominent background color. This would also affect several packages -that enable @samp{hl-line-mode}, such as @samp{elfeed} and @samp{mu4e}. - -The default is to use a more subtle gray. - -@node Matching parentheses -@section Option for parenthesis matching (show-paren-mode) - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-intense-paren-match} -@item -@samp{modus-vivendi-theme-intense-paren-match} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Apply a more intense background to the matching parentheses (or -delimiters). This affects tools such as the built-in @samp{show-paren-mode}. -The default is to use a subtle warm color for the background of those -overlays. - -@node Diffs -@section Option for diff buffer looks - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-diffs} -@item -@samp{modus-vivendi-theme-diffs} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{desaturated} -@item -@samp{fg-only} -@end enumerate - -By default the themes will apply richly colored backgrounds to the -output of diffs, such as those of @samp{diff-mode}, @samp{ediff}, @samp{smerge-mode}, and -@samp{magit}. These are color combinations of an accented background and -foreground so that, for example, added lines have a pronounced green -background with an appropriate shade of green for the affected text. -Word-wise or ``refined'' changes follow this pattern but use different -shades of those colors to remain distinct. - -A @samp{desaturated} value tones down all relevant color values. It still -combines an accented background with an appropriate foreground, yet its -overall impression is very subtle. Refined changes are a bit more -intense to fulfil their intended function, though still less saturated -than default. - -While @samp{fg-only} will remove all accented backgrounds and instead rely on -color-coded text to denote changes. For instance, added lines use an -intense green foreground, while their background is the same as the rest -of the buffer. Word-wise highlights still use a background value which -is, nonetheless, more subtle than its default equivalent. - -Concerning @samp{magit}, an extra set of tweaks are introduced for the effect -of highlighting the current diff hunk, so as to remain consistent with -the overall experience of that mode. Expect changes that are consistent -with the overall intent of the aforementioned. - -@node Org mode blocks -@section Option for org-mode block styles - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-org-blocks} -@item -@samp{modus-vivendi-theme-org-blocks} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{greyscale} -@item -@samp{rainbow} -@end enumerate - -The default is to use the same background as the rest of the buffer for -the contents of the block. - -A value of @samp{greyscale} will apply a subtle neutral gray background to the -block's contents. It will also extend to the edge of the window the -background of the ``begin'' and ``end'' block delimiter lines (only relevant -for Emacs versions >= 27 where the 'extend' keyword is recognised by -@samp{set-face-attribute}). - -While @samp{rainbow} will instead use an accented background for the contents -of the block. The exact color will depend on the programming language -and is controlled by the @samp{org-src-block-faces} variable (refer to the -theme's source code for the current association list). This is most -suitable for users who work on literate programming documents that mix -and match several languages. - -Note that the ``rainbow'' blocks may require you to also reload the -major-mode so that the colors are applied properly: use @kbd{M-x org-mode} or -@kbd{M-x org-mode-restart} to refresh the buffer. Or start typing in each -code block (inefficient at scale, but it still works). - -@node Heading styles -@section Option for headings' overall style - -This is defined as an alist and, therefore, uses a different approach -than other customization options documented in this manual. - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-headings} -@item -@samp{modus-vivendi-theme-headings} -@end itemize - -Possible values, which can be specified for each heading level (examples -further below): - -@itemize -@item -nil (default fallback option---covers all heading levels) -@item -@samp{t} (default style for a single heading, when the fallback differs) -@item -@samp{no-bold} -@item -@samp{line} -@item -@samp{line-no-bold} -@item -@samp{rainbow} -@item -@samp{rainbow-line} -@item -@samp{rainbow-line-no-bold} -@item -@samp{highlight} -@item -@samp{highlight-no-bold} -@item -@samp{rainbow-highlight} -@item -@samp{rainbow-highlight-no-bold} -@item -@samp{section} -@item -@samp{section-no-bold} -@item -@samp{rainbow-section} -@item -@samp{rainbow-section-no-bold} -@end itemize - -To control faces per level from 1-8, use something like this (same for -@samp{modus-vivendi-theme-headings}): - -@lisp -(setq modus-operandi-theme-headings - '((1 . section) - (2 . line) - (3 . highlight) - (t . rainbow-no-bold))) -@end lisp - -The above uses the @samp{section} value for heading levels 1, the @samp{line} for -headings 2, @samp{highlight} for 3. All other levels fall back to -@samp{rainbow-line-no-bold}. - -To set a uniform value for all heading levels, use this pattern: - -@lisp -;; A given style for every heading -(setq modus-operandi-theme-headings - '((t . rainbow-line-no-bold))) - -;; Default aesthetic for every heading -(setq modus-operandi-theme-headings - '((t . nil))) -@end lisp - -The default style for headings uses a fairly desaturated foreground -value in combination with a bold typographic weight. To specify this -style for a given level N (assuming you wish to have another fallback -option), just specify the value @samp{t} like this: - -@lisp -(setq modus-operandi-theme-headings - '((1 . t) - (2 . line) - (t . rainbow-line-no-bold))) -@end lisp - -A description of all other possible styles: - -@itemize -@item -@samp{no-bold} retains the default text color while removing the typographic -weight. - -@item -@samp{line} is the same as the default plus an overline over the heading. - -@item -@samp{line-no-bold} is the same as @samp{line} without bold weight. - -@item -@samp{rainbow} uses a more colorful foreground in combination with bold -weight. - -@item -@samp{rainbow-line} is the same as @samp{rainbow} plus an overline. - -@item -@samp{rainbow-line-no-bold} is the same as @samp{rainbow-line} without the bold -weight. - -@item -@samp{highlight} retains the default style of a fairly desaturated foreground -combined with a bold weight and adds to it a subtle accented -background. - -@item -@samp{highlight-no-bold} is the same as @samp{highlight} without a bold weight. - -@item -@samp{rainbow-highlight} is the same as @samp{highlight} but with a more colorful -foreground. - -@item -@samp{rainbow-highlight-no-bold} is the same as @samp{rainbow-highlight} without a -bold weight. - -@item -@samp{section} retains the default looks and adds to them both an overline -and a slightly accented background. It is, in effect, a combination -of the @samp{line} and @samp{highlight} values. - -@item -@samp{section-no-bold} is the same as @samp{section} without a bold weight. - -@item -@samp{rainbow-section} is the same as @samp{section} but with a more colorful -foreground. - -@item -@samp{rainbow-section-no-bold} is the same as @samp{rainbow-section} without a bold -weight.`` -@end itemize - -@node Scaled headings -@section Option for scaled headings - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-scale-headings} -@item -@samp{modus-vivendi-theme-scale-headings} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Make headings larger in height relative to the main text. This is -noticeable in modes like Org. The default is to use the same size for -headings and body copy. - -@menu -* Scaled heading sizes:: Specify rate of increase for scaled headings -@end menu - -@node Scaled heading sizes -@subsection Control the scale of headings - -In addition to toggles for enabling scaled headings, users can also -specify a number of their own. - -@itemize -@item -If it is a floating point, say, @samp{1.5}, it is interpreted as a multiple -of the base font size. This is the recommended method. - -@item -If it is an integer, it is read as an absolute font height. The -number is basically the point size multiplied by ten. So if you want -it to be @samp{18pt} you must pass @samp{180}. Please understand that setting an -absolute value is discouraged, as it will break the layout when you -try to change font sizes with the built-in @samp{text-scale-adjust} command -(see @ref{Font configs (DIY), , Font configurations}). -@end itemize - -Below are the variables in their default values, using the floating -point paradigm. The numbers are very conservative, but you are free to -change them to your liking, such as @samp{1.2}, @samp{1.4}, @samp{1.6}, @samp{1.8}, @samp{2.0}---or use a -resource for finding a consistent scale: - -@lisp -(setq modus-operandi-theme-scale-1 1.05 - modus-operandi-theme-scale-2 1.1 - modus-operandi-theme-scale-3 1.15 - modus-operandi-theme-scale-4 1.2 - modus-operandi-theme-scale-5 1.3) - -(setq modus-vivendi-theme-scale-1 1.05 - modus-vivendi-theme-scale-2 1.1 - modus-vivendi-theme-scale-3 1.15 - modus-vivendi-theme-scale-4 1.2 - modus-vivendi-theme-scale-5 1.3) -@end lisp - -Note that in earlier versions of Org, scaling would only increase the -size of the heading, but not of keywords that were added to it, like -``TODO''. The issue has been fixed upstream: -@uref{https://protesilaos.com/codelog/2020-09-24-org-headings-adapt/}. - -@node Headings' font -@section Option for variable-pitch font in headings - -Symbol names: - -@itemize -@item -@samp{modus-operandi-theme-variable-pitch-headings} -@item -@samp{modus-vivendi-theme-variable-pitch-headings} -@end itemize - -Possible values: - -@enumerate -@item -@samp{nil} (default) -@item -@samp{t} -@end enumerate - -Choose to apply a proportionately spaced, else ``variable-pitch'', -typeface to headings (such as in Org mode). The default is to use the -main font family. - -@ref{Font configs (DIY), , Font configurations for Org (and others)}. - -@node Advanced customization (do-it-yourself) -@chapter Advanced customization (do-it-yourself) - -Unlike the predefined customization options which follow a -straightforward pattern of allowing the user to quickly specify their -preference, the themes also provide a more flexible, albeit difficult, -mechanism to control things with precision (see @ref{Customization Options}). - -This section is of interest only to users who are prepared to maintain -their own local tweaks and who are willing to deal with any possible -incompatibilities between versioned releases of the themes. As such, -they are labelled as ``do-it-yourself'' or ``DIY''. - -@menu -* Tweak colors (DIY):: Declare your own palette overrides -* Font configs (DIY):: Optimise for mixed typeface buffers -* Org user faces (DIY):: Extend styles for org-mode keywords and priorities -@end menu - -@node Tweak colors (DIY) -@section Full access to the themes' palette - -The variables are: - -@itemize -@item -@samp{modus-operandi-theme-override-colors-alist} -@item -@samp{modus-vivendi-theme-override-colors-alist} -@end itemize - -Users can specify an association list that maps the names of color -variables to hexadecimal RGB values (in the form of @samp{#RRGGBB}). This -means that it is possible to override the entire palette or subsets -thereof (see the source code for the actual names and values). - -Example: - -@lisp -;; Redefine the values of those three variables for the given theme -(setq modus-vivendi-theme-override-colors-alist - '(("magenta" . "#ffaabb") - ("magenta-alt" . "#ee88ff") - ("magenta-alt-other" . "#bbaaff"))) -@end lisp - -If you want to be creative, you can define a minor mode that refashions -the themes on demand. The following is a minor mode that gets activated -on demand. We combine it with the function to switch between Modus -Operandi and Modus Vivendi (@pxref{Toggle between the themes on demand}, for -a basic command, and/or @pxref{Configure options prior to loading}, for a more -comprehensive setup). - -@lisp -(define-minor-mode modus-themes-alt-mode - "Override Modus themes' palette variables with custom values. - -This is intended as a proof-of-concept. It is, nonetheless, a -perfectly accessible alternative, conforming with the design -principles of the Modus themes. It still is not as good as the -default colors." - :init-value nil - :global t - (if modus-themes-alt-mode - (setq modus-operandi-theme-override-colors-alist - '(("bg-main" . "#fefcf4") - ("bg-dim" . "#faf6ef") - ("bg-alt" . "#f7efe5") - ("bg-hl-line" . "#f4f0e3") - ("bg-active" . "#e8dfd1") - ("bg-inactive" . "#f6ece5") - ("bg-region" . "#c6bab1") - ("bg-header" . "#ede3e0") - ("bg-tab-bar" . "#dcd3d3") - ("bg-tab-active" . "#fdf6eb") - ("bg-tab-inactive" . "#c8bab8") - ("fg-unfocused" . "#55556f")) - modus-vivendi-theme-override-colors-alist - '(("bg-main" . "#100b17") - ("bg-dim" . "#161129") - ("bg-alt" . "#181732") - ("bg-hl-line" . "#191628") - ("bg-active" . "#282e46") - ("bg-inactive" . "#1a1e39") - ("bg-region" . "#393a53") - ("bg-header" . "#202037") - ("bg-tab-bar" . "#262b41") - ("bg-tab-active" . "#120f18") - ("bg-tab-inactive" . "#3a3a5a") - ("fg-unfocused" . "#9a9aab"))) - (setq modus-operandi-theme-override-colors-alist nil - modus-vivendi-theme-override-colors-alist nil))) - -(defun modus-themes-toggle (&optional arg) - "Toggle between `modus-operandi' and `modus-vivendi' themes. - -With optional \\[universal-argument] prefix, enable -`modus-themes-alt-mode' for the loaded theme." - (interactive "P") - (if arg - (modus-themes-alt-mode 1) - (modus-themes-alt-mode -1)) - (if (eq (car custom-enabled-themes) 'modus-operandi) - (progn - (disable-theme 'modus-operandi) - (load-theme 'modus-vivendi t)) - (disable-theme 'modus-vivendi) - (load-theme 'modus-operandi t))) -@end lisp - -@printindex cp - -@node Font configs (DIY) -@section Font configurations for Org (and others) - -The themes are designed to cope well with mixed font settings (@ref{No mixed fonts, , Option -for no font mixing}). Currently this applies to @samp{org-mode} and -@samp{markdown-mode}. - -In practice it means that the user can safely opt for a more -prose-friendly proportionately spaced typeface as their default, while -letting spacing-sensitive elements like tables and inline code always -use a monospaced font, by inheriting from the @samp{fixed-pitch} face. - -Users can try the built-in @kbd{M-x variable-pitch-mode} to see the effect in -action. - -To make everything use your desired font families, you need to configure -the @samp{variable-pitch} (proportional spacing) and @samp{fixed-pitch} (monospaced) -faces respectively. It may also be convenient to set your main typeface -by configuring the @samp{default} face the same way. - -Put something like this in your initialization file (make sure to read -the documentation of @samp{set-face-attribute}, with @kbd{M-x describe-function}): - -@lisp -;; Main typeface -(set-face-attribute 'default nil :family "DejaVu Sans Mono" :height 110) - -;; Proportionately spaced typeface -(set-face-attribute 'variable-pitch nil :family "DejaVu Serif" :height 1.0) - -;; Monospaced typeface -(set-face-attribute 'fixed-pitch nil :family "DejaVu Sans Mono" :height 1.0) -@end lisp - -Note the differences in the @samp{:height} property. The @samp{default} face must -specify an absolute value, which is the point size × 10. So if you want -to use a font at point size @samp{11}, you set the height at @samp{110}.@footnote{@samp{:height} -values do not need to be rounded to multiples of ten: the likes of @samp{115} -are perfectly valid—some typefaces will change to account for those -finer increments.} Whereas every other face must have a value that is -relative to the default, represented as a floating point (if you use an -integer, say, @samp{15} then that means an absolute height). This is of -paramount importantance: it ensures that all fonts can scale gracefully -when using something like the @samp{text-scale-adjust} command which only -operates on the base font size (i.e. the @samp{default} face's absolute -height). - -An alternative syntax for the @samp{default} face, is to pass all typeface -parameters directly to a @samp{font} property.@footnote{Has the benefit of -accepting @samp{fontconfig} parameters (GNU/Linux), such as @samp{"DejaVu Sans -Mono-11:hintstyle=hintslight:autohint=false"}. -@uref{https://www.freedesktop.org/software/fontconfig/fontconfig-user.html}} -Note that here we use a standard point size: - -@lisp -(set-face-attribute 'default nil :font "DejaVu Sans Mono-11") -@end lisp - -Again, remember to only ever specify an absolute height for the @samp{default}. - -@printindex cp - -@node Org user faces (DIY) -@section Org user faces (DIY) - -Users of @samp{org-mode} have the option to configure various keywords and -priority cookies to better match their workflow. User options are -@samp{org-todo-keyword-faces} and @samp{org-priority-faces}. - -As those are meant to be custom faces, it would be futile to have the -themes try to guess what each user would want to use, which keywords to -target, and so on. Instead, we can provide guidelines on how to -customize things to one's liking with the intent of retaining the -overall aesthetics of the theme. - -Please bear in mind that the end result of those is not controlled by -the active theme but by how Org maps faces to its constructs. Editing -those while @samp{org-mode} is active requires @kbd{M-x org-mode-restart} for changes -to take effect. - -Let us assume you wish to visually differentiate your keywords. You -have something like this: - -@lisp -(setq org-todo-keywords - '((sequence "TODO(t)" "|" "DONE(D)" "CANCEL(C)") - (sequence "MEET(m)" "|" "MET(M)") - (sequence "STUDY(s)" "|" "STUDIED(S)") - (sequence "WRITE(w)" "|" "WROTE(W)"))) -@end lisp - -You could then use a variant of the following to inherit from a face -that uses the styles you want and also to preserve the properties -applied by the @samp{org-todo} face: - -@lisp -(setq org-todo-keyword-faces - '(("MEET" . '(font-lock-preprocessor-face org-todo)) - ("STUDY" . '(font-lock-variable-name-face org-todo)) - ("WRITE" . '(font-lock-type-face org-todo)))) -@end lisp - -This will refashion the keywords you specify, while letting the other -items in @samp{org-todo-keywords} use their original styles (which are defined -in the @samp{org-todo} and @samp{org-done} faces). - -If you want back the defaults, try specifying just the @samp{org-todo} face: - -@lisp -(setq org-todo-keyword-faces - '(("MEET" . org-todo) - ("STUDY" . org-todo) - ("WRITE" . org-todo))) -@end lisp - -When you inherit from multiple faces, you need to quote the list as -shown further above. The order is important: the last item is applied -over the previous ones. If you do not want to blend multiple faces, you -do not need a quoted list. A pattern of @samp{keyword . face} would suffice. - -Both approaches can be used simultaneously, as illustrated in this -configuration of the priority cookies: - -@lisp -(setq org-priority-faces - '((?A . '(org-scheduled-today org-priority)) - (?B . org-priority) - (?C . '(shadow org-priority)))) -@end lisp - -To find all the faces that are loaded in your current Emacs session, use -@kbd{M-x list-faces-display}. Also try @kbd{M-x describe-variable} and then specify -the name of each of those Org variables demonstrated above. Their -documentation strings will offer you further guidance. - -Furthermore, consider reading the ``Notes for aspiring Emacs theme -developers'', published on 2020-08-28 by me (Protesilaos Stavrou): -@uref{https://protesilaos.com/codelog/2020-08-28-notes-emacs-theme-devs/}. - -@printindex cp - -@printindex cp - -@node Face coverage -@chapter Face coverage - -Modus Operandi and Modus Vivendi try to provide as close to full face -coverage as possible. This is necessary to ensure a consistently -accessible reading experience across all possible interfaces. - -@menu -* Supported packages:: Full list of covered face groups -* Covered indirectly:: -* Will NOT be supported:: -@end menu - -@node Supported packages -@section Full support for packages or face groups - -This list will always be updated to reflect the current state of the -project. The idea is to offer an overview of the known status of all -affected face groups. The items with an appended asterisk @samp{*} tend to -have lots of extensions, so the ``full support'' may not be 100% true… - -@itemize -@item -ace-window -@item -ag -@item -alert -@item -all-the-icons -@item -annotate -@item -anzu -@item -apropos -@item -apt-sources-list -@item -artbollocks-mode -@item -auctex and @TeX{} -@item -auto-dim-other-buffers -@item -avy -@item -awesome-tray -@item -binder -@item -bm -@item -bongo -@item -boon -@item -breakpoint (provided by the built-in @samp{gdb-mi.el} library) -@item -buffer-expose -@item -calendar and diary -@item -calfw -@item -centaur-tabs -@item -change-log and log-view (such as @samp{vc-print-log} and @samp{vc-print-root-log}) -@item -cider -@item -circe -@item -color-rg -@item -column-enforce-mode -@item -company-mode* -@item -company-posframe -@item -compilation-mode -@item -completions -@item -counsel* -@item -counsel-css -@item -counsel-notmuch -@item -counsel-org-capture-string -@item -cov -@item -cperl-mode -@item -csv-mode -@item -ctrlf -@item -custom (@kbd{M-x customize}) -@item -dap-mode -@item -dashboard (emacs-dashboard) -@item -deadgrep -@item -debbugs -@item -define-word -@item -deft -@item -dictionary -@item -diff-hl -@item -diff-mode -@item -dim-autoload -@item -dir-treeview -@item -dired -@item -dired-async -@item -dired-git -@item -dired-git-info -@item -dired-narrow -@item -dired-subtree -@item -diredfl -@item -disk-usage -@item -doom-modeline -@item -dynamic-ruler -@item -easy-jekyll -@item -easy-kill -@item -ebdb -@item -ediff -@item -eglot -@item -el-search -@item -eldoc-box -@item -elfeed -@item -elfeed-score -@item -emms -@item -enhanced-ruby-mode -@item -epa -@item -equake -@item -erc -@item -eros -@item -ert -@item -eshell -@item -eshell-fringe-status -@item -eshell-git-prompt -@item -eshell-prompt-extras (epe) -@item -eshell-syntax-highlighting -@item -evil* (evil-mode) -@item -evil-goggles -@item -evil-visual-mark-mode -@item -eww -@item -eyebrowse -@item -fancy-dabbrev -@item -flycheck -@item -flycheck-color-mode-line -@item -flycheck-indicator -@item -flycheck-posframe -@item -flymake -@item -flyspell -@item -flyspell-correct -@item -flx -@item -freeze-it -@item -frog-menu -@item -focus -@item -fold-this -@item -font-lock (generic syntax highlighting) -@item -forge -@item -fountain (fountain-mode) -@item -geiser -@item -git-commit -@item -git-gutter (and variants) -@item -git-lens -@item -git-rebase -@item -git-timemachine -@item -git-walktree -@item -gnus -@item -golden-ratio-scroll-screen -@item -helm* -@item -helm-ls-git -@item -helm-switch-shell -@item -helm-xref -@item -helpful -@item -highlight-blocks -@item -highlight-defined -@item -highlight-escape-sequences (@samp{hes-mode}) -@item -highlight-indentation -@item -highlight-numbers -@item -highlight-symbol -@item -highlight-tail -@item -highlight-thing -@item -hl-defined -@item -hl-fill-column -@item -hl-line-mode -@item -hl-todo -@item -hydra -@item -hyperlist -@item -ibuffer -@item -icomplete -@item -icomplete-vertical -@item -ido-mode -@item -iedit -@item -iflipb -@item -imenu-list -@item -indium -@item -info -@item -info-colors -@item -interaction-log -@item -ioccur -@item -isearch, occur, etc. -@item -ivy* -@item -ivy-posframe -@item -jira (org-jira) -@item -journalctl-mode -@item -js2-mode -@item -julia -@item -jupyter -@item -kaocha-runner -@item -keycast -@item -line numbers (@samp{display-line-numbers-mode} and global variant) -@item -lsp-mode -@item -lsp-ui -@item -magit -@item -magit-imerge -@item -man -@item -markdown-mode -@item -markup-faces (@samp{adoc-mode}) -@item -mentor -@item -messages -@item -minibuffer-line -@item -minimap -@item -modeline -@item -mood-line -@item -moody -@item -mpdel -@item -mu4e -@item -mu4e-conversation -@item -multiple-cursors -@item -neotree -@item -no-emoji -@item -notmuch -@item -num3-mode -@item -nxml-mode -@item -objed -@item -orderless -@item -org* -@item -org-journal -@item -org-noter -@item -org-pomodoro -@item -org-recur -@item -org-roam -@item -org-superstar -@item -org-table-sticky-header -@item -org-treescope -@item -origami -@item -outline-mode -@item -outline-minor-faces -@item -package (@kbd{M-x list-packages}) -@item -page-break-lines -@item -paradox -@item -paren-face -@item -parrot -@item -pass -@item -persp-mode -@item -perspective -@item -phi-grep -@item -phi-search -@item -pkgbuild-mode -@item -pomidor -@item -powerline -@item -powerline-evil -@item -proced -@item -prodigy -@item -racket-mode -@item -rainbow-blocks -@item -rainbow-identifiers -@item -rainbow-delimiters -@item -rcirc -@item -regexp-builder (also known as @samp{re-builder}) -@item -rg (rg.el) -@item -ripgrep -@item -rmail -@item -ruler-mode -@item -sallet -@item -selectrum -@item -semantic -@item -sesman -@item -shell-script-mode -@item -show-paren-mode -@item -side-notes -@item -skewer-mode -@item -smart-mode-line -@item -smartparens -@item -smerge -@item -spaceline -@item -speedbar -@item -spell-fu -@item -stripes -@item -suggest -@item -switch-window -@item -swiper -@item -swoop -@item -sx -@item -symbol-overlay -@item -syslog-mode -@item -table (built-in table.el) -@item -telephone-line -@item -term -@item -tomatinho -@item -transient (pop-up windows such as Magit's) -@item -trashed -@item -treemacs -@item -tty-menu -@item -tuareg -@item -typescript -@item -undo-tree -@item -vc (built-in mode line status for version control) -@item -vc-annotate (@kbd{C-x v g}) -@item -vdiff -@item -vimish-fold -@item -visible-mark -@item -visual-regexp -@item -volatile-highlights -@item -vterm -@item -wcheck-mode -@item -web-mode -@item -wgrep -@item -which-function-mode -@item -which-key -@item -whitespace-mode -@item -window-divider-mode -@item -winum -@item -writegood-mode -@item -woman -@item -xah-elisp-mode -@item -xref -@item -xterm-color (and ansi-colors) -@item -yaml-mode -@item -yasnippet -@item -ztree -@end itemize - -Plus many other miscellaneous faces that are provided by the upstream -GNU Emacs distribution. - -@node Covered indirectly -@section Covered indirectly - -These do not require any extra styles because they are configured to -inherit from some basic faces. Please confirm. - -@itemize -@item -edit-indirect -@item -evil-owl -@item -perl-mode -@item -php-mode -@item -rjsx-mode -@item -swift-mode -@end itemize - -@node Will NOT be supported -@section Will NOT be supported - -I have thus far identified a single package that does fit into the -overarching objective of this project: @uref{https://github.com/hlissner/emacs-solaire-mode, solaire}. It basically tries to -cast a less intense background on the main file-visiting buffers, so -that secondary elements like sidebars can have the default (pure -white/black) background. - -I will only cover this package if it ever supports the inverse effect: -less intense colors (but still accessible) for ancillary interfaces -and the intended styles for the content you are actually working on. - -@node Notes for individual packages -@chapter Notes for individual packages - -This section covers information that may be of interest to users of -individual packages. - -@menu -* Note on company-mode overlay pop-up:: -* Note for ERC escaped color sequences:: -* Note for powerline or spaceline:: -* Note on shr colors:: -* Note for Helm grep:: -* Note on vc-annotate-background-mode:: -@end menu - -@node Note on company-mode overlay pop-up -@section Note on company-mode overlay pop-up - -By default, the @samp{company-mode} pop-up that lists completion candidates is -drawn using an overlay. This creates alignment issues every time it is -placed above a piece of text that has a different height than the -default. - -The solution recommended by the project's maintainer is to use an -alternative front-end for drawing the pop-up which uses child frames -instead of overlays.@footnote{@uref{https://github.com/company-mode/company-mode/issues/1010}}@footnote{@uref{https://github.com/tumashu/company-posframe/}} - -@node Note for ERC escaped color sequences -@section Note for ERC escaped color sequences - -The built-in IRC client @samp{erc} has the ability to colorise any text using -escape sequences that start with @samp{^C} (inserted with @samp{C-q C-c}) and are -followed by a number for the foreground and background.@footnote{This page -explains the basics, though it is not specific to Emacs: -@uref{https://www.mirc.com/colors.html}} Possible numbers are 0-15, with the -first entry being the foreground and the second the background, -separated by a comma. Like this @samp{^C1,6}. The minimum setup is this: - -@lisp -(add-to-list 'erc-modules 'irccontrols) -(setq erc-interpret-controls-p t - erc-interpret-mirc-color t) -@end lisp - -As this allows users to make arbitrary combinations, it is impossible to -guarantee a consistently high contrast ratio. All we can we do is -provide guidance on the combinations that satisfy the accessibility -standard of the themes: - -@table @asis -@item Modus Operandi -Use foreground color 1 for all backgrounds from -2-15. Like so: @samp{C-q C-c1,N} where @samp{N} is the background. - -@item Modus Vivendi -Use foreground color 0 for all backgrounds from -2-13. Use foreground @samp{1} for backgrounds 14, 15. -@end table - -Colors 0 and 1 are white and black respectively. So combine them -together, if you must. - -@node Note for powerline or spaceline -@section Note for powerline or spaceline - -Both Powerline and Spaceline package users will likely need to use the -command @samp{powerline-reset} whenever they make changes to their themes -and/or modeline setup. - -@node Note on shr colors -@section Note on shr colors - -Emacs' HTML rendering mechanism (@samp{shr}) may need explicit configuration to -respect the theme's colors instead of whatever specifications the -webpage provides. Consult @kbd{C-h v shr-use-colors}. - -@node Note for Helm grep -@section Note for Helm grep - -There is one face from the Helm package that is meant to highlight the -matches of a grep or grep-like command (@samp{ag} or @samp{ripgrep}). It is -@samp{helm-grep-match}. However, this face can only apply when the user does -not pass @samp{--color=always} as a command-line option for their command. - -Here is the docstring for that face, which is defined in the -@samp{helm-grep.el} library (view a library with @samp{M-x find-library}). - -@quotation -Face used to highlight grep matches. Have no effect when grep backend -use ``--color='' - -@end quotation - -The user must either remove @samp{--color} from the flags passed to the grep -function, or explicitly use @samp{--color=never} (or equivalent). Helm -provides user-facing customization options for controlling the grep -function's parameters, such as @samp{helm-grep-default-command} and -@samp{helm-grep-git-grep-command}. - -When @samp{--color=always} is in effect, the grep output will use red text in -bold letter forms to present the matching part in the list of -candidates. That style still meets the contrast ratio target of >= 7:1 -(accessibility standard WCAG AAA), because it draws the reference to -ANSI color number 1 (red) from the already-supported array of -@samp{ansi-color-names-vector}. - -@node Note on vc-annotate-background-mode -@section Note on vc-annotate-background-mode - -Due to the unique way @samp{vc-annotate} (@kbd{C-x v g}) applies colors, support for -its background mode (@samp{vc-annotate-background-mode}) is disabled at the -theme level. - -Normally, such a drastic measure should not belong in a theme: assuming -the user's preferences is bad practice. However, it has been deemed -necessary in the interest of preserving color contrast accessibility -while still supporting a useful built-in tool. - -If there actually is a way to avoid such a course of action, without -prejudice to the accessibility standard of this project, then please -report as much or send patches (see @ref{Contributing}). - -@node Contributing -@chapter Contributing - -This section documents the canonical sources of the themes and the ways -in which you can contribute to their ongoing development. - -@menu -* Sources of the themes:: -* Issues you can help with:: -* Merge requests:: Legal considerations for code patches -@end menu - -@node Sources of the themes -@section Sources of the themes - -The @samp{modus-operandi} and @samp{modus-vivendi} themes are built into Emacs. -Currently they are in the project's @samp{master} branch, which is tracking the -next development release target. - -The source code of the themes is @uref{https://gitlab.com/protesilaos/modus-themes/, available on Gitlab}, for the time -being. A @uref{https://github.com/protesilaos/modus-themes/, mirror on Github} is also on offer. - -An HTML version of this manual is available as an extension to the -@uref{https://protesilaos.com/modus-themes/, author's personal website} (does not rely on any non-free code). - -@node Issues you can help with -@section Issues you can help with - -A few tasks you can help with: - -@itemize -@item -Suggest refinements to packages that are covered. -@item -Report packages not covered thus far. -@item -Report bugs, inconsistencies, shortcomings. -@item -Help expand the documentation of covered-but-not-styled packages. -@item -Suggest refinements to the color palette. -@item -Help expand this document or any other piece of documentation. -@item -Merge requests for code refinements. -@end itemize - -@xref{Merge requests, , Patches require copyright assignment to the FSF}. - -It would be great if your feedback also includes some screenshots, GIFs, -or short videos, as well as further instructions to reproduce a given -setup. Though this is not a requirement. - -Whatever you do, bear in mind the overarching objective of the Modus -themes: to keep a contrast ratio that is greater or equal to 7:1 between -background and foreground colors. If a compromise is ever necessary -between aesthetics and accessibility, it shall always be made in the -interest of the latter. - -@node Merge requests -@section Patches require copyright assignment to the FSF - -Code contributions are most welcome. For any major edit (more than 15 -lines, or so, in aggregate per person), you need to make a copyright -assignment to the Free Software Foundation. This is necessary because -the themes are part of the upstream Emacs distribution: the FSF must at -all times be in a position to enforce the GNU General Public License. - -Copyright assignment is a simple process. Check the request form below -(please adapt it accordingly). You must write an email to the address -mentioned in the form and then wait for the FSF to send you a legal -agreement. Sign the document and file it back to them. This could all -happen via email and take about a week. You are encouraged to go -through this process. You only need to do it once. It will allow you -to make contributions to Emacs in general. - -@example -Please email the following information to assign@@gnu.org, and we -will send you the assignment form for your past and future changes. - -Please use your full legal name (in ASCII characters) as the subject -line of the message. ----------------------------------------------------------------------- -REQUEST: SEND FORM FOR PAST AND FUTURE CHANGES - -[What is the name of the program or package you're contributing to?] - -GNU Emacs - -[Did you copy any files or text written by someone else in these changes? -Even if that material is free software, we need to know about it.] - -Copied a few snippets from the same files I edited. Their author, -Protesilaos Stavrou, has already assigned copyright to the Free Software -Foundation. - -[Do you have an employer who might have a basis to claim to own -your changes? Do you attend a school which might make such a claim?] - - -[For the copyright registration, what country are you a citizen of?] - - -[What year were you born?] - - -[Please write your email address here.] - - -[Please write your postal address here.] - - - - - -[Which files have you changed so far, and which new files have you written -so far?] - -Changed a couple of themes that are part of the Emacs source code: - -./etc/themes/modus-operandi-theme.el -./etc/themes/modus-vivendi-theme.el -@end example - -@node Acknowledgements -@chapter Acknowledgements - -The Modus themes are a collective effort. Every contribution counts. - -@table @asis -@item Author/maintainer -Protesilaos Stavrou. - -@item Code contributions -Anders Johansson, Basil L@. Contovounesios, -Markus Beppler, Matthew Stevenson. - -@item Ideas and user feedback -Aaron Jensen, Adam Spiers, Alex Griffin, -Alex Peitsinis, Alexey Shmalko, Anders Johansson, André Alexandre -Gomes, Arif Rezai, Basil L@. Contovounesios, Damien Cassou, Dario -Gjorgjevski, David Edmondson, Davor Rotim, Divan Santana, Gerry -Agbobada, Gianluca Recchia, Iris Garcia, Len Trigg, Manuel Uberti, -Mark Burton, Markus Beppler, Michael Goldenberg, Murilo Pereira, -Nicolas De Jaeghere, Pierre Téchoueyres, Roman Rudakov, Ryan Phillips, -Shreyas Ragavan, Tassilo Horn, Thibaut Verron, Trey Merkley, Uri -Sharf, Utkarsh Singh, Vincent Foley. As well as users: Ben, -Fourchaux, Fredrik, Moesasji, Nick, TheBlob42, dinko, doolio, jixiuf, -okamsn, tycho garen. - -@item Packaging -Dhavan Vaidya (Debian), Stefan Kangas (core Emacs), -Stefan Monnier (GNU Elpa). - -@item Inspiration for certain features -Fabrice Niessen (leuven-theme), -Bozhidar Batsov (zenburn-theme). -@end table - -@node Meta -@chapter Meta - -If you are curious about the principles that govern the development of -this project read the essay @uref{https://protesilaos.com/codelog/2020-03-17-design-modus-themes-emacs/, On the design of the Modus themes} -(2020-03-17). - -Here are some more publications for those interested in the kind of work -that goes into this project (sometimes the commits also include details -of this sort): - -@itemize -@item -@uref{https://protesilaos.com/codelog/2020-05-10-modus-operandi-palette-review/, Modus Operandi theme subtle palette review} (2020-05-10) -@item -@uref{https://protesilaos.com/codelog/2020-06-13-modus-vivendi-palette-review/, Modus Vivendi theme subtle palette review} (2020-06-13) -@item -@uref{https://protesilaos.com/codelog/2020-07-04-modus-themes-faint-colours/, Modus themes: new ``faint syntax'' option} (2020-07-04) -@item -@uref{https://protesilaos.com/codelog/2020-07-08-modus-themes-nuanced-colours/, Modus themes: major review of ``nuanced'' colours} (2020-07-08) -@item -@uref{https://protesilaos.com/codelog/2020-09-14-modus-themes-review-blues/, Modus themes: review of blue colours} (2020-09-14) -@end itemize - -And here are the canonical sources for this project's documentation: - -@table @asis -@item Manual -@uref{https://protesilaos.com/modus-themes} -@item Change Log -@uref{https://protesilaos.com/modus-themes-changelog} -@item Screenshots -@uref{https://protesilaos.com/modus-themes-pictures} -@end table - -@node External projects (ports) -@chapter External projects (ports) - -The present section documents projects that extend the scope of the -Modus themes. The following list will be updated whenever relevant -information is brought to my attention. If you already have or intend -to produce such a port, feel welcome @uref{https://protesilaos.com/contact, to contact me}. - -@table @asis -@item Modus exporter -This is @uref{https://github.com/polaris64/modus-exporter, an Elisp library written by Simon Pugnet}. -Licensed under the terms of the GNU General Public License. It is -meant to capture the color values of the active Modus theme (Operandi -or Vivendi) and output it as a valid theme for some other application. -@end table - -@node GNU Free Documentation License -@appendix GNU Free Documentation License - -@example - GNU Free Documentation License - Version 1.3, 3 November 2008 - - - Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. - <https://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -0. PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document "free" in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - - -1. APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The "Document", below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as "you". You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML -or XML using a publicly available DTD, and standard-conforming simple -HTML, PostScript or PDF designed for human modification. Examples of -transparent image formats include PNG, XCF and JPG. Opaque formats -include proprietary formats that can be read and edited only by -proprietary word processors, SGML or XML for which the DTD and/or -processing tools are not generally available, and the -machine-generated HTML, PostScript or PDF produced by some word -processors for output purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -The "publisher" means any person or entity that distributes copies of -the Document to the public. - -A section "Entitled XYZ" means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as "Acknowledgements", -"Dedications", "Endorsements", or "History".) To "Preserve the Title" -of such a section when you modify the Document means that it remains a -section "Entitled XYZ" according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no -other conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to -give them a chance to provide you with an updated version of the -Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has fewer than five), - unless they release you from this requirement. -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. Preserve the section Entitled "History", Preserve its Title, and add - to it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section Entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions - it was based on. These may be placed in the "History" section. - You may omit a network location for a work that was published at - least four years before the Document itself, or if the original - publisher of the version it refers to gives permission. -K. For any section Entitled "Acknowledgements" or "Dedications", - Preserve the Title of the section, and preserve in the section all - the substance and tone of each of the contributor acknowledgements - and/or dedications given therein. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section Entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section to be Entitled "Endorsements" - or to conflict in title with any Invariant Section. -O. Preserve any Warranty Disclaimers. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled "History" -in the various original documents, forming one section Entitled -"History"; likewise combine any sections Entitled "Acknowledgements", -and any sections Entitled "Dedications". You must delete all sections -Entitled "Endorsements". - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other -documents released under this License, and replace the individual -copies of this License in the various documents with a single copy -that is included in the collection, provided that you follow the rules -of this License for verbatim copying of each of the documents in all -other respects. - -You may extract a single document from such a collection, and -distribute it individually under this License, provided you insert a -copy of this License into the extracted document, and follow this -License in all other respects regarding verbatim copying of that -document. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an "aggregate" if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled "Acknowledgements", -"Dedications", or "History", the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions of the -GNU Free Documentation License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in -detail to address new problems or concerns. See -https://www.gnu.org/licenses/. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy's public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. - -11. RELICENSING - -"Massive Multiauthor Collaboration Site" (or "MMC Site") means any -World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -"Massive Multiauthor Collaboration" (or "MMC") contained in the site -means any set of copyrightable works thus published on the MMC site. - -"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. - -"Incorporate" means to publish or republish a Document, in whole or in -part, as part of another Document. - -An MMC is "eligible for relicensing" if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole or -in part into the MMC, (1) had no cover texts or invariant sections, and -(2) were thus incorporated prior to November 1, 2008. - -The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. - - -ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the "with...Texts." line with this: - - with the Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. -@end example - -@bye diff --git a/doc/misc/nxml-mode.texi b/doc/misc/nxml-mode.texi index 3671ac8f3d2..4ca223d46c4 100644 --- a/doc/misc/nxml-mode.texi +++ b/doc/misc/nxml-mode.texi @@ -82,7 +82,7 @@ documents. To get validation and schema-sensitive editing, you need a RELAX NG Compact Syntax (RNC) schema for your document (@pxref{Locating a schema}). The @file{etc/schema} directory includes some schemas for popular document -types. See @url{http://relaxng.org/} for more information on RELAX NG@. +types. See @url{https://relaxng.org/} for more information on RELAX NG@. You can use the @samp{Trang} program from @url{http://www.thaiopensource.com/relaxng/trang.html} to automatically create RNC schemas. This program can: diff --git a/doc/misc/octave-mode.texi b/doc/misc/octave-mode.texi index 1adc2689697..e3306060159 100644 --- a/doc/misc/octave-mode.texi +++ b/doc/misc/octave-mode.texi @@ -83,9 +83,12 @@ addition to the standard Emacs commands. @kindex C-M-j @findex octave-indent-new-comment-line @vindex octave-continuation-string +@vindex octave-string-continuation-marker Break Octave line at point, continuing comment if within one. Insert @code{octave-continuation-string} before breaking the line unless -inside a list. Signal an error if within a single-quoted string. +inside a list. If within a double-quoted string, insert +@code{octave-string-continuation-marker} instead. Signal an error if +within a single-quoted string. @item C-c ; @kindex C-c ; diff --git a/doc/misc/org-setup.org b/doc/misc/org-setup.org new file mode 100644 index 00000000000..d0392f10a20 --- /dev/null +++ b/doc/misc/org-setup.org @@ -0,0 +1,53 @@ +# SETUPFILE for Org manual + +# Copyright (C) 2021 Free Software Foundation, Inc. +# +# This file is part of GNU Emacs. +# +# GNU Emacs is free software: you can redistribute it and/or modify +# 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. +# +# GNU Emacs is distributed in the hope that it will be useful, +# 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/>. + +# XXX: We cannot use TODO keyword as a node starts with "TODO". +#+todo: REVIEW FIXME | DONE +#+property: header-args :eval no +#+startup: overview nologdone + +# Use proper quote and backtick for code sections in PDF output +# Cf. Texinfo manual 14.2 +#+texinfo_header: @set txicodequoteundirected +#+texinfo_header: @set txicodequotebacktick + +# Contact Info +#+texinfo_header: @set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage} +#+texinfo_header: @set MAINTAINER Bastien Guerry +#+texinfo_header: @set MAINTAINEREMAIL @email{bzg@gnu.org} +#+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:bzg@gnu.org,contact the maintainer} + +#+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t +#+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark +#+select_tags: export +#+exclude_tags: noexport + +#+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@ +#+macro: var @@texinfo:@var{@@$1@@texinfo:}@@ + +# The "version" macro extracts "Version" keyword from "org.el". It +# returns major.minor version number. This is sufficient since bugfix +# releases are not expected to add features and therefore imply manual +# modifications. +#+macro: version (eval (with-current-buffer (find-file-noselect "../../lisp/org/org.el") (org-with-point-at 1 (if (re-search-forward "Version: +\\([0-9.]+\\)" nil t) (mapconcat #'identity (cl-subseq (split-string (match-string-no-properties 1) "\\.") 0 2) ".") (error "Missing \"Version\" keyword in \"org.el\""))))) + +# The "kbd" macro turns KBD into @kbd{KBD}. Additionally, it +# encloses case-sensitive special keys (SPC, RET...) within @key{...}. +#+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t)))) + diff --git a/doc/misc/org.org b/doc/misc/org.org new file mode 100644 index 00000000000..f072b5e00e0 --- /dev/null +++ b/doc/misc/org.org @@ -0,0 +1,21904 @@ +#+title: The Org Manual +#+subtitle: Release {{{version}}} +#+author: The Org Mode Developers +#+language: en + + +#+texinfo: @insertcopying + +* Introduction +:PROPERTIES: +:DESCRIPTION: Getting started. +:END: +#+cindex: introduction + +** Summary +:PROPERTIES: +:DESCRIPTION: Brief summary of what Org does. +:END: +#+cindex: summary + +Org is a mode for keeping notes, maintaining TODO lists, and project +planning with a fast and effective plain-text markup language. It +also is an authoring system with unique support for literate +programming and reproducible research. + +Org is implemented on top of Outline mode, which makes it possible to +keep the content of large files well structured. Visibility cycling +and structure editing help to work with the tree. Tables are easily +created with a built-in table editor. Plain text URL-like links +connect to websites, emails, Usenet messages, BBDB entries, and any +files related to the projects. + +Org develops organizational tasks around notes files that contain +lists or information about projects as plain text. Project planning +and task management make use of metadata which is part of an outline +node. Based on this data, specific entries can be extracted in +queries and create dynamic /agenda views/ that also integrate the +Emacs calendar and diary. Org can be used to implement many different +project planning schemes, such as David Allen's GTD system. + +Org files can serve as a single source authoring system with export to +many different formats such as HTML, LaTeX, Open Document, and +Markdown. New export backends can be derived from existing ones, or +defined from scratch. + +Org files can include source code blocks, which makes Org uniquely +suited for authoring technical documents with code examples. Org +source code blocks are fully functional; they can be evaluated in +place and their results can be captured in the file. This makes it +possible to create a single file reproducible research compendium. + +Org keeps simple things simple. When first fired up, it should feel +like a straightforward, easy to use outliner. Complexity is not +imposed, but a large amount of functionality is available when needed. +Org is a toolbox. Many users actually run only a---very +personal---fraction of Org's capabilities, and know that there is more +whenever they need it. + +All of this is achieved with strictly plain text files, the most +portable and future-proof file format. Org runs in Emacs. Emacs is +one of the most widely ported programs, so that Org mode is available +on every major platform. + +#+cindex: FAQ +There is a website for Org which provides links to the newest version +of Org, as well as additional information, frequently asked questions +(FAQ), links to tutorials, etc. This page is located at +[[https://orgmode.org]]. + +#+cindex: print edition +An earlier version (7.3) of this manual is available as a [[http://www.network-theory.co.uk/org/manual/][paperback +book from Network Theory Ltd.]]. + +** Installation +:PROPERTIES: +:DESCRIPTION: Installing Org. +:END: +#+cindex: installation + +Org is included in all recent distributions of GNU Emacs, so you +probably do not need to install it. Most users will simply activate +Org and begin exploring its many features. + +If, for one reason or another, you want to install Org on top of this +pre-packaged version, there are three ways to do it: + +- by using the Emacs package system; +- by downloading Org as an archive; or +- by using Org's git repository. + +We *strongly recommend* sticking to a single installation method. + +*** Using Emacs packaging system +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Recent Emacs distributions include a packaging system which lets you +install Elisp libraries. You can install Org from the "package menu", +with {{{kbd(M-x list-packages)}}}. See [[info:emacs::Package Menu][Package Menu]]. + +#+attr_texinfo: :tag Important +#+begin_quote +You need to do this in a session where no =.org= file has been +visited, i.e., where no Org built-in function have been loaded. +Otherwise autoload Org functions will mess up the installation. +#+end_quote + +If you want to use Org's package repository, check out the [[https://orgmode.org/elpa.html][Org ELPA +page]]. + +*** Downloading Org as an archive +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +You can download Org latest release from [[https://orgmode.org/][Org's website]]. In this case, +make sure you set the load path correctly in your Emacs init file: + +#+begin_src emacs-lisp +(add-to-list 'load-path "~/path/to/orgdir/lisp") +#+end_src + +The downloaded archive contains contributed libraries that are not +included in Emacs. If you want to use them, add the =contrib/= +directory to your load path: + +#+begin_src emacs-lisp +(add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t) +#+end_src + +Optionally, you can compile the files and/or install them in your +system. Run =make help= to list compilation and installation options. + +*** Using Org's git repository +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +You can clone Org's repository and install Org like this: + +#+begin_example +$ cd ~/src/ +$ git clone https://code.orgmode.org/bzg/org-mode.git +$ cd org-mode/ +$ make autoloads +#+end_example + +Note that in this case, =make autoloads= is mandatory: it defines +Org's version in =org-version.el= and Org's autoloads in +=org-loaddefs.el=. + +Remember to add the correct load path as described in the method +above. + +You can also compile with =make=, generate the documentation with +=make doc=, create a local configuration with =make config= and +install Org with =make install=. Please run =make help= to get the +list of compilation/installation options. + +For more detailed explanations on Org's build system, please check the +Org Build System page on [[https://orgmode.org/worg/dev/org-build-system.html][Worg]]. + +** Activation +:PROPERTIES: +:DESCRIPTION: How to activate Org for certain buffers. +:END: +#+cindex: activation +#+cindex: autoload +#+cindex: ELPA +#+cindex: global key bindings +#+cindex: key bindings, global + +Org mode buffers need Font Lock to be turned on: this is the default +in Emacs[fn:1]. + +There are compatibility issues between Org mode and some other Elisp +packages (see [[*Packages that conflict with Org mode]]). Please take the +time to check the list. + +#+findex: org-agenda +#+findex: org-capture +#+findex: org-store-link +For a better experience, the three Org commands ~org-store-link~, +~org-capture~ and ~org-agenda~ ought to be accessible anywhere in +Emacs, not just in Org buffers. To that effect, you need to bind them +to globally available keys, like the ones reserved for users (see +[[info:elisp::Key Binding Conventions]]). Here are suggested bindings, +please modify the keys to your own liking. + +#+begin_src emacs-lisp +(global-set-key (kbd "C-c l") 'org-store-link) +(global-set-key (kbd "C-c a") 'org-agenda) +(global-set-key (kbd "C-c c") 'org-capture) +#+end_src + +#+cindex: Org mode, turning on +Files with the =.org= extension use Org mode by default. To turn on +Org mode in a file that does not have the extension =.org=, make the +first line of a file look like this: + +: MY PROJECTS -*- mode: org; -*- + +#+vindex: org-insert-mode-line-in-empty-file +#+texinfo: @noindent +which selects Org mode for this buffer no matter what the file's name +is. See also the variable ~org-insert-mode-line-in-empty-file~. + +Many commands in Org work on the region if the region is /active/. To +make use of this, you need to have Transient Mark mode turned on, +which is the default. If you do not like it, you can create an active +region by using the mouse to select a region, or pressing +{{{kbd(C-SPC)}}} twice before moving point. + +** Feedback +:PROPERTIES: +:DESCRIPTION: Bug reports, ideas, patches, etc. +:END: +#+cindex: feedback +#+cindex: bug reports +#+cindex: reporting a bug +#+cindex: maintainer +#+cindex: author + +If you find problems with Org, or if you have questions, remarks, or +ideas about it, please send an email to the Org mailing list +[[mailto:emacs-orgmode@gnu.org]]. You can subscribe to the list [[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][from this +web page]]. If you are not a member of the mailing list, your mail will +be passed to the list after a moderator has approved it[fn:2]. We ask +you to read and respect the [[https://www.gnu.org/philosophy/kind-communication.html][GNU Kind Communications Guidelines]] when +sending messages on this mailing list. + +#+findex: org-version +#+findex: org-submit-bug-report +For bug reports, please first try to reproduce the bug with the latest +version of Org available---if you are running an outdated version, it +is quite possible that the bug has been fixed already. If the bug +persists, prepare a report and provide as much information as +possible, including the version information of Emacs ({{{kbd(M-x +emacs-version)}}}) and Org ({{{kbd(M-x org-version)}}}), as well as +the Org related setup in the Emacs init file. The easiest way to do +this is to use the command + +: M-x org-submit-bug-report <RET> + +#+texinfo: @noindent +which puts all this information into an Emacs mail buffer so that you +only need to add your description. If you are not sending the Email +from within Emacs, please copy and paste the content into your Email +program. + +Sometimes you might face a problem due to an error in your Emacs or +Org mode setup. Before reporting a bug, it is very helpful to start +Emacs with minimal customizations and reproduce the problem. Doing so +often helps you determine if the problem is with your customization or +with Org mode itself. You can start a typical minimal session with +a command like the example below. + +: $ emacs -Q -l /path/to/minimal-org.el + +However if you are using Org mode as distributed with Emacs, a minimal +setup is not necessary. In that case it is sufficient to start Emacs +as =emacs -Q=. The =minimal-org.el= setup file can have contents as +shown below. + +#+begin_src emacs-lisp +;;; Minimal setup to load latest `org-mode'. + +;; Activate debugging. +(setq debug-on-error t + debug-on-signal nil + debug-on-quit nil) + +;; Add latest Org mode to load path. +(add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp")) +(add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t)) +#+end_src + +If an error occurs, a "backtrace" can be very useful---see below on +how to create one. Often a small example file helps, along with clear +information about: + +1. What exactly did you do? +2. What did you expect to happen? +3. What happened instead? + +Thank you for helping to improve this program. + +*** How to create a useful backtrace +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: backtrace of an error +If working with Org produces an error with a message you do not +understand, you may have hit a bug. The best way to report this is by +providing, in addition to what was mentioned above, a backtrace. This +is information from the built-in debugger about where and how the +error occurred. Here is how to produce a useful backtrace: + +1. Reload uncompiled versions of all Org mode Lisp files. The + backtrace contains much more information if it is produced with + uncompiled code. To do this, use + + : C-u M-x org-reload <RET> + + #+texinfo: @noindent + or, from the menu: Org \rarr Refresh/Reload \rarr Reload Org uncompiled. + +2. Then, activate the debugger: + + : M-x toggle-debug-on-error <RET> + + #+texinfo: @noindent + or, from the menu: Options \rarr Enter Debugger on Error. + +3. Do whatever you have to do to hit the error. Do not forget to + document the steps you take. + +4. When you hit the error, a =*Backtrace*= buffer appears on the + screen. Save this buffer to a file---for example using {{{kbd(C-x + C-w)}}}---and attach it to your bug report. + +** Typesetting Conventions Used in this Manual +:PROPERTIES: +:DESCRIPTION: Typesetting conventions used in this manual. +:ALT_TITLE: Conventions +:END: + +*** TODO keywords, tags, properties, etc. +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Org uses various syntactical elements: TODO keywords, tags, property +names, keywords, blocks, etc. In this manual we use the following +conventions: + +#+attr_texinfo: :sep , +- =TODO=, =WAITING= :: + + TODO keywords are written with all capitals, even if they are + user-defined. + +- =boss=, =ARCHIVE= :: + + Tags are case-sensitive. User-defined tags are written in + lowercase; built-in tags with special meaning are written as they + should appear in the document, usually with all capitals. + +- =Release=, =PRIORITY= :: + + User-defined properties are capitalized; built-in properties with + special meaning are written with all capitals. + +- =TITLE=, =BEGIN= ... =END= :: + + Keywords and blocks are written in uppercase to enhance their + readability, but you can use lowercase in your Org files. + +*** Key bindings and commands +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +The manual lists both the keys and the corresponding commands for +accessing a functionality. Org mode often uses the same key for +different functions, depending on context. The command that is bound +to such keys has a generic name, like ~org-metaright~. In the manual +we will, wherever possible, give the function that is internally +called by the generic command. For example, in the chapter on +document structure, {{{kbd(M-RIGHT)}}} will be listed to call +~org-do-demote~, while in the chapter on tables, it will be listed to +call ~org-table-move-column-right~. + +* Document Structure +:PROPERTIES: +:DESCRIPTION: A tree works like your brain. +:END: + +#+cindex: document structure +#+cindex: structure of document +Org is an outliner. Outlines allow a document to be organized in +a hierarchical structure, which, least for me, is the best +representation of notes and thoughts. An overview of this structure +is achieved by folding, i.e., hiding large parts of the document to +show only the general document structure and the parts currently being +worked on. Org greatly simplifies the use of outlines by compressing +the entire show and hide functionalities into a single command, +~org-cycle~, which is bound to the {{{kbd(TAB)}}} key. + +** Headlines +:PROPERTIES: +:DESCRIPTION: How to typeset Org tree headlines. +:END: +#+cindex: headlines +#+cindex: outline tree +#+vindex: org-special-ctrl-a/e +#+vindex: org-special-ctrl-k +#+vindex: org-ctrl-k-protect-subtree + +Headlines define the structure of an outline tree. Org headlines +start on the left margin[fn:3] with one or more stars followed by +a space. For example: + +#+begin_example +,* Top level headline +,** Second level +,*** Third level + some text +,*** Third level + more text +,* Another top level headline +#+end_example + +#+vindex: org-footnote-section +The name defined in ~org-footnote-section~ is reserved. Do not use it +as a title for your own headings. + +Some people find the many stars too noisy and would prefer an outline +that has whitespace followed by a single star as headline starters. +This can be achieved using a Org Indent minor mode. See [[*A Cleaner +Outline View]] for more information. + +Headlines are not numbered. However, you may want to dynamically +number some, or all, of them. See [[*Dynamic Headline Numbering]]. + +#+vindex: org-cycle-separator-lines +An empty line after the end of a subtree is considered part of it and +is hidden when the subtree is folded. However, if you leave at least +two empty lines, one empty line remains visible after folding the +subtree, in order to structure the collapsed view. See the variable +~org-cycle-separator-lines~ to modify this behavior. + +** Visibility Cycling +:PROPERTIES: +:DESCRIPTION: Show and hide, much simplified. +:END: +#+cindex: cycling, visibility +#+cindex: visibility cycling +#+cindex: trees, visibility +#+cindex: show hidden text +#+cindex: hide text + +*** Global and local cycling +:PROPERTIES: +:DESCRIPTION: Cycling through various visibility states. +:END: +#+cindex: subtree visibility states +#+cindex: subtree cycling +#+cindex: folded, subtree visibility state +#+cindex: children, subtree visibility state +#+cindex: subtree, subtree visibility state + +Outlines make it possible to hide parts of the text in the buffer. +Org uses just two commands, bound to {{{kbd(TAB)}}} and +{{{kbd(S-TAB)}}} to change the visibility in the buffer. + +#+attr_texinfo: :sep , +- {{{kbd(TAB)}}} (~org-cycle~) :: + + #+kindex: TAB + #+findex: org-cycle + /Subtree cycling/: Rotate current subtree among the states + + #+begin_example + ,-> FOLDED -> CHILDREN -> SUBTREE --. + '-----------------------------------' + #+end_example + + #+vindex: org-cycle-emulate-tab + Point must be on a headline for this to work[fn:4]. + +- {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} :: + + #+cindex: global visibility states + #+cindex: global cycling + #+cindex: overview, global visibility state + #+cindex: contents, global visibility state + #+cindex: show all, global visibility state + #+kindex: C-u TAB + #+kindex: S-TAB + #+findex: org-global-cycle + /Global cycling/: Rotate the entire buffer among the states + + #+begin_example + ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. + '--------------------------------------' + #+end_example + + When {{{kbd(S-TAB)}}} is called with a numeric prefix argument + {{{var(N)}}}, view contents only up to headlines of level + {{{var(N)}}}. + + Note that inside tables (see [[*Tables]]), {{{kbd(S-TAB)}}} jumps to the + previous field instead. + + #+vindex: org-cycle-global-at-bob + You can run global cycling using {{{kbd(TAB)}}} only if point is at + the very beginning of the buffer, but not on a headline, and + ~org-cycle-global-at-bob~ is set to a non-~nil~ value. + +- {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) :: + + #+cindex: startup visibility + #+kindex: C-u C-u TAB + #+findex: org-set-startup-visibility + Switch back to the startup visibility of the buffer (see [[*Initial + visibility]]). + +- {{{kbd(C-u C-u C-u TAB)}}} (~outline-show-all~) :: + + #+cindex: show all, command + #+kindex: C-u C-u C-u TAB + #+findex: outline-show-all + Show all, including drawers. + +- {{{kbd(C-c C-r)}}} (~org-reveal~) :: + + #+cindex: revealing context + #+kindex: C-c C-r + #+findex: org-reveal + Reveal context around point, showing the current entry, the + following heading and the hierarchy above. It is useful for working + near a location that has been exposed by a sparse tree command (see + [[*Sparse Trees]]) or an agenda command (see [[*Commands in the Agenda + Buffer]]). With a prefix argument, show, on each level, all sibling + headings. With a double prefix argument, also show the entire + subtree of the parent. + +- {{{kbd(C-c C-k)}}} (~outline-show-branches~) :: + + #+cindex: show branches, command + #+kindex: C-c C-k + #+findex: outline-show-branches + Expose all the headings of the subtree, but not their bodies. + +- {{{kbd(C-c TAB)}}} (~outline-show-children~) :: + + #+cindex: show children, command + #+kindex: C-c TAB + #+findex: outline-show-children + Expose all direct children of the subtree. With a numeric prefix + argument {{{var(N)}}}, expose all children down to level + {{{var(N)}}}. + +- {{{kbd(C-c C-x b)}}} (~org-tree-to-indirect-buffer~) :: + + #+kindex: C-c C-x b + #+findex: org-tree-to-indirect-buffer + Show the current subtree in an indirect buffer[fn:5]. With + a numeric prefix argument {{{var(N)}}}, go up to level {{{var(N)}}} + and then take that tree. If {{{var(N)}}} is negative then go up + that many levels. With a {{{kbd(C-u)}}} prefix, do not remove the + previously used indirect buffer. + +- {{{kbd(C-c C-x v)}}} (~org-copy-visible~) :: + + #+kindex: C-c C-x v + #+findex: org-copy-visible + Copy the /visible/ text in the region into the kill ring. + +*** Initial visibility +:PROPERTIES: +:DESCRIPTION: Setting the initial visibility state. +:END: + +#+vindex: org-startup-folded +When Emacs first visits an Org file, the global state is set to +~showeverything~, i.e., all file content is visible[fn:6]. This can +be configured through the variable ~org-startup-folded~, or on +a per-file basis by adding one of the following lines anywhere in the +buffer: + +#+cindex: @samp{STARTUP}, keyword +#+begin_example +,#+STARTUP: overview +,#+STARTUP: content +,#+STARTUP: showall +,#+STARTUP: showeverything +#+end_example + +#+cindex: @samp{VISIBILITY}, property +Furthermore, any entries with a =VISIBILITY= property (see [[*Properties +and Columns]]) get their visibility adapted accordingly. Allowed values +for this property are =folded=, =children=, =content=, and =all=. + +- {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) :: + + #+kindex: C-u C-u TAB + #+findex: org-set-startup-visibility + Switch back to the startup visibility of the buffer, i.e., whatever + is requested by startup options and =VISIBILITY= properties in + individual entries. + +*** Catching invisible edits +:PROPERTIES: +:DESCRIPTION: Preventing mistakes when editing invisible parts. +:END: +#+cindex: edits, catching invisible + +#+vindex: org-catch-invisible-edits +Sometimes you may inadvertently edit an invisible part of the buffer +and be confused on what has been edited and how to undo the mistake. +Setting ~org-catch-invisible-edits~ to non-~nil~ helps preventing +this. See the docstring of this option on how Org should catch +invisible edits and process them. + +** Motion +:PROPERTIES: +:DESCRIPTION: Jumping to other headlines. +:END: +#+cindex: motion, between headlines +#+cindex: jumping, to headlines +#+cindex: headline navigation + +The following commands jump to other headlines in the buffer. + +- {{{kbd(C-c C-n)}}} (~org-next-visible-heading~) :: + + #+kindex: C-c C-n + #+findex: org-next-visible-heading + Next heading. + +- {{{kbd(C-c C-p)}}} (~org-previous-visible-heading~) :: + + #+kindex: C-c C-p + #+findex: org-previous-visible-heading + Previous heading. + +- {{{kbd(C-c C-f)}}} (~org-forward-heading-same-level~) :: + + #+kindex: C-c C-f + #+findex: org-forward-heading-same-level + Next heading same level. + +- {{{kbd(C-c C-b)}}} (~org-backward-heading-same-level~) :: + + #+kindex: C-c C-b + #+findex: org-backward-heading-same-level + Previous heading same level. + +- {{{kbd(C-c C-u)}}} (~outline-up-heading~) :: + + #+kindex: C-c C-u + #+findex: outline-up-heading + Backward to higher level heading. + +- {{{kbd(C-c C-j)}}} (~org-goto~) :: + + #+kindex: C-c C-j + #+findex: org-goto + #+vindex: org-goto-auto-isearch + Jump to a different place without changing the current outline + visibility. Shows the document structure in a temporary buffer, + where you can use the following keys to find your destination: + + #+attr_texinfo: :columns 0.3 0.7 + | {{{kbd(TAB)}}} | Cycle visibility. | + | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible headline. | + | {{{kbd(RET)}}} | Select this location. | + | {{{kbd(/)}}} | Do a Sparse-tree search | + + #+texinfo: @noindent + The following keys work if you turn off ~org-goto-auto-isearch~ + + #+attr_texinfo: :columns 0.3 0.7 + | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible headline. | + | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous headline same level. | + | {{{kbd(u)}}} | One level up. | + | {{{kbd(0)}}} ... {{{kbd(9)}}} | Digit argument. | + | {{{kbd(q)}}} | Quit. | + + #+vindex: org-goto-interface + #+texinfo: @noindent + See also the variable ~org-goto-interface~. + +** Structure Editing +:PROPERTIES: +:DESCRIPTION: Changing sequence and level of headlines. +:END: +#+cindex: structure editing +#+cindex: headline, promotion and demotion +#+cindex: promotion, of subtrees +#+cindex: demotion, of subtrees +#+cindex: subtree, cut and paste +#+cindex: pasting, of subtrees +#+cindex: cutting, of subtrees +#+cindex: copying, of subtrees +#+cindex: sorting, of subtrees +#+cindex: subtrees, cut and paste + +#+attr_texinfo: :sep , +- {{{kbd(M-RET)}}} (~org-meta-return~) :: + + #+kindex: M-RET + #+findex: org-meta-return + #+vindex: org-M-RET-may-split-line + Insert a new heading, item or row. + + If the command is used at the /beginning/ of a line, and if there is + a heading or a plain list item (see [[*Plain Lists]]) at point, the new + heading/item is created /before/ the current line. When used at the + beginning of a regular line of text, turn that line into a heading. + + When this command is used in the middle of a line, the line is split + and the rest of the line becomes the new item or headline. If you + do not want the line to be split, customize + ~org-M-RET-may-split-line~. + + Calling the command with a {{{kbd(C-u)}}} prefix unconditionally + inserts a new heading at the end of the current subtree, thus + preserving its contents. With a double {{{kbd(C-u C-u)}}} prefix, + the new heading is created at the end of the parent subtree instead. + +- {{{kbd(C-RET)}}} (~org-insert-heading-respect-content~) :: + + #+kindex: C-RET + #+findex: org-insert-heading-respect-content + Insert a new heading at the end of the current subtree. + +- {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) :: + + #+kindex: M-S-RET + #+findex: org-insert-todo-heading + #+vindex: org-treat-insert-todo-heading-as-state-change + Insert new TODO entry with same level as current heading. See also + the variable ~org-treat-insert-todo-heading-as-state-change~. + +- {{{kbd(C-S-RET)}}} (~org-insert-todo-heading-respect-content~) :: + + #+kindex: C-S-RET + #+findex: org-insert-todo-heading-respect-content + Insert new TODO entry with same level as current heading. Like + {{{kbd(C-RET)}}}, the new headline is inserted after the current + subtree. + +- {{{kbd(TAB)}}} (~org-cycle~) :: + + #+kindex: TAB + #+findex: org-cycle + In a new entry with no text yet, the first {{{kbd(TAB)}}} demotes + the entry to become a child of the previous one. The next + {{{kbd(TAB)}}} makes it a parent, and so on, all the way to top + level. Yet another {{{kbd(TAB)}}}, and you are back to the initial + level. + +- {{{kbd(M-LEFT)}}} (~org-do-promote~), {{{kbd(M-RIGHT)}}} (~org-do-demote~) :: + + #+kindex: M-LEFT + #+findex: org-do-promote + #+kindex: M-RIGHT + #+findex: org-do-demote + Promote or demote current heading by one level. + + #+cindex: region, active + #+cindex: active region + #+cindex: transient mark mode + When there is an active region---i.e., when Transient Mark mode is + active---promotion and demotion work on all headlines in the region. + To select a region of headlines, it is best to place both point and + mark at the beginning of a line, mark at the beginning of the first + headline, and point at the line just after the last headline to + change. + +- {{{kbd(M-S-LEFT)}}} (~org-promote-subtree~) :: + + #+kindex: M-S-LEFT + #+findex: org-promote-subtree + Promote the current subtree by one level. + +- {{{kbd(M-S-RIGHT)}}} (~org-demote-subtree~) :: + + #+kindex: M-S-RIGHT + #+findex: org-demote-subtree + Demote the current subtree by one level. + +- {{{kbd(M-UP)}}} (~org-move-subtree-up~) :: + + #+kindex: M-UP + #+findex: org-move-subtree-up + Move subtree up, i.e., swap with previous subtree of same level. + +- {{{kbd(M-DOWN)}}} (~org-move-subtree-down~) :: + + #+kindex: M-DOWN + #+findex: org-move-subtree-down + Move subtree down, i.e., swap with next subtree of same level. + +- {{{kbd(C-c @)}}} (~org-mark-subtree~) :: + + #+kindex: C-c @@ + #+findex: org-mark-subtree + Mark the subtree at point. Hitting repeatedly marks subsequent + subtrees of the same level as the marked subtree. + +- {{{kbd(C-c C-x C-w)}}} (~org-cut-subtree~) :: + + #+kindex: C-c C-x C-w + #+findex: org-cut-subtree + Kill subtree, i.e., remove it from buffer but save in kill ring. + With a numeric prefix argument N, kill N sequential subtrees. + +- {{{kbd(C-c C-x M-w)}}} (~org-copy-subtree~) :: + + #+kindex: C-c C-x M-w + #+findex: org-copy-subtree + Copy subtree to kill ring. With a numeric prefix argument N, copy + the N sequential subtrees. + +- {{{kbd(C-c C-x C-y)}}} (~org-paste-subtree~) :: + + #+kindex: C-c C-x C-y + #+findex: org-paste-subtree + Yank subtree from kill ring. This does modify the level of the + subtree to make sure the tree fits in nicely at the yank position. + The yank level can also be specified with a numeric prefix argument, + or by yanking after a headline marker like =****=. + +- {{{kbd(C-y)}}} (~org-yank~) :: + + #+kindex: C-y + #+findex: org-yank + #+vindex: org-yank-adjusted-subtrees + #+vindex: org-yank-folded-subtrees + Depending on the variables ~org-yank-adjusted-subtrees~ and + ~org-yank-folded-subtrees~, Org's internal ~yank~ command pastes + subtrees folded and in a clever way, using the same command as + {{{kbd(C-c C-x C-y)}}}. With the default settings, no level + adjustment takes place, but the yanked tree is folded unless doing + so would swallow text previously visible. Any prefix argument to + this command forces a normal ~yank~ to be executed, with the prefix + passed along. A good way to force a normal yank is {{{kbd(C-u + C-y)}}}. If you use ~yank-pop~ after a yank, it yanks previous kill + items plainly, without adjustment and folding. + +- {{{kbd(C-c C-x c)}}} (~org-clone-subtree-with-time-shift~) :: + + #+kindex: C-c C-x c + #+findex: org-clone-subtree-with-time-shift + Clone a subtree by making a number of sibling copies of it. You are + prompted for the number of copies to make, and you can also specify + if any timestamps in the entry should be shifted. This can be + useful, for example, to create a number of tasks related to a series + of lectures to prepare. For more details, see the docstring of the + command ~org-clone-subtree-with-time-shift~. + +- {{{kbd(C-c C-w)}}} (~org-refile~) :: + + #+kindex: C-c C-w + #+findex: org-refile + Refile entry or region to a different location. See [[*Refile and + Copy]]. + +- {{{kbd(C-c ^)}}} (~org-sort~) :: + + #+kindex: C-c ^ + #+findex: org-sort + Sort same-level entries. When there is an active region, all + entries in the region are sorted. Otherwise the children of the + current headline are sorted. The command prompts for the sorting + method, which can be alphabetically, numerically, by time---first + timestamp with active preferred, creation time, scheduled time, + deadline time---by priority, by TODO keyword---in the sequence the + keywords have been defined in the setup---or by the value of + a property. Reverse sorting is possible as well. You can also + supply your own function to extract the sorting key. With + a {{{kbd(C-u)}}} prefix, sorting is case-sensitive. + +- {{{kbd(C-x n s)}}} (~org-narrow-to-subtree~) :: + + #+kindex: C-x n s + #+findex: org-narrow-to-subtree + Narrow buffer to current subtree. + +- {{{kbd(C-x n b)}}} (~org-narrow-to-block~) :: + + #+kindex: C-x n b + #+findex: org-narrow-to-block + Narrow buffer to current block. + +- {{{kbd(C-x n w)}}} (~widen~) :: + + #+kindex: C-x n w + #+findex: widen + Widen buffer to remove narrowing. + +- {{{kbd(C-c *)}}} (~org-toggle-heading~) :: + + #+kindex: C-c * + #+findex: org-toggle-heading + Turn a normal line or plain list item into a headline---so that it + becomes a subheading at its location. Also turn a headline into + a normal line by removing the stars. If there is an active region, + turn all lines in the region into headlines. If the first line in + the region was an item, turn only the item lines into headlines. + Finally, if the first line is a headline, remove the stars from all + headlines in the region. + +Note that when point is inside a table (see [[*Tables]]), the Meta-Cursor +keys have different functionality. + +** Sparse Trees +:PROPERTIES: +:DESCRIPTION: Matches embedded in context. +:END: +#+cindex: sparse trees +#+cindex: trees, sparse +#+cindex: folding, sparse trees +#+cindex: occur, command + +#+vindex: org-show-context-detail +An important feature of Org mode is the ability to construct /sparse +trees/ for selected information in an outline tree, so that the entire +document is folded as much as possible, but the selected information +is made visible along with the headline structure above it[fn:7]. +Just try it out and you will see immediately how it works. + +Org mode contains several commands creating such trees, all these +commands can be accessed through a dispatcher: + +- {{{kbd(C-c /)}}} (~org-sparse-tree~) :: + + #+kindex: C-c / + #+findex: org-sparse-tree + This prompts for an extra key to select a sparse-tree creating + command. + +- {{{kbd(C-c / r)}}} or {{{kbd(C-c / /)}}} (~org-occur~) :: + + #+kindex: C-c / r + #+kindex: C-c / / + #+findex: org-occur + #+vindex: org-remove-highlights-with-change + Prompts for a regexp and shows a sparse tree with all matches. If + the match is in a headline, the headline is made visible. If the + match is in the body of an entry, headline and body are made + visible. In order to provide minimal context, also the full + hierarchy of headlines above the match is shown, as well as the + headline following the match. Each match is also highlighted; the + highlights disappear when the buffer is changed by an editing + command, or by pressing {{{kbd(C-c C-c)}}}[fn:8]. When called with + a {{{kbd(C-u)}}} prefix argument, previous highlights are kept, so + several calls to this command can be stacked. + +- {{{kbd(M-g n)}}} or {{{kbd(M-g M-n)}}} (~next-error~) :: + + #+kindex: M-g n + #+kindex: M-g M-n + #+findex: next-error + Jump to the next sparse tree match in this buffer. + +- {{{kbd(M-g p)}}} or {{{kbd(M-g M-p)}}} (~previous-error~) :: + + #+kindex: M-g p + #+kindex: M-g M-p + #+findex: previous-error + Jump to the previous sparse tree match in this buffer. + +#+vindex: org-agenda-custom-commands +For frequently used sparse trees of specific search strings, you can +use the variable ~org-agenda-custom-commands~ to define fast keyboard +access to specific sparse trees. These commands will then be +accessible through the agenda dispatcher (see [[*The Agenda Dispatcher]]). +For example: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("f" occur-tree "FIXME"))) +#+end_src + +#+texinfo: @noindent +defines the key {{{kbd(f)}}} as a shortcut for creating a sparse tree +matching the string =FIXME=. + +The other sparse tree commands select headings based on TODO keywords, +tags, or properties and are discussed later in this manual. + +#+kindex: C-c C-e C-v +#+cindex: printing sparse trees +#+cindex: visible text, printing +To print a sparse tree, you can use the Emacs command +~ps-print-buffer-with-faces~ which does not print invisible parts of +the document. Or you can use the command {{{kbd(C-c C-e C-v)}}} to +export only the visible part of the document and print the resulting +file. + +** Plain Lists +:PROPERTIES: +:DESCRIPTION: Additional structure within an entry. +:END: +#+cindex: plain lists +#+cindex: lists, plain +#+cindex: lists, ordered +#+cindex: ordered lists + +Within an entry of the outline tree, hand-formatted lists can provide +additional structure. They also provide a way to create lists of +checkboxes (see [[*Checkboxes]]). Org supports editing such lists, and +every exporter (see [[*Exporting]]) can parse and format them. + +Org knows ordered lists, unordered lists, and description lists. + +#+attr_texinfo: :indic @bullet +- /Unordered/ list items start with =-=, =+=, or =*=[fn:9] as bullets. + +- + #+vindex: org-plain-list-ordered-item-terminator + #+vindex: org-alphabetical-lists + /Ordered/ list items start with a numeral followed by either + a period or a right parenthesis[fn:10], such as =1.= or =1)=[fn:11] + If you want a list to start with a different value---e.g., + 20---start the text of the item with =[@20]=[fn:12]. Those + constructs can be used in any item of the list in order to enforce + a particular numbering. + +- /Description/ list items are unordered list items, and contain the + separator =::= to distinguish the description /term/ from the + description. + +Items belonging to the same list must have the same indentation on the +first line. In particular, if an ordered list reaches number =10.=, +then the 2-digit numbers must be written left-aligned with the other +numbers in the list. An item ends before the next line that is less +or equally indented than its bullet/number. + +A list ends whenever every item has ended, which means before any line +less or equally indented than items at top level. It also ends before +two blank lines. In that case, all items are closed. Here is an +example: + +#+begin_example +,* Lord of the Rings +My favorite scenes are (in this order) +1. The attack of the Rohirrim +2. Eowyn's fight with the witch king + + this was already my favorite scene in the book + + I really like Miranda Otto. +3. Peter Jackson being shot by Legolas + - on DVD only + He makes a really funny face when it happens. +But in the end, no individual scenes matter but the film as a whole. +Important actors in this film are: +- Elijah Wood :: He plays Frodo +- Sean Astin :: He plays Sam, Frodo's friend. I still remember him + very well from his role as Mikey Walsh in /The Goonies/. +#+end_example + +Org supports these lists by tuning filling and wrapping commands to +deal with them correctly, and by exporting them properly (see +[[*Exporting]]). Since indentation is what governs the structure of these +lists, many structural constructs like =#+BEGIN_= blocks can be +indented to signal that they belong to a particular item. + +#+vindex: org-list-demote-modify-bullet +#+vindex: org-list-indent-offset +If you find that using a different bullet for a sub-list---than that +used for the current list-level---improves readability, customize the +variable ~org-list-demote-modify-bullet~. To get a greater difference +of indentation between items and theirs sub-items, customize +~org-list-indent-offset~. + +#+vindex: org-list-automatic-rules +The following commands act on items when point is in the first line of +an item---the line with the bullet or number. Some of them imply the +application of automatic rules to keep list structure intact. If some +of these actions get in your way, configure ~org-list-automatic-rules~ +to disable them individually. + +#+attr_texinfo: :sep , +- {{{kbd(TAB)}}} (~org-cycle~) :: + + #+cindex: cycling, in plain lists + #+kindex: TAB + #+findex: org-cycle + #+vindex: org-cycle-include-plain-lists + Items can be folded just like headline levels. Normally this works + only if point is on a plain list item. For more details, see the + variable ~org-cycle-include-plain-lists~. If this variable is set + to ~integrate~, plain list items are treated like low-level + headlines. The level of an item is then given by the indentation of + the bullet/number. Items are always subordinate to real headlines, + however; the hierarchies remain completely separated. In a new item + with no text yet, the first {{{kbd(TAB)}}} demotes the item to + become a child of the previous one. Subsequent {{{kbd(TAB)}}}s move + the item to meaningful levels in the list and eventually get it back + to its initial position. + +- {{{kbd(M-RET)}}} (~org-insert-heading~) :: + + #+kindex: M-RET + #+findex: org-insert-heading + #+vindex: org-M-RET-may-split-line + Insert new item at current level. With a prefix argument, force + a new heading (see [[*Structure Editing]]). If this command is used in + the middle of an item, that item is /split/ in two, and the second + part becomes the new item[fn:13]. If this command is executed + /before item's body/, the new item is created /before/ the current + one. + +- {{{kbd(M-S-RET)}}} :: + + #+kindex: M-S-RET + Insert a new item with a checkbox (see [[*Checkboxes]]). + +- {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}} :: + + #+kindex: S-UP + #+kindex: S-DOWN + #+cindex: shift-selection-mode + #+vindex: org-support-shift-select + #+vindex: org-list-use-circular-motion + Jump to the previous/next item in the current list, but only if + ~org-support-shift-select~ is off[fn:14]. If not, you can still use + paragraph jumping commands like {{{kbd(C-UP)}}} and + {{{kbd(C-DOWN)}}} to quite similar effect. + +- {{{kbd(M-UP)}}}, {{{kbd(M-DOWN)}}} :: + + #+kindex: M-UP + #+kindex: M-DOWN + Move the item including subitems up/down[fn:15], i.e., swap with + previous/next item of same indentation. If the list is ordered, + renumbering is automatic. + +- {{{kbd(M-LEFT)}}}, {{{kbd(M-RIGHT)}}} :: + + #+kindex: M-LEFT + #+kindex: M-RIGHT + Decrease/increase the indentation of an item, leaving children + alone. + +- {{{kbd(M-S-LEFT)}}}, {{{kbd(M-S-RIGHT)}}} :: + + #+kindex: M-S-LEFT + #+kindex: M-S-RIGHT + Decrease/increase the indentation of the item, including subitems. + Initially, the item tree is selected based on current indentation. + When these commands are executed several times in direct succession, + the initially selected region is used, even if the new indentation + would imply a different hierarchy. To use the new hierarchy, break + the command chain by moving point. + + As a special case, using this command on the very first item of + a list moves the whole list. This behavior can be disabled by + configuring ~org-list-automatic-rules~. The global indentation of + a list has no influence on the text /after/ the list. + +- {{{kbd(C-c C-c)}}} :: + + #+kindex: C-c C-c + If there is a checkbox (see [[*Checkboxes]]) in the item line, toggle + the state of the checkbox. In any case, verify bullets and + indentation consistency in the whole list. + +- {{{kbd(C-c -)}}} :: + + #+kindex: C-c - + #+vindex: org-plain-list-ordered-item-terminator + Cycle the entire list level through the different itemize/enumerate + bullets (=-=, =+=, =*=, =1.=, =1)=) or a subset of them, depending + on ~org-plain-list-ordered-item-terminator~, the type of list, and + its indentation. With a numeric prefix argument N, select the Nth + bullet from this list. If there is an active region when calling + this, all lines are converted to list items. With a prefix + argument, the selected text is changed into a single item. If the + first line already was a list item, any item marker is removed from + the list. Finally, even without an active region, a normal line is + converted into a list item. + +- {{{kbd(C-c *)}}} :: + + #+kindex: C-c * + Turn a plain list item into a headline---so that it becomes + a subheading at its location. See [[*Structure Editing]], for + a detailed explanation. + +- {{{kbd(C-c C-*)}}} :: + + #+kindex: C-c C-* + Turn the whole plain list into a subtree of the current heading. + Checkboxes (see [[*Checkboxes]]) become =TODO=, respectively =DONE=, + keywords when unchecked, respectively checked. + +- {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} :: + + #+vindex: org-support-shift-select + #+kindex: S-LEFT + #+kindex: S-RIGHT + This command also cycles bullet styles when point is in on the + bullet or anywhere in an item line, details depending on + ~org-support-shift-select~. + +- {{{kbd(C-c ^)}}} :: + + #+kindex: C-c ^ + #+cindex: sorting, of plain list + Sort the plain list. Prompt for the sorting method: numerically, + alphabetically, by time, or by custom function. + +** Drawers +:PROPERTIES: +:DESCRIPTION: Tucking stuff away. +:END: +#+cindex: drawers +#+cindex: visibility cycling, drawers + +Sometimes you want to keep information associated with an entry, but +you normally do not want to see it. For this, Org mode has /drawers/. +They can contain anything but a headline and another drawer. Drawers +look like this: + +#+begin_example +,** This is a headline +Still outside the drawer +:DRAWERNAME: +This is inside the drawer. +:END: +After the drawer. +#+end_example + +#+kindex: C-c C-x d +#+findex: org-insert-drawer +You can interactively insert a drawer at point by calling +~org-insert-drawer~, which is bound to {{{kbd(C-c C-x d)}}}. With an +active region, this command puts the region inside the drawer. With +a prefix argument, this command calls ~org-insert-property-drawer~, +which creates a =PROPERTIES= drawer right below the current headline. +Org mode uses this special drawer for storing properties (see +[[*Properties and Columns]]). You cannot use it for anything else. + +Completion over drawer keywords is also possible using +{{{kbd(M-TAB)}}}[fn:16]. + +Visibility cycling (see [[*Visibility Cycling]]) on the headline hides and +shows the entry, but keep the drawer collapsed to a single line. In +order to look inside the drawer, you need to move point to the drawer +line and press {{{kbd(TAB)}}} there. + +You can also arrange for state change notes (see [[Tracking TODO state +changes]]) and clock times (see [[*Clocking Work Time]]) to be stored in +a =LOGBOOK= drawer. If you want to store a quick note there, in +a similar way to state changes, use + +- {{{kbd(C-c C-z)}}} :: + + #+kindex: C-c C-z + Add a time-stamped note to the =LOGBOOK= drawer. + +** Blocks +:PROPERTIES: +:DESCRIPTION: Folding blocks. +:END: +#+vindex: org-hide-block-startup +#+cindex: blocks, folding + +Org mode uses =#+BEGIN= ... =#+END= blocks for various purposes from +including source code examples (see [[*Literal Examples]]) to capturing +time logging information (see [[*Clocking Work Time]]). These blocks can +be folded and unfolded by pressing {{{kbd(TAB)}}} in the =#+BEGIN= +line. You can also get all blocks folded at startup by configuring +the variable ~org-hide-block-startup~ or on a per-file basis by using + +#+cindex: STARTUP, keyword +#+begin_example +,#+STARTUP: hideblocks +,#+STARTUP: nohideblocks +#+end_example + +* Tables +:PROPERTIES: +:DESCRIPTION: Pure magic for quick formatting. +:END: +#+cindex: tables +#+cindex: editing tables + +Org comes with a fast and intuitive table editor. Spreadsheet-like +calculations are supported using the Emacs Calc package (see [[info:calc][GNU Emacs +Calculator Manual]]). + +** Built-in Table Editor +:PROPERTIES: +:DESCRIPTION: Simple tables. +:END: +#+cindex: table editor, built-in + +#+cindex: header lines, in tables +#+cindex: horizontal rule, in tables +#+cindex: row separator, in tables +#+cindex: table syntax +Org makes it easy to format tables in plain ASCII. Any line with =|= +as the first non-whitespace character is considered part of a table. +=|= is also the column separator[fn:17]. Moreover, a line starting +with =|-= is a horizontal rule. It separates rows explicitly. Rows +before the first horizontal rule are header lines. A table might look +like this: + +#+begin_example +| Name | Phone | Age | +|-------+-------+-----| +| Peter | 1234 | 17 | +| Anna | 4321 | 25 | +#+end_example + +A table is re-aligned automatically each time you press +{{{kbd(TAB)}}}, {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} inside the table. +{{{kbd(TAB)}}} also moves to the next field---{{{kbd(RET)}}} to the +next row---and creates new table rows at the end of the table or +before horizontal lines. The indentation of the table is set by the +first line. Horizontal rules are automatically expanded on every +re-align to span the whole table width. So, to create the above +table, you would only type + +#+begin_example +|Name|Phone|Age| +|- +#+end_example + +#+texinfo: @noindent +and then press {{{kbd(TAB)}}} to align the table and start filling in +fields. Even faster would be to type =|Name|Phone|Age= followed by +{{{kbd(C-c RET)}}}. + +When typing text into a field, Org treats {{{kbd(DEL)}}}, +{{{kbd(Backspace)}}}, and all character keys in a special way, so that +inserting and deleting avoids shifting other fields. Also, when +typing /immediately/ after point was moved into a new field with +{{{kbd(TAB)}}}, {{{kbd(S-TAB)}}} or {{{kbd(RET)}}}, the field is +automatically made blank. If this behavior is too unpredictable for +you, configure the option ~org-table-auto-blank-field~. + +*** Creation and conversion +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c |)}}} (~org-table-create-or-convert-from-region~) :: + + #+kindex: C-c | + #+findex: org-table-create-or-convert-from-region + Convert the active region to table. If every line contains at least + one {{{kbd(TAB)}}} character, the function assumes that the material + is tab separated. If every line contains a comma, comma-separated + values (CSV) are assumed. If not, lines are split at whitespace + into fields. You can use a prefix argument to force a specific + separator: {{{kbd(C-u)}}} forces CSV, {{{kbd(C-u C-u)}}} forces + {{{kbd(TAB)}}}, {{{kbd(C-u C-u C-u)}}} prompts for a regular + expression to match the separator, and a numeric argument + N indicates that at least N consecutive spaces, or alternatively + a {{{kbd(TAB)}}} will be the separator. + + If there is no active region, this command creates an empty Org + table. But it is easier just to start typing, like {{{kbd(| + N a m e | P h o n e | A g e RET | - TAB)}}}. + +*** Re-aligning and field motion +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c C-c)}}} (~org-table-align~) :: + + #+kindex: C-c C-c + #+findex: org-table-align + Re-align the table without moving point. + +- {{{kbd(TAB)}}} (~org-table-next-field~) :: + + #+kindex: TAB + #+findex: org-table-next-field + Re-align the table, move to the next field. Creates a new row if + necessary. + +- {{{kbd(C-c SPC)}}} (~org-table-blank-field~) :: + + #+kindex: C-c SPC + #+findex: org-table-blank-field + Blank the field at point. + +- {{{kbd(S-TAB)}}} (~org-table-previous-field~) :: + + #+kindex: S-TAB + #+findex: org-table-previous-field + Re-align, move to previous field. + +- {{{kbd(RET)}}} (~org-table-next-row~) :: + + #+kindex: RET + #+findex: org-table-next-row + Re-align the table and move down to next row. Creates a new row if + necessary. At the beginning or end of a line, {{{kbd(RET)}}} still + inserts a new line, so it can be used to split a table. + +- {{{kbd(M-a)}}} (~org-table-beginning-of-field~) :: + + #+kindex: M-a + #+findex: org-table-beginning-of-field + Move to beginning of the current table field, or on to the previous + field. + +- {{{kbd(M-e)}}} (~org-table-end-of-field~) :: + + #+kindex: M-e + #+findex: org-table-end-of-field + Move to end of the current table field, or on to the next field. + +*** Column and row editing +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(M-LEFT)}}} (~org-table-move-column-left~) :: + + #+kindex: M-LEFT + #+findex: org-table-move-column-left + Move the current column left. + +- {{{kbd(M-RIGHT)}}} (~org-table-move-column-right~) :: + + #+kindex: M-RIGHT + #+findex: org-table-move-column-right + Move the current column right. + +- {{{kbd(M-S-LEFT)}}} (~org-table-delete-column~) :: + + #+kindex: M-S-LEFT + #+findex: org-table-delete-column + Kill the current column. + +- {{{kbd(M-S-RIGHT)}}} (~org-table-insert-column~) :: + + #+kindex: M-S-RIGHT + #+findex: org-table-insert-column + Insert a new column at point position. Move the recent column and + all cells to the right of this column to the right. + +- {{{kbd(M-UP)}}} (~org-table-move-row-up~) :: + + #+kindex: M-UP + #+findex: org-table-move-row-up + Move the current row up. + +- {{{kbd(M-DOWN)}}} (~org-table-move-row-down~) :: + + #+kindex: M-DOWN + #+findex: org-table-move-row-down + Move the current row down. + +- {{{kbd(M-S-UP)}}} (~org-table-kill-row~) :: + + #+kindex: M-S-UP + #+findex: org-table-kill-row + Kill the current row or horizontal line. + +- {{{kbd(S-UP)}}} (~org-table-move-cell-up~) :: + + #+kindex: S-UP + #+findex: org-table-move-cell-up + Move cell up by swapping with adjacent cell. + +- {{{kbd(S-DOWN)}}} (~org-table-move-cell-down~) :: + + #+kindex: S-DOWN + #+findex: org-table-move-cell-down + Move cell down by swapping with adjacent cell. + +- {{{kbd(S-LEFT)}}} (~org-table-move-cell-left~) :: + + #+kindex: S-LEFT + #+findex: org-table-move-cell-left + Move cell left by swapping with adjacent cell. + +- {{{kbd(S-RIGHT)}}} (~org-table-move-cell-right~) :: + + #+kindex: S-RIGHT + #+findex: org-table-move-cell-right + Move cell right by swapping with adjacent cell. + +- {{{kbd(M-S-DOWN)}}} (~org-table-insert-row~) :: + + #+kindex: M-S-DOWN + #+findex: org-table-insert-row + Insert a new row above the current row. With a prefix argument, the + line is created below the current one. + +- {{{kbd(C-c -)}}} (~org-table-insert-hline~) :: + + #+kindex: C-c - + #+findex: org-table-insert-hline + Insert a horizontal line below current row. With a prefix argument, + the line is created above the current line. + +- {{{kbd(C-c RET)}}} (~org-table-hline-and-move~) :: + + #+kindex: C-c RET + #+findex: org-table-hline-and-move + Insert a horizontal line below current row, and move point into the + row below that line. + +- {{{kbd(C-c ^)}}} (~org-table-sort-lines~) :: + + #+kindex: C-c ^ + #+findex: org-table-sort-lines + Sort the table lines in the region. The position of point indicates + the column to be used for sorting, and the range of lines is the + range between the nearest horizontal separator lines, or the entire + table. If point is before the first column, you are prompted for + the sorting column. If there is an active region, the mark + specifies the first line and the sorting column, while point should + be in the last line to be included into the sorting. The command + prompts for the sorting type, alphabetically, numerically, or by + time. You can sort in normal or reverse order. You can also supply + your own key extraction and comparison functions. When called with + a prefix argument, alphabetic sorting is case-sensitive. + +*** Regions +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c C-x M-w)}}} (~org-table-copy-region~) :: + + #+kindex: C-c C-x M-w + #+findex: org-table-copy-region + Copy a rectangular region from a table to a special clipboard. + Point and mark determine edge fields of the rectangle. If there is + no active region, copy just the current field. The process ignores + horizontal separator lines. + +- {{{kbd(C-c C-x C-w)}}} (~org-table-cut-region~) :: + + #+kindex: C-c C-x C-w + #+findex: org-table-cut-region + Copy a rectangular region from a table to a special clipboard, and + blank all fields in the rectangle. So this is the "cut" operation. + +- {{{kbd(C-c C-x C-y)}}} (~org-table-paste-rectangle~) :: + + #+kindex: C-c C-x C-y + #+findex: org-table-paste-rectangle + Paste a rectangular region into a table. The upper left corner ends + up in the current field. All involved fields are overwritten. If + the rectangle does not fit into the present table, the table is + enlarged as needed. The process ignores horizontal separator lines. + +- {{{kbd(M-RET)}}} (~org-table-wrap-region~) :: + + #+kindex: M-RET + #+findex: org-table-wrap-region + Split the current field at point position and move the rest to the + line below. If there is an active region, and both point and mark + are in the same column, the text in the column is wrapped to minimum + width for the given number of lines. A numeric prefix argument may + be used to change the number of desired lines. If there is no + region, but you specify a prefix argument, the current field is made + blank, and the content is appended to the field above. + +*** Calculations +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: formula, in tables +#+cindex: calculations, in tables + +- {{{kbd(C-c +)}}} (~org-table-sum~) :: + + #+kindex: C-c + + #+findex: org-table-sum + Sum the numbers in the current column, or in the rectangle defined + by the active region. The result is shown in the echo area and can + be inserted with {{{kbd(C-y)}}}. + +- {{{kbd(S-RET)}}} (~org-table-copy-down~) :: + + #+kindex: S-RET + #+findex: org-table-copy-down + #+vindex: org-table-copy-increment + When current field is empty, copy from first non-empty field above. + When not empty, copy current field down to next row and move point + along with it. + + Depending on the variable ~org-table-copy-increment~, integer and + time stamp field values, and fields prefixed or suffixed with + a whole number, can be incremented during copy. Also, a ~0~ prefix + argument temporarily disables the increment. + + This key is also used by shift-selection and related modes (see + [[*Packages that conflict with Org mode]]). + +*** Miscellaneous +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c `)}}} (~org-table-edit-field~) :: + + #+kindex: C-c ` + #+findex: org-table-edit-field + Edit the current field in a separate window. This is useful for + fields that are not fully visible (see [[*Column Width and Alignment]]). + When called with a {{{kbd(C-u)}}} prefix, just make the full field + visible, so that it can be edited in place. When called with two + {{{kbd(C-u)}}} prefixes, make the editor window follow point through + the table and always show the current field. The follow mode exits + automatically when point leaves the table, or when you repeat this + command with {{{kbd(C-u C-u C-c `)}}}. + +- {{{kbd(M-x org-table-import)}}} :: + + #+findex: org-table-import + Import a file as a table. The table should be TAB or whitespace + separated. Use, for example, to import a spreadsheet table or data + from a database, because these programs generally can write + TAB-separated text files. This command works by inserting the file + into the buffer and then converting the region to a table. Any + prefix argument is passed on to the converter, which uses it to + determine the separator. + +- {{{kbd(C-c |)}}} (~org-table-create-or-convert-from-region~) :: + + #+kindex: C-c | + #+findex: org-table-create-or-convert-from-region + Tables can also be imported by pasting tabular text into the Org + buffer, selecting the pasted text with {{{kbd(C-x C-x)}}} and then + using the {{{kbd(C-c |)}}} command (see [[*Creation and conversion]]). + +- {{{kbd(M-x org-table-export)}}} :: + + #+findex: org-table-export + #+vindex: org-table-export-default-format + Export the table, by default as a TAB-separated file. Use for data + exchange with, for example, spreadsheet or database programs. The + format used to export the file can be configured in the variable + ~org-table-export-default-format~. You may also use properties + =TABLE_EXPORT_FILE= and =TABLE_EXPORT_FORMAT= to specify the file + name and the format for table export in a subtree. Org supports + quite general formats for exported tables. The exporter format is + the same as the format used by Orgtbl radio tables, see [[*Translator + functions]], for a detailed description. + +- {{{kbd(M-x org-table-header-line-mode)}}} :: + + #+findex: org-table-header-line-mode + #+vindex: org-table-header-line-p + Turn on the display of the first data row of the table at point in + the window header line when this first row is not visible anymore in + the buffer. You can activate this minor mode by default by setting + the option ~org-table-header-line-p~ to ~t~. + +- {{{kbd(M-x org-table-transpose-table-at-point)}}} :: + + #+findex: org-table-transpose-table-at-point + Transpose the table at point and eliminate hlines. + +** Column Width and Alignment +:PROPERTIES: +:DESCRIPTION: Overrule the automatic settings. +:END: +#+cindex: narrow columns in tables +#+cindex: alignment in tables + +The width of columns is automatically determined by the table editor. +The alignment of a column is determined automatically from the +fraction of number-like versus non-number fields in the column. + +#+vindex: org-table-automatic-realign +Editing a field may modify alignment of the table. Moving +a contiguous row or column---i.e., using {{{kbd(TAB)}}} or +{{{kbd(RET)}}}---automatically re-aligns it. If you want to disable +this behavior, set ~org-table-automatic-realign~ to ~nil~. In any +case, you can always align manually a table: + +- {{{kbd(C-c C-c)}}} (~org-table-align~) :: + + #+kindex: C-c C-c + #+findex: org-table-align + Align the current table. + +#+vindex: org-startup-align-all-tables +Setting the option ~org-startup-align-all-tables~ re-aligns all tables +in a file upon visiting it. You can also set this option on +a per-file basis with: + +#+begin_example +,#+STARTUP: align +,#+STARTUP: noalign +#+end_example + +Sometimes a single field or a few fields need to carry more text, +leading to inconveniently wide columns. Maybe you want to hide away +several columns or display them with a fixed width, regardless of +content, as shown in the following example. + +#+begin_example +|---+---------------------+--------| |---+-------…+…| +| | <6> | | | | <6> …|…| +| 1 | one | some | ----\ | 1 | one …|…| +| 2 | two | boring | ----/ | 2 | two …|…| +| 3 | This is a long text | column | | 3 | This i…|…| +|---+---------------------+--------| |---+-------…+…| +#+end_example + +To set the width of a column, one field anywhere in the column may +contain just the string =<N>= where {{{var(N)}}} specifies the width +as a number of characters. You control displayed width of columns +with the following tools: + +- {{{kbd(C-c TAB)}}} (~org-table-toggle-column-width~) :: + + #+kindex: C-c TAB + #+findex: org-table-toggle-column-width + Shrink or expand current column. + + If a width cookie specifies a width W for the column, shrinking it + displays the first W visible characters only. Otherwise, the column + is shrunk to a single character. + + When called before the first column or after the last one, ask for + a list of column ranges to operate on. + +- {{{kbd(C-u C-c TAB)}}} (~org-table-shrink~) :: + + #+kindex: C-u C-c TAB + #+findex: org-table-shrink + Shrink all columns with a column width. Expand the others. + +- {{{kbd(C-u C-u C-c TAB)}}} (~org-table-expand~) :: + + #+kindex: C-u C-u C-c TAB + #+findex: org-table-expand + Expand all columns. + +To see the full text of a shrunk field, hold the mouse over it: +a tool-tip window then shows the full contents of the field. +Alternatively, {{{kbd(C-h .)}}} (~display-local-help~) reveals them, +too. For convenience, any change near the shrunk part of a column +expands it. + +#+vindex: org-startup-shrink-all-tables +Setting the option ~org-startup-shrink-all-tables~ shrinks all columns +containing a width cookie in a file the moment it is visited. You can +also set this option on a per-file basis with: + +: #+STARTUP: shrink + +If you would like to overrule the automatic alignment of number-rich +columns to the right and of string-rich columns to the left, you can +use =<r>=, =<c>= or =<l>= in a similar fashion. You may also combine +alignment and field width like this: =<r10>=. + +Lines which only contain these formatting cookies are removed +automatically upon exporting the document. + +** Column Groups +:PROPERTIES: +:DESCRIPTION: Grouping to trigger vertical lines. +:END: +#+cindex: grouping columns in tables + +When Org exports tables, it does so by default without vertical lines +because that is visually more satisfying in general. Occasionally +however, vertical lines can be useful to structure a table into groups +of columns, much like horizontal lines can do for groups of rows. In +order to specify column groups, you can use a special row where the +first field contains only =/=. The further fields can either contain +=<= to indicate that this column should start a group, =>= to indicate +the end of a column, or =<>= (no space between =<= and =>=) to make +a column a group of its own. Upon export, boundaries between column +groups are marked with vertical lines. Here is an example: + +#+begin_example +| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | +|---+-----+-----+-----+---------+------------| +| / | < | | > | < | > | +| 1 | 1 | 1 | 1 | 1 | 1 | +| 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | +| 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | +|---+-----+-----+-----+---------+------------| +,#+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1))) +#+end_example + +It is also sufficient to just insert the column group starters after +every vertical line you would like to have: + +#+begin_example +| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | +|---+-----+-----+-----+---------+------------| +| / | < | | | < | | +#+end_example + +** The Orgtbl Minor Mode +:PROPERTIES: +:DESCRIPTION: The table editor as minor mode. +:ALT_TITLE: Orgtbl Mode +:END: +#+cindex: Orgtbl mode +#+cindex: minor mode for tables + +#+findex: orgtbl-mode +If you like the intuitive way the Org table editor works, you might +also want to use it in other modes like Text mode or Mail mode. The +minor mode Orgtbl mode makes this possible. You can always toggle the +mode with {{{kbd(M-x orgtbl-mode)}}}. To turn it on by default, for +example in Message mode, use + +#+begin_src emacs-lisp +(add-hook 'message-mode-hook 'turn-on-orgtbl) +#+end_src + +Furthermore, with some special setup, it is possible to maintain +tables in arbitrary syntax with Orgtbl mode. For example, it is +possible to construct LaTeX tables with the underlying ease and power +of Orgtbl mode, including spreadsheet capabilities. For details, see +[[*Tables in Arbitrary Syntax]]. + +** The Spreadsheet +:PROPERTIES: +:DESCRIPTION: The table editor has spreadsheet capabilities. +:END: +#+cindex: calculations, in tables +#+cindex: spreadsheet capabilities +#+cindex: Calc package + +The table editor makes use of the Emacs Calc package to implement +spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms +to derive fields from other fields. While fully featured, Org's +implementation is not identical to other spreadsheets. For example, +Org knows the concept of a /column formula/ that will be applied to +all non-header fields in a column without having to copy the formula +to each relevant field. There is also a formula debugger, and a +formula editor with features for highlighting fields in the table +corresponding to the references at point in the formula, moving these +references by arrow keys. + +*** References +:PROPERTIES: +:DESCRIPTION: How to refer to another field or range. +:END: +#+cindex: references + +To compute fields in the table from other fields, formulas must +reference other fields or ranges. In Org, fields can be referenced by +name, by absolute coordinates, and by relative coordinates. To find +out what the coordinates of a field are, press {{{kbd(C-c ?)}}} in +that field, or press {{{kbd(C-c })}}} to toggle the display of a grid. + +**** Field references +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: field references +#+cindex: references, to fields +Formulas can reference the value of another field in two ways. Like +in any other spreadsheet, you may reference fields with +a letter/number combination like =B3=, meaning the second field in the +third row. However, Org prefers to use another, more general +representation that looks like this:[fn:18] + +: @ROW$COLUMN + +Column specifications can be absolute like =$1=, =$2=, ..., =$N=, or +relative to the current column, i.e., the column of the field which is +being computed, like =$+1= or =$-2=. =$<= and =$>= are immutable +references to the first and last column, respectively, and you can use +=$>>>= to indicate the third column from the right. + +The row specification only counts data lines and ignores horizontal +separator lines, or "hlines". Like with columns, you can use absolute +row numbers =@1=, =@2=, ..., =@N=, and row numbers relative to the +current row like =@+3= or =@-1=. =@<= and =@>= are immutable +references the first and last row in the table, respectively. You may +also specify the row relative to one of the hlines: =@I= refers to the +first hline, =@II= to the second, etc. =@-I= refers to the first such +line above the current line, =@+I= to the first such line below the +current line. You can also write =@III+2= which is the second data +line after the third hline in the table. + +=@0= and =$0= refer to the current row and column, respectively, i.e., +to the row/column for the field being computed. Also, if you omit +either the column or the row part of the reference, the current +row/column is implied. + +Org's references with /unsigned/ numbers are fixed references in the +sense that if you use the same reference in the formula for two +different fields, the same field is referenced each time. Org's +references with /signed/ numbers are floating references because the +same reference operator can reference different fields depending on +the field being calculated by the formula. + +Here are a few examples: + +#+attr_texinfo: :columns 0.2 0.8 +| =@2$3= | 2nd row, 3rd column (same as =C2=) | +| =$5= | column 5 in the current row (same as =E&=) | +| =@2= | current column, row 2 | +| =@-1$-3= | field one row up, three columns to the left | +| =@-I$2= | field just under hline above current row, column 2 | +| =@>$5= | field in the last row, in column 5 | + +**** Range references +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: range references +#+cindex: references, to ranges +You may reference a rectangular range of fields by specifying two +field references connected by two dots =..=. The ends are included in +the range. If both fields are in the current row, you may simply use +=$2..$7=, but if at least one field is in a different row, you need to +use the general =@ROW$COLUMN= format at least for the first field, +i.e., the reference must start with =@= in order to be interpreted +correctly. Examples: + +#+attr_texinfo: :columns 0.2 0.8 +| =$1..$3= | first three fields in the current row | +| =$P..$Q= | range, using column names (see [[*Advanced features]]) | +| =$<<<..$>>= | start in third column, continue to the last but one | +| =@2$1..@4$3= | nine fields between these two fields (same as =A2..C4=) | +| =@-1$-2..@-1= | 3 fields in the row above, starting from 2 columns on the left | +| =@I..II= | between first and second hline, short for =@I..@II= | + +#+texinfo: @noindent +Range references return a vector of values that can be fed into Calc +vector functions. Empty fields in ranges are normally suppressed, so +that the vector contains only the non-empty fields. For other options +with the mode switches =E=, =N= and examples, see [[*Formula syntax for +Calc]]. + +**** Field coordinates in formulas +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: field coordinates +#+cindex: coordinates, of field +#+cindex: row, of field coordinates +#+cindex: column, of field coordinates +#+vindex: org-table-current-column +#+vindex: org-table-current-dline +One of the very first actions during evaluation of Calc formulas and +Lisp formulas is to substitute =@#= and =$#= in the formula with the +row or column number of the field where the current result will go to. +The traditional Lisp formula equivalents are ~org-table-current-dline~ +and ~org-table-current-column~. Examples: + +- =if(@# % 2, $#, string(""))= :: + + Insert column number on odd rows, set field to empty on even rows. + +- =$2 = '(identity remote(FOO, @@#$1))= :: + + Copy text or values of each row of column 1 of the table named + {{{var(FOO)}}} into column 2 of the current table. + +- =@3 = 2 * remote(FOO, @1$$#)= :: + + Insert the doubled value of each column of row 1 of the table + named {{{var(FOO)}}} into row 3 of the current table. + +#+texinfo: @noindent +For the second and third examples, table {{{var(FOO)}}} must have at +least as many rows or columns as the current table. Note that this is +inefficient[fn:19] for large number of rows. + +**** Named references +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: named references +#+cindex: references, named +#+cindex: name, of column or field +#+cindex: constants, in calculations +#+cindex: @samp{CONSTANTS}, keyword +#+vindex: org-table-formula-constants + +=$name= is interpreted as the name of a column, parameter or constant. +Constants are defined globally through the variable +~org-table-formula-constants~, and locally---for the file---through +a line like this example: + +: #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 + +#+vindex: constants-unit-system +#+pindex: constants.el +Also, properties (see [[*Properties and Columns]]) can be used as +constants in table formulas: for a property =Xyz= use the name +=$PROP_Xyz=, and the property will be searched in the current outline +entry and in the hierarchy above it. If you have the =constants.el= +package, it will also be used to resolve constants, including natural +constants like =$h= for Planck's constant, and units like =$km= for +kilometers[fn:20]. Column names and parameters can be specified in +special table lines. These are described below, see [[*Advanced +features]]. All names must start with a letter, and further consist +of letters and numbers. + +**** Remote references +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: remote references +#+cindex: references, remote +#+cindex: references, to a different table +#+cindex: name, of column or field +#+cindex: @samp{NAME}, keyword +You may also reference constants, fields and ranges from a different +table, either in the current file or even in a different file. The +syntax is + +: remote(NAME,REF) + +#+texinfo: @noindent +where {{{var(NAME)}}} can be the name of a table in the current file +as set by a =#+NAME:= line before the table. It can also be the ID of +an entry, even in a different file, and the reference then refers to +the first table in that entry. {{{var(REF)}}} is an absolute field or +range reference as described above for example =@3$3= or =$somename=, +valid in the referenced table. + +#+cindex: table indirection +When {{{var(NAME)}}} has the format =@ROW$COLUMN=, it is substituted +with the name or ID found in this field of the current table. For +example =remote($1, @@>$2)= \Rightarrow =remote(year_2013, @@>$1)=. The format +=B3= is not supported because it can not be distinguished from a plain +table name or ID. + +*** Formula syntax for Calc +:PROPERTIES: +:DESCRIPTION: Using Calc to compute stuff. +:END: +#+cindex: formula syntax, Calc +#+cindex: syntax, of formulas + +A formula can be any algebraic expression understood by the Emacs Calc +package. Note that Calc has the non-standard convention that =/= has +lower precedence than =*=, so that =a/b*c= is interpreted as +=(a/(b*c))=. Before evaluation by ~calc-eval~ (see [[info:calc#Calling Calc from Your Programs][Calling Calc from +Your Lisp Programs]]), variable substitution takes place according to +the rules described above. + +#+cindex: vectors, in table calculations +The range vectors can be directly fed into the Calc vector functions +like ~vmean~ and ~vsum~. + +#+cindex: format specifier, in spreadsheet +#+cindex: mode, for Calc +#+vindex: org-calc-default-modes +A formula can contain an optional mode string after a semicolon. This +string consists of flags to influence Calc and other modes during +execution. By default, Org uses the standard Calc modes (precision +12, angular units degrees, fraction and symbolic modes off). The +display format, however, has been changed to =(float 8)= to keep +tables compact. The default settings can be configured using the +variable ~org-calc-default-modes~. + +- =p20= :: + + Set the internal Calc calculation precision to 20 digits. + +- =n3=, =s3=, =e2=, =f4= :: + + Normal, scientific, engineering or fixed format of the result of + Calc passed back to Org. Calc formatting is unlimited in precision + as long as the Calc calculation precision is greater. + +- =D=, =R= :: + + Degree and radian angle modes of Calc. + +- =F=, =S= :: + + Fraction and symbolic modes of Calc. + +- =T=, =t=, =U= :: + + Duration computations in Calc or Lisp, [[*Durations and time values]]. + +- =E= :: + + If and how to consider empty fields. Without =E= empty fields in + range references are suppressed so that the Calc vector or Lisp list + contains only the non-empty fields. With =E= the empty fields are + kept. For empty fields in ranges or empty field references the + value =nan= (not a number) is used in Calc formulas and the empty + string is used for Lisp formulas. Add =N= to use 0 instead for both + formula types. For the value of a field the mode =N= has higher + precedence than =E=. + +- =N= :: + + Interpret all fields as numbers, use 0 for non-numbers. See the + next section to see how this is essential for computations with Lisp + formulas. In Calc formulas it is used only occasionally because + there number strings are already interpreted as numbers without =N=. + +- =L= :: + + Literal, for Lisp formulas only. See the next section. + +Unless you use large integer numbers or high-precision calculation and +display for floating point numbers you may alternatively provide +a ~printf~ format specifier to reformat the Calc result after it has +been passed back to Org instead of letting Calc already do the +formatting[fn:21]. A few examples: + +| =$1+$2= | Sum of first and second field | +| =$1+$2;%.2f= | Same, format result to two decimals | +| =exp($2)+exp($1)= | Math functions can be used | +| =$0;%.1f= | Reformat current cell to 1 decimal | +| =($3-32)*5/9= | Degrees F \to C conversion | +| =$c/$1/$cm= | Hz \to cm conversion, using =constants.el= | +| =tan($1);Dp3s1= | Compute in degrees, precision 3, display SCI 1 | +| =sin($1);Dp3%.1e= | Same, but use ~printf~ specifier for display | +| =vmean($2..$7)= | Compute column range mean, using vector function | +| =vmean($2..$7);EN= | Same, but treat empty fields as 0 | +| =taylor($3,x=7,2)= | Taylor series of $3, at x=7, second degree | + +Calc also contains a complete set of logical operations (see [[info:calc#Logical Operations][Logical +Operations]]). For example + +- =if($1 < 20, teen, string(""))= :: + + ="teen"= if age =$1= is less than 20, else the Org table result + field is set to empty with the empty string. + +- =if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1= :: + + Sum of the first two columns. When at least one of the input fields + is empty the Org table result field is set to empty. =E= is + required to not convert empty fields to 0. =f-1= is an optional + Calc format string similar to =%.1f= but leaves empty results empty. + +- =if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E= :: + + Mean value of a range unless there is any empty field. Every field + in the range that is empty is replaced by =nan= which lets =vmean= + result in =nan=. Then =typeof == 12= detects the =nan= from ~vmean~ + and the Org table result field is set to empty. Use this when the + sample set is expected to never have missing values. + +- =if("$1..$7" == "[]", string(""), vmean($1..$7))= :: + + Mean value of a range with empty fields skipped. Every field in the + range that is empty is skipped. When all fields in the range are + empty the mean value is not defined and the Org table result field + is set to empty. Use this when the sample set can have a variable + size. + +- =vmean($1..$7); EN= :: + + To complete the example before: Mean value of a range with empty + fields counting as samples with value 0. Use this only when + incomplete sample sets should be padded with 0 to the full size. + +You can add your own Calc functions defined in Emacs Lisp with +~defmath~ and use them in formula syntax for Calc. + +*** Emacs Lisp forms as formulas +:PROPERTIES: +:DESCRIPTION: Writing formulas in Emacs Lisp. +:ALT_TITLE: Formula syntax for Lisp +:END: +#+cindex: Lisp forms, as table formulas + +It is also possible to write a formula in Emacs Lisp. This can be +useful for string manipulation and control structures, if Calc's +functionality is not enough. + +If a formula starts with a single-quote followed by an opening +parenthesis, then it is evaluated as a Lisp form. The evaluation +should return either a string or a number. Just as with Calc +formulas, you can specify modes and a ~printf~ format after +a semicolon. + +With Emacs Lisp forms, you need to be conscious about the way field +references are interpolated into the form. By default, a reference is +interpolated as a Lisp string (in double-quotes) containing the field. +If you provide the =N= mode switch, all referenced elements are +numbers---non-number fields will be zero---and interpolated as Lisp +numbers, without quotes. If you provide the =L= flag, all fields are +interpolated literally, without quotes. For example, if you want a +reference to be interpreted as a string by the Lisp form, enclose the +reference operator itself in double-quotes, like ="$3"=. Ranges are +inserted as space-separated fields, so you can embed them in list or +vector syntax. + +Here are a few examples---note how the =N= mode is used when we do +computations in Lisp: + +- ='(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))= :: + + Swap the first two characters of the content of column 1. + +- ='(+ $1 $2);N= :: + + Add columns 1 and 2, equivalent to Calc's =$1+$2=. + +- ='(apply '+ '($1..$4));N= :: + + Compute the sum of columns 1 to 4, like Calc's =vsum($1..$4)=. + +*** Durations and time values +:PROPERTIES: +:DESCRIPTION: How to compute durations and time values. +:END: +#+cindex: duration, computing +#+cindex: time, computing +#+vindex: org-table-duration-custom-format + +If you want to compute time values use the =T=, =t=, or =U= flag, +either in Calc formulas or Elisp formulas: + +#+begin_example +| Task 1 | Task 2 | Total | +|---------+----------+----------| +| 2:12 | 1:47 | 03:59:00 | +| 2:12 | 1:47 | 03:59 | +| 3:02:20 | -2:07:00 | 0.92 | +,#+TBLFM: @2$3=$1+$2;T::@3$3=$1+$2;U::@4$3=$1+$2;t +#+end_example + +Input duration values must be of the form =HH:MM[:SS]=, where seconds +are optional. With the =T= flag, computed durations are displayed as +=HH:MM:SS= (see the first formula above). With the =U= flag, seconds +are omitted so that the result is only =HH:MM= (see second formula +above). Zero-padding of the hours field depends upon the value of the +variable ~org-table-duration-hour-zero-padding~. + +With the =t= flag, computed durations are displayed according to the +value of the option ~org-table-duration-custom-format~, which defaults +to ~hours~ and displays the result as a fraction of hours (see the +third formula in the example above). + +Negative duration values can be manipulated as well, and integers are +considered as seconds in addition and subtraction. + +*** Field and range formulas +:PROPERTIES: +:DESCRIPTION: Formula for specific (ranges of) fields. +:END: +#+cindex: field formula +#+cindex: range formula +#+cindex: formula, for individual table field +#+cindex: formula, for range of fields + +To assign a formula to a particular field, type it directly into the +field, preceded by =:==, for example =vsum(@II..III)=. When you press +{{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} with point +still in the field, the formula is stored as the formula for this +field, evaluated, and the current field is replaced with the result. + +#+cindex: @samp{TBLFM}, keyword +Formulas are stored in a special =TBLFM= keyword located directly +below the table. If you type the equation in the fourth field of the +third data line in the table, the formula looks like =@3$4=$1+$2=. +When inserting/deleting/swapping column and rows with the appropriate +commands, /absolute references/ (but not relative ones) in stored +formulas are modified in order to still reference the same field. To +avoid this from happening, in particular in range references, anchor +ranges at the table borders (using =@<=, =@>=, =$<=, =$>=), or at +hlines using the =@I= notation. Automatic adaptation of field +references does not happen if you edit the table structure with normal +editing commands---you must fix the formulas yourself. + +Instead of typing an equation into the field, you may also use the +following command + +- {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) :: + + #+kindex: C-u C-c = + #+findex: org-table-eval-formula + Install a new formula for the current field. The command prompts + for a formula with default taken from the =TBLFM= keyword, + applies it to the current field, and stores it. + +The left-hand side of a formula can also be a special expression in +order to assign the formula to a number of different fields. There is +no keyboard shortcut to enter such range formulas. To add them, use +the formula editor (see [[*Editing and debugging formulas]]) or edit +the =TBLFM= keyword directly. + +- =$2== :: + + Column formula, valid for the entire column. This is so common that + Org treats these formulas in a special way, see [[*Column formulas]]. + +- =@3== :: + + Row formula, applies to all fields in the specified row. =@>== + means the last row. + +- =@1$2..@4$3== :: + + Range formula, applies to all fields in the given rectangular range. + This can also be used to assign a formula to some but not all fields + in a row. + +- =$NAME== :: + + Named field, see [[*Advanced features]]. + +*** Column formulas +:PROPERTIES: +:DESCRIPTION: Formulas valid for an entire column. +:END: +#+cindex: column formula +#+cindex: formula, for table column + +When you assign a formula to a simple column reference like =$3==, the +same formula is used in all fields of that column, with the following +very convenient exceptions: (i) If the table contains horizontal +separator hlines with rows above and below, everything before the +first such hline is considered part of the table /header/ and is not +modified by column formulas. Therefore a header is mandatory when you +use column formulas and want to add hlines to group rows, like for +example to separate a total row at the bottom from the summand rows +above. (ii) Fields that already get a value from a field/range +formula are left alone by column formulas. These conditions make +column formulas very easy to use. + +To assign a formula to a column, type it directly into any field in +the column, preceded by an equal sign, like ==$1+$2=. When you press +{{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} with point +still in the field, the formula is stored as the formula for the +current column, evaluated and the current field replaced with the +result. If the field contains only ===, the previously stored formula +for this column is used. For each column, Org only remembers the most +recently used formula. In the =TBLFM= keyword, column formulas look +like =$4=$1+$2=. The left-hand side of a column formula can not be +the name of column, it must be the numeric column reference or =$>=. + +Instead of typing an equation into the field, you may also use the +following command: + +- {{{kbd(C-c =)}}} (~org-table-eval-formula~) :: + + #+kindex: C-c = + #+findex: org-table-eval-formula + Install a new formula for the current column and replace current + field with the result of the formula. The command prompts for + a formula, with default taken from the =TBLFM= keyword, applies it + to the current field and stores it. With a numeric prefix argument, + e.g., {{{kbd(C-5 C-c =)}}}, the command applies it to that many + consecutive fields in the current column. + +*** Lookup functions +:PROPERTIES: +:DESCRIPTION: Lookup functions for searching tables. +:END: +#+cindex: lookup functions in tables +#+cindex: table lookup functions + +Org has three predefined Emacs Lisp functions for lookups in tables. + +- =(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)= :: + + #+findex: org-lookup-first + Searches for the first element {{{var(S)}}} in list + {{{var(S-LIST)}}} for which + #+begin_src emacs-lisp + (PREDICATE VAL S) + #+end_src + is non-~nil~; returns the value from the corresponding position in + list {{{var(R-LIST)}}}. The default {{{var(PREDICATE)}}} is + ~equal~. Note that the parameters {{{var(VAL)}}} and {{{var(S)}}} + are passed to {{{var(PREDICATE)}}} in the same order as the + corresponding parameters are in the call to ~org-lookup-first~, + where {{{var(VAL)}}} precedes {{{var(S-LIST)}}}. If + {{{var(R-LIST)}}} is ~nil~, the matching element {{{var(S)}}} of + {{{var(S-LIST)}}} is returned. + +- =(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)= :: + + #+findex: org-lookup-last + Similar to ~org-lookup-first~ above, but searches for the /last/ + element for which {{{var(PREDICATE)}}} is non-~nil~. + +- =(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)= :: + + #+findex: org-lookup-all + Similar to ~org-lookup-first~, but searches for /all/ elements for + which {{{var(PREDICATE)}}} is non-~nil~, and returns /all/ + corresponding values. This function can not be used by itself in + a formula, because it returns a list of values. However, powerful + lookups can be built when this function is combined with other Emacs + Lisp functions. + +If the ranges used in these functions contain empty fields, the =E= +mode for the formula should usually be specified: otherwise empty +fields are not included in {{{var(S-LIST)}}} and/or {{{var(R-LIST)}}} +which can, for example, result in an incorrect mapping from an element +of {{{var(S-LIST)}}} to the corresponding element of +{{{var(R-LIST)}}}. + +These three functions can be used to implement associative arrays, +count matching cells, rank results, group data, etc. For practical +examples see [[https://orgmode.org/worg/org-tutorials/org-lookups.html][this tutorial on Worg]]. + +*** Editing and debugging formulas +:PROPERTIES: +:DESCRIPTION: Fixing formulas. +:END: +#+cindex: formula editing +#+cindex: editing, of table formulas + +#+vindex: org-table-use-standard-references +You can edit individual formulas in the minibuffer or directly in the +field. Org can also prepare a special buffer with all active formulas +of a table. When offering a formula for editing, Org converts +references to the standard format (like =B3= or =D&=) if possible. If +you prefer to only work with the internal format (like =@3$2= or +=$4=), configure the variable ~org-table-use-standard-references~. + +- {{{kbd(C-c =)}}} or {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) :: + + #+kindex: C-c = + #+kindex: C-u C-c = + #+findex: org-table-eval-formula + Edit the formula associated with the current column/field in the + minibuffer. See [[*Column formulas]], and [[*Field and range formulas]]. + +- {{{kbd(C-u C-u C-c =)}}} (~org-table-eval-formula~) :: + + #+kindex: C-u C-u C-c = + #+findex: org-table-eval-formula + Re-insert the active formula (either a field formula, or a column + formula) into the current field, so that you can edit it directly in + the field. The advantage over editing in the minibuffer is that you + can use the command {{{kbd(C-c ?)}}}. + +- {{{kbd(C-c ?)}}} (~org-table-field-info~) :: + + #+kindex: C-c ? + #+findex: org-table-field-info + While editing a formula in a table field, highlight the field(s) + referenced by the reference at point position in the formula. + +- {{{kbd(C-c })}}} (~org-table-toggle-coordinate-overlays~) :: + + #+kindex: C-c @} + #+findex: org-table-toggle-coordinate-overlays + Toggle the display of row and column numbers for a table, using + overlays. These are updated each time the table is aligned; you can + force it with {{{kbd(C-c C-c)}}}. + +- {{{kbd(C-c {)}}} (~org-table-toggle-formula-debugger~) :: + + #+kindex: C-c @{ + #+findex: org-table-toggle-formula-debugger + Toggle the formula debugger on and off. See below. + +- {{{kbd(C-c ')}}} (~org-table-edit-formulas~) :: + + #+kindex: C-c ' + #+findex: org-table-edit-formulas + Edit all formulas for the current table in a special buffer, where + the formulas are displayed one per line. If the current field has + an active formula, point in the formula editor marks it. While + inside the special buffer, Org automatically highlights any field or + range reference at point position. You may edit, remove and add + formulas, and use the following commands: + + - {{{kbd(C-c C-c)}}} or {{{kbd(C-x C-s)}}} (~org-table-fedit-finish~) :: + + #+kindex: C-x C-s + #+kindex: C-c C-c + #+findex: org-table-fedit-finish + Exit the formula editor and store the modified formulas. With + {{{kbd(C-u)}}} prefix, also apply the new formulas to the + entire table. + + - {{{kbd(C-c C-q)}}} (~org-table-fedit-abort~) :: + + #+kindex: C-c C-q + #+findex: org-table-fedit-abort + Exit the formula editor without installing changes. + + - {{{kbd(C-c C-r)}}} (~org-table-fedit-toggle-ref-type~) :: + + #+kindex: C-c C-r + #+findex: org-table-fedit-toggle-ref-type + Toggle all references in the formula editor between standard (like + =B3=) and internal (like =@3$2=). + + - {{{kbd(TAB)}}} (~org-table-fedit-lisp-indent~) :: + + #+kindex: TAB + #+findex: org-table-fedit-lisp-indent + Pretty-print or indent Lisp formula at point. When in a line + containing a Lisp formula, format the formula according to Emacs + Lisp rules. Another {{{kbd(TAB)}}} collapses the formula back + again. In the open formula, {{{kbd(TAB)}}} re-indents just like + in Emacs Lisp mode. + + - {{{kbd(M-TAB)}}} (~lisp-complete-symbol~) :: + + #+kindex: M-TAB + #+findex: lisp-complete-symbol + Complete Lisp symbols, just like in Emacs Lisp mode. + + - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}}, {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} :: + + #+kindex: S-UP + #+kindex: S-DOWN + #+kindex: S-LEFT + #+kindex: S-RIGHT + #+findex: org-table-fedit-ref-up + #+findex: org-table-fedit-ref-down + #+findex: org-table-fedit-ref-left + #+findex: org-table-fedit-ref-right + Shift the reference at point. For example, if the reference is + =B3= and you press {{{kbd(S-RIGHT)}}}, it becomes =C3=. This also + works for relative references and for hline references. + + - {{{kbd(M-S-UP)}}} (~org-table-fedit-line-up~) :: + + #+kindex: M-S-UP + #+findex: org-table-fedit-line-up + Move the test line for column formulas up in the Org buffer. + + - {{{kbd(M-S-DOWN)}}} (~org-table-fedit-line-down~) :: + + #+kindex: M-S-DOWN + #+findex: org-table-fedit-line-down + Move the test line for column formulas down in the Org buffer. + + - {{{kbd(M-UP)}}} (~org-table-fedit-scroll-up~) :: + + #+kindex: M-UP + #+findex: org-table-fedit-scroll-up + Scroll up the window displaying the table. + + - {{{kbd(M-DOWN)}}} (~org-table-fedit-scroll-down~) :: + + #+kindex: M-DOWN + #+findex: org-table-fedit-scroll-down + Scroll down the window displaying the table. + + - {{{kbd(C-c })}}} :: + + #+kindex: C-c @} + #+findex: org-table-toggle-coordinate-overlays + Turn the coordinate grid in the table on and off. + +Making a table field blank does not remove the formula associated with +the field, because that is stored in a different line---the =TBLFM= +keyword line. During the next recalculation, the field will be filled +again. To remove a formula from a field, you have to give an empty +reply when prompted for the formula, or to edit the =TBLFM= keyword. + +#+kindex: C-c C-c +You may edit the =TBLFM= keyword directly and re-apply the changed +equations with {{{kbd(C-c C-c)}}} in that line or with the normal +recalculation commands in the table. + +**** Using multiple =TBLFM= lines +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: multiple formula lines +#+cindex: @samp{TBLFM} keywords, multiple +#+cindex: @samp{TBLFM}, switching + +#+kindex: C-c C-c +You may apply the formula temporarily. This is useful when you want +to switch the formula applied to the table. Place multiple =TBLFM= +keywords right after the table, and then press {{{kbd(C-c C-c)}}} on +the formula to apply. Here is an example: + +#+begin_example +| x | y | +|---+---| +| 1 | | +| 2 | | +,#+TBLFM: $2=$1*1 +,#+TBLFM: $2=$1*2 +#+end_example + +#+texinfo: @noindent +Pressing {{{kbd(C-c C-c)}}} in the line of =#+TBLFM: $2=$1*2= yields: + +#+begin_example +| x | y | +|---+---| +| 1 | 2 | +| 2 | 4 | +,#+TBLFM: $2=$1*1 +,#+TBLFM: $2=$1*2 +#+end_example + +#+texinfo: @noindent +If you recalculate this table, with {{{kbd(C-u C-c *)}}}, for example, +you get the following result from applying only the first =TBLFM= +keyword. + +#+begin_example +| x | y | +|---+---| +| 1 | 1 | +| 2 | 2 | +,#+TBLFM: $2=$1*1 +,#+TBLFM: $2=$1*2 +#+end_example + +**** Debugging formulas +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: formula debugging +#+cindex: debugging, of table formulas + +When the evaluation of a formula leads to an error, the field content +becomes the string =#ERROR=. If you would like to see what is going +on during variable substitution and calculation in order to find +a bug, turn on formula debugging in the Tbl menu and repeat the +calculation, for example by pressing {{{kbd(C-u C-u C-c = RET)}}} in +a field. Detailed information are displayed. + +*** Updating the table +:PROPERTIES: +:DESCRIPTION: Recomputing all dependent fields. +:END: +#+cindex: recomputing table fields +#+cindex: updating, table + +Recalculation of a table is normally not automatic, but needs to be +triggered by a command. To make recalculation at least +semi-automatic, see [[*Advanced features]]. + +In order to recalculate a line of a table or the entire table, use the +following commands: + +- {{{kbd(C-c *)}}} (~org-table-recalculate~) :: + + #+kindex: C-c * + #+findex: org-table-recalculate + Recalculate the current row by first applying the stored column + formulas from left to right, and all field/range formulas in the + current row. + +- {{{kbd(C-u C-c *)}}} or {{{kbd(C-u C-c C-c)}}} :: + + #+kindex: C-u C-c * + #+kindex: C-u C-c C-c + Recompute the entire table, line by line. Any lines before the + first hline are left alone, assuming that these are part of the + table header. + +- {{{kbd(C-u C-u C-c *)}}} or {{{kbd(C-u C-u C-c C-c)}}} (~org-table-iterate~) :: + + #+kindex: C-u C-u C-c * + #+kindex: C-u C-u C-c C-c + #+findex: org-table-iterate + Iterate the table by recomputing it until no further changes occur. + This may be necessary if some computed fields use the value of other + fields that are computed /later/ in the calculation sequence. + +- {{{kbd(M-x org-table-recalculate-buffer-tables)}}} :: + + #+findex: org-table-recalculate-buffer-tables + Recompute all tables in the current buffer. + +- {{{kbd(M-x org-table-iterate-buffer-tables)}}} :: + + #+findex: org-table-iterate-buffer-tables + Iterate all tables in the current buffer, in order to converge + table-to-table dependencies. + +*** Advanced features +:PROPERTIES: +:DESCRIPTION: Field and column names, automatic recalculation... +:END: + +If you want the recalculation of fields to happen automatically, or if +you want to be able to assign /names/[fn:22] to fields and columns, +you need to reserve the first column of the table for special marking +characters. + +- {{{kbd(C-#)}}} (~org-table-rotate-recalc-marks~) :: + + #+kindex: C-# + #+findex: org-table-rotate-recalc-marks + Rotate the calculation mark in first column through the states =#=, + =*=, =!=, =$=. When there is an active region, change all marks in + the region. + +Here is an example of a table that collects exam results of students +and makes use of these features: + +#+begin_example +|---+---------+--------+--------+--------+-------+------| +| | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | +|---+---------+--------+--------+--------+-------+------| +| ! | | P1 | P2 | P3 | Tot | | +| # | Maximum | 10 | 15 | 25 | 50 | 10.0 | +| ^ | | m1 | m2 | m3 | mt | | +|---+---------+--------+--------+--------+-------+------| +| # | Peter | 10 | 8 | 23 | 41 | 8.2 | +| # | Sam | 2 | 4 | 3 | 9 | 1.8 | +|---+---------+--------+--------+--------+-------+------| +| | Average | | | | 25.0 | | +| ^ | | | | | at | | +| $ | max=50 | | | | | | +|---+---------+--------+--------+--------+-------+------| +,#+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f +#+end_example + +#+attr_texinfo: :tag Important +#+begin_quote +Please note that for these special tables, recalculating the table +with {{{kbd(C-u C-c *)}}} only affects rows that are marked =#= or +=*=, and fields that have a formula assigned to the field itself. The +column formulas are not applied in rows with empty first field. +#+end_quote + +#+cindex: marking characters, tables +The marking characters have the following meaning: + +- =!= :: + + The fields in this line define names for the columns, so that you + may refer to a column as =$Tot= instead of =$6=. + +- =^= :: + + This row defines names for the fields /above/ the row. With such + a definition, any formula in the table may use =$m1= to refer to the + value =10=. Also, if you assign a formula to a names field, it is + stored as =$name = ...=. + +- =_= :: + + Similar to =^=, but defines names for the fields in the row /below/. + +- =$= :: + + Fields in this row can define /parameters/ for formulas. For + example, if a field in a =$= row contains =max=50=, then formulas in + this table can refer to the value 50 using =$max=. Parameters work + exactly like constants, only that they can be defined on a per-table + basis. + +- =#= :: + + Fields in this row are automatically recalculated when pressing + {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(S-TAB)}}} in this row. + Also, this row is selected for a global recalculation with + {{{kbd(C-u C-c *)}}}. Unmarked lines are left alone by this + command. + +- =*= :: + + Selects this line for global recalculation with {{{kbd(C-u C-c + *)}}}, but not for automatic recalculation. Use this when automatic + recalculation slows down editing too much. + +- =/= :: + + Do not export this line. Useful for lines that contain the + narrowing =<N>= markers or column group markers. + +Finally, just to whet your appetite for what can be done with the +fantastic Calc package, here is a table that computes the Taylor +series of degree n at location x for a couple of functions. + +#+begin_example +|---+-------------+---+-----+--------------------------------------| +| | Func | n | x | Result | +|---+-------------+---+-----+--------------------------------------| +| # | exp(x) | 1 | x | 1 + x | +| # | exp(x) | 2 | x | 1 + x + x^2 / 2 | +| # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | +| # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | +| # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | +| * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | +|---+-------------+---+-----+--------------------------------------| +,#+TBLFM: $5=taylor($2,$4,$3);n3 +#+end_example + +** Org Plot +:PROPERTIES: +:DESCRIPTION: Plotting from Org tables. +:END: +#+cindex: graph, in tables +#+cindex: plot tables using Gnuplot + +Org Plot can produce graphs of information stored in Org tables, +either graphically or in ASCII art. + +*** Graphical plots using Gnuplot +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{PLOT}, keyword +Org Plot can produce 2D and 3D graphs of information stored in Org +tables using [[http://www.gnuplot.info/][Gnuplot]] and [[http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html][Gnuplot mode]]. To see this in action, ensure +that you have both Gnuplot and Gnuplot mode installed on your system, +then call {{{kbd(C-c \quot g)}}} or {{{kbd(M-x org-plot/gnuplot)}}} on the +following table. + +#+begin_example +,#+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" +| Sede | Max cites | H-index | +|-----------+-----------+---------| +| Chile | 257.72 | 21.39 | +| Leeds | 165.77 | 19.68 | +| Sao Paolo | 71.00 | 11.50 | +| Stockholm | 134.19 | 14.33 | +| Morelia | 257.56 | 17.67 | +#+end_example + +Notice that Org Plot is smart enough to apply the table's headers as +labels. Further control over the labels, type, content, and +appearance of plots can be exercised through the =PLOT= keyword +preceding a table. See below for a complete list of Org Plot options. +For more information and examples see the [[https://orgmode.org/worg/org-tutorials/org-plot.html][Org Plot tutorial]]. + +**** Plot options +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- =set= :: + + Specify any Gnuplot option to be set when graphing. + +- =title= :: + + Specify the title of the plot. + +- =ind= :: + + Specify which column of the table to use as the =x= axis. + +- =deps= :: + + Specify the columns to graph as a Lisp style list, surrounded by + parentheses and separated by spaces for example =dep:(3 4)= to graph + the third and fourth columns. Defaults to graphing all other + columns aside from the =ind= column. + +- =type= :: + + Specify whether the plot is =2d=, =3d=, or =grid=. + +- =with= :: + + Specify a =with= option to be inserted for every column being + plotted, e.g., =lines=, =points=, =boxes=, =impulses=. Defaults to + =lines=. + +- =file= :: + + If you want to plot to a file, specify + ="path/to/desired/output-file"=. + +- =labels= :: + + List of labels to be used for the =deps=. Defaults to the column + headers if they exist. + +- =line= :: + + Specify an entire line to be inserted in the Gnuplot script. + +- =map= :: + + When plotting =3d= or =grid= types, set this to =t= to graph a flat + mapping rather than a =3d= slope. + +- =timefmt= :: + + Specify format of Org mode timestamps as they will be parsed by + Gnuplot. Defaults to =%Y-%m-%d-%H:%M:%S=. + +- =script= :: + + If you want total control, you can specify a script file---place the + file name between double-quotes---which will be used to plot. + Before plotting, every instance of =$datafile= in the specified + script will be replaced with the path to the generated data file. + Note: even if you set this option, you may still want to specify the + plot type, as that can impact the content of the data file. + +*** ASCII bar plots +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +While point is on a column, typing {{{kbd(C-c " a)}}} or {{{kbd(M-x +orgtbl-ascii-plot)}}} create a new column containing an ASCII-art bars +plot. The plot is implemented through a regular column formula. When +the source column changes, the bar plot may be updated by refreshing +the table, for example typing {{{kbd(C-u C-c *)}}}. + +#+begin_example +| Sede | Max cites | | +|---------------+-----------+--------------| +| Chile | 257.72 | WWWWWWWWWWWW | +| Leeds | 165.77 | WWWWWWWh | +| Sao Paolo | 71.00 | WWW; | +| Stockholm | 134.19 | WWWWWW: | +| Morelia | 257.56 | WWWWWWWWWWWH | +| Rochefourchat | 0.00 | | +,#+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12) +#+end_example + +The formula is an Elisp call. + +#+attr_texinfo: :options orgtbl-ascii-draw value min max &optional width +#+begin_defun +Draw an ASCII bar in a table. + +{{{var(VALUE)}}} is the value to plot. + +{{{var(MIN)}}} is the value displayed as an empty bar. {{{var(MAX)}}} +is the value filling all the {{{var(WIDTH)}}}. Sources values outside +this range are displayed as =too small= or =too large=. + +{{{var(WIDTH)}}} is the number of characters of the bar plot. It +defaults to =12=. +#+end_defun + +* Hyperlinks +:PROPERTIES: +:DESCRIPTION: Notes in context. +:END: +#+cindex: hyperlinks + +Like HTML, Org provides support for links inside a file, external +links to other files, Usenet articles, emails, and much more. + +** Link Format +:PROPERTIES: +:DESCRIPTION: How links in Org are formatted. +:END: +#+cindex: link format +#+cindex: format, of links + +#+cindex: angle bracket links +#+cindex: plain links +Org recognizes plain URIs, possibly wrapped within angle +brackets[fn:23], and activate them as clickable links. + +#+cindex: bracket links +The general link format, however, looks like this: + +: [[LINK][DESCRIPTION]] + +#+texinfo: @noindent +or alternatively + +: [[LINK]] + +#+cindex: escape syntax, for links +#+cindex: backslashes, in links +Some =\=, =[= and =]= characters in the {{{var(LINK)}}} part need to +be "escaped", i.e., preceded by another =\= character. More +specifically, the following characters, and only them, must be +escaped: + +1. all =[= and =]= characters, +2. every =\= character preceding either =]= or =[=, +3. every =\= character at the end of the link. + +#+findex: org-link-escape +Functions inserting links (see [[*Handling Links]]) properly escape +ambiguous characters. You only need to bother about the rules above +when inserting directly, or yanking, a URI within square brackets. +When in doubt, you may use the function ~org-link-escape~, which turns +a link string into its escaped form. + +Once a link in the buffer is complete, with all brackets present, Org +changes the display so that =DESCRIPTION= is displayed instead of +=[[LINK][DESCRIPTION]]= and =LINK= is displayed instead of =[[LINK]]=. +Links are highlighted in the ~org-link~ face, which, by default, is an +underlined face. + +You can directly edit the visible part of a link. This can be either +the {{{var(LINK)}}} part, if there is no description, or the +{{{var(DESCRIPTION)}}} part otherwise. To also edit the invisible +{{{var(LINK)}}} part, use {{{kbd(C-c C-l)}}} with point on the link +(see [[*Handling Links]]). + +If you place point at the beginning or just behind the end of the +displayed text and press {{{kbd(BS)}}}, you remove +the---invisible---bracket at that location[fn:24]. This makes the link +incomplete and the internals are again displayed as plain text. +Inserting the missing bracket hides the link internals again. To show +the internal structure of all links, use the menu: Org \rarr Hyperlinks \rarr +Literal links. + +** Internal Links +:PROPERTIES: +:DESCRIPTION: Links to other places in the current file. +:END: +#+cindex: internal links +#+cindex: links, internal + +A link that does not look like a URL---i.e., does not start with +a known scheme or a file name---refers to the current document. You +can follow it with {{{kbd(C-c C-o)}}} when point is on the link, or +with a mouse click (see [[*Handling Links]]). + +#+cindex: @samp{CUSTOM_ID}, property +Org provides several refinements to internal navigation within +a document. Most notably, a construct like =[[#my-custom-id]]= +specifically targets the entry with the =CUSTOM_ID= property set to +=my-custom-id=. Also, an internal link looking like =[[*Some +section]]= points to a headline with the name =Some section=[fn:25]. + +#+cindex: targets, for links +When the link does not belong to any of the cases above, Org looks for +a /dedicated target/: the same string in double angular brackets, like +=<<My Target>>=. + +#+cindex: @samp{NAME}, keyword +If no dedicated target exists, the link tries to match the exact name +of an element within the buffer. Naming is done, unsurprisingly, with +the =NAME= keyword, which has to be put in the line before the element +it refers to, as in the following example + +#+begin_example +,#+NAME: My Target +| a | table | +|----+------------| +| of | four cells | +#+end_example + +#+vindex: org-link-search-must-match-exact-headline +Ultimately, if none of the above succeeds, Org searches for a headline +that is exactly the link text but may also include a TODO keyword and +tags, or initiates a plain text search, according to the value of +~org-link-search-must-match-exact-headline~. + +Note that you must make sure custom IDs, dedicated targets, and names +are unique throughout the document. Org provides a linter to assist +you in the process, if needed. See [[*Org Syntax]]. + +During export, internal links are used to mark objects and assign them +a number. Marked objects are then referenced by links pointing to +them. In particular, links without a description appear as the number +assigned to the marked object[fn:26]. In the following excerpt from +an Org buffer + +#+begin_example +1. one item +2. <<target>>another item +Here we refer to item [[target]]. +#+end_example + +#+texinfo: @noindent +The last sentence will appear as =Here we refer to item 2= when +exported. + +In non-Org files, the search looks for the words in the link text. In +the above example the search would be for =target=. + +Following a link pushes a mark onto Org's own mark ring. You can +return to the previous position with {{{kbd(C-c &)}}}. Using this +command several times in direct succession goes back to positions +recorded earlier. + +** Radio Targets +:PROPERTIES: +:DESCRIPTION: Make targets trigger links in plain text. +:END: +#+cindex: radio targets +#+cindex: targets, radio +#+cindex: links, radio targets + +Org can automatically turn any occurrences of certain target names in +normal text into a link. So without explicitly creating a link, the +text connects to the target radioing its position. Radio targets are +enclosed by triple angular brackets. For example, a target =<<<My +Target>>>= causes each occurrence of =my target= in normal text to +become activated as a link. The Org file is scanned automatically for +radio targets only when the file is first loaded into Emacs. To +update the target list during editing, press {{{kbd(C-c C-c)}}} with +point on or at a target. + +** External Links +:PROPERTIES: +:DESCRIPTION: URL-like links to the world. +:END: +#+cindex: links, external +#+cindex: external links +#+cindex: attachment links +#+cindex: BBDB links +#+cindex: Elisp links +#+cindex: file links +#+cindex: Gnus links +#+cindex: Help links +#+cindex: IRC links +#+cindex: Info links +#+cindex: MH-E links +#+cindex: Rmail links +#+cindex: shell links +#+cindex: URL links +#+cindex: Usenet links + +Org supports links to files, websites, Usenet and email messages, BBDB +database entries and links to both IRC conversations and their logs. +External links are URL-like locators. They start with a short +identifying string followed by a colon. There can be no space after +the colon. + +Here is the full set of built-in link types: + +- =file= :: + + File links. File name may be remote, absolute, or relative. + + Additionally, you can specify a line number, or a text search. + In Org files, you may link to a headline name, a custom ID, or a + code reference instead. + + As a special case, "file" prefix may be omitted if the file name + is complete, e.g., it starts with =./=, or =/=. + +- =attachment= :: + + Same as file links but for files and folders attached to the current + node (see [[*Attachments]]). Attachment links are intended to behave + exactly as file links but for files relative to the attachment + directory. + +- =bbdb= :: + + Link to a BBDB record, with possible regexp completion. + +- =docview= :: + + Link to a document opened with DocView mode. You may specify a page + number. + +- =doi= :: + + Link to an electronic resource, through its handle. + +- =elisp= :: + + Execute an Elisp command upon activation. + +- =gnus=, =rmail=, =mhe= :: + + Link to messages or folders from a given Emacs' MUA. + +- =help= :: + + Display documentation of a symbol in =*Help*= buffer. + +- =http=, =https= :: + + Web links. + +- =id= :: + + Link to a specific headline by its ID property, in an Org file. + +- =info= :: + + Link to an Info manual, or to a specific node. + +- =irc= :: + + Link to an IRC channel. + +- =mailto= :: + + Link to message composition. + +- =news= :: + + Usenet links. + +- =shell= :: + + Execute a shell command upon activation. + +The following table illustrates the link types above, along with their +options: + +| Link Type | Example | +|------------+----------------------------------------------------------| +| http | =http://staff.science.uva.nl/c.dominik/= | +| https | =https://orgmode.org/= | +| doi | =doi:10.1000/182= | +| file | =file:/home/dominik/images/jupiter.jpg= | +| | =/home/dominik/images/jupiter.jpg= (same as above) | +| | =file:papers/last.pdf= | +| | =./papers/last.pdf= (same as above) | +| | =file:/ssh:me@some.where:papers/last.pdf= (remote) | +| | =/ssh:me@some.where:papers/last.pdf= (same as above) | +| | =file:sometextfile::NNN= (jump to line number) | +| | =file:projects.org= | +| | =file:projects.org::some words= (text search)[fn:27] | +| | =file:projects.org::*task title= (headline search) | +| | =file:projects.org::#custom-id= (headline search) | +| attachment | =attachment:projects.org= | +| | =attachment:projects.org::some words= (text search) | +| docview | =docview:papers/last.pdf::NNN= | +| id | =id:B7423F4D-2E8A-471B-8810-C40F074717E9= | +| news | =news:comp.emacs= | +| mailto | =mailto:adent@galaxy.net= | +| mhe | =mhe:folder= (folder link) | +| | =mhe:folder#id= (message link) | +| rmail | =rmail:folder= (folder link) | +| | =rmail:folder#id= (message link) | +| gnus | =gnus:group= (group link) | +| | =gnus:group#id= (article link) | +| bbdb | =bbdb:R.*Stallman= (record with regexp) | +| irc | =irc:/irc.com/#emacs/bob= | +| help | =help:org-store-link= | +| info | =info:org#External links= | +| shell | =shell:ls *.org= | +| elisp | =elisp:(find-file "Elisp.org")= (Elisp form to evaluate) | +| | =elisp:org-agenda= (interactive Elisp command) | + +#+cindex: VM links +#+cindex: Wanderlust links +On top of these built-in link types, additional ones are available +through the =contrib/= directory (see [[*Installation]]). For example, +these links to VM or Wanderlust messages are available when you load +the corresponding libraries from the =contrib/= directory: + +| =vm:folder= | VM folder link | +| =vm:folder#id= | VM message link | +| =vm://myself@some.where.org/folder#id= | VM on remote machine | +| =vm-imap:account:folder= | VM IMAP folder link | +| =vm-imap:account:folder#id= | VM IMAP message link | +| =wl:folder= | Wanderlust folder link | +| =wl:folder#id= | Wanderlust message link | + +For information on customizing Org to add new link types, see [[*Adding +Hyperlink Types]]. + +A link should be enclosed in double brackets and may contain +descriptive text to be displayed instead of the URL (see [[*Link +Format]]), for example: + +: [[https://www.gnu.org/software/emacs/][GNU Emacs]] + +If the description is a file name or URL that points to an image, HTML +export (see [[*HTML Export]]) inlines the image as a clickable button. If +there is no description at all and the link points to an image, that +image is inlined into the exported HTML file. + +#+cindex: square brackets, around links +#+cindex: angular brackets, around links +#+cindex: plain text external links +Org also recognizes external links amid normal text and activates them +as links. If spaces must be part of the link (for example in +=bbdb:R.*Stallman=), or if you need to remove ambiguities about the +end of the link, enclose the link in square or angular brackets. + +** Handling Links +:PROPERTIES: +:DESCRIPTION: Creating, inserting and following. +:END: +#+cindex: links, handling + +Org provides methods to create a link in the correct syntax, to insert +it into an Org file, and to follow the link. + +#+findex: org-store-link +#+cindex: storing links +The main function is ~org-store-link~, called with {{{kbd(M-x +org-store-link)}}}. Because of its importance, we suggest to bind it +to a widely available key (see [[*Activation]]). It stores a link to the +current location. The link is stored for later insertion into an Org +buffer---see below. The kind of link that is created depends on the +current buffer: + +- /Org mode buffers/ :: + + For Org files, if there is a =<<target>>= at point, the link points + to the target. Otherwise it points to the current headline, which + is also the description[fn:28]. + + #+vindex: org-id-link-to-org-use-id + #+cindex: @samp{CUSTOM_ID}, property + #+cindex: @samp{ID}, property + If the headline has a =CUSTOM_ID= property, store a link to this + custom ID. In addition or alternatively, depending on the value of + ~org-id-link-to-org-use-id~, create and/or use a globally unique + =ID= property for the link[fn:29]. So using this command in Org + buffers potentially creates two links: a human-readable link from + the custom ID, and one that is globally unique and works even if the + entry is moved from file to file. Later, when inserting the link, + you need to decide which one to use. + +- /Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus/ :: + + #+vindex: org-link-email-description-format + Pretty much all Emacs mail clients are supported. The link points + to the current article, or, in some Gnus buffers, to the group. The + description is constructed according to the variable + ~org-link-email-description-format~. By default, it refers to the + addressee and the subject. + +- /Web browsers: W3, W3M and EWW/ :: + + Here the link is the current URL, with the page title as the + description. + +- /Contacts: BBDB/ :: + + Links created in a BBDB buffer point to the current entry. + +- /Chat: IRC/ :: + + #+vindex: org-irc-links-to-logs + For IRC links, if the variable ~org-irc-link-to-logs~ is non-~nil~, + create a =file= style link to the relevant point in the logs for the + current conversation. Otherwise store an =irc= style link to the + user/channel/server under the point. + +- /Other files/ :: + + For any other file, the link points to the file, with a search + string (see [[*Search Options in File Links]]) pointing to the contents + of the current line. If there is an active region, the selected + words form the basis of the search string. You can write custom Lisp + functions to select the search string and perform the search for + particular file types (see [[*Custom Searches]]). + + You can also define dedicated links to other files. See [[*Adding + Hyperlink Types]]. + +- /Agenda view/ :: + + When point is in an agenda view, the created link points to the + entry referenced by the current line. + +From an Org buffer, the following commands create, navigate or, more +generally, act on links. + +#+attr_texinfo: :sep , +- {{{kbd(C-c C-l)}}} (~org-insert-link~) :: + + #+kindex: C-c C-l + #+findex: org-insert-link + #+cindex: link completion + #+cindex: completion, of links + #+cindex: inserting links + #+vindex: org-link-keep-stored-after-insertion + Insert a link[fn:30]. This prompts for a link to be inserted into + the buffer. You can just type a link, using text for an internal + link, or one of the link type prefixes mentioned in the examples + above. The link is inserted into the buffer, along with + a descriptive text[fn:31]. If some text was selected at this time, + it becomes the default description. + + - /Inserting stored links/ :: + + All links stored during the current session are part of the + history for this prompt, so you can access them with {{{kbd(UP)}}} + and {{{kbd(DOWN)}}} (or {{{kbd(M-p)}}}, {{{kbd(M-n)}}}). + + - /Completion support/ :: + + Completion with {{{kbd(TAB)}}} helps you to insert valid link + prefixes like =http= or =ftp=, including the prefixes defined + through link abbreviations (see [[*Link Abbreviations]]). If you + press {{{kbd(RET)}}} after inserting only the prefix, Org offers + specific completion support for some link types[fn:32]. For + example, if you type {{{kbd(f i l e RET)}}}---alternative access: + {{{kbd(C-u C-c C-l)}}}, see below---Org offers file name + completion, and after {{{kbd(b b d b RET)}}} you can complete + contact names. + +- {{{kbd(C-u C-c C-l)}}} :: + + #+cindex: file name completion + #+cindex: completion, of file names + #+kindex: C-u C-c C-l + When {{{kbd(C-c C-l)}}} is called with a {{{kbd(C-u)}}} prefix + argument, insert a link to a file. You may use file name completion + to select the name of the file. The path to the file is inserted + relative to the directory of the current Org file, if the linked + file is in the current directory or in a sub-directory of it, or if + the path is written relative to the current directory using =../=. + Otherwise an absolute path is used, if possible with =~/= for your + home directory. You can force an absolute path with two + {{{kbd(C-u)}}} prefixes. + +- {{{kbd(C-c C-l)}}} (with point on existing link) :: + + #+cindex: following links + When point is on an existing link, {{{kbd(C-c C-l)}}} allows you to + edit the link and description parts of the link. + +- {{{kbd(C-c C-o)}}} (~org-open-at-point~) :: + + #+kindex: C-c C-o + #+findex: org-open-at-point + #+vindex: org-file-apps + Open link at point. This launches a web browser for URL (using + ~browse-url-at-point~), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for + the corresponding links, and execute the command in a shell link. + When point is on an internal link, this command runs the + corresponding search. When point is on the tags part of a headline, + it creates the corresponding tags view (see [[*Matching tags and + properties]]). If point is on a timestamp, it compiles the agenda for + that date. Furthermore, it visits text and remote files in =file= + links with Emacs and select a suitable application for local + non-text files. Classification of files is based on file extension + only. See option ~org-file-apps~. If you want to override the + default application and visit the file with Emacs, use + a {{{kbd(C-u)}}} prefix. If you want to avoid opening in Emacs, use + a {{{kbd(C-u C-u)}}} prefix. + + #+vindex: org-link-frame-setup + If point is on a headline, but not on a link, offer all links in the + headline and entry text. If you want to setup the frame + configuration for following links, customize ~org-link-frame-setup~. + +- {{{kbd(RET)}}} :: + + #+vindex: org-return-follows-link + #+kindex: RET + When ~org-return-follows-link~ is set, {{{kbd(RET)}}} also follows + the link at point. + +- {{{kbd(mouse-2)}}} or {{{kbd(mouse-1)}}} :: + + #+kindex: mouse-2 + #+kindex: mouse-1 + On links, {{{kbd(mouse-1)}}} and {{{kbd(mouse-2)}}} opens the link + just as {{{kbd(C-c C-o)}}} does. + +- {{{kbd(mouse-3)}}} :: + + #+vindex: org-link-use-indirect-buffer-for-internals + #+kindex: mouse-3 + Like {{{kbd(mouse-2)}}}, but force file links to be opened with + Emacs, and internal links to be displayed in another window[fn:33]. + +- {{{kbd(C-c %)}}} (~org-mark-ring-push~) :: + + #+kindex: C-c % + #+findex: org-mark-ring-push + #+cindex: mark ring + Push the current position onto the Org mark ring, to be able to + return easily. Commands following an internal link do this + automatically. + +- {{{kbd(C-c &)}}} (~org-mark-ring-goto~) :: + + #+kindex: C-c & + #+findex: org-mark-ring-goto + #+cindex: links, returning to + Jump back to a recorded position. A position is recorded by the + commands following internal links, and by {{{kbd(C-c %)}}}. Using + this command several times in direct succession moves through a ring + of previously recorded positions. + +- {{{kbd(C-c C-x C-n)}}} (~org-next-link~), {{{kbd(C-c C-x C-p)}}} (~org-previous-link~) :: + + #+kindex: C-c C-x C-p + #+findex: org-previous-link + #+kindex: C-c C-x C-n + #+findex: org-next-link + #+cindex: links, finding next/previous + Move forward/backward to the next link in the buffer. At the limit + of the buffer, the search fails once, and then wraps around. The + key bindings for this are really too long; you might want to bind + this also to {{{kbd(M-n)}}} and {{{kbd(M-p)}}}. + + #+begin_src emacs-lisp + (with-eval-after-load 'org + (define-key org-mode-map (kbd "M-n") 'org-next-link) + (define-key org-mode-map (kbd "M-p") 'org-previous-link)) + #+end_src + +** Using Links Outside Org +:PROPERTIES: +:DESCRIPTION: Linking from my C source code? +:END: + +#+findex: org-insert-link-global +#+findex: org-open-at-point-global +You can insert and follow links that have Org syntax not only in Org, +but in any Emacs buffer. For this, Org provides two functions: +~org-insert-link-global~ and ~org-open-at-point-global~. + +You might want to bind them to globally available keys. See +[[*Activation]] for some advice. + +** Link Abbreviations +:PROPERTIES: +:DESCRIPTION: Shortcuts for writing complex links. +:END: +#+cindex: link abbreviations +#+cindex: abbreviation, links + +Long URL can be cumbersome to type, and often many similar links are +needed in a document. For this you can use link abbreviations. An +abbreviated link looks like this + +: [[linkword:tag][description]] + +#+texinfo: @noindent +#+vindex: org-link-abbrev-alist +where the tag is optional. The /linkword/ must be a word, starting +with a letter, followed by letters, numbers, =-=, and =_=. +Abbreviations are resolved according to the information in the +variable ~org-link-abbrev-alist~ that relates the linkwords to +replacement text. Here is an example: + +#+begin_src emacs-lisp +(setq org-link-abbrev-alist + '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") + ("Nu Html Checker" . "https://validator.w3.org/nu/?doc=%h") + ("duckduckgo" . "https://duckduckgo.com/?q=%s") + ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1") + ("ads" . "https://ui.adsabs.harvard.edu/search/q=%20author%3A\"%s\""))) +#+end_src + +If the replacement text contains the string =%s=, it is replaced with +the tag. Using =%h= instead of =%s= percent-encodes the tag (see the +example above, where we need to encode the URL parameter). Using +=%(my-function)= passes the tag to a custom Lisp function, and replace +it by the resulting string. + +If the replacement text do not contain any specifier, it is simply +appended to the string in order to create the link. + +Instead of a string, you may also specify a Lisp function to create +the link. Such a function will be called with the tag as the only +argument. + +With the above setting, you could link to a specific bug with +=[[bugzilla:129]]=, search the web for =OrgMode= with =[[duckduckgo:OrgMode]]=, +show the map location of the Free Software Foundation =[[gmap:51 +Franklin Street, Boston]]= or of Carsten office =[[omap:Science Park 904, +Amsterdam, The Netherlands]]= and find out what the Org author is doing +besides Emacs hacking with =[[ads:Dominik,C]]=. + +If you need special abbreviations just for a single Org buffer, you +can define them in the file with + +#+cindex: @samp{LINK}, keyword +#+begin_example +,#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= +,#+LINK: duckduckgo https://duckduckgo.com/?q=%s +#+end_example + +In-buffer completion (see [[*Completion]]) can be used after =[= to +complete link abbreviations. You may also define a Lisp function that +implements special (e.g., completion) support for inserting such a +link with {{{kbd(C-c C-l)}}}. Such a function should not accept any +arguments, and should return the full link with a prefix. You can set +the link completion function like this: + +#+begin_src emacs-lisp +(org-link-set-parameter "type" :complete #'some-completion-function) +#+end_src + +** Search Options in File Links +:PROPERTIES: +:DESCRIPTION: Linking to a specific location. +:ALT_TITLE: Search Options +:END: +#+cindex: search option in file links +#+cindex: file links, searching +#+cindex: attachment links, searching + +File links can contain additional information to make Emacs jump to a +particular location in the file when following a link. This can be a +line number or a search option after a double colon[fn:34]. For +example, when the command ~org-store-link~ creates a link (see +[[*Handling Links]]) to a file, it encodes the words in the current line +as a search string that can be used to find this line back later when +following the link with {{{kbd(C-c C-o)}}}. + +Note that all search options apply for Attachment links in the same +way that they apply for File links. + +Here is the syntax of the different ways to attach a search to a file +link, together with explanations for each: + +#+begin_example +[[file:~/code/main.c::255]] +[[file:~/xx.org::My Target]] +[[file:~/xx.org::*My Target]] +[[file:~/xx.org::#my-custom-id]] +[[file:~/xx.org::/regexp/]] +[[attachment:main.c::255]] +#+end_example + +- =255= :: + + Jump to line 255. + +- =My Target= :: + + Search for a link target =<<My Target>>=, or do a text search for + =my target=, similar to the search in internal links, see [[*Internal + Links]]. In HTML export (see [[*HTML Export]]), such a file link becomes + a HTML reference to the corresponding named anchor in the linked + file. + +- =*My Target= :: + + In an Org file, restrict search to headlines. + +- =#my-custom-id= :: + + Link to a heading with a =CUSTOM_ID= property + +- =/REGEXP/= :: + + Do a regular expression search for {{{var(REGEXP)}}}. This uses the + Emacs command ~occur~ to list all matches in a separate window. If + the target file is in Org mode, ~org-occur~ is used to create + a sparse tree with the matches. + +As a degenerate case, a file link with an empty file name can be used +to search the current file. For example, =[[file:::find me]]= does +a search for =find me= in the current file, just as =[[find me]]= +would. + +** Custom Searches +:PROPERTIES: +:DESCRIPTION: When the default search is not enough. +:END: +#+cindex: custom search strings +#+cindex: search strings, custom + +The default mechanism for creating search strings and for doing the +actual search related to a file link may not work correctly in all +cases. For example, BibTeX database files have many entries like +~year="1993"~ which would not result in good search strings, because +the only unique identification for a BibTeX entry is the citation key. + +#+vindex: org-create-file-search-functions +#+vindex: org-execute-file-search-functions +If you come across such a problem, you can write custom functions to +set the right search string for a particular file type, and to do the +search for the string in the file. Using ~add-hook~, these functions +need to be added to the hook variables +~org-create-file-search-functions~ and +~org-execute-file-search-functions~. See the docstring for these +variables for more information. Org actually uses this mechanism for +BibTeX database files, and you can use the corresponding code as an +implementation example. See the file =ol-bibtex.el=. + +* TODO Items +:PROPERTIES: +:DESCRIPTION: Every tree branch can be a TODO item. +:END: +#+cindex: TODO items + +Org mode does not maintain TODO lists as separate documents[fn:35]. +Instead, TODO items are an integral part of the notes file, because +TODO items usually come up while taking notes! With Org mode, simply +mark any entry in a tree as being a TODO item. In this way, +information is not duplicated, and the entire context from which the +TODO item emerged is always present. + +Of course, this technique for managing TODO items scatters them +throughout your notes file. Org mode compensates for this by +providing methods to give you an overview of all the things that you +have to do. + +** Basic TODO Functionality +:PROPERTIES: +:DESCRIPTION: Marking and displaying TODO entries. +:ALT_TITLE: TODO Basics +:END: + +Any headline becomes a TODO item when it starts with the word =TODO=, +for example: + +: *** TODO Write letter to Sam Fortune + +The most important commands to work with TODO entries are: + +- {{{kbd(C-c C-t)}}} (~org-todo~) :: + + #+kindex: C-c C-t + #+cindex: cycling, of TODO states + Rotate the TODO state of the current item among + + #+begin_example + ,-> (unmarked) -> TODO -> DONE --. + '--------------------------------' + #+end_example + + If TODO keywords have fast access keys (see [[*Fast access to TODO + states]]), prompt for a TODO keyword through the fast selection + interface; this is the default behavior when + ~org-use-fast-todo-selection~ is non-~nil~. + + The same state changing can also be done "remotely" from the agenda + buffer with the {{{kbd(t)}}} command key (see [[*Commands in the + Agenda Buffer]]). + +- {{{kbd(S-RIGHT)}}} {{{kbd(S-LEFT)}}} :: + + #+kindex: S-RIGHT + #+kindex: S-LEFT + #+vindex: org-treat-S-cursor-todo-selection-as-state-change + Select the following/preceding TODO state, similar to cycling. + Useful mostly if more than two TODO states are possible (see + [[*Extended Use of TODO Keywords]]). See also [[*Packages that conflict + with Org mode]], for a discussion of the interaction with + shift-selection. See also the variable + ~org-treat-S-cursor-todo-selection-as-state-change~. + +- {{{kbd(C-c / t)}}} (~org-show-todo-tree~) :: + + #+kindex: C-c / t + #+cindex: sparse tree, for TODO + #+vindex: org-todo-keywords + #+findex: org-show-todo-tree + View TODO items in a /sparse tree/ (see [[*Sparse Trees]]). Folds the + entire buffer, but shows all TODO items---with not-DONE state---and + the headings hierarchy above them. With a prefix argument, or by + using {{{kbd(C-c / T)}}}, search for a specific TODO. You are + prompted for the keyword, and you can also give a list of keywords + like =KWD1|KWD2|...= to list entries that match any one of these + keywords. With a numeric prefix argument N, show the tree for the + Nth keyword in the variable ~org-todo-keywords~. With two prefix + arguments, find all TODO states, both un-done and done. + +- {{{kbd(M-x org-agenda t)}}} (~org-todo-list~) :: + + #+kindex: t @r{(Agenda dispatcher)} + Show the global TODO list. Collects the TODO items (with not-DONE + states) from all agenda files (see [[*Agenda Views]]) into a single + buffer. The new buffer is in Org Agenda mode, which provides + commands to examine and manipulate the TODO entries from the new + buffer (see [[*Commands in the Agenda Buffer]]). See [[*The global TODO + list]], for more information. + +- {{{kbd(S-M-RET)}}} (~org-insert-todo-heading~) :: + + #+kindex: S-M-RET + #+findex: org-insert-todo-heading + Insert a new TODO entry below the current one. + +#+vindex: org-todo-state-tags-triggers +Changing a TODO state can also trigger tag changes. See the docstring +of the option ~org-todo-state-tags-triggers~ for details. + +** Extended Use of TODO Keywords +:PROPERTIES: +:DESCRIPTION: Workflow and assignments. +:ALT_TITLE: TODO Extensions +:END: +#+cindex: extended TODO keywords + +#+vindex: org-todo-keywords +By default, marked TODO entries have one of only two states: TODO and +DONE. Org mode allows you to classify TODO items in more complex ways +with /TODO keywords/ (stored in ~org-todo-keywords~). With special +setup, the TODO keyword system can work differently in different +files. + +Note that /tags/ are another way to classify headlines in general and +TODO items in particular (see [[*Tags]]). + +*** TODO keywords as workflow states +:PROPERTIES: +:DESCRIPTION: From TODO to DONE in steps. +:ALT_TITLE: Workflow states +:END: +#+cindex: TODO workflow +#+cindex: workflow states as TODO keywords + +You can use TODO keywords to indicate different, possibly /sequential/ +states in the process of working on an item, for example[fn:36]: + +#+begin_src emacs-lisp +(setq org-todo-keywords + '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) +#+end_src + +The vertical bar separates the TODO keywords (states that /need +action/) from the DONE states (which need /no further action/). If +you do not provide the separator bar, the last state is used as the +DONE state. + +#+cindex: completion, of TODO keywords +With this setup, the command {{{kbd(C-c C-t)}}} cycles an entry from +=TODO= to =FEEDBACK=, then to =VERIFY=, and finally to =DONE= and +=DELEGATED=. You may also use a numeric prefix argument to quickly +select a specific state. For example {{{kbd(C-3 C-c C-t)}}} changes +the state immediately to =VERIFY=. Or you can use {{{kbd(S-RIGHT)}}} +and {{{kbd(S-LEFT)}}} to go forward and backward through the states. +If you define many keywords, you can use in-buffer completion (see +[[*Completion]]) or a special one-key selection scheme (see [[*Fast +access to TODO states]]) to insert these words into the buffer. +Changing a TODO state can be logged with a timestamp, see [[*Tracking +TODO state changes]], for more information. + +*** TODO keywords as types +:PROPERTIES: +:DESCRIPTION: I do this, Fred does the rest. +:ALT_TITLE: TODO types +:END: +#+cindex: TODO types +#+cindex: names as TODO keywords +#+cindex: types as TODO keywords + +The second possibility is to use TODO keywords to indicate different +/types/ of action items. For example, you might want to indicate that +items are for "work" or "home". Or, when you work with several people +on a single project, you might want to assign action items directly to +persons, by using their names as TODO keywords. This type of +functionality is actually much better served by using tags (see +[[*Tags]]), so the TODO implementation is kept just for backward +compatibility. + +Using TODO types, it would be set up like this: + +#+begin_src emacs-lisp +(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) +#+end_src + +In this case, different keywords do not indicate states, but +rather different types. So the normal work flow would be to assign +a task to a person, and later to mark it DONE. Org mode supports this +style by adapting the workings of the command {{{kbd(C-c +C-t)}}}[fn:37]. When used several times in succession, it still +cycles through all names, in order to first select the right type for +a task. But when you return to the item after some time and execute +{{{kbd(C-c C-t)}}} again, it will switch from any name directly to +=DONE=. Use prefix arguments or completion to quickly select +a specific name. You can also review the items of a specific TODO +type in a sparse tree by using a numeric prefix to {{{kbd(C-c / t)}}}. +For example, to see all things Lucy has to do, you would use +{{{kbd(C-3 C-c / t)}}}. To collect Lucy's items from all agenda files +into a single buffer, you would use the numeric prefix argument as +well when creating the global TODO list: {{{kbd(C-3 M-x org-agenda +t)}}}. + +*** Multiple keyword sets in one file +:PROPERTIES: +:DESCRIPTION: Mixing it all, still finding your way. +:ALT_TITLE: Multiple sets in one file +:END: +#+cindex: TODO keyword sets + +Sometimes you may want to use different sets of TODO keywords in +parallel. For example, you may want to have the basic TODO/DONE, but +also a workflow for bug fixing, and a separate state indicating that +an item has been canceled---so it is not DONE, but also does not +require action. Your setup would then look like this: + +#+begin_src emacs-lisp +(setq org-todo-keywords + '((sequence "TODO" "|" "DONE") + (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") + (sequence "|" "CANCELED"))) +#+end_src + +The keywords should all be different, this helps Org mode keep track +of which subsequence should be used for a given entry. In this setup, +{{{kbd(C-c C-t)}}} only operates within a sub-sequence, so it switches +from =DONE= to (nothing) to =TODO=, and from =FIXED= to (nothing) to +=REPORT=. Therefore you need a mechanism to initially select the +correct sequence. In addition to typing a keyword or using completion +(see [[*Completion]]), you may also apply the following commands: + +#+attr_texinfo: :sep , +- {{{kbd(C-u C-u C-c C-t)}}}, {{{kbd(C-S-RIGHT)}}}, {{{kbd(C-S-LEFT)}}} :: + + #+kindex: C-S-RIGHT + #+kindex: C-S-LEFT + #+kindex: C-u C-u C-c C-t + These keys jump from one TODO sub-sequence to the next. In the + above example, {{{kbd(C-u C-u C-c C-t)}}} or {{{kbd(C-S-RIGHT)}}} + would jump from =TODO= or =DONE= to =REPORT=, and any of the words + in the second row to =CANCELED=. Note that the {{{kbd(C-S-)}}} key + binding conflict with shift-selection (see [[*Packages that conflict + with Org mode]]). + +- {{{kbd(S-RIGHT)}}}, {{{kbd(S-LEFT)}}} :: + + #+kindex: S-RIGHT + #+kindex: S-LEFT + {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}} walk through /all/ keywords + from all sub-sequences, so for example {{{kbd(S-RIGHT)}}} would + switch from =DONE= to =REPORT= in the example above. For + a discussion of the interaction with shift-selection, see [[*Packages + that conflict with Org mode]]. + +*** Fast access to TODO states +:PROPERTIES: +:DESCRIPTION: Single letter selection of state. +:END: + +If you would like to quickly change an entry to an arbitrary TODO +state instead of cycling through the states, you can set up keys for +single-letter access to the states. This is done by adding the +selection character after each keyword, in parentheses[fn:38]. For +example: + +#+begin_src emacs-lisp +(setq org-todo-keywords + '((sequence "TODO(t)" "|" "DONE(d)") + (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") + (sequence "|" "CANCELED(c)"))) +#+end_src + +#+vindex: org-fast-tag-selection-include-todo +If you then press {{{kbd(C-c C-t)}}} followed by the selection key, +the entry is switched to this state. {{{kbd(SPC)}}} can be used to +remove any TODO keyword from an entry[fn:39]. + +*** Setting up keywords for individual files +:PROPERTIES: +:DESCRIPTION: Different files, different requirements. +:ALT_TITLE: Per-file keywords +:END: +#+cindex: keyword options +#+cindex: per-file keywords +#+cindex: @samp{TODO}, keyword +#+cindex: @samp{TYP_TODO}, keyword +#+cindex: @samp{SEQ_TODO}, keyword + +It can be very useful to use different aspects of the TODO mechanism +in different files. For file-local settings, you need to add special +lines to the file which set the keywords and interpretation for that +file only. For example, to set one of the two examples discussed +above, you need one of the following lines, starting in column zero +anywhere in the file: + +: #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED + +You may also write =#+SEQ_TODO= to be explicit about the +interpretation, but it means the same as =#+TODO=, or + +: #+TYP_TODO: Fred Sara Lucy Mike | DONE + +A setup for using several sets in parallel would be: + +#+begin_example +,#+TODO: TODO | DONE +,#+TODO: REPORT BUG KNOWNCAUSE | FIXED +,#+TODO: | CANCELED +#+end_example + +#+cindex: completion, of option keywords +#+kindex: M-TAB +To make sure you are using the correct keyword, type =#+= into the +buffer and then use {{{kbd(M-TAB)}}} to complete it (see [[*Completion]]). + +#+cindex: DONE, final TODO keyword +Remember that the keywords after the vertical bar---or the last +keyword if no bar is there---must always mean that the item is DONE, +although you may use a different word. After changing one of these +lines, use {{{kbd(C-c C-c)}}} with point still in the line to make the +changes known to Org mode[fn:40]. + +*** Faces for TODO keywords +:PROPERTIES: +:DESCRIPTION: Highlighting states. +:END: +#+cindex: faces, for TODO keywords + +#+vindex: org-todo, face +#+vindex: org-done, face +#+vindex: org-todo-keyword-faces +Org mode highlights TODO keywords with special faces: ~org-todo~ for +keywords indicating that an item still has to be acted upon, and +~org-done~ for keywords indicating that an item is finished. If you +are using more than two different states, you might want to use +special faces for some of them. This can be done using the variable +~org-todo-keyword-faces~. For example: + +#+begin_src emacs-lisp +(setq org-todo-keyword-faces + '(("TODO" . org-warning) ("STARTED" . "yellow") + ("CANCELED" . (:foreground "blue" :weight bold)))) +#+end_src + +#+vindex: org-faces-easy-properties +While using a list with face properties as shown for =CANCELED= +/should/ work, this does not always seem to be the case. If +necessary, define a special face and use that. A string is +interpreted as a color. The variable ~org-faces-easy-properties~ +determines if that color is interpreted as a foreground or +a background color. + +*** TODO dependencies +:PROPERTIES: +:DESCRIPTION: When one task needs to wait for others. +:END: +#+cindex: TODO dependencies +#+cindex: dependencies, of TODO states + +#+vindex: org-enforce-todo-dependencies +#+cindex: @samp{ORDERED}, property +The structure of Org files---hierarchy and lists---makes it easy to +define TODO dependencies. Usually, a parent TODO task should not be +marked as done until all TODO subtasks, or children tasks, are marked +as done. Sometimes there is a logical sequence to (sub)tasks, so that +one subtask cannot be acted upon before all siblings above it have +been marked as done. If you customize the variable +~org-enforce-todo-dependencies~, Org blocks entries from changing +state to DONE while they have TODO children that are not DONE. +Furthermore, if an entry has a property =ORDERED=, each of its TODO +children is blocked until all earlier siblings are marked as done. +Here is an example: + +#+begin_example +,* TODO Blocked until (two) is done +,** DONE one +,** TODO two + +,* Parent +:PROPERTIES: +:ORDERED: t +:END: +,** TODO a +,** TODO b, needs to wait for (a) +,** TODO c, needs to wait for (a) and (b) +#+end_example + +#+cindex: TODO dependencies, @samp{NOBLOCKING} +#+cindex: @samp{NOBLOCKING}, property +You can ensure an entry is never blocked by using the =NOBLOCKING= +property (see [[*Properties and Columns]]): + +#+begin_example +,* This entry is never blocked +:PROPERTIES: +:NOBLOCKING: t +:END: +#+end_example + +- {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) :: + + #+kindex: C-c C-x o + #+findex: org-toggle-ordered-property + #+vindex: org-track-ordered-property-with-tag + Toggle the =ORDERED= property of the current entry. A property is + used for this behavior because this should be local to the current + entry, not inherited from entries above like a tag (see [[*Tags]]). + However, if you would like to /track/ the value of this property + with a tag for better visibility, customize the variable + ~org-track-ordered-property-with-tag~. + +- {{{kbd(C-u C-u C-u C-c C-t)}}} :: + + #+kindex: C-u C-u C-u C-u C-c C-t + Change TODO state, regardless of any state blocking. + +#+vindex: org-agenda-dim-blocked-tasks +If you set the variable ~org-agenda-dim-blocked-tasks~, TODO entries +that cannot be marked as done because of unmarked children are shown +in a dimmed font or even made invisible in agenda views (see [[*Agenda +Views]]). + +#+cindex: checkboxes and TODO dependencies +#+vindex: org-enforce-todo-dependencies +You can also block changes of TODO states by using checkboxes (see +[[*Checkboxes]]). If you set the variable +~org-enforce-todo-checkbox-dependencies~, an entry that has unchecked +checkboxes is blocked from switching to DONE. + +If you need more complex dependency structures, for example +dependencies between entries in different trees or files, check out +the contributed module =org-depend.el=. + +** Progress Logging +:PROPERTIES: +:DESCRIPTION: Dates and notes for progress. +:END: +#+cindex: progress logging +#+cindex: logging, of progress + +To record a timestamp and a note when changing a TODO state, call the +command ~org-todo~ with a prefix argument. + +- {{{kbd(C-u C-c C-t)}}} (~org-todo~) :: + + #+kindex: C-u C-c C-t + Prompt for a note and record a the time of the TODO state change. + The note is inserted as a list item below the headline, but can also + be placed into a drawer, see [[*Tracking TODO state changes]]. + +If you want to be more systematic, Org mode can automatically record a +timestamp and optionally a note when you mark a TODO item as DONE, or +even each time you change the state of a TODO item. This system is +highly configurable, settings can be on a per-keyword basis and can be +localized to a file or even a subtree. For information on how to +clock working time for a task, see [[*Clocking Work Time]]. + +*** Closing items +:PROPERTIES: +:DESCRIPTION: When was this entry marked as done? +:END: + +The most basic automatic logging is to keep track of /when/ a certain +TODO item was marked as done. This can be achieved with[fn:41] + +#+begin_src emacs-lisp +(setq org-log-done 'time) +#+end_src + +#+vindex: org-closed-keep-when-no-todo +#+texinfo: @noindent +Then each time you turn an entry from a TODO (not-done) state into any +of the DONE states, a line =CLOSED: [timestamp]= is inserted just +after the headline. If you turn the entry back into a TODO item +through further state cycling, that line is removed again. If you +turn the entry back to a non-TODO state (by pressing {{{kbd(C-c C-t +SPC)}}} for example), that line is also removed, unless you set +~org-closed-keep-when-no-todo~ to non-~nil~. If you want to record +a note along with the timestamp, use[fn:42] + +#+begin_src emacs-lisp +(setq org-log-done 'note) +#+end_src + +#+texinfo: @noindent +You are then prompted for a note, and that note is stored below the +entry with a =Closing Note= heading. + +*** Tracking TODO state changes +:PROPERTIES: +:DESCRIPTION: When did the status change? +:END: +#+cindex: drawer, for state change recording + +#+vindex: org-log-states-order-reversed +#+vindex: org-log-into-drawer +#+cindex: @samp{LOG_INTO_DRAWER}, property +You might want to automatically keep track of when a state change +occurred and maybe take a note about this change. You can either +record just a timestamp, or a time-stamped note. These records are +inserted after the headline as an itemized list, newest first[fn:43]. +When taking a lot of notes, you might want to get the notes out of the +way into a drawer (see [[*Drawers]]). Customize the variable +~org-log-into-drawer~ to get this behavior---the recommended drawer +for this is called =LOGBOOK=[fn:44]. You can also overrule the +setting of this variable for a subtree by setting a =LOG_INTO_DRAWER= +property. + +Since it is normally too much to record a note for every state, Org +mode expects configuration on a per-keyword basis for this. This is +achieved by adding special markers =!= (for a timestamp) or =@= (for +a note with timestamp) in parentheses after each keyword. For +example, with the setting + +#+begin_src emacs-lisp +(setq org-todo-keywords + '((sequence "TODO(t)" "WAIT(w@/!)" "|" "DONE(d!)" "CANCELED(c@)"))) +#+end_src + +#+texinfo: @noindent +To record a timestamp without a note for TODO keywords configured with +=@=, just type {{{kbd(C-c C-c)}}} to enter a blank note when prompted. + +#+vindex: org-log-done +You not only define global TODO keywords and fast access keys, but +also request that a time is recorded when the entry is set to =DONE=, +and that a note is recorded when switching to =WAIT= or +=CANCELED=[fn:45]. The setting for =WAIT= is even more special: the +=!= after the slash means that in addition to the note taken when +entering the state, a timestamp should be recorded when /leaving/ the +=WAIT= state, if and only if the /target/ state does not configure +logging for entering it. So it has no effect when switching from +=WAIT= to =DONE=, because =DONE= is configured to record a timestamp +only. But when switching from =WAIT= back to =TODO=, the =/!= in the +=WAIT= setting now triggers a timestamp even though =TODO= has no +logging configured. + +You can use the exact same syntax for setting logging preferences local +to a buffer: + +: #+TODO: TODO(t) WAIT(w@/!) | DONE(d!) CANCELED(c@) + +#+cindex: @samp{LOGGING}, property +In order to define logging settings that are local to a subtree or +a single item, define a =LOGGING= property in this entry. Any +non-empty =LOGGING= property resets all logging settings to ~nil~. +You may then turn on logging for this specific tree using =STARTUP= +keywords like =lognotedone= or =logrepeat=, as well as adding state +specific settings like =TODO(!)=. For example: + +#+begin_example +,* TODO Log each state with only a time + :PROPERTIES: + :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) + :END: +,* TODO Only log when switching to WAIT, and when repeating + :PROPERTIES: + :LOGGING: WAIT(@) logrepeat + :END: +,* TODO No logging at all + :PROPERTIES: + :LOGGING: nil + :END: +#+end_example + +*** Tracking your habits +:PROPERTIES: +:DESCRIPTION: How consistent have you been? +:END: +#+cindex: habits +#+cindex: @samp{STYLE}, property + +Org has the ability to track the consistency of a special category of +TODO, called "habits." To use habits, you have to enable the ~habits~ +module by customizing the variable ~org-modules~. + +A habit has the following properties: + +1. The habit is a TODO item, with a TODO keyword representing an open + state. + +2. The property =STYLE= is set to the value =habit= (see [[*Properties + and Columns]]). + +3. The TODO has a scheduled date, usually with a =.+= style repeat + interval. A =++= style may be appropriate for habits with time + constraints, e.g., must be done on weekends, or a =+= style for an + unusual habit that can have a backlog, e.g., weekly reports. + +4. The TODO may also have minimum and maximum ranges specified by + using the syntax =.+2d/3d=, which says that you want to do the task + at least every three days, but at most every two days. + +5. State logging for the DONE state is enabled (see [[*Tracking TODO + state changes]]), in order for historical data to be represented in + the consistency graph. If it is not enabled it is not an error, + but the consistency graphs are largely meaningless. + +To give you an idea of what the above rules look like in action, here's an +actual habit with some history: + +#+begin_example +,** TODO Shave + SCHEDULED: <2009-10-17 Sat .+2d/4d> + :PROPERTIES: + :STYLE: habit + :LAST_REPEAT: [2009-10-19 Mon 00:36] + :END: + - State "DONE" from "TODO" [2009-10-15 Thu] + - State "DONE" from "TODO" [2009-10-12 Mon] + - State "DONE" from "TODO" [2009-10-10 Sat] + - State "DONE" from "TODO" [2009-10-04 Sun] + - State "DONE" from "TODO" [2009-10-02 Fri] + - State "DONE" from "TODO" [2009-09-29 Tue] + - State "DONE" from "TODO" [2009-09-25 Fri] + - State "DONE" from "TODO" [2009-09-19 Sat] + - State "DONE" from "TODO" [2009-09-16 Wed] + - State "DONE" from "TODO" [2009-09-12 Sat] +#+end_example + +What this habit says is: I want to shave at most every 2 days---given +by the =SCHEDULED= date and repeat interval---and at least every +4 days. If today is the 15th, then the habit first appears in the +agenda (see [[*Agenda Views]]) on Oct 17, after the minimum of 2 days has +elapsed, and will appear overdue on Oct 19, after four days have +elapsed. + +What's really useful about habits is that they are displayed along +with a consistency graph, to show how consistent you've been at +getting that task done in the past. This graph shows every day that +the task was done over the past three weeks, with colors for each day. +The colors used are: + +- Blue :: If the task was not to be done yet on that day. +- Green :: If the task could have been done on that day. +- Yellow :: If the task was going to be overdue the next day. +- Red :: If the task was overdue on that day. + +In addition to coloring each day, the day is also marked with an +asterisk if the task was actually done that day, and an exclamation +mark to show where the current day falls in the graph. + +There are several configuration variables that can be used to change +the way habits are displayed in the agenda. + +- ~org-habit-graph-column~ :: + + #+vindex: org-habit-graph-column + The buffer column at which the consistency graph should be drawn. + This overwrites any text in that column, so it is a good idea to + keep your habits' titles brief and to the point. + +- ~org-habit-preceding-days~ :: + + #+vindex: org-habit-preceding-days + The amount of history, in days before today, to appear in + consistency graphs. + +- ~org-habit-following-days~ :: + + #+vindex: org-habit-following-days + The number of days after today that appear in consistency graphs. + +- ~org-habit-show-habits-only-for-today~ :: + + #+vindex: org-habit-show-habits-only-for-today + If non-~nil~, only show habits in today's agenda view. The default + value is ~t~. Pressing {{{kbd(C-u K)}}} in the agenda toggles this + variable. + +Lastly, pressing {{{kbd(K)}}} in the agenda buffer causes habits to +temporarily be disabled and do not appear at all. Press {{{kbd(K)}}} +again to bring them back. They are also subject to tag filtering, if +you have habits which should only be done in certain contexts, for +example. + +** Priorities +:PROPERTIES: +:DESCRIPTION: Some things are more important than others. +:END: +#+cindex: priorities +#+cindex: priority cookie + +If you use Org mode extensively, you may end up with enough TODO items +that it starts to make sense to prioritize them. Prioritizing can be +done by placing a /priority cookie/ into the headline of a TODO item +right after the TODO keyword, like this: + +: *** TODO [#A] Write letter to Sam Fortune + +#+vindex: org-priority-faces +By default, Org mode supports three priorities: =A=, =B=, and =C=. +=A= is the highest priority. An entry without a cookie is treated as +equivalent if it had priority =B=. Priorities make a difference only +for sorting in the agenda (see [[*Weekly/daily agenda]]). Outside the +agenda, they have no inherent meaning to Org mode. The cookies are +displayed with the face defined by the variable ~org-priority-faces~, +which can be customized. + +You can also use numeric values for priorities, such as + +: *** TODO [#1] Write letter to Sam Fortune + +When using numeric priorities, you need to set ~org-priority-highest~, +~org-priority-lowest~ and ~org-priority-default~ to integers, which +must all be strictly inferior to 65. + +Priorities can be attached to any outline node; they do not need to be +TODO items. + +#+attr_texinfo: :sep ; +- {{{kbd(C-c \,)}}} (~org-priority~) :: + + #+kindex: C-c , + #+findex: org-priority + Set the priority of the current headline. The command prompts for + a priority character =A=, =B= or =C=. When you press {{{kbd(SPC)}}} + instead, the priority cookie, if one is set, is removed from the + headline. The priorities can also be changed "remotely" from the + agenda buffer with the {{{kbd(\,)}}} command (see [[*Commands in the + Agenda Buffer]]). + +- {{{kbd(S-UP)}}} (~org-priority-up~); {{{kbd(S-DOWN)}}} (~org-priority-down~) :: + + #+kindex: S-UP + #+kindex: S-DOWN + #+findex: org-priority-up + #+findex: org-priority-down + #+vindex: org-priority-start-cycle-with-default + Increase/decrease the priority of the current headline[fn:46]. Note + that these keys are also used to modify timestamps (see [[*Creating + Timestamps]]). See also [[*Packages that conflict with Org mode]], for + a discussion of the interaction with shift-selection. + +#+vindex: org-priority-highest +#+vindex: org-priority-lowest +#+vindex: org-priority-default +You can change the range of allowed priorities by setting the +variables ~org-priority-highest~, ~org-priority-lowest~, and +~org-priority-default~. For an individual buffer, you may set these +values (highest, lowest, default) like this (please make sure that the +highest priority is earlier in the alphabet than the lowest priority): + +#+cindex: @samp{PRIORITIES}, keyword +: #+PRIORITIES: A C B + +Or, using numeric values: + +: #+PRIORITIES: 1 10 5 + +** Breaking Down Tasks into Subtasks +:PROPERTIES: +:DESCRIPTION: Splitting a task into manageable pieces. +:ALT_TITLE: Breaking Down Tasks +:END: +#+cindex: tasks, breaking down +#+cindex: statistics, for TODO items + +#+vindex: org-agenda-todo-list-sublevels +It is often advisable to break down large tasks into smaller, +manageable subtasks. You can do this by creating an outline tree +below a TODO item, with detailed subtasks on the tree[fn:47]. To keep +an overview of the fraction of subtasks that have already been marked +as done, insert either =[/]= or =[%]= anywhere in the headline. These +cookies are updated each time the TODO status of a child changes, or +when pressing {{{kbd(C-c C-c)}}} on the cookie. For example: + +#+begin_example +,* Organize Party [33%] +,** TODO Call people [1/2] +,*** TODO Peter +,*** DONE Sarah +,** TODO Buy food +,** DONE Talk to neighbor +#+end_example + +#+cindex: @samp{COOKIE_DATA}, property +If a heading has both checkboxes and TODO children below it, the +meaning of the statistics cookie become ambiguous. Set the property +=COOKIE_DATA= to either =checkbox= or =todo= to resolve this issue. + +#+vindex: org-hierarchical-todo-statistics +If you would like to have the statistics cookie count any TODO entries +in the subtree (not just direct children), configure the variable +~org-hierarchical-todo-statistics~. To do this for a single subtree, +include the word =recursive= into the value of the =COOKIE_DATA= +property. + +#+begin_example org +,* Parent capturing statistics [2/20] + :PROPERTIES: + :COOKIE_DATA: todo recursive + :END: +#+end_example + +If you would like a TODO entry to automatically change to DONE when +all children are done, you can use the following setup: + +#+begin_src emacs-lisp +(defun org-summary-todo (n-done n-not-done) + "Switch entry to DONE when all subentries are done, to TODO otherwise." + (let (org-log-done org-log-states) ; turn off logging + (org-todo (if (= n-not-done 0) "DONE" "TODO")))) + +(add-hook 'org-after-todo-statistics-hook 'org-summary-todo) +#+end_src + +Another possibility is the use of checkboxes to identify (a hierarchy +of) a large number of subtasks (see [[*Checkboxes]]). + +** Checkboxes +:PROPERTIES: +:DESCRIPTION: Tick-off lists. +:END: +#+cindex: checkboxes + +#+vindex: org-list-automatic-rules +Every item in a plain list[fn:48] (see [[*Plain Lists]]) can be made into +a checkbox by starting it with the string =[ ]=. This feature is +similar to TODO items (see [[*TODO Items]]), but is more lightweight. +Checkboxes are not included into the global TODO list, so they are +often great to split a task into a number of simple steps. Or you can +use them in a shopping list. + +Here is an example of a checkbox list. + +#+begin_example +,* TODO Organize party [2/4] + - [-] call people [1/3] + - [ ] Peter + - [X] Sarah + - [ ] Sam + - [X] order food + - [ ] think about what music to play + - [X] talk to the neighbors +#+end_example + +Checkboxes work hierarchically, so if a checkbox item has children +that are checkboxes, toggling one of the children checkboxes makes the +parent checkbox reflect if none, some, or all of the children are +checked. + +#+cindex: statistics, for checkboxes +#+cindex: checkbox statistics +#+cindex: @samp{COOKIE_DATA}, property +#+vindex: org-hierarchical-checkbox-statistics +The =[2/4]= and =[1/3]= in the first and second line are cookies +indicating how many checkboxes present in this entry have been checked +off, and the total number of checkboxes present. This can give you an +idea on how many checkboxes remain, even without opening a folded +entry. The cookies can be placed into a headline or into (the first +line of) a plain list item. Each cookie covers checkboxes of direct +children structurally below the headline/item on which the cookie +appears[fn:49]. You have to insert the cookie yourself by typing +either =[/]= or =[%]=. With =[/]= you get an =n out of m= result, as +in the examples above. With =[%]= you get information about the +percentage of checkboxes checked (in the above example, this would be +=[50%]= and =[33%]=, respectively). In a headline, a cookie can count +either checkboxes below the heading or TODO states of children, and it +displays whatever was changed last. Set the property =COOKIE_DATA= to +either =checkbox= or =todo= to resolve this issue. + +#+cindex: blocking, of checkboxes +#+cindex: checkbox blocking +#+cindex: @samp{ORDERED}, property +If the current outline node has an =ORDERED= property, checkboxes must +be checked off in sequence, and an error is thrown if you try to check +off a box while there are unchecked boxes above it. + +The following commands work with checkboxes: + +- {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~) :: + + #+kindex: C-c C-c + #+findex: org-toggle-checkbox + Toggle checkbox status or---with prefix argument---checkbox presence + at point. With a single prefix argument, add an empty checkbox or + remove the current one[fn:50]. With a double prefix argument, set + it to =[-]=, which is considered to be an intermediate state. + +- {{{kbd(C-c C-x C-b)}}} (~org-toggle-checkbox~) :: + + #+kindex: C-c C-x C-b + Toggle checkbox status or---with prefix argument---checkbox presence + at point. With double prefix argument, set it to =[-]=, which is + considered to be an intermediate state. + + - If there is an active region, toggle the first checkbox in the + region and set all remaining boxes to the same status as the + first. With a prefix argument, add or remove the checkbox for all + items in the region. + + - If point is in a headline, toggle checkboxes in the region between + this headline and the next---so /not/ the entire subtree. + + - If there is no active region, just toggle the checkbox at point. + +- {{{kbd(C-c C-x C-r)}}} (~org-toggle-radio-button~) :: + + #+kindex: C-c C-x C-r + #+findex: org-toggle-radio-button + #+cindex: radio button, checkbox as + Toggle checkbox status by using the checkbox of the item at point as + a radio button: when the checkbox is turned on, all other checkboxes + on the same level will be turned off. With a universal prefix + argument, toggle the presence of the checkbox. With a double prefix + argument, set it to =[-]=. + + #+findex: org-list-checkbox-radio-mode + {{{kbd(C-c C-c)}}} can be told to consider checkboxes as radio buttons by + setting =#+ATTR_ORG: :radio t= right before the list or by calling + {{{kbd(M-x org-list-checkbox-radio-mode)}}} to activate this minor mode. + +- {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) :: + + #+kindex: M-S-RET + #+findex: org-insert-todo-heading + Insert a new item with a checkbox. This works only if point is + already in a plain list item (see [[*Plain Lists]]). + +- {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) :: + + #+kindex: C-c C-x o + #+findex: org-toggle-ordered-property + #+vindex: org-track-ordered-property-with-tag + Toggle the =ORDERED= property of the entry, to toggle if checkboxes + must be checked off in sequence. A property is used for this + behavior because this should be local to the current entry, not + inherited like a tag. However, if you would like to /track/ the + value of this property with a tag for better visibility, customize + ~org-track-ordered-property-with-tag~. + +- {{{kbd(C-c #)}}} (~org-update-statistics-cookies~) :: + + #+kindex: C-c # + #+findex: org-update-statistics-cookies + Update the statistics cookie in the current outline entry. When + called with a {{{kbd(C-u)}}} prefix, update the entire file. + Checkbox statistic cookies are updated automatically if you toggle + checkboxes with {{{kbd(C-c C-c)}}} and make new ones with + {{{kbd(M-S-RET)}}}. TODO statistics cookies update when changing + TODO states. If you delete boxes/entries or add/change them by + hand, use this command to get things back into sync. + +* Tags +:PROPERTIES: +:DESCRIPTION: Tagging headlines and matching sets of tags. +:END: +#+cindex: tags +#+cindex: headline tagging +#+cindex: matching, tags +#+cindex: sparse tree, tag based + +An excellent way to implement labels and contexts for +cross-correlating information is to assign /tags/ to headlines. Org +mode has extensive support for tags. + +#+vindex: org-tag-faces +Every headline can contain a list of tags; they occur at the end of +the headline. Tags are normal words containing letters, numbers, =_=, +and =@=. Tags must be preceded and followed by a single colon, e.g., +=:work:=. Several tags can be specified, as in =:work:urgent:=. Tags +by default are in bold face with the same color as the headline. You +may specify special faces for specific tags using the variable +~org-tag-faces~, in much the same way as you can for TODO keywords +(see [[*Faces for TODO keywords]]). + +** Tag Inheritance +:PROPERTIES: +:DESCRIPTION: Tags use the tree structure of an outline. +:END: +#+cindex: tag inheritance +#+cindex: inheritance, of tags +#+cindex: sublevels, inclusion into tags match + +/Tags/ make use of the hierarchical structure of outline trees. If +a heading has a certain tag, all subheadings inherit the tag as well. +For example, in the list + +#+begin_example +,* Meeting with the French group :work: +,** Summary by Frank :boss:notes: +,*** TODO Prepare slides for him :action: +#+end_example + +#+texinfo: @noindent +the final heading has the tags =work=, =boss=, =notes=, and =action= +even though the final heading is not explicitly marked with those +tags. You can also set tags that all entries in a file should inherit +just as if these tags were defined in a hypothetical level zero that +surrounds the entire file. Use a line like this[fn:51] + +#+cindex: @samp{FILETAGS}, keyword +: #+FILETAGS: :Peter:Boss:Secret: + +#+vindex: org-use-tag-inheritance +#+vindex: org-tags-exclude-from-inheritance +To limit tag inheritance to specific tags, or to turn it off entirely, +use the variables ~org-use-tag-inheritance~ and +~org-tags-exclude-from-inheritance~. + +#+vindex: org-tags-match-list-sublevels +When a headline matches during a tags search while tag inheritance is +turned on, all the sublevels in the same tree---for a simple match +form---match as well[fn:52]. The list of matches may then become +very long. If you only want to see the first tags match in a subtree, +configure the variable ~org-tags-match-list-sublevels~ (not +recommended). + +#+vindex: org-agenda-use-tag-inheritance +Tag inheritance is relevant when the agenda search tries to match +a tag, either in the ~tags~ or ~tags-todo~ agenda types. In other +agenda types, ~org-use-tag-inheritance~ has no effect. Still, you may +want to have your tags correctly set in the agenda, so that tag +filtering works fine, with inherited tags. Set +~org-agenda-use-tag-inheritance~ to control this: the default value +includes all agenda types, but setting this to ~nil~ can really speed +up agenda generation. + +** Setting Tags +:PROPERTIES: +:DESCRIPTION: How to assign tags to a headline. +:END: +#+cindex: setting tags +#+cindex: tags, setting + +#+kindex: M-TAB +Tags can simply be typed into the buffer at the end of a headline. +After a colon, {{{kbd(M-TAB)}}} offers completion on tags. There is +also a special command for inserting tags: + +- {{{kbd(C-c C-q)}}} (~org-set-tags-command~) :: + + #+kindex: C-c C-q + #+findex: org-set-tags-command + #+cindex: completion, of tags + #+vindex: org-tags-column + Enter new tags for the current headline. Org mode either offers + completion or a special single-key interface for setting tags, see + below. After pressing {{{kbd(RET)}}}, the tags are inserted and + aligned to ~org-tags-column~. When called with a {{{kbd(C-u)}}} + prefix, all tags in the current buffer are aligned to that column, + just to make things look nice. Tags are automatically realigned + after promotion, demotion, and TODO state changes (see [[*Basic TODO + Functionality]]). + +- {{{kbd(C-c C-c)}}} (~org-set-tags-command~) :: + + #+kindex: C-c C-c + When point is in a headline, this does the same as {{{kbd(C-c + C-q)}}}. + +#+vindex: org-complete-tags-always-offer-all-agenda-tags +#+vindex: org-tag-alist +#+cindex: @samp{TAGS}, keyword +Org supports tag insertion based on a /list of tags/. By default this +list is constructed dynamically, containing all tags currently used in +the buffer[fn:53]. You may also globally specify a hard list of tags +with the variable ~org-tag-alist~. Finally you can set the default +tags for a given file using the =TAGS= keyword, like + +#+begin_example +,#+TAGS: @work @home @tennisclub +,#+TAGS: laptop car pc sailboat +#+end_example + +If you have globally defined your preferred set of tags using the +variable ~org-tag-alist~, but would like to use a dynamic tag list in +a specific file, add an empty =TAGS= keyword to that file: + +: #+TAGS: + +#+vindex: org-tag-persistent-alist +If you have a preferred set of tags that you would like to use in +every file, in addition to those defined on a per-file basis by =TAGS= +keyword, then you may specify a list of tags with the variable +~org-tag-persistent-alist~. You may turn this off on a per-file basis +by adding a =STARTUP= keyword to that file: + +: #+STARTUP: noptag + +By default Org mode uses the standard minibuffer completion facilities +for entering tags. However, it also implements another, quicker, tag +selection method called /fast tag selection/. This allows you to +select and deselect tags with just a single key press. For this to +work well you should assign unique letters to most of your commonly +used tags. You can do this globally by configuring the variable +~org-tag-alist~ in your Emacs init file. For example, you may find +the need to tag many items in different files with =@home=. In this +case you can set something like: + +#+begin_src emacs-lisp +(setq org-tag-alist '(("@work" . ?w) ("@home" . ?h) ("laptop" . ?l))) +#+end_src + +If the tag is only relevant to the file you are working on, then you +can instead set the =TAGS= keyword as: + +: #+TAGS: @work(w) @home(h) @tennisclub(t) laptop(l) pc(p) + +The tags interface shows the available tags in a splash window. If +you want to start a new line after a specific tag, insert =\n= into +the tag list + +: #+TAGS: @work(w) @home(h) @tennisclub(t) \n laptop(l) pc(p) + +#+texinfo: @noindent +or write them in two lines: + +#+begin_example +,#+TAGS: @work(w) @home(h) @tennisclub(t) +,#+TAGS: laptop(l) pc(p) +#+end_example + +You can also group together tags that are mutually exclusive by using +braces, as in: + +: #+TAGS: { @work(w) @home(h) @tennisclub(t) } laptop(l) pc(p) + +#+texinfo: @noindent +you indicate that at most one of =@work=, =@home=, and =@tennisclub= +should be selected. Multiple such groups are allowed. + +Do not forget to press {{{kbd(C-c C-c)}}} with point in one of these +lines to activate any changes. + +To set these mutually exclusive groups in the variable +~org-tags-alist~, you must use the dummy tags ~:startgroup~ and +~:endgroup~ instead of the braces. Similarly, you can use ~:newline~ +to indicate a line break. The previous example would be set globally +by the following configuration: + +#+begin_src emacs-lisp +(setq org-tag-alist '((:startgroup . nil) + ("@work" . ?w) ("@home" . ?h) + ("@tennisclub" . ?t) + (:endgroup . nil) + ("laptop" . ?l) ("pc" . ?p))) +#+end_src + +If at least one tag has a selection key then pressing {{{kbd(C-c +C-c)}}} automatically presents you with a special interface, listing +inherited tags, the tags of the current headline, and a list of all +valid tags with corresponding keys[fn:54]. + +Pressing keys assigned to tags adds or removes them from the list of +tags in the current line. Selecting a tag in a group of mutually +exclusive tags turns off any other tag from that group. + +In this interface, you can also use the following special keys: + +- {{{kbd(TAB)}}} :: + + #+kindex: TAB + Enter a tag in the minibuffer, even if the tag is not in the + predefined list. You can complete on all tags present in the + buffer. You can also add several tags: just separate them with + a comma. + +- {{{kbd(SPC)}}} :: + + #+kindex: SPC + Clear all tags for this line. + +- {{{kbd(RET)}}} :: + + #+kindex: RET + Accept the modified set. + +- {{{kbd(C-g)}}} :: + + #+kindex: C-g + Abort without installing changes. + +- {{{kbd(q)}}} :: + + #+kindex: q + If {{{kbd(q)}}} is not assigned to a tag, it aborts like + {{{kbd(C-g)}}}. + +- {{{kbd(!)}}} :: + + #+kindex: ! + Turn off groups of mutually exclusive tags. Use this to (as an + exception) assign several tags from such a group. + +- {{{kbd(C-c)}}} :: + + #+kindex: C-c C-c + Toggle auto-exit after the next change (see below). If you are + using expert mode, the first {{{kbd(C-c)}}} displays the selection + window. + +This method lets you assign tags to a headline with very few keys. +With the above setup, you could clear the current tags and set +=@home=, =laptop= and =pc= tags with just the following keys: +{{{kbd(C-c C-c SPC h l p RET)}}}. Switching from =@home= to =@work= +would be done with {{{kbd(C-c C-c w RET)}}} or alternatively with +{{{kbd(C-c C-c C-c w)}}}. Adding the non-predefined tag =sarah= could +be done with {{{kbd(C-c C-c TAB s a r a h RET)}}}. + +#+vindex: org-fast-tag-selection-single-key +If you find that most of the time you need only a single key press to +modify your list of tags, set the variable +~org-fast-tag-selection-single-key~. Then you no longer have to press +{{{kbd(RET)}}} to exit fast tag selection---it exits after the first +change. If you then occasionally need more keys, press {{{kbd(C-c)}}} +to turn off auto-exit for the current tag selection process (in +effect: start selection with {{{kbd(C-c C-c C-c)}}} instead of +{{{kbd(C-c C-c)}}}). If you set the variable to the value ~expert~, +the special window is not even shown for single-key tag selection, it +comes up only when you press an extra {{{kbd(C-c)}}}. + +** Tag Hierarchy +:PROPERTIES: +:DESCRIPTION: Create a hierarchy of tags. +:END: +#+cindex: group tags +#+cindex: tags, groups +#+cindex: tags hierarchy + +Tags can be defined in hierarchies. A tag can be defined as a /group +tag/ for a set of other tags. The group tag can be seen as the +"broader term" for its set of tags. Defining multiple group tags and +nesting them creates a tag hierarchy. + +One use-case is to create a taxonomy of terms (tags) that can be used +to classify nodes in a document or set of documents. + +When you search for a group tag, it return matches for all members in +the group and its subgroups. In an agenda view, filtering by a group +tag displays or hide headlines tagged with at least one of the members +of the group or any of its subgroups. This makes tag searches and +filters even more flexible. + +You can set group tags by using brackets and inserting a colon between +the group tag and its related tags---beware that all whitespaces are +mandatory so that Org can parse this line correctly: + +: #+TAGS: [ GTD : Control Persp ] + +In this example, =GTD= is the group tag and it is related to two other +tags: =Control=, =Persp=. Defining =Control= and =Persp= as group +tags creates a hierarchy of tags: + +#+begin_example +,#+TAGS: [ Control : Context Task ] +,#+TAGS: [ Persp : Vision Goal AOF Project ] +#+end_example + +That can conceptually be seen as a hierarchy of tags: + +- =GTD= + - =Persp= + - =Vision= + - =Goal= + - =AOF= + - =Project= + - =Control= + - =Context= + - =Task= + +You can use the ~:startgrouptag~, ~:grouptags~ and ~:endgrouptag~ +keyword directly when setting ~org-tag-alist~ directly: + +#+begin_src emacs-lisp +(setq org-tag-alist '((:startgrouptag) + ("GTD") + (:grouptags) + ("Control") + ("Persp") + (:endgrouptag) + (:startgrouptag) + ("Control") + (:grouptags) + ("Context") + ("Task") + (:endgrouptag))) +#+end_src + +The tags in a group can be mutually exclusive if using the same group +syntax as is used for grouping mutually exclusive tags together; using +curly brackets. + +: #+TAGS: { Context : @Home @Work @Call } + +When setting ~org-tag-alist~ you can use ~:startgroup~ and ~:endgroup~ +instead of ~:startgrouptag~ and ~:endgrouptag~ to make the tags +mutually exclusive. + +Furthermore, the members of a group tag can also be regular +expressions, creating the possibility of a more dynamic and rule-based +tag structure. The regular expressions in the group must be specified +within curly brackets. Here is an expanded example: + +#+begin_example +,#+TAGS: [ Vision : {V@.+} ] +,#+TAGS: [ Goal : {G@.+} ] +,#+TAGS: [ AOF : {AOF@.+} ] +,#+TAGS: [ Project : {P@.+} ] +#+end_example + +Searching for the tag =Project= now lists all tags also including +regular expression matches for =P@.+=, and similarly for tag searches +on =Vision=, =Goal= and =AOF=. For example, this would work well for +a project tagged with a common project-identifier, e.g., +=P@2014_OrgTags=. + +#+kindex: C-c C-x q +#+findex: org-toggle-tags-groups +#+vindex: org-group-tags +If you want to ignore group tags temporarily, toggle group tags +support with ~org-toggle-tags-groups~, bound to {{{kbd(C-c C-x q)}}}. +If you want to disable tag groups completely, set ~org-group-tags~ to +~nil~. + +** Tag Searches +:PROPERTIES: +:DESCRIPTION: Searching for combinations of tags. +:END: +#+cindex: tag searches +#+cindex: searching for tags + +Once a system of tags has been set up, it can be used to collect +related information into special lists. + +- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) :: + + #+kindex: C-c / m + #+kindex: C-c \ + #+findex: org-match-sparse-tree + Create a sparse tree with all headlines matching a tags search. + With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not + a TODO line. + +- {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) :: + + #+kindex: m @r{(Agenda dispatcher)} + #+findex: org-tags-view + Create a global list of tag matches from all agenda files. See + [[*Matching tags and properties]]. + +- {{{kbd(M-x org-agenda M)}}} (~org-tags-view~) :: + + #+kindex: M @r{(Agenda dispatcher)} + #+vindex: org-tags-match-list-sublevels + Create a global list of tag matches from all agenda files, but check + only TODO items and force checking subitems (see the option + ~org-tags-match-list-sublevels~). + +These commands all prompt for a match string which allows basic +Boolean logic like =+boss+urgent-project1=, to find entries with tags +=boss= and =urgent=, but not =project1=, or =Kathy|Sally= to find +entries which are tagged, like =Kathy= or =Sally=. The full syntax of +the search string is rich and allows also matching against TODO +keywords, entry levels and properties. For a complete description +with many examples, see [[*Matching tags and properties]]. + +* Properties and Columns +:PROPERTIES: +:DESCRIPTION: Storing information about an entry. +:END: +#+cindex: properties + +A property is a key-value pair associated with an entry. Properties +can be set so they are associated with a single entry, with every +entry in a tree, or with the whole buffer. + +There are two main applications for properties in Org mode. First, +properties are like tags, but with a value. Imagine maintaining +a file where you document bugs and plan releases for a piece of +software. Instead of using tags like =release_1=, =release_2=, you +can use a property, say =Release=, that in different subtrees has +different values, such as =1.0= or =2.0=. Second, you can use +properties to implement (very basic) database capabilities in an Org +buffer. Imagine keeping track of your music CDs, where properties +could be things such as the album, artist, date of release, number of +tracks, and so on. + +Properties can be conveniently edited and viewed in column view (see +[[*Column View]]). + +** Property Syntax +:PROPERTIES: +:DESCRIPTION: How properties are spelled out. +:END: +#+cindex: property syntax +#+cindex: drawer, for properties + +Properties are key--value pairs. When they are associated with +a single entry or with a tree they need to be inserted into a special +drawer (see [[*Drawers]]) with the name =PROPERTIES=, which has to be +located right below a headline, and its planning line (see [[*Deadlines +and Scheduling]]) when applicable. Each property is specified on +a single line, with the key---surrounded by colons---first, and the +value after it. Keys are case-insensitive. Here is an example: + +#+begin_example +,* CD collection +,** Classic +,*** Goldberg Variations + :PROPERTIES: + :Title: Goldberg Variations + :Composer: J.S. Bach + :Artist: Glenn Gould + :Publisher: Deutsche Grammophon + :NDisks: 1 + :END: +#+end_example + +Depending on the value of ~org-use-property-inheritance~, a property +set this way is associated either with a single entry, or with the +sub-tree defined by the entry, see [[*Property Inheritance]]. + +You may define the allowed values for a particular property =Xyz= by +setting a property =Xyz_ALL=. This special property is /inherited/, +so if you set it in a level 1 entry, it applies to the entire tree. +When allowed values are defined, setting the corresponding property +becomes easier and is less prone to typing errors. For the example +with the CD collection, we can pre-define publishers and the number of +disks in a box like this: + +#+begin_example +,* CD collection + :PROPERTIES: + :NDisks_ALL: 1 2 3 4 + :Publisher_ALL: "Deutsche Grammophon" Philips EMI + :END: +#+end_example + +Properties can be inserted on buffer level. That means they apply +before the first headline and can be inherited by all entries in a +file. Property blocks defined before first headline needs to be +located at the top of the buffer, allowing only comments above. + +Properties can also be defined using lines like: + +#+cindex: @samp{_ALL} suffix, in properties +#+cindex: @samp{PROPERTY}, keyword +: #+PROPERTY: NDisks_ALL 1 2 3 4 + +#+cindex: @samp{+} suffix, in properties +If you want to add to the value of an existing property, append a =+= +to the property name. The following results in the property =var= +having the value =foo=1 bar=2=. + +#+begin_example +,#+PROPERTY: var foo=1 +,#+PROPERTY: var+ bar=2 +#+end_example + +It is also possible to add to the values of inherited properties. The +following results in the =Genres= property having the value =Classic +Baroque= under the =Goldberg Variations= subtree. + +#+begin_example +,* CD collection +,** Classic + :PROPERTIES: + :Genres: Classic + :END: +,*** Goldberg Variations + :PROPERTIES: + :Title: Goldberg Variations + :Composer: J.S. Bach + :Artist: Glenn Gould + :Publisher: Deutsche Grammophon + :NDisks: 1 + :Genres+: Baroque + :END: +#+end_example + +Note that a property can only have one entry per drawer. + +#+vindex: org-global-properties +Property values set with the global variable ~org-global-properties~ +can be inherited by all entries in all Org files. + +The following commands help to work with properties: + +#+attr_texinfo: :sep , +- {{{kbd(M-TAB)}}} (~pcomplete~) :: + + #+kindex: M-TAB + #+findex: pcomplete + After an initial colon in a line, complete property keys. All keys + used in the current file are offered as possible completions. + +- {{{kbd(C-c C-x p)}}} (~org-set-property~) :: + + #+kindex: C-c C-x p + #+findex: org-set-property + Set a property. This prompts for a property name and a value. If + necessary, the property drawer is created as well. + +- {{{kbd(C-u M-x org-insert-drawer)}}} :: + + #+findex: org-insert-drawer + Insert a property drawer into the current entry. The drawer is + inserted early in the entry, but after the lines with planning + information like deadlines. If before first headline the drawer is + inserted at the top of the drawer after any potential comments. + +- {{{kbd(C-c C-c)}}} (~org-property-action~) :: + + #+kindex: C-c C-c + #+findex: org-property-action + With point in a property drawer, this executes property commands. + +- {{{kbd(C-c C-c s)}}} (~org-set-property~) :: + + #+kindex: C-c C-c s + #+findex: org-set-property + Set a property in the current entry. Both the property and the + value can be inserted using completion. + +- {{{kbd(S-RIGHT)}}} (~org-property-next-allowed-values~), {{{kbd(S-LEFT)}}} (~org-property-previous-allowed-value~) :: + + #+kindex: S-RIGHT + #+kindex: S-LEFT + Switch property at point to the next/previous allowed value. + +- {{{kbd(C-c C-c d)}}} (~org-delete-property~) :: + + #+kindex: C-c C-c d + #+findex: org-delete-property + Remove a property from the current entry. + +- {{{kbd(C-c C-c D)}}} (~org-delete-property-globally~) :: + + #+kindex: C-c C-c D + #+findex: org-delete-property-globally + Globally remove a property, from all entries in the current file. + +- {{{kbd(C-c C-c c)}}} (~org-compute-property-at-point~) :: + + #+kindex: C-c C-c c + #+findex: org-compute-property-at-point + Compute the property at point, using the operator and scope from the + nearest column format definition. + +** Special Properties +:PROPERTIES: +:DESCRIPTION: Access to other Org mode features. +:END: +#+cindex: properties, special + +Special properties provide an alternative access method to Org mode +features, like the TODO state or the priority of an entry, discussed +in the previous chapters. This interface exists so that you can +include these states in a column view (see [[*Column View]]), or to use +them in queries. The following property names are special and should +not be used as keys in the properties drawer: + +#+cindex: @samp{ALLTAGS}, special property +#+cindex: @samp{BLOCKED}, special property +#+cindex: @samp{CLOCKSUM}, special property +#+cindex: @samp{CLOCKSUM_T}, special property +#+cindex: @samp{CLOSED}, special property +#+cindex: @samp{DEADLINE}, special property +#+cindex: @samp{FILE}, special property +#+cindex: @samp{ITEM}, special property +#+cindex: @samp{PRIORITY}, special property +#+cindex: @samp{SCHEDULED}, special property +#+cindex: @samp{TAGS}, special property +#+cindex: @samp{TIMESTAMP}, special property +#+cindex: @samp{TIMESTAMP_IA}, special property +#+cindex: @samp{TODO}, special property +| =ALLTAGS= | All tags, including inherited ones. | +| =BLOCKED= | ~t~ if task is currently blocked by children or siblings. | +| =CATEGORY= | The category of an entry. | +| =CLOCKSUM= | The sum of CLOCK intervals in the subtree. ~org-clock-sum~ | +| | must be run first to compute the values in the current buffer. | +| =CLOCKSUM_T= | The sum of CLOCK intervals in the subtree for today. | +| | ~org-clock-sum-today~ must be run first to compute the | +| | values in the current buffer. | +| =CLOSED= | When was this entry closed? | +| =DEADLINE= | The deadline timestamp. | +| =FILE= | The filename the entry is located in. | +| =ITEM= | The headline of the entry. | +| =PRIORITY= | The priority of the entry, a string with a single letter. | +| =SCHEDULED= | The scheduling timestamp. | +| =TAGS= | The tags defined directly in the headline. | +| =TIMESTAMP= | The first keyword-less timestamp in the entry. | +| =TIMESTAMP_IA= | The first inactive timestamp in the entry. | +| =TODO= | The TODO keyword of the entry. | + +** Property Searches +:PROPERTIES: +:DESCRIPTION: Matching property values. +:END: +#+cindex: properties, searching +#+cindex: searching, of properties + +To create sparse trees and special lists with selection based on +properties, the same commands are used as for tag searches (see [[*Tag +Searches]]). + +- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) :: + + #+kindex: C-c / m + #+kindex: C-c \ + #+findex: org-match-sparse-tree + Create a sparse tree with all matching entries. With + a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not + a TODO line. + +- {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) :: + + #+kindex: m @r{(Agenda dispatcher)} + #+findex: org-tags-view + Create a global list of tag/property matches from all agenda files. + +- {{{kbd(M-x org-agenda M)}}} (~org-tags-view~) :: + + #+kindex: M @r{(Agenda dispatcher)} + #+vindex: org-tags-match-list-sublevels + Create a global list of tag matches from all agenda files, but check + only TODO items and force checking of subitems (see the option + ~org-tags-match-list-sublevels~). + +The syntax for the search string is described in [[*Matching tags and +properties]]. + +There is also a special command for creating sparse trees based on a +single property: + +- {{{kbd(C-c / p)}}} :: + + #+kindex: C-c / p + Create a sparse tree based on the value of a property. This first + prompts for the name of a property, and then for a value. A sparse + tree is created with all entries that define this property with the + given value. If you enclose the value in curly braces, it is + interpreted as a regular expression and matched against the property + values. + +** Property Inheritance +:PROPERTIES: +:DESCRIPTION: Passing values down a tree. +:END: +#+cindex: properties, inheritance +#+cindex: inheritance, of properties + +#+vindex: org-use-property-inheritance +The outline structure of Org documents lends itself to an inheritance +model of properties: if the parent in a tree has a certain property, +the children can inherit this property. Org mode does not turn this +on by default, because it can slow down property searches +significantly and is often not needed. However, if you find +inheritance useful, you can turn it on by setting the variable +~org-use-property-inheritance~. It may be set to ~t~ to make all +properties inherited from the parent, to a list of properties that +should be inherited, or to a regular expression that matches inherited +properties. If a property has the value ~nil~, this is interpreted as +an explicit un-define of the property, so that inheritance search +stops at this value and returns ~nil~. + +Org mode has a few properties for which inheritance is hard-coded, at +least for the special applications for which they are used: + +- ~COLUMNS~ :: + + #+cindex: @samp{COLUMNS}, property + The =COLUMNS= property defines the format of column view (see + [[*Column View]]). It is inherited in the sense that the level where + a =COLUMNS= property is defined is used as the starting point for + a column view table, independently of the location in the subtree + from where columns view is turned on. + +- ~CATEGORY~ :: + + #+cindex: @samp{CATEGORY}, property + For agenda view, a category set through a =CATEGORY= property + applies to the entire subtree. + +- ~ARCHIVE~ :: + + #+cindex: @samp{ARCHIVE}, property + For archiving, the =ARCHIVE= property may define the archive + location for the entire subtree (see [[*Moving a tree to an archive + file]]). + +- ~LOGGING~ :: + + #+cindex: @samp{LOGGING}, property + The =LOGGING= property may define logging settings for an entry or + a subtree (see [[*Tracking TODO state changes]]). + +** Column View +:PROPERTIES: +:DESCRIPTION: Tabular viewing and editing. +:END: + +A great way to view and edit properties in an outline tree is /column +view/. In column view, each outline node is turned into a table row. +Columns in this table provide access to properties of the entries. +Org mode implements columns by overlaying a tabular structure over the +headline of each item. While the headlines have been turned into +a table row, you can still change the visibility of the outline tree. +For example, you get a compact table by switching to "contents" +view---{{{kbd(S-TAB)}}} {{{kbd(S-TAB)}}}, or simply {{{kbd(c)}}} +while column view is active---but you can still open, read, and edit +the entry below each headline. Or, you can switch to column view +after executing a sparse tree command and in this way get a table only +for the selected items. Column view also works in agenda buffers (see +[[*Agenda Views]]) where queries have collected selected items, possibly +from a number of files. + +*** Defining columns +:PROPERTIES: +:DESCRIPTION: The COLUMNS format property. +:END: +#+cindex: column view, for properties +#+cindex: properties, column view + +Setting up a column view first requires defining the columns. This is +done by defining a column format line. + +**** Scope of column definitions +:PROPERTIES: +:DESCRIPTION: Where defined, where valid? +:END: + +To specify a format that only applies to a specific tree, add +a =COLUMNS= property to the top node of that tree, for example: + +#+begin_example +,** Top node for columns view + :PROPERTIES: + :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO + :END: +#+end_example + +A =COLUMNS= property within a property drawer before first headline +will apply to the entire file. As an addition to property drawers, +keywords can also be defined for an entire file using a line like: + +#+cindex: @samp{COLUMNS}, keyword +: #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO + +If a =COLUMNS= property is present in an entry, it defines columns for +the entry itself, and for the entire subtree below it. Since the +column definition is part of the hierarchical structure of the +document, you can define columns on level 1 that are general enough +for all sublevels, and more specific columns further down, when you +edit a deeper part of the tree. + +**** Column attributes +:PROPERTIES: +:DESCRIPTION: Appearance and content of a column. +:END: + +A column definition sets the attributes of a column. The general +definition looks like this: + +: %[WIDTH]PROPERTY[(TITLE)][{SUMMARY-TYPE}] + +#+texinfo: @noindent +Except for the percent sign and the property name, all items are +optional. The individual parts have the following meaning: + +- {{{var(WIDTH)}}} :: + + An integer specifying the width of the column in characters. If + omitted, the width is determined automatically. + +- {{{var(PROPERTY)}}} :: + + The property that should be edited in this column. Special + properties representing meta data are allowed here as well (see + [[*Special Properties]]). + +- {{{var(TITLE)}}} :: + + The header text for the column. If omitted, the property name is + used. + +- {{{var(SUMMARY-TYPE)}}} :: + + The summary type. If specified, the column values for parent nodes + are computed from the children[fn:55]. + + Supported summary types are: + + | =+= | Sum numbers in this column. | + | =+;%.1f= | Like =+=, but format result with =%.1f=. | + | =$= | Currency, short for =+;%.2f=. | + | =min= | Smallest number in column. | + | =max= | Largest number. | + | =mean= | Arithmetic mean of numbers. | + | =X= | Checkbox status, =[X]= if all children are =[X]=. | + | =X/= | Checkbox status, =[n/m]=. | + | =X%= | Checkbox status, =[n%]=. | + | =:= | Sum times, HH:MM, plain numbers are minutes. | + | =:min= | Smallest time value in column. | + | =:max= | Largest time value. | + | =:mean= | Arithmetic mean of time values. | + | =@min= | Minimum age[fn:56] (in days/hours/mins/seconds). | + | =@max= | Maximum age (in days/hours/mins/seconds). | + | =@mean= | Arithmetic mean of ages (in days/hours/mins/seconds). | + | =est+= | Add low-high estimates. | + + #+vindex: org-columns-summary-types + You can also define custom summary types by setting + ~org-columns-summary-types~. + +The =est+= summary type requires further explanation. It is used for +combining estimates, expressed as low-high ranges. For example, +instead of estimating a particular task will take 5 days, you might +estimate it as 5--6 days if you're fairly confident you know how much +work is required, or 1--10 days if you do not really know what needs +to be done. Both ranges average at 5.5 days, but the first represents +a more predictable delivery. + +When combining a set of such estimates, simply adding the lows and +highs produces an unrealistically wide result. Instead, =est+= adds +the statistical mean and variance of the subtasks, generating a final +estimate from the sum. For example, suppose you had ten tasks, each +of which was estimated at 0.5 to 2 days of work. Straight addition +produces an estimate of 5 to 20 days, representing what to expect if +everything goes either extremely well or extremely poorly. In +contrast, =est+= estimates the full job more realistically, at 10--15 +days. + +Here is an example for a complete columns definition, along with +allowed values[fn:57]. + +#+begin_example +:COLUMNS: %25ITEM %9Approved(Approved?){X} %Owner %11Status \ + %10Time_Estimate{:} %CLOCKSUM %CLOCKSUM_T +:Owner_ALL: Tammy Mark Karl Lisa Don +:Status_ALL: "In progress" "Not started yet" "Finished" "" +:Approved_ALL: "[ ]" "[X]" +#+end_example + +#+texinfo: @noindent +The first column, =%25ITEM=, means the first 25 characters of the item +itself, i.e., of the headline. You probably always should start the +column definition with the =ITEM= specifier. The other specifiers +create columns =Owner= with a list of names as allowed values, for +=Status= with four different possible values, and for a checkbox field +=Approved=. When no width is given after the =%= character, the +column is exactly as wide as it needs to be in order to fully display +all values. The =Approved= column does have a modified title +(=Approved?=, with a question mark). Summaries are created for the +=Time_Estimate= column by adding time duration expressions like HH:MM, +and for the =Approved= column, by providing an =[X]= status if all +children have been checked. The =CLOCKSUM= and =CLOCKSUM_T= columns +are special, they lists the sums of CLOCK intervals in the subtree, +either for all clocks or just for today. + +*** Using column view +:PROPERTIES: +:DESCRIPTION: How to create and use column view. +:END: + +**** Turning column view on or off +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c C-x C-c)}}} (~org-columns~) :: + + #+kindex: C-c C-x C-c + #+vindex: org-columns + #+vindex: org-columns-default-format + Turn on column view. If point is before the first headline in the + file, column view is turned on for the entire file, using the + =#+COLUMNS= definition. If point is somewhere inside the outline, + this command searches the hierarchy, up from point, for a =COLUMNS= + property that defines a format. When one is found, the column view + table is established for the tree starting at the entry that + contains the =COLUMNS= property. If no such property is found, the + format is taken from the =#+COLUMNS= line or from the variable + ~org-columns-default-format~, and column view is established for the + current entry and its subtree. + +- {{{kbd(r)}}} or {{{kbd(g)}}} on a columns view line (~org-columns-redo~) :: + + #+kindex: r + #+kindex: g + #+findex: org-columns-redo + Recreate the column view, to include recent changes made in the + buffer. + +- {{{kbd(C-c C-c)}}} or {{{kbd(q)}}} on a columns view line (~org-columns-quit~) :: + + #+kindex: q + #+kindex: C-c C-c + #+findex: org-columns-quit + Exit column view. + +**** Editing values +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+attr_texinfo: :sep and +- {{{kbd(LEFT)}}}, {{{kbd(RIGHT)}}}, {{{kbd(UP)}}}, {{{kbd(DOWN)}}} :: + + Move through the column view from field to field. + +- {{{kbd(1..9\,0)}}} :: + + #+kindex: 1..9,0 + Directly select the Nth allowed value, {{{kbd(0)}}} selects the + 10th value. + +- {{{kbd(n)}}} or {{{kbd(S-RIGHT)}}} (~org-columns-next-allowed-value~) and {{{kbd(p)}}} or {{{kbd(S-LEFT)}}} (~org-columns-previous-allowed-value~) :: + + #+kindex: n + #+kindex: S-RIGHT + #+kindex: p + #+kindex: S-LEFT + #+findex: org-columns-next-allowed-value + #+findex: org-columns-previous-allowed-value + Switch to the next/previous allowed value of the field. For this, + you have to have specified allowed values for a property. + +- {{{kbd(e)}}} (~org-columns-edit-value~) :: + + #+kindex: e + #+findex: org-columns-edit-value + Edit the property at point. For the special properties, this + invokes the same interface that you normally use to change that + property. For example, the tag completion or fast selection + interface pops up when editing a =TAGS= property. + +- {{{kbd(C-c C-c)}}} (~org-columns-toggle-or-columns-quit~) :: + + #+kindex: C-c C-c + #+findex: org-columns-toggle-or-columns-quit + When there is a checkbox at point, toggle it. Else exit column + view. + +- {{{kbd(v)}}} (~org-columns-show-value~) :: + + #+kindex: v + #+findex: org-columns-show-value + View the full value of this property. This is useful if the width + of the column is smaller than that of the value. + +- {{{kbd(a)}}} (~org-columns-edit-allowed~) :: + + #+kindex: a + #+findex: org-columns-edit-allowed + Edit the list of allowed values for this property. If the list is + found in the hierarchy, the modified values is stored there. If no + list is found, the new value is stored in the first entry that is + part of the current column view. + +**** Modifying column view on-the-fly +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+attr_texinfo: :sep and +- {{{kbd(<)}}} (~org-columns-narrow~) and {{{kbd(>)}}} (~org-columns-widen~) :: + + #+kindex: < + #+kindex: > + #+findex: org-columns-narrow + #+findex: org-columns-widen + Make the column narrower/wider by one character. + +- {{{kbd(S-M-RIGHT)}}} (~org-columns-new~) :: + + #+kindex: S-M-RIGHT + #+findex: org-columns-new + Insert a new column, to the left of the current column. + +- {{{kbd(S-M-LEFT)}}} (~org-columns-delete~) :: + + #+kindex: S-M-LEFT + #+findex: org-columns-delete + Delete the current column. + +*** Capturing column view +:PROPERTIES: +:DESCRIPTION: A dynamic block for column view. +:END: + +Since column view is just an overlay over a buffer, it cannot be +exported or printed directly. If you want to capture a column view, +use a =columnview= dynamic block (see [[*Dynamic Blocks]]). The frame of +this block looks like this: + +#+cindex: @samp{BEGIN columnview} +#+begin_example +,* The column view +,#+BEGIN: columnview :hlines 1 :id "label" + +,#+END: +#+end_example + +This dynamic block has the following parameters: + +- =:id= :: + + This is the most important parameter. Column view is a feature that + is often localized to a certain (sub)tree, and the capture block + might be at a different location in the file. To identify the tree + whose view to capture, you can use four values: + + - =local= :: + + Use the tree in which the capture block is located. + + - =global= :: + + Make a global view, including all headings in the file. + + - =file:FILENAME= :: + + Run column view at the top of the {{{var(FILENAME)}}} file. + + - =LABEL= :: + + #+cindex: @samp{ID}, property + Call column view in the tree that has an =ID= property with the + value {{{var(LABEL)}}}. You can use {{{kbd(M-x org-id-copy)}}} to + create a globally unique ID for the current entry and copy it to + the kill-ring. + +- =:match= :: + + When set to a string, use this as a tags/property match filter to + select only a subset of the headlines in the scope set by the ~:id~ + parameter. + + +- =:hlines= :: + + When ~t~, insert an hline after every line. When a number N, insert + an hline before each headline with level ~<= N~. + +- =:vlines= :: + + When non-~nil~, force column groups to get vertical lines. + +- =:maxlevel= :: + + When set to a number, do not capture entries below this level. + +- =:skip-empty-rows= :: + + When non-~nil~, skip rows where the only non-empty specifier of + the column view is =ITEM=. + +- =:exclude-tags= :: + + List of tags to exclude from column view table: entries with these + tags will be excluded from the column view. + +- =:indent= :: + + When non-~nil~, indent each =ITEM= field according to its level. + +- =:format= :: + + Specify a column attribute (see [[*Column attributes]]) for the dynamic + block. + +The following commands insert or update the dynamic block: + +- ~org-columns-insert-dblock~ :: + + #+kindex: C-c C-x x + #+findex: org-columns-insert-dblock + Insert a dynamic block capturing a column view. Prompt for the + scope or ID of the view. + + This command can be invoked by calling + ~org-dynamic-block-insert-dblock~ ({{{kbd(C-c C-x x)}}}) and + selecting "columnview" (see [[*Dynamic Blocks]]). + +- {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) :: + + #+kindex: C-c C-c + #+kindex: C-c C-x C-u + #+findex: org-dblock-update + Update dynamic block at point. point needs to be in the =#+BEGIN= + line of the dynamic block. + +- {{{kbd(C-u C-c C-x C-u)}}} (~org-update-all-dblocks~) :: + + #+kindex: C-u C-c C-x C-u + Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful if + you have several clock table blocks, column-capturing blocks or + other dynamic blocks in a buffer. + +You can add formulas to the column view table and you may add plotting +instructions in front of the table---these survive an update of the +block. If there is a =TBLFM= keyword after the table, the table is +recalculated automatically after an update. + +An alternative way to capture and process property values into a table +is provided by Eric Schulte's =org-collector.el=, which is +a contributed package[fn:58]. It provides a general API to collect +properties from entries in a certain scope, and arbitrary Lisp +expressions to process these values before inserting them into a table +or a dynamic block. + +* Dates and Times +:PROPERTIES: +:DESCRIPTION: Making items useful for planning. +:END: +#+cindex: dates +#+cindex: times +#+cindex: timestamp +#+cindex: date stamp + +To assist project planning, TODO items can be labeled with a date +and/or a time. The specially formatted string carrying the date and +time information is called a /timestamp/ in Org mode. This may be +a little confusing because timestamp is often used as indicating when +something was created or last changed. However, in Org mode this term +is used in a much wider sense. + +** Timestamps +:PROPERTIES: +:DESCRIPTION: Assigning a time to a tree entry. +:END: +#+cindex: timestamps +#+cindex: ranges, time +#+cindex: date stamps +#+cindex: deadlines +#+cindex: scheduling + +A timestamp is a specification of a date (possibly with a time or +a range of times) in a special format, either =<2003-09-16 Tue>= or +=<2003-09-16 Tue 09:39>= or =<2003-09-16 Tue 12:00-12:30>=[fn:59]. +A timestamp can appear anywhere in the headline or body of an Org tree +entry. Its presence causes entries to be shown on specific dates in +the agenda (see [[*Weekly/daily agenda]]). We distinguish: + +- Plain timestamp; Event; Appointment :: + + #+cindex: timestamp + #+cindex: appointment + A simple timestamp just assigns a date/time to an item. This is + just like writing down an appointment or event in a paper agenda. + In the agenda display, the headline of an entry associated with + a plain timestamp is shown exactly on that date. + + #+begin_example + ,* Meet Peter at the movies + <2006-11-01 Wed 19:15> + ,* Discussion on climate change + <2006-11-02 Thu 20:00-22:00> + #+end_example + +- Timestamp with repeater interval :: + + #+cindex: timestamp, with repeater interval + A timestamp may contain a /repeater interval/, indicating that it + applies not only on the given date, but again and again after + a certain interval of N days (d), weeks (w), months (m), or years + (y). The following shows up in the agenda every Wednesday: + + #+begin_example + ,* Pick up Sam at school + <2007-05-16 Wed 12:30 +1w> + #+end_example + +- Diary-style expression entries :: + + #+cindex: diary style timestamps + #+cindex: sexp timestamps + For more complex date specifications, Org mode supports using the + special expression diary entries implemented in the Emacs Calendar + package[fn:60]. For example, with optional time: + + #+begin_example + ,* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month + <%%(diary-float t 4 2)> + #+end_example + +- Time/Date range :: + + #+cindex: timerange + #+cindex: date range + Two timestamps connected by =--= denote a range. The headline is + shown on the first and last day of the range, and on any dates that + are displayed and fall in the range. Here is an example: + + #+begin_example + ,** Meeting in Amsterdam + <2004-08-23 Mon>--<2004-08-26 Thu> + #+end_example + +- Inactive timestamp :: + + #+cindex: timestamp, inactive + #+cindex: inactive timestamp + Just like a plain timestamp, but with square brackets instead of + angular ones. These timestamps are inactive in the sense that they + do /not/ trigger an entry to show up in the agenda. + + #+begin_example + ,* Gillian comes late for the fifth time + [2006-11-01 Wed] + #+end_example + +** Creating Timestamps +:PROPERTIES: +:DESCRIPTION: Commands to insert timestamps. +:END: + +For Org mode to recognize timestamps, they need to be in the specific +format. All commands listed below produce timestamps in the correct +format. + +#+attr_texinfo: :sep , +- {{{kbd(C-c .)}}} (~org-time-stamp~) :: + + #+kindex: C-c . + #+findex: org-time-stamp + Prompt for a date and insert a corresponding timestamp. When point + is at an existing timestamp in the buffer, the command is used to + modify this timestamp instead of inserting a new one. When this + command is used twice in succession, a time range is inserted. + + #+kindex: C-u C-c . + #+vindex: org-time-stamp-rounding-minutes + When called with a prefix argument, use the alternative format which + contains date and time. The default time can be rounded to + multiples of 5 minutes. See the option + ~org-time-stamp-rounding-minutes~. + + #+kindex: C-u C-u C-c . + With two prefix arguments, insert an active timestamp with the + current time without prompting. + +- {{{kbd(C-c !)}}} (~org-time-stamp-inactive~) :: + + #+kindex: C-c ! + #+kindex: C-u C-c ! + #+kindex: C-u C-u C-c ! + #+findex: org-time-stamp-inactive + Like {{{kbd(C-c .)}}}, but insert an inactive timestamp that does + not cause an agenda entry. + +- {{{kbd(C-c C-c)}}} :: + + #+kindex: C-c C-c + Normalize timestamp, insert or fix day name if missing or wrong. + +- {{{kbd(C-c <)}}} (~org-date-from-calendar~) :: + + #+kindex: C-c < + #+findex: org-date-from-calendar + Insert a timestamp corresponding to point date in the calendar. + +- {{{kbd(C-c >)}}} (~org-goto-calendar~) :: + + #+kindex: C-c > + #+findex: org-goto-calendar + Access the Emacs calendar for the current date. If there is + a timestamp in the current line, go to the corresponding date + instead. + +- {{{kbd(C-c C-o)}}} (~org-open-at-point~) :: + + #+kindex: C-c C-o + #+findex: org-open-at-point + Access the agenda for the date given by the timestamp or -range at + point (see [[*Weekly/daily agenda]]). + +- {{{kbd(S-LEFT)}}} (~org-timestamp-down-day~), {{{kbd(S-RIGHT)}}} (~org-timestamp-up-day~) :: + + #+kindex: S-LEFT + #+kindex: S-RIGHT + #+findex: org-timestamp-down-day + #+findex: org-timestamp-up-day + Change date at point by one day. These key bindings conflict with + shift-selection and related modes (see [[*Packages that conflict with + Org mode]]). + +- {{{kbd(S-UP)}}} (~org-timestamp-up~), {{{kbd(S-DOWN)}}} (~org-timestamp-down~) :: + + #+kindex: S-UP + #+kindex: S-DOWN + On the beginning or enclosing bracket of a timestamp, change its + type. Within a timestamp, change the item under point. Point can + be on a year, month, day, hour or minute. When the timestamp + contains a time range like =15:30-16:30=, modifying the first time + also shifts the second, shifting the time block with constant + length. To change the length, modify the second time. Note that if + point is in a headline and not at a timestamp, these same keys + modify the priority of an item (see [[*Priorities]]). The key bindings + also conflict with shift-selection and related modes (see [[*Packages + that conflict with Org mode]]). + +- {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) :: + + #+kindex: C-c C-y + #+findex: org-evaluate-time-range + #+cindex: evaluate time range + Evaluate a time range by computing the difference between start and + end. With a prefix argument, insert result after the time range (in + a table: into the following column). + +*** The date/time prompt +:PROPERTIES: +:DESCRIPTION: How Org mode helps you enter dates and times. +:END: +#+cindex: date, reading in minibuffer +#+cindex: time, reading in minibuffer + +#+vindex: org-read-date-prefer-future +When Org mode prompts for a date/time, the default is shown in default +date/time format, and the prompt therefore seems to ask for a specific +format. But it in fact accepts date/time information in a variety of +formats. Generally, the information should start at the beginning of +the string. Org mode finds whatever information is in there and +derives anything you have not specified from the /default date and +time/. The default is usually the current date and time, but when +modifying an existing timestamp, or when entering the second stamp of +a range, it is taken from the stamp in the buffer. When filling in +information, Org mode assumes that most of the time you want to enter +a date in the future: if you omit the month/year and the given +day/month is /before/ today, it assumes that you mean a future +date[fn:61]. If the date has been automatically shifted into the +future, the time prompt shows this with =(=>F)=. + +For example, let's assume that today is *June 13, 2006*. Here is how +various inputs are interpreted, the items filled in by Org mode are in +*bold*. + +| =3-2-5= | \rArr{} 2003-02-05 | +| =2/5/3= | \rArr{} 2003-02-05 | +| =14= | \rArr{} *2006*-*06*-14 | +| =12= | \rArr{} *2006*-*07*-12 | +| =2/5= | \rArr{} *2007*-02-05 | +| =Fri= | \rArr{} nearest Friday (default date or later) | +| =sep 15= | \rArr{} *2006*-09-15 | +| =feb 15= | \rArr{} *2007*-02-15 | +| =sep 12 9= | \rArr{} 2009-09-12 | +| =12:45= | \rArr{} *2006*-*06*-*13* 12:45 | +| =22 sept 0:34= | \rArr{} *2006*-09-22 0:34 | +| =w4= | \rArr{} ISO week for of the current year *2006* | +| =2012 w4 fri= | \rArr{} Friday of ISO week 4 in 2012 | +| =2012-w04-5= | \rArr{} Same as above | + +Furthermore you can specify a relative date by giving, as the /first/ +thing in the input: a plus/minus sign, a number and a letter---=h=, +=d=, =w=, =m= or =y=---to indicate a change in hours, days, weeks, +months, or years. With =h= the date is relative to the current time, +with the other letters and a single plus or minus, the date is +relative to today at 00:00. With a double plus or minus, it is +relative to the default date. If instead of a single letter, you use +the abbreviation of day name, the date is the Nth such day, e.g.: + +| =+0= | \rArr{} today | +| =.= | \rArr{} today | +| =+2h= | \rArr{} two hours from now | +| =+4d= | \rArr{} four days from today | +| =+4= | \rArr{} same as +4d | +| =+2w= | \rArr{} two weeks from today | +| =++5= | \rArr{} five days from default date | +| =+2tue= | \rArr{} second Tuesday from now | + +#+vindex: parse-time-months +#+vindex: parse-time-weekdays +The function understands English month and weekday abbreviations. If +you want to use un-abbreviated names and/or other languages, configure +the variables ~parse-time-months~ and ~parse-time-weekdays~. + +#+vindex: org-read-date-force-compatible-dates +Not all dates can be represented in a given Emacs implementation. By +default Org mode forces dates into the compatibility range 1970--2037 +which works on all Emacs implementations. If you want to use dates +outside of this range, read the docstring of the variable +~org-read-date-force-compatible-dates~. + +You can specify a time range by giving start and end times or by +giving a start time and a duration (in HH:MM format). Use one or two +dash(es) as the separator in the former case and use =+= as the +separator in the latter case, e.g.: + +| =11am-1:15pm= | \rArr{} 11:00-13:15 | +| =11am--1:15pm= | \rArr{} same as above | +| =11am+2:15= | \rArr{} same as above | + +#+cindex: calendar, for selecting date +#+vindex: org-popup-calendar-for-date-prompt +Parallel to the minibuffer prompt, a calendar is popped up[fn:62]. +When you exit the date prompt, either by clicking on a date in the +calendar, or by pressing {{{kbd(RET)}}}, the date selected in the +calendar is combined with the information entered at the prompt. You +can control the calendar fully from the minibuffer: + +#+kindex: < +#+kindex: > +#+kindex: M-v +#+kindex: C-v +#+kindex: mouse-1 +#+kindex: S-RIGHT +#+kindex: S-LEFT +#+kindex: S-DOWN +#+kindex: S-UP +#+kindex: M-S-RIGHT +#+kindex: M-S-LEFT +#+kindex: RET +#+kindex: . +#+kindex: C-. +#+attr_texinfo: :columns 0.25 0.55 +| {{{kbd(RET)}}} | Choose date at point in calendar. | +| {{{kbd(mouse-1)}}} | Select date by clicking on it. | +| {{{kbd(S-RIGHT)}}} | One day forward. | +| {{{kbd(S-LEFT)}}} | One day backward. | +| {{{kbd(S-DOWN)}}} | One week forward. | +| {{{kbd(S-UP)}}} | One week backward. | +| {{{kbd(M-S-RIGHT)}}} | One month forward. | +| {{{kbd(M-S-LEFT)}}} | One month backward. | +| {{{kbd(>)}}} | Scroll calendar forward by one month. | +| {{{kbd(<)}}} | Scroll calendar backward by one month. | +| {{{kbd(M-v)}}} | Scroll calendar forward by 3 months. | +| {{{kbd(C-v)}}} | Scroll calendar backward by 3 months. | +| {{{kbd(C-.)}}} | Select today's date[fn:63] | + +#+vindex: org-read-date-display-live +The actions of the date/time prompt may seem complex, but I assure you +they will grow on you, and you will start getting annoyed by pretty +much any other way of entering a date/time out there. To help you +understand what is going on, the current interpretation of your input +is displayed live in the minibuffer[fn:64]. + +*** Custom time format +:PROPERTIES: +:DESCRIPTION: Making dates look different. +:END: +#+cindex: custom date/time format +#+cindex: time format, custom +#+cindex: date format, custom + +#+vindex: org-display-custom-times +#+vindex: org-time-stamp-custom-formats +Org mode uses the standard ISO notation for dates and times as it is +defined in ISO 8601. If you cannot get used to this and require +another representation of date and time to keep you happy, you can get +it by customizing the variables ~org-display-custom-times~ and +~org-time-stamp-custom-formats~. + +- {{{kbd(C-c C-x C-t)}}} (~org-toggle-time-stamp-overlays~) :: + + #+kindex: C-c C-x C-t + #+findex: org-toggle-time-stamp-overlays + Toggle the display of custom formats for dates and times. + +Org mode needs the default format for scanning, so the custom +date/time format does not /replace/ the default format. Instead, it +is put /over/ the default format using text properties. This has the +following consequences: + +- You cannot place point onto a timestamp anymore, only before or + after. + +- The {{{kbd(S-UP)}}} and {{{kbd(S-DOWN)}}} keys can no longer be used + to adjust each component of a timestamp. If point is at the + beginning of the stamp, {{{kbd(S-UP)}}} and {{{kbd(S-DOWN)}}} change + the stamp by one day, just like {{{kbd(S-LEFT)}}} + {{{kbd(S-RIGHT)}}}. At the end of the stamp, change the time by one + minute. + +- If the timestamp contains a range of clock times or a repeater, + these are not overlaid, but remain in the buffer as they were. + +- When you delete a timestamp character-by-character, it only + disappears from the buffer after /all/ (invisible) characters + belonging to the ISO timestamp have been removed. + +- If the custom timestamp format is longer than the default and you + are using dates in tables, table alignment will be messed up. If + the custom format is shorter, things do work as expected. + +** Deadlines and Scheduling +:PROPERTIES: +:DESCRIPTION: Planning your work. +:END: + +A timestamp may be preceded by special keywords to facilitate +planning. Both the timestamp and the keyword have to be positioned +immediately after the task they refer to. + +- =DEADLINE= :: + + #+cindex: @samp{DEADLINE} marker + Meaning: the task---most likely a TODO item, though not + necessarily---is supposed to be finished on that date. + + #+vindex: org-deadline-warning-days + On the deadline date, the task is listed in the agenda. In + addition, the agenda for /today/ carries a warning about the + approaching or missed deadline, starting ~org-deadline-warning-days~ + before the due date, and continuing until the entry is marked as + done. An example: + + #+begin_example + ,*** TODO write article about the Earth for the Guide + DEADLINE: <2004-02-29 Sun> + The editor in charge is [[bbdb:Ford Prefect]] + #+end_example + + #+vindex: org-agenda-skip-deadline-prewarning-if-scheduled + You can specify a different lead time for warnings for a specific + deadlines using the following syntax. Here is an example with + a warning period of 5 days =DEADLINE: <2004-02-29 Sun -5d>=. This + warning is deactivated if the task gets scheduled and you set + ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~. + +- =SCHEDULED= :: + + #+cindex: @samp{SCHEDULED} marker + Meaning: you are planning to start working on that task on the given + date. + + #+vindex: org-agenda-skip-scheduled-if-done + The headline is listed under the given date[fn:65]. In addition, + a reminder that the scheduled date has passed is present in the + compilation for /today/, until the entry is marked as done, i.e., + the task is automatically forwarded until completed. + + #+begin_example + ,*** TODO Call Trillian for a date on New Years Eve. + SCHEDULED: <2004-12-25 Sat> + #+end_example + + #+vindex: org-scheduled-delay-days + #+vindex: org-agenda-skip-scheduled-delay-if-deadline + If you want to /delay/ the display of this task in the agenda, use + =SCHEDULED: <2004-12-25 Sat -2d>=: the task is still scheduled on + the 25th but will appear two days later. In case the task contains + a repeater, the delay is considered to affect all occurrences; if + you want the delay to only affect the first scheduled occurrence of + the task, use =--2d= instead. See ~org-scheduled-delay-days~ and + ~org-agenda-skip-scheduled-delay-if-deadline~ for details on how to + control this globally or per agenda. + + #+attr_texinfo: :tag Important + #+begin_quote + Scheduling an item in Org mode should /not/ be understood in the + same way that we understand /scheduling a meeting/. Setting a date + for a meeting is just a simple appointment, you should mark this + entry with a simple plain timestamp, to get this item shown on the + date where it applies. This is a frequent misunderstanding by Org + users. In Org mode, /scheduling/ means setting a date when you want + to start working on an action item. + #+end_quote + +You may use timestamps with repeaters in scheduling and deadline +entries. Org mode issues early and late warnings based on the +assumption that the timestamp represents the /nearest instance/ of the +repeater. However, the use of diary expression entries like + +: <%%(diary-float t 42)> + +#+texinfo: @noindent +in scheduling and deadline timestamps is limited. Org mode does not +know enough about the internals of each function to issue early and +late warnings. However, it shows the item on each day where the +expression entry matches. + +*** Inserting deadlines or schedules +:PROPERTIES: +:DESCRIPTION: Planning items. +:ALT_TITLE: Inserting deadline/schedule +:END: + +The following commands allow you to quickly insert a deadline or to +schedule an item:[fn:66] + +- {{{kbd(C-c C-d)}}} (~org-deadline~) :: + + #+kindex: C-c C-d + #+findex: org-deadline + #+vindex: org-log-redeadline + Insert =DEADLINE= keyword along with a stamp. The insertion happens + in the line directly following the headline. Remove any =CLOSED= + timestamp . When called with a prefix argument, also remove any + existing deadline from the entry. Depending on the variable + ~org-log-redeadline~, take a note when changing an existing + deadline[fn:67]. + +- {{{kbd(C-c C-s)}}} (~org-schedule~) :: + + #+kindex: C-c C-s + #+findex: org-schedule + #+vindex: org-log-reschedule + Insert =SCHEDULED= keyword along with a stamp. The insertion + happens in the line directly following the headline. Remove any + =CLOSED= timestamp. When called with a prefix argument, also remove + the scheduling date from the entry. Depending on the variable + ~org-log-reschedule~, take a note when changing an existing + scheduling time[fn:68]. + +- {{{kbd(C-c / d)}}} (~org-check-deadlines~) :: + + #+kindex: C-c / d + #+findex: org-check-deadlines + #+cindex: sparse tree, for deadlines + #+vindex: org-deadline-warning-days + Create a sparse tree with all deadlines that are either past-due, or + which will become due within ~org-deadline-warning-days~. With + {{{kbd(C-u)}}} prefix, show all deadlines in the file. With + a numeric prefix, check that many days. For example, {{{kbd(C-1 C-c + / d)}}} shows all deadlines due tomorrow. + +- {{{kbd(C-c / b)}}} (~org-check-before-date~) :: + + #+kindex: C-c / b + #+findex: org-check-before-date + Sparse tree for deadlines and scheduled items before a given date. + +- {{{kbd(C-c / a)}}} (~org-check-after-date~) :: + + #+kindex: C-c / a + #+findex: org-check-after-date + Sparse tree for deadlines and scheduled items after a given date. + +Note that ~org-schedule~ and ~org-deadline~ supports setting the date +by indicating a relative time e.g., =+1d= sets the date to the next +day after today, and =--1w= sets the date to the previous week before +any current timestamp. + +*** Repeated tasks +:PROPERTIES: +:DESCRIPTION: Items that show up again and again. +:END: +#+cindex: tasks, repeated +#+cindex: repeated tasks + +Some tasks need to be repeated again and again. Org mode helps to +organize such tasks using a so-called repeater in a =DEADLINE=, +=SCHEDULED=, or plain timestamps[fn:69]. In the following example: + +#+begin_example +,** TODO Pay the rent + DEADLINE: <2005-10-01 Sat +1m> +#+end_example + +#+texinfo: @noindent +the =+1m= is a repeater; the intended interpretation is that the task +has a deadline on =<2005-10-01>= and repeats itself every (one) month +starting from that time. You can use yearly, monthly, weekly, daily +and hourly repeat cookies by using the =y=, =m=, =w=, =d= and =h= +letters. If you need both a repeater and a special warning period in +a deadline entry, the repeater should come first and the warning +period last + +: DEADLINE: <2005-10-01 Sat +1m -3d> + +#+vindex: org-todo-repeat-to-state +Deadlines and scheduled items produce entries in the agenda when they +are over-due, so it is important to be able to mark such an entry as +done once you have done so. When you mark a =DEADLINE= or +a =SCHEDULED= with the TODO keyword =DONE=, it no longer produces +entries in the agenda. The problem with this is, however, is that +then also the /next/ instance of the repeated entry will not be +active. Org mode deals with this in the following way: when you try +to mark such an entry as done, using {{{kbd(C-c C-t)}}}, it shifts the +base date of the repeating timestamp by the repeater interval, and +immediately sets the entry state back to TODO[fn:70]. In the example +above, setting the state to =DONE= would actually switch the date like +this: + +#+begin_example +,** TODO Pay the rent + DEADLINE: <2005-11-01 Tue +1m> +#+end_example + +To mark a task with a repeater as DONE, use {{{kbd(C-- 1 C-c C-t)}}}, +i.e., ~org-todo~ with a numeric prefix argument of =-1=. + +#+vindex: org-log-repeat +A timestamp[fn:71] is added under the deadline, to keep a record that +you actually acted on the previous instance of this deadline. + +As a consequence of shifting the base date, this entry is no longer +visible in the agenda when checking past dates, but all future +instances will be visible. + +With the =+1m= cookie, the date shift is always exactly one month. So +if you have not paid the rent for three months, marking this entry +DONE still keeps it as an overdue deadline. Depending on the task, +this may not be the best way to handle it. For example, if you forgot +to call your father for 3 weeks, it does not make sense to call him +3 times in a single day to make up for it. Finally, there are tasks, +like changing batteries, which should always repeat a certain time +/after/ the last time you did it. For these tasks, Org mode has +special repeaters =++= and =.+=. For example: + +#+begin_example +,** TODO Call Father + DEADLINE: <2008-02-10 Sun ++1w> + Marking this DONE shifts the date by at least one week, but also + by as many weeks as it takes to get this date into the future. + However, it stays on a Sunday, even if you called and marked it + done on Saturday. + +,** TODO Empty kitchen trash + DEADLINE: <2008-02-08 Fri 20:00 ++1d> + Marking this DONE shifts the date by at least one day, and also + by as many days as it takes to get the timestamp into the future. + Since there is a time in the timestamp, the next deadline in the + future will be on today's date if you complete the task before + 20:00. + +,** TODO Check the batteries in the smoke detectors + DEADLINE: <2005-11-01 Tue .+1m> + Marking this DONE shifts the date to one month after today. + +,** TODO Wash my hands + DEADLINE: <2019-04-05 08:00 Sun .+1h> + Marking this DONE shifts the date to exactly one hour from now. +#+end_example + +#+vindex: org-agenda-skip-scheduled-if-deadline-is-shown +You may have both scheduling and deadline information for a specific +task. If the repeater is set for the scheduling information only, you +probably want the repeater to be ignored after the deadline. If so, +set the variable ~org-agenda-skip-scheduled-if-deadline-is-shown~ to +~repeated-after-deadline~. However, any scheduling information +without a repeater is no longer relevant once the task is done, and +thus, removed upon repeating the task. If you want both scheduling +and deadline information to repeat after the same interval, set the +same repeater for both timestamps. + +An alternative to using a repeater is to create a number of copies of +a task subtree, with dates shifted in each copy. The command +{{{kbd(C-c C-x c)}}} was created for this purpose; it is described in +[[*Structure Editing]]. + +** Clocking Work Time +:PROPERTIES: +:DESCRIPTION: Tracking how long you spend on a task. +:END: +#+cindex: clocking time +#+cindex: time clocking + +Org mode allows you to clock the time you spend on specific tasks in +a project. When you start working on an item, you can start the +clock. When you stop working on that task, or when you mark the task +done, the clock is stopped and the corresponding time interval is +recorded. It also computes the total time spent on each +subtree[fn:72] of a project. And it remembers a history or tasks +recently clocked, so that you can jump quickly between a number of +tasks absorbing your time. + +To save the clock history across Emacs sessions, use: + +#+begin_src emacs-lisp +(setq org-clock-persist 'history) +(org-clock-persistence-insinuate) +#+end_src + +#+vindex: org-clock-persist +When you clock into a new task after resuming Emacs, the incomplete +clock[fn:73] is retrieved (see [[*Resolving idle time]]) and you are +prompted about what to do with it. + +*** Clocking commands +:PROPERTIES: +:DESCRIPTION: Starting and stopping a clock. +:END: + +#+attr_texinfo: :sep , +- {{{kbd(C-c C-x C-i)}}} (~org-clock-in~) :: + + #+kindex: C-c C-x C-i + #+findex: org-clock-in + #+vindex: org-clock-into-drawer + #+vindex: org-clock-continuously + #+cindex: @samp{LOG_INTO_DRAWER}, property + Start the clock on the current item (clock-in). This inserts the + =CLOCK= keyword together with a timestamp. If this is not the first + clocking of this item, the multiple =CLOCK= lines are wrapped into + a =LOGBOOK= drawer (see also the variable ~org-clock-into-drawer~). + You can also overrule the setting of this variable for a subtree by + setting a =CLOCK_INTO_DRAWER= or =LOG_INTO_DRAWER= property. When + called with a {{{kbd(C-u)}}} prefix argument, select the task from + a list of recently clocked tasks. With two {{{kbd(C-u C-u)}}} + prefixes, clock into the task at point and mark it as the default + task; the default task is always be available with letter + {{{kbd(d)}}} when selecting a clocking task. With three {{{kbd(C-u + C-u C-u)}}} prefixes, force continuous clocking by starting the + clock when the last clock stopped. + + #+cindex: @samp{CLOCK_MODELINE_TOTAL}, property + #+cindex: @samp{LAST_REPEAT}, property + #+vindex: org-clock-mode-line-total + #+vindex: org-clock-in-prepare-hook + While the clock is running, Org shows the current clocking time in + the mode line, along with the title of the task. The clock time + shown is all time ever clocked for this task and its children. If + the task has an effort estimate (see [[*Effort Estimates]]), the mode + line displays the current clocking time against it[fn:74]. If the + task is a repeating one (see [[*Repeated tasks]]), show only the time + since the last reset of the task[fn:75]. You can exercise more + control over show time with the =CLOCK_MODELINE_TOTAL= property. It + may have the values =current= to show only the current clocking + instance, =today= to show all time clocked on this tasks today---see + also the variable ~org-extend-today-until~, ~all~ to include all + time, or ~auto~ which is the default[fn:76]. Clicking with + {{{kbd(mouse-1)}}} onto the mode line entry pops up a menu with + clocking options. + +- {{{kbd(C-c C-x C-o)}}} (~org-clock-out~) :: + + #+kindex: C-c C-x C-o + #+findex: org-clock-out + #+vindex: org-log-note-clock-out + Stop the clock (clock-out). This inserts another timestamp at the + same location where the clock was last started. It also directly + computes the resulting time in inserts it after the time range as + ==>HH:MM=. See the variable ~org-log-note-clock-out~ for the + possibility to record an additional note together with the clock-out + timestamp[fn:77]. + +- {{{kbd(C-c C-x C-x)}}} (~org-clock-in-last~) :: + + #+kindex: C-c C-x C-x + #+findex: org-clock-in-last + #+vindex: org-clock-continuously + Re-clock the last clocked task. With one {{{kbd(C-u)}}} prefix + argument, select the task from the clock history. With two + {{{kbd(C-u)}}} prefixes, force continuous clocking by starting the + clock when the last clock stopped. + +- {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) :: + + #+kindex: C-c C-x C-e + #+findex: org-clock-modify-effort-estimate + Update the effort estimate for the current clock task. + +- {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) :: + + #+kindex: C-c C-c + #+kindex: C-c C-y + #+findex: org-evaluate-time-range + Recompute the time interval after changing one of the timestamps. + This is only necessary if you edit the timestamps directly. If you + change them with {{{kbd(S-<cursor>)}}} keys, the update is + automatic. + +- {{{kbd(C-S-UP)}}} (~org-clock-timestamps-up~), {{{kbd(C-S-DOWN)}}} (~org-clock-timestamps-down~) :: + + #+kindex: C-S-UP + #+findex: org-clock-timestamps-up + #+kindex: C-S-DOWN + #+findex: org-clock-timestamps-down + On CLOCK log lines, increase/decrease both timestamps so that the + clock duration keeps the same value. + +- {{{kbd(S-M-UP)}}} (~org-timestamp-up~), {{{kbd(S-M-DOWN)}}} (~org-timestamp-down~) :: + + #+kindex: S-M-UP + #+findex: org-clock-timestamp-up + #+kindex: S-M-DOWN + #+findex: org-clock-timestamp-down + On =CLOCK= log lines, increase/decrease the timestamp at point and + the one of the previous, or the next, clock timestamp by the same + duration. For example, if you hit {{{kbd(S-M-UP)}}} to increase + a clocked-out timestamp by five minutes, then the clocked-in + timestamp of the next clock is increased by five minutes. + +- {{{kbd(C-c C-t)}}} (~org-todo~) :: + + #+kindex: C-c C-t + #+findex: org-todo + Changing the TODO state of an item to DONE automatically stops the + clock if it is running in this same item. + +- {{{kbd(C-c C-x C-q)}}} (~org-clock-cancel~) :: + + #+kindex: C-c C-x C-q + #+findex: org-clock-cancel + Cancel the current clock. This is useful if a clock was started by + mistake, or if you ended up working on something else. + +- {{{kbd(C-c C-x C-j)}}} (~org-clock-goto~) :: + + #+kindex: C-c C-x C-j + #+findex: or-clock-goto + Jump to the headline of the currently clocked in task. With + a {{{kbd(C-u)}}} prefix argument, select the target task from a list + of recently clocked tasks. + +- {{{kbd(C-c C-x C-d)}}} (~org-clock-display~) :: + + #+kindex: C-c C-x C-d + #+findex: org-clock-display + #+vindex: org-remove-highlights-with-change + Display time summaries for each subtree in the current buffer. This + puts overlays at the end of each headline, showing the total time + recorded under that heading, including the time of any subheadings. + You can use visibility cycling to study the tree, but the overlays + disappear when you change the buffer (see variable + ~org-remove-highlights-with-change~) or press {{{kbd(C-c C-c)}}}. + +The {{{kbd(l)}}} key may be used in the agenda (see [[*Weekly/daily +agenda]]) to show which tasks have been worked on or closed during +a day. + +*Important:* note that both ~org-clock-out~ and ~org-clock-in-last~ +can have a global keybinding and do not modify the window disposition. + +*** The clock table +:PROPERTIES: +:DESCRIPTION: Detailed reports. +:END: +#+cindex: clocktable, dynamic block +#+cindex: report, of clocked time + +Org mode can produce quite complex reports based on the time clocking +information. Such a report is called a /clock table/, because it is +formatted as one or several Org tables. + +#+attr_texinfo: :sep , +- ~org-clock-report~ :: + + #+kindex: C-c C-x x + #+findex: org-clock-report + Insert or update a clock table. When called with a prefix argument, + jump to the first clock table in the current document and update it. + The clock table includes archived trees. + + This command can be invoked by calling + ~org-dynamic-block-insert-dblock~ ({{{kbd(C-c C-x x)}}}) and + selecting "clocktable" (see [[*Dynamic Blocks]]). + +- {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) :: + + #+kindex: C-c C-c + #+kindex: C-c C-x C-u + #+findex: org-dblock-update + Update dynamic block at point. Point needs to be in the =BEGIN= + line of the dynamic block. + +- {{{kbd(C-u C-c C-x C-u)}}} :: + + #+kindex: C-u C-c C-x C-u + Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful if + you have several clock table blocks in a buffer. + +- {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} (~org-clocktable-try-shift~) :: + + #+kindex: S-LEFT + #+kindex: S-RIGHT + #+findex: org-clocktable-try-shift + Shift the current =:block= interval and update the table. Point + needs to be in the =#+BEGIN: clocktable= line for this command. If + =:block= is =today=, it is shifted to =today-1=, etc. + +Here is an example of the frame for a clock table as it is inserted +into the buffer by ~org-clock-report~: + +#+cindex: @samp{BEGIN clocktable} +#+begin_example +,#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file +,#+END: clocktable +#+end_example + +#+vindex: org-clocktable-defaults +The =#+BEGIN= line contains options to define the scope, structure, +and formatting of the report. Defaults for all these options can be +configured in the variable ~org-clocktable-defaults~. + +First there are options that determine which clock entries are to +be selected: + +- =:maxlevel= :: + + Maximum level depth to which times are listed in the table. Clocks + at deeper levels are summed into the upper level. + +- =:scope= :: + + The scope to consider. This can be any of the following: + + | =nil= | the current buffer or narrowed region | + | =file= | the full current buffer | + | =subtree= | the subtree where the clocktable is located | + | =treeN= | the surrounding level N tree, for example =tree3= | + | =tree= | the surrounding level 1 tree | + | =agenda= | all agenda files | + | =("file" ...)= | scan these files | + | =FUNCTION= | scan files returned by calling {{{var(FUNCTION)}}} with no argument | + | =file-with-archives= | current file and its archives | + | =agenda-with-archives= | all agenda files, including archives | + +- =:block= :: + + The time block to consider. This block is specified either + absolutely, or relative to the current time and may be any of these + formats: + + | =2007-12-31= | New year eve 2007 | + | =2007-12= | December 2007 | + | =2007-W50= | ISO-week 50 in 2007 | + | =2007-Q2= | 2nd quarter in 2007 | + | =2007= | the year 2007 | + | =today=, =yesterday=, =today-N= | a relative day | + | =thisweek=, =lastweek=, =thisweek-N= | a relative week | + | =thismonth=, =lastmonth=, =thismonth-N= | a relative month | + | =thisyear=, =lastyear=, =thisyear-N= | a relative year | + | =untilnow=[fn:78] | all clocked time ever | + + #+vindex: org-clock-display-default-range + When this option is not set, Org falls back to the value in + ~org-clock-display-default-range~, which defaults to the current + year. + + Use {{{kbd(S-LEFT)}}} or {{{kbd(S-RIGHT)}}} to shift the time + interval. + +- =:tstart= :: + + A time string specifying when to start considering times. Relative + times like ="<-2w>"= can also be used. See [[*Matching tags and + properties]] for relative time syntax. + +- =:tend= :: + + A time string specifying when to stop considering times. Relative + times like ="<now>"= can also be used. See [[*Matching tags and + properties]] for relative time syntax. + +- =:wstart= :: + + The starting day of the week. The default is 1 for Monday. + +- =:mstart= :: + + The starting day of the month. The default is 1 for the first. + +- =:step= :: + + Set to =day=, =week=, =semimonth=, =month=, or =year= to split the + table into chunks. To use this, either =:block=, or =:tstart= and + =:tend= are required. + +- =:stepskip0= :: + + When non-~nil~, do not show steps that have zero time. + +- =:fileskip0= :: + + When non-~nil~, do not show table sections from files which did not + contribute. + +- =:match= :: + + A tags match to select entries that should contribute. See + [[*Matching tags and properties]] for the match syntax. + +#+findex: org-clocktable-write-default +Then there are options that determine the formatting of the table. +There options are interpreted by the function +~org-clocktable-write-default~, but you can specify your own function +using the =:formatter= parameter. + +- =:emphasize= :: + + When non-~nil~, emphasize level one and level two items. + +- =:lang= :: + + Language[fn:79] to use for descriptive cells like "Task". + +- =:link= :: + + Link the item headlines in the table to their origins. + +- =:narrow= :: + + An integer to limit the width of the headline column in the Org + table. If you write it like =50!=, then the headline is also + shortened in export. + +- =:indent= :: + + Indent each headline field according to its level. + +- =:hidefiles= :: + + Hide the file column when multiple files are used to produce the + table. + +- =:tcolumns= :: + + Number of columns to be used for times. If this is smaller than + =:maxlevel=, lower levels are lumped into one column. + +- =:level= :: + + Should a level number column be included? + +- =:sort= :: + + A cons cell containing the column to sort and a sorting type. E.g., + =:sort (1 . ?a)= sorts the first column alphabetically. + +- =:compact= :: + + Abbreviation for =:level nil :indent t :narrow 40! :tcolumns 1=. + All are overwritten except if there is an explicit =:narrow=. + +- =:timestamp= :: + + A timestamp for the entry, when available. Look for =SCHEDULED=, + =DEADLINE=, =TIMESTAMP= and =TIMESTAMP_IA= special properties (see + [[*Special Properties]]), in this order. + +- =:tags= :: + + When this flag is non-~nil~, show the headline's tags. + +- =:properties= :: + + List of properties shown in the table. Each property gets its own + column. + +- =:inherit-props= :: + + When this flag is non-~nil~, the values for =:properties= are + inherited. + +- =:formula= :: + + Content of a =TBLFM= keyword to be added and evaluated. As + a special case, =:formula %= adds a column with % time. If you do + not specify a formula here, any existing formula below the clock + table survives updates and is evaluated. + +- =:formatter= :: + + A function to format clock data and insert it into the buffer. + +To get a clock summary of the current level 1 tree, for the current +day, you could write: + +#+begin_example +,#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t +,#+END: clocktable +#+end_example + +#+texinfo: @noindent +To use a specific time range you could write[fn:80] + +#+begin_example +,#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" + :tend "<2006-08-10 Thu 12:00>" +,#+END: clocktable +#+end_example + +#+texinfo: @noindent +A range starting a week ago and ending right now could be written as + +#+begin_example +,#+BEGIN: clocktable :tstart "<-1w>" :tend "<now>" +,#+END: clocktable +#+end_example + +#+texinfo: @noindent +A summary of the current subtree with % times would be + +#+begin_example +,#+BEGIN: clocktable :scope subtree :link t :formula % +,#+END: clocktable +#+end_example + +#+texinfo: @noindent +A horizontally compact representation of everything clocked during +last week would be + +#+begin_example +,#+BEGIN: clocktable :scope agenda :block lastweek :compact t +,#+END: clocktable +#+end_example + +*** Resolving idle time and continuous clocking +:PROPERTIES: +:DESCRIPTION: Resolving time when you've been idle. +:ALT_TITLE: Resolving idle time +:END: + +**** Resolving idle time +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: resolve idle time +#+cindex: idle, resolve, dangling + +If you clock in on a work item, and then walk away from your +computer---perhaps to take a phone call---you often need to +"resolve" the time you were away by either subtracting it from the +current clock, or applying it to another one. + +#+vindex: org-clock-idle-time +#+vindex: org-clock-x11idle-program-name +By customizing the variable ~org-clock-idle-time~ to some integer, +such as 10 or 15, Emacs can alert you when you get back to your +computer after being idle for that many minutes[fn:81], and ask what +you want to do with the idle time. There will be a question waiting +for you when you get back, indicating how much idle time has passed +constantly updated with the current amount, as well as a set of +choices to correct the discrepancy: + +- {{{kbd(k)}}} :: + + #+kindex: k + To keep some or all of the minutes and stay clocked in, press + {{{kbd(k)}}}. Org asks how many of the minutes to keep. Press + {{{kbd(RET)}}} to keep them all, effectively changing nothing, or + enter a number to keep that many minutes. + +- {{{kbd(K)}}} :: + + #+kindex: K + If you use the shift key and press {{{kbd(K)}}}, it keeps however + many minutes you request and then immediately clock out of that + task. If you keep all of the minutes, this is the same as just + clocking out of the current task. + +- {{{kbd(s)}}} :: + + #+kindex: s + To keep none of the minutes, use {{{kbd(s)}}} to subtract all the + away time from the clock, and then check back in from the moment you + returned. + +- {{{kbd(S)}}} :: + + #+kindex: S + To keep none of the minutes and just clock out at the start of the + away time, use the shift key and press {{{kbd(S)}}}. Remember that + using shift always leave you clocked out, no matter which option you + choose. + +- {{{kbd(C)}}} :: + + #+kindex: C + To cancel the clock altogether, use {{{kbd(C)}}}. Note that if + instead of canceling you subtract the away time, and the resulting + clock amount is less than a minute, the clock is still canceled + rather than cluttering up the log with an empty entry. + +What if you subtracted those away minutes from the current clock, and +now want to apply them to a new clock? Simply clock in to any task +immediately after the subtraction. Org will notice that you have +subtracted time "on the books", so to speak, and will ask if you want +to apply those minutes to the next task you clock in on. + +There is one other instance when this clock resolution magic occurs. +Say you were clocked in and hacking away, and suddenly your cat chased +a mouse who scared a hamster that crashed into your UPS's power +button! You suddenly lose all your buffers, but thanks to auto-save +you still have your recent Org mode changes, including your last clock +in. + +If you restart Emacs and clock into any task, Org will notice that you +have a dangling clock which was never clocked out from your last +session. Using that clock's starting time as the beginning of the +unaccounted-for period, Org will ask how you want to resolve that +time. The logic and behavior is identical to dealing with away time +due to idleness; it is just happening due to a recovery event rather +than a set amount of idle time. + +You can also check all the files visited by your Org agenda for +dangling clocks at any time using {{{kbd(M-x org-resolve-clocks +RET)}}} (or {{{kbd(C-c C-x C-z)}}}). + +**** Continuous clocking +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: continuous clocking + +#+vindex: org-clock-continuously +You may want to start clocking from the time when you clocked out the +previous task. To enable this systematically, set +~org-clock-continuously~ to non-~nil~. Each time you clock in, Org +retrieves the clock-out time of the last clocked entry for this +session, and start the new clock from there. + +If you only want this from time to time, use three universal prefix +arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with +~org-clock-in-last~. + +**** Clocking out automatically after some idle time +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: auto clocking out after idle time + +#+vindex: org-clock-auto-clockout-timer +When you often forget to clock out before being idle and you don't +want to manually set the clocking time to take into account, you can +set ~org-clock-auto-clockout-timer~ to a number of seconds and add +=(org-clock-auto-clockout-insinuate)= to your =.emacs= file. + +When the clock is running and Emacs is idle for more than this number +of seconds, the clock will be clocked out automatically. + +Use =M-x org-clock-toggle-auto-clockout RET= to temporarily turn this +on or off. + +** Effort Estimates +:PROPERTIES: +:DESCRIPTION: Planning work effort in advance. +:END: +#+cindex: effort estimates +#+cindex: @samp{EFFORT}, property +#+vindex: org-effort-property + +If you want to plan your work in a very detailed way, or if you need +to produce offers with quotations of the estimated work effort, you +may want to assign effort estimates to entries. If you are also +clocking your work, you may later want to compare the planned effort +with the actual working time, a great way to improve planning +estimates. + +Effort estimates are stored in a special property =EFFORT=. Multiple +formats are supported, such as =3:12=, =1:23:45=, or =1d3h5min=; see +the file =org-duration.el= for more detailed information about the +format. + +You can set the effort for an entry with the following commands: + +- {{{kbd(C-c C-x e)}}} (~org-set-effort~) :: + + #+kindex: C-c C-x e + #+findex: org-set-effort + Set the effort estimate for the current entry. With a prefix + argument, set it to the next allowed value---see below. This + command is also accessible from the agenda with the {{{kbd(e)}}} + key. + +- {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) :: + + #+kindex: C-c C-x C-e + #+findex: org-clock-modify-effort-estimate + Modify the effort estimate of the item currently being clocked. + +Clearly the best way to work with effort estimates is through column +view (see [[*Column View]]). You should start by setting up discrete +values for effort estimates, and a =COLUMNS= format that displays +these values together with clock sums---if you want to clock your +time. For a specific buffer you can use: + +#+begin_example +,#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 +,#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort){:} %CLOCKSUM +#+end_example + +#+texinfo: @noindent +#+vindex: org-global-properties +#+vindex: org-columns-default-format +or, even better, you can set up these values globally by customizing +the variables ~org-global-properties~ and +~org-columns-default-format~. In particular if you want to use this +setup also in the agenda, a global setup may be advised. + +The way to assign estimates to individual items is then to switch to +column mode, and to use {{{kbd(S-RIGHT)}}} and {{{kbd(S-LEFT)}}} to +change the value. The values you enter are immediately summed up in +the hierarchy. In the column next to it, any clocked time is +displayed. + +#+vindex: org-agenda-columns-add-appointments-to-effort-sum +If you switch to column view in the daily/weekly agenda, the effort +column summarizes the estimated work effort for each day[fn:82], and +you can use this to find space in your schedule. To get an overview +of the entire part of the day that is committed, you can set the +option ~org-agenda-columns-add-appointments-to-effort-sum~. The +appointments on a day that take place over a specified time interval +are then also added to the load estimate of the day. + +Effort estimates can be used in secondary agenda filtering that is +triggered with the {{{kbd(/)}}} key in the agenda (see [[*Commands in +the Agenda Buffer]]). If you have these estimates defined consistently, +two or three key presses narrow down the list to stuff that fits into +an available time slot. + +** Taking Notes with a Relative Timer +:PROPERTIES: +:DESCRIPTION: Notes with a running timer. +:ALT_TITLE: Timers +:END: +#+cindex: relative timer +#+cindex: countdown timer + +Org provides two types of timers. There is a relative timer that +counts up, which can be useful when taking notes during, for example, +a meeting or a video viewing. There is also a countdown timer. + +The relative and countdown are started with separate commands. + +- {{{kbd(C-c C-x 0)}}} (~org-timer-start~) :: + + #+kindex: C-c C-x 0 + #+findex: org-timer-start + Start or reset the relative timer. By default, the timer is set + to 0. When called with a {{{kbd(C-u)}}} prefix, prompt the user for + a starting offset. If there is a timer string at point, this is + taken as the default, providing a convenient way to restart taking + notes after a break in the process. When called with a double + prefix argument {{{kbd(C-u C-u)}}}, change all timer strings in the + active region by a certain amount. This can be used to fix timer + strings if the timer was not started at exactly the right moment. + +- {{{kbd(C-c C-x ;)}}} (~org-timer-set-timer~) :: + + #+kindex: C-c C-x ; + #+findex: org-timer-set-timer + #+vindex: org-timer-default-timer + Start a countdown timer. The user is prompted for a duration. + ~org-timer-default-timer~ sets the default countdown value. Giving + a numeric prefix argument overrides this default value. This + command is available as {{{kbd(;)}}} in agenda buffers. + +Once started, relative and countdown timers are controlled with the +same commands. + +- {{{kbd(C-c C-x .)}}} (~org-timer~) :: + + #+kindex: C-c C-x . + #+findex: org-timer + Insert a relative time into the buffer. The first time you use + this, the timer starts. Using a prefix argument restarts it. + +- {{{kbd(C-c C-x -)}}} (~org-timer-item~) :: + + #+kindex: C-c C-x - + #+findex: org-timer-item + Insert a description list item with the current relative time. With + a prefix argument, first reset the timer to 0. + +- {{{kbd(M-RET)}}} (~org-insert-heading~) :: + + #+kindex: M-RET + #+findex: org-insert-heading + Once the timer list is started, you can also use {{{kbd(M-RET)}}} to + insert new timer items. + +- {{{kbd(C-c C-x \,)}}} (~org-timer-pause-or-continue~) :: + + #+kindex: C-c C-x , + #+findex: org-timer-pause-or-continue + Pause the timer, or continue it if it is already paused. + +- {{{kbd(C-c C-x _)}}} (~org-timer-stop~) :: + + #+kindex: C-c C-x _ + #+findex: org-timer-stop + Stop the timer. After this, you can only start a new timer, not + continue the old one. This command also removes the timer from the + mode line. + +* Refiling and Archiving +:PROPERTIES: +:DESCRIPTION: Moving and copying information with ease. +:END: +#+cindex: refiling notes +#+cindex: copying notes +#+cindex: archiving + +Once information is in the system, it may need to be moved around. +Org provides Refile, Copy and Archive commands for this. Refile and +Copy helps with moving and copying outlines. Archiving helps to keep +the system compact and fast. + +** Refile and Copy +:PROPERTIES: +:DESCRIPTION: Moving/copying a tree from one place to another. +:END: +#+cindex: refiling notes +#+cindex: copying notes + +When reviewing the captured data, you may want to refile or to copy +some of the entries into a different list, for example into a project. +Cutting, finding the right location, and then pasting the note is +cumbersome. To simplify this process, you can use the following +special command: + +- {{{kbd(C-c C-w)}}} (~org-refile~) :: + + #+kindex: C-c C-w + #+findex: org-refile + #+vindex: org-reverse-note-order + #+vindex: org-refile-targets + #+vindex: org-refile-use-outline-path + #+vindex: org-outline-path-complete-in-steps + #+vindex: org-refile-allow-creating-parent-nodes + #+vindex: org-log-refile + Refile the entry or region at point. This command offers possible + locations for refiling the entry and lets you select one with + completion. The item (or all items in the region) is filed below + the target heading as a subitem. Depending on + ~org-reverse-note-order~, it is either the first or last subitem. + + By default, all level 1 headlines in the current buffer are + considered to be targets, but you can have more complex definitions + across a number of files. See the variable ~org-refile-targets~ for + details. If you would like to select a location via + a file-path-like completion along the outline path, see the + variables ~org-refile-use-outline-path~ and + ~org-outline-path-complete-in-steps~. If you would like to be able + to create new nodes as new parents for refiling on the fly, check + the variable ~org-refile-allow-creating-parent-nodes~. When the + variable ~org-log-refile~[fn:83] is set, a timestamp or a note is + recorded whenever an entry is refiled. + +- {{{kbd(C-u C-c C-w)}}} :: + + #+kindex: C-u C-c C-w + Use the refile interface to jump to a heading. + +- {{{kbd(C-u C-u C-c C-w)}}} (~org-refile-goto-last-stored~) :: + + #+kindex: C-u C-u C-c C-w + #+findex: org-refile-goto-last-stored + Jump to the location where ~org-refile~ last moved a tree to. + +- {{{kbd(C-2 C-c C-w)}}} :: + + #+kindex: C-2 C-c C-w + Refile as the child of the item currently being clocked. + +- {{{kbd(C-3 C-c C-w)}}} :: + + #+kindex: C-3 C-c C-w + #+vindex: org-refile-keep + Refile and keep the entry in place. Also see ~org-refile-keep~ to + make this the default behavior, and beware that this may result in + duplicated =ID= properties. + +- {{{kbd(C-0 C-c C-w)}}} or {{{kbd(C-u C-u C-u C-c C-w)}}} (~org-refile-cache-clear~) :: + + #+kindex: C-u C-u C-u C-c C-w + #+kindex: C-0 C-c C-w + #+findex: org-refile-cache-clear + #+vindex: org-refile-use-cache + Clear the target cache. Caching of refile targets can be turned on + by setting ~org-refile-use-cache~. To make the command see new + possible targets, you have to clear the cache with this command. + +- {{{kbd(C-c M-w)}}} (~org-refile-copy~) :: + + #+kindex: C-c M-w + #+findex: org-refile-copy + Copying works like refiling, except that the original note is not + deleted. + +** Archiving +:PROPERTIES: +:DESCRIPTION: What to do with finished products. +:END: +#+cindex: archiving + +When a project represented by a (sub)tree is finished, you may want to +move the tree out of the way and to stop it from contributing to the +agenda. Archiving is important to keep your working files compact and +global searches like the construction of agenda views fast. + +- {{{kbd(C-c C-x C-a)}}} (~org-archive-subtree-default~) :: + + #+kindex: C-c C-x C-a + #+findex: org-archive-subtree-default + #+vindex: org-archive-default-command + Archive the current entry using the command specified in the + variable ~org-archive-default-command~. + +*** Moving a tree to an archive file +:PROPERTIES: +:DESCRIPTION: Moving a tree to an archive file. +:ALT_TITLE: Moving subtrees +:END: +#+cindex: external archiving + +The most common archiving action is to move a project tree to another +file, the archive file. + +- {{{kbd(C-c C-x C-s)}}} or short {{{kbd(C-c $)}}} (~org-archive-subtree~) :: + + #+kindex: C-c C-x C-s + #+kindex: C-c $ + #+findex: org-archive-subtree + #+vindex: org-archive-location + Archive the subtree starting at point position to the location given + by ~org-archive-location~. + +- {{{kbd(C-u C-c C-x C-s)}}} :: + + #+kindex: C-u C-c C-x C-s + Check if any direct children of the current headline could be moved + to the archive. To do this, check each subtree for open TODO + entries. If none is found, the command offers to move it to the + archive location. If point is /not/ on a headline when this command + is invoked, check level 1 trees. + +- {{{kbd(C-u C-u C-c C-x C-s)}}} :: + + #+kindex: C-u C-u C-c C-x C-s + As above, but check subtree for timestamps instead of TODO entries. + The command offers to archive the subtree if it /does/ contain + a timestamp, and that timestamp is in the past. + +#+cindex: archive locations +The default archive location is a file in the same directory as the +current file, with the name derived by appending =_archive= to the +current file name. You can also choose what heading to file archived +items under, with the possibility to add them to a datetree in a file. +For information and examples on how to specify the file and the +heading, see the documentation string of the variable +~org-archive-location~. + +There is also an in-buffer option for setting this variable, for +example: + +#+cindex: @samp{ARCHIVE}, keyword +: #+ARCHIVE: %s_done:: + +#+cindex: ARCHIVE, property +If you would like to have a special archive location for a single +entry or a (sub)tree, give the entry an =ARCHIVE= property with the +location as the value (see [[*Properties and Columns]]). + +#+vindex: org-archive-save-context-info +When a subtree is moved, it receives a number of special properties +that record context information like the file from where the entry +came, its outline path the archiving time etc. Configure the variable +~org-archive-save-context-info~ to adjust the amount of information +added. + +#+vindex: org-archive-subtree-save-file-p +When ~org-archive-subtree-save-file-p~ is non-~nil~, save the target +archive buffer. + +*** Internal archiving +:PROPERTIES: +:DESCRIPTION: Switch off a tree but keep it in the file. +:END: + +#+cindex: @samp{ARCHIVE}, tag +If you want to just switch off---for agenda views---certain subtrees +without moving them to a different file, you can use the =ARCHIVE= +tag. + +A headline that is marked with the =ARCHIVE= tag (see [[*Tags]]) stays at +its location in the outline tree, but behaves in the following way: + +- + #+vindex: org-cycle-open-archived-trees + It does not open when you attempt to do so with a visibility cycling + command (see [[*Visibility Cycling]]). You can force cycling archived + subtrees with {{{kbd(C-TAB)}}}, or by setting the option + ~org-cycle-open-archived-trees~. Also normal outline commands, like + ~outline-show-all~, open archived subtrees. + +- + #+vindex: org-sparse-tree-open-archived-trees + During sparse tree construction (see [[*Sparse Trees]]), matches in + archived subtrees are not exposed, unless you configure the option + ~org-sparse-tree-open-archived-trees~. + +- + #+vindex: org-agenda-skip-archived-trees + During agenda view construction (see [[*Agenda Views]]), the content of + archived trees is ignored unless you configure the option + ~org-agenda-skip-archived-trees~, in which case these trees are + always included. In the agenda you can press {{{kbd(v a)}}} to get + archives temporarily included. + +- + #+vindex: org-export-with-archived-trees + Archived trees are not exported (see [[*Exporting]]), only the headline + is. Configure the details using the variable + ~org-export-with-archived-trees~. + +- + #+vindex: org-columns-skip-archived-trees + Archived trees are excluded from column view unless the variable + ~org-columns-skip-archived-trees~ is configured to ~nil~. + +The following commands help manage the =ARCHIVE= tag: + +- {{{kbd(C-c C-x a)}}} (~org-toggle-archive-tag~) :: + + #+kindex: C-c C-x a + #+findex: org-toggle-archive-tag + Toggle the archive tag for the current headline. When the tag is + set, the headline changes to a shadowed face, and the subtree below + it is hidden. + +- {{{kbd(C-u C-c C-x a)}}} :: + + #+kindex: C-u C-c C-x a + Check if any direct children of the current headline should be + archived. To do this, check each subtree for open TODO entries. If + none is found, the command offers to set the =ARCHIVE= tag for the + child. If point is /not/ on a headline when this command is + invoked, check the level 1 trees. + +- {{{kbd(C-c C-TAB)}}} (~org-force-cycle-archived~) :: + + #+kindex: C-TAB + Cycle a tree even if it is tagged with =ARCHIVE=. + +- {{{kbd(C-c C-x A)}}} (~org-archive-to-archive-sibling~) :: + + #+kindex: C-c C-x A + #+findex: org-archive-to-archive-sibling + Move the current entry to the /Archive Sibling/. This is a sibling + of the entry with the heading =Archive= and the archive tag. The + entry becomes a child of that sibling and in this way retains a lot + of its original context, including inherited tags and approximate + position in the outline. + +* Capture and Attachments +:PROPERTIES: +:DESCRIPTION: Dealing with external data. +:END: +#+cindex: capture +#+cindex: attachments +#+cindex: RSS feeds +#+cindex: Atom feeds +#+cindex: protocols, for external access + +An important part of any organization system is the ability to quickly +capture new ideas and tasks, and to associate reference material with +them. Org does this using a process called /capture/. It also can +store files related to a task (/attachments/) in a special directory. +Finally, it can parse RSS feeds for information. To learn how to let +external programs (for example a web browser) trigger Org to capture +material, see [[*Protocols for External Access]]. + +** Capture +:PROPERTIES: +:DESCRIPTION: Capturing new stuff. +:END: +#+cindex: capture + +Capture lets you quickly store notes with little interruption of your +work flow. Org's method for capturing new items is heavily inspired +by John Wiegley's excellent Remember package. + +*** Setting up capture +:PROPERTIES: +:DESCRIPTION: Where notes will be stored. +:END: + +The following customization sets a default target file for notes. + +#+vindex: org-default-notes-file +#+begin_src emacs-lisp +(setq org-default-notes-file (concat org-directory "/notes.org")) +#+end_src + +You may also define a global key for capturing new material (see +[[*Activation]]). + +*** Using capture +:PROPERTIES: +:DESCRIPTION: Commands to invoke and terminate capture. +:END: + +- {{{kbd(M-x org-capture)}}} (~org-capture~) :: + + #+findex: org-capture + #+cindex: date tree + Display the capture templates menu. If you have templates defined + (see [[*Capture templates]]), it offers these templates for selection or + use a new Org outline node as the default template. It inserts the + template into the target file and switch to an indirect buffer + narrowed to this new node. You may then insert the information you + want. + +- {{{kbd(C-c C-c)}}} (~org-capture-finalize~) :: + + #+kindex: C-c C-c @r{(Capture buffer)} + #+findex: org-capture-finalize + Once you have finished entering information into the capture buffer, + {{{kbd(C-c C-c)}}} returns you to the window configuration before + the capture process, so that you can resume your work without + further distraction. When called with a prefix argument, finalize + and then jump to the captured item. + +- {{{kbd(C-c C-w)}}} (~org-capture-refile~) :: + + #+kindex: C-c C-w @r{(Capture buffer)} + #+findex: org-capture-refile + Finalize the capture process by refiling the note to a different + place (see [[*Refile and Copy]]). Please realize that this is a normal + refiling command that will be executed---so point position at the + moment you run this command is important. If you have inserted + a tree with a parent and children, first move point back to the + parent. Any prefix argument given to this command is passed on to + the ~org-refile~ command. + +- {{{kbd(C-c C-k)}}} (~org-capture-kill~) :: + + #+kindex: C-c C-k @r{(Capture buffer)} + #+findex: org-capture-kill + Abort the capture process and return to the previous state. + +#+kindex: k c @r{(Agenda)} +You can also call ~org-capture~ in a special way from the agenda, +using the {{{kbd(k c)}}} key combination. With this access, any +timestamps inserted by the selected capture template defaults to the +date at point in the agenda, rather than to the current date. + +To find the locations of the last stored capture, use ~org-capture~ +with prefix commands: + +- {{{kbd(C-u M-x org-capture)}}} :: + + Visit the target location of a capture template. You get to select + the template in the usual way. + +- {{{kbd(C-u C-u M-x org-capture)}}} :: + + Visit the last stored capture item in its buffer. + +#+vindex: org-capture-bookmark +#+vindex: org-capture-last-stored +You can also jump to the bookmark ~org-capture-last-stored~, which is +automatically created unless you set ~org-capture-bookmark~ to ~nil~. + +To insert the capture at point in an Org buffer, call ~org-capture~ +with a {{{kbd(C-0)}}} prefix argument. + +*** Capture templates +:PROPERTIES: +:DESCRIPTION: Define the outline of different note types. +:END: +#+cindex: templates, for Capture + +You can use templates for different types of capture items, and for +different target locations. The easiest way to create such templates +is through the customize interface. + +- {{{kbd(C)}}} :: + + #+kindex: C @r{(Capture menu} + #+vindex: org-capture-templates + Customize the variable ~org-capture-templates~. + +Before we give the formal description of template definitions, let's +look at an example. Say you would like to use one template to create +general TODO entries, and you want to put these entries under the +heading =Tasks= in your file =~/org/gtd.org=. Also, a date tree in +the file =journal.org= should capture journal entries. A possible +configuration would look like: + +#+begin_src emacs-lisp +(setq org-capture-templates + '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") + "* TODO %?\n %i\n %a") + ("j" "Journal" entry (file+datetree "~/org/journal.org") + "* %?\nEntered on %U\n %i\n %a"))) +#+end_src + +If you then press {{{kbd(t)}}} from the capture menu, Org will prepare +the template for you like this: + +#+begin_example +,* TODO + [[file:LINK TO WHERE YOU INITIATED CAPTURE]] +#+end_example + +#+texinfo: @noindent +During expansion of the template, =%a= has been replaced by a link to +the location from where you called the capture command. This can be +extremely useful for deriving tasks from emails, for example. You +fill in the task definition, press {{{kbd(C-c C-c)}}} and Org returns +you to the same place where you started the capture process. + +To define special keys to capture to a particular template without +going through the interactive template selection, you can create your +key binding like this: + +#+begin_src emacs-lisp +(define-key global-map (kbd "C-c x") + (lambda () (interactive) (org-capture nil "x"))) +#+end_src + +**** Template elements +:PROPERTIES: +:DESCRIPTION: What is needed for a complete template entry. +:END: + +Now lets look at the elements of a template definition. Each entry in +~org-capture-templates~ is a list with the following items: + +- keys :: + + The keys that selects the template, as a string, characters only, + for example ="a"=, for a template to be selected with a single key, + or ="bt"= for selection with two keys. When using several keys, + keys using the same prefix key must be sequential in the list and + preceded by a 2-element entry explaining the prefix key, for + example: + + #+begin_src emacs-lisp + ("b" "Templates for marking stuff to buy") + #+end_src + + If you do not define a template for the {{{kbd(C)}}} key, this key + opens the Customize buffer for this complex variable. + +- description :: + + A short string describing the template, shown during selection. + +- type :: + + The type of entry, a symbol. Valid values are: + + - ~entry~ :: + + An Org mode node, with a headline. Will be filed as the child of + the target entry or as a top-level entry. The target file should + be an Org file. + + - ~item~ :: + + A plain list item, placed in the first plain list at the target + location. Again the target file should be an Org file. + + - ~checkitem~ :: + + A checkbox item. This only differs from the plain list item by + the default template. + + - ~table-line~ :: + + A new line in the first table at the target location. Where + exactly the line will be inserted depends on the properties + ~:prepend~ and ~:table-line-pos~ (see below). + + - ~plain~ :: + + Text to be inserted as it is. + +- target :: + + #+vindex: org-default-notes-file + #+vindex: org-directory + Specification of where the captured item should be placed. In Org + files, targets usually define a node. Entries will become children + of this node. Other types will be added to the table or list in the + body of this node. Most target specifications contain a file name. + If that file name is the empty string, it defaults to + ~org-default-notes-file~. A file can also be given as a variable or + as a function called with no argument. When an absolute path is not + specified for a target, it is taken as relative to ~org-directory~. + + Valid values are: + + - =(file "path/to/file")= :: + + Text will be placed at the beginning or end of that file. + + - =(id "id of existing org entry")= :: + + Filing as child of this entry, or in the body of the entry. + + - =(file+headline "filename" "node headline")= :: + + Fast configuration if the target heading is unique in the file. + + - =(file+olp "filename" "Level 1 heading" "Level 2" ...)= :: + + For non-unique headings, the full path is safer. + + - =(file+regexp "filename" "regexp to find location")= :: + + Use a regular expression to position point. + + - =(file+olp+datetree "filename" [ "Level 1 heading" ...])= :: + + This target[fn:84] creates a heading in a date tree[fn:85] for + today's date. If the optional outline path is given, the tree + will be built under the node it is pointing to, instead of at top + level. Check out the ~:time-prompt~ and ~:tree-type~ properties + below for additional options. + + - =(file+function "filename" function-finding-location)= :: + + A function to find the right location in the file. + + - =(clock)= :: + + File to the entry that is currently being clocked. + + - =(function function-finding-location)= :: + + Most general way: write your own function which both visits the + file and moves point to the right location. + +- template :: + + The template for creating the capture item. If you leave this + empty, an appropriate default template will be used. Otherwise this + is a string with escape codes, which will be replaced depending on + time and context of the capture call. You may also get this + template string from a file[fn:86], or dynamically, from a function + using either syntax: + + : (file "/path/to/template-file") + : (function FUNCTION-RETURNING-THE-TEMPLATE) + +- properties :: + + The rest of the entry is a property list of additional options. + Recognized properties are: + + - ~:prepend~ :: + + Normally new captured information will be appended at the target + location (last child, last table line, last list item, ...). + Setting this property changes that. + + - ~:immediate-finish~ :: + + When set, do not offer to edit the information, just file it away + immediately. This makes sense if the template only needs + information that can be added automatically. + + - ~:jump-to-captured~ :: + + When set, jump to the captured entry when finished. + + - ~:empty-lines~ :: + + Set this to the number of lines to insert before and after the new + item. Default 0, and the only other common value is 1. + + - ~:empty-lines-after~ :: + + Set this to the number of lines that should be inserted after the + new item. Overrides ~:empty-lines~ for the number of lines + inserted after. + + - ~:empty-lines-before~ :: + + Set this to the number of lines that should be inserted before the + new item. Overrides ~:empty-lines~ for the number lines inserted + before. + + - ~:clock-in~ :: + + Start the clock in this item. + + - ~:clock-keep~ :: + + Keep the clock running when filing the captured entry. + + - ~:clock-resume~ :: + + If starting the capture interrupted a clock, restart that clock + when finished with the capture. Note that ~:clock-keep~ has + precedence over ~:clock-resume~. When setting both to non-~nil~, + the current clock will run and the previous one will not be + resumed. + + - ~:time-prompt~ :: + + Prompt for a date/time to be used for date/week trees and when + filling the template. Without this property, capture uses the + current date and time. Even if this property has not been set, + you can force the same behavior by calling ~org-capture~ with + a {{{kbd(C-1)}}} prefix argument. + + - ~:tree-type~ :: + + Use ~week~ to make a week tree instead of the month-day tree, + i.e., place the headings for each day under a heading with the + current ISO week. Use ~month~ to group entries by month + only. Default is to group entries by day. + + - ~:unnarrowed~ :: + + Do not narrow the target buffer, simply show the full buffer. + Default is to narrow it so that you only see the new material. + + - ~:table-line-pos~ :: + + Specification of the location in the table where the new line + should be inserted. It should be a string like =II-3= meaning + that the new line should become the third line before the second + horizontal separator line. + + - ~:kill-buffer~ :: + + If the target file was not yet visited when capture was invoked, + kill the buffer again after capture is completed. + + - ~:no-save~ :: + + Do not save the target file after finishing the capture. + +**** Template expansion +:PROPERTIES: +:DESCRIPTION: Filling in information about time and context. +:END: + +In the template itself, special "%-escapes"[fn:87] allow dynamic +insertion of content. The templates are expanded in the order given +here: + +- =%[FILE]= :: + + Insert the contents of the file given by {{{var(FILE)}}}. + +- =%(EXP)= :: + + Evaluate Elisp expression {{{var(EXP)}}} and replace it with the + result. The {{{var(EXP)}}} form must return a string. Only + placeholders pre-existing within the template, or introduced with + =%[file]=, are expanded this way. Since this happens after + expanding non-interactive "%-escapes", those can be used to fill the + expression. + +- =%<FORMAT>= :: + + The result of format-time-string on the {{{var(FORMAT)}}} + specification. + +- =%t= :: + + Timestamp, date only. + +- =%T= :: + + Timestamp, with date and time. + +- =%u=, =%U= :: + + Like =%t=, =%T= above, but inactive timestamps. + +- =%i= :: + + Initial content, the region when capture is called while the region + is active. If there is text before =%i= on the same line, such as + indentation, and =%i= is not inside a =%(exp)= form, that prefix is + added before every line in the inserted text. + +- =%a= :: + + Annotation, normally the link created with ~org-store-link~. + +- =%A= :: + + Like =%a=, but prompt for the description part. + +- =%l= :: + + Like =%a=, but only insert the literal link. + +- =%c= :: + + Current kill ring head. + +- =%x= :: + + Content of the X clipboard. + +- =%k= :: + + Title of the currently clocked task. + +- =%K= :: + + Link to the currently clocked task. + +- =%n= :: + + User name (taken from ~user-full-name~). + +- =%f= :: + + File visited by current buffer when org-capture was called. + +- =%F= :: + + Full path of the file or directory visited by current buffer. + +- =%:keyword= :: + + Specific information for certain link types, see below. + +- =%^g= :: + + Prompt for tags, with completion on tags in target file. + +- =%^G= :: + + Prompt for tags, with completion all tags in all agenda files. + +- =%^t= :: + + Like =%t=, but prompt for date. Similarly =%^T=, =%^u=, =%^U=. You + may define a prompt like =%^{Birthday}t=. + +- =%^C= :: + + Interactive selection of which kill or clip to use. + +- =%^L= :: + + Like =%^C=, but insert as link. + +- =%^{PROP}p= :: + + Prompt the user for a value for property {{{var(PROP)}}}. + +- =%^{PROMPT}= :: + + Prompt the user for a string and replace this sequence with it. You + may specify a default value and a completion table with + =%^{prompt|default|completion2|completion3...}=. The arrow keys + access a prompt-specific history. + +- =%\N= :: + + Insert the text entered at the {{{var(N)}}}th =%^{PROMPT}=, where + {{{var(N)}}} is a number, starting from 1. + +- =%?= :: + + After completing the template, position point here. + +#+vindex: org-store-link-props +For specific link types, the following keywords are defined[fn:88]: + +#+vindex: org-link-from-user-regexp +| Link type | Available keywords | +|--------------+----------------------------------------------------------| +| bbdb | =%:name=, =%:company= | +| irc | =%:server=, =%:port=, =%:nick= | +| mh, rmail | =%:type=, =%:subject=, =%:message-id= | +| | =%:from=, =%:fromname=, =%:fromaddress= | +| | =%:to=, =%:toname=, =%:toaddress= | +| | =%:date= (message date header field) | +| | =%:date-timestamp= (date as active timestamp) | +| | =%:date-timestamp-inactive= (date as inactive timestamp) | +| | =%:fromto= (either "to NAME" or "from NAME")[fn:89] | +| gnus | =%:group=, for messages also all email fields | +| w3, w3m | =%:url= | +| info | =%:file=, =%:node= | +| calendar | =%:date= | +| org-protocol | =%:link=, =%:description=, =%:annotation= | + +**** Templates in contexts +:PROPERTIES: +:DESCRIPTION: Only show a template in a specific context. +:END: + +#+vindex: org-capture-templates-contexts +To control whether a capture template should be accessible from +a specific context, you can customize +~org-capture-templates-contexts~. Let's say, for example, that you +have a capture template "p" for storing Gnus emails containing +patches. Then you would configure this option like this: + +#+begin_src emacs-lisp +(setq org-capture-templates-contexts + '(("p" (in-mode . "message-mode")))) +#+end_src + +You can also tell that the command key {{{kbd(p)}}} should refer to +another template. In that case, add this command key like this: + +#+begin_src emacs-lisp +(setq org-capture-templates-contexts + '(("p" "q" (in-mode . "message-mode")))) +#+end_src + +See the docstring of the variable for more information. + +** Attachments +:PROPERTIES: +:DESCRIPTION: Attach files to outlines. +:END: +#+cindex: attachments + +It is often useful to associate reference material with an outline +node. Small chunks of plain text can simply be stored in the subtree +of a project. Hyperlinks (see [[*Hyperlinks]]) can establish associations +with files that live elsewhere on a local, or even remote, computer, +like emails or source code files belonging to a project. + +Another method is /attachments/, which are files located in a +directory belonging to an outline node. Org uses directories either +named by a unique ID of each entry, or by a =DIR= property. + +*** Attachment defaults and dispatcher +:PROPERTIES: +:DESCRIPTION: How to access attachment commands +:END: + +By default, Org attach uses ID properties when adding attachments to +outline nodes. This makes working with attachments fully automated. +There is no decision needed for folder-name or location. ID-based +directories are by default located in the =data/= directory, which +lives in the same directory where your Org file lives[fn:90]. + +When attachments are made using ~org-attach~ a default tag =ATTACH= is +added to the node that gets the attachments. + +For more control over the setup, see [[*Attachment options]]. + +The following commands deal with attachments: + +- {{{kbd(C-c C-a)}}} (~org-attach~) :: + + #+kindex: C-c C-a + #+findex: org-attach + The dispatcher for commands related to the attachment system. After + these keys, a list of commands is displayed and you must press an + additional key to select a command: + + - {{{kbd(a)}}} (~org-attach-attach~) :: + + #+kindex: C-c C-a a + #+findex: org-attach-attach + #+vindex: org-attach-method + Select a file and move it into the task's attachment directory. + The file is copied, moved, or linked, depending on + ~org-attach-method~. Note that hard links are not supported on + all systems. + + - {{{kbd(c)}}}/{{{kbd(m)}}}/{{{kbd(l)}}} :: + + #+kindex: C-c C-a c + #+kindex: C-c C-a m + #+kindex: C-c C-a l + Attach a file using the copy/move/link method. Note that hard + links are not supported on all systems. + + - {{{kbd(b)}}} (~org-attach-buffer~) :: + + #+kindex: C-c C-a b + #+findex: org-attach-buffer + Select a buffer and save it as a file in the task's attachment + directory. + + - {{{kbd(n)}}} (~org-attach-new~) :: + + #+kindex: C-c C-a n + #+findex: org-attach-new + Create a new attachment as an Emacs buffer. + + - {{{kbd(z)}}} (~org-attach-sync~) :: + + #+kindex: C-c C-a z + #+findex: org-attach-sync + Synchronize the current task with its attachment directory, in + case you added attachments yourself. + + - {{{kbd(o)}}} (~org-attach-open~) :: + + #+kindex: C-c C-a o + #+findex: org-attach-open + #+vindex: org-file-apps + Open current task's attachment. If there is more than one, prompt + for a file name first. Opening follows the rules set by + ~org-file-apps~. For more details, see the information on + following hyperlinks (see [[*Handling Links]]). + + - {{{kbd(O)}}} (~org-attach-open-in-emacs~) :: + + #+kindex: C-c C-a O + #+findex: org-attach-open-in-emacs + Also open the attachment, but force opening the file in Emacs. + + - {{{kbd(f)}}} (~org-attach-reveal~) :: + + #+kindex: C-c C-a f + #+findex: org-attach-reveal + Open the current task's attachment directory. + + - {{{kbd(F)}}} (~org-attach-reveal-in-emacs~) :: + + #+kindex: C-c C-a F + #+findex: org-attach-reveal-in-emacs + Also open the directory, but force using Dired in Emacs. + + - {{{kbd(d)}}} (~org-attach-delete-one~) :: + + #+kindex: C-c C-a d + Select and delete a single attachment. + + - {{{kbd(D)}}} (~org-attach-delete-all~) :: + + #+kindex: C-c C-a D + Delete all of a task's attachments. A safer way is to open the + directory in Dired and delete from there. + + - {{{kbd(s)}}} (~org-attach-set-directory~) :: + + #+kindex: C-c C-a s + #+cindex: @samp{DIR}, property + Set a specific directory as the entry's attachment directory. + This works by putting the directory path into the =DIR= + property. + + - {{{kbd(S)}}} (~org-attach-unset-directory~) :: + + #+kindex: C-c C-a S + #+cindex: @samp{DIR}, property + Remove the attachment directory. This command removes the =DIR= + property and asks the user to either move content inside that + folder, if an =ID= property is set, delete the content, or to + leave the attachment directory as is but no longer attached to the + outline node. + +*** Attachment options +:PROPERTIES: +:DESCRIPTION: Configuring the attachment system +:END: + +There are a couple of options for attachments that are worth +mentioning. + +- ~org-attach-id-dir~ :: + #+vindex: org-attach-id-dir + The directory where attachments are stored when =ID= is used as + method. + +- ~org-attach-dir-relative~ :: + #+vindex: org-attach-dir-relative + When setting the =DIR= property on a node using {{{kbd(C-c C-a s)}}} + (~org-attach-set-directory~), absolute links are entered by default. + This option changes that to relative links. + +- ~org-attach-use-inheritance~ :: + #+vindex: org-attach-use-inheritance + By default folders attached to an outline node are inherited from + parents according to ~org-use-property-inheritance~. If one instead + want to set inheritance specifically for Org attach that can be done + using ~org-attach-use-inheritance~. Inheriting documents through + the node hierarchy makes a lot of sense in most cases. Especially + when using attachment links (see [[*Attachment links]]). The following + example shows one use case for attachment inheritance: + + #+begin_example + ,* Chapter A ... + :PROPERTIES: + :DIR: Chapter A/ + :END: + ,** Introduction + Some text + + #+NAME: Image 1 + [[attachment:image 1.jpg]] + #+end_example + + Without inheritance one would not be able to resolve the link to + =image 1.jpg=, since the link is inside a sub-heading to =Chapter + A=. + + Inheritance works the same way for both =ID= and =DIR= property. If + both properties are defined on the same headline then =DIR= takes + precedence. This is also true if inheritance is enabled. If =DIR= + is inherited from a parent node in the outline, that property still + takes precedence over an =ID= property defined on the node itself. + +- ~org-attach-method~ :: + #+vindex: org-attach-method + When attaching files using the dispatcher {{{kbd(C-c C-a)}}} it + defaults to copying files. The behavior can be changed by + customizing ~org-attach-method~. Options are Copy, Move/Rename, + Hard link or Symbolic link. + +- ~org-attach-preferred-new-method~ :: + #+vindex: org-attach-preferred-new-method + This customization lets you choose the default way to attach to + nodes without existing =ID= and =DIR= property. It defaults to ~id~ + but can also be set to ~dir~, ~ask~ or ~nil~. + +- ~org-attach-archive-delete~ :: + #+vindex: org-attach-archive-delete + Configure this to determine if attachments should be deleted or not + when a subtree that has attachments is archived. + +- ~org-attach-auto-tag~ :: + #+vindex: org-attach-auto-tag + When attaching files to a heading it will be assigned a tag + according to what is set here. + +- ~org-attach-id-to-path-function-list~ :: + #+vindex: org-attach-id-to-path-function-list + When =ID= is used for attachments, the ID is parsed into a part of a + directory-path. See ~org-attach-id-uuid-folder-format~ for the + default function. Define a new one and add it as first element in + ~org-attach-id-to-path-function-list~ if you want the folder + structure in any other way. All functions in this list will be + tried when resolving existing ID's into paths, to maintain backward + compatibility with existing folders in your system. + +- ~org-attach-store-link-p~ :: + #+vindex: org-attach-store-link-p + Stores a link to the file that is being attached. The link is + stored in ~org-stored-links~ for later insertion with {{{kbd(C-c + C-l)}}} (see [[*Handling Links]]). Depending on what option is set in + ~org-attach-store-link-p~, the link is stored to either the original + location as a file link, the attachment location as an attachment + link or to the attachment location as a file link. + +- ~org-attach-commands~ :: + #+vindex: org-attach-commands + List of all commands used in the attach dispatcher. + +- ~org-attach-expert~ :: + #+vindex: org-attach-expert + Do not show the splash buffer with the attach dispatcher when + ~org-attach-expert~ is set to non-~nil~. + +See customization group =Org Attach= if you want to change the +default settings. + +*** Attachment links +:PROPERTIES: +:DESCRIPTION: Hyperlink access to attachments +:END: + +Attached files and folders can be referenced using attachment links. +This makes it easy to refer to the material added to an outline node. +Especially if it was attached using the unique ID of the entry! + +#+begin_example +,* TODO Some task + :PROPERTIES: + :ID: 95d50008-c12e-479f-a4f2-cc0238205319 + :END: +See attached document for more information: [[attachment:info.org]] +#+end_example + +See [[*External Links]] for more information about these links. + +*** Automatic version-control with Git +:PROPERTIES: +:DESCRIPTION: Everything safely stored away +:END: + +If the directory attached to an outline node is a Git repository, Org +can be configured to automatically commit changes to that repository +when it sees them. + +To make Org mode take care of versioning of attachments for you, add +the following to your Emacs config: + +#+begin_src emacs-lisp + (require 'org-attach-git) +#+end_src + +*** Attach from Dired +:PROPERTIES: +:DESCRIPTION: Using dired to select an attachment +:END: +#+cindex: attach from Dired +#+findex: org-attach-dired-to-subtree + +It is possible to attach files to a subtree from a Dired buffer. To +use this feature, have one window in Dired mode containing the file(s) +to be attached and another window with point in the subtree that shall +get the attachments. In the Dired window, with point on a file, +{{{kbd(M-x org-attach-dired-to-subtree)}}} attaches the file to the +subtree using the attachment method set by variable +~org-attach-method~. When files are marked in the Dired window then +all marked files get attached. + +Add the following lines to the Emacs init file to have {{{kbd(C-c C-x +a)}}} attach files in Dired buffers. + +#+begin_src emacs-lisp +(add-hook 'dired-mode-hook + (lambda () + (define-key dired-mode-map + (kbd "C-c C-x a") + #'org-attach-dired-to-subtree))) +#+end_src + +The following code shows how to bind the previous command with +a specific attachment method. + +#+begin_src emacs-lisp +(add-hook 'dired-mode-hook + (lambda () + (define-key dired-mode-map (kbd "C-c C-x c") + (lambda () + (interactive) + (let ((org-attach-method 'cp)) + (call-interactively #'org-attach-dired-to-subtree)))))) +#+end_src + +** RSS Feeds +:PROPERTIES: +:DESCRIPTION: Getting input from RSS feeds. +:END: +#+cindex: RSS feeds +#+cindex: Atom feeds + +Org can add and change entries based on information found in RSS feeds +and Atom feeds. You could use this to make a task out of each new +podcast in a podcast feed. Or you could use a phone-based +note-creating service on the web to import tasks into Org. To access +feeds, configure the variable ~org-feed-alist~. The docstring of this +variable has detailed information. With the following + +#+begin_src emacs-lisp +(setq org-feed-alist + '(("Slashdot" + "http://rss.slashdot.org/Slashdot/slashdot" + "~/txt/org/feeds.org" "Slashdot Entries"))) +#+end_src + +#+texinfo: @noindent +new items from the feed provided by =rss.slashdot.org= result in new +entries in the file =~/org/feeds.org= under the heading =Slashdot +Entries=, whenever the following command is used: + +- {{{kbd(C-c C-x g)}}} (~org-feed-update-all~) :: + + #+kindex: C-c C-x g + Collect items from the feeds configured in ~org-feed-alist~ and act + upon them. + +- {{{kbd(C-c C-x G)}}} (~org-feed-goto-inbox~) :: + + #+kindex: C-c C-x G + Prompt for a feed name and go to the inbox configured for this feed. + +Under the same headline, Org creates a drawer =FEEDSTATUS= in which it +stores information about the status of items in the feed, to avoid +adding the same item several times. + +For more information, including how to read atom feeds, see +=org-feed.el= and the docstring of ~org-feed-alist~. + +* Agenda Views +:PROPERTIES: +:DESCRIPTION: Collecting information into views. +:END: +#+cindex: agenda views + +Due to the way Org works, TODO items, time-stamped items, and tagged +headlines can be scattered throughout a file or even a number of +files. To get an overview of open action items, or of events that are +important for a particular date, this information must be collected, +sorted and displayed in an organized way. + +Org can select items based on various criteria and display them in +a separate buffer. Six different view types are provided: + +- an /agenda/ that is like a calendar and shows information for + specific dates, + +- a /TODO list/ that covers all unfinished action items, + +- a /match view/, showings headlines based on the tags, properties, + and TODO state associated with them, + +- a /text search view/ that shows all entries from multiple files that + contain specified keywords, + +- a /stuck projects view/ showing projects that currently do not move + along, and + +- /custom views/ that are special searches and combinations of + different views. + +The extracted information is displayed in a special /agenda buffer/. +This buffer is read-only, but provides commands to visit the +corresponding locations in the original Org files, and even to edit +these files remotely. + +#+vindex: org-agenda-skip-comment-trees +#+vindex: org-agenda-skip-archived-trees +#+cindex: commented entries, in agenda views +#+cindex: archived entries, in agenda views +By default, the report ignores commented (see [[*Comment Lines]]) and +archived (see [[*Internal archiving]]) entries. You can override this by +setting ~org-agenda-skip-comment-trees~ and +~org-agenda-skip-archived-trees~ to ~nil~. + +#+vindex: org-agenda-window-setup +#+vindex: org-agenda-restore-windows-after-quit +Two variables control how the agenda buffer is displayed and whether +the window configuration is restored when the agenda exits: +~org-agenda-window-setup~ and ~org-agenda-restore-windows-after-quit~. + +** Agenda Files +:PROPERTIES: +:DESCRIPTION: Files being searched for agenda information. +:END: +#+cindex: agenda files +#+cindex: files for agenda + +#+vindex: org-agenda-files +The information to be shown is normally collected from all /agenda +files/, the files listed in the variable ~org-agenda-files~[fn:91]. +If a directory is part of this list, all files with the extension +=.org= in this directory are part of the list. + +Thus, even if you only work with a single Org file, that file should +be put into the list[fn:92]. You can customize ~org-agenda-files~, +but the easiest way to maintain it is through the following commands + +#+attr_texinfo: :sep and +- {{{kbd(C-c [)}}} (~org-agenda-file-to-front~) :: + + #+kindex: C-c [ + #+findex: org-agenda-file-to-front + #+cindex: files, adding to agenda list + Add current file to the list of agenda files. The file is added to + the front of the list. If it was already in the list, it is moved + to the front. With a prefix argument, file is added/moved to the + end. + +- {{{kbd(C-c ])}}} (~org-remove-file~) :: + + #+kindex: C-c ] + #+findex: org-remove-file + Remove current file from the list of agenda files. + +- {{{kbd(C-')}}} and {{{kbd(C-\,)}}} (~org-cycle-agenda-files~) :: + + #+kindex: C-' + #+kindex: C-, + #+findex: org-cycle-agenda-files + #+cindex: cycling, of agenda files + Cycle through agenda file list, visiting one file after the other. + +- {{{kbd(M-x org-switchb)}}} :: + + #+findex: org-switchb + Command to use an Iswitchb-like interface to switch to and between + Org buffers. + +#+texinfo: @noindent +The Org menu contains the current list of files and can be used to +visit any of them. + +If you would like to focus the agenda temporarily on a file not in +this list, or on just one file in the list, or even on only a subtree +in a file, then this can be done in different ways. For a single +agenda command, you may press {{{kbd(<)}}} once or several times in +the dispatcher (see [[*The Agenda Dispatcher]]). To restrict the agenda +scope for an extended period, use the following commands: + +- {{{kbd(C-c C-x <)}}} (~org-agenda-set-restriction-lock~) :: + + #+kindex: C-c C-x < + #+findex: org-agenda-set-restriction-lock + Restrict the agenda to the current subtree. If there already is + a restriction at point, remove it. When called with a universal + prefix argument or with point before the first headline in a file, + set the agenda scope to the entire file. This restriction remains + in effect until removed with {{{kbd(C-c C-x >)}}}, or by typing + either {{{kbd(<)}}} or {{{kbd(>)}}} in the agenda dispatcher. If + there is a window displaying an agenda view, the new restriction + takes effect immediately. + +- {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) :: + + #+kindex: C-c C-x > + #+findex: org-agenda-remove-restriction-lock + Remove the restriction created by {{{kbd(C-c C-x <)}}}. + +When working with Speedbar, you can use the following commands in the +Speedbar frame: + +- {{{kbd(<)}}} (~org-speedbar-set-agenda-restriction~) :: + + #+findex: org-speedbar-set-agenda-restriction + Restrict the agenda to the item---either an Org file or a subtree in + such a file---at point in the Speedbar frame. If agenda is already + restricted there, remove the restriction. If there is a window + displaying an agenda view, the new restriction takes effect + immediately. + +- {{{kbd(>)}}} (~org-agenda-remove-restriction-lock~) :: + + #+findex: org-agenda-remove-restriction-lock + Remove the restriction. + +** The Agenda Dispatcher +:PROPERTIES: +:DESCRIPTION: Keyboard access to agenda views. +:ALT_TITLE: Agenda Dispatcher +:END: +#+cindex: agenda dispatcher +#+cindex: dispatching agenda commands + +The views are created through a dispatcher, accessible with {{{kbd(M-x +org-agenda)}}}, or, better, bound to a global key (see [[*Activation]]). +It displays a menu from which an additional letter is required to +execute a command. The dispatcher offers the following default +commands: + +#+attr_texinfo: :sep , +- {{{kbd(a)}}} :: + + Create the calendar-like agenda (see [[*Weekly/daily agenda]]). + +- {{{kbd(t)}}}, {{{kbd(T)}}} :: + + Create a list of all TODO items (see [[*The global TODO list]]). + +- {{{kbd(m)}}}, {{{kbd(M)}}} :: + + Create a list of headlines matching a given expression (see + [[*Matching tags and properties]]). + +- {{{kbd(s)}}} :: + + #+kindex: s @r{(Agenda dispatcher)} + Create a list of entries selected by a boolean expression of + keywords and/or regular expressions that must or must not occur in + the entry. + +- {{{kbd(/)}}} :: + + #+kindex: / @r{(Agenda dispatcher)} + #+vindex: org-agenda-text-search-extra-files + Search for a regular expression in all agenda files and additionally + in the files listed in ~org-agenda-text-search-extra-files~. This + uses the Emacs command ~multi-occur~. A prefix argument can be used + to specify the number of context lines for each match, default is + 1. + +- {{{kbd(#)}}} :: + + Create a list of stuck projects (see [[*Stuck projects]]). + +- {{{kbd(!)}}} :: + + Configure the list of stuck projects (see [[*Stuck projects]]). + +- {{{kbd(<)}}} :: + + #+kindex: < @r{(Agenda dispatcher)} + Restrict an agenda command to the current buffer[fn:93]. If + narrowing is in effect restrict to the narrowed part of the buffer. + After pressing {{{kbd(<)}}}, you still need to press the character + selecting the command. + +- {{{kbd(< <)}}} :: + + #+kindex: < < @r{(Agenda dispatcher)} + If there is an active region, restrict the following agenda command + to the region. Otherwise, restrict it to the current + subtree[fn:94]. After pressing {{{kbd(< <)}}}, you still need to + press the character selecting the command. + +- {{{kbd(*)}}} :: + + #+kindex: * @r{(Agenda dispatcher)} + #+vindex: org-agenda-sticky + #+findex: org-toggle-sticky-agenda + Toggle sticky agenda views. By default, Org maintains only a single + agenda buffer and rebuilds it each time you change the view, to make + sure everything is always up to date. If you switch between views + often and the build time bothers you, you can turn on sticky agenda + buffers (make this the default by customizing the variable + ~org-agenda-sticky~). With sticky agendas, the dispatcher only + switches to the selected view, you need to update it by hand with + {{{kbd(r)}}} or {{{kbd(g)}}}. You can toggle sticky agenda view any + time with ~org-toggle-sticky-agenda~. + +You can also define custom commands that are accessible through the +dispatcher, just like the default commands. This includes the +possibility to create extended agenda buffers that contain several +blocks together, for example the weekly agenda, the global TODO list +and a number of special tags matches. See [[*Custom Agenda Views]]. + +** The Built-in Agenda Views +:PROPERTIES: +:DESCRIPTION: What is available out of the box? +:ALT_TITLE: Built-in Agenda Views +:END: + +In this section we describe the built-in views. + +*** Weekly/daily agenda +:PROPERTIES: +:DESCRIPTION: The calendar page with current tasks. +:END: +#+cindex: agenda +#+cindex: weekly agenda +#+cindex: daily agenda + +The purpose of the weekly/daily /agenda/ is to act like a page of +a paper agenda, showing all the tasks for the current week or day. + +- {{{kbd(M-x org-agenda a)}}} (~org-agenda-list~) :: + + #+kindex: a @r{(Agenda dispatcher)} + #+findex: org-agenda-list + #+cindex: org-agenda, command + Compile an agenda for the current week from a list of Org files. + The agenda shows the entries for each day. With a numeric prefix + argument[fn:95]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you may + set the number of days to be displayed. + +#+vindex: org-agenda-span +#+vindex: org-agenda-start-day +#+vindex: org-agenda-start-on-weekday +The default number of days displayed in the agenda is set by the +variable ~org-agenda-span~. This variable can be set to any number of +days you want to see by default in the agenda, or to a span name, such +a ~day~, ~week~, ~month~ or ~year~. For weekly agendas, the default +is to start on the previous Monday (see +~org-agenda-start-on-weekday~). You can also set the start date using +a date shift: =(setq org-agenda-start-day "+10d")= starts the agenda +ten days from today in the future. + +Remote editing from the agenda buffer means, for example, that you can +change the dates of deadlines and appointments from the agenda buffer. +The commands available in the Agenda buffer are listed in [[*Commands in +the Agenda Buffer]]. + +**** Calendar/Diary integration +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: calendar integration +#+cindex: diary integration + +Emacs contains the calendar and diary by Edward\nbsp{}M.\nbsp{}Reingold. The +calendar displays a three-month calendar with holidays from different +countries and cultures. The diary allows you to keep track of +anniversaries, lunar phases, sunrise/set, recurrent appointments +(weekly, monthly) and more. In this way, it is quite complementary to +Org. It can be very useful to combine output from Org with the diary. + +In order to include entries from the Emacs diary into Org mode's +agenda, you only need to customize the variable + +#+begin_src emacs-lisp +(setq org-agenda-include-diary t) +#+end_src + +#+texinfo: @noindent +After that, everything happens automatically. All diary entries +including holidays, anniversaries, etc., are included in the agenda +buffer created by Org mode. {{{kbd(SPC)}}}, {{{kbd(TAB)}}}, and +{{{kbd(RET)}}} can be used from the agenda buffer to jump to the diary +file in order to edit existing diary entries. The {{{kbd(i)}}} +command to insert new entries for the current date works in the agenda +buffer, as well as the commands {{{kbd(S)}}}, {{{kbd(M)}}}, and +{{{kbd(C)}}} to display Sunrise/Sunset times, show lunar phases and to +convert to other calendars, respectively. {{{kbd(c)}}} can be used to +switch back and forth between calendar and agenda. + +If you are using the diary only for expression entries and holidays, +it is faster to not use the above setting, but instead to copy or even +move the entries into an Org file. Org mode evaluates diary-style +expression entries, and does it faster because there is no overhead +for first creating the diary display. Note that the expression +entries must start at the left margin, no whitespace is allowed before +them, as seen in the following segment of an Org file:[fn:96] + +#+begin_example +,* Holidays + :PROPERTIES: + :CATEGORY: Holiday + :END: +%%(org-calendar-holiday) ; special function for holiday names + +,* Birthdays + :PROPERTIES: + :CATEGORY: Ann + :END: +%%(org-anniversary 1956 5 14) Arthur Dent is %d years old +%%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old +#+end_example + +**** Anniversaries from BBDB +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: BBDB, anniversaries +#+cindex: anniversaries, from BBDB + +#+findex: org-bbdb-anniversaries +If you are using the Insidious Big Brother Database to store your +contacts, you very likely prefer to store anniversaries in BBDB rather +than in a separate Org or diary file. Org supports this and can show +BBDB anniversaries as part of the agenda. All you need to do is to +add the following to one of your agenda files: + +#+begin_example +,* Anniversaries + :PROPERTIES: + :CATEGORY: Anniv + :END: +%%(org-bbdb-anniversaries) +#+end_example + +You can then go ahead and define anniversaries for a BBDB record. +Basically, you need a field named =anniversary= for the BBDB record +which contains the date in the format =YYYY-MM-DD= or =MM-DD=, +followed by a space and the class of the anniversary (=birthday=, +=wedding=, or a format string). If you omit the class, it defaults to +=birthday=. Here are a few examples, the header for the file +=ol-bbdb.el= contains more detailed information. + +#+begin_example +1973-06-22 +06-22 +1955-08-02 wedding +2008-04-14 %s released version 6.01 of Org mode, %d years ago +#+end_example + +After a change to BBDB, or for the first agenda display during an +Emacs session, the agenda display suffers a short delay as Org updates +its hash with anniversaries. However, from then on things will be +very fast, much faster in fact than a long list of +=%%(diary-anniversary)= entries in an Org or Diary file. + +#+findex: org-bbdb-anniversaries-future +If you would like to see upcoming anniversaries with a bit of +forewarning, you can use the following instead: + +#+begin_example +,* Anniversaries + :PROPERTIES: + :CATEGORY: Anniv + :END: +%%(org-bbdb-anniversaries-future 3) +#+end_example + +That will give you three days' warning: on the anniversary date itself +and the two days prior. The argument is optional: if omitted, it +defaults to 7. + +**** Appointment reminders +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: @file{appt.el} +#+cindex: appointment reminders +#+cindex: appointment +#+cindex: reminders + +#+cindex: APPT_WARNTIME, keyword +Org can interact with Emacs appointments notification facility. To +add the appointments of your agenda files, use the command +~org-agenda-to-appt~. This command lets you filter through the list +of your appointments and add only those belonging to a specific +category or matching a regular expression. It also reads +a =APPT_WARNTIME= property which overrides the value of +~appt-message-warning-time~ for this appointment. See the docstring +for details. + +*** The global TODO list +:PROPERTIES: +:DESCRIPTION: All unfinished action items. +:ALT_TITLE: Global TODO list +:END: +#+cindex: global TODO list +#+cindex: TODO list, global + +The global TODO list contains all unfinished TODO items formatted and +collected into a single place. + +- {{{kbd(M-x org-agenda t)}}} (~org-todo-list~) :: + + #+kindex: t @r{(Agenda dispatcher)} + #+findex: org-todo-list + Show the global TODO list. This collects the TODO items from all + agenda files (see [[*Agenda Views]]) into a single buffer. By default, + this lists items with a state the is not a DONE state. The buffer + is in Agenda mode, so there are commands to examine and manipulate + the TODO entries directly from that buffer (see [[*Commands in the + Agenda Buffer]]). + +- {{{kbd(M-x org-agenda T)}}} (~org-todo-list~) :: + + #+kindex: T @r{(Agenda dispatcher)} + #+findex: org-todo-list + #+cindex: TODO keyword matching + #+vindex: org-todo-keywords + Like the above, but allows selection of a specific TODO keyword. + You can also do this by specifying a prefix argument to + {{{kbd(t)}}}. You are prompted for a keyword, and you may also + specify several keywords by separating them with =|= as the boolean + OR operator. With a numeric prefix, the Nth keyword in + ~org-todo-keywords~ is selected. + + #+kindex: r + The {{{kbd(r)}}} key in the agenda buffer regenerates it, and you + can give a prefix argument to this command to change the selected + TODO keyword, for example {{{kbd(3 r)}}}. If you often need + a search for a specific keyword, define a custom command for it (see + [[*The Agenda Dispatcher]]). + + Matching specific TODO keywords can also be done as part of a tags + search (see [[*Tag Searches]]). + +Remote editing of TODO items means that you can change the state of +a TODO entry with a single key press. The commands available in the +TODO list are described in [[*Commands in the Agenda Buffer]]. + +#+cindex: sublevels, inclusion into TODO list +Normally the global TODO list simply shows all headlines with TODO +keywords. This list can become very long. There are two ways to keep +it more compact: + +- + #+vindex: org-agenda-todo-ignore-scheduled + #+vindex: org-agenda-todo-ignore-deadlines + #+vindex: org-agenda-todo-ignore-timestamp + #+vindex: org-agenda-todo-ignore-with-date + Some people view a TODO item that has been /scheduled/ for execution + or have a /deadline/ (see [[*Timestamps]]) as no longer /open/. + Configure the variables ~org-agenda-todo-ignore-scheduled~ to + exclude some or all scheduled items from the global TODO list, + ~org-agenda-todo-ignore-deadlines~ to exclude some or all items with + a deadline set, ~org-agenda-todo-ignore-timestamp~ to exclude some + or all items with an active timestamp other than a DEADLINE or + a SCHEDULED timestamp and/or ~org-agenda-todo-ignore-with-date~ to + exclude items with at least one active timestamp. + +- + #+vindex: org-agenda-todo-list-sublevels + TODO items may have sublevels to break up the task into subtasks. + In such cases it may be enough to list only the highest level TODO + headline and omit the sublevels from the global list. Configure the + variable ~org-agenda-todo-list-sublevels~ to get this behavior. + +*** Matching tags and properties +:PROPERTIES: +:DESCRIPTION: Structured information with fine-tuned search. +:END: +#+cindex: matching, of tags +#+cindex: matching, of properties +#+cindex: tags view +#+cindex: match view + +If headlines in the agenda files are marked with /tags/ (see [[*Tags]]), +or have properties (see [[*Properties and Columns]]), you can select +headlines based on this metadata and collect them into an agenda +buffer. The match syntax described here also applies when creating +sparse trees with {{{kbd(C-c / m)}}}. + +- {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) :: + + #+kindex: m @r{(Agenda dispatcher)} + #+findex: org-tags-view + Produce a list of all headlines that match a given set of tags. The + command prompts for a selection criterion, which is a boolean logic + expression with tags, like =+work+urgent-withboss= or =work|home= + (see [[*Tags]]). If you often need a specific search, define a custom + command for it (see [[*The Agenda Dispatcher]]). + +- {{{kbd(M-x org-agenda M)}}} (~org-tags-view~) :: + + #+kindex: M @r{(Agenda dispatcher)} + #+findex: org-tags-view + #+vindex: org-tags-match-list-sublevels + #+vindex: org-agenda-tags-todo-honor-ignore-options + Like {{{kbd(m)}}}, but only select headlines that are also TODO + items and force checking subitems (see the variable + ~org-tags-match-list-sublevels~). To exclude scheduled/deadline + items, see the variable ~org-agenda-tags-todo-honor-ignore-options~. + Matching specific TODO keywords together with a tags match is also + possible, see [[*Tag Searches]]. + +The commands available in the tags list are described in [[*Commands in +the Agenda Buffer]]. + +#+cindex: boolean logic, for agenda searches +A search string can use Boolean operators =&= for AND and =|= for OR. +=&= binds more strongly than =|=. Parentheses are currently not +implemented. Each element in the search is either a tag, a regular +expression matching tags, or an expression like =PROPERTY OPERATOR +VALUE= with a comparison operator, accessing a property value. Each +element may be preceded by =-= to select against it, and =+= is +syntactic sugar for positive selection. The AND operator =&= is +optional when =+= or =-= is present. Here are some examples, using +only tags. + +- =+work-boss= :: + + Select headlines tagged =work=, but discard those also tagged + =boss=. + +- =work|laptop= :: + + Selects lines tagged =work= or =laptop=. + +- =work|laptop+night= :: + + Like before, but require the =laptop= lines to be tagged also + =night=. + +#+cindex: regular expressions, with tags search +Instead of a tag, you may also specify a regular expression enclosed +in curly braces. For example, =work+{^boss.*}= matches headlines that +contain the tag =:work:= and any tag /starting/ with =boss=. + +#+cindex: group tags, as regular expressions +Group tags (see [[*Tag Hierarchy]]) are expanded as regular expressions. +E.g., if =work= is a group tag for the group =:work:lab:conf:=, then +searching for =work= also searches for ={\(?:work\|lab\|conf\)}= and +searching for =-work= searches for all headlines but those with one of +the tags in the group (i.e., =-{\(?:work\|lab\|conf\)}=). + +#+cindex: TODO keyword matching, with tags search +#+cindex: level, for tags/property match +#+cindex: category, for tags/property match +#+vindex: org-odd-levels-only +You may also test for properties (see [[*Properties and Columns]]) at the +same time as matching tags. The properties may be real properties, or +special properties that represent other metadata (see [[*Special +Properties]]). For example, the property =TODO= represents the TODO +keyword of the entry. Or, the property =LEVEL= represents the level +of an entry. So searching =+LEVEL=3+boss-TODO="DONE"= lists all level +three headlines that have the tag =boss= and are /not/ marked with the +TODO keyword =DONE=. In buffers with ~org-odd-levels-only~ set, +=LEVEL= does not count the number of stars, but =LEVEL=2= corresponds +to 3 stars etc. + +Here are more examples: + +- =work+TODO="WAITING"= :: + + Select =work=-tagged TODO lines with the specific TODO keyword + =WAITING=. + +- =work+TODO="WAITING"|home+TODO="WAITING"= :: + + Waiting tasks both at work and at home. + +When matching properties, a number of different operators can be used +to test the value of a property. Here is a complex example: + +#+begin_example ++work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 + +With={Sarah|Denny}+SCHEDULED>="<2008-10-11>" +#+end_example + +#+texinfo: @noindent +The type of comparison depends on how the comparison value is written: + +- If the comparison value is a plain number, a numerical comparison is + done, and the allowed operators are =<=, ===, =>=, =<==, =>==, and + =<>=. + +- If the comparison value is enclosed in double-quotes, a string + comparison is done, and the same operators are allowed. + +- If the comparison value is enclosed in double-quotes /and/ angular + brackets (like =DEADLINE<="<2008-12-24 18:30>"=), both values are + assumed to be date/time specifications in the standard Org way, and + the comparison is done accordingly. Valid values also include + ="<now>"= for now (including time), ="<today>"=, and ="<tomorrow>"= + for these days at 0:00 hours, i.e., without a time specification. + You can also use strings like ="<+5d>"= or ="<-2m>"= with units =d=, + =w=, =m=, and =y= for day, week, month, and year, respectively. + +- If the comparison value is enclosed in curly braces, a regexp match + is performed, with === meaning that the regexp matches the property + value, and =<>= meaning that it does not match. + +So the search string in the example finds entries tagged =work= but +not =boss=, which also have a priority value =A=, a =Coffee= property +with the value =unlimited=, an =EFFORT= property that is numerically +smaller than 2, a =With= property that is matched by the regular +expression =Sarah|Denny=, and that are scheduled on or after October +11, 2008. + +You can configure Org mode to use property inheritance during +a search, but beware that this can slow down searches considerably. +See [[*Property Inheritance]], for details. + +For backward compatibility, and also for typing speed, there is also +a different way to test TODO states in a search. For this, terminate +the tags/property part of the search string (which may include several +terms connected with =|=) with a =/= and then specify a Boolean +expression just for TODO keywords. The syntax is then similar to that +for tags, but should be applied with care: for example, a positive +selection on several TODO keywords cannot meaningfully be combined +with boolean AND. However, /negative selection/ combined with AND can +be meaningful. To make sure that only lines are checked that actually +have any TODO keyword (resulting in a speed-up), use {{{kbd(M-x +org-agenda M)}}}, or equivalently start the TODO part after the slash +with =!=. Using {{{kbd(M-x org-agenda M)}}} or =/!= does not match +TODO keywords in a DONE state. Examples: + +- =work/WAITING= :: + + Same as =work+TODO="WAITING"=. + +- =work/!-WAITING-NEXT= :: + + Select =work=-tagged TODO lines that are neither =WAITING= nor + =NEXT=. + +- =work/!+WAITING|+NEXT= :: + + Select =work=-tagged TODO lines that are either =WAITING= or =NEXT=. + +*** Search view +:PROPERTIES: +:DESCRIPTION: Find entries by searching for text. +:END: +#+cindex: search view +#+cindex: text search +#+cindex: searching, for text + +This agenda view is a general text search facility for Org mode +entries. It is particularly useful to find notes. + +- {{{kbd(M-x org-agenda s)}}} (~org-search-view~) :: + + #+kindex: s @r{(Agenda dispatcher)} + #+findex: org-search-view + This is a special search that lets you select entries by matching + a substring or specific words using a boolean logic. + +For example, the search string =computer equipment= matches entries +that contain =computer equipment= as a substring, even if the two +words are separated by more space or a line break. + +Search view can also search for specific keywords in the entry, using +Boolean logic. The search string =+computer ++wifi -ethernet -{8\.11[bg]}= matches note entries that contain the +keywords =computer= and =wifi=, but not the keyword =ethernet=, and +which are also not matched by the regular expression =8\.11[bg]=, +meaning to exclude both =8.11b= and =8.11g=. The first =+= is +necessary to turn on boolean search, other =+= characters are +optional. For more details, see the docstring of the command +~org-search-view~. + +You can incrementally and conveniently adjust a boolean search from +the agenda search view with the following keys + +#+attr_texinfo: :columns 0.1 0.6 +| {{{kbd([)}}} | Add a positive search word | +| {{{kbd(])}}} | Add a negative search word | +| {{{kbd({)}}} | Add a positive regular expression | +| {{{kbd(})}}} | Add a negative regular expression | + +#+vindex: org-agenda-text-search-extra-files +Note that in addition to the agenda files, this command also searches +the files listed in ~org-agenda-text-search-extra-files~. + +*** Stuck projects +:PROPERTIES: +:DESCRIPTION: Find projects you need to review. +:END: +#+pindex: GTD, Getting Things Done + +If you are following a system like David Allen's GTD to organize your +work, one of the "duties" you have is a regular review to make sure +that all projects move along. A /stuck/ project is a project that has +no defined next actions, so it never shows up in the TODO lists Org +mode produces. During the review, you need to identify such projects +and define next actions for them. + +- {{{kbd(M-x org-agenda #)}}} (~org-agenda-list-stuck-projects~) :: + + #+kindex: # @r{(Agenda dispatcher)} + #+findex: org-agenda-list-stuck-projects + List projects that are stuck. + +- {{{kbd(M-x org-agenda !)}}} :: + + #+kindex: ! @r{(Agenda dispatcher)} + #+vindex: org-stuck-projects + Customize the variable ~org-stuck-projects~ to define what a stuck + project is and how to find it. + +You almost certainly need to configure this view before it works for +you. The built-in default assumes that all your projects are level-2 +headlines, and that a project is not stuck if it has at least one +entry marked with a TODO keyword =TODO= or =NEXT= or =NEXTACTION=. + +Let's assume that you, in your own way of using Org mode, identify +projects with a tag =:PROJECT:=, and that you use a TODO keyword +=MAYBE= to indicate a project that should not be considered yet. +Let's further assume that the TODO keyword =DONE= marks finished +projects, and that =NEXT= and =TODO= indicate next actions. The tag +=:@shop:= indicates shopping and is a next action even without the +NEXT tag. Finally, if the project contains the special word =IGNORE= +anywhere, it should not be listed either. In this case you would +start by identifying eligible projects with a tags/TODO match (see +[[*Tag Searches]]) =+PROJECT/-MAYBE-DONE=, and then check for =TODO=, +=NEXT=, =@shop=, and =IGNORE= in the subtree to identify projects that +are not stuck. The correct customization for this is: + +#+begin_src emacs-lisp +(setq org-stuck-projects + '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@shop") + "\\<IGNORE\\>")) +#+end_src + +Note that if a project is identified as non-stuck, the subtree of this +entry is searched for stuck projects. + +** Presentation and Sorting +:PROPERTIES: +:DESCRIPTION: How agenda items are prepared for display. +:END: +#+cindex: presentation, of agenda items + +#+vindex: org-agenda-prefix-format +#+vindex: org-agenda-tags-column +Before displaying items in an agenda view, Org mode visually prepares +the items and sorts them. Each item occupies a single line. The line +starts with a /prefix/ that contains the /category/ (see [[*Categories]]) +of the item and other important information. You can customize in +which column tags are displayed through ~org-agenda-tags-column~. You +can also customize the prefix using the option +~org-agenda-prefix-format~. This prefix is followed by a cleaned-up +version of the outline headline associated with the item. + +*** Categories +:PROPERTIES: +:DESCRIPTION: Not all tasks are equal. +:END: +#+cindex: category +#+cindex: @samp{CATEGORY}, keyword + +The category is a broad label assigned to each agenda item. By +default, the category is simply derived from the file name, but you +can also specify it with a special line in the buffer, like +this: + +: #+CATEGORY: Thesis + +#+cindex: @samp{CATEGORY}, property +If you would like to have a special category for a single entry or +a (sub)tree, give the entry a =CATEGORY= property with the special +category you want to apply as the value. + +#+vindex: org-agenda-category-icon-alist +The display in the agenda buffer looks best if the category is not +longer than 10 characters. You can set up icons for category by +customizing the ~org-agenda-category-icon-alist~ variable. + +*** Time-of-day specifications +:PROPERTIES: +:DESCRIPTION: How the agenda knows the time. +:END: +#+cindex: time-of-day specification + +Org mode checks each agenda item for a time-of-day specification. The +time can be part of the timestamp that triggered inclusion into the +agenda, for example + +: <2005-05-10 Tue 19:00> + +#+texinfo: @noindent +Time ranges can be specified with two timestamps: + +: <2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15> + +#+vindex: org-agenda-search-headline-for-time +In the headline of the entry itself, a time(range)---like =12:45= or +a =8:30-1pm=---may also appear as plain text[fn:97]. + +If the agenda integrates the Emacs diary (see [[*Weekly/daily agenda]]), +time specifications in diary entries are recognized as well. + +For agenda display, Org mode extracts the time and displays it in +a standard 24 hour format as part of the prefix. The example times in +the previous paragraphs would end up in the agenda like this: + +#+begin_example + 8:30-13:00 Arthur Dent lies in front of the bulldozer +12:45...... Ford Prefect arrives and takes Arthur to the pub +19:00...... The Vogon reads his poem +20:30-22:15 Marvin escorts the Hitchhikers to the bridge +#+end_example + +#+cindex: time grid +If the agenda is in single-day mode, or for the display of today, the +timed entries are embedded in a time grid, like + +#+begin_example + 8:00...... ------------------ + 8:30-13:00 Arthur Dent lies in front of the bulldozer +10:00...... ------------------ +12:00...... ------------------ +12:45...... Ford Prefect arrives and takes Arthur to the pub +14:00...... ------------------ +16:00...... ------------------ +18:00...... ------------------ +19:00...... The Vogon reads his poem +20:00...... ------------------ +20:30-22:15 Marvin escorts the Hitchhikers to the bridge +#+end_example + +#+vindex: org-agenda-use-time-grid +#+vindex: org-agenda-time-grid +The time grid can be turned on and off with the variable +~org-agenda-use-time-grid~, and can be configured with +~org-agenda-time-grid~. + +*** Sorting of agenda items +:PROPERTIES: +:DESCRIPTION: The order of things. +:END: +#+cindex: sorting, of agenda items +#+cindex: priorities, of agenda items + +Before being inserted into a view, the items are sorted. How this is +done depends on the type of view. + +- + #+vindex: org-agenda-files + For the daily/weekly agenda, the items for each day are sorted. The + default order is to first collect all items containing an explicit + time-of-day specification. These entries are shown at the beginning + of the list, as a /schedule/ for the day. After that, items remain + grouped in categories, in the sequence given by ~org-agenda-files~. + Within each category, items are sorted by priority (see + [[*Priorities]]), which is composed of the base priority (2000 for + priority =A=, 1000 for =B=, and 0 for =C=), plus additional + increments for overdue scheduled or deadline items. + +- For the TODO list, items remain in the order of categories, but + within each category, sorting takes place according to priority (see + [[*Priorities]]). The priority used for sorting derives from the + priority cookie, with additions depending on how close an item is to + its due or scheduled date. + +- For tags matches, items are not sorted at all, but just appear in + the sequence in which they are found in the agenda files. + +#+vindex: org-agenda-sorting-strategy +Sorting can be customized using the variable +~org-agenda-sorting-strategy~, and may also include criteria based on +the estimated effort of an entry (see [[*Effort Estimates]]). + +*** Filtering/limiting agenda items +:PROPERTIES: +:DESCRIPTION: Dynamically narrow the agenda. +:END: + +#+vindex: org-agenda-category-filter-preset +#+vindex: org-agenda-tag-filter-preset +#+vindex: org-agenda-effort-filter-preset +#+vindex: org-agenda-regexp-filter-preset +Agenda built-in or custom commands are statically defined. Agenda +filters and limits allow to flexibly narrow down the list of agenda +entries. + +/Filters/ only change the visibility of items, are very fast and are +mostly used interactively[fn:98]. You can switch quickly between +different filters without having to recreate the agenda. /Limits/ on +the other hand take effect before the agenda buffer is populated, so +they are mostly useful when defined as local variables within custom +agenda commands. + +**** Filtering in the agenda +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: agenda filtering +#+cindex: filtering entries, in agenda +#+cindex: tag filtering, in agenda +#+cindex: category filtering, in agenda +#+cindex: top headline filtering, in agenda +#+cindex: effort filtering, in agenda +#+cindex: query editing, in agenda + +The general filtering command is ~org-agenda-filter~, bound to +{{{kbd(/)}}}. Before we introduce it, we describe commands for +individual filter types. All filtering commands handle prefix +arguments in the same way: A single {{{kbd(C-u)}}} prefix negates the +filter, so it removes lines selected by the filter. A double prefix +adds the new filter condition to the one(s) already in place, so +filter elements are accumulated. + +- {{{kbd(\)}}} (~org-agenda-filter-by-tag~) :: + + #+findex: org-agenda-filter-by-tag + Filter the agenda view with respect to a tag. You are prompted for + a tag selection letter; {{{kbd(SPC)}}} means any tag at all. + Pressing {{{kbd(TAB)}}} at that prompt offers completion to select a + tag, including any tags that do not have a selection character. The + command then hides all entries that do not contain or inherit this + tag. Pressing {{{kbd(+)}}} or {{{kbd(-)}}} at the prompt switches + between filtering for and against the next tag. To clear the + filter, press {{{kbd(\)}}} twice (once to call the command again, + and once at the prompt). + +- {{{kbd(<)}}} (~org-agenda-filter-by-category~) :: + + #+findex: org-agenda-filter-by-category + Filter by category of the line at point, and show only entries with + this category. When called with a prefix argument, hide all entries + with the category at point. To clear the filter, call this command + again by pressing {{{kbd(<)}}}. + +- {{{kbd(=)}}} (~org-agenda-filter-by-regexp~) :: + + #+findex: org-agenda-filter-by-regexp + Filter the agenda view by a regular expression: only show agenda + entries matching the regular expression the user entered. To clear + the filter, call the command again by pressing {{{kbd(=)}}}. + +- {{{kbd(_)}}} (~org-agenda-filter-by-effort~) :: + + #+findex: org-agenda-filter-by-effort + Filter the agenda view with respect to effort estimates, so select + tasks that take the right amount of time. You first need to set up + a list of efforts globally, for example + + #+begin_src emacs-lisp + (setq org-global-properties + '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) + #+end_src + + #+vindex: org-sort-agenda-noeffort-is-high + You can then filter for an effort by first typing an operator, one + of {{{kbd(<)}}}, {{{kbd(>)}}} and {{{kbd(=)}}}, and then the + one-digit index of an effort estimate in your array of allowed + values, where {{{kbd(0)}}} means the 10th value. The filter then + restricts to entries with effort smaller-or-equal, equal, or + larger-or-equal than the selected value. For application of the + operator, entries without a defined effort are treated according to + the value of ~org-sort-agenda-noeffort-is-high~. To clear the + filter, press {{{kbd(_)}}} twice (once to call the command again, + and once at the first prompt). + +- {{{kbd(^)}}} (~org-agenda-filter-by-top-headline~) :: + + #+findex: org-agenda-filter-by-top-headline + Filter the current agenda view and only display items that fall + under the same top-level headline as the current entry. To clear + the filter, call this command again by pressing {{{kbd(^)}}}. + +- {{{kbd(/)}}} (~org-agenda-filter~) :: + + #+findex: org-agenda-filter + This is the unified interface to four of the five filter methods + described above. At the prompt, specify different filter elements + in a single string, with full completion support. For example, + + : +work-John+<0:10-/plot/ + + selects entries with category =work= and effort estimates below 10 + minutes, and deselects entries with tag =John= or matching the + regexp =plot=. You can leave =+= out if that does not lead to + ambiguities. The sequence of elements is arbitrary. The filter + syntax assumes that there is no overlap between categories and tags. + Otherwise, tags take priority. If you reply to the prompt with the + empty string, all filtering is removed. If a filter is specified, + it replaces all current filters. But if you call the command with + a double prefix argument, or if you add an additional =+= (e.g., + =++work=) to the front of the string, the new filter elements are + added to the active ones. A single prefix argument applies the + entire filter in a negative sense. + +- {{{kbd(|)}}} (~org-agenda-filter-remove-all~) :: + + Remove all filters in the current agenda view. + +**** Computed tag filtering +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+vindex: org-agenda-auto-exclude-function +If the variable ~org-agenda-auto-exclude-function~ is set to +a user-defined function, that function can select tags that should be +used as a tag filter when requested. The function will be called with +lower-case versions of all tags represented in the current view. The +function should return ="-tag"= if the filter should remove +entries with that tag, ="+tag"= if only entries with this tag should +be kept, or =nil= if that tag is irrelevant. For example, let's say +you use a =Net= tag to identify tasks which need network access, an +=Errand= tag for errands in town, and a =Call= tag for making phone +calls. You could auto-exclude these tags based on the availability of +the Internet, and outside of business hours, with something like this: + +#+begin_src emacs-lisp +(defun my-auto-exclude-fn (tag) + (when (cond ((string= tag "net") + (/= 0 (call-process "/sbin/ping" nil nil nil + "-c1" "-q" "-t1" "mail.gnu.org"))) + ((member tag '("errand" "call")) + (let ((hr (nth 2 (decode-time)))) + (or (< hr 8) (> hr 21))))) + (concat "-" tag))) + +(setq org-agenda-auto-exclude-function #'my-auto-exclude-fn) +#+end_src + +You can apply this self-adapting filter by using a triple prefix +argument to ~org-agenda-filter~, i.e.\nbsp{}press {{{kbd(C-u C-u C-u /)}}}, +or by pressing {{{kbd(RET)}}} in ~org-agenda-filter-by-tag~. + +**** Setting limits for the agenda +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: limits, in agenda + +Here is a list of options that you can set, either globally, or +locally in your custom agenda views (see [[*Custom Agenda Views]]). + +- ~org-agenda-max-entries~ :: + + #+vindex: org-agenda-max-entries + Limit the number of entries. + +- ~org-agenda-max-effort~ :: + + #+vindex: org-agenda-max-effort + Limit the duration of accumulated efforts (as minutes). + +- ~org-agenda-max-todos~ :: + + #+vindex: org-agenda-max-todos + Limit the number of entries with TODO keywords. + +- ~org-agenda-max-tags~ :: + + #+vindex: org-agenda-max-tags + Limit the number of tagged entries. + +When set to a positive integer, each option excludes entries from +other categories: for example, =(setq org-agenda-max-effort 100)= +limits the agenda to 100 minutes of effort and exclude any entry that +has no effort property. If you want to include entries with no effort +property, use a negative value for ~org-agenda-max-effort~. One +useful setup is to use ~org-agenda-max-entries~ locally in a custom +command. For example, this custom command displays the next five +entries with a =NEXT= TODO keyword. + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("n" todo "NEXT" + ((org-agenda-max-entries 5))))) +#+end_src + +Once you mark one of these five entry as DONE, rebuilding the agenda +will again the next five entries again, including the first entry that +was excluded so far. + +You can also dynamically set temporary limits, which are lost when +rebuilding the agenda: + +- {{{kbd(~ )}}} (~org-agenda-limit-interactively~) :: + + #+findex: org-agenda-limit-interactively + This prompts for the type of limit to apply and its value. + +** Commands in the Agenda Buffer +:PROPERTIES: +:DESCRIPTION: Remote editing of Org trees. +:ALT_TITLE: Agenda Commands +:END: +#+cindex: commands, in agenda buffer + +Entries in the agenda buffer are linked back to the Org file or diary +file where they originate. You are not allowed to edit the agenda +buffer itself, but commands are provided to show and jump to the +original entry location, and to edit the Org files "remotely" from the +agenda buffer. In this way, all information is stored only once, +removing the risk that your agenda and note files may diverge. + +Some commands can be executed with mouse clicks on agenda lines. For +the other commands, point needs to be in the desired line. + +*** Motion +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: motion commands in agenda + +- {{{kbd(n)}}} (~org-agenda-next-line~) :: + + #+kindex: n + #+findex: org-agenda-next-line + Next line (same as {{{kbd(DOWN)}}} and {{{kbd(C-n)}}}). + +- {{{kbd(p)}}} (~org-agenda-previous-line~) :: + + #+kindex: p + #+findex: org-agenda-previous-line + Previous line (same as {{{kbd(UP)}}} and {{{kbd(C-p)}}}). + +*** View/Go to Org file +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: view file commands in agenda + +- {{{kbd(SPC)}}} or {{{kbd(mouse-3)}}} (~org-agenda-show-and-scroll-up~) :: + + #+kindex: SPC + #+kindex: mouse-3 + #+findex: org-agenda-show-and-scroll-up + Display the original location of the item in another window. + With a prefix argument, make sure that drawers stay folded. + +- {{{kbd(L)}}} (~org-agenda-recenter~) :: + + #+findex: org-agenda-recenter + Display original location and recenter that window. + +- {{{kbd(TAB)}}} or {{{kbd(mouse-2)}}} (~org-agenda-goto~) :: + + #+kindex: TAB + #+kindex: mouse-2 + #+findex: org-agenda-goto + Go to the original location of the item in another window. + +- {{{kbd(RET)}}} (~org-agenda-switch-to~) :: + + #+kindex: RET + #+findex: org-agenda-switch-to + Go to the original location of the item and delete other windows. + +- {{{kbd(F)}}} (~org-agenda-follow-mode~) :: + + #+kindex: F + #+findex: org-agenda-follow-mode + #+vindex: org-agenda-start-with-follow-mode + Toggle Follow mode. In Follow mode, as you move point through the + agenda buffer, the other window always shows the corresponding + location in the Org file. The initial setting for this mode in new + agenda buffers can be set with the variable + ~org-agenda-start-with-follow-mode~. + +- {{{kbd(C-c C-x b)}}} (~org-agenda-tree-to-indirect-buffer~) :: + + #+kindex: C-c C-x b + #+findex: org-agenda-tree-to-indirect-buffer + Display the entire subtree of the current item in an indirect + buffer. With a numeric prefix argument N, go up to level N and then + take that tree. If N is negative, go up that many levels. With + a {{{kbd(C-u)}}} prefix, do not remove the previously used indirect + buffer. + +- {{{kbd(C-c C-o)}}} (~org-agenda-open-link~) :: + + #+kindex: C-c C-o + #+findex: org-agenda-open-link + Follow a link in the entry. This offers a selection of any links in + the text belonging to the referenced Org node. If there is only one + link, follow it without a selection prompt. + +*** Change display +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: change agenda display +#+cindex: display changing, in agenda + +#+attr_texinfo: :sep , +- {{{kbd(A)}}} :: + + #+kindex: A + Interactively select another agenda view and append it to the + current view. + +- {{{kbd(o)}}} :: + + #+kindex: o + Delete other windows. + +- {{{kbd(v d)}}} or short {{{kbd(d)}}} (~org-agenda-day-view~) :: + + #+kindex: v d + #+kindex: d + #+findex: org-agenda-day-view + Switch to day view. When switching to day view, this setting + becomes the default for subsequent agenda refreshes. A numeric + prefix argument may be used to jump directly to a specific day of + the year. For example, {{{kbd(32 d)}}} jumps to February 1st. When + setting day view, a year may be encoded in the prefix argument as + well. For example, {{{kbd(200712 d)}}} jumps to January 12, 2007. + If such a year specification has only one or two digits, it is + expanded into one of the 30 next years or the last 69 years. + +- {{{kbd(v w)}}} or short {{{kbd(w)}}} (~org-agenda-week-view~) :: + + #+kindex: v w + #+kindex: w + #+findex: org-agenda-week-view + Switch to week view. When switching week view, this setting becomes + the default for subsequent agenda refreshes. A numeric prefix + argument may be used to jump directly to a specific day of the ISO + week. For example {{{kbd(9 w)}}} to ISO week number 9. When + setting week view, a year may be encoded in the prefix argument as + well. For example, {{{kbd(200712 w)}}} jumps to week 12 in 2007. + If such a year specification has only one or two digits, it is + expanded into one of the 30 next years or the last 69 years. + +- {{{kbd(v m)}}} (~org-agenda-month-view~) :: + + #+kindex: v m + #+findex: org-agenda-month-view + Switch to month view. Because month views are slow to create, they + do not become the default for subsequent agenda refreshes. + A numeric prefix argument may be used to jump directly to a specific + day of the month. When setting month view, a year may be encoded in + the prefix argument as well. For example, {{{kbd(200712 m)}}} jumps + to December, 2007. If such a year specification has only one or two + digits, it is expanded into one of the 30 next years or the last 69 + years. + +- {{{kbd(v y)}}} (~org-agenda-year-view~) :: + + #+kindex: v y + #+findex: org-agenda-year-view + Switch to year view. Because year views are slow to create, they do + not become the default for subsequent agenda refreshes. A numeric + prefix argument may be used to jump directly to a specific day of + the year. + +- {{{kbd(v SPC)}}} (~org-agenda-reset-view~) :: + + #+kindex: v SPC + #+findex: org-agenda-reset-view + #+vindex: org-agenda-span + Reset the current view to ~org-agenda-span~. + +- {{{kbd(f)}}} (~org-agenda-later~) :: + + #+kindex: f + #+findex: org-agenda-later + Go forward in time to display the span following the current one. + For example, if the display covers a week, switch to the following + week. With a prefix argument, repeat that many times. + +- {{{kbd(b)}}} (~org-agenda-earlier~) :: + + #+kindex: b + #+findex: org-agenda-earlier + Go backward in time to display earlier dates. + +- {{{kbd(.)}}} (~org-agenda-goto-today~) :: + + #+kindex: . + #+findex: org-agenda-goto-today + Go to today. + +- {{{kbd(j)}}} (~org-agenda-goto-date~) :: + + #+kindex: j + #+findex: org-agenda-goto-date + Prompt for a date and go there. + +- {{{kbd(J)}}} (~org-agenda-clock-goto~) :: + + #+kindex: J + #+findex: org-agenda-clock-goto + Go to the currently clocked-in task /in the agenda buffer/. + +- {{{kbd(D)}}} (~org-agenda-toggle-diary~) :: + + #+kindex: D + #+findex: org-agenda-toggle-diary + Toggle the inclusion of diary entries. See [[*Weekly/daily agenda]]. + +- {{{kbd(v l)}}} or {{{kbd(v L)}}} or short {{{kbd(l)}}} (~org-agenda-log-mode~) :: + + #+kindex: v l + #+kindex: l + #+kindex: v L + #+findex: org-agenda-log-mode + #+vindex: org-log-done + #+vindex: org-agenda-log-mode-items + Toggle Logbook mode. In Logbook mode, entries that were marked as + done while logging was on (see the variable ~org-log-done~) are + shown in the agenda, as are entries that have been clocked on that + day. You can configure the entry types that should be included in + log mode using the variable ~org-agenda-log-mode-items~. When + called with a {{{kbd(C-u)}}} prefix argument, show all possible + logbook entries, including state changes. When called with two + prefix arguments {{{kbd(C-u C-u)}}}, show only logging information, + nothing else. {{{kbd(v L)}}} is equivalent to {{{kbd(C-u v l)}}}. + +- {{{kbd(v [)}}} or short {{{kbd([)}}} (~org-agenda-manipulate-query-add~) :: + + #+kindex: v [ + #+kindex: [ + #+findex: org-agenda-manipulate-query-add + Include inactive timestamps into the current view. Only for + weekly/daily agenda. + +- {{{kbd(v a)}}} (~org-agenda-archives-mode~) :: + + #+kindex: v a + #+findex: org-agenda-archives-mode + Toggle Archives mode. In Archives mode, trees that are archived + (see [[*Internal archiving]]) are also scanned when producing the + agenda. To exit archives mode, press {{{kbd(v a)}}} again. + +- {{{kbd(v A)}}} :: + + #+kindex: v A + Toggle Archives mode. Include all archive files as well. + +- {{{kbd(v R)}}} or short {{{kbd(R)}}} (~org-agenda-clockreport-mode~) :: + + #+kindex: v R + #+kindex: R + #+findex: org-agenda-clockreport-mode + #+vindex: org-agenda-start-with-clockreport-mode + #+vindex: org-clock-report-include-clocking-task + Toggle Clockreport mode. In Clockreport mode, the daily/weekly + agenda always shows a table with the clocked times for the time span + and file scope covered by the current agenda view. The initial + setting for this mode in new agenda buffers can be set with the + variable ~org-agenda-start-with-clockreport-mode~. By using + a prefix argument when toggling this mode (i.e., {{{kbd(C-u R)}}}), + the clock table does not show contributions from entries that are + hidden by agenda filtering[fn:99]. See also the variable + ~org-clock-report-include-clocking-task~. + +- {{{kbd(v c)}}} :: + + #+kindex: v c + #+vindex: org-agenda-clock-consistency-checks + Show overlapping clock entries, clocking gaps, and other clocking + problems in the current agenda range. You can then visit clocking + lines and fix them manually. See the variable + ~org-agenda-clock-consistency-checks~ for information on how to + customize the definition of what constituted a clocking problem. To + return to normal agenda display, press {{{kbd(l)}}} to exit Logbook + mode. + +- {{{kbd(v E)}}} or short {{{kbd(E)}}} (~org-agenda-entry-text-mode~) :: + + #+kindex: v E + #+kindex: E + #+findex: org-agenda-entry-text-mode + #+vindex: org-agenda-start-with-entry-text-mode + #+vindex: org-agenda-entry-text-maxlines + Toggle entry text mode. In entry text mode, a number of lines from + the Org outline node referenced by an agenda line are displayed + below the line. The maximum number of lines is given by the + variable ~org-agenda-entry-text-maxlines~. Calling this command + with a numeric prefix argument temporarily modifies that number to + the prefix value. + +- {{{kbd(G)}}} (~org-agenda-toggle-time-grid~) :: + + #+kindex: G + #+vindex: org-agenda-use-time-grid + #+vindex: org-agenda-time-grid + Toggle the time grid on and off. See also the variables + ~org-agenda-use-time-grid~ and ~org-agenda-time-grid~. + +- {{{kbd(r)}}} (~org-agenda-redo~), {{{kbd(g)}}} :: + + #+kindex: r + #+kindex: g + #+findex: org-agenda-redo + Recreate the agenda buffer, for example to reflect the changes after + modification of the timestamps of items with {{{kbd(S-LEFT)}}} and + {{{kbd(S-RIGHT)}}}. When the buffer is the global TODO list, + a prefix argument is interpreted to create a selective list for + a specific TODO keyword. + +- {{{kbd(C-x C-s)}}} or short {{{kbd(s)}}} (~org-save-all-org-buffers~) :: + + #+kindex: C-x C-s + #+findex: org-save-all-org-buffers + #+kindex: s + Save all Org buffers in the current Emacs session, and also the + locations of IDs. + +- {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) :: + + #+kindex: C-c C-x C-c + #+findex: org-agenda-columns + #+vindex: org-columns-default-format + Invoke column view (see [[*Column View]]) in the agenda buffer. The + column view format is taken from the entry at point, or, if there is + no entry at point, from the first entry in the agenda view. So + whatever the format for that entry would be in the original buffer + (taken from a property, from a =COLUMNS= keyword, or from the + default variable ~org-columns-default-format~) is used in the + agenda. + +- {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) :: + + #+kindex: C-c C-x > + #+findex: org-agenda-remove-restriction-lock + Remove the restriction lock on the agenda, if it is currently + restricted to a file or subtree (see [[*Agenda Files]]). + +- {{{kbd(M-UP)}}} (~org-agenda-drag-line-backward~) :: + + #+kindex: M-UP + #+findex: org-agenda-drag-line-backward + Drag the line at point backward one line. With a numeric prefix + argument, drag backward by that many lines. + + Moving agenda lines does not persist after an agenda refresh and + does not modify the contributing Org files. + +- {{{kbd(M-DOWN)}}} (~org-agenda-drag-line-forward~) :: + + #+kindex: M-DOWN + #+findex: org-agenda-drag-line-forward + Drag the line at point forward one line. With a numeric prefix + argument, drag forward by that many lines. + +*** Remote editing +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: remote editing, from agenda + +- {{{kbd(0--9)}}} :: + + Digit argument. + +- {{{kbd(C-_)}}} (~org-agenda-undo~) :: + + #+kindex: C-_ + #+findex: org-agenda-undo + #+cindex: undoing remote-editing events + #+cindex: remote editing, undo + Undo a change due to a remote editing command. The change is undone + both in the agenda buffer and in the remote buffer. + +- {{{kbd(t)}}} (~org-agenda-todo~) :: + + #+kindex: t + #+findex: org-agenda-todo + Change the TODO state of the item, both in the agenda and in the + original Org file. A prefix arg is passed through to the ~org-todo~ + command, so for example a {{{kbd(C-u)}}} prefix are will trigger + taking a note to document the state change. + +- {{{kbd(C-S-RIGHT)}}} (~org-agenda-todo-nextset~) :: + + #+kindex: C-S-RIGHT + #+findex: org-agenda-todo-nextset + Switch to the next set of TODO keywords. + +- {{{kbd(C-S-LEFT)}}}, ~org-agenda-todo-previousset~ :: + + #+kindex: C-S-LEFT + Switch to the previous set of TODO keywords. + +- {{{kbd(C-k)}}} (~org-agenda-kill~) :: + + #+kindex: C-k + #+findex: org-agenda-kill + #+vindex: org-agenda-confirm-kill + Delete the current agenda item along with the entire subtree + belonging to it in the original Org file. If the text to be deleted + remotely is longer than one line, the kill needs to be confirmed by + the user. See variable ~org-agenda-confirm-kill~. + +- {{{kbd(C-c C-w)}}} (~org-agenda-refile~) :: + + #+kindex: C-c C-w + #+findex: org-agenda-refile + Refile the entry at point. + +- {{{kbd(C-c C-x C-a)}}} or short {{{kbd(a)}}} (~org-agenda-archive-default-with-confirmation~) :: + + #+kindex: C-c C-x C-a + #+kindex: a + #+findex: org-agenda-archive-default-with-confirmation + #+vindex: org-archive-default-command + Archive the subtree corresponding to the entry at point using the + default archiving command set in ~org-archive-default-command~. + When using the {{{kbd(a)}}} key, confirmation is required. + +- {{{kbd(C-c C-x a)}}} (~org-agenda-toggle-archive-tag~) :: + + #+kindex: C-c C-x a + #+findex: org-agenda-toggle-archive-tag + Toggle the archive tag (see [[*Internal archiving]]) for the current + headline. + +- {{{kbd(C-c C-x A)}}} (~org-agenda-archive-to-archive-sibling~) :: + + #+kindex: C-c C-x A + #+findex: org-agenda-archive-to-archive-sibling + Move the subtree corresponding to the current entry to its /archive + sibling/. + +- {{{kbd(C-c C-x C-s)}}} or short {{{kbd($)}}} (~org-agenda-archive~) :: + + #+kindex: C-c C-x C-s + #+kindex: $ + #+findex: org-agenda-archive + Archive the subtree corresponding to the current headline. This + means the entry is moved to the configured archive location, most + likely a different file. + +- {{{kbd(T)}}} (~org-agenda-show-tags~) :: + + #+kindex: T + #+findex: org-agenda-show-tags + #+vindex: org-agenda-show-inherited-tags + Show all tags associated with the current item. This is useful if + you have turned off ~org-agenda-show-inherited-tags~, but still want + to see all tags of a headline occasionally. + +- {{{kbd(:)}}} (~org-agenda-set-tags~) :: + + #+kindex: : + #+findex: org-agenda-set-tags + Set tags for the current headline. If there is an active region in + the agenda, change a tag for all headings in the region. + +- {{{kbd(\,)}}} (~org-agenda-priority~) :: + + #+kindex: , + #+findex: org-agenda-priority + Set the priority for the current item. Org mode prompts for the + priority character. If you reply with {{{kbd(SPC)}}}, the priority + cookie is removed from the entry. + +- {{{kbd(+)}}} or {{{kbd(S-UP)}}} (~org-agenda-priority-up~) :: + + #+kindex: + + #+kindex: S-UP + #+findex: org-agenda-priority-up + Increase the priority of the current item. The priority is changed + in the original buffer, but the agenda is not resorted. Use the + {{{kbd(r)}}} key for this. + +- {{{kbd(-)}}} or {{{kbd(S-DOWN)}}} (~org-agenda-priority-down~) :: + + #+kindex: - + #+kindex: S-DOWN + #+findex: org-agenda-priority-down + Decrease the priority of the current item. + +- {{{kbd(C-c C-x e)}}} or short {{{kbd(e)}}} (~org-agenda-set-effort~) :: + + #+kindex: e + #+kindex: C-c C-x e + #+findex: org-agenda-set-effort + Set the effort property for the current item. + +- {{{kbd(C-c C-z)}}} or short {{{kbd(z)}}} (~org-agenda-add-note~) :: + + #+kindex: z + #+kindex: C-c C-z + #+findex: org-agenda-add-note + #+vindex: org-log-into-drawer + Add a note to the entry. This note is recorded, and then filed to + the same location where state change notes are put. Depending on + ~org-log-into-drawer~, this may be inside a drawer. + +- {{{kbd(C-c C-a)}}} (~org-attach~) :: + + #+kindex: C-c C-a + #+findex: org-attach + Dispatcher for all command related to attachments. + +- {{{kbd(C-c C-s)}}} (~org-agenda-schedule~) :: + + #+kindex: C-c C-s + #+findex: org-agenda-schedule + Schedule this item. With a prefix argument, remove the + scheduling timestamp + +- {{{kbd(C-c C-d)}}} (~org-agenda-deadline~) :: + + #+kindex: C-c C-d + #+findex: org-agenda-deadline + Set a deadline for this item. With a prefix argument, remove the + deadline. + +- {{{kbd(S-RIGHT)}}} (~org-agenda-do-date-later~) :: + + #+kindex: S-RIGHT + #+findex: org-agenda-do-date-later + Change the timestamp associated with the current line by one day + into the future. If the date is in the past, the first call to this + command moves it to today. With a numeric prefix argument, change + it by that many days. For example, {{{kbd(3 6 5 S-RIGHT)}}} changes + it by a year. With a {{{kbd(C-u)}}} prefix, change the time by one + hour. If you immediately repeat the command, it will continue to + change hours even without the prefix argument. With a double + {{{kbd(C-u C-u)}}} prefix, do the same for changing minutes. The + stamp is changed in the original Org file, but the change is not + directly reflected in the agenda buffer. Use {{{kbd(r)}}} or + {{{kbd(g)}}} to update the buffer. + +- {{{kbd(S-LEFT)}}} (~org-agenda-do-date-earlier~) :: + + #+kindex: S-LEFT + #+findex: org-agenda-do-date-earlier + Change the timestamp associated with the current line by one day + into the past. + +- {{{kbd(>)}}} (~org-agenda-date-prompt~) :: + + #+kindex: > + #+findex: org-agenda-date-prompt + Change the timestamp associated with the current line. The key + {{{kbd(>)}}} has been chosen, because it is the same as + {{{kbd(S-.)}}} on my keyboard. + +- {{{kbd(I)}}} (~org-agenda-clock-in~) :: + + #+kindex: I + #+findex: org-agenda-clock-in + Start the clock on the current item. If a clock is running already, + it is stopped first. + +- {{{kbd(O)}}} (~org-agenda-clock-out~) :: + + #+kindex: O + #+findex: org-agenda-clock-out + Stop the previously started clock. + +- {{{kbd(X)}}} (~org-agenda-clock-cancel~) :: + + #+kindex: X + #+findex: org-agenda-clock-cancel + Cancel the currently running clock. + +- {{{kbd(J)}}} (~org-agenda-clock-goto~) :: + + #+kindex: J + #+findex: org-agenda-clock-goto + Jump to the running clock in another window. + +- {{{kbd(k)}}} (~org-agenda-capture~) :: + + #+kindex: k + #+findex: org-agenda-capture + #+cindex: capturing, from agenda + #+vindex: org-capture-use-agenda-date + Like ~org-capture~, but use the date at point as the default date + for the capture template. See ~org-capture-use-agenda-date~ to make + this the default behavior of ~org-capture~. + +*** Bulk remote editing selected entries +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: remote editing, bulk, from agenda +#+vindex: org-agenda-bulk-custom-functions + +- {{{kbd(m)}}} (~org-agenda-bulk-mark~) :: + #+kindex: m + #+findex: org-agenda-bulk-mark + + Mark the entry at point for bulk action. If there is an active + region in the agenda, mark the entries in the region. With numeric + prefix argument, mark that many successive entries. + +- {{{kbd(*)}}} (~org-agenda-bulk-mark-all~) :: + #+kindex: * + #+findex: org-agenda-bulk-mark-all + + Mark all visible agenda entries for bulk action. + +- {{{kbd(u)}}} (~org-agenda-bulk-unmark~) :: + #+kindex: u + #+findex: org-agenda-bulk-unmark + + Unmark entry for bulk action. + +- {{{kbd(U)}}} (~org-agenda-bulk-remove-all-marks~) :: + #+kindex: U + #+findex: org-agenda-bulk-remove-all-marks + + Unmark all marked entries for bulk action. + +- {{{kbd(M-m)}}} (~org-agenda-bulk-toggle~) :: + #+kindex: M-m + #+findex: org-agenda-bulk-toggle + + Toggle mark of the entry at point for bulk action. + +- {{{kbd(M-*)}}} (~org-agenda-bulk-toggle-all~) :: + #+kindex: M-* + #+findex: org-agenda-bulk-toggle-all + + Toggle mark of every entry for bulk action. + +- {{{kbd(%)}}} (~org-agenda-bulk-mark-regexp~) :: + #+kindex: % + #+findex: org-agenda-bulk-mark-regexp + + Mark entries matching a regular expression for bulk action. + +- {{{kbd(B)}}} (~org-agenda-bulk-action~) :: + #+kindex: B + #+findex: org-agenda-bulk-action + #+vindex: org-agenda-bulk-persistent-marks + + Bulk action: act on all marked entries in the agenda. This prompts + for another key to select the action to be applied. The prefix + argument to {{{kbd(B)}}} is passed through to the {{{kbd(s)}}} and + {{{kbd(d)}}} commands, to bulk-remove these special timestamps. By + default, marks are removed after the bulk. If you want them to + persist, set ~org-agenda-bulk-persistent-marks~ to ~t~ or hit + {{{kbd(p)}}} at the prompt. + + - {{{kbd(p)}}} :: + + Toggle persistent marks. + + - {{{kbd($)}}} :: + + Archive all selected entries. + + - {{{kbd(A)}}} :: + + Archive entries by moving them to their respective archive + siblings. + + - {{{kbd(t)}}} :: + + Change TODO state. This prompts for a single TODO keyword and + changes the state of all selected entries, bypassing blocking and + suppressing logging notes---but not timestamps. + + - {{{kbd(+)}}} :: + + Add a tag to all selected entries. + + - {{{kbd(-)}}} :: + + Remove a tag from all selected entries. + + - {{{kbd(s)}}} :: + + Schedule all items to a new date. To shift existing schedule + dates by a fixed number of days, use something starting with + double plus at the prompt, for example =++8d= or =++2w=. + + - {{{kbd(d)}}} :: + + Set deadline to a specific date. + + - {{{kbd(r)}}} :: + + Prompt for a single refile target and move all entries. The + entries are no longer in the agenda; refresh ({{{kbd(g)}}}) to + bring them back. + + - {{{kbd(S)}}} :: + + Reschedule randomly into the coming N days. N is prompted for. + With a prefix argument ({{{kbd(C-u B S)}}}), scatter only across + weekdays. + + - {{{kbd(f)}}} :: + + #+vindex: org-agenda-bulk-custom-functions + Apply a function[fn:100] to marked entries. For example, the + function below sets the =CATEGORY= property of the entries to + =web=. + + #+begin_src emacs-lisp + (defun set-category () + (interactive "P") + (let ((marker (or (org-get-at-bol 'org-hd-marker) + (org-agenda-error)))) + (org-with-point-at marker + (org-back-to-heading t) + (org-set-property "CATEGORY" "web")))) + #+end_src + +*** Calendar commands +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: calendar commands, from agenda + +- {{{kbd(c)}}} (~org-agenda-goto-calendar~) :: + + #+kindex: c + #+findex: org-agenda-goto-calendar + Open the Emacs calendar and go to the date at point in the agenda. + +- {{{kbd(c)}}} (~org-calendar-goto-agenda~) :: + + #+kindex: c + #+findex: org-calendar-goto-agenda + When in the calendar, compute and show the Org agenda for the date + at point. + +- {{{kbd(i)}}} (~org-agenda-diary-entry~) :: + #+kindex: i + #+findex: org-agenda-diary-entry + + #+cindex: diary entries, creating from agenda + Insert a new entry into the diary, using the date at point and (for + block entries) the date at the mark. This adds to the Emacs diary + file[fn:101], in a way similar to the {{{kbd(i)}}} command in the + calendar. The diary file pops up in another window, where you can + add the entry. + + #+vindex: org-agenda-diary-file + If you configure ~org-agenda-diary-file~ to point to an Org file, + Org creates entries in that file instead. Most entries are stored + in a date-based outline tree that will later make it easy to archive + appointments from previous months/years. The tree is built under an + entry with a =DATE_TREE= property, or else with years as top-level + entries. Emacs prompts you for the entry text---if you specify it, + the entry is created in ~org-agenda-diary-file~ without further + interaction. If you directly press {{{kbd(RET)}}} at the prompt + without typing text, the target file is shown in another window for + you to finish the entry there. See also the {{{kbd(k r)}}} command. + +- {{{kbd(M)}}} (~org-agenda-phases-of-moon~) :: + + #+kindex: M + #+findex: org-agenda-phases-of-moon + Show the phases of the moon for the three months around current + date. + +- {{{kbd(S)}}} (~org-agenda-sunrise-sunset~) :: + + #+kindex: S + #+findex: org-agenda-sunrise-sunset + Show sunrise and sunset times. The geographical location must be + set with calendar variables, see the documentation for the Emacs + calendar. + +- {{{kbd(C)}}} (~org-agenda-convert-date~) :: + + #+kindex: C + #+findex: org-agenda-convert-date + Convert the date at point into many other cultural and historic + calendars. + +- {{{kbd(H)}}} (~org-agenda-holidays~) :: + + #+kindex: H + #+findex: org-agenda-holidays + Show holidays for three months around point date. + +*** Quit and exit +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(q)}}} (~org-agenda-quit~) :: + #+kindex: q + #+findex: org-agenda-quit + + Quit agenda, remove the agenda buffer. + +- {{{kbd(x)}}} (~org-agenda-exit~) :: + #+kindex: x + #+findex: org-agenda-exit + + #+cindex: agenda files, removing buffers + Exit agenda, remove the agenda buffer and all buffers loaded by + Emacs for the compilation of the agenda. Buffers created by the + user to visit Org files are not removed. + +** Custom Agenda Views +:PROPERTIES: +:DESCRIPTION: Defining special searches and views. +:END: +#+cindex: custom agenda views +#+cindex: agenda views, custom + +Custom agenda commands serve two purposes: to store and quickly access +frequently used TODO and tags searches, and to create special +composite agenda buffers. Custom agenda commands are accessible +through the dispatcher (see [[*The Agenda Dispatcher]]), just like the +default commands. + +*** Storing searches +:PROPERTIES: +:DESCRIPTION: Type once, use often. +:END: + +The first application of custom searches is the definition of keyboard +shortcuts for frequently used searches, either creating an agenda +buffer, or a sparse tree (the latter covering of course only the +current buffer). + +#+kindex: C @r{(Agenda dispatcher)} +#+vindex: org-agenda-custom-commands +#+cindex: agenda views, main example +#+cindex: agenda, as an agenda views +#+cindex: agenda*, as an agenda views +#+cindex: tags, as an agenda view +#+cindex: todo, as an agenda view +#+cindex: tags-todo +#+cindex: todo-tree +#+cindex: occur-tree +#+cindex: tags-tree +Custom commands are configured in the variable +~org-agenda-custom-commands~. You can customize this variable, for +example by pressing {{{kbd(C)}}} from the agenda dispatcher (see [[*The +Agenda Dispatcher]]). You can also directly set it with Emacs Lisp in +the Emacs init file. The following example contains all valid agenda +views: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("x" agenda) + ("y" agenda*) + ("w" todo "WAITING") + ("W" todo-tree "WAITING") + ("u" tags "+boss-urgent") + ("v" tags-todo "+boss-urgent") + ("U" tags-tree "+boss-urgent") + ("f" occur-tree "\\<FIXME\\>") + ("h" . "HOME+Name tags searches") ;description for "h" prefix + ("hl" tags "+home+Lisa") + ("hp" tags "+home+Peter") + ("hk" tags "+home+Kim"))) +#+end_src + +The initial string in each entry defines the keys you have to press +after the dispatcher command in order to access the command. Usually +this is just a single character, but if you have many similar +commands, you can also define two-letter combinations where the first +character is the same in several combinations and serves as a prefix +key[fn:102]. The second parameter is the search type, followed by the +string or regular expression to be used for the matching. The example +above will therefore define: + +- {{{kbd(x)}}} :: + + as a global search for agenda entries planned[fn:103] this week/day. + +- {{{kbd(y)}}} :: + + as the same search, but only for entries with an hour specification + like =[h]h:mm=---think of them as appointments. + +- {{{kbd(w)}}} :: + + as a global search for TODO entries with =WAITING= as the TODO + keyword. + +- {{{kbd(W)}}} :: + + as the same search, but only in the current buffer and displaying + the results as a sparse tree. + +- {{{kbd(u)}}} :: + + as a global tags search for headlines tagged =boss= but not + =urgent=. + +- {{{kbd(v)}}} :: + + The same search, but limiting it to headlines that are also TODO + items. + +- {{{kbd(U)}}} :: + + as the same search, but only in the current buffer and displaying + the result as a sparse tree. + +- {{{kbd(f)}}} :: + + to create a sparse tree (again, current buffer only) with all + entries containing the word =FIXME=. + +- {{{kbd(h)}}} :: + + as a prefix command for a =HOME= tags search where you have to press + an additional key ({{{kbd(l)}}}, {{{kbd(p)}}} or {{{kbd(k)}}}) to + select a name (Lisa, Peter, or Kim) as additional tag to match. + +Note that ~*-tree~ agenda views need to be called from an Org buffer +as they operate on the current buffer only. + +*** Block agenda +:PROPERTIES: +:DESCRIPTION: All the stuff you need in a single buffer. +:END: +#+cindex: block agenda +#+cindex: agenda, with block views + +Another possibility is the construction of agenda views that comprise +the results of /several/ commands, each of which creates a block in +the agenda buffer. The available commands include ~agenda~ for the +daily or weekly agenda (as created with {{{kbd(a)}}}) , ~alltodo~ for +the global TODO list (as constructed with {{{kbd(t)}}}), ~stuck~ for +the list of stuck projects (as obtained with {{{kbd(#)}}}) and the +matching commands discussed above: ~todo~, ~tags~, and ~tags-todo~. + +Here are two examples: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("h" "Agenda and Home-related tasks" + ((agenda "") + (tags-todo "home") + (tags "garden"))) + ("o" "Agenda and Office-related tasks" + ((agenda "") + (tags-todo "work") + (tags "office"))))) +#+end_src + +#+texinfo: @noindent +This defines {{{kbd(h)}}} to create a multi-block view for stuff you +need to attend to at home. The resulting agenda buffer contains your +agenda for the current week, all TODO items that carry the tag =home=, +and also all lines tagged with =garden=. Finally the command +{{{kbd(o)}}} provides a similar view for office tasks. + +*** Setting options for custom commands +:PROPERTIES: +:DESCRIPTION: Changing the rules. +:ALT_TITLE: Setting options +:END: +#+cindex: options, for custom agenda views + +#+vindex: org-agenda-custom-commands +Org mode contains a number of variables regulating agenda construction +and display. The global variables define the behavior for all agenda +commands, including the custom commands. However, if you want to +change some settings just for a single custom view, you can do so. +Setting options requires inserting a list of variable names and values +at the right spot in ~org-agenda-custom-commands~. For example: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("w" todo "WAITING" + ((org-agenda-sorting-strategy '(priority-down)) + (org-agenda-prefix-format " Mixed: "))) + ("U" tags-tree "+boss-urgent" + ((org-show-context-detail 'minimal))) + ("N" search "" + ((org-agenda-files '("~org/notes.org")) + (org-agenda-text-search-extra-files nil))))) +#+end_src + +#+texinfo: @noindent +Now the {{{kbd(w)}}} command sorts the collected entries only by +priority, and the prefix format is modified to just say =Mixed:= +instead of giving the category of the entry. The sparse tags tree of +{{{kbd(U)}}} now turns out ultra-compact, because neither the headline +hierarchy above the match, nor the headline following the match are +shown. The command {{{kbd(N)}}} does a text search limited to only +a single file. + +For command sets creating a block agenda, ~org-agenda-custom-commands~ +has two separate spots for setting options. You can add options that +should be valid for just a single command in the set, and options that +should be valid for all commands in the set. The former are just +added to the command entry; the latter must come after the list of +command entries. Going back to the block agenda example (see [[*Block +agenda]]), let's change the sorting strategy for the {{{kbd(h)}}} +commands to ~priority-down~, but let's sort the results for =garden= +tags query in the opposite order, ~priority-up~. This would look like +this: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("h" "Agenda and Home-related tasks" + ((agenda) + (tags-todo "home") + (tags "garden" + ((org-agenda-sorting-strategy '(priority-up))))) + ((org-agenda-sorting-strategy '(priority-down)))) + ("o" "Agenda and Office-related tasks" + ((agenda) + (tags-todo "work") + (tags "office"))))) +#+end_src + +As you see, the values and parentheses setting is a little complex. +When in doubt, use the customize interface to set this variable---it +fully supports its structure. Just one caveat: when setting options +in this interface, the /values/ are just Lisp expressions. So if the +value is a string, you need to add the double-quotes around the value +yourself. + +#+vindex: org-agenda-custom-commands-contexts +To control whether an agenda command should be accessible from +a specific context, you can customize +~org-agenda-custom-commands-contexts~. Let's say for example that you +have an agenda command {{{kbd(o)}}} displaying a view that you only +need when reading emails. Then you would configure this option like +this: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands-contexts + '(("o" (in-mode . "message-mode")))) +#+end_src + +You can also tell that the command key {{{kbd(o)}}} should refer to +another command key {{{kbd(r)}}}. In that case, add this command key +like this: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands-contexts + '(("o" "r" (in-mode . "message-mode")))) +#+end_src + +See the docstring of the variable for more information. + +** Exporting Agenda Views +:PROPERTIES: +:DESCRIPTION: Writing a view to a file. +:END: +#+cindex: agenda views, exporting + +If you are away from your computer, it can be very useful to have +a printed version of some agenda views to carry around. Org mode can +export custom agenda views as plain text, HTML[fn:104], Postscript, +PDF[fn:105], and iCalendar files. If you want to do this only +occasionally, use the following command: + +- {{{kbd(C-x C-w)}}} (~org-agenda-write~) :: + #+kindex: C-x C-w + #+findex: org-agenda-write + #+cindex: exporting agenda views + #+cindex: agenda views, exporting + + #+vindex: org-agenda-exporter-settings + Write the agenda view to a file. + +If you need to export certain agenda views frequently, you can +associate any custom agenda command with a list of output file +names[fn:106]. Here is an example that first defines custom commands +for the agenda and the global TODO list, together with a number of +files to which to export them. Then we define two block agenda +commands and specify file names for them as well. File names can be +relative to the current working directory, or absolute. + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("X" agenda "" nil ("agenda.html" "agenda.ps")) + ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) + ("h" "Agenda and Home-related tasks" + ((agenda "") + (tags-todo "home") + (tags "garden")) + nil + ("~/views/home.html")) + ("o" "Agenda and Office-related tasks" + ((agenda) + (tags-todo "work") + (tags "office")) + nil + ("~/views/office.ps" "~/calendars/office.ics")))) +#+end_src + +The extension of the file name determines the type of export. If it +is =.html=, Org mode uses the htmlize package to convert the buffer to +HTML and save it to this file name. If the extension is =.ps=, +~ps-print-buffer-with-faces~ is used to produce Postscript output. If +the extension is =.ics=, iCalendar export is run export over all files +that were used to construct the agenda, and limit the export to +entries listed in the agenda. Any other extension produces a plain +ASCII file. + +The export files are /not/ created when you use one of those +commands interactively because this might use too much overhead. +Instead, there is a special command to produce /all/ specified +files in one step: + +- {{{kbd(e)}}} (~org-store-agenda-views~) :: + + #+kindex: e @r{(Agenda dispatcher)} + #+findex: org-store-agenda-views + Export all agenda views that have export file names associated with + them. + +You can use the options section of the custom agenda commands to also +set options for the export commands. For example: + +#+begin_src emacs-lisp +(setq org-agenda-custom-commands + '(("X" agenda "" + ((ps-number-of-columns 2) + (ps-landscape-mode t) + (org-agenda-prefix-format " [ ] ") + (org-agenda-with-colors nil) + (org-agenda-remove-tags t)) + ("theagenda.ps")))) +#+end_src + +#+texinfo: @noindent +#+vindex: org-agenda-exporter-settings +This command sets two options for the Postscript exporter, to make it +print in two columns in landscape format---the resulting page can be +cut in two and then used in a paper agenda. The remaining settings +modify the agenda prefix to omit category and scheduling information, +and instead include a checkbox to check off items. We also remove the +tags to make the lines compact, and we do not want to use colors for +the black-and-white printer. Settings specified in +~org-agenda-exporter-settings~ also apply, e.g., + +#+begin_src emacs-lisp +(setq org-agenda-exporter-settings + '((ps-number-of-columns 2) + (ps-landscape-mode t) + (org-agenda-add-entry-text-maxlines 5) + (htmlize-output-type 'css))) +#+end_src + +#+texinfo: @noindent +but the settings in ~org-agenda-custom-commands~ take precedence. + +From the command line you may also use: + +#+begin_src shell +emacs -eval (org-batch-store-agenda-views) -kill +#+end_src + +#+texinfo: @noindent +or, if you need to modify some parameters[fn:107] + +#+begin_src shell +emacs -eval '(org-batch-store-agenda-views \ + org-agenda-span (quote month) \ + org-agenda-start-day "2007-11-01" \ + org-agenda-include-diary nil \ + org-agenda-files (quote ("~/org/project.org")))' \ + -kill +#+end_src + +#+texinfo: @noindent +which creates the agenda views restricted to the file +=~/org/project.org=, without diary entries and with a 30-day extent. + +You can also extract agenda information in a way that allows further +processing by other programs. See [[*Extracting Agenda Information]], for +more information. + +** Using Column View in the Agenda +:PROPERTIES: +:DESCRIPTION: Using column view for collected entries. +:ALT_TITLE: Agenda Column View +:END: +#+cindex: column view, in agenda +#+cindex: agenda, column view + +Column view (see [[*Column View]]) is normally used to view and edit +properties embedded in the hierarchical structure of an Org file. It +can be quite useful to use column view also from the agenda, where +entries are collected by certain criteria. + +- {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) :: + #+kindex: C-c C-x C-c + #+findex: org-agenda-columns + + Turn on column view in the agenda. + +To understand how to use this properly, it is important to realize +that the entries in the agenda are no longer in their proper outline +environment. This causes the following issues: + +1. + #+vindex: org-columns-default-format-for-agenda + #+vindex: org-columns-default-format + Org needs to make a decision which columns format to use. Since + the entries in the agenda are collected from different files, and + different files may have different columns formats, this is a + non-trivial problem. Org first checks if + ~org-overriding-columns-format~ is currently set, and if so, takes + the format from there. You should set this variable only in the + /local settings section/ of a custom agenda command (see [[*Custom + Agenda Views]]) to make it valid for that specific agenda view. If + no such binding exists, it checks, in sequence, + ~org-columns-default-format-for-agenda~, the format associated with + the first item in the agenda (through a property or a =#+COLUMNS= + setting in that buffer) and finally ~org-columns-default-format~. + +2. + #+cindex: @samp{CLOCKSUM}, special property + If any of the columns has a summary type defined (see [[*Column + attributes]]), turning on column view in the agenda visits all + relevant agenda files and make sure that the computations of this + property are up to date. This is also true for the special + =CLOCKSUM= property. Org then sums the values displayed in the + agenda. In the daily/weekly agenda, the sums cover a single day; + in all other views they cover the entire block. + + It is important to realize that the agenda may show the same entry + /twice/---for example as scheduled and as a deadline---and it may + show two entries from the same hierarchy (for example a /parent/ + and its /child/). In these cases, the summation in the agenda + leads to incorrect results because some values count double. + +3. When the column view in the agenda shows the =CLOCKSUM= property, + that is always the entire clocked time for this item. So even in + the daily/weekly agenda, the clocksum listed in column view may + originate from times outside the current view. This has the + advantage that you can compare these values with a column listing + the planned total effort for a task---one of the major + applications for column view in the agenda. If you want + information about clocked time in the displayed period use clock + table mode (press {{{kbd(R)}}} in the agenda). + +4. + #+cindex: @samp{CLOCKSUM_T}, special property + When the column view in the agenda shows the =CLOCKSUM_T= property, + that is always today's clocked time for this item. So even in the + weekly agenda, the clocksum listed in column view only originates + from today. This lets you compare the time you spent on a task for + today, with the time already spent---via =CLOCKSUM=---and with + the planned total effort for it. + +* Markup for Rich Contents +:PROPERTIES: +:DESCRIPTION: Compose beautiful documents. +:END: + +Org is primarily about organizing and searching through your +plain-text notes. However, it also provides a lightweight yet robust +markup language for rich text formatting and more. For instance, you +may want to center or emphasize text. Or you may need to insert +a formula or image in your writing. Org offers syntax for all of this +and more. Used in conjunction with the export framework (see +[[*Exporting]]), you can author beautiful documents in Org---like the fine +manual you are currently reading. + +** Paragraphs +:PROPERTIES: +:DESCRIPTION: The basic unit of text. +:END: + +#+cindex: paragraphs, markup rules +Paragraphs are separated by at least one empty line. If you need to +enforce a line break within a paragraph, use =\\= at the end of +a line. + +#+cindex: line breaks, markup rules +To preserve the line breaks, indentation and blank lines in a region, +but otherwise use normal formatting, you can use this construct, which +can also be used to format poetry. + +#+cindex: @samp{BEGIN_VERSE} +#+cindex: verse blocks +#+begin_example +,#+BEGIN_VERSE + Great clouds overhead + Tiny black birds rise and fall + Snow covers Emacs + + ---AlexSchroeder +,#+END_VERSE +#+end_example + +When quoting a passage from another document, it is customary to +format this as a paragraph that is indented on both the left and the +right margin. You can include quotations in Org documents like this: + +#+cindex: @samp{BEGIN_QUOTE} +#+cindex: quote blocks +#+begin_example +,#+BEGIN_QUOTE +Everything should be made as simple as possible, +but not any simpler ---Albert Einstein +,#+END_QUOTE +#+end_example + +If you would like to center some text, do it like this: + +#+cindex: @samp{BEGIN_CENTER} +#+cindex: center blocks +#+begin_example +,#+BEGIN_CENTER +Everything should be made as simple as possible, \\ +but not any simpler +,#+END_CENTER +#+end_example + +** Emphasis and Monospace +:PROPERTIES: +:DESCRIPTION: Bold, italic, etc. +:END: +#+cindex: underlined text, markup rules +#+cindex: bold text, markup rules +#+cindex: italic text, markup rules +#+cindex: verbatim text, markup rules +#+cindex: code text, markup rules +#+cindex: strike-through text, markup rules + +You can make words =*bold*=, =/italic/=, =_underlined_=, ==verbatim== +and =~code~=, and, if you must, =+strike-through+=. Text in the code +and verbatim string is not processed for Org specific syntax; it is +exported verbatim. + +#+vindex: org-fontify-emphasized-text +To turn off fontification for marked up text, you can set +~org-fontify-emphasized-text~ to ~nil~. To narrow down the list of +available markup syntax, you can customize ~org-emphasis-alist~. + +** Subscripts and Superscripts +:PROPERTIES: +:DESCRIPTION: Simple syntax for raising/lowering text. +:END: +#+cindex: subscript +#+cindex: superscript + +=^= and =_= are used to indicate super- and subscripts. To increase +the readability of ASCII text, it is not necessary, but OK, to +surround multi-character sub- and superscripts with curly braces. For +example + +#+begin_example +The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand, +the radius of Alpha Centauri is R_{Alpha Centauri} = 1.28 x R_{sun}. +#+end_example + +#+vindex: org-use-sub-superscripts +If you write a text where the underscore is often used in a different +context, Org's convention to always interpret these as subscripts can +get in your way. Configure the variable ~org-use-sub-superscripts~ to +change this convention. For example, when setting this variable to +~{}~, =a_b= is not interpreted as a subscript, but =a_{b}= is. + +You can set ~org-use-sub-superscripts~ in a file using the export +option =^:= (see [[*Export Settings][Export Settings]]). For example, =#+OPTIONS: ^:{}= +sets ~org-use-sub-superscripts~ to ~{}~ and limits super- and +subscripts to the curly bracket notation. + +You can also toggle the visual display of super- and subscripts: + +- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) :: + + #+kindex: C-c C-x \ + #+findex: org-toggle-pretty-entities + This command formats sub- and superscripts in a WYSIWYM way. + +#+vindex: org-pretty-entities +#+vindex: org-pretty-entities-include-sub-superscripts +Set both ~org-pretty-entities~ and +~org-pretty-entities-include-sub-superscripts~ to ~t~ to start with +super- and subscripts /visually/ interpreted as specified by the +option ~org-use-sub-superscripts~. + +** Special Symbols +:PROPERTIES: +:DESCRIPTION: Greek letters and other symbols. +:END: +#+cindex: math symbols +#+cindex: special symbols +#+cindex: entities + +You can use LaTeX-like syntax to insert special symbols---named +entities---like =\alpha= to indicate the Greek letter, or =\to= to indicate +an arrow. Completion for these symbols is available, just type =\= +and maybe a few letters, and press {{{kbd(M-TAB)}}} to see possible +completions. If you need such a symbol inside a word, terminate it +with a pair of curly brackets. For example + +#+begin_example +Pro tip: Given a circle \Gamma of diameter d, the length of its +circumference is \pi{}d. +#+end_example + +#+findex: org-entities-help +#+vindex: org-entities-user +A large number of entities is provided, with names taken from both +HTML and LaTeX; you can comfortably browse the complete list from +a dedicated buffer using the command ~org-entities-help~. It is also +possible to provide your own special symbols in the variable +~org-entities-user~. + +During export, these symbols are transformed into the native format of +the exporter back-end. Strings like =\alpha= are exported as =α= in +the HTML output, and as =\(\alpha\)= in the LaTeX output. Similarly, =\nbsp= +becomes = = in HTML and =~= in LaTeX. + +#+cindex: special symbols, in-buffer display +If you would like to see entities displayed as UTF-8 characters, use +the following command[fn:108]: + +- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) :: + #+kindex: C-c C-x \ + #+findex: org-toggle-pretty-entities + + Toggle display of entities as UTF-8 characters. This does not + change the buffer content which remains plain ASCII, but it overlays + the UTF-8 character for display purposes only. + +#+cindex: shy hyphen, special symbol +#+cindex: dash, special symbol +#+cindex: ellipsis, special symbol +In addition to regular entities defined above, Org exports in +a special way[fn:109] the following commonly used character +combinations: =\-= is treated as a shy hyphen, =--= and =---= are +converted into dashes, and =...= becomes a compact set of dots. + +** Embedded LaTeX +:PROPERTIES: +:DESCRIPTION: LaTeX can be freely used inside Org documents. +:END: +#+cindex: @TeX{} interpretation +#+cindex: @LaTeX{} interpretation + +Plain ASCII is normally sufficient for almost all note taking. +Exceptions include scientific notes, which often require mathematical +symbols and the occasional formula. LaTeX[fn:110] is widely used to +typeset scientific documents. Org mode supports embedding LaTeX code +into its files, because many academics are used to writing and reading +LaTeX source code, and because it can be readily processed to produce +pretty output for a number of export back-ends. + +*** LaTeX fragments +:PROPERTIES: +:DESCRIPTION: Complex formulas made easy. +:END: +#+cindex: @LaTeX{} fragments + +#+vindex: org-format-latex-header +Org mode can contain LaTeX math fragments, and it supports ways to +process these for several export back-ends. When exporting to LaTeX, +the code is left as it is. When exporting to HTML, Org can use either +[[http://www.mathjax.org][MathJax]] (see [[*Math formatting in HTML export]]) or transcode the math +into images (see [[*Previewing LaTeX fragments]]). + +LaTeX fragments do not need any special marking at all. The following +snippets are identified as LaTeX source code: + +- Environments of any kind[fn:111]. The only requirement is that the + =\begin= statement appears on a new line, preceded by only + whitespace. + +- Text within the usual LaTeX math delimiters. To avoid conflicts + with currency specifications, single =$= characters are only + recognized as math delimiters if the enclosed text contains at most + two line breaks, is directly attached to the =$= characters with no + whitespace in between, and if the closing =$= is followed by + whitespace, punctuation or a dash. For the other delimiters, there + is no such restriction, so when in doubt, use =\(...\)= as inline + math delimiters. + +#+texinfo: @noindent +For example: + +#+begin_example +\begin{equation} % arbitrary environments, +x=\sqrt{b} % even tables, figures +\end{equation} % etc + +If $a^2=b$ and \( b=2 \), then the solution must be +either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \]. +#+end_example + +#+vindex: org-export-with-latex +LaTeX processing can be configured with the variable +~org-export-with-latex~. The default setting is ~t~ which means +MathJax for HTML, and no processing for ASCII and LaTeX back-ends. +You can also set this variable on a per-file basis using one of these +lines: + +| =#+OPTIONS: tex:t= | Do the right thing automatically (MathJax) | +| =#+OPTIONS: tex:nil= | Do not process LaTeX fragments at all | +| =#+OPTIONS: tex:verbatim= | Verbatim export, for jsMath or so | + +*** Previewing LaTeX fragments +:PROPERTIES: +:DESCRIPTION: What will this snippet look like? +:END: +#+cindex: @LaTeX{} fragments, preview + +#+vindex: org-preview-latex-default-process +If you have a working LaTeX installation and =dvipng=, =dvisvgm= or +=convert= installed[fn:112], LaTeX fragments can be processed to +produce images of the typeset expressions to be used for inclusion +while exporting to HTML (see [[*LaTeX fragments]]), or for inline +previewing within Org mode. + +#+vindex: org-format-latex-options +#+vindex: org-format-latex-header +You can customize the variables ~org-format-latex-options~ and +~org-format-latex-header~ to influence some aspects of the preview. +In particular, the ~:scale~ (and for HTML export, ~:html-scale~) +property of the former can be used to adjust the size of the preview +images. + +- {{{kbd(C-c C-x C-l)}}} (~org-latex-preview~) :: + #+kindex: C-c C-x C-l + #+findex: org-latex-preview + + Produce a preview image of the LaTeX fragment at point and overlay + it over the source code. If there is no fragment at point, process + all fragments in the current entry---between two headlines. + + When called with a single prefix argument, clear all images in the + current entry. Two prefix arguments produce a preview image for all + fragments in the buffer, while three of them clear all the images in + that buffer. + +#+vindex: org-startup-with-latex-preview +You can turn on the previewing of all LaTeX fragments in a file with + +: #+STARTUP: latexpreview + +To disable it, simply use + +: #+STARTUP: nolatexpreview + +*** Using CDLaTeX to enter math +:PROPERTIES: +:DESCRIPTION: Speed up entering of formulas. +:ALT_TITLE: CDLaTeX mode +:END: +#+cindex: CD@LaTeX{} + +CDLaTeX mode is a minor mode that is normally used in combination with +a major LaTeX mode like AUCTeX in order to speed-up insertion of +environments and math templates. Inside Org mode, you can make use of +some of the features of CDLaTeX mode. You need to install +=cdlatex.el= and =texmathp.el= (the latter comes also with AUCTeX) +using [[https://melpa.org/][MELPA]] with the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html][Emacs packaging system]] or alternatively from +[[https://staff.fnwi.uva.nl/c.dominik/Tools/cdlatex/]]. Do not use +CDLaTeX mode itself under Org mode, but use the special version Org +CDLaTeX minor mode that comes as part of Org. Turn it on for the +current buffer with {{{kbd(M-x org-cdlatex-mode)}}}, or for all Org +files with + +#+begin_src emacs-lisp +(add-hook 'org-mode-hook 'turn-on-org-cdlatex) +#+end_src + +When this mode is enabled, the following features are present (for +more details see the documentation of CDLaTeX mode): + +#+attr_texinfo: :sep , +- {{{kbd(C-c {)}}} :: + #+kindex: C-c @{ + + Insert an environment template. + +- {{{kbd(TAB)}}} :: + #+kindex: TAB + + The {{{kbd(TAB)}}} key expands the template if point is inside + a LaTeX fragment[fn:113]. For example, {{{kbd(TAB)}}} expands =fr= + to =\frac{}{}= and position point correctly inside the first brace. + Another {{{kbd(TAB)}}} gets you into the second brace. + + Even outside fragments, {{{kbd(TAB)}}} expands environment + abbreviations at the beginning of a line. For example, if you write + =equ= at the beginning of a line and press {{{kbd(TAB)}}}, this + abbreviation is expanded to an =equation= environment. To get + a list of all abbreviations, type {{{kbd(M-x + cdlatex-command-help)}}}. + +- {{{kbd(^)}}}, {{{kbd(_)}}} :: + #+kindex: _ + #+kindex: ^ + #+vindex: cdlatex-simplify-sub-super-scripts + + Pressing {{{kbd(_)}}} and {{{kbd(^)}}} inside a LaTeX fragment + inserts these characters together with a pair of braces. If you use + {{{kbd(TAB)}}} to move out of the braces, and if the braces surround + only a single character or macro, they are removed again (depending + on the variable ~cdlatex-simplify-sub-super-scripts~). + +- {{{kbd(`)}}} :: + #+kindex: ` + + Pressing the backquote followed by a character inserts math macros, + also outside LaTeX fragments. If you wait more than 1.5 seconds + after the backquote, a help window pops up. + +- {{{kbd(')}}} :: + #+kindex: ' + + Pressing the single-quote followed by another character modifies the + symbol before point with an accent or a font. If you wait more than + 1.5 seconds after the single-quote, a help window pops up. + Character modification works only inside LaTeX fragments; outside + the quote is normal. + +** Literal Examples +:PROPERTIES: +:DESCRIPTION: Source code examples with special formatting. +:END: +#+cindex: literal examples, markup rules +#+cindex: code line references, markup rules + +You can include literal examples that should not be subjected to +markup. Such examples are typeset in monospace, so this is well +suited for source code and similar examples. + +#+cindex: @samp{BEGIN_EXAMPLE} +#+cindex: example block +#+begin_example +,#+BEGIN_EXAMPLE + Some example from a text file. +,#+END_EXAMPLE +#+end_example + +#+cindex: comma escape, in literal examples +There is one limitation, however. You must insert a comma right +before lines starting with either =*=, =,*=, =#+= or =,#+=, as those +may be interpreted as outlines nodes or some other special syntax. +Org transparently strips these additional commas whenever it accesses +the contents of the block. + +#+begin_example +,#+BEGIN_EXAMPLE +,,* I am no real headline +,#+END_EXAMPLE +#+end_example + +For simplicity when using small examples, you can also start the +example lines with a colon followed by a space. There may also be +additional whitespace before the colon: + +#+begin_example +Here is an example + : Some example from a text file. +#+end_example + +#+cindex: formatting source code, markup rules +#+vindex: org-latex-listings +If the example is source code from a programming language, or any +other text that can be marked up by Font Lock in Emacs, you can ask +for the example to look like the fontified Emacs buffer[fn:114]. This +is done with the code block, where you also need to specify the name +of the major mode that should be used to fontify the example[fn:115], +see [[*Structure Templates]] for shortcuts to easily insert code blocks. + +#+cindex: @samp{BEGIN_SRC} +#+cindex: source block +#+begin_example +,#+BEGIN_SRC emacs-lisp + (defun org-xor (a b) + "Exclusive or." + (if a (not b) b)) + ,#+END_SRC +#+end_example + +Both in =example= and in =src= snippets, you can add a =-n= switch to +the end of the =#+BEGIN= line, to get the lines of the example +numbered. The =-n= takes an optional numeric argument specifying the +starting line number of the block. If you use a =+n= switch, the +numbering from the previous numbered snippet is continued in the +current one. The =+n= switch can also take a numeric argument. This +adds the value of the argument to the last line of the previous block +to determine the starting line number. + +#+begin_example +,#+BEGIN_SRC emacs-lisp -n 20 + ;; This exports with line number 20. + (message "This is line 21") +,#+END_SRC + +,#+BEGIN_SRC emacs-lisp +n 10 + ;; This is listed as line 31. + (message "This is line 32") +,#+END_SRC +#+end_example + +In literal examples, Org interprets strings like =(ref:name)= as +labels, and use them as targets for special hyperlinks like +=[[(name)]]=---i.e., the reference name enclosed in single parenthesis. +In HTML, hovering the mouse over such a link remote-highlights the +corresponding code line, which is kind of cool. + +You can also add a =-r= switch which /removes/ the labels from the +source code[fn:116]. With the =-n= switch, links to these references +are labeled by the line numbers from the code listing. Otherwise +links use the labels with no parentheses. Here is an example: + +#+begin_example -l "(dumb-reference:%s)" +,#+BEGIN_SRC emacs-lisp -n -r + (save-excursion (ref:sc) + (goto-char (point-min)) (ref:jump) +,#+END_SRC +In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]] +jumps to point-min. +#+end_example + +#+cindex: indentation, in source blocks +Source code and examples may be /indented/ in order to align nicely +with the surrounding text, and in particular with plain list structure +(see [[*Plain Lists]]). By default, Org only retains the relative +indentation between lines, e.g., when exporting the contents of the +block. However, you can use the =-i= switch to also preserve the +global indentation, if it does matter. See [[*Editing Source Code]]. + +#+vindex: org-coderef-label-format +If the syntax for the label format conflicts with the language syntax, +use a =-l= switch to change the format, for example + +: #+BEGIN_SRC pascal -n -r -l "((%s))" + +#+texinfo: @noindent +See also the variable ~org-coderef-label-format~. + +HTML export also allows examples to be published as text areas (see +[[*Text areas in HTML export]]). + +Because the =#+BEGIN= ... =#+END= patterns need to be added so often, +a shortcut is provided (see [[*Structure Templates]]). + +- {{{kbd(C-c ')}}} (~org-edit-special~) :: + + #+kindex: C-c ' + #+findex: org-edit-special + Edit the source code example at point in its native mode. This + works by switching to a temporary buffer with the source code. You + need to exit by pressing {{{kbd(C-c ')}}} again. The edited version + then replaces the old version in the Org buffer. Fixed-width + regions---where each line starts with a colon followed by + a space---are edited using Artist mode[fn:117] to allow creating + ASCII drawings easily. Using this command in an empty line creates + a new fixed-width region. + +#+cindex: storing link, in a source code buffer +Calling ~org-store-link~ (see [[*Handling Links]]) while editing a source +code example in a temporary buffer created with {{{kbd(C-c ')}}} +prompts for a label. Make sure that it is unique in the current +buffer, and insert it with the proper formatting like =(ref:label)= at +the end of the current line. Then the label is stored as a link +=(label)=, for retrieval with {{{kbd(C-c C-l)}}}. + +** Images +:PROPERTIES: +:DESCRIPTION: Display an image. +:END: + +#+cindex: inlining images +#+cindex: images, markup rules +An image is a link to an image file[fn:118] that does not have +a description part, for example + +: ./img/cat.jpg + +If you wish to define a caption for the image (see [[*Captions]]) and +maybe a label for internal cross references (see [[*Internal Links]]), +make sure that the link is on a line by itself and precede it with +=CAPTION= and =NAME= keywords as follows: + +#+begin_example +,#+CAPTION: This is the caption for the next figure link (or table) +,#+NAME: fig:SED-HR4049 +[[./img/a.jpg]] +#+end_example + +Such images can be displayed within the buffer with the following +command: + +- {{{kbd(C-c C-x C-v)}}} (~org-toggle-inline-images~) :: + + #+kindex: C-c C-x C-v + #+findex: org-toggle-inline-images + #+vindex: org-startup-with-inline-images + Toggle the inline display of linked images. When called with + a prefix argument, also display images that do have a link + description. You can ask for inline images to be displayed at + startup by configuring the variable + ~org-startup-with-inline-images~[fn:119]. + +** Captions +:PROPERTIES: +:DESCRIPTION: Describe tables, images... +:END: +#+cindex: captions, markup rules +#+cindex: @samp{CAPTION}, keyword + +You can assign a caption to a specific part of a document by inserting +a =CAPTION= keyword immediately before it: + +#+begin_example +,#+CAPTION: This is the caption for the next table (or link) +| ... | ... | +|-----+-----| +#+end_example + +Optionally, the caption can take the form: + +: #+CAPTION[Short caption]: Longer caption. + +Even though images and tables are prominent examples of captioned +structures, the same caption mechanism can apply to many +others---e.g., LaTeX equations, source code blocks. Depending on the +export back-end, those may or may not be handled. + +** Horizontal Rules +:PROPERTIES: +:DESCRIPTION: Make a line. +:END: + +#+cindex: horizontal rules, markup rules +A line consisting of only dashes, and at least 5 of them, is exported +as a horizontal line. + +** Creating Footnotes +:PROPERTIES: +:DESCRIPTION: Edit and read footnotes. +:END: +#+cindex: footnotes + +A footnote is started by a footnote marker in square brackets in +column 0, no indentation allowed. It ends at the next footnote +definition, headline, or after two consecutive empty lines. The +footnote reference is simply the marker in square brackets, inside +text. Markers always start with =fn:=. For example: + +#+begin_example +The Org homepage[fn:1] now looks a lot better than it used to. +... +[fn:1] The link is: https://orgmode.org +#+end_example + +Org mode extends the number-based syntax to /named/ footnotes and +optional inline definition. Here are the valid references: + +- =[fn:NAME]= :: + + A named footnote reference, where {{{var(NAME)}}} is a unique + label word, or, for simplicity of automatic creation, a number. + +- =[fn:: This is the inline definition of this footnote]= :: + + An anonymous footnote where the definition is given directly at the + reference point. + +- =[fn:NAME: a definition]= :: + + An inline definition of a footnote, which also specifies a name for + the note. Since Org allows multiple references to the same note, + you can then use =[fn:NAME]= to create additional references. + +#+vindex: org-footnote-auto-label +Footnote labels can be created automatically, or you can create names +yourself. This is handled by the variable ~org-footnote-auto-label~ +and its corresponding =STARTUP= keywords. See the docstring of that +variable for details. + +The following command handles footnotes: + +- {{{kbd(C-c C-x f)}}} :: + + The footnote action command. + + #+kindex: C-c C-x f + When point is on a footnote reference, jump to the definition. When + it is at a definition, jump to the---first---reference. + + #+vindex: org-footnote-define-inline + #+vindex: org-footnote-section + Otherwise, create a new footnote. Depending on the variable + ~org-footnote-define-inline~[fn:120], the definition is placed right + into the text as part of the reference, or separately into the + location determined by the variable ~org-footnote-section~. + + When this command is called with a prefix argument, a menu of + additional options is offered: + + #+attr_texinfo: :columns 0.1 0.9 + | {{{kbd(s)}}} | Sort the footnote definitions by reference sequence. | + | {{{kbd(r)}}} | Renumber the simple =fn:N= footnotes. | + | {{{kbd(S)}}} | Short for first {{{kbd(r)}}}, then {{{kbd(s)}}} action. | + | {{{kbd(n)}}} | Rename all footnotes into a =fn:1= ... =fn:n= sequence. | + | {{{kbd(d)}}} | Delete the footnote at point, including definition and references. | + + #+vindex: org-footnote-auto-adjust + Depending on the variable ~org-footnote-auto-adjust~[fn:121], + renumbering and sorting footnotes can be automatic after each + insertion or deletion. + +- {{{kbd(C-c C-c)}}} :: + + #+kindex: C-c C-c + If point is on a footnote reference, jump to the definition. If it + is at the definition, jump back to the reference. When called at + a footnote location with a prefix argument, offer the same menu as + {{{kbd(C-c C-x f)}}}. + +- {{{kbd(C-c C-o)}}} or {{{kbd(mouse-1/2)}}} :: + + #+kindex: C-c C-o + #+kindex: mouse-1 + #+kindex: mouse-2 + Footnote labels are also links to the corresponding definition or + reference, and you can use the usual commands to follow these links. + +* Exporting +:PROPERTIES: +:DESCRIPTION: Sharing and publishing notes. +:END: +#+cindex: exporting + +At some point you might want to print your notes, publish them on the +web, or share them with people not using Org. Org can convert and +export documents to a variety of other formats while retaining as much +structure (see [[*Document Structure]]) and markup (see [[*Markup for Rich +Contents]]) as possible. + +#+cindex: export back-end +The libraries responsible for translating Org files to other formats +are called /back-ends/. Org ships with support for the following +back-ends: + +- /ascii/ (ASCII format) +- /beamer/ (LaTeX Beamer format) +- /html/ (HTML format) +- /icalendar/ (iCalendar format) +- /latex/ (LaTeX format) +- /md/ (Markdown format) +- /odt/ (OpenDocument Text format) +- /org/ (Org format) +- /texinfo/ (Texinfo format) +- /man/ (Man page format) + +Users can install libraries for additional formats from the Emacs +packaging system. For easy discovery, these packages have a common +naming scheme: ~ox-NAME~, where {{{var(NAME)}}} is a format. For +example, ~ox-koma-letter~ for /koma-letter/ back-end. More libraries +can be found in the =contrib/= directory (see [[*Installation]]). + +#+vindex: org-export-backends +Org only loads back-ends for the following formats by default: ASCII, +HTML, iCalendar, LaTeX, and ODT. Additional back-ends can be loaded +in either of two ways: by configuring the ~org-export-backends~ +variable, or by requiring libraries in the Emacs init file. For +example, to load the Markdown back-end, add this to your Emacs config: + +#+begin_src emacs-lisp +(require 'ox-md) +#+end_src + +** The Export Dispatcher +:PROPERTIES: +:DESCRIPTION: The main interface. +:END: +#+cindex: dispatcher, for export commands +#+cindex: export, dispatcher + +The export dispatcher is the main interface for Org's exports. +A hierarchical menu presents the currently configured export formats. +Options are shown as easy toggle switches on the same screen. + +#+vindex: org-export-dispatch-use-expert-ui +Org also has a minimal prompt interface for the export dispatcher. +When the variable ~org-export-dispatch-use-expert-ui~ is set to +a non-~nil~ value, Org prompts in the minibuffer. To switch back to +the hierarchical menu, press {{{kbd(?)}}}. + +- {{{kbd(C-c C-e)}}} (~org-export~) :: + #+kindex: C-c C-e + #+findex: org-export + + Invokes the export dispatcher interface. The options show default + settings. The {{{kbd(C-u)}}} prefix argument preserves options from + the previous export, including any sub-tree selections. + +Org exports the entire buffer by default. If the Org buffer has an +active region, then Org exports just that region. + +Within the dispatcher interface, the following key combinations can +further alter what is exported, and how. + +- {{{kbd(C-a)}}} :: + #+kindex: C-c C-e C-a + + Toggle asynchronous export. Asynchronous export uses an external + Emacs process with a specially configured initialization file to + complete the exporting process in the background, without tying-up + Emacs. This is particularly useful when exporting long documents. + + Output from an asynchronous export is saved on the /export stack/. + To view this stack, call the export dispatcher with a double + {{{kbd(C-u)}}} prefix argument. If already in the export dispatcher + menu, {{{kbd(&)}}} displays the stack. + + #+vindex: org-export-in-background + You can make asynchronous export the default by setting + ~org-export-in-background~. + + #+vindex: org-export-async-init-file + You can set the initialization file used by the background process + by setting ~org-export-async-init-file~. + +- {{{kbd(C-b)}}} :: + #+kindex: C-c C-e C-b + + Toggle body-only export. Useful for excluding headers and footers + in the export. Affects only those back-end formats that have + sections like =<head>...</head>= in HTML. + +- {{{kbd(C-s)}}} :: + #+kindex: C-c C-e C-s + + Toggle sub-tree export. When turned on, Org exports only the + sub-tree starting from point position at the time the export + dispatcher was invoked. Org uses the top heading of this sub-tree + as the document's title. If point is not on a heading, Org uses the + nearest enclosing header. If point is in the document preamble, Org + signals an error and aborts export. + + #+vindex: org-export-initial-scope + To make sub-tree export the default, customize the variable + ~org-export-initial-scope~. + +- {{{kbd(C-v)}}} :: + #+kindex: C-c C-e C-v + + Toggle visible-only export. This is useful for exporting only + certain parts of an Org document by adjusting the visibility of + particular headings. + +** Export Settings +:PROPERTIES: +:DESCRIPTION: Common export settings. +:END: +#+cindex: options, for export +#+cindex: Export, settings + +#+cindex: @samp{OPTIONS}, keyword +Export options can be set: globally with variables; for an individual +file by making variables buffer-local with in-buffer settings (see +[[*Summary of In-Buffer Settings]]); by setting individual keywords or +specifying them in compact form with the =OPTIONS= keyword; or for +a tree by setting properties (see [[*Properties and Columns]]). Options +set at a specific level override options set at a more general level. + +#+cindex: @samp{SETUPFILE}, keyword +In-buffer settings may appear anywhere in the file, either directly or +indirectly through a file included using =#+SETUPFILE: filename or +URL= syntax. Option keyword sets tailored to a particular back-end +can be inserted from the export dispatcher (see [[*The Export +Dispatcher]]) using the =Insert template= command by pressing +{{{kbd(#)}}}. To insert keywords individually, a good way to make +sure the keyword is correct is to type =#+= and then to use +{{{kbd(M-TAB)}}}[fn:16] for completion. + +The export keywords available for every back-end, and their equivalent +global variables, include: + +- =AUTHOR= :: + + #+cindex: @samp{AUTHOR}, keyword + #+vindex: user-full-name + The document author (~user-full-name~). + +- =CREATOR= :: + + #+cindex: @samp{CREATOR}, keyword + #+vindex: org-expot-creator-string + Entity responsible for output generation + (~org-export-creator-string~). + +- =DATE= :: + + #+cindex: @samp{DATE}, keyword + #+vindex: org-export-date-timestamp-format + A date or a time-stamp[fn:122]. + +- =EMAIL= :: + + #+cindex: @samp{EMAIL}, keyword + #+vindex: user-mail-address + The email address (~user-mail-address~). + +- =LANGUAGE= :: + + #+cindex: @samp{LANGUAGE}, keyword + #+vindex: org-export-default-language + Language to use for translating certain strings + (~org-export-default-language~). With =#+LANGUAGE: fr=, for + example, Org translates =Table of contents= to the French =Table des + matières=[fn:123]. + +- =SELECT_TAGS= :: + + #+cindex: @samp{SELECT_TAGS}, keyword + #+vindex: org-export-select-tags + The default value is =("export")=. When a tree is tagged with + =export= (~org-export-select-tags~), Org selects that tree and its + sub-trees for export. Org excludes trees with =noexport= tags, see + below. When selectively exporting files with =export= tags set, Org + does not export any text that appears before the first headline. + +- =EXCLUDE_TAGS= :: + + #+cindex: @samp{EXCLUDE_TAGS}, keyword + #+vindex: org-export-exclude-tags + The default value is =("noexport")=. When a tree is tagged with + =noexport= (~org-export-exclude-tags~), Org excludes that tree and + its sub-trees from export. Entries tagged with =noexport= are + unconditionally excluded from the export, even if they have an + =export= tag. Even if a sub-tree is not exported, Org executes any + code blocks contained there. + +- =TITLE= :: + + #+cindex: @samp{TITLE}, keyword + #+cindex: document title + Org displays this title. For long titles, use multiple =#+TITLE= + lines. + +- =EXPORT_FILE_NAME= :: + + #+cindex: @samp{EXPORT_FILE_NAME}, keyword + The name of the output file to be generated. Otherwise, Org + generates the file name based on the buffer name and the extension + based on the back-end format. + +The =OPTIONS= keyword is a compact form. To configure multiple +options, use several =OPTIONS= lines. =OPTIONS= recognizes the +following arguments. + +- ~'~ :: + + #+vindex: org-export-with-smart-quotes + Toggle smart quotes (~org-export-with-smart-quotes~). Depending on + the language used, when activated, Org treats pairs of double quotes + as primary quotes, pairs of single quotes as secondary quotes, and + single quote marks as apostrophes. + +- ~*~ :: + + #+vindex: org-export-with-emphasize + Toggle emphasized text (~org-export-with-emphasize~). + +- ~-~ :: + + #+vindex: org-export-with-special-strings + Toggle conversion of special strings + (~org-export-with-special-strings~). + +- ~:~ :: + + #+vindex: org-export-with-fixed-width + Toggle fixed-width sections (~org-export-with-fixed-width~). + +- ~<~ :: + + #+vindex: org-export-with-timestamps + Toggle inclusion of time/date active/inactive stamps + (~org-export-with-timestamps~). + +- ~\n~ :: + + #+vindex: org-export-preserve-breaks + Toggles whether to preserve line breaks + (~org-export-preserve-breaks~). + +- ~^~ :: + + #+vindex: org-export-with-sub-superscripts + Toggle TeX-like syntax for sub- and superscripts. If you write + =^:{}=, =a_{b}= is interpreted, but the simple =a_b= is left as it + is (~org-export-with-sub-superscripts~). + +- ~arch~ :: + + #+vindex: org-export-with-archived-trees + Configure how archived trees are exported. When set to ~headline~, + the export process skips the contents and processes only the + headlines (~org-export-with-archived-trees~). + +- ~author~ :: + + #+vindex: org-export-with-author + Toggle inclusion of author name into exported file + (~org-export-with-author~). + +- ~broken-links~ :: + + #+vindex: org-export-with-broken-links + Toggles if Org should continue exporting upon finding a broken + internal link. When set to ~mark~, Org clearly marks the problem + link in the output (~org-export-with-broken-links~). + +- ~c~ :: + + #+vindex: org-export-with-clocks + Toggle inclusion of =CLOCK= keywords (~org-export-with-clocks~). + +- ~creator~ :: + + #+vindex: org-export-with-creator + Toggle inclusion of creator information in the exported file + (~org-export-with-creator~). + +- ~d~ :: + + #+vindex: org-export-with-drawers + Toggles inclusion of drawers, or list of drawers to include, or list + of drawers to exclude (~org-export-with-drawers~). + +- ~date~ :: + + #+vindex: org-export-with-date + Toggle inclusion of a date into exported file + (~org-export-with-date~). + +- ~e~ :: + + #+vindex: org-export-with-entities + Toggle inclusion of entities (~org-export-with-entities~). + +- ~email~ :: + + #+vindex: org-export-with-email + Toggle inclusion of the author's e-mail into exported file + (~org-export-with-email~). + +- ~f~ :: + + #+vindex: org-export-with-footnotes + Toggle the inclusion of footnotes (~org-export-with-footnotes~). + +- ~H~ :: + + #+vindex: org-export-headline-levels + Set the number of headline levels for export + (~org-export-headline-levels~). Below that level, headlines are + treated differently. In most back-ends, they become list items. + +- ~inline~ :: + + #+vindex: org-export-with-inlinetasks + Toggle inclusion of inlinetasks (~org-export-with-inlinetasks~). + +- ~num~ :: + + #+vindex: org-export-with-section-numbers + #+cindex: @samp{UNNUMBERED}, property + Toggle section-numbers (~org-export-with-section-numbers~). When + set to number N, Org numbers only those headlines at level N or + above. Set =UNNUMBERED= property to non-~nil~ to disable numbering + of heading and subheadings entirely. Moreover, when the value is + =notoc= the headline, and all its children, do not appear in the + table of contents either (see [[*Table of Contents]]). + +- ~p~ :: + + #+vindex: org-export-with-planning + Toggle export of planning information (~org-export-with-planning~). + "Planning information" comes from lines located right after the + headline and contain any combination of these cookies: =SCHEDULED=, + =DEADLINE=, or =CLOSED=. + +- ~pri~ :: + + #+vindex: org-export-with-priority + Toggle inclusion of priority cookies + (~org-export-with-priority~). + +- ~prop~ :: + + #+vindex: org-export-with-properties + Toggle inclusion of property drawers, or list the properties to + include (~org-export-with-properties~). + +- ~stat~ :: + + #+vindex: org-export-with-statistics-cookies + Toggle inclusion of statistics cookies + (~org-export-with-statistics-cookies~). + +- ~tags~ :: + + #+vindex: org-export-with-tags + Toggle inclusion of tags, may also be ~not-in-toc~ + (~org-export-with-tags~). + +- ~tasks~ :: + + #+vindex: org-export-with-tasks + Toggle inclusion of tasks (TODO items); or ~nil~ to remove all + tasks; or ~todo~ to remove done tasks; or list the keywords to keep + (~org-export-with-tasks~). + +- ~tex~ :: + + #+vindex: org-export-with-latex + ~nil~ does not export; ~t~ exports; ~verbatim~ keeps everything in + verbatim (~org-export-with-latex~). + +- ~timestamp~ :: + + #+vindex: org-export-time-stamp-file + Toggle inclusion of the creation time in the exported file + (~org-export-time-stamp-file~). + +- ~title~ :: + + #+vindex: org-export-with-title + Toggle inclusion of title (~org-export-with-title~). + +- ~toc~ :: + + #+vindex: org-export-with-toc + Toggle inclusion of the table of contents, or set the level limit + (~org-export-with-toc~). + +- ~todo~ :: + + #+vindex: org-export-with-todo-keywords + Toggle inclusion of TODO keywords into exported text + (~org-export-with-todo-keywords~). + +- ~|~ :: + + #+vindex: org-export-with-tables + Toggle inclusion of tables (~org-export-with-tables~). + +When exporting sub-trees, special node properties can override the +above keywords. These properties have an =EXPORT_= prefix. For +example, =DATE= becomes, =EXPORT_DATE= when used for a specific +sub-tree. Except for =SETUPFILE=, all other keywords listed above +have an =EXPORT_= equivalent. + +#+cindex: @samp{BIND}, keyword +#+vindex: org-export-allow-bind-keywords +If ~org-export-allow-bind-keywords~ is non-~nil~, Emacs variables can +become buffer-local during export by using the =BIND= keyword. Its +syntax is =#+BIND: variable value=. This is particularly useful for +in-buffer settings that cannot be changed using keywords. + +** Table of Contents +:PROPERTIES: +:DESCRIPTION: The if and where of the table of contents. +:END: +#+cindex: table of contents +#+cindex: list of tables +#+cindex: list of listings + +#+cindex: @samp{toc}, in @samp{OPTIONS} keyword +#+vindex: org-export-with-toc +The table of contents includes all headlines in the document. Its +depth is therefore the same as the headline levels in the file. If +you need to use a different depth, or turn it off entirely, set the +~org-export-with-toc~ variable accordingly. You can achieve the same +on a per file basis, using the following =toc= item in =OPTIONS= +keyword: + +#+begin_example +,#+OPTIONS: toc:2 (only include two levels in TOC) +,#+OPTIONS: toc:nil (no default TOC at all) +#+end_example + +#+cindex: excluding entries from table of contents +#+cindex: table of contents, exclude entries +Org includes both numbered and unnumbered headlines in the table of +contents[fn:124]. If you need to exclude an unnumbered headline, +along with all its children, set the =UNNUMBERED= property to =notoc= +value. + +#+begin_example +,* Subtree not numbered, not in table of contents either + :PROPERTIES: + :UNNUMBERED: notoc + :END: +#+end_example + +#+cindex: @samp{TOC}, keyword +Org normally inserts the table of contents directly before the first +headline of the file. To move the table of contents to a different +location, first turn off the default with ~org-export-with-toc~ +variable or with =#+OPTIONS: toc:nil=. Then insert =#+TOC: headlines +N= at the desired location(s). + +#+begin_example +,#+OPTIONS: toc:nil +... +,#+TOC: headlines 2 +#+end_example + +To adjust the table of contents depth for a specific section of the +Org document, append an additional =local= parameter. This parameter +becomes a relative depth for the current level. The following example +inserts a local table of contents, with direct children only. + +#+begin_example +,* Section +,#+TOC: headlines 1 local +#+end_example + +Note that for this feature to work properly in LaTeX export, the Org +file requires the inclusion of the titletoc package. Because of +compatibility issues, titletoc has to be loaded /before/ hyperref. +Customize the ~org-latex-default-packages-alist~ variable. + +The following example inserts a table of contents that links to the +children of the specified target. + +#+begin_example +,* Target + :PROPERTIES: + :CUSTOM_ID: TargetSection + :END: +,** Heading A +,** Heading B +,* Another section +,#+TOC: headlines 1 :target #TargetSection +#+end_example + +The =:target= attribute is supported in HTML, Markdown, ODT, and ASCII export. + +Use the =TOC= keyword to generate list of tables---respectively, all +listings---with captions. + +#+begin_example +,#+TOC: listings +,#+TOC: tables +#+end_example + +#+cindex: @samp{ALT_TITLE}, property +Normally Org uses the headline for its entry in the table of contents. +But with =ALT_TITLE= property, a different entry can be specified for +the table of contents. + +** Include Files +:PROPERTIES: +:DESCRIPTION: Include additional files into a document. +:END: +#+cindex: include files, during export +#+cindex: export, include files +#+cindex: @samp{INCLUDE}, keyword + +During export, you can include the content of another file. For +example, to include your =.emacs= file, you could use: + +: #+INCLUDE: "~/.emacs" src emacs-lisp + +#+texinfo: @noindent +The first parameter is the file name to include. The optional second +parameter specifies the block type: =example=, =export= or =src=. The +optional third parameter specifies the source code language to use for +formatting the contents. This is relevant to both =export= and =src= +block types. + +If an included file is specified as having a markup language, Org +neither checks for valid syntax nor changes the contents in any way. +For example and source blocks, Org code-escapes the contents before +inclusion. + +#+cindex: @samp{minlevel}, include +If an included file is not specified as having any markup language, +Org assumes it be in Org format and proceeds as usual with a few +exceptions. Org makes the footnote labels (see [[*Creating Footnotes]]) +in the included file local to that file. The contents of the included +file belong to the same structure---headline, item---containing the +=INCLUDE= keyword. In particular, headlines within the file become +children of the current section. That behavior can be changed by +providing an additional keyword parameter, =:minlevel=. It shifts the +headlines in the included file to become the lowest level. For +example, this syntax makes the included file a sibling of the current +top-level headline: + +: #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1 + +#+cindex: @samp{lines}, include +Inclusion of only portions of files are specified using ranges +parameter with =:lines= keyword. The line at the upper end of the +range will not be included. The start and/or the end of the range may +be omitted to use the obvious defaults. + +| =#+INCLUDE: "~/.emacs" :lines "5-10"= | Include lines 5 to 10, 10 excluded | +| =#+INCLUDE: "~/.emacs" :lines "-10"= | Include lines 1 to 10, 10 excluded | +| =#+INCLUDE: "~/.emacs" :lines "10-"= | Include lines from 10 to EOF | + +Inclusions may specify a file-link to extract an object matched by +~org-link-search~[fn:125] (see [[*Search Options in File Links]]). The +ranges for =:lines= keyword are relative to the requested element. +Therefore, + +: #+INCLUDE: "./paper.org::*conclusion" :lines 1-20 + +#+texinfo: @noindent +includes the first 20 lines of the headline named =conclusion=. + +#+cindex: @samp{only-contents}, include +To extract only the contents of the matched object, set +=:only-contents= property to non-~nil~. This omits any planning lines +or property drawers. For example, to include the body of the heading +with the custom ID =theory=, you can use + +: #+INCLUDE: "./paper.org::#theory" :only-contents t + +The following command allows navigating to the included document: + +- {{{kbd(C-c ')}}} (~org-edit~special~) :: + #+kindex: C-c ' + #+findex: org-edit-special + + Visit the included file at point. + +** Macro Replacement +:PROPERTIES: +:DESCRIPTION: Use macros to create templates. +:END: +#+cindex: macro replacement, during export +#+cindex: @samp{MACRO}, keyword + +#+vindex: org-export-global-macros +Macros replace text snippets during export. Macros are defined +globally in ~org-export-global-macros~, or document-wise with the +following syntax: + +: #+MACRO: name replacement text; $1, $2 are arguments + +#+texinfo: @noindent +which can be referenced using ={{{name(arg1, arg2)}}}=[fn:126]. For +example + +#+begin_example +,#+MACRO: poem Rose is $1, violet's $2. Life's ordered: Org assists you. +{{{poem(red,blue)}}} +#+end_example + +#+texinfo: @noindent +becomes + +: Rose is red, violet's blue. Life's ordered: Org assists you. + +As a special case, Org parses any replacement text starting with +=(eval= as an Emacs Lisp expression and evaluates it accordingly. +Within such templates, arguments become strings. Thus, the following +macro + +: #+MACRO: gnustamp (eval (concat "GNU/" (capitalize $1))) + +#+texinfo: @noindent +turns ={{{gnustamp(linux)}}}= into =GNU/Linux= during export. + +Org recognizes macro references in following Org markup areas: +paragraphs, headlines, verse blocks, tables cells and lists. Org also +recognizes macro references in keywords, such as =CAPTION=, =TITLE=, +=AUTHOR=, =DATE=, and for some back-end specific export options. + +Org comes with following pre-defined macros: + +#+attr_texinfo: :sep ; +- ={{{keyword(NAME)}}}=; ={{{title}}}=; ={{{author}}}=; ={{{email}}}= :: + + #+cindex: @samp{keyword}, macro + #+cindex: @samp{title}, macro + #+cindex: @samp{author}, macro + #+cindex: @samp{email}, macro + The =keyword= macro collects all values from {{{var(NAME)}}} + keywords throughout the buffer, separated with white space. + =title=, =author= and =email= macros are shortcuts for, + respectively, ={{{keyword(TITLE)}}}=, ={{{keyword(AUTHOR)}}}= and + ={{{keyword(EMAIL)}}}=. + +- ={{{date}}}=; ={{{date(FORMAT)}}}= :: + + #+cindex: @samp{date}, macro + This macro refers to the =DATE= keyword. {{{var(FORMAT)}}} is an + optional argument to the =date= macro that is used only if =DATE= is + a single timestamp. {{{var(FORMAT)}}} should be a format string + understood by ~format-time-string~. + +- ={{{time(FORMAT)}}}=; ={{{modification-time(FORMAT, VC)}}}= :: + + #+cindex: @samp{time}, macro + #+cindex: @samp{modification-time}, macro + These macros refer to the document's date and time of export and + date and time of modification. {{{var(FORMAT)}}} is a string + understood by ~format-time-string~. If the second argument to the + ~modification-time~ macro is non-~nil~, Org uses =vc.el= to retrieve + the document's modification time from the version control system. + Otherwise Org reads the file attributes. + +- ={{{input-file}}}= :: + + #+cindex: @samp{input-file}, macro + This macro refers to the filename of the exported file. + +- ={{{property(PROPERTY-NAME)}}}=; ={{{property(PROPERTY-NAME, SEARCH OPTION)}}}= :: + + #+cindex: @samp{property}, macro + This macro returns the value of property {{{var(PROPERTY-NAME)}}} in + the current entry. If {{{var(SEARCH-OPTION)}}} (see [[*Search + Options in File Links]]) refers to a remote entry, use it instead. + +- ={{{n}}}=; ={{{n(NAME)}}}=; ={{{n(NAME, ACTION)}}}= :: + + #+cindex: @samp{n}, macro + #+cindex: counter, macro + This macro implements custom counters by returning the number of + times the macro has been expanded so far while exporting the buffer. + You can create more than one counter using different {{{var(NAME)}}} + values. If {{{var(ACTION)}}} is =-=, previous value of the counter + is held, i.e., the specified counter is not incremented. If the + value is a number, the specified counter is set to that value. If + it is any other non-empty string, the specified counter is reset + to 1. You may leave {{{var(NAME)}}} empty to reset the default + counter. + +#+cindex: @samp{results}, macro +Moreover, inline source blocks (see [[*Structure of Code Blocks]]) use the +special =results= macro to mark their output. As such, you are +advised against re-defining it, unless you know what you are doing. + +#+vindex: org-hide-macro-markers +The surrounding brackets can be made invisible by setting +~org-hide-macro-markers~ to a non-~nil~ value. + +Org expands macros at the very beginning of the export process. + +** Comment Lines +:PROPERTIES: +:DESCRIPTION: What will not be exported. +:END: +#+cindex: exporting, not + +#+cindex: comment lines +Lines starting with zero or more whitespace characters followed by one +=#= and a whitespace are treated as comments and, as such, are not +exported. + +#+cindex: @samp{BEGIN_COMMENT} +#+cindex: comment block +Likewise, regions surrounded by =#+BEGIN_COMMENT= ... =#+END_COMMENT= +are not exported. + +#+cindex: comment trees +Finally, a =COMMENT= keyword at the beginning of an entry, but after +any other keyword or priority cookie, comments out the entire subtree. +In this case, the subtree is not exported and no code block within it +is executed either[fn:127]. The command below helps changing the +comment status of a headline. + +- {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: + #+kindex: C-c ; + #+findex: org-toggle-comment + + Toggle the =COMMENT= keyword at the beginning of an entry. + +** ASCII/Latin-1/UTF-8 export +:PROPERTIES: +:DESCRIPTION: Exporting to flat files with encoding. +:END: +#+cindex: ASCII export +#+cindex: Latin-1 export +#+cindex: UTF-8 export + +ASCII export produces an output file containing only plain ASCII +characters. This is the simplest and most direct text output. It +does not contain any Org markup. Latin-1 and UTF-8 export use +additional characters and symbols available in these encoding +standards. All three of these export formats offer the most basic of +text output for maximum portability. + +#+vindex: org-ascii-text-width +On export, Org fills and justifies text according to the text width +set in ~org-ascii-text-width~. + +#+vindex: org-ascii-links-to-notes +Org exports links using a footnote-like style where the descriptive +part is in the text and the link is in a note before the next heading. +See the variable ~org-ascii-links-to-notes~ for details. + +*** ASCII export commands +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+attr_texinfo: :sep , +- {{{kbd(C-c C-e t a)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t l)}}}, {{{kbd(C-c C-e t u)}}} :: + #+kindex: C-c C-e t a + #+kindex: C-c C-e t l + #+kindex: C-c C-e t u + #+findex: org-ascii-export-to-ascii + + Export as an ASCII file with a =.txt= extension. For =myfile.org=, + Org exports to =myfile.txt=, overwriting without warning. For + =myfile.txt=, Org exports to =myfile.txt.txt= in order to prevent + data loss. + +- {{{kbd(C-c C-e t A)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t L)}}}, {{{kbd(C-c C-e t U)}}} :: + #+kindex: C-c C-e t A + #+kindex: C-c C-e t L + #+kindex: C-c C-e t U + #+findex: org-ascii-export-as-ascii + + Export to a temporary buffer. Does not create a file. + +*** ASCII specific export settings +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +The ASCII export back-end has one extra keyword for customizing ASCII +output. Setting this keyword works similar to the general options +(see [[*Export Settings]]). + +- =SUBTITLE= :: + + #+cindex: @samp{SUBTITLE}, keyword + The document subtitle. For long subtitles, use multiple + =#+SUBTITLE= lines in the Org file. Org prints them on one + continuous line, wrapping into multiple lines if necessary. + +*** Header and sectioning structure +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Org converts the first three outline levels into headlines for ASCII +export. The remaining levels are turned into lists. To change this +cut-off point where levels become lists, see [[*Export Settings]]. + +*** Quoting ASCII text +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +To insert text within the Org file by the ASCII back-end, use one the +following constructs, inline, keyword, or export block: + +#+cindex: @samp{ASCII}, keyword +#+cindex: @samp{BEGIN_EXPORT ascii} +#+begin_example +Inline text @@ascii:and additional text@@ within a paragraph. + +,#+ASCII: Some text + +,#+BEGIN_EXPORT ascii +Org exports text in this block only when using ASCII back-end. +,#+END_EXPORT +#+end_example + +*** ASCII specific attributes +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: @samp{ATTR_ASCII}, keyword +#+cindex: horizontal rules, in ASCII export + +ASCII back-end recognizes only one attribute, =:width=, which +specifies the width of a horizontal rule in number of characters. The +keyword and syntax for specifying widths is: + +#+begin_example +,#+ATTR_ASCII: :width 10 +----- +#+end_example + +*** ASCII special blocks +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+cindex: special blocks, in ASCII export +#+cindex: @samp{BEGIN_JUSTIFYLEFT} +#+cindex: @samp{BEGIN_JUSTIFYRIGHT} + +Besides =#+BEGIN_CENTER= blocks (see [[*Paragraphs]]), ASCII back-end has +these two left and right justification blocks: + +#+begin_example +,#+BEGIN_JUSTIFYLEFT +It's just a jump to the left... +,#+END_JUSTIFYLEFT + +,#+BEGIN_JUSTIFYRIGHT +...and then a step to the right. +,#+END_JUSTIFYRIGHT +#+end_example + +** Beamer Export +:PROPERTIES: +:DESCRIPTION: Producing presentations and slides. +:END: +#+cindex: Beamer export + +Org uses Beamer export to convert an Org file tree structure into +high-quality interactive slides for presentations. Beamer is a LaTeX +document class for creating presentations in PDF, HTML, and other +popular display formats. + +*** Beamer export commands +:PROPERTIES: +:DESCRIPTION: For creating Beamer documents. +:END: + +- {{{kbd(C-c C-e l b)}}} (~org-beamer-export-to-latex~) :: + #+kindex: C-c C-e l b + #+findex: org-beamer-export-to-latex + + Export as LaTeX file with a =.tex= extension. For =myfile.org=, Org + exports to =myfile.tex=, overwriting without warning. + +- {{{kbd(C-c C-e l B)}}} (~org-beamer-export-as-latex~) :: + #+kindex: C-c C-e l B + #+findex: org-beamer-export-as-latex + + Export to a temporary buffer. Does not create a file. + +- {{{kbd(C-c C-e l P)}}} (~org-beamer-export-to-pdf~) :: + #+kindex: C-c C-e l P + #+findex: org-beamer-export-to-pdf + + Export as LaTeX file and then convert it to PDF format. + +- {{{kbd(C-c C-e l O)}}} :: + #+kindex: C-c C-e l O + + Export as LaTeX file, convert it to PDF format, and then open the + PDF file. + +*** Beamer specific export settings +:PROPERTIES: +:DESCRIPTION: For customizing Beamer export. +:END: + +Beamer export back-end has several additional keywords for customizing +Beamer output. These keywords work similar to the general options +settings (see [[*Export Settings]]). + +- =BEAMER_THEME= :: + + #+cindex: @samp{BEAMER_THEME}, keyword + #+vindex: org-beamer-theme + The Beamer layout theme (~org-beamer-theme~). Use square brackets + for options. For example: + + : #+BEAMER_THEME: Rochester [height=20pt] + +- =BEAMER_FONT_THEME= :: + + #+cindex: @samp{BEAMER_FONT_THEME}, keyword + The Beamer font theme. + +- =BEAMER_INNER_THEME= :: + + #+cindex: @samp{BEAMER_INNER_THEME}, keyword + The Beamer inner theme. + +- =BEAMER_OUTER_THEME= :: + + #+cindex: @samp{BEAMER_OUTER_THEME}, keyword + The Beamer outer theme. + +- =BEAMER_HEADER= :: + + #+cindex: @samp{BEAMER_HEADER}, keyword + Arbitrary lines inserted in the preamble, just before the =hyperref= + settings. + +- =DESCRIPTION= :: + + #+cindex: @samp{DESCRIPTION}, keyword + The document description. For long descriptions, use multiple + =DESCRIPTION= keywords. By default, =hyperref= inserts + =DESCRIPTION= as metadata. Use ~org-latex-hyperref-template~ to + configure document metadata. Use ~org-latex-title-command~ to + configure typesetting of description as part of front matter. + +- =KEYWORDS= :: + + #+cindex: @samp{KEYWORDS}, keyword + The keywords for defining the contents of the document. Use + multiple =KEYWORDS= lines if necessary. By default, =hyperref= + inserts =KEYWORDS= as metadata. Use ~org-latex-hyperref-template~ + to configure document metadata. Use ~org-latex-title-command~ to + configure typesetting of keywords as part of front matter. + +- =SUBTITLE= :: + + #+cindex: @samp{SUBTITLE}, keyword + Document's subtitle. For typesetting, use + ~org-beamer-subtitle-format~ string. Use + ~org-latex-hyperref-template~ to configure document metadata. Use + ~org-latex-title-command~ to configure typesetting of subtitle as + part of front matter. + +*** Frames and Blocks in Beamer +:PROPERTIES: +:DESCRIPTION: For composing Beamer slides. +:END: + +Org transforms heading levels into Beamer's sectioning elements, +frames and blocks. Any Org tree with a not-too-deep-level nesting +should in principle be exportable as a Beamer presentation. + +- + #+vindex: org-beamer-frame-level + Org headlines become Beamer frames when the heading level in Org is + equal to ~org-beamer-frame-level~ or =H= value in a =OPTIONS= line + (see [[*Export Settings]]). + + #+cindex: @samp{BEAMER_ENV}, property + Org overrides headlines to frames conversion for the current tree of + an Org file if it encounters the =BEAMER_ENV= property set to + =frame= or =fullframe=. Org ignores whatever + ~org-beamer-frame-level~ happens to be for that headline level in + the Org tree. In Beamer terminology, a full frame is a frame + without its title. + +- Org exports a Beamer frame's objects as block environments. Org can + enforce wrapping in special block types when =BEAMER_ENV= property + is set[fn:128]. For valid values see + ~org-beamer-environments-default~. To add more values, see + ~org-beamer-environments-extra~. + #+vindex: org-beamer-environments-default + #+vindex: org-beamer-environments-extra + +- + #+cindex: @samp{BEAMER_REF}, property + If =BEAMER_ENV= is set to =appendix=, Org exports the entry as an + appendix. When set to =note=, Org exports the entry as a note + within the frame or between frames, depending on the entry's heading + level. When set to =noteNH=, Org exports the entry as a note + without its title. When set to =againframe=, Org exports the entry + with =\againframe= command, which makes setting the =BEAMER_REF= + property mandatory because =\againframe= needs frame to resume. + + When =ignoreheading= is set, Org export ignores the entry's headline + but not its content. This is useful for inserting content between + frames. It is also useful for properly closing a =column= + environment. @end itemize + + #+cindex: @samp{BEAMER_ACT}, property + #+cindex: @samp{BEAMER_OPT}, property + When =BEAMER_ACT= is set for a headline, Org export translates that + headline as an overlay or action specification. When enclosed in + square brackets, Org export makes the overlay specification + a default. Use =BEAMER_OPT= to set any options applicable to the + current Beamer frame or block. The Beamer export back-end wraps + with appropriate angular or square brackets. It also adds the + =fragile= option for any code that may require a verbatim block. + + #+cindex: @samp{BEAMER_COL}, property + To create a column on the Beamer slide, use the =BEAMER_COL= + property for its headline in the Org file. Set the value of + =BEAMER_COL= to a decimal number representing the fraction of the + total text width. Beamer export uses this value to set the column's + width and fills the column with the contents of the Org entry. If + the Org entry has no specific environment defined, Beamer export + ignores the heading. If the Org entry has a defined environment, + Beamer export uses the heading as title. Behind the scenes, Beamer + export automatically handles LaTeX column separations for contiguous + headlines. To manually adjust them for any unique configurations + needs, use the =BEAMER_ENV= property. + +*** Beamer specific syntax +:PROPERTIES: +:DESCRIPTION: For using in Org documents. +:END: + +Since Org's Beamer export back-end is an extension of the LaTeX +back-end, it recognizes other LaTeX specific syntax---for example, +=#+LATEX:= or =#+ATTR_LATEX:=. See [[*LaTeX Export]], for details. + +Beamer export wraps the table of contents generated with =toc:t= +=OPTION= keyword in a =frame= environment. Beamer export does not +wrap the table of contents generated with =TOC= keyword (see [[*Table of +Contents]]). Use square brackets for specifying options. + +: #+TOC: headlines [currentsection] + +Insert Beamer-specific code using the following constructs: + +#+cindex: @samp{BEAMER}, keyword +#+cindex: @samp{BEGIN_EXPORT beamer} +#+begin_example +,#+BEAMER: \pause + +,#+BEGIN_EXPORT beamer + Only Beamer export back-end exports this. +,#+END_BEAMER + +Text @@beamer:some code@@ within a paragraph. +#+end_example + +Inline constructs, such as the last one above, are useful for adding +overlay specifications to objects with ~bold~, ~item~, ~link~, +~radio-target~ and ~target~ types. Enclose the value in angular +brackets and place the specification at the beginning of the object as +shown in this example: + +: A *@@beamer:<2->@@useful* feature + +#+cindex: @samp{ATTR_BEAMER}, keyword +Beamer export recognizes the =ATTR_BEAMER= keyword with the following +attributes from Beamer configurations: =:environment= for changing +local Beamer environment, =:overlay= for specifying Beamer overlays in +angular or square brackets, and =:options= for inserting optional +arguments. + +#+begin_example +,#+ATTR_BEAMER: :environment nonindentlist +- item 1, not indented +- item 2, not indented +- item 3, not indented +#+end_example + +#+begin_example +,#+ATTR_BEAMER: :overlay <+-> +- item 1 +- item 2 +#+end_example + +#+begin_example +,#+ATTR_BEAMER: :options [Lagrange] +Let $G$ be a finite group, and let $H$ be +a subgroup of $G$. Then the order of $H$ divides the order of $G$. +#+end_example + +*** Editing support +:PROPERTIES: +:DESCRIPTION: Editing support. +:END: + +Org Beamer mode is a special minor mode for faster editing of Beamer +documents. + +: #+STARTUP: beamer + +- {{{kbd(C-c C-b)}}} (~org-beamer-select-environment~) :: + #+kindex: C-c C-b + #+findex: org-beamer-select-environment + + Org Beamer mode provides this key for quicker selections in Beamer + normal environments, and for selecting the =BEAMER_COL= property. + +*** A Beamer example +:PROPERTIES: +:DESCRIPTION: A complete presentation. +:END: + +Here is an example of an Org document ready for Beamer export. + +#+begin_example +,#+TITLE: Example Presentation +,#+AUTHOR: Carsten Dominik +,#+OPTIONS: H:2 toc:t num:t +,#+LATEX_CLASS: beamer +,#+LATEX_CLASS_OPTIONS: [presentation] +,#+BEAMER_THEME: Madrid +,#+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) + +,* This is the first structural section + +,** Frame 1 +,*** Thanks to Eric Fraga :B_block: + :PROPERTIES: + :BEAMER_COL: 0.48 + :BEAMER_ENV: block + :END: + for the first viable Beamer setup in Org +,*** Thanks to everyone else :B_block: + :PROPERTIES: + :BEAMER_COL: 0.48 + :BEAMER_ACT: <2-> + :BEAMER_ENV: block + :END: + for contributing to the discussion +,**** This will be formatted as a beamer note :B_note: + :PROPERTIES: + :BEAMER_env: note + :END: +,** Frame 2 (where we will not use columns) +,*** Request + Please test this stuff! +#+end_example + +** HTML Export +:PROPERTIES: +:DESCRIPTION: Exporting to HTML. +:END: +#+cindex: HTML export + +Org mode contains an HTML exporter with extensive HTML formatting +compatible with XHTML 1.0 strict standard. + +*** HTML export commands +:PROPERTIES: +:DESCRIPTION: Invoking HTML export. +:END: + +- {{{kbd(C-c C-e h h)}}} (~org-html-export-to-html~) :: + #+kindex: C-c C-e h h + #+kindex: C-c C-e h o + #+findex: org-html-export-to-html + + Export as HTML file with a =.html= extension. For =myfile.org=, Org + exports to =myfile.html=, overwriting without warning. {{{kbd{C-c + C-e h o)}}} exports to HTML and opens it in a web browser. + +- {{{kbd(C-c C-e h H)}}} (~org-html-export-as-html~) :: + #+kindex: C-c C-e h H + #+findex: org-html-export-as-html + + Exports to a temporary buffer. Does not create a file. + +*** HTML specific export settings +:PROPERTIES: +:DESCRIPTION: Settings for HTML export. +:END: + +HTML export has a number of keywords, similar to the general options +settings described in [[*Export Settings]]. + +- =DESCRIPTION= :: + + #+cindex: @samp{DESCRIPTION}, keyword + This is the document's description, which the HTML exporter inserts + it as a HTML meta tag in the HTML file. For long descriptions, use + multiple =DESCRIPTION= lines. The exporter takes care of wrapping + the lines properly. + +- =HTML_DOCTYPE= :: + + #+cindex: @samp{HTML_DOCTYPE}, keyword + #+vindex: org-html-doctype + Specify the document type, for example: HTML5 (~org-html-doctype~). + +- =HTML_CONTAINER= :: + + #+cindex: @samp{HTML_CONTAINER}, keyword + #+vindex: org-html-container-element + Specify the HTML container, such as =div=, for wrapping sections and + elements (~org-html-container-element~). + +- =HTML_LINK_HOME= :: + + #+cindex: @samp{HTML_LINK_HOME}, keyword + #+vindex: org-html-link-home + The URL for home link (~org-html-link-home~). + +- =HTML_LINK_UP= :: + + #+cindex: @samp{HTML_LINK_UP}, keyword + #+vindex: org-html-link-up + The URL for the up link of exported HTML pages (~org-html-link-up~). + +- =HTML_MATHJAX= :: + + #+cindex: @samp{HTML_MATHJAX}, keyword + #+vindex: org-html-mathjax-options + Options for MathJax (~org-html-mathjax-options~). MathJax is used + to typeset LaTeX math in HTML documents. See [[*Math formatting in + HTML export]], for an example. + +- =HTML_HEAD= :: + + #+cindex: @samp{HTML_HEAD}, keyword + #+vindex: org-html-head + Arbitrary lines for appending to the HTML document's head + (~org-html-head~). + +- =HTML_HEAD_EXTRA= :: + + #+cindex: @samp{HTML_HEAD_EXTRA}, keyword + #+vindex: org-html-head-extra + More arbitrary lines for appending to the HTML document's head + (~org-html-head-extra~). + +- =KEYWORDS= :: + + #+cindex: @samp{KEYWORDS}, keyword + Keywords to describe the document's content. HTML exporter inserts + these keywords as HTML meta tags. For long keywords, use multiple + =KEYWORDS= lines. + +- =LATEX_HEADER= :: + + #+cindex: @samp{LATEX_HEADER}, keyword + Arbitrary lines for appending to the preamble; HTML exporter appends + when transcoding LaTeX fragments to images (see [[*Math formatting in + HTML export]]). + +- =SUBTITLE= :: + + #+cindex: @samp{SUBTITLE}, keyword + The document's subtitle. HTML exporter formats subtitle if document + type is =HTML5= and the CSS has a =subtitle= class. + +Some of these keywords are explained in more detail in the following +sections of the manual. + +*** HTML doctypes +:PROPERTIES: +:DESCRIPTION: Exporting various (X)HTML flavors. +:END: + +Org can export to various (X)HTML flavors. + +#+vindex: org-html-doctype +#+vindex: org-html-doctype-alist +Set the ~org-html-doctype~ variable for different (X)HTML variants. +Depending on the variant, the HTML exporter adjusts the syntax of HTML +conversion accordingly. Org includes the following ready-made +variants: + +- ~"html4-strict"~ +- ~"html4-transitional"~ +- ~"html4-frameset"~ +- ~"xhtml-strict"~ +- ~"xhtml-transitional"~ +- ~"xhtml-frameset"~ +- ~"xhtml-11"~ +- ~"html5"~ +- ~"xhtml5"~ + +#+texinfo: @noindent +See the variable ~org-html-doctype-alist~ for details. The default is +~"xhtml-strict"~. + +#+vindex: org-html-html5-fancy +#+cindex: @samp{HTML5}, export new elements +Org's HTML exporter does not by default enable new block elements +introduced with the HTML5 standard. To enable them, set +~org-html-html5-fancy~ to non-~nil~. Or use an =OPTIONS= line in the +file to set =html5-fancy=. + +HTML5 documents can now have arbitrary =#+BEGIN= ... =#+END= blocks. +For example: + +#+begin_example +,#+BEGIN_aside + Lorem ipsum +,#+END_aside +#+end_example + +#+texinfo: @noindent +exports to: + +#+begin_src html +<aside> + <p>Lorem ipsum</p> +</aside> +#+end_src + +#+texinfo: @noindent +while this: + +#+begin_example +,#+ATTR_HTML: :controls controls :width 350 +,#+BEGIN_video +,#+HTML: <source src="movie.mp4" type="video/mp4"> +,#+HTML: <source src="movie.ogg" type="video/ogg"> +Your browser does not support the video tag. +,#+END_video +#+end_example + +#+texinfo: @noindent +exports to: + +#+begin_src html +<video controls="controls" width="350"> + <source src="movie.mp4" type="video/mp4"> + <source src="movie.ogg" type="video/ogg"> + <p>Your browser does not support the video tag.</p> +</video> +#+end_src + +#+vindex: org-html-html5-elements +When special blocks do not have a corresponding HTML5 element, the +HTML exporter reverts to standard translation (see +~org-html-html5-elements~). For example, =#+BEGIN_lederhosen= exports +to ~<div class="lederhosen">~. + +Special blocks cannot have headlines. For the HTML exporter to wrap +the headline and its contents in ~<section>~ or ~<article>~ tags, set +the =HTML_CONTAINER= property for the headline. + +*** HTML preamble and postamble +:PROPERTIES: +:DESCRIPTION: Inserting preamble and postamble. +:END: +#+vindex: org-html-preamble +#+vindex: org-html-postamble +#+vindex: org-html-preamble-format +#+vindex: org-html-postamble-format +#+vindex: org-html-validation-link +#+vindex: org-export-creator-string +#+vindex: org-export-time-stamp-file + +The HTML exporter has delineations for preamble and postamble. The +default value for ~org-html-preamble~ is ~t~, which makes the HTML +exporter insert the preamble. See the variable +~org-html-preamble-format~ for the format string. + +Set ~org-html-preamble~ to a string to override the default format +string. If the string is a function, the HTML exporter expects the +function to return a string upon execution. The HTML exporter inserts +this string in the preamble. The HTML exporter does not insert +a preamble if ~org-html-preamble~ is set ~nil~. + +The default value for ~org-html-postamble~ is ~auto~, which makes the +HTML exporter build a postamble from looking up author's name, email +address, creator's name, and date. Set ~org-html-postamble~ to ~t~ to +insert the postamble in the format specified in the +~org-html-postamble-format~ variable. The HTML exporter does not +insert a postamble if ~org-html-postamble~ is set to ~nil~. + +*** Quoting HTML tags +:PROPERTIES: +:DESCRIPTION: Using direct HTML in Org files. +:END: + +The HTML export back-end transforms =<= and =>= to =<= and =>=. +To include raw HTML code in the Org file so the HTML export back-end +can insert that HTML code in the output, use this inline syntax: +=@@html:...@@=. For example: + +: @@html:<b>@@bold text@@html:</b>@@ + +#+cindex: @samp{HTML}, keyword +#+cindex: @samp{BEGIN_EXPORT html} +For larger raw HTML code blocks, use these HTML export code blocks: + +#+begin_example +,#+HTML: Literal HTML code for export + +,#+BEGIN_EXPORT html + All lines between these markers are exported literally +,#+END_EXPORT +#+end_example + +*** Headlines in HTML export +:PROPERTIES: +:DESCRIPTION: Formatting headlines. +:END: +#+cindex: headlines, in HTML export + +Headlines are exported to =<h1>=, =<h2>=, etc. Each headline gets the +=id= attribute from =CUSTOM_ID= property, or a unique generated value, +see [[*Internal Links]]. + +#+vindex: org-html-self-link-headlines +When ~org-html-self-link-headlines~ is set to a non-~nil~ value, the +text of the headlines is also wrapped in =<a>= tags. These tags have +a =href= attribute making the headlines link to themselves. + +*** Links in HTML export +:PROPERTIES: +:DESCRIPTION: Inserting and formatting links. +:END: +#+cindex: links, in HTML export +#+cindex: internal links, in HTML export +#+cindex: external links, in HTML export + +The HTML export back-end transforms Org's internal links (see +[[*Internal Links]]) to equivalent HTML links in the output. The back-end +similarly handles Org's automatic links created by radio targets (see +[[*Radio Targets]]) similarly. For Org links to external files, the +back-end transforms the links to /relative/ paths. + +#+vindex: org-html-link-org-files-as-html +For Org links to other =.org= files, the back-end automatically +changes the file extension to =.html= and makes file paths relative. +If the =.org= files have an equivalent =.html= version at the same +location, then the converted links should work without any further +manual intervention. However, to disable this automatic path +translation, set ~org-html-link-org-files-as-html~ to ~nil~. When +disabled, the HTML export back-end substitutes the ID-based links in +the HTML output. For more about linking files when publishing to +a directory, see [[*Publishing links]]. + +Org files can also have special directives to the HTML export +back-end. For example, by using =#+ATTR_HTML= lines to specify new +format attributes to ~<a>~ or ~<img>~ tags. This example shows +changing the link's title and style: + +#+cindex: @samp{ATTR_HTML}, keyword +#+begin_example +,#+ATTR_HTML: :title The Org mode homepage :style color:red; +[[https://orgmode.org]] +#+end_example + +*** Tables in HTML export +:PROPERTIES: +:DESCRIPTION: How to modify the formatting of tables. +:END: +#+cindex: tables, in HTML +#+vindex: org-export-html-table-tag + +The HTML export back-end uses ~org-html-table-default-attributes~ when +exporting Org tables to HTML. By default, the exporter does not draw +frames and cell borders. To change for this for a table, use the +following lines before the table in the Org file: + +#+cindex: @samp{CAPTION}, keyword +#+cindex: @samp{ATTR_HTML}, keyword +#+begin_example +,#+CAPTION: This is a table with lines around and between cells +,#+ATTR_HTML: :border 2 :rules all :frame border +#+end_example + +The HTML export back-end preserves column groupings in Org tables (see +[[*Column Groups]]) when exporting to HTML. + +Additional options for customizing tables for HTML export. + +- ~org-html-table-align-individual-fields~ :: + + #+vindex: org-html-table-align-individual-fields + Non-~nil~ attaches style attributes for alignment to each table + field. + +- ~org-html-table-caption-above~ :: + + #+vindex: org-html-table-caption-above + Non-~nil~ places caption string at the beginning of the table. + +- ~org-html-table-data-tags~ :: + + #+vindex: org-html-table-data-tags + Opening and ending tags for table data fields. + +- ~org-html-table-default-attributes~ :: + + #+vindex: org-html-table-default-attributes + Default attributes and values for table tags. + +- ~org-html-table-header-tags~ :: + + #+vindex: org-html-table-header-tags + Opening and ending tags for table's header fields. + +- ~org-html-table-row-tags~ :: + + #+vindex: org-html-table-row-tags + Opening and ending tags for table rows. + +- ~org-html-table-use-header-tags-for-first-column~ :: + + #+vindex: org-html-table-use-header-tags-for-first-column + Non-~nil~ formats column one in tables with header tags. + +*** Images in HTML export +:PROPERTIES: +:DESCRIPTION: How to insert figures into HTML output. +:END: +#+cindex: images, inline in HTML +#+cindex: inlining images in HTML + +The HTML export back-end has features to convert Org image links to +HTML inline images and HTML clickable image links. + +#+vindex: org-html-inline-images +When the link in the Org file has no description, the HTML export +back-end by default in-lines that image. For example: +=[[file:myimg.jpg]]= is in-lined, while =[[file:myimg.jpg][the image]]= links to the text, +=the image=. For more details, see the variable +~org-html-inline-images~. + +On the other hand, if the description part of the Org link is itself +another link, such as =file:= or =http:= URL pointing to an image, the +HTML export back-end in-lines this image and links to the main image. +This Org syntax enables the back-end to link low-resolution thumbnail +to the high-resolution version of the image, as shown in this example: + +: [[file:highres.jpg][file:thumb.jpg]] + +To change attributes of in-lined images, use =#+ATTR_HTML= lines in +the Org file. This example shows realignment to right, and adds ~alt~ +and ~title~ attributes in support of text viewers and modern web +accessibility standards. + +#+cindex: @samp{CAPTION}, keyword +#+cindex: @samp{ATTR_HTML}, keyword +#+begin_example +,#+CAPTION: A black cat stalking a spider +,#+ATTR_HTML: :alt cat/spider image :title Action! :align right +[[./img/a.jpg]] +#+end_example + +The HTML export back-end copies the =http= links from the Org file +as-is. + +*** Math formatting in HTML export +:PROPERTIES: +:DESCRIPTION: Beautiful math also on the web. +:END: +#+cindex: MathJax +#+cindex: dvipng +#+cindex: dvisvgm +#+cindex: ImageMagick + +#+vindex: org-html-mathjax-options~ +LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two +different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]], +which should work out of the box with Org[fn:129][fn:130]. Some MathJax +display options can be configured via ~org-html-mathjax-options~, or +in the buffer. For example, with the following settings, + +#+begin_example +,#+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler +,#+HTML_MATHJAX: cancel.js noErrors.js +#+end_example + +#+texinfo: @noindent +equation labels are displayed on the left margin and equations are +five em from the left margin. In addition, it loads the two MathJax +extensions =cancel.js= and =noErrors.js=[fn:131]. + +#+vindex: org-html-mathjax-template +See the docstring of ~org-html-mathjax-options~ for all supported +variables. The MathJax template can be configure via +~org-html-mathjax-template~. + +If you prefer, you can also request that LaTeX fragments are processed +into small images that will be inserted into the browser page. Before +the availability of MathJax, this was the default method for Org +files. This method requires that the dvipng program, dvisvgm or +ImageMagick suite is available on your system. You can still get this +processing with + +: #+OPTIONS: tex:dvipng + +: #+OPTIONS: tex:dvisvgm + +#+texinfo: @noindent +or + +: #+OPTIONS: tex:imagemagick + +*** Text areas in HTML export +:PROPERTIES: +:DESCRIPTION: An alternate way to show an example. +:END: + +#+cindex: text areas, in HTML +Before Org mode's Babel, one popular approach to publishing code in +HTML was by using =:textarea=. The advantage of this approach was +that copying and pasting was built into browsers with simple +JavaScript commands. Even editing before pasting was made simple. + +The HTML export back-end can create such text areas. It requires an +=#+ATTR_HTML= line as shown in the example below with the =:textarea= +option. This must be followed by either an example or a source code +block. Other Org block types do not honor the =:textarea= option. + +By default, the HTML export back-end creates a text area 80 characters +wide and height just enough to fit the content. Override these +defaults with =:width= and =:height= options on the =#+ATTR_HTML= +line. + +#+begin_example +,#+ATTR_HTML: :textarea t :width 40 +,#+BEGIN_EXAMPLE + (defun org-xor (a b) + "Exclusive or." + (if a (not b) b)) +,#+END_EXAMPLE +#+end_example + +*** CSS support +:PROPERTIES: +:DESCRIPTION: Changing the appearance of the output. +:END: +#+cindex: CSS, for HTML export +#+cindex: HTML export, CSS + +#+vindex: org-export-html-todo-kwd-class-prefix +#+vindex: org-export-html-tag-class-prefix +You can modify the CSS style definitions for the exported file. The +HTML exporter assigns the following special CSS classes[fn:132] to +appropriate parts of the document---your style specifications may +change these, in addition to any of the standard classes like for +headlines, tables, etc. + +| ~p.author~ | author information, including email | +| ~p.date~ | publishing date | +| ~p.creator~ | creator info, about org mode version | +| ~.title~ | document title | +| ~.subtitle~ | document subtitle | +| ~.todo~ | TODO keywords, all not-done states | +| ~.done~ | the DONE keywords, all states that count as done | +| ~.WAITING~ | each TODO keyword also uses a class named after itself | +| ~.timestamp~ | timestamp | +| ~.timestamp-kwd~ | keyword associated with a timestamp, like =SCHEDULED= | +| ~.timestamp-wrapper~ | span around keyword plus timestamp | +| ~.tag~ | tag in a headline | +| ~._HOME~ | each tag uses itself as a class, "@" replaced by "_" | +| ~.target~ | target for links | +| ~.linenr~ | the line number in a code example | +| ~.code-highlighted~ | for highlighting referenced code lines | +| ~div.outline-N~ | div for outline level N (headline plus text) | +| ~div.outline-text-N~ | extra div for text at outline level N | +| ~.section-number-N~ | section number in headlines, different for each level | +| ~.figure-number~ | label like "Figure 1:" | +| ~.table-number~ | label like "Table 1:" | +| ~.listing-number~ | label like "Listing 1:" | +| ~div.figure~ | how to format an in-lined image | +| ~pre.src~ | formatted source code | +| ~pre.example~ | normal example | +| ~p.verse~ | verse paragraph | +| ~div.footnotes~ | footnote section headline | +| ~p.footnote~ | footnote definition paragraph, containing a footnote | +| ~.footref~ | a footnote reference number (always a <sup>) | +| ~.footnum~ | footnote number in footnote definition (always <sup>) | +| ~.org-svg~ | default class for a linked =.svg= image | + +#+vindex: org-html-style-default +#+vindex: org-html-head +#+vindex: org-html-head-extra +#+cindex: @samp{HTML_INCLUDE_STYLE}, keyword +The HTML export back-end includes a compact default style in each +exported HTML file. To override the default style with another style, +use these keywords in the Org file. They will replace the global +defaults the HTML exporter uses. + +#+cindex: @samp{HTML_HEAD}, keyword +#+cindex: @samp{HTML_HEAD_EXTRA}, keyword +#+begin_example +,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" /> +,#+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" /> +#+end_example + +#+vindex: org-html-head-include-default-style +To just turn off the default style, customize +~org-html-head-include-default-style~ variable, or use this option +line in the Org file. + +#+cindex: @samp{html-style}, @samp{OPTIONS} item +: #+OPTIONS: html-style:nil + +For longer style definitions, either use several =HTML_HEAD= and +=HTML_HEAD_EXTRA= keywords, or use ~<style> ... </style>~ blocks +around them. Both of these approaches can avoid referring to an +external file. + +#+cindex: @samp{HTML_CONTAINER_CLASS}, property +#+cindex: @samp{HTML_HEADLINE_CLASS}, property +In order to add styles to a sub-tree, use the =HTML_CONTAINER_CLASS= +property to assign a class to the tree. In order to specify CSS +styles for a particular headline, you can use the ID specified in +a =CUSTOM_ID= property. You can also assign a specific class to +a headline with the =HTML_HEADLINE_CLASS= property. + +Never change the ~org-html-style-default~ constant. Instead use other +simpler ways of customizing as described above. + +*** JavaScript supported display of web pages +:PROPERTIES: +:DESCRIPTION: Info and folding in a web browser. +:ALT_TITLE: JavaScript support +:END: + +Sebastian Rose has written a JavaScript program especially designed to +allow two different ways of viewing HTML files created with Org. One +is an /Info/-like mode where each section is displayed separately and +navigation can be done with the {{{kbd(n)}}} and {{{kbd(p)}}} keys, and some other +keys as well, press {{{kbd(?)}}} for an overview of the available keys. The +second one has a /folding/ view, much like Org provides inside Emacs. +The script is available at https://orgmode.org/org-info.js and the +documentation at https://orgmode.org/worg/code/org-info-js/. The +script is hosted on https://orgmode.org, but for reliability, prefer +installing it on your own web server. + +To use this program, just add this line to the Org file: + +#+cindex: @samp{INFOJS_OPT}, keyword +: #+INFOJS_OPT: view:info toc:nil + +#+texinfo: @noindent +The HTML header now has the code needed to automatically invoke the +script. For setting options, use the syntax from the above line for +options described below: + +- =path:= :: + + The path to the script. The default is to grab the script from + [[https://orgmode.org/org-info.js]], but you might want to have a local + copy and use a path like =../scripts/org-info.js=. + +- =view:= :: + + Initial view when the website is first shown. Possible values are: + + | =info= | Info-like interface with one section per page | + | =overview= | Folding interface, initially showing only top-level | + | =content= | Folding interface, starting with all headlines visible | + | =showall= | Folding interface, all headlines and text visible | + +- =sdepth:= :: + + Maximum headline level still considered as an independent section + for info and folding modes. The default is taken from + ~org-export-headline-levels~, i.e., the =H= switch in =OPTIONS=. If + this is smaller than in ~org-export-headline-levels~, each + info/folding section can still contain child headlines. + +- =toc:= :: + + Should the table of contents /initially/ be visible? Even when + =nil=, you can always get to the "toc" with {{{kbd(i)}}}. + +- =tdepth:= :: + + The depth of the table of contents. The defaults are taken from the + variables ~org-export-headline-levels~ and ~org-export-with-toc~. + +- =ftoc:= :: + + Does the CSS of the page specify a fixed position for the "toc"? If + yes, the toc is displayed as a section. + +- =ltoc:= :: + + Should there be short contents (children) in each section? Make + this =above= if the section should be above initial text. + +- =mouse:= :: + + Headings are highlighted when the mouse is over them. Should be + =underline= (default) or a background color like =#cccccc=. + +- =buttons:= :: + + Should view-toggle buttons be everywhere? When =nil= (the default), + only one such button is present. + +#+vindex: org-infojs-options +#+vindex: org-export-html-use-infojs +You can choose default values for these options by customizing the +variable ~org-infojs-options~. If you always want to apply the script +to your pages, configure the variable ~org-export-html-use-infojs~. + +** LaTeX Export +:PROPERTIES: +:DESCRIPTION: Exporting to @LaTeX{} and processing to PDF. +:END: +#+cindex: @LaTeX{} export +#+cindex: PDF export + +The LaTeX export back-end can handle complex documents, incorporate +standard or custom LaTeX document classes, generate documents using +alternate LaTeX engines, and produce fully linked PDF files with +indexes, bibliographies, and tables of contents, destined for +interactive online viewing or high-quality print publication. + +While the details are covered in-depth in this section, here are some +quick references to variables for the impatient: for engines, see +~org-latex-compiler~; for build sequences, see +~org-latex-pdf-process~; for packages, see +~org-latex-default-packages-alist~ and ~org-latex-packages-alist~. + +An important note about the LaTeX export back-end: it is sensitive to +blank lines in the Org document. That's because LaTeX itself depends +on blank lines to tell apart syntactical elements, such as paragraphs. + +*** LaTeX/PDF export commands +:PROPERTIES: +:DESCRIPTION: For producing @LaTeX{} and PDF documents. +:END: + +- {{{kbd(C-c C-e l l)}}} (~org-latex-export-to-latex~) :: + + #+kindex: C-c C-e l l + #+findex: org-latex-export-to-latex~ + Export to a LaTeX file with a =.tex= extension. For =myfile.org=, + Org exports to =myfile.tex=, overwriting without warning. + +- {{{kbd(C-c C-e l L)}}} (~org-latex-export-as-latex~) :: + + #+kindex: C-c C-e l L + #+findex: org-latex-export-as-latex + Export to a temporary buffer. Do not create a file. + +- {{{kbd(C-c C-e l p)}}} (~org-latex-export-to-pdf~) :: + + #+kindex: C-c C-e l p + #+findex: org-latex-export-to-pdf + Export as LaTeX file and convert it to PDF file. + +- {{{kbd(C-c C-e l o)}}} :: + + #+kindex: C-c C-e l o + Export as LaTeX file and convert it to PDF, then open the PDF using + the default viewer. + +- {{{kbd(M-x org-export-region-as-latex)}}} :: + + Convert the region to LaTeX under the assumption that it was in Org + mode syntax before. This is a global command that can be invoked in + any buffer. + +#+vindex: org-latex-compiler +#+vindex: org-latex-bibtex-compiler +#+vindex: org-latex-default-packages-alist +#+cindex: pdflatex +#+cindex: xelatex +#+cindex: lualatex +#+cindex: @samp{LATEX_COMPILER}, keyword +The LaTeX export back-end can use any of these LaTeX engines: +=pdflatex=, =xelatex=, and =lualatex=. These engines compile LaTeX +files with different compilers, packages, and output options. The +LaTeX export back-end finds the compiler version to use from +~org-latex-compiler~ variable or the =#+LATEX_COMPILER= keyword in the +Org file. See the docstring for the +~org-latex-default-packages-alist~ for loading packages with certain +compilers. Also see ~org-latex-bibtex-compiler~ to set the +bibliography compiler[fn:133]. + +*** LaTeX specific export settings +:PROPERTIES: +:DESCRIPTION: Unique to this @LaTeX{} back-end. +:END: + +The LaTeX export back-end has several additional keywords for +customizing LaTeX output. Setting these keywords works similar to the +general options (see [[*Export Settings]]). + +#+attr_texinfo: :sep , +- =DESCRIPTION= :: + #+cindex: @samp{DESCRIPTION}, keyword + #+vindex: org-latex-hyperref-template + #+vindex: org-latex-title-command + The document's description. The description along with author name, + keywords, and related file metadata are inserted in the output file + by the hyperref package. See ~org-latex-hyperref-template~ for + customizing metadata items. See ~org-latex-title-command~ for + typesetting description into the document's front matter. Use + multiple =DESCRIPTION= keywords for long descriptions. + +- =LANGUAGE= :: + #+cindex: @samp{LANGUAGE}, keyword + #+vindex: org-latex-packages-alist + In order to be effective, the =babel= or =polyglossia= + packages---according to the LaTeX compiler used---must be loaded + with the appropriate language as argument. This can be accomplished + by modifying the ~org-latex-packages-alist~ variable, e.g., with the + following snippet: + + #+begin_src emacs-lisp + (add-to-list 'org-latex-packages-alist + '("AUTO" "babel" t ("pdflatex"))) + (add-to-list 'org-latex-packages-alist + '("AUTO" "polyglossia" t ("xelatex" "lualatex"))) + #+end_src + +- =LATEX_CLASS= :: + + #+cindex: @samp{LATEX_CLASS}, keyword + #+vindex: org-latex-default-class + #+vindex: org-latex-classes + This is LaTeX document class, such as /article/, /report/, /book/, + and so on, which contain predefined preamble and headline level + mapping that the LaTeX export back-end needs. The back-end reads + the default class name from the ~org-latex-default-class~ variable. + Org has /article/ as the default class. A valid default class must + be an element of ~org-latex-classes~. + +- =LATEX_CLASS_OPTIONS= :: + + #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword + Options the LaTeX export back-end uses when calling the LaTeX + document class. + +- =LATEX_COMPILER= :: + + #+cindex: @samp{LATEX_COMPILER}, keyword + #+vindex: org-latex-compiler + The compiler, such as =pdflatex=, =xelatex=, =lualatex=, for + producing the PDF. See ~org-latex-compiler~. + +- =LATEX_HEADER=, =LATEX_HEADER_EXTRA= :: + + #+cindex: @samp{LATEX_HEADER}, keyword + #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword + #+vindex: org-latex-classes + Arbitrary lines to add to the document's preamble, before the + hyperref settings. See ~org-latex-classes~ for adjusting the + structure and order of the LaTeX headers. + +- =KEYWORDS= :: + + #+cindex: @samp{KEYWORDS}, keyword + #+vindex: org-latex-hyperref-template + #+vindex: org-latex-title-command + The keywords for the document. The description along with author + name, keywords, and related file metadata are inserted in the output + file by the hyperref package. See ~org-latex-hyperref-template~ for + customizing metadata items. See ~org-latex-title-command~ for + typesetting description into the document's front matter. Use + multiple =KEYWORDS= lines if necessary. + +- =SUBTITLE= :: + + #+cindex: @samp{SUBTITLE}, keyword + #+vindex: org-latex-subtitle-separate + #+vindex: org-latex-subtitle-format + The document's subtitle. It is typeset as per + ~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is + non-~nil~, it is typed outside of the ~\title~ macro. See + ~org-latex-hyperref-template~ for customizing metadata items. See + ~org-latex-title-command~ for typesetting description into the + document's front matter. + +The following sections have further details. + +*** LaTeX header and sectioning structure +:PROPERTIES: +:DESCRIPTION: Setting up the export file structure. +:ALT_TITLE: LaTeX header and sectioning +:END: +#+cindex: @LaTeX{} class +#+cindex: @LaTeX{} sectioning structure +#+cindex: @LaTeX{} header +#+cindex: header, for @LaTeX{} files +#+cindex: sectioning structure, for @LaTeX{} export + +The LaTeX export back-end converts the first three of Org's outline +levels into LaTeX headlines. The remaining Org levels are exported as +lists. To change this globally for the cut-off point between levels +and lists, (see [[*Export Settings]]). + +By default, the LaTeX export back-end uses the /article/ class. + +#+vindex: org-latex-default-class +#+vindex: org-latex-classes +#+vindex: org-latex-default-packages-alist +#+vindex: org-latex-packages-alist +To change the default class globally, edit ~org-latex-default-class~. +To change the default class locally in an Org file, add option lines +=#+LATEX_CLASS: myclass=. To change the default class for just a part +of the Org file, set a sub-tree property, =EXPORT_LATEX_CLASS=. The +class name entered here must be valid member of ~org-latex-classes~. +This variable defines a header template for each class into which the +exporter splices the values of ~org-latex-default-packages-alist~ and +~org-latex-packages-alist~. Use the same three variables to define +custom sectioning or custom classes. + +#+cindex: @samp{LATEX_CLASS}, keyword +#+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword +#+cindex: @samp{EXPORT_LATEX_CLASS}, property +#+cindex: @samp{EXPORT_LATEX_CLASS_OPTIONS}, property +The LaTeX export back-end sends the =LATEX_CLASS_OPTIONS= keyword and +=EXPORT_LATEX_CLASS_OPTIONS= property as options to the LaTeX +~\documentclass~ macro. The options and the syntax for specifying +them, including enclosing them in square brackets, follow LaTeX +conventions. + +: #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn] + +#+cindex: @samp{LATEX_HEADER}, keyword +#+cindex: @samp{LATEX_HEADER_EXTRA}, keyword +The LaTeX export back-end appends values from =LATEX_HEADER= and +=LATEX_HEADER_EXTRA= keywords to the LaTeX header. The docstring for +~org-latex-classes~ explains in more detail. Also note that LaTeX +export back-end does not append =LATEX_HEADER_EXTRA= to the header +when previewing LaTeX snippets (see [[*Previewing LaTeX fragments]]). + +A sample Org file with the above headers: + +#+begin_example +,#+LATEX_CLASS: article +,#+LATEX_CLASS_OPTIONS: [a4paper] +,#+LATEX_HEADER: \usepackage{xyz} + +,* Headline 1 + some text +,* Headline 2 + some more text +#+end_example + +*** Quoting LaTeX code +:PROPERTIES: +:DESCRIPTION: Incorporating literal @LaTeX{} code. +:END: + +The LaTeX export back-end can insert any arbitrary LaTeX code, see +[[*Embedded LaTeX]]. There are three ways to embed such code in the Org +file and they all use different quoting syntax. + +#+cindex: inline, in @LaTeX{} export +Inserting in-line quoted with @ symbols: + +: Code embedded in-line @@latex:any arbitrary LaTeX code@@ in a paragraph. + +#+cindex: @samp{LATEX}, keyword +Inserting as one or more keyword lines in the Org file: + +: #+LATEX: any arbitrary LaTeX code + +#+cindex: @samp{BEGIN_EXPORT latex} +Inserting as an export block in the Org file, where the back-end +exports any code between begin and end markers: + +#+begin_example +,#+BEGIN_EXPORT latex + any arbitrary LaTeX code +,#+END_EXPORT +#+end_example + +*** Tables in LaTeX export +:PROPERTIES: +:DESCRIPTION: Options for exporting tables to @LaTeX{}. +:END: +#+cindex: tables, in @LaTeX{} export + +The LaTeX export back-end can pass several LaTeX attributes for table +contents and layout. Besides specifying a label (see [[*Internal Links]]) +and a caption (see [[*Captions]]), the other valid LaTeX attributes +include: + +#+attr_texinfo: :sep , +- =:mode= :: + + #+vindex: org-latex-default-table-mode + The LaTeX export back-end wraps the table differently depending on + the mode for accurate rendering of math symbols. Mode is either + =table=, =math=, =inline-math= or =verbatim=. + + For =math= or =inline-math= mode, LaTeX export back-end wraps the + table in a math environment, but every cell in it is exported as-is. + The LaTeX export back-end determines the default mode from + ~org-latex-default-table-mode~. The LaTeX export back-end merges + contiguous tables in the same mode into a single environment. + +- =:environment= :: + + #+vindex: org-latex-default-table-environment + Set the default LaTeX table environment for the LaTeX export + back-end to use when exporting Org tables. Common LaTeX table + environments are provided by these packages: tabularx, longtable, + array, tabu, and bmatrix. For packages, such as tabularx and tabu, + or any newer replacements, include them in the + ~org-latex-packages-alist~ variable so the LaTeX export back-end can + insert the appropriate load package headers in the converted LaTeX + file. Look in the docstring for the ~org-latex-packages-alist~ + variable for configuring these packages for LaTeX snippet previews, + if any. + +- =:caption= :: + + Use =CAPTION= keyword to set a simple caption for a table (see + [[*Captions]]). For custom captions, use =:caption= attribute, which + accepts raw LaTeX code. =:caption= value overrides =CAPTION= value. + +- =:float=, =:placement= :: + + The table environments by default are not floats in LaTeX. To make + them floating objects use =:float= with one of the following + options: =sideways=, =multicolumn=, =t=, and =nil=. + + LaTeX floats can also have additional layout =:placement= + attributes. These are the usual =[h t b p ! H]= permissions + specified in square brackets. Note that for =:float sideways= + tables, the LaTeX export back-end ignores =:placement= attributes. + +- =:align=, =:font=, =:width= :: + + The LaTeX export back-end uses these attributes for regular tables + to set their alignments, fonts, and widths. + +- =:spread= :: + + When =:spread= is non-~nil~, the LaTeX export back-end spreads or + shrinks the table by the =:width= for tabu and longtabu + environments. =:spread= has no effect if =:width= is not set. + +- =:booktabs=, =:center=, =:rmlines= :: + + #+vindex: org-latex-tables-booktabs + #+vindex: org-latex-tables-centered + All three commands are toggles. =:booktabs= brings in modern + typesetting enhancements to regular tables. The booktabs package + has to be loaded through ~org-latex-packages-alist~. =:center= is + for centering the table. =:rmlines= removes all but the very first + horizontal line made of ASCII characters from "table.el" tables + only. + +- =:math-prefix=, =:math-suffix=, =:math-arguments= :: + + The LaTeX export back-end inserts =:math-prefix= string value in + a math environment before the table. The LaTeX export back-end + inserts =:math-suffix= string value in a math environment after the + table. The LaTeX export back-end inserts =:math-arguments= string + value between the macro name and the table's contents. + =:math-arguments= comes in use for matrix macros that require more + than one argument, such as =qbordermatrix=. + +LaTeX table attributes help formatting tables for a wide range of +situations, such as matrix product or spanning multiple pages: + +#+begin_example +,#+ATTR_LATEX: :environment longtable :align l|lp{3cm}r|l +| ... | ... | +| ... | ... | + +,#+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times +| a | b | +| c | d | +,#+ATTR_LATEX: :mode math :environment bmatrix +| 1 | 2 | +| 3 | 4 | +#+end_example + +Set the caption with the LaTeX command +=\bicaption{HeadingA}{HeadingB}=: + +#+begin_example +,#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB} +| ... | ... | +| ... | ... | +#+end_example + +*** Images in LaTeX export +:PROPERTIES: +:DESCRIPTION: How to insert figures into @LaTeX{} output. +:END: +#+cindex: images, inline in LaTeX +#+cindex: inlining images in LaTeX +#+cindex: @samp{ATTR_LATEX}, keyword + +The LaTeX export back-end processes image links in Org files that do +not have descriptions, such as these links =[[file:img.jpg]]= or +=[[./img.jpg]]=, as direct image insertions in the final PDF output. In +the PDF, they are no longer links but actual images embedded on the +page. The LaTeX export back-end uses =\includegraphics= macro to +insert the image. But for TikZ (http://sourceforge.net/projects/pgf/) +images, the back-end uses an ~\input~ macro wrapped within +a ~tikzpicture~ environment. + +For specifying image =:width=, =:height=, =:scale= and other =:options=, +use this syntax: + +#+begin_example +,#+ATTR_LATEX: :width 5cm :options angle=90 +[[./img/sed-hr4049.pdf]] +#+end_example + +A =:scale= attribute overrides both =:width= and =:height= attributes. + +For custom commands for captions, use the =:caption= attribute. It +overrides the default =#+CAPTION= value: + +#+begin_example +,#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB} +[[./img/sed-hr4049.pdf]] +#+end_example + +When captions follow the method as described in [[*Captions]], the LaTeX +export back-end wraps the picture in a floating =figure= environment. +To float an image without specifying a caption, set the =:float= +attribute to one of the following: + +- =t= :: + + For a standard =figure= environment; used by default whenever an + image has a caption. + +- =multicolumn= :: + + To span the image across multiple columns of a page; the back-end + wraps the image in a =figure*= environment. + +- =wrap= :: + + For text to flow around the image on the right; the figure occupies + the left half of the page. + +- =sideways= :: + + For a new page with the image sideways, rotated ninety degrees, in + a =sidewaysfigure= environment; overrides =:placement= setting. + +- =nil= :: + + To avoid a =:float= even if using a caption. + +Use the =placement= attribute to modify a floating environment's +placement. + +#+begin_example +,#+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement {r}{0.4\textwidth} +[[./img/hst.png]] +#+end_example + +#+vindex: org-latex-images-centered +#+cindex: center image in LaTeX export +#+cindex: image, centering in LaTeX export +The LaTeX export back-end centers all images by default. Setting +=:center= to =nil= disables centering. To disable centering globally, +set ~org-latex-images-centered~ to =t=. + +Set the =:comment-include= attribute to non-~nil~ value for the LaTeX +export back-end to comment out the =\includegraphics= macro. + +*** Plain lists in LaTeX export +:PROPERTIES: +:DESCRIPTION: Attributes specific to lists. +:END: + +#+cindex: plain lists, in @LaTeX{} export +#+cindex: @samp{ATTR_LATEX}, keyword +The LaTeX export back-end accepts the =environment= and =options= +attributes for plain lists. Both attributes work together for +customizing lists, as shown in the examples: + +#+begin_example +,#+LATEX_HEADER: \usepackage[inline]{enumitem} +Some ways to say "Hello": +,#+ATTR_LATEX: :environment itemize* +,#+ATTR_LATEX: :options [label={}, itemjoin={,}, itemjoin*={, and}] +- Hola +- Bonjour +- Guten Tag. +#+end_example + +Since LaTeX supports only four levels of nesting for lists, use an +external package, such as =enumitem= in LaTeX, for levels deeper than +four: + +#+begin_example +,#+LATEX_HEADER: \usepackage{enumitem} +,#+LATEX_HEADER: \renewlist{itemize}{itemize}{9} +,#+LATEX_HEADER: \setlist[itemize]{label=$\circ$} +- One + - Two + - Three + - Four + - Five +#+end_example + +*** Source blocks in LaTeX export +:PROPERTIES: +:DESCRIPTION: Attributes specific to source code blocks. +:END: +#+cindex: source blocks, in @LaTeX{} export +#+cindex: @samp{ATTR_LATEX}, keyword + +The LaTeX export back-end can make source code blocks into floating +objects through the attributes =:float= and =:options=. For =:float=: + +- =t= :: + + Makes a source block float; by default floats any source block with + a caption. + +- =multicolumn= :: + + Spans the source block across multiple columns of a page. + +- =nil= :: + + Avoids a =:float= even if using a caption; useful for source code + blocks that may not fit on a page. + +#+begin_example +,#+ATTR_LATEX: :float nil +,#+BEGIN_SRC emacs-lisp + Lisp code that may not fit in a single page. +,#+END_SRC +#+end_example + +#+vindex: org-latex-listings-options +#+vindex: org-latex-minted-options +The LaTeX export back-end passes string values in =:options= to LaTeX +packages for customization of that specific source block. In the +example below, the =:options= are set for Minted. Minted is a source +code highlighting LaTeX package with many configurable options. + +#+begin_example +,#+ATTR_LATEX: :options commentstyle=\bfseries +,#+BEGIN_SRC emacs-lisp + (defun Fib (n) + (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2))))) +,#+END_SRC +#+end_example + +To apply similar configuration options for all source blocks in +a file, use the ~org-latex-listings-options~ and +~org-latex-minted-options~ variables. + +*** Example blocks in LaTeX export +:PROPERTIES: +:DESCRIPTION: Attributes specific to example blocks. +:END: +#+cindex: example blocks, in @LaTeX{} export +#+cindex: verbatim blocks, in @LaTeX{} export +#+cindex: @samp{ATTR_LATEX}, keyword + +The LaTeX export back-end wraps the contents of example blocks in +a =verbatim= environment. To change this behavior to use another +environment globally, specify an appropriate export filter (see +[[*Advanced Export Configuration]]). To change this behavior to use +another environment for each block, use the =:environment= parameter +to specify a custom environment. + +#+begin_example +,#+ATTR_LATEX: :environment myverbatim +,#+BEGIN_EXAMPLE + This sentence is false. +,#+END_EXAMPLE +#+end_example + +*** Special blocks in LaTeX export +:PROPERTIES: +:DESCRIPTION: Attributes specific to special blocks. +:END: + +#+cindex: special blocks, in @LaTeX{} export +#+cindex: abstract, in @LaTeX{} export +#+cindex: proof, in @LaTeX{} export +#+cindex: @samp{ATTR_LATEX}, keyword + +For other special blocks in the Org file, the LaTeX export back-end +makes a special environment of the same name. The back-end also takes +=:options=, if any, and appends as-is to that environment's opening +string. For example: + +#+begin_example +,#+BEGIN_abstract + We demonstrate how to solve the Syracuse problem. +,#+END_abstract + +,#+ATTR_LATEX: :options [Proof of important theorem] +,#+BEGIN_proof + ... + Therefore, any even number greater than 2 is the sum of two primes. +,#+END_proof +#+end_example + +#+texinfo: @noindent +exports to + +#+begin_example +\begin{abstract} + We demonstrate how to solve the Syracuse problem. +\end{abstract} + +\begin{proof}[Proof of important theorem] + ... + Therefore, any even number greater than 2 is the sum of two primes. +\end{proof} +#+end_example + +If you need to insert a specific caption command, use =:caption= +attribute. It overrides standard =CAPTION= value, if any. For +example: + +#+begin_example +,#+ATTR_LATEX: :caption \MyCaption{HeadingA} +,#+BEGIN_proof + ... +,#+END_proof +#+end_example + +*** Horizontal rules in LaTeX export +:PROPERTIES: +:DESCRIPTION: Attributes specific to horizontal rules. +:END: +#+cindex: horizontal rules, in @LaTeX{} export +#+cindex: @samp{ATTR_LATEX}, keyword + +The LaTeX export back-end converts horizontal rules by the specified +=:width= and =:thickness= attributes. For example: + +#+begin_example +,#+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt +----- +#+end_example + +** Markdown Export +:PROPERTIES: +:DESCRIPTION: Exporting to Markdown. +:END: +#+cindex: Markdown export + +The Markdown export back-end, "md", converts an Org file to Markdown +format, as defined at http://daringfireball.net/projects/markdown/. + +Since it is built on top of the HTML back-end (see [[*HTML Export]]), it +converts every Org construct not defined in Markdown syntax, such as +tables, to HTML. + +*** Markdown export commands +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c C-e m m)}}} (~org-md-export-to-markdown~) :: + + #+kindex: C-c C-c m m + #+findex: org-md-export-to-markdown + Export to a text file with Markdown syntax. For =myfile.org=, Org + exports to =myfile.md=, overwritten without warning. + +- {{{kbd(C-c C-e m M)}}} (~org-md-export-as-markdown~) :: + + #+kindex: C-c C-c m M + #+findex: org-md-export-as-markdown + Export to a temporary buffer. Does not create a file. + +- {{{kbd(C-c C-e m o)}}} :: + + #+kindex: C-c C-e m o + Export as a text file with Markdown syntax, then open it. + +*** Header and sectioning structure +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+vindex: org-md-headline-style +Based on ~org-md-headline-style~, Markdown export can generate +headlines of both /atx/ and /setext/ types. /atx/ limits headline +levels to two whereas /setext/ limits headline levels to six. Beyond +these limits, the export back-end converts headlines to lists. To set +a limit to a level before the absolute limit (see [[*Export Settings]]). + +** OpenDocument Text Export +:PROPERTIES: +:DESCRIPTION: Exporting to OpenDocument Text. +:END: +#+cindex: ODT +#+cindex: OpenDocument +#+cindex: export, OpenDocument +#+cindex: LibreOffice + +The ODT export back-end handles creating of OpenDocument Text (ODT) +format. Documents created by this exporter use the +{{{cite(OpenDocument-v1.2 specification)}}}[fn:134] and are compatible +with LibreOffice 3.4. + +*** Pre-requisites for ODT export +:PROPERTIES: +:DESCRIPTION: Required packages. +:END: +#+cindex: zip + +The ODT export back-end relies on the zip program to create the final +compressed ODT output. Check if =zip= is locally available and +executable. Without it, export cannot finish. + +*** ODT export commands +:PROPERTIES: +:DESCRIPTION: Invoking export. +:END: + +- {{{kbd(C-c C-e o o)}}} (~org-export-to-odt~) :: + + #+kindex: C-c C-e o o + #+findex: org-export-to-odt + Export as OpenDocument Text file. + + #+cindex: @samp{EXPORT_FILE_NAME}, property + #+vindex: org-odt-preferred-output-format + + If ~org-odt-preferred-output-format~ is specified, the ODT export + back-end automatically converts the exported file to that format. + + For =myfile.org=, Org exports to =myfile.odt=, overwriting without + warning. The ODT export back-end exports a region only if a region + was active. + + If the selected region is a single tree, the ODT export back-end + makes the tree head the document title. Incidentally, {{{kbd(C-c + @)}}} selects the current sub-tree. If the tree head entry has, or + inherits, an =EXPORT_FILE_NAME= property, the ODT export back-end + uses that for file name. + +- {{{kbd(C-c C-e o O)}}} :: + + #+kindex: C-c C-e o O + Export as an OpenDocument Text file and open the resulting file. + + #+vindex: org-export-odt-preferred-output-format + If ~org-export-odt-preferred-output-format~ is specified, open the + converted file instead. See [[*Automatically exporting to other + formats]]. + +*** ODT specific export settings +:PROPERTIES: +:DESCRIPTION: Configuration options. +:END: + +The ODT export back-end has several additional keywords for +customizing ODT output. Setting these keywords works similar to the +general options (see [[*Export Settings]]). + +- =DESCRIPTION= :: + + #+cindex: @samp{DESCRIPTION}, keyword + This is the document's description, which the ODT export back-end + inserts as document metadata. For long descriptions, use multiple + lines, prefixed with =DESCRIPTION=. + +- =KEYWORDS= :: + + #+cindex: @samp{KEYWORDS}, keyword + The keywords for the document. The ODT export back-end inserts the + description along with author name, keywords, and related file + metadata as metadata in the output file. Use multiple =KEYWORDS= if + necessary. + +- =ODT_STYLES_FILE= :: + + #+cindex: @samp{ODT_STYLES_FILE}, keyword + #+vindex: org-odt-styles-file + The ODT export back-end uses the ~org-odt-styles-file~ by default. + See [[*Applying custom styles]] for details. + +- =SUBTITLE= :: + + #+cindex: @samp{SUBTITLE}, keyword + The document subtitle. + +*** Extending ODT export +:PROPERTIES: +:DESCRIPTION: Producing DOC, PDF files. +:END: + +The ODT export back-end can produce documents in other formats besides +ODT using a specialized ODT converter process. Its common interface +works with popular converters to produce formats such as =doc=, or +convert a document from one format, say =csv=, to another format, say +=xls=. + +#+cindex: @file{unoconv} +#+vindex: org-odt-convert-process +Customize ~org-odt-convert-process~ variable to point to =unoconv=, +which is the ODT's preferred converter. Working installations of +LibreOffice would already have =unoconv= installed. Alternatively, +other converters may be substituted here. See [[*Configuring +a document converter]]. + +**** Automatically exporting to other formats +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+vindex: org-odt-preferred-output-format +If ODT format is just an intermediate step to get to other formats, +such as =doc=, =docx=, =rtf=, or =pdf=, etc., then extend the ODT +export back-end to directly produce that format. Specify the final +format in the ~org-odt-preferred-output-format~ variable. This is one +way to extend (see [[*ODT export commands]]). + +**** Converting between document formats +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +The Org export back-end is made to be inter-operable with a wide range +of text document format converters. Newer generation converters, such +as LibreOffice and Pandoc, can handle hundreds of formats at once. +Org provides a consistent interaction with whatever converter is +installed. Here are some generic commands: + +- {{{kbd(M-x org-odt-convert)}}} :: + + #+findex: org-odt-convert + Convert an existing document from one format to another. With + a prefix argument, opens the newly produced file. + +*** Applying custom styles +:PROPERTIES: +:DESCRIPTION: Styling the output. +:END: +#+cindex: styles, custom +#+cindex: template, custom + +The ODT export back-end comes with many OpenDocument styles (see +[[*Working with OpenDocument style files]]). To expand or further +customize these built-in style sheets, either edit the style sheets +directly or generate them using an application such as LibreOffice. +The example here shows creating a style using LibreOffice. + +**** Applying custom styles: the easy way +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +1. Create a sample =example.org= file with settings as shown below, + and export it to ODT format. + + : #+OPTIONS: H:10 num:t + +2. Open the above =example.odt= using LibreOffice. Use the /Stylist/ + to locate the target styles, which typically have the "Org" prefix. + Open one, modify, and save as either OpenDocument Text (ODT) or + OpenDocument Template (OTT) file. + +3. + #+vindex: org-odt-styles-file + Customize the variable ~org-odt-styles-file~ and point it to the + newly created file. For additional configuration options, see + [[x-overriding-factory-styles][Overriding factory styles]]. + + #+cindex: @samp{ODT_STYLES_FILE}, keyword + To apply an ODT style to a particular file, use the + =ODT_STYLES_FILE= keyword as shown in the example below: + + : #+ODT_STYLES_FILE: "/path/to/example.ott" + + #+texinfo: @noindent + or + + : #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png")) + +**** Using third-party styles and templates +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +The ODT export back-end relies on many templates and style names. +Using third-party styles and templates can lead to mismatches. +Templates derived from built in ODT templates and styles seem to have +fewer problems. + +*** Links in ODT export +:PROPERTIES: +:DESCRIPTION: Handling and formatting links. +:END: +#+cindex: links, in ODT export + +ODT exporter creates native cross-references for internal links. It +creates Internet-style links for all other links. + +A link with no description and pointing to a regular, un-itemized, +outline heading is replaced with a cross-reference and section number +of the heading. + +A =\ref{label}=-style reference to an image, table etc., is replaced +with a cross-reference and sequence number of the labeled entity. See +[[*Labels and captions in ODT export]]. + +*** Tables in ODT export +:PROPERTIES: +:DESCRIPTION: Org tables conversions. +:END: + +#+cindex: tables, in ODT export + +The ODT export back-end handles native Org mode tables (see [[*Tables]]) +and simple =table.el= tables. Complex =table.el= tables having column +or row spans are not supported. Such tables are stripped from the +exported document. + +By default, the ODT export back-end exports a table with top and +bottom frames and with ruled lines separating row and column groups +(see [[*Column Groups]]). All tables are typeset to occupy the same +width. The ODT export back-end honors any table alignments and +relative widths for columns (see [[*Column Width and Alignment]]). + +Note that the ODT export back-end interprets column widths as weighted +ratios, the default weight being 1. + +#+cindex: @samp{ATTR_ODT}, keyword +Specifying =:rel-width= property on an =ATTR_ODT= line controls the +width of the table. For example: + +#+begin_example +,#+ATTR_ODT: :rel-width 50 +| Area/Month | Jan | Feb | Mar | Sum | +|---------------+-------+-------+-------+-------| +| / | < | | | < | +| <l13> | <r5> | <r5> | <r5> | <r6> | +| North America | 1 | 21 | 926 | 948 | +| Middle East | 6 | 75 | 844 | 925 | +| Asia Pacific | 9 | 27 | 790 | 826 | +|---------------+-------+-------+-------+-------| +| Sum | 16 | 123 | 2560 | 2699 | +#+end_example + +On export, the above table takes 50% of text width area. The exporter +sizes the columns in the ratio: 13:5:5:5:6. The first column is +left-aligned and rest of the columns, right-aligned. Vertical rules +separate the header and the last column. Horizontal rules separate +the header and the last row. + +For even more customization, create custom table styles and associate +them with a table using the =ATTR_ODT= keyword. See [[*Customizing +tables in ODT export]]. + +*** Images in ODT export +:PROPERTIES: +:DESCRIPTION: Inserting images. +:END: +#+cindex: images, embedding in ODT +#+cindex: embedding images in ODT + +**** Embedding images +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +The ODT export back-end processes image links in Org files that do not +have descriptions, such as these links =[[file:img.jpg]]= or =[[./img.jpg]]=, +as direct image insertions in the final output. Either of these +examples works: + +: [[file:img.png]] + +: [[./img.png]] + +**** Embedding clickable images +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +For clickable images, provide a link whose description is another link +to an image file. For example, to embed an image +=org-mode-unicorn.png= which when clicked jumps to https://orgmode.org +website, do the following + +: [[https://orgmode.org][./org-mode-unicorn.png]] + +**** Sizing and scaling of embedded images +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{ATTR_ODT}, keyword + +Control the size and scale of the embedded images with the =ATTR_ODT= +attribute. + +#+cindex: identify, ImageMagick +#+vindex: org-odt-pixels-per-inch +The ODT export back-end starts with establishing the size of the image +in the final document. The dimensions of this size are measured in +centimeters. The back-end then queries the image file for its +dimensions measured in pixels. For this measurement, the back-end +relies on ImageMagick's identify program or Emacs ~create-image~ and +~image-size~ API. ImageMagick is the preferred choice for large file +sizes or frequent batch operations. The back-end then converts the +pixel dimensions using ~org-odt-pixels-per-inch~ into the familiar 72 +dpi or 96 dpi. The default value for this is in +~display-pixels-per-inch~, which can be tweaked for better results +based on the capabilities of the output device. Here are some common +image scaling operations: + +- Explicitly size the image :: + + To embed =img.png= as a 10 cm x 10 cm image, do the following: + + #+begin_example + ,#+ATTR_ODT: :width 10 :height 10 + [[./img.png]] + #+end_example + +- Scale the image :: + + To embed =img.png= at half its size, do the following: + + #+begin_example + ,#+ATTR_ODT: :scale 0.5 + [[./img.png]] + #+end_example + +- Scale the image to a specific width :: + + To embed =img.png= with a width of 10 cm while retaining the + original height:width ratio, do the following: + + #+begin_example + ,#+ATTR_ODT: :width 10 + [[./img.png]] + #+end_example + +- Scale the image to a specific height :: + + To embed =img.png= with a height of 10 cm while retaining the + original height:width ratio, do the following: + + #+begin_example + ,#+ATTR_ODT: :height 10 + [[./img.png]] + #+end_example + +**** Anchoring of images +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{ATTR_ODT}, keyword +The ODT export back-end can anchor images to =as-char=, =paragraph=, +or =page=. Set the preferred anchor using the =:anchor= property of +the =ATTR_ODT= line. + +To create an image that is anchored to a page: + +#+begin_example +,#+ATTR_ODT: :anchor page +[[./img.png]] +#+end_example + +*** Math formatting in ODT export +:PROPERTIES: +:DESCRIPTION: Formatting @LaTeX{} fragments. +:END: + +The ODT exporter has special support for handling math. + +**** LaTeX math snippets +:PROPERTIES: +:DESCRIPTION: Embedding in @LaTeX{} format. +:END: + +LaTeX math snippets (see [[*LaTeX fragments]]) can be embedded in the ODT +document in one of the following ways: + +- MathML :: + + #+cindex: MathML + Add this line to the Org file. This option is activated on + a per-file basis. + + : #+OPTIONS: tex:t + + With this option, LaTeX fragments are first converted into MathML + fragments using an external LaTeX-to-MathML converter program. The + resulting MathML fragments are then embedded as an OpenDocument + Formula in the exported document. + + #+vindex: org-latex-to-mathml-convert-command + #+vindex: org-latex-to-mathml-jar-file + You can specify the LaTeX-to-MathML converter by customizing the + variables ~org-latex-to-mathml-convert-command~ and + ~org-latex-to-mathml-jar-file~. + + If you prefer to use MathToWeb[fn:135] as your converter, you can + configure the above variables as shown below. + + #+begin_src emacs-lisp + (setq org-latex-to-mathml-convert-command + "java -jar %j -unicode -force -df %o %I" + org-latex-to-mathml-jar-file + "/path/to/mathtoweb.jar") + #+end_src + + #+texinfo: @noindent + or, to use LaTeXML[fn:136] instead, + + #+begin_src emacs-lisp + (setq org-latex-to-mathml-convert-command + "latexmlmath \"%i\" --presentationmathml=%o") + #+end_src + + To quickly verify the reliability of the LaTeX-to-MathML + converter, use the following commands: + + - {{{kbd(M-x org-export-as-odf)}}} :: + + Convert a LaTeX math snippet to an OpenDocument formula (=.odf=) + file. + + - {{{kbd(M-x org-export-as-odf-and-open)}}} :: + + Convert a LaTeX math snippet to an OpenDocument formula (=.odf=) + file and open the formula file with the system-registered + application. + +- PNG images :: + + #+cindex: dvipng + #+cindex: dvisvgm + #+cindex: ImageMagick + Add this line to the Org file. This option is activated on + a per-file basis. + + : #+OPTIONS: tex:dvipng + + : #+OPTIONS: tex:dvisvgm + + #+texinfo: @noindent + or + + : #+OPTIONS: tex:imagemagick + + Under this option, LaTeX fragments are processed into PNG or SVG + images and the resulting images are embedded in the exported + document. This method requires dvipng program, dvisvgm or + ImageMagick programs. + +**** MathML and OpenDocument formula files +:PROPERTIES: +:DESCRIPTION: Embedding in native format. +:END: + +When embedding LaTeX math snippets in ODT documents is not reliable, +there is one more option to try. Embed an equation by linking to its +MathML (=.mml=) source or its OpenDocument formula (=.odf=) file as +shown below: + +: [[./equation.mml]] + +#+texinfo: @noindent +or + +: [[./equation.odf]] + +*** Labels and captions in ODT export +:PROPERTIES: +:DESCRIPTION: Rendering objects. +:END: + +ODT format handles labeling and captioning of objects based on their +types. Inline images, tables, LaTeX fragments, and Math formulas are +numbered and captioned separately. Each object also gets a unique +sequence number based on its order of first appearance in the Org +file. Each category has its own sequence. A caption is just a label +applied to these objects. + +#+begin_example +,#+CAPTION: Bell curve +,#+NAME: fig:SED-HR4049 +[[./img/a.png]] +#+end_example + +When rendered, it may show as follows in the exported document: + +: Figure 2: Bell curve + +#+vindex: org-odt-category-map-alist +To modify the category component of the caption, customize the option +~org-odt-category-map-alist~. For example, to tag embedded images +with the string "Illustration" instead of the default string "Figure", +use the following setting: + +#+begin_src emacs-lisp +(setq org-odt-category-map-alist + '(("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p))) +#+end_src + +With the above modification, the previous example changes to: + +: Illustration 2: Bell curve + +*** Literal examples in ODT export +:PROPERTIES: +:DESCRIPTION: For source code and example blocks. +:END: + +The ODT export back-end supports literal examples (see [[*Literal +Examples]]) with full fontification. Internally, the ODT export +back-end relies on =htmlfontify.el= to generate the style definitions +needed for fancy listings. The auto-generated styles get =OrgSrc= +prefix and inherit colors from the faces used by Emacs Font Lock +library for that source language. + +#+vindex: org-odt-fontify-srcblocks +For custom fontification styles, customize the +~org-odt-create-custom-styles-for-srcblocks~ option. + +#+vindex: org-odt-create-custom-styles-for-srcblocks +To turn off fontification of literal examples, customize the +~org-odt-fontify-srcblocks~ option. + +*** Advanced topics in ODT export +:PROPERTIES: +:DESCRIPTION: For power users. +:END: + +The ODT export back-end has extensive features useful for power users +and frequent uses of ODT formats. + +**** Configuring a document converter +:PROPERTIES: +:DESCRIPTION: Registering a document converter. +:UNNUMBERED: notoc +:END: +#+cindex: convert +#+cindex: doc, docx, rtf +#+cindex: converter + +The ODT export back-end works with popular converters with little or +no extra configuration. See [[*Extending ODT export]]. The following is +for unsupported converters or tweaking existing defaults. + +- Register the converter :: + + #+vindex: org-export-odt-convert-processes + Add the name of the converter to the ~org-odt-convert-processes~ + variable. Note that it also requires how the converter is invoked + on the command line. See the variable's docstring for details. + +- Configure its capabilities :: + + #+vindex: org-export-odt-convert-capabilities + Specify which formats the converter can handle by customizing the + variable ~org-odt-convert-capabilities~. Use the entry for the + default values in this variable for configuring the new converter. + Also see its docstring for details. + +- Choose the converter :: + + #+vindex: org-export-odt-convert-process + Select the newly added converter as the preferred one by customizing + the option ~org-odt-convert-process~. + +**** Working with OpenDocument style files +:PROPERTIES: +:DESCRIPTION: Exploring internals. +:UNNUMBERED: notoc +:END: +#+cindex: styles, custom +#+cindex: template, custom + +This section explores the internals of the ODT exporter; the means by which +it produces styled documents; the use of automatic and custom OpenDocument +styles. + +The ODT exporter relies on two files for generating its output. These +files are bundled with the distribution under the directory pointed to +by the variable ~org-odt-styles-dir~. The two files are: + +- =OrgOdtStyles.xml= <<x-orgodtstyles-xml>> :: + + This file contributes to the =styles.xml= file of the final ODT + document. This file gets modified for the following purposes: + + 1. To control outline numbering based on user settings; + + 2. To add styles generated by =htmlfontify.el= for fontification of + code blocks. + +- =OrgOdtContentTemplate.xml= <<x-orgodtcontenttemplate-xml>> :: + + This file contributes to the =content.xml= file of the final ODT + document. The contents of the Org outline are inserted between the + =<office:text>= ... =</office:text>= elements of this file. + + Apart from serving as a template file for the final =content.xml=, + the file serves the following purposes: + + 1. It contains automatic styles for formatting of tables which are + referenced by the exporter; + + 2. It contains =<text:sequence-decl>= ... =</text:sequence-decl>= + elements that control numbering of tables, images, equations, and + similar entities. + +<<x-overriding-factory-styles>> The following two variables control +the location from where the ODT exporter picks up the custom styles +and content template files. Customize these variables to override the +factory styles used by the exporter. + +- ~org-odt-styles-file~ :: + + The ODT export back-end uses the file pointed to by this variable, + such as =styles.xml=, for the final output. It can take one of the + following values: + + - =FILE.xml= :: + + Use this file instead of the default =styles.xml= + + - =FILE.odt= or =FILE.ott= :: + + Use the =styles.xml= contained in the specified OpenDocument + Text or Template file + + - =FILE.odt= or =FILE.ott= and a subset of included files :: + + Use the =styles.xml= contained in the specified OpenDocument Text + or Template file. Additionally extract the specified member files + and embed those within the final ODT document. + + Use this option if the =styles.xml= file references additional + files like header and footer images. + + - ~nil~ :: + + Use the default =styles.xml=. + +- ~org-odt-content-template-file~ :: + + Use this variable to specify the blank =content.xml= used in the + final output. + +**** Creating one-off styles +:PROPERTIES: +:DESCRIPTION: Customizing styles, highlighting... +:UNNUMBERED: notoc +:END: + +The ODT export back-end can read embedded raw OpenDocument XML from +the Org file. Such direct formatting is useful for one-off instances. + +- Embedding ODT tags as part of regular text :: + + Enclose OpenDocument syntax in =@@odt:...@@= for inline markup. For + example, to highlight a region of text do the following: + + #+begin_example + @@odt:<text:span text:style-name="Highlight">This is highlighted + text</text:span>@@. But this is regular text. + #+end_example + + *Hint:* To see the above example in action, edit the =styles.xml= + (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom /Highlight/ style as shown + below: + + #+begin_example + <style:style style:name="Highlight" style:family="text"> + <style:text-properties fo:background-color="#ff0000"/> + </style:style> + #+end_example + +- Embedding a one-line OpenDocument XML :: + + #+cindex: @samp{ODT}, keyword + The ODT export back-end can read one-liner options with =#+ODT:= in + the Org file. For example, to force a page break: + + #+begin_example + ,#+ODT: <text:p text:style-name="PageBreak"/> + #+end_example + + *Hint:* To see the above example in action, edit your + =styles.xml= (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom =PageBreak= + style as shown below. + + #+begin_example + <style:style style:name="PageBreak" style:family="paragraph" + style:parent-style-name="Text_20_body"> + <style:paragraph-properties fo:break-before="page"/> + </style:style> + #+end_example + +- Embedding a block of OpenDocument XML :: + + The ODT export back-end can also read ODT export blocks for + OpenDocument XML. Such blocks use the =#+BEGIN_EXPORT odt= + ... =#+END_EXPORT= constructs. + + For example, to create a one-off paragraph that uses bold text, do + the following: + + #+begin_example + ,#+BEGIN_EXPORT odt + <text:p text:style-name="Text_20_body_20_bold"> + This paragraph is specially formatted and uses bold text. + </text:p> + ,#+END_EXPORT + #+end_example + +**** Customizing tables in ODT export +:PROPERTIES: +:DESCRIPTION: Defining table templates. +:UNNUMBERED: notoc +:END: +#+cindex: tables, in ODT export +#+cindex: @samp{ATTR_ODT}, keyword + +Override the default table format by specifying a custom table style +with the =#+ATTR_ODT= line. For a discussion on default formatting of +tables, see [[*Tables in ODT export]]. + +This feature closely mimics the way table templates are defined in the +OpenDocument-v1.2 specification[fn:137]. + +#+vindex: org-odt-table-styles +For quick preview of this feature, install the settings below and export the +table that follows: + +#+begin_src emacs-lisp +(setq org-export-odt-table-styles + (append org-export-odt-table-styles + '(("TableWithHeaderRowAndColumn" "Custom" + ((use-first-row-styles . t) + (use-first-column-styles . t))) + ("TableWithFirstRowandLastRow" "Custom" + ((use-first-row-styles . t) + (use-last-row-styles . t)))))) +#+end_src + +#+begin_example +,#+ATTR_ODT: :style TableWithHeaderRowAndColumn +| Name | Phone | Age | +| Peter | 1234 | 17 | +| Anna | 4321 | 25 | +#+end_example + +The example above used =Custom= template and installed two table +styles =TableWithHeaderRowAndColumn= and +=TableWithFirstRowandLastRow=. *Important:* The OpenDocument styles +needed for producing the above template were pre-defined. They are +available in the section marked =Custom Table Template= in +=OrgOdtContentTemplate.xml= (see [[x-orgodtcontenttemplate-xml][Factory styles]]). For adding new +templates, define new styles there. + +To use this feature proceed as follows: + +1. Create a table template[fn:138]. + + A table template is set of =table-cell= and =paragraph= styles for + each of the following table cell categories: + + - Body + - First column + - Last column + - First row + - Last row + - Even row + - Odd row + - Even column + - Odd Column + + The names for the above styles must be chosen based on the name of + the table template using a well-defined convention. + + The naming convention is better illustrated with an example. For + a table template with the name =Custom=, the needed style names are + listed in the following table. + + | Cell type | Cell style | Paragraph style | + |--------------+------------------------------+-----------------------------------| + | Body | =CustomTableCell= | =CustomTableParagraph= | + | First column | =CustomFirstColumnTableCell= | =CustomFirstColumnTableParagraph= | + | Last column | =CustomLastColumnTableCell= | =CustomLastColumnTableParagraph= | + | First row | =CustomFirstRowTableCell= | =CustomFirstRowTableParagraph= | + | Last row | =CustomLastRowTableCell= | =CustomLastRowTableParagraph= | + | Even row | =CustomEvenRowTableCell= | =CustomEvenRowTableParagraph= | + | Odd row | =CustomOddRowTableCell= | =CustomOddRowTableParagraph= | + | Even column | =CustomEvenColumnTableCell= | =CustomEvenColumnTableParagraph= | + | Odd column | =CustomOddColumnTableCell= | =CustomOddColumnTableParagraph= | + + To create a table template with the name =Custom=, define the above + styles in the =<office:automatic-styles>= ... + =</office:automatic-styles>= element of the content template file + (see [[x-orgodtcontenttemplate-xml][Factory styles]]). + +2. Define a table style[fn:139]. + + #+vindex: org-odt-table-styles + To define a table style, create an entry for the style in the + variable ~org-odt-table-styles~ and specify the following: + + - the name of the table template created in step (1), + - the set of cell styles in that template that are to be activated. + + For example, the entry below defines two different table styles + =TableWithHeaderRowAndColumn= and =TableWithFirstRowandLastRow= + based on the same template =Custom=. The styles achieve their + intended effect by selectively activating the individual cell + styles in that template. + + #+begin_src emacs-lisp + (setq org-export-odt-table-styles + (append org-export-odt-table-styles + '(("TableWithHeaderRowAndColumn" "Custom" + ((use-first-row-styles . t) + (use-first-column-styles . t))) + ("TableWithFirstRowandLastRow" "Custom" + ((use-first-row-styles . t) + (use-last-row-styles . t)))))) + #+end_src + +3. Associate a table with the table style. + + To do this, specify the table style created in step (2) as part of + the =ATTR_ODT= line as shown below. + + #+begin_example + ,#+ATTR_ODT: :style TableWithHeaderRowAndColumn + | Name | Phone | Age | + | Peter | 1234 | 17 | + | Anna | 4321 | 25 | + #+end_example + +**** Validating OpenDocument XML +:PROPERTIES: +:DESCRIPTION: Debugging corrupted OpenDocument files. +:UNNUMBERED: notoc +:END: + +Sometimes ODT format files may not open due to =.odt= file corruption. +To verify if such a file is corrupt, validate it against the +OpenDocument Relax NG Compact (RNC) syntax schema. But first the +=.odt= files have to be decompressed using =zip=. Note that =.odt= +files are ZIP archives: [[info:emacs::File Archives]]. The contents of +ODT files are in XML. For general help with validation---and +schema-sensitive editing---of XML files: [[info:nxml-mode::Introduction]]. + +#+vindex: org-export-odt-schema-dir +Customize ~org-odt-schema-dir~ to point to a directory with +OpenDocument RNC files and the needed schema-locating rules. The ODT +export back-end takes care of updating the +~rng-schema-locating-files~. + +** Org Export +:PROPERTIES: +:DESCRIPTION: Exporting to Org. +:END: + +#+cindex: Org export +/org/ export back-end creates a normalized version of the Org document +in current buffer. The exporter evaluates Babel code (see [[*Evaluating +Code Blocks]]) and removes content specific to other back-ends. + +*** Org export commands +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- {{{kbd(C-c C-e O o)}}} (~org-org-export-to-org~) :: + + #+kindex: C-c C-e O o + #+findex: org-org-export-to-org + Export as an Org file with a =.org= extension. For =myfile.org=, + Org exports to =myfile.org.org=, overwriting without warning. + +- {{{kbd(C-c C-e O v)}}} (~~) :: + + #+kindex: C-c C-e O v + Export to an Org file, then open it. + +** Texinfo Export +:PROPERTIES: +:DESCRIPTION: Exporting to Texinfo. +:END: + +*** Texinfo export commands +:PROPERTIES: +:DESCRIPTION: Invoking commands. +:END: + +- {{{kbd(C-c C-e i t)}}} (~org-texinfo-export-to-texinfo~) :: + + #+kindex: C-c C-e i t + #+findex: org-texinfo-export-to-texinfo + Export as a Texinfo file with =.texi= extension. For =myfile.org=, + Org exports to =myfile.texi=, overwriting without warning. + +- {{{kbd(C-c C-e i i)}}} (~org-texinfo-export-to-info~) :: + + #+kindex: C-c C-e i i + #+findex: org-texinfo-export-to-info + #+vindex: org-texinfo-info-process + Export to Texinfo format first and then process it to make an Info + file. To generate other formats, such as DocBook, customize the + ~org-texinfo-info-process~ variable. + +*** Texinfo specific export settings +:PROPERTIES: +:DESCRIPTION: Setting the environment. +:END: + +The Texinfo export back-end has several additional keywords for +customizing Texinfo output. Setting these keywords works similar to +the general options (see [[*Export Settings]]). + +- =SUBTITLE= :: + + #+cindex: @samp{SUBTITLE}, keyword + The document subtitle. + +- =SUBAUTHOR= :: + + #+cindex: @samp{SUBAUTHOR}, keyword + Additional authors for the document. + +- =TEXINFO_FILENAME= :: + + #+cindex: @samp{TEXINFO_FILENAME}, keyword + The Texinfo filename. + +- =TEXINFO_CLASS= :: + + #+cindex: @samp{TEXINFO_CLASS}, keyword + #+vindex: org-texinfo-default-class + The default document class (~org-texinfo-default-class~), which must + be a member of ~org-texinfo-classes~. + +- =TEXINFO_HEADER= :: + + #+cindex: @samp{TEXINFO_HEADER}, keyword + Arbitrary lines inserted at the end of the header. + +- =TEXINFO_POST_HEADER= :: + + #+cindex: @samp{TEXINFO_POST_HEADER}, keyword + Arbitrary lines inserted after the end of the header. + +- =TEXINFO_DIR_CATEGORY= :: + + #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword + The directory category of the document. + +- =TEXINFO_DIR_TITLE= :: + + #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword + The directory title of the document. + +- =TEXINFO_DIR_DESC= :: + + #+cindex: @samp{TEXINFO_DIR_DESC}, keyword + The directory description of the document. + +- =TEXINFO_PRINTED_TITLE= :: + + #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword + The printed title of the document. + +*** Texinfo file header +:PROPERTIES: +:DESCRIPTION: Generating the header. +:END: + +#+cindex: @samp{TEXINFO_FILENAME}, keyword +After creating the header for a Texinfo file, the Texinfo back-end +automatically generates a name and destination path for the Info file. +To override this default with a more sensible path and name, specify +the =TEXINFO_FILENAME= keyword. + +#+vindex: org-texinfo-coding-system +#+cindex: @samp{TEXINFO_HEADER}, keyword +Along with the output's file name, the Texinfo header also contains +language details (see [[*Export Settings]]) and encoding system as set in +the ~org-texinfo-coding-system~ variable. Insert =TEXINFO_HEADER= +keywords for each additional command in the header, for example: + +: #+TEXINFO_HEADER: @synindex + +#+cindex: @samp{TEXINFO_CLASS}, keyword +#+vindex: org-texinfo-classes +Instead of repeatedly installing the same set of commands, define +a class in ~org-texinfo-classes~ once, and then activate it in the +document by setting the =TEXINFO_CLASS= keyword to that class. + +*** Texinfo title and copyright page +:PROPERTIES: +:DESCRIPTION: Creating preamble pages. +:END: + +#+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword +The default template for hard copy output has a title page with +=TITLE= and =AUTHOR= keywords (see [[*Export Settings]]). To replace the +regular title with something different for the printed version, use +the =TEXINFO_PRINTED_TITLE= and =SUBTITLE= keywords. Both expect raw +Texinfo code for setting their values. + +#+cindex: @samp{SUBAUTHOR}, keyword +If one =AUTHOR= line is not sufficient, add multiple =SUBAUTHOR= +keywords. They have to be set in raw Texinfo code. + +#+begin_example +,#+AUTHOR: Jane Smith +,#+SUBAUTHOR: John Doe +,#+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt{tex,@*} Is Broken in @TeX{} +#+end_example + +#+cindex: @samp{COPYING}, property +Copying material is defined in a dedicated headline with a non-~nil~ +=COPYING= property. The back-end inserts the contents within +a =@copying= command at the beginning of the document. The heading +itself does not appear in the structure of the document. + +Copyright information is printed on the back of the title page. + +#+begin_example +,* Legalese + :PROPERTIES: + :COPYING: t + :END: + + This is a short example of a complete Texinfo file, version 1.0. + + Copyright \copy 2016 Free Software Foundation, Inc. +#+end_example + +*** Info directory file +:PROPERTIES: +:DESCRIPTION: Installing a manual in Info file hierarchy. +:END: + +#+cindex: @samp{dir} file, in Texinfo export +#+cindex: Info directory file, in Texinfo export +#+cindex: @code{install-info}, in Texinfo export + +#+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword +#+cindex: @samp{TEXINFO_DIR_TITLE}, keyword +#+cindex: @samp{TEXINFO_DIR_DESC}, keyword +The end result of the Texinfo export process is the creation of an +Info file. This Info file's metadata has variables for category, +title, and description: =TEXINFO_DIR_CATEGORY=, =TEXINFO_DIR_TITLE=, +and =TEXINFO_DIR_DESC= keywords that establish where in the Info +hierarchy the file fits. + +Here is an example that writes to the Info directory file: + +#+begin_example +,#+TEXINFO_DIR_CATEGORY: Emacs +,#+TEXINFO_DIR_TITLE: Org Mode: (org) +,#+TEXINFO_DIR_DESC: Outline-based notes management and organizer +#+end_example + +*** Headings and sectioning structure +:PROPERTIES: +:DESCRIPTION: Building document structure. +:END: + +#+vindex: org-texinfo-classes +#+vindex: org-texinfo-default-class +#+cindex: @samp{TEXINFO_CLASS}, keyword +The Texinfo export back-end uses a pre-defined scheme to convert Org +headlines to equivalent Texinfo structuring commands. A scheme like +this maps top-level headlines to numbered chapters tagged as +~@chapter~ and lower-level headlines to unnumbered chapters tagged as +~@unnumbered~. To override such mappings to introduce ~@part~ or +other Texinfo structuring commands, define a new class in +~org-texinfo-classes~. Activate the new class with the +=TEXINFO_CLASS= keyword. When no new class is defined and activated, +the Texinfo export back-end defaults to the +~org-texinfo-default-class~. + +If an Org headline's level has no associated Texinfo structuring +command, or is below a certain threshold (see [[*Export Settings]]), then +the Texinfo export back-end makes it into a list item. + +#+cindex: @samp{APPENDIX}, property +The Texinfo export back-end makes any headline with a non-~nil~ +=APPENDIX= property into an appendix. This happens independent of the +Org headline level or the =TEXINFO_CLASS= keyword. + +#+cindex: @samp{ALT_TITLE}, property +#+cindex: @samp{DESCRIPTION}, property +The Texinfo export back-end creates a menu entry after the Org +headline for each regular sectioning structure. To override this with +a shorter menu entry, use the =ALT_TITLE= property (see [[*Table of +Contents]]). Texinfo menu entries also have an option for a longer +=DESCRIPTION= property. Here's an example that uses both to override +the default menu entry: + +#+begin_example +,* Controlling Screen Display + :PROPERTIES: + :ALT_TITLE: Display + :DESCRIPTION: Controlling Screen Display + :END: +#+end_example + +#+cindex: Top node, in Texinfo export +The text before the first headline belongs to the /Top/ node, i.e., +the node in which a reader enters an Info manual. As such, it is +expected not to appear in printed output generated from the =.texi= +file. See [[info:texinfo::The Top Node]], for more information. + +*** Indices +:PROPERTIES: +:DESCRIPTION: Creating indices. +:END: + +#+cindex: @samp{CINDEX}, keyword +#+cindex: concept index, in Texinfo export +#+cindex: @samp{FINDEX}, keyword +#+cindex: function index, in Texinfo export +#+cindex: @samp{KINDEX}, keyword +#+cindex: keystroke index, in Texinfo export +#+cindex: @samp{PINDEX}, keyword +#+cindex: program index, in Texinfo export +#+cindex: @samp{TINDEX}, keyword +#+cindex: data type index, in Texinfo export +#+cindex: @samp{VINDEX}, keyword +#+cindex: variable index, in Texinfo export +The Texinfo export back-end recognizes these indexing keywords if used +in the Org file: =CINDEX=, =FINDEX=, =KINDEX=, =PINDEX=, =TINDEX= and +=VINDEX=. Write their value as verbatim Texinfo code; in particular, +={=, =}= and =@= characters need to be escaped with =@= if they do not +belong to a Texinfo command. + +: #+CINDEX: Defining indexing entries + +#+cindex: @samp{INDEX}, property +For the back-end to generate an index entry for a headline, set the +=INDEX= property to =cp= or =vr=. These abbreviations come from +Texinfo that stand for concept index and variable index. The Texinfo +manual has abbreviations for all other kinds of indexes. The back-end +exports the headline as an unnumbered chapter or section command, and +then inserts the index after its contents. + +#+begin_example +,* Concept Index + :PROPERTIES: + :INDEX: cp + :END: +#+end_example + +*** Quoting Texinfo code +:PROPERTIES: +:DESCRIPTION: Incorporating literal Texinfo code. +:END: + +Use any of the following three methods to insert or escape raw Texinfo +code: + +#+cindex: @samp{TEXINFO}, keyword +#+cindex: @samp{BEGIN_EXPORT texinfo} +#+begin_example +Richard @@texinfo:@sc{@@Stallman@@texinfo:}@@ commence' GNU. + +,#+TEXINFO: @need800 +This paragraph is preceded by... + +,#+BEGIN_EXPORT texinfo + @auindex Johnson, Mark + @auindex Lakoff, George +,#+END_EXPORT +#+end_example + +*** Plain lists in Texinfo export +:PROPERTIES: +:DESCRIPTION: List attributes. +:END: + +#+cindex: @samp{ATTR_TEXINFO}, keyword +#+cindex: two-column tables, in Texinfo export +#+cindex: table-type, Texinfo attribute +The Texinfo export back-end by default converts description lists in +the Org file using the default command =@table=, which results in +a table with two columns. To change this behavior, set =:table-type= +attribute to either =ftable= or =vtable= value. For more information, +see [[info:texinfo::Two-column Tables]]. + +#+vindex: org-texinfo-table-default-markup +#+cindex: indic, Texinfo attribute +The Texinfo export back-end by default also applies a text highlight +based on the defaults stored in ~org-texinfo-table-default-markup~. +To override the default highlight command, specify another one with +the =:indic= attribute. + +#+cindex: multiple items in Texinfo lists +#+cindex: sep, Texinfo attribute +Org syntax is limited to one entry per list item. Nevertheless, the +Texinfo export back-end can split that entry according to any text +provided through the =:sep= attribute. Each part then becomes a new +entry in the first column of the table. + +The following example illustrates all the attributes above: + +#+begin_example +,#+ATTR_TEXINFO: :table-type vtable :sep , :indic asis +- foo, bar :: This is the common text for variables foo and bar. +#+end_example + +#+texinfo: @noindent +becomes + +#+begin_example +@vtable @asis +@item foo +@itemx bar +This is the common text for variables foo and bar. +@end table +#+end_example + +#+cindex: lettered lists, in Texinfo export +#+cindex: enum, Texinfo attribute +Ordered lists are numbered when exported to Texinfo format. Such +numbering obeys any counter (see [[*Plain Lists]]) in the first item of +the list. The =:enum= attribute also let you start the list at +a specific number, or switch to a lettered list, as illustrated here + +#+begin_example +#+ATTR_TEXINFO: :enum A +1. Alpha +2. Bravo +3. Charlie +#+end_example + +*** Tables in Texinfo export +:PROPERTIES: +:DESCRIPTION: Table attributes. +:END: + +#+cindex: @samp{ATTR_TEXINFO}, keyword +When exporting tables, the Texinfo export back-end uses the widest +cell width in each column. To override this and instead specify as +fractions of line length, use the =:columns= attribute. See example +below. + +#+begin_example +,#+ATTR_TEXINFO: :columns .5 .5 +| a cell | another cell | +#+end_example + +*** Images in Texinfo export +:PROPERTIES: +:DESCRIPTION: Image attributes. +:END: + +#+cindex: @samp{ATTR_TEXINFO}, keyword +Insert a file link to the image in the Org file, and the Texinfo +export back-end inserts the image. These links must have the usual +supported image extensions and no descriptions. To scale the image, +use =:width= and =:height= attributes. For alternate text, use =:alt= +and specify the text using Texinfo code, as shown in the example: + +#+begin_example +,#+ATTR_TEXINFO: :width 1in :alt Alternate @i{text} +[[ridt.pdf]] +#+end_example + +*** Quotations in Texinfo export +:PROPERTIES: +:DESCRIPTION: Quote block attributes. +:END: + +#+cindex: @samp{ATTR_TEXINFO}, keyword +You can write the text of a quotation within a quote block (see +[[*Paragraphs]]). You may also emphasize some text at the beginning of +the quotation with the =:tag= attribute. + +#+begin_example +,#+ATTR_TEXINFO: :tag Warning +,#+BEGIN_QUOTE +Striking your thumb with a hammer may cause severe pain and discomfort. +,#+END_QUOTE +#+end_example + +To specify the author of the quotation, use the =:author= attribute. + +#+begin_example +,#+ATTR_TEXINFO: :author King Arthur +,#+BEGIN_QUOTE +The Lady of the Lake, her arm clad in the purest shimmering samite, +held aloft Excalibur from the bosom of the water, signifying by divine +providence that I, Arthur, was to carry Excalibur. That is why I am +your king. +,#+END_QUOTE +#+end_example + +*** Special blocks in Texinfo export +:PROPERTIES: +:DESCRIPTION: Special block attributes. +:END: + +#+cindex: @samp{ATTR_TEXINFO}, keyword + +The Texinfo export back-end converts special blocks to commands with +the same name. It also adds any =:options= attributes to the end of +the command, as shown in this example: + +#+begin_example +,#+ATTR_TEXINFO: :options org-org-export-to-org ... +,#+BEGIN_defun + A somewhat obsessive function name. +,#+END_defun +#+end_example + +#+texinfo: @noindent +becomes + +#+begin_example +@defun org-org-export-to-org ... + A somewhat obsessive function name. +@end defun +#+end_example + +*** A Texinfo example +:PROPERTIES: +:DESCRIPTION: Processing Org to Texinfo. +:END: + +Here is a more detailed example Org file. See +[[info:texinfo::GNU Sample Texts]] for an equivalent example using +Texinfo code. + +#+begin_example +,#+TITLE: GNU Sample {{{version}}} +,#+SUBTITLE: for version {{{version}}}, {{{updated}}} +,#+AUTHOR: A.U. Thor +,#+EMAIL: bug-sample@gnu.org + +,#+OPTIONS: ':t toc:t author:t email:t +,#+LANGUAGE: en + +,#+MACRO: version 2.0 +,#+MACRO: updated last updated 4 March 2014 + +,#+TEXINFO_FILENAME: sample.info +,#+TEXINFO_HEADER: @syncodeindex pg cp + +,#+TEXINFO_DIR_CATEGORY: Texinfo documentation system +,#+TEXINFO_DIR_TITLE: sample: (sample) +,#+TEXINFO_DIR_DESC: Invoking sample + +,#+TEXINFO_PRINTED_TITLE: GNU Sample + +This manual is for GNU Sample (version {{{version}}}, +{{{updated}}}). + +,* Copying + :PROPERTIES: + :COPYING: t + :END: + + This manual is for GNU Sample (version {{{version}}}, + {{{updated}}}), which is an example in the Texinfo documentation. + + Copyright \copy 2016 Free Software Foundation, Inc. + + ,#+BEGIN_QUOTE + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.3 or any later version published by the Free Software + Foundation; with no Invariant Sections, with no Front-Cover Texts, + and with no Back-Cover Texts. A copy of the license is included in + the section entitled "GNU Free Documentation License". + ,#+END_QUOTE + +,* Invoking sample + + ,#+PINDEX: sample + ,#+CINDEX: invoking @command{sample} + + This is a sample manual. There is no sample program to invoke, but + if there were, you could see its basic usage and command line + options here. + +,* GNU Free Documentation License + :PROPERTIES: + :APPENDIX: t + :END: + + ,#+INCLUDE: fdl.org + +,* Index + :PROPERTIES: + :INDEX: cp + :END: +#+end_example + +** iCalendar Export +:PROPERTIES: +:DESCRIPTION: Exporting to iCalendar. +:END: +#+cindex: iCalendar export + +A large part of Org mode's interoperability success is its ability to +easily export to or import from external applications. The iCalendar +export back-end takes calendar data from Org files and exports to the +standard iCalendar format. + +#+vindex: org-icalendar-include-todo +#+vindex: org-icalendar-use-deadline +#+vindex: org-icalendar-use-scheduled +The iCalendar export back-end can also incorporate TODO entries based +on the configuration of the ~org-icalendar-include-todo~ variable. +The back-end exports plain timestamps as =VEVENT=, TODO items as +=VTODO=, and also create events from deadlines that are in non-TODO +items. The back-end uses the deadlines and scheduling dates in Org +TODO items for setting the start and due dates for the iCalendar TODO +entry. Consult the ~org-icalendar-use-deadline~ and +~org-icalendar-use-scheduled~ variables for more details. + +#+vindex: org-icalendar-categories +#+vindex: org-icalendar-alarm-time +For tags on the headline, the iCalendar export back-end makes them +into iCalendar categories. To tweak the inheritance of tags and TODO +states, configure the variable ~org-icalendar-categories~. To assign +clock alarms based on time, configure the ~org-icalendar-alarm-time~ +variable. + +#+vindex: org-icalendar-store-UID +#+cindex: @samp{ID}, property +The iCalendar format standard requires globally unique identifier---or +UID---for each entry. The iCalendar export back-end creates UIDs +during export. To save a copy of the UID in the Org file set the +variable ~org-icalendar-store-UID~. The back-end looks for the =ID= +property of the entry for re-using the same UID for subsequent +exports. + +Since a single Org entry can result in multiple iCalendar +entries---timestamp, deadline, scheduled item, or TODO item---Org adds +prefixes to the UID, depending on which part of the Org entry +triggered the creation of the iCalendar entry. Prefixing ensures UIDs +remains unique, yet enable synchronization programs trace the +connections. + +- {{{kbd(C-c C-e c f)}}} (~org-icalendar-export-to-ics~) :: + + #+kindex: C-c C-e c f + #+findex: org-icalendar-export-to-ics + Create iCalendar entries from the current Org buffer and store them + in the same directory, using a file extension =.ics=. + +- {{{kbd(C-c C-e c a)}}} (~org-icalendar-export-agenda-files~) :: + + #+kindex: C-c C-e c a + #+findex: org-icalendar-export-agenda-files + Create iCalendar entries from Org files in ~org-agenda-files~ and + store in a separate iCalendar file for each Org file. + +- {{{kbd(C-c C-e c c)}}} (~org-icalendar-combine-agenda-files~) :: + + #+kindex: C-c C-e c c + #+findex: org-icalendar-combine-agenda-files + #+vindex: org-icalendar-combined-agenda-file + Create a combined iCalendar file from Org files in + ~org-agenda-files~ and write it to + ~org-icalendar-combined-agenda-file~ file name. + +#+cindex: @samp{SUMMARY}, property +#+cindex: @samp{DESCRIPTION}, property +#+cindex: @samp{LOCATION}, property +#+cindex: @samp{TIMEZONE}, property +#+cindex: @samp{CLASS}, property +The iCalendar export back-end includes =SUMMARY=, =DESCRIPTION=, +=LOCATION=, =TIMEZONE= and =CLASS= properties from the Org entries +when exporting. To force the back-end to inherit the =LOCATION=, +=TIMEZONE= and =CLASS= properties, configure the +~org-use-property-inheritance~ variable. + +#+vindex: org-icalendar-include-body +When Org entries do not have =SUMMARY=, =DESCRIPTION=, =LOCATION= and +=CLASS= properties, the iCalendar export back-end derives the summary +from the headline, and derives the description from the body of the +Org item. The ~org-icalendar-include-body~ variable limits the +maximum number of characters of the content are turned into its +description. + +The =TIMEZONE= property can be used to specify a per-entry time zone, +and is applied to any entry with timestamp information. Time zones +should be specified as per the IANA time zone database format, e.g., +=Asia/Almaty=. Alternately, the property value can be =UTC=, to force +UTC time for this entry only. + +The =CLASS= property can be used to specify a per-entry visibility +class or access restrictions, and is applied to any entry with class +information. The iCalendar standard defines three visibility classes: +- =PUBLIC= :: The entry is publicly visible (this is the default). +- =CONFIDENTIAL= :: Only a limited group of clients get access to the + event. +- =PRIVATE= :: The entry can be retrieved only by its owner. +The server should treat unknown class properties the same as +=PRIVATE=. + +Exporting to iCalendar format depends in large part on the +capabilities of the destination application. Some are more lenient +than others. Consult the Org mode FAQ for advice on specific +applications. + +** Other Built-in Back-ends +:PROPERTIES: +:DESCRIPTION: Exporting to a man page. +:END: + +Other export back-ends included with Org are: + +- =ox-man.el=: Export to a man page. + +To activate such back-ends, either customize ~org-export-backends~ or +load directly with =(require 'ox-man)=. On successful load, the +back-end adds new keys in the export dispatcher (see [[*The Export +Dispatcher]]). + +Follow the comment section of such files, for example, =ox-man.el=, +for usage and configuration details. + +** Advanced Export Configuration +:PROPERTIES: +:DESCRIPTION: Fine-tuning the export output. +:END: + +*** Hooks +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+vindex: org-export-before-processing-hook +#+vindex: org-export-before-parsing-hook +The export process executes two hooks before the actual exporting +begins. The first hook, ~org-export-before-processing-hook~, runs +before any expansions of macros, Babel code, and include keywords in +the buffer. The second hook, ~org-export-before-parsing-hook~, runs +before the buffer is parsed. + +Functions added to these hooks are called with a single argument: the +export back-end actually used, as a symbol. You may use them for +heavy duty structural modifications of the document. For example, you +can remove every headline in the buffer during export like this: + +#+begin_src emacs-lisp +(defun my-headline-removal (backend) + "Remove all headlines in the current buffer. +BACKEND is the export back-end being used, as a symbol." + (org-map-entries + (lambda () (delete-region (point) (line-beginning-position 2))))) + +(add-hook 'org-export-before-parsing-hook 'my-headline-removal) +#+end_src + +*** Filters +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: Filters, exporting +Filters are lists of functions to be applied to certain parts for +a given back-end. The output from the first function in the filter is +passed on to the next function in the filter. The final output is the +output from the final function in the filter. + +The Org export process has many filter sets applicable to different +types of objects, plain text, parse trees, export options, and final +output formats. The filters are named after the element type or +object type: ~org-export-filter-TYPE-functions~, where {{{var(TYPE)}}} +is the type targeted by the filter. Valid types are: + +#+attr_texinfo: :columns 0.33 0.33 0.33 +| body | bold | babel-call | +| center-block | clock | code | +| diary-sexp | drawer | dynamic-block | +| entity | example-block | export-block | +| export-snippet | final-output | fixed-width | +| footnote-definition | footnote-reference | headline | +| horizontal-rule | inline-babel-call | inline-src-block | +| inlinetask | italic | item | +| keyword | latex-environment | latex-fragment | +| line-break | link | node-property | +| options | paragraph | parse-tree | +| plain-list | plain-text | planning | +| property-drawer | quote-block | radio-target | +| section | special-block | src-block | +| statistics-cookie | strike-through | subscript | +| superscript | table | table-cell | +| table-row | target | timestamp | +| underline | verbatim | verse-block | + +Here is an example filter that replaces non-breaking spaces ~ ~ in the +Org buffer with =~= for the LaTeX back-end. + +#+begin_src emacs-lisp +(defun my-latex-filter-nobreaks (text backend info) + "Ensure \" \" are properly handled in LaTeX export." + (when (org-export-derived-backend-p backend 'latex) + (replace-regexp-in-string " " "~" text))) + +(add-to-list 'org-export-filter-plain-text-functions + 'my-latex-filter-nobreaks) +#+end_src + +A filter requires three arguments: the code to be transformed, the +name of the back-end, and some optional information about the export +process. The third argument can be safely ignored. Note the use of +~org-export-derived-backend-p~ predicate that tests for /latex/ +back-end or any other back-end, such as /beamer/, derived from +/latex/. + +*** Defining filters for individual files +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +The Org export can filter not just for back-ends, but also for +specific files through the =BIND= keyword. Here is an example with +two filters; one removes brackets from time stamps, and the other +removes strike-through text. The filter functions are defined in +a code block in the same Org file, which is a handy location for +debugging. + +#+begin_example +,#+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp) +,#+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through) +,#+BEGIN_SRC emacs-lisp :exports results :results none + (defun tmp-f-timestamp (s backend info) + (replace-regexp-in-string "&[lg]t;\\|[][]" "" s)) + (defun tmp-f-strike-through (s backend info) "") +,#+END_SRC +#+end_example + +*** Extending an existing back-end +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Some parts of the conversion process can be extended for certain +elements so as to introduce a new or revised translation. That is how +the HTML export back-end was extended to handle Markdown format. The +extensions work seamlessly so any aspect of filtering not done by the +extended back-end is handled by the original back-end. Of all the +export customization in Org, extending is very powerful as it operates +at the parser level. + +For this example, make the /ascii/ back-end display the language used +in a source code block. Also make it display only when some attribute +is non-~nil~, like the following: + +: #+ATTR_ASCII: :language t + +Then extend ASCII back-end with a custom "my-ascii" back-end. + +#+begin_src emacs-lisp +(defun my-ascii-src-block (src-block contents info) + "Transcode a SRC-BLOCK element from Org to ASCII. +CONTENTS is nil. INFO is a plist used as a communication +channel." + (if (not (org-export-read-attribute :attr_ascii src-block :language)) + (org-export-with-backend 'ascii src-block contents info) + (concat + (format ",--[ %s ]--\n%s`----" + (org-element-property :language src-block) + (replace-regexp-in-string + "^" "| " + (org-element-normalize-string + (org-export-format-code-default src-block info))))))) + +(org-export-define-derived-backend 'my-ascii 'ascii + :translate-alist '((src-block . my-ascii-src-block))) +#+end_src + +The ~my-ascii-src-block~ function looks at the attribute above the +current element. If not true, hands over to /ascii/ back-end. If +true, which it is in this example, it creates a box around the code +and leaves room for the inserting a string for language. The last +form creates the new back-end that springs to action only when +translating ~src-block~ type elements. + +To use the newly defined back-end, evaluate the following from an Org +buffer: + +#+begin_src emacs-lisp +(org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*") +#+end_src + +Further steps to consider would be an interactive function, +self-installing an item in the export dispatcher menu, and other +user-friendly improvements. + +** Export in Foreign Buffers +:PROPERTIES: +:DESCRIPTION: Author tables and lists in Org syntax. +:END: + +The export back-ends in Org often include commands to convert selected +regions. A convenient feature of this in-place conversion is that the +exported output replaces the original source. Here are such +functions: + +- ~org-ascii-convert-region-to-ascii~ :: + + #+findex: org-ascii-convert-region-to-ascii + Convert the selected region into ASCII. + +- ~org-ascii-convert-region-to-utf8~ :: + + #+findex: org-ascii-convert-region-to-utf8 + Convert the selected region into UTF-8. + +- ~org-html-convert-region-to-html~ :: + + #+findex: org-html-convert-region-to-html + Convert the selected region into HTML. + +- ~org-latex-convert-region-to-latex~ :: + + #+findex: org-latex-convert-region-to-latex + Convert the selected region into LaTeX. + +- ~org-texinfo-convert-region-to-texinfo~ :: + + #+findex: org-texinfo-convert-region-to-texinfo + Convert the selected region into Texinfo. + +- ~org-md-convert-region-to-md~ :: + + #+findex: org-md-convert-region-to-md + Convert the selected region into Markdown. + +In-place conversions are particularly handy for quick conversion of +tables and lists in foreign buffers. For example, in an HTML buffer, +write a list in Org syntax, select it, and convert it to HTML with +{{{kbd(M-x org-html-convert-region-to-html)}}}. + +*** Exporting to minimal HTML +:PROPERTIES: +:DESCRIPTION: Exporting HTML without CSS, Javascript, etc. +:ALT_TITLE: Bare HTML +:END: + +If you want to output a minimal HTML file, with no CSS, no Javascript, +no preamble or postamble, here are the variable you would need to set: + +#+vindex: org-html-head +#+vindex: org-html-head-extra +#+vindex: org-html-head-include-default-style +#+vindex: org-html-head-include-scripts +#+vindex: org-html-preamble +#+vindex: org-html-postamble +#+vindex: org-html-use-infojs +#+begin_src emacs-lisp +(setq org-html-head "" + org-html-head-extra "" + org-html-head-include-default-style nil + org-html-head-include-scripts nil + org-html-preamble nil + org-html-postamble nil + org-html-use-infojs nil) +#+end_src + +* Publishing +:PROPERTIES: +:DESCRIPTION: Create a web site of linked Org files. +:END: +#+cindex: publishing + +Org includes a publishing management system that allows you to +configure automatic HTML conversion of /projects/ composed of +interlinked Org files. You can also configure Org to automatically +upload your exported HTML pages and related attachments, such as +images and source code files, to a web server. + +You can also use Org to convert files into PDF, or even combine HTML +and PDF conversion so that files are available in both formats on the +server. + +Publishing has been contributed to Org by David O'Toole. + +** Configuration +:PROPERTIES: +:DESCRIPTION: Defining projects. +:END: +Publishing needs significant configuration to specify files, +destination and many other properties of a project. + +*** The variable ~org-publish-project-alist~ +:PROPERTIES: +:DESCRIPTION: The central configuration variable. +:ALT_TITLE: Project alist +:END: +#+cindex: projects, for publishing + +#+vindex: org-publish-project-alist +Publishing is configured almost entirely through setting the value of +one variable, called ~org-publish-project-alist~. Each element of the +list configures one project, and may be in one of the two following +forms: + +#+begin_src emacs-lisp +("project-name" :property value :property value ...) +#+end_src + +#+texinfo: @noindent +i.e., a well-formed property list with alternating keys and values, +or: + +#+begin_src emacs-lisp +("project-name" :components ("project-name" "project-name" ...)) +#+end_src + +In both cases, projects are configured by specifying property values. +A project defines the set of files that are to be published, as well +as the publishing configuration to use when publishing those files. +When a project takes the second form listed above, the individual +members of the ~:components~ property are taken to be sub-projects, +which group together files requiring different publishing options. +When you publish such a "meta-project", all the components are also +published, in the sequence given. + +*** Sources and destinations for files +:PROPERTIES: +:DESCRIPTION: From here to there. +:ALT_TITLE: Sources and destinations +:END: +#+cindex: directories, for publishing + +Most properties are optional, but some should always be set. In +particular, Org needs to know where to look for source files, and +where to put published files. + +- ~:base-directory~ :: + + Directory containing publishing source files. + +- ~:publishing-directory~ :: + + Directory where output files are published. You can directly + publish to a webserver using a file name syntax appropriate for the + Emacs tramp package. Or you can publish to a local directory and + use external tools to upload your website (see [[*Uploading Files]]). + +- ~:preparation-function~ :: + + Function or list of functions to be called before starting the + publishing process, for example, to run =make= for updating files to + be published. Each preparation function is called with a single + argument, the project property list. + +- ~:completion-function~ :: + + Function or list of functions called after finishing the publishing + process, for example, to change permissions of the resulting files. + Each completion function is called with a single argument, the + project property list. + +*** Selecting files +:PROPERTIES: +:DESCRIPTION: What files are part of the project? +:END: +#+cindex: files, selecting for publishing + +By default, all files with extension =.org= in the base directory are +considered part of the project. This can be modified by setting the +following properties + +- ~:base-extension~ :: + + Extension---without the dot---of source files. This actually is + a regular expression. Set this to the symbol ~any~ if you want to + get all files in ~:base-directory~, even without extension. + +- ~:exclude~ :: + + Regular expression to match file names that should not be published, + even though they have been selected on the basis of their extension. + +- ~:include~ :: + + List of files to be included regardless of ~:base-extension~ and + ~:exclude~. + +- ~:recursive~ :: + + Non-~nil~ means, check base-directory recursively for files to + publish. + +*** Publishing action +:PROPERTIES: +:DESCRIPTION: Setting the function doing the publishing. +:END: +#+cindex: action, for publishing + +Publishing means that a file is copied to the destination directory +and possibly transformed in the process. The default transformation +is to export Org files as HTML files, and this is done by the function +~org-publish-org-to-html~ which calls the HTML exporter (see [[*HTML +Export]]). But you can also publish your content as PDF files using +~org-publish-org-to-pdf~, or as ASCII, Texinfo, etc., using the +corresponding functions. + +If you want to publish the Org file as an =.org= file but with +/archived/, /commented/, and /tag-excluded/ trees removed, use +~org-publish-org-to-org~. This produces =file.org= and put it in the +publishing directory. If you want a htmlized version of this file, +set the parameter ~:htmlized-source~ to ~t~. It produces +=file.org.html= in the publishing directory[fn:140]. + +Other files like images only need to be copied to the publishing +destination; for this you can use ~org-publish-attachment~. For +non-Org files, you always need to specify the publishing function: + +- ~:publishing-function~ :: + + Function executing the publication of a file. This may also be + a list of functions, which are all called in turn. + +- ~:htmlized-source~ :: + + Non-~nil~ means, publish htmlized source. + +The function must accept three arguments: a property list containing +at least a ~:publishing-directory~ property, the name of the file to +be published, and the path to the publishing directory of the output +file. It should take the specified file, make the necessary +transformation, if any, and place the result into the destination +folder. + +*** Options for the exporters +:PROPERTIES: +:DESCRIPTION: Tweaking HTML/@LaTeX{} export. +:ALT_TITLE: Publishing options +:END: +#+cindex: options, for publishing +#+cindex: publishing options + +The property list can be used to set many export options for the HTML +and LaTeX exporters. In most cases, these properties correspond to +user variables in Org. The table below lists these properties along +with the variable they belong to. See the documentation string for +the respective variable for details. + +#+vindex: org-publish-project-alist +When a property is given a value in ~org-publish-project-alist~, its +setting overrides the value of the corresponding user variable, if +any, during publishing. Options set within a file (see [[*Export +Settings]]), however, override everything. + +**** Generic properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:archived-trees~ | ~org-export-with-archived-trees~ | +| ~:exclude-tags~ | ~org-export-exclude-tags~ | +| ~:headline-levels~ | ~org-export-headline-levels~ | +| ~:language~ | ~org-export-default-language~ | +| ~:preserve-breaks~ | ~org-export-preserve-breaks~ | +| ~:section-numbers~ | ~org-export-with-section-numbers~ | +| ~:select-tags~ | ~org-export-select-tags~ | +| ~:with-author~ | ~org-export-with-author~ | +| ~:with-broken-links~ | ~org-export-with-broken-links~ | +| ~:with-clocks~ | ~org-export-with-clocks~ | +| ~:with-creator~ | ~org-export-with-creator~ | +| ~:with-date~ | ~org-export-with-date~ | +| ~:with-drawers~ | ~org-export-with-drawers~ | +| ~:with-email~ | ~org-export-with-email~ | +| ~:with-emphasize~ | ~org-export-with-emphasize~ | +| ~:with-fixed-width~ | ~org-export-with-fixed-width~ | +| ~:with-footnotes~ | ~org-export-with-footnotes~ | +| ~:with-latex~ | ~org-export-with-latex~ | +| ~:with-planning~ | ~org-export-with-planning~ | +| ~:with-priority~ | ~org-export-with-priority~ | +| ~:with-properties~ | ~org-export-with-properties~ | +| ~:with-special-strings~ | ~org-export-with-special-strings~ | +| ~:with-sub-superscript~ | ~org-export-with-sub-superscripts~ | +| ~:with-tables~ | ~org-export-with-tables~ | +| ~:with-tags~ | ~org-export-with-tags~ | +| ~:with-tasks~ | ~org-export-with-tasks~ | +| ~:with-timestamps~ | ~org-export-with-timestamps~ | +| ~:with-title~ | ~org-export-with-title~ | +| ~:with-toc~ | ~org-export-with-toc~ | +| ~:with-todo-keywords~ | ~org-export-with-todo-keywords~ | + +**** ASCII specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:ascii-bullets~ | ~org-ascii-bullets~ | +| ~:ascii-caption-above~ | ~org-ascii-caption-above~ | +| ~:ascii-charset~ | ~org-ascii-charset~ | +| ~:ascii-global-margin~ | ~org-ascii-global-margin~ | +| ~:ascii-format-drawer-function~ | ~org-ascii-format-drawer-function~ | +| ~:ascii-format-inlinetask-function~ | ~org-ascii-format-inlinetask-function~ | +| ~:ascii-headline-spacing~ | ~org-ascii-headline-spacing~ | +| ~:ascii-indented-line-width~ | ~org-ascii-indented-line-width~ | +| ~:ascii-inlinetask-width~ | ~org-ascii-inlinetask-width~ | +| ~:ascii-inner-margin~ | ~org-ascii-inner-margin~ | +| ~:ascii-links-to-notes~ | ~org-ascii-links-to-notes~ | +| ~:ascii-list-margin~ | ~org-ascii-list-margin~ | +| ~:ascii-paragraph-spacing~ | ~org-ascii-paragraph-spacing~ | +| ~:ascii-quote-margin~ | ~org-ascii-quote-margin~ | +| ~:ascii-table-keep-all-vertical-lines~ | ~org-ascii-table-keep-all-vertical-lines~ | +| ~:ascii-table-use-ascii-art~ | ~org-ascii-table-use-ascii-art~ | +| ~:ascii-table-widen-columns~ | ~org-ascii-table-widen-columns~ | +| ~:ascii-text-width~ | ~org-ascii-text-width~ | +| ~:ascii-underline~ | ~org-ascii-underline~ | +| ~:ascii-verbatim-format~ | ~org-ascii-verbatim-format~ | + +**** Beamer specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:beamer-theme~ | ~org-beamer-theme~ | +| ~:beamer-column-view-format~ | ~org-beamer-column-view-format~ | +| ~:beamer-environments-extra~ | ~org-beamer-environments-extra~ | +| ~:beamer-frame-default-options~ | ~org-beamer-frame-default-options~ | +| ~:beamer-outline-frame-options~ | ~org-beamer-outline-frame-options~ | +| ~:beamer-outline-frame-title~ | ~org-beamer-outline-frame-title~ | +| ~:beamer-subtitle-format~ | ~org-beamer-subtitle-format~ | + +**** HTML specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:html-allow-name-attribute-in-anchors~ | ~org-html-allow-name-attribute-in-anchors~ | +| ~:html-checkbox-type~ | ~org-html-checkbox-type~ | +| ~:html-container~ | ~org-html-container-element~ | +| ~:html-divs~ | ~org-html-divs~ | +| ~:html-doctype~ | ~org-html-doctype~ | +| ~:html-extension~ | ~org-html-extension~ | +| ~:html-footnote-format~ | ~org-html-footnote-format~ | +| ~:html-footnote-separator~ | ~org-html-footnote-separator~ | +| ~:html-footnotes-section~ | ~org-html-footnotes-section~ | +| ~:html-format-drawer-function~ | ~org-html-format-drawer-function~ | +| ~:html-format-headline-function~ | ~org-html-format-headline-function~ | +| ~:html-format-inlinetask-function~ | ~org-html-format-inlinetask-function~ | +| ~:html-head-extra~ | ~org-html-head-extra~ | +| ~:html-head-include-default-style~ | ~org-html-head-include-default-style~ | +| ~:html-head-include-scripts~ | ~org-html-head-include-scripts~ | +| ~:html-head~ | ~org-html-head~ | +| ~:html-home/up-format~ | ~org-html-home/up-format~ | +| ~:html-html5-fancy~ | ~org-html-html5-fancy~ | +| ~:html-indent~ | ~org-html-indent~ | +| ~:html-infojs-options~ | ~org-html-infojs-options~ | +| ~:html-infojs-template~ | ~org-html-infojs-template~ | +| ~:html-inline-image-rules~ | ~org-html-inline-image-rules~ | +| ~:html-inline-images~ | ~org-html-inline-images~ | +| ~:html-link-home~ | ~org-html-link-home~ | +| ~:html-link-org-files-as-html~ | ~org-html-link-org-files-as-html~ | +| ~:html-link-up~ | ~org-html-link-up~ | +| ~:html-link-use-abs-url~ | ~org-html-link-use-abs-url~ | +| ~:html-mathjax-options~ | ~org-html-mathjax-options~ | +| ~:html-mathjax-template~ | ~org-html-mathjax-template~ | +| ~:html-equation-reference-format~ | ~org-html-equation-reference-format~ | +| ~:html-metadata-timestamp-format~ | ~org-html-metadata-timestamp-format~ | +| ~:html-postamble-format~ | ~org-html-postamble-format~ | +| ~:html-postamble~ | ~org-html-postamble~ | +| ~:html-preamble-format~ | ~org-html-preamble-format~ | +| ~:html-preamble~ | ~org-html-preamble~ | +| ~:html-self-link-headlines~ | ~org-html-self-link-headlines~ | +| ~:html-table-align-individual-field~ | ~de{org-html-table-align-individual-fields~ | +| ~:html-table-attributes~ | ~org-html-table-default-attributes~ | +| ~:html-table-caption-above~ | ~org-html-table-caption-above~ | +| ~:html-table-data-tags~ | ~org-html-table-data-tags~ | +| ~:html-table-header-tags~ | ~org-html-table-header-tags~ | +| ~:html-table-row-tags~ | ~org-html-table-row-tags~ | +| ~:html-table-use-header-tags-for-first-column~ | ~org-html-table-use-header-tags-for-first-column~ | +| ~:html-tag-class-prefix~ | ~org-html-tag-class-prefix~ | +| ~:html-text-markup-alist~ | ~org-html-text-markup-alist~ | +| ~:html-todo-kwd-class-prefix~ | ~org-html-todo-kwd-class-prefix~ | +| ~:html-toplevel-hlevel~ | ~org-html-toplevel-hlevel~ | +| ~:html-use-infojs~ | ~org-html-use-infojs~ | +| ~:html-validation-link~ | ~org-html-validation-link~ | +| ~:html-viewport~ | ~org-html-viewport~ | +| ~:html-wrap-src-lines~ | ~org-html-wrap-src-lines~ | +| ~:html-xml-declaration~ | ~org-html-xml-declaration~ | + +**** LaTeX specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:latex-active-timestamp-format~ | ~org-latex-active-timestamp-format~ | +| ~:latex-caption-above~ | ~org-latex-caption-above~ | +| ~:latex-classes~ | ~org-latex-classes~ | +| ~:latex-class~ | ~org-latex-default-class~ | +| ~:latex-compiler~ | ~org-latex-compiler~ | +| ~:latex-default-figure-position~ | ~org-latex-default-figure-position~ | +| ~:latex-default-table-environment~ | ~org-latex-default-table-environment~ | +| ~:latex-default-table-mode~ | ~org-latex-default-table-mode~ | +| ~:latex-diary-timestamp-format~ | ~org-latex-diary-timestamp-format~ | +| ~:latex-footnote-defined-format~ | ~org-latex-footnote-defined-format~ | +| ~:latex-footnote-separator~ | ~org-latex-footnote-separator~ | +| ~:latex-format-drawer-function~ | ~org-latex-format-drawer-function~ | +| ~:latex-format-headline-function~ | ~org-latex-format-headline-function~ | +| ~:latex-format-inlinetask-function~ | ~org-latex-format-inlinetask-function~ | +| ~:latex-hyperref-template~ | ~org-latex-hyperref-template~ | +| ~:latex-image-default-height~ | ~org-latex-image-default-height~ | +| ~:latex-image-default-option~ | ~org-latex-image-default-option~ | +| ~:latex-image-default-width~ | ~org-latex-image-default-width~ | +| ~:latex-images-centered~ | ~org-latex-images-centered~ | +| ~:latex-inactive-timestamp-format~ | ~org-latex-inactive-timestamp-format~ | +| ~:latex-inline-image-rules~ | ~org-latex-inline-image-rules~ | +| ~:latex-link-with-unknown-path-format~ | ~org-latex-link-with-unknown-path-format~ | +| ~:latex-listings-langs~ | ~org-latex-listings-langs~ | +| ~:latex-listings-options~ | ~org-latex-listings-options~ | +| ~:latex-listings~ | ~org-latex-listings~ | +| ~:latex-minted-langs~ | ~org-latex-minted-langs~ | +| ~:latex-minted-options~ | ~org-latex-minted-options~ | +| ~:latex-prefer-user-labels~ | ~org-latex-prefer-user-labels~ | +| ~:latex-subtitle-format~ | ~org-latex-subtitle-format~ | +| ~:latex-subtitle-separate~ | ~org-latex-subtitle-separate~ | +| ~:latex-table-scientific-notation~ | ~org-latex-table-scientific-notation~ | +| ~:latex-tables-booktabs~ | ~org-latex-tables-booktabs~ | +| ~:latex-tables-centered~ | ~org-latex-tables-centered~ | +| ~:latex-text-markup-alist~ | ~org-latex-text-markup-alist~ | +| ~:latex-title-command~ | ~org-latex-title-command~ | +| ~:latex-toc-command~ | ~org-latex-toc-command~ | + +**** Markdown specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:md-footnote-format~ | ~org-md-footnote-format~ | +| ~:md-footnotes-section~ | ~org-md-footnotes-section~ | +| ~:md-headline-style~ | ~org-md-headline-style~ | + +**** ODT specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:odt-content-template-file~ | ~org-odt-content-template-file~ | +| ~:odt-display-outline-level~ | ~org-odt-display-outline-level~ | +| ~:odt-fontify-srcblocks~ | ~org-odt-fontify-srcblocks~ | +| ~:odt-format-drawer-function~ | ~org-odt-format-drawer-function~ | +| ~:odt-format-headline-function~ | ~org-odt-format-headline-function~ | +| ~:odt-format-inlinetask-function~ | ~org-odt-format-inlinetask-function~ | +| ~:odt-inline-formula-rules~ | ~org-odt-inline-formula-rules~ | +| ~:odt-inline-image-rules~ | ~org-odt-inline-image-rules~ | +| ~:odt-pixels-per-inch~ | ~org-odt-pixels-per-inch~ | +| ~:odt-styles-file~ | ~org-odt-styles-file~ | +| ~:odt-table-styles~ | ~org-odt-table-styles~ | +| ~:odt-use-date-fields~ | ~org-odt-use-date-fields~ | + +**** Texinfo specific properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +| ~:texinfo-active-timestamp-format~ | ~org-texinfo-active-timestamp-format~ | +| ~:texinfo-classes~ | ~org-texinfo-classes~ | +| ~:texinfo-class~ | ~org-texinfo-default-class~ | +| ~:texinfo-table-default-markup~ | ~org-texinfo-table-default-markup~ | +| ~:texinfo-diary-timestamp-format~ | ~org-texinfo-diary-timestamp-format~ | +| ~:texinfo-filename~ | ~org-texinfo-filename~ | +| ~:texinfo-format-drawer-function~ | ~org-texinfo-format-drawer-function~ | +| ~:texinfo-format-headline-function~ | ~org-texinfo-format-headline-function~ | +| ~:texinfo-format-inlinetask-function~ | ~org-texinfo-format-inlinetask-function~ | +| ~:texinfo-inactive-timestamp-format~ | ~org-texinfo-inactive-timestamp-format~ | +| ~:texinfo-link-with-unknown-path-format~ | ~org-texinfo-link-with-unknown-path-format~ | +| ~:texinfo-node-description-column~ | ~org-texinfo-node-description-column~ | +| ~:texinfo-table-scientific-notation~ | ~org-texinfo-table-scientific-notation~ | +| ~:texinfo-tables-verbatim~ | ~org-texinfo-tables-verbatim~ | +| ~:texinfo-text-markup-alist~ | ~org-texinfo-text-markup-alist~ | + +*** Publishing links +:PROPERTIES: +:DESCRIPTION: Which links keep working after publishing? +:END: +#+cindex: links, publishing + +To create a link from one Org file to another, you would use something +like =[[file:foo.org][The foo]]= or simply =[[file:foo.org]]= (see [[*External Links]]). When +published, this link becomes a link to =foo.html=. You can thus +interlink the pages of your "Org web" project and the links will work +as expected when you publish them to HTML. If you also publish the +Org source file and want to link to it, use an =http= link instead of +a =file:= link, because =file= links are converted to link to the +corresponding =.html= file. + +You may also link to related files, such as images. Provided you are +careful with relative file names, and provided you have also +configured Org to upload the related files, these links will work too. +See [[*Example: complex publishing configuration]], for an example of this +usage. + +Eventually, links between published documents can contain some search +options (see [[*Search Options in File Links]]), which will be resolved to +the appropriate location in the linked file. For example, once +published to HTML, the following links all point to a dedicated anchor +in =foo.html=. + +#+begin_example +[[file:foo.org::*heading]] +[[file:foo.org::#custom-id]] +[[file:foo.org::target]] +#+end_example + +*** Generating a sitemap +:PROPERTIES: +:DESCRIPTION: Generating a list of all pages. +:ALT_TITLE: Site map +:END: +#+cindex: sitemap, of published pages + +The following properties may be used to control publishing of +a map of files for a given project. + +- ~:auto-sitemap~ :: + + When non-~nil~, publish a sitemap during + ~org-publish-current-project~ or ~org-publish-all~. + +- ~:sitemap-filename~ :: + + Filename for output of sitemap. Defaults to =sitemap.org=, which + becomes =sitemap.html=. + +- ~:sitemap-title~ :: + + Title of sitemap page. Defaults to name of file. + +- ~:sitemap-format-entry~ :: + + #+findex: org-publish-find-date + #+findex: org-publish-find-property + #+findex: org-publish-find-title + With this option one can tell how a site-map entry is formatted in + the site-map. It is a function called with three arguments: the + file or directory name relative to base directory of the project, + the site-map style and the current project. It is expected to + return a string. Default value turns file names into links and use + document titles as descriptions. For specific formatting needs, one + can use ~org-publish-find-date~, ~org-publish-find-title~ and + ~org-publish-find-property~, to retrieve additional information + about published documents. + +- ~:sitemap-function~ :: + + Plug-in function to use for generation of the sitemap. It is called + with two arguments: the title of the site-map and a representation + of the files and directories involved in the project as a nested + list, which can further be transformed using ~org-list-to-generic~, + ~org-list-to-subtree~ and alike. Default value generates a plain + list of links to all files in the project. + +- ~:sitemap-sort-folders~ :: + + Where folders should appear in the sitemap. Set this to ~first~ + (default) or ~last~ to display folders first or last, respectively. + When set to ~ignore~, folders are ignored altogether. Any other + value mixes files and folders. This variable has no effect when + site-map style is ~tree~. + +- ~:sitemap-sort-files~ :: + + How the files are sorted in the site map. Set this to + ~alphabetically~ (default), ~chronologically~ or + ~anti-chronologically~. ~chronologically~ sorts the files with + older date first while ~anti-chronologically~ sorts the files with + newer date first. ~alphabetically~ sorts the files alphabetically. + The date of a file is retrieved with ~org-publish-find-date~. + +- ~:sitemap-ignore-case~ :: + + Should sorting be case-sensitive? Default ~nil~. + +- ~:sitemap-file-entry-format~ :: + + With this option one can tell how a sitemap's entry is formatted in + the sitemap. This is a format string with some escape sequences: + ~%t~ stands for the title of the file, ~%a~ stands for the author of + the file and ~%d~ stands for the date of the file. The date is + retrieved with the ~org-publish-find-date~ function and formatted + with ~org-publish-sitemap-date-format~. Default ~%t~. + +- ~:sitemap-date-format~ :: + + Format string for the ~format-time-string~ function that tells how + a sitemap entry's date is to be formatted. This property bypasses + ~org-publish-sitemap-date-format~ which defaults to ~%Y-%m-%d~. + +*** Generating an index +:PROPERTIES: +:DESCRIPTION: An index that reaches across pages. +:END: +#+cindex: index, in a publishing project + +Org mode can generate an index across the files of a publishing project. + +- ~:makeindex~ :: + + When non-~nil~, generate in index in the file =theindex.org= and + publish it as =theindex.html=. + +The file is created when first publishing a project with the +~:makeindex~ set. The file only contains a statement =#+INCLUDE: +"theindex.inc"=. You can then build around this include statement by +adding a title, style information, etc. + +#+cindex: @samp{INDEX}, keyword +Index entries are specified with =INDEX= keyword. An entry that +contains an exclamation mark creates a sub item. + +#+begin_example +,*** Curriculum Vitae +,#+INDEX: CV +,#+INDEX: Application!CV +#+end_example + +** Uploading Files +:PROPERTIES: +:DESCRIPTION: How to get files up on the server. +:END: +#+cindex: rsync +#+cindex: unison + +For those people already utilizing third party sync tools such as +Rsync or Unison, it might be preferable not to use the built-in remote +publishing facilities of Org mode which rely heavily on Tramp. Tramp, +while very useful and powerful, tends not to be so efficient for +multiple file transfer and has been known to cause problems under +heavy usage. + +Specialized synchronization utilities offer several advantages. In +addition to timestamp comparison, they also do content and +permissions/attribute checks. For this reason you might prefer to +publish your web to a local directory---possibly even /in place/ with +your Org files---and then use Unison or Rsync to do the +synchronization with the remote host. + +Since Unison, for example, can be configured as to which files to +transfer to a certain remote destination, it can greatly simplify the +project publishing definition. Simply keep all files in the correct +location, process your Org files with ~org-publish~ and let the +synchronization tool do the rest. You do not need, in this scenario, +to include attachments such as JPG, CSS or PNG files in the project +definition since the third-party tool syncs them. + +Publishing to a local directory is also much faster than to a remote +one, so that you can afford more easily to republish entire projects. +If you set ~org-publish-use-timestamps-flag~ to ~nil~, you gain the +main benefit of re-including any changed external files such as source +example files you might include with =INCLUDE= keyword. The timestamp +mechanism in Org is not smart enough to detect if included files have +been modified. + +** Sample Configuration +:PROPERTIES: +:DESCRIPTION: Example projects. +:END: + +Below we provide two example configurations. The first one is +a simple project publishing only a set of Org files. The second +example is more complex, with a multi-component project. + +*** Example: simple publishing configuration +:PROPERTIES: +:DESCRIPTION: One-component publishing. +:ALT_TITLE: Simple example +:END: + +This example publishes a set of Org files to the =public_html= +directory on the local machine. + +#+begin_src emacs-lisp +(setq org-publish-project-alist + '(("org" + :base-directory "~/org/" + :publishing-directory "~/public_html" + :section-numbers nil + :table-of-contents nil + :style "<link rel=\"stylesheet\" + href=\"../other/mystyle.css\" + type=\"text/css\"/>"))) +#+end_src + +*** Example: complex publishing configuration +:PROPERTIES: +:DESCRIPTION: A multi-component publishing example. +:ALT_TITLE: Complex example +:END: + +This more complicated example publishes an entire website, including +Org files converted to HTML, image files, Emacs Lisp source code, and +style sheets. The publishing directory is remote and private files +are excluded. + +To ensure that links are preserved, care should be taken to replicate +your directory structure on the web server, and to use relative file +paths. For example, if your Org files are kept in =~/org/= and your +publishable images in =~/images/=, you would link to an image with + +: file:../images/myimage.png + +On the web server, the relative path to the image should be the same. +You can accomplish this by setting up an =images/= folder in the right +place on the web server, and publishing images to it. + +#+begin_src emacs-lisp +(setq org-publish-project-alist + '(("orgfiles" + :base-directory "~/org/" + :base-extension "org" + :publishing-directory "/ssh:user@host:~/html/notebook/" + :publishing-function org-html-publish-to-html + :exclude "PrivatePage.org" ;; regexp + :headline-levels 3 + :section-numbers nil + :with-toc nil + :html-head "<link rel=\"stylesheet\" + href=\"../other/mystyle.css\" type=\"text/css\"/>" + :html-preamble t) + + ("images" + :base-directory "~/images/" + :base-extension "jpg\\|gif\\|png" + :publishing-directory "/ssh:user@host:~/html/images/" + :publishing-function org-publish-attachment) + + ("other" + :base-directory "~/other/" + :base-extension "css\\|el" + :publishing-directory "/ssh:user@host:~/html/other/" + :publishing-function org-publish-attachment) + ("website" :components ("orgfiles" "images" "other")))) +#+end_src + +** Triggering Publication +:PROPERTIES: +:DESCRIPTION: Publication commands. +:END: + +Once properly configured, Org can publish with the following commands: + +- {{{kbd(C-c C-e P x)}}} (~org-publish~) :: + + #+kindex: C-c C-e P x + #+findex: org-publish + Prompt for a specific project and publish all files that belong to + it. + +- {{{kbd(C-c C-e P p)}}} (~org-publish-current-project~) :: + + #+kindex: C-c C-e P p + #+findex: org-publish-current-project + Publish the project containing the current file. + +- {{{kbd(C-c C-e P f)}}} (~org-publish-current-file~) :: + + #+kindex: C-c C-e P f + #+findex: org-publish-current-file + Publish only the current file. + +- {{{kbd(C-c C-e P a)}}} (~org-publish-all~) :: + + #+kindex: C-c C-e P a + #+findex: org-publish-all + Publish every project. + +#+vindex: org-publish-use-timestamps-flag +Org uses timestamps to track when a file has changed. The above +functions normally only publish changed files. You can override this +and force publishing of all files by giving a prefix argument to any +of the commands above, or by customizing the variable +~org-publish-use-timestamps-flag~. This may be necessary in +particular if files include other files via =SETUPFILE= or =INCLUDE= +keywords. + +* Working with Source Code +:PROPERTIES: +:DESCRIPTION: Export, evaluate, and tangle code blocks. +:END: +#+cindex: source code, working with + +Source code here refers to any plain text collection of computer +instructions, possibly with comments, written using a human-readable +programming language. Org can manage source code in an Org document +when the source code is identified with begin and end markers. +Working with source code begins with identifying source code blocks. +A source code block can be placed almost anywhere in an Org document; +it is not restricted to the preamble or the end of the document. +However, Org cannot manage a source code block if it is placed inside +an Org comment or within a fixed width section. + +Here is an example source code block in the Emacs Lisp language: + +#+begin_example +,#+BEGIN_SRC emacs-lisp + (defun org-xor (a b) + "Exclusive or." + (if a (not b) b)) +,#+END_SRC +#+end_example + +Source code blocks are one of many Org block types, which also include +"center", "comment", "dynamic", "example", "export", "quote", +"special", and "verse". This section pertains to blocks between +=#+BEGIN_SRC= and =#+END_SRC=. + +Details of Org's facilities for working with source code are described +in the following sections. + +** Features Overview +:PROPERTIES: +:DESCRIPTION: Enjoy the versatility of source blocks. +:END: + +Org can manage the source code in the block delimited by =#+BEGIN_SRC= +... =#+END_SRC= in several ways that can simplify housekeeping tasks +essential to modern source code maintenance. Org can edit, format, +extract, export, and publish source code blocks. Org can also compile +and execute a source code block, then capture the results. The Org +mode literature sometimes refers to source code blocks as /live code/ +blocks because they can alter the content of the Org document or the +material that it exports. Users can control how live they want each +source code block by tweaking the header arguments (see [[*Using Header +Arguments]]) for compiling, execution, extraction, and exporting. + +For editing and formatting a source code block, Org uses an +appropriate Emacs major mode that includes features specifically +designed for source code in that language. + +Org can extract one or more source code blocks and write them to one +or more source files---a process known as /tangling/ in literate +programming terminology. + +For exporting and publishing, Org's back-ends can format a source code +block appropriately, often with native syntax highlighting. + +For executing and compiling a source code block, the user can +configure Org to select the appropriate compiler. Org provides +facilities to collect the result of the execution or compiler output, +insert it into the Org document, and/or export it. In addition to +text results, Org can insert links to other data types, including +audio, video, and graphics. Org can also link a compiler error +message to the appropriate line in the source code block. + +An important feature of Org's management of source code blocks is the +ability to pass variables, functions, and results to one another using +a common syntax for source code blocks in any language. Although most +literate programming facilities are restricted to one language or +another, Org's language-agnostic approach lets the literate programmer +match each programming task with the appropriate computer language and +to mix them all together in a single Org document. This +interoperability among languages explains why Org's source code +management facility was named /Org Babel/ by its originators, Eric +Schulte and Dan Davison. + +Org mode fulfills the promise of easy verification and maintenance of +publishing reproducible research by keeping text, data, code, +configuration settings of the execution environment, the results of +the execution, and associated narratives, claims, references, and +internal and external links in a single Org document. + +** Structure of Code Blocks +:PROPERTIES: +:DESCRIPTION: Code block syntax described. +:END: +#+cindex: code block, structure +#+cindex: source code, block structure +#+cindex: @samp{NAME} keyword, in source blocks +#+cindex: @samp{BEGIN_SRC} + +Org offers two ways to structure source code in Org documents: in +a source code block, and directly inline. Both specifications are +shown below. + +A source code block conforms to this structure: + +#+begin_example +,#+NAME: <name> +,#+BEGIN_SRC <language> <switches> <header arguments> + <body> +,#+END_SRC +#+end_example + +Do not be put-off by having to remember the source block syntax. Org +mode offers a command for wrapping existing text in a block (see +[[*Structure Templates]]). Org also works with other completion systems +in Emacs, some of which predate Org and have custom domain-specific +languages for defining templates. Regular use of templates reduces +errors, increases accuracy, and maintains consistency. + +#+cindex: source code, inline +An inline code block conforms to this structure: + +: src_<language>{<body>} + +#+texinfo: @noindent +or + +: src_<language>[<header arguments>]{<body>} + +- =#+NAME: <name>= :: + + Optional. Names the source block so it can be called, like + a function, from other source blocks or inline code to evaluate or + to capture the results. Code from other blocks, other files, and + from table formulas (see [[*The Spreadsheet]]) can use the name to + reference a source block. This naming serves the same purpose as + naming Org tables. Org mode requires unique names. For duplicate + names, Org mode's behavior is undefined. + +- =#+BEGIN_SRC= ... =#+END_SRC= :: + + Mandatory. They mark the start and end of a block that Org + requires. The =#+BEGIN_SRC= line takes additional arguments, as + described next. + +- =<language>= :: + + #+cindex: language, in code blocks + Mandatory. It is the identifier of the source code language in the + block. See [[*Languages]], for identifiers of supported languages. + +- =<switches>= :: + + #+cindex: switches, in code blocks + Optional. Switches provide finer control of the code execution, + export, and format (see the discussion of switches in [[*Literal + Examples]]). + +- =<header arguments>= :: + + #+cindex: header arguments, in code blocks + Optional. Heading arguments control many aspects of evaluation, + export and tangling of code blocks (see [[*Using Header Arguments]]). + Using Org's properties feature, header arguments can be selectively + applied to the entire buffer or specific sub-trees of the Org + document. + +- =<body>= :: + + Source code in the dialect of the specified language identifier. + +** Using Header Arguments +:PROPERTIES: +:DESCRIPTION: Different ways to set header arguments. +:END: + +Org comes with many header arguments common to all languages. New +header arguments are added for specific languages as they become +available for use in source code blocks. A header argument is +specified with an initial colon followed by the argument's name in +lowercase. + +Since header arguments can be set in several ways, Org prioritizes +them in case of overlaps or conflicts by giving local settings +a higher priority. Header values in function calls, for example, +override header values from global defaults. + +*** System-wide header arguments +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+vindex: org-babel-default-header-args + +#+vindex: org-babel-default-header-args +System-wide values of header arguments can be specified by customizing +the ~org-babel-default-header-args~ variable, which defaults to the +following values: + +#+begin_example +:session => "none" +:results => "replace" +:exports => "code" +:cache => "no" +:noweb => "no" +#+end_example + +The example below sets =:noweb= header arguments to =yes=, which makes +Org expand =:noweb= references by default. + +#+begin_src emacs-lisp +(setq org-babel-default-header-args + (cons '(:noweb . "yes") + (assq-delete-all :noweb org-babel-default-header-args))) +#+end_src + +#+cindex: language specific default header arguments +#+cindex: default header arguments per language +Each language can have separate default header arguments by +customizing the variable ~org-babel-default-header-args:<LANG>~, where +{{{var(<LANG>)}}} is the name of the language. For details, see the +language-specific online documentation at +https://orgmode.org/worg/org-contrib/babel/. + +*** Header arguments in Org mode properties +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +For header arguments applicable to the buffer, use =PROPERTY= keyword +anywhere in the Org file (see [[*Property Syntax]]). + +The following example makes all the R code blocks execute in the same +session. Setting =:results= to =silent= ignores the results of +executions for all blocks, not just R code blocks; no results inserted +for any block. + +#+begin_example +,#+PROPERTY: header-args:R :session *R* +,#+PROPERTY: header-args :results silent +#+end_example + +#+vindex: org-use-property-inheritance +Header arguments set through Org's property drawers (see [[*Property +Syntax]]) apply at the sub-tree level on down. Since these property +drawers can appear anywhere in the file hierarchy, Org uses outermost +call or source block to resolve the values. Org ignores +~org-use-property-inheritance~ setting. + +In this example, =:cache= defaults to =yes= for all code blocks in the +sub-tree. + +#+begin_example +,* sample header + :PROPERTIES: + :header-args: :cache yes + :END: +#+end_example + +#+kindex: C-c C-x p +#+findex: org-set-property +Properties defined through ~org-set-property~ function, bound to +{{{kbd(C-c C-x p)}}}, apply to all active languages. They override +properties set in ~org-babel-default-header-args~. + +#+cindex: language specific header arguments properties +#+cindex: header arguments per language +Language-specific header arguments are also read from properties +=header-args:<LANG>= where {{{var(<LANG>)}}} is the language +identifier. For example, + +#+begin_example +,* Heading + :PROPERTIES: + :header-args:clojure: :session *clojure-1* + :header-args:R: :session *R* + :END: +,** Subheading + :PROPERTIES: + :header-args:clojure: :session *clojure-2* + :END: +#+end_example + +#+texinfo: @noindent +would force separate sessions for Clojure blocks in =Heading= and +=Subheading=, but use the same session for all R blocks. Blocks in +=Subheading= inherit settings from =Heading=. + +*** Code block specific header arguments +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Header arguments are most commonly set at the source code block level, +on the =#+BEGIN_SRC= line. Arguments set at this level take +precedence over those set in the ~org-babel-default-header-args~ +variable, and also those set as header properties. + +In the following example, setting =:results= to =silent= makes it +ignore results of the code execution. Setting =:exports= to =code= +exports only the body of the code block to HTML or LaTeX. + +#+begin_example +,#+NAME: factorial +,#+BEGIN_SRC haskell :results silent :exports code :var n=0 + fac 0 = 1 + fac n = n * fac (n-1) +,#+END_SRC +#+end_example + +The same header arguments in an inline code block: + +: src_haskell[:exports both]{fac 5} + +#+cindex: @samp{HEADER}, keyword +Code block header arguments can span multiple lines using =#+HEADER:= +on each line. Note that Org currently accepts the plural spelling of +=#+HEADER:= only as a convenience for backward-compatibility. It may +be removed at some point. + +Multi-line header arguments on an unnamed code block: + +#+begin_example +,#+HEADER: :var data1=1 +,#+BEGIN_SRC emacs-lisp :var data2=2 + (message "data1:%S, data2:%S" data1 data2) +,#+END_SRC + +,#+RESULTS: +: data1:1, data2:2 +#+end_example + +Multi-line header arguments on a named code block: + +#+begin_example +,#+NAME: named-block +,#+HEADER: :var data=2 +,#+BEGIN_SRC emacs-lisp + (message "data:%S" data) +,#+END_SRC + +,#+RESULTS: named-block + : data:2 +#+end_example + +*** Header arguments in function calls +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Header arguments in function calls are the most specific and override +all other settings in case of an overlap. They get the highest +priority. Two =#+CALL:= examples are shown below. For the complete +syntax of =CALL= keyword, see [[*Evaluating Code Blocks]]. + +In this example, =:exports results= header argument is applied to the +evaluation of the =#+CALL:= line. + +: #+CALL: factorial(n=5) :exports results + +In this example, =:session special= header argument is applied to the +evaluation of =factorial= code block. + +: #+CALL: factorial[:session special](n=5) + +** Environment of a Code Block +:PROPERTIES: +:DESCRIPTION: Arguments, sessions, working directory... +:END: + +*** Passing arguments +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: passing arguments to code blocks +#+cindex: arguments, in code blocks +#+cindex: @samp{var}, header argument +Use =var= for passing arguments to source code blocks. The specifics +of variables in code blocks vary by the source language and are +covered in the language-specific documentation. The syntax for =var=, +however, is the same for all languages. This includes declaring +a variable, and assigning a default value. + +The following syntax is used to pass arguments to code blocks using +the =var= header argument. + +: :var NAME=ASSIGN + +#+texinfo: @noindent +{{{var(NAME)}}} is the name of the variable bound in the code block +body. {{{var(ASSIGN)}}} is a literal value, such as a string, +a number, a reference to a table, a list, a literal example, another +code block---with or without arguments---or the results of evaluating +a code block. + +Here are examples of passing values by reference: + +- table :: + + A table named with a =NAME= keyword. + + #+begin_example + ,#+NAME: example-table + | 1 | + | 2 | + | 3 | + | 4 | + + ,#+NAME: table-length + ,#+BEGIN_SRC emacs-lisp :var table=example-table + (length table) + ,#+END_SRC + + ,#+RESULTS: table-length + : 4 + #+end_example + + When passing a table, you can treat specially the row, or the + column, containing labels for the columns, or the rows, in the + table. + + #+cindex: @samp{colnames}, header argument + The =colnames= header argument accepts =yes=, =no=, or =nil= values. + The default value is =nil=: if an input table has column + names---because the second row is a horizontal rule---then Org + removes the column names, processes the table, puts back the column + names, and then writes the table to the results block. Using =yes=, + Org does the same to the first row, even if the initial table does + not contain any horizontal rule. When set to =no=, Org does not + pre-process column names at all. + + #+begin_example + ,#+NAME: less-cols + | a | + |---| + | b | + | c | + + ,#+BEGIN_SRC python :var tab=less-cols :colnames nil + return [[val + '*' for val in row] for row in tab] + ,#+END_SRC + + ,#+RESULTS: + | a | + |----| + | b* | + | c* | + #+end_example + + #+cindex: @samp{rownames}, header argument + Similarly, the =rownames= header argument can take two values: =yes= + or =no=. When set to =yes=, Org removes the first column, processes + the table, puts back the first column, and then writes the table to + the results block. The default is =no=, which means Org does not + pre-process the first column. Note that Emacs Lisp code blocks + ignore =rownames= header argument because of the ease of + table-handling in Emacs. + + #+begin_example + ,#+NAME: with-rownames + | one | 1 | 2 | 3 | 4 | 5 | + | two | 6 | 7 | 8 | 9 | 10 | + + ,#+BEGIN_SRC python :var tab=with-rownames :rownames yes + return [[val + 10 for val in row] for row in tab] + ,#+END_SRC + + ,#+RESULTS: + | one | 11 | 12 | 13 | 14 | 15 | + | two | 16 | 17 | 18 | 19 | 20 | + #+end_example + +- list :: + + A simple named list. + + #+begin_example + ,#+NAME: example-list + - simple + - not + - nested + - list + + ,#+BEGIN_SRC emacs-lisp :var x=example-list + (print x) + ,#+END_SRC + + ,#+RESULTS: + | simple | list | + #+end_example + + Note that only the top level list items are passed along. Nested + list items are ignored. + +- code block without arguments :: + + A code block name, as assigned by =NAME= keyword from the example + above, optionally followed by parentheses. + + #+begin_example + ,#+BEGIN_SRC emacs-lisp :var length=table-length() + (* 2 length) + ,#+END_SRC + + ,#+RESULTS: + : 8 + #+end_example + +- code block with arguments :: + + A code block name, as assigned by =NAME= keyword, followed by + parentheses and optional arguments passed within the parentheses. + + #+begin_example + ,#+NAME: double + ,#+BEGIN_SRC emacs-lisp :var input=8 + (* 2 input) + ,#+END_SRC + + ,#+RESULTS: double + : 16 + + ,#+NAME: squared + ,#+BEGIN_SRC emacs-lisp :var input=double(input=1) + (* input input) + ,#+END_SRC + + ,#+RESULTS: squared + : 4 + #+end_example + +- literal example :: + + A literal example block named with a =NAME= keyword. + + #+begin_example + ,#+NAME: literal-example + ,#+BEGIN_EXAMPLE + A literal example + on two lines + ,#+END_EXAMPLE + + ,#+NAME: read-literal-example + ,#+BEGIN_SRC emacs-lisp :var x=literal-example + (concatenate #'string x " for you.") + ,#+END_SRC + + ,#+RESULTS: read-literal-example + : A literal example + : on two lines for you. + #+end_example + +Indexing variable values enables referencing portions of a variable. +Indexes are 0 based with negative values counting backwards from the +end. If an index is separated by commas then each subsequent section +indexes as the next dimension. Note that this indexing occurs +/before/ other table-related header arguments are applied, such as +=hlines=, =colnames= and =rownames=. The following example assigns +the last cell of the first row the table =example-table= to the +variable =data=: + +#+begin_example +,#+NAME: example-table +| 1 | a | +| 2 | b | +| 3 | c | +| 4 | d | + +,#+BEGIN_SRC emacs-lisp :var data=example-table[0,-1] + data +,#+END_SRC + +,#+RESULTS: +: a +#+end_example + +Two integers separated by a colon reference a range of variable +values. In that case the entire inclusive range is referenced. For +example the following assigns the middle three rows of =example-table= +to =data=. + +#+begin_example +,#+NAME: example-table +| 1 | a | +| 2 | b | +| 3 | c | +| 4 | d | +| 5 | 3 | + +,#+BEGIN_SRC emacs-lisp :var data=example-table[1:3] + data +,#+END_SRC + +,#+RESULTS: +| 2 | b | +| 3 | c | +| 4 | d | +#+end_example + +To pick the entire range, use an empty index, or the single character +=*=. =0:-1= does the same thing. Example below shows how to +reference the first column only. + +#+begin_example +,#+NAME: example-table +| 1 | a | +| 2 | b | +| 3 | c | +| 4 | d | + +,#+BEGIN_SRC emacs-lisp :var data=example-table[,0] + data +,#+END_SRC + +,#+RESULTS: +| 1 | 2 | 3 | 4 | +#+end_example + +Index referencing can be used for tables and code blocks. Index +referencing can handle any number of dimensions. Commas delimit +multiple dimensions, as shown below. + +#+begin_example +,#+NAME: 3D +,#+BEGIN_SRC emacs-lisp + '(((1 2 3) (4 5 6) (7 8 9)) + ((10 11 12) (13 14 15) (16 17 18)) + ((19 20 21) (22 23 24) (25 26 27))) +,#+END_SRC + +,#+BEGIN_SRC emacs-lisp :var data=3D[1,,1] + data +,#+END_SRC + +,#+RESULTS: +| 11 | 14 | 17 | +#+end_example + +Note that row names and column names are not removed prior to variable +indexing. You need to take them into account, even when =colnames= or +=rownames= header arguments remove them. + +Emacs lisp code can also set the values for variables. To +differentiate a value from Lisp code, Org interprets any value +starting with =(=, =[=, ='= or =`= as Emacs Lisp code. The result of +evaluating that code is then assigned to the value of that variable. +The following example shows how to reliably query and pass the file +name of the Org mode buffer to a code block using headers. We need +reliability here because the file's name could change once the code in +the block starts executing. + +#+begin_example +,#+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both + wc -w $filename +,#+END_SRC +#+end_example + +Note that values read from tables and lists are not mistakenly +evaluated as Emacs Lisp code, as illustrated in the following example. + +#+begin_example +,#+NAME: table +| (a b c) | + +,#+HEADER: :var data=table[0,0] +,#+BEGIN_SRC perl + $data +,#+END_SRC + +,#+RESULTS: +: (a b c) +#+end_example + +*** Using sessions +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: using sessions in code blocks +#+cindex: @samp{session}, header argument +Two code blocks can share the same environment. The =session= header +argument is for running multiple source code blocks under one session. +Org runs code blocks with the same session name in the same +interpreter process. + +- =none= :: + + Default. Each code block gets a new interpreter process to execute. + The process terminates once the block is evaluated. + +- {{{var(STRING)}}} :: + + Any string besides =none= turns that string into the name of that + session. For example, =:session STRING= names it =STRING=. If + =session= has no value, then the session name is derived from the + source language identifier. Subsequent blocks with the same source + code language use the same session. Depending on the language, + state variables, code from other blocks, and the overall interpreted + environment may be shared. Some interpreted languages support + concurrent sessions when subsequent source code language blocks + change session names. + +Only languages that provide interactive evaluation can have session +support. Not all languages provide this support, such as C and ditaa. +Even languages, such as Python and Haskell, that do support +interactive evaluation impose limitations on allowable language +constructs that can run interactively. Org inherits those limitations +for those code blocks running in a session. + +*** Choosing a working directory +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: working directory, in a code block +#+cindex: @samp{dir}, header argument +#+cindex: @samp{mkdirp}, header argument +The =dir= header argument specifies the default directory during code +block execution. If it is absent, then the directory associated with +the current buffer is used. In other words, supplying =:dir +DIRECTORY= temporarily has the same effect as changing the current +directory with {{{kbd(M-x cd RET DIRECTORY)}}}, and then not setting +=dir=. Under the surface, =dir= simply sets the value of the Emacs +variable ~default-directory~. Setting =mkdirp= header argument to +a non-~nil~ value creates the directory, if necessary. + +For example, to save the plot file in the =Work/= folder of the home +directory---notice tilde is expanded: + +#+begin_example +,#+BEGIN_SRC R :file myplot.png :dir ~/Work + matplot(matrix(rnorm(100), 10), type="l") +,#+END_SRC +#+end_example + +To evaluate the code block on a remote machine, supply a remote +directory name using Tramp syntax. For example: + +#+begin_example +,#+BEGIN_SRC R :file plot.png :dir /scp:dand@yakuba.princeton.edu: + plot(1:10, main=system("hostname", intern=TRUE)) +,#+END_SRC +#+end_example + +Org first captures the text results as usual for insertion in the Org +file. Then Org also inserts a link to the remote file, thanks to +Emacs Tramp. Org constructs the remote path to the file name from +=dir= and ~default-directory~, as illustrated here: + +: [[file:/scp:dand@yakuba.princeton.edu:/home/dand/plot.png][plot.png]] + +When =dir= is used with =session=, Org sets the starting directory for +a new session. But Org does not alter the directory of an already +existing session. + +Do not use =dir= with =:exports results= or with =:exports both= to +avoid Org inserting incorrect links to remote files. That is because +Org does not expand ~default directory~ to avoid some underlying +portability issues. + +*** Inserting headers and footers +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: headers, in code blocks +#+cindex: footers, in code blocks +#+cindex: @samp{prologue}, header argument +The =prologue= header argument is for appending to the top of the code +block for execution, like a reset instruction. For example, you may +use =:prologue "reset"= in a Gnuplot code block or, for every such +block: + +#+begin_src emacs-lisp +(add-to-list 'org-babel-default-header-args:gnuplot + '((:prologue . "reset"))) + +#+end_src + +#+cindex: @samp{epilogue}, header argument +Likewise, the value of the =epilogue= header argument is for appending +to the end of the code block for execution. + +** Evaluating Code Blocks +:PROPERTIES: +:DESCRIPTION: Place results of evaluation in the Org buffer. +:END: +#+cindex: code block, evaluating +#+cindex: source code, evaluating +#+cindex: @samp{RESULTS}, keyword + +A note about security: With code evaluation comes the risk of harm. +Org safeguards by prompting for user's permission before executing any +code in the source block. To customize this safeguard, or disable it, +see [[*Code Evaluation and Security Issues]]. + +*** How to evaluate source code +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Org captures the results of the code block evaluation and inserts them +in the Org file, right after the code block. The insertion point is +after a newline and the =RESULTS= keyword. Org creates the =RESULTS= +keyword if one is not already there. + +By default, Org enables only Emacs Lisp code blocks for execution. +See [[*Languages]] to enable other languages. + +#+kindex: C-c C-c +#+kindex: C-c C-v e +#+findex: org-babel-execute-src-block +Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or +{{{kbd(C-c C-v e)}}} with the point on a code block[fn:141] calls the +~org-babel-execute-src-block~ function, which executes the code in the +block, collects the results, and inserts them in the buffer. + +#+cindex: @samp{CALL}, keyword +#+vindex: org-babel-inline-result-wrap +By calling a named code block[fn:142] from an Org mode buffer or +a table. Org can call the named code blocks from the current Org mode +buffer or from the "Library of Babel" (see [[*Library of Babel]]). + +The syntax for =CALL= keyword is: + +#+begin_example +,#+CALL: <name>(<arguments>) +,#+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments> +#+end_example + +The syntax for inline named code blocks is: + +#+begin_example +... call_<name>(<arguments>) ... +... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ... +#+end_example + +When inline syntax is used, the result is wrapped based on the +variable ~org-babel-inline-result-wrap~, which by default is set to +~"=%s="~ to produce verbatim text suitable for markup. + +- =<name>= :: + + This is the name of the code block (see [[*Structure of Code Blocks]]) + to be evaluated in the current document. If the block is located in + another file, start =<name>= with the file name followed by + a colon. For example, in order to execute a block named =clear-data= + in =file.org=, you can write the following: + + : #+CALL: file.org:clear-data() + +- =<arguments>= :: + + Org passes arguments to the code block using standard function call + syntax. For example, a =#+CALL:= line that passes =4= to a code + block named =double=, which declares the header argument =:var n=2=, + would be written as: + + : #+CALL: double(n=4) + + #+texinfo: @noindent + Note how this function call syntax is different from the header + argument syntax. + +- =<inside header arguments>= :: + + Org passes inside header arguments to the named code block using the + header argument syntax. Inside header arguments apply to code block + evaluation. For example, =[:results output]= collects results + printed to stdout during code execution of that block. Note how + this header argument syntax is different from the function call + syntax. + +- =<end header arguments>= :: + + End header arguments affect the results returned by the code block. + For example, =:results html= wraps the results in a =#+BEGIN_EXPORT + html= block before inserting the results in the Org buffer. + +*** Limit code block evaluation +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{eval}, header argument +#+cindex: control code block evaluation +The =eval= header argument can limit evaluation of specific code +blocks and =CALL= keyword. It is useful for protection against +evaluating untrusted code blocks by prompting for a confirmation. + +- =never= or =no= :: + + Org never evaluates the source code. + +- =query= :: + + Org prompts the user for permission to evaluate the source code. + +- =never-export= or =no-export= :: + + Org does not evaluate the source code when exporting, yet the user + can evaluate it interactively. + +- =query-export= :: + + Org prompts the user for permission to evaluate the source code + during export. + +If =eval= header argument is not set, then Org determines whether to +evaluate the source code from the ~org-confirm-babel-evaluate~ +variable (see [[*Code Evaluation and Security Issues]]). + +*** Cache results of evaluation +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{cache}, header argument +#+cindex: cache results of code evaluation +The =cache= header argument is for caching results of evaluating code +blocks. Caching results can avoid re-evaluating a code block that +have not changed since the previous run. To benefit from the cache +and avoid redundant evaluations, the source block must have a result +already present in the buffer, and neither the header +arguments---including the value of =var= references---nor the text of +the block itself has changed since the result was last computed. This +feature greatly helps avoid long-running calculations. For some edge +cases, however, the cached results may not be reliable. + +The caching feature is best for when code blocks are pure functions, +that is functions that return the same value for the same input +arguments (see [[*Environment of a Code Block]]), and that do not have +side effects, and do not rely on external variables other than the +input arguments. Functions that depend on a timer, file system +objects, and random number generators are clearly unsuitable for +caching. + +A note of warning: when =cache= is used in a session, caching may +cause unexpected results. + +When the caching mechanism tests for any source code changes, it does +not expand noweb style references (see [[*Noweb Reference Syntax]]). + +The =cache= header argument can have one of two values: =yes= or =no=. + +- =no= :: + + Default. No caching of results; code block evaluated every time. + +- =yes= :: + + Whether to run the code or return the cached results is determined + by comparing the SHA1 hash value of the combined code block and + arguments passed to it. This hash value is packed on the + =#+RESULTS:= line from previous evaluation. When hash values match, + Org does not evaluate the code block. When hash values mismatch, + Org evaluates the code block, inserts the results, recalculates the + hash value, and updates =#+RESULTS:= line. + +In this example, both functions are cached. But =caller= runs only if +the result from =random= has changed since the last run. + +#+begin_example +,#+NAME: random +,#+BEGIN_SRC R :cache yes + runif(1) +,#+END_SRC + +,#+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random +0.4659510825295 + +,#+NAME: caller +,#+BEGIN_SRC emacs-lisp :var x=random :cache yes + x +,#+END_SRC + +,#+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller +0.254227238707244 +#+end_example + +** Results of Evaluation +:PROPERTIES: +:DESCRIPTION: Choosing a results type, post-processing... +:END: +#+cindex: code block, results of evaluation +#+cindex: source code, results of evaluation + +#+cindex: @samp{results}, header argument +How Org handles results of a code block execution depends on many +header arguments working together. The primary determinant, however, +is the =results= header argument. It accepts four classes of options. +Each code block can take only one option per class: + +- Collection :: + + For how the results should be collected from the code block; + +- Type :: + + For which type of result the code block will return; affects how Org + processes and inserts results in the Org buffer; + +- Format :: + + For the result; affects how Org processes results; + +- Handling :: + + For inserting results once they are properly formatted. + +*** Collection +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Collection options specify the results. Choose one of the options; +they are mutually exclusive. + +- =value= :: + + Default for most Babel libraries[fn:142]. Functional mode. Org + gets the value by wrapping the code in a function definition in the + language of the source block. That is why when using =:results + value=, code should execute like a function and return a value. For + languages like Python, an explicit ~return~ statement is mandatory + when using =:results value=. Result is the value returned by the + last statement in the code block. + + When evaluating the code block in a session (see [[*Environment of + a Code Block]]), Org passes the code to an interpreter running as an + interactive Emacs inferior process. Org gets the value from the + source code interpreter's last statement output. Org has to use + language-specific methods to obtain the value. For example, from + the variable ~_~ in Ruby, and the value of ~.Last.value~ in R. + +- =output= :: + + Scripting mode. Org passes the code to an external process running + the interpreter. Org returns the contents of the standard output + stream as text results. + + When using a session, Org passes the code to the interpreter running + as an interactive Emacs inferior process. Org concatenates any text + output from the interpreter and returns the collection as a result. + +*** Type +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Type tells what result types to expect from the execution of the code +block. Choose one of the options; they are mutually exclusive. The +default behavior is to automatically determine the result type. + +#+attr_texinfo: :sep , +- =table=, =vector= :: + + Interpret the results as an Org table. If the result is a single + value, create a table with one row and one column. Usage example: + =:results value table=. + + #+cindex: @samp{hlines}, header argument + In-between each table row or below the table headings, sometimes + results have horizontal lines, which are also known as "hlines". + The =hlines= argument with the default =no= value strips such lines + from the input table. For most code, this is desirable, or else + those =hline= symbols raise unbound variable errors. A =yes= + accepts such lines, as demonstrated in the following example. + + #+begin_example + ,#+NAME: many-cols + | a | b | c | + |---+---+---| + | d | e | f | + |---+---+---| + | g | h | i | + + ,#+NAME: no-hline + ,#+BEGIN_SRC python :var tab=many-cols :hlines no + return tab + ,#+END_SRC + + ,#+RESULTS: no-hline + | a | b | c | + | d | e | f | + | g | h | i | + + ,#+NAME: hlines + ,#+BEGIN_SRC python :var tab=many-cols :hlines yes + return tab + ,#+END_SRC + + ,#+RESULTS: hlines + | a | b | c | + |---+---+---| + | d | e | f | + |---+---+---| + | g | h | i | + #+end_example + +- =list= :: + + Interpret the results as an Org list. If the result is a single + value, create a list of one element. + +- =scalar=, =verbatim= :: + + Interpret literally and insert as quoted text. Do not create + a table. Usage example: =:results value verbatim=. + +- =file= :: + + Interpret as a filename. Save the results of execution of the code + block to that file, then insert a link to it. You can control both + the filename and the description associated to the link. + + #+cindex: @samp{file}, header argument + #+cindex: @samp{output-dir}, header argument + Org first tries to generate the filename from the value of the + =file= header argument and the directory specified using the + =output-dir= header arguments. If =output-dir= is not specified, + Org assumes it is the current directory. + + #+begin_example + ,#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/ + size(2cm); + draw(unitcircle); + ,#+END_SRC + #+end_example + + #+cindex: @samp{file-ext}, header argument + If =file= header argument is missing, Org generates the base name of + the output file from the name of the code block, and its extension + from the =file-ext= header argument. In that case, both the name + and the extension are mandatory. + + #+begin_example + ,#+name: circle + ,#+BEGIN_SRC asymptote :results value file :file-ext pdf + size(2cm); + draw(unitcircle); + ,#+END_SRC + #+end_example + + #+cindex: @samp{file-desc}, header argument + The =file-desc= header argument defines the description (see + [[*Link Format]]) for the link. If =file-desc= is present but has no value, + the =file= value is used as the link description. When this + argument is not present, the description is omitted. + + #+cindex: @samp{sep}, header argument + By default, Org assumes that a table written to a file has + TAB-delimited output. You can choose a different separator with + the =sep= header argument. + + #+cindex: @samp{file-mode}, header argument + The =file-mode= header argument defines the file permissions. To + make it executable, use =:file-mode (identity #o755)=. + + #+begin_example + ,#+BEGIN_SRC shell :results file :file script.sh :file-mode (identity #o755) + echo "#!/bin/bash" + echo "echo Hello World" + ,#+END_SRC + #+end_example + +*** Format +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Format pertains to the type of the result returned by the code block. +Choose one of the options; they are mutually exclusive. The default +follows from the type specified above. + +#+attr_texinfo: :sep , +- =code= :: + + Result enclosed in a code block. Useful for parsing. Usage + example: =:results value code=. + +- =drawer= :: + + Result wrapped in a =RESULTS= drawer. Useful for containing =raw= + or =org= results for later scripting and automated processing. + Usage example: =:results value drawer=. + +- =html= :: + + Results enclosed in a =BEGIN_EXPORT html= block. Usage example: + =:results value html=. + +- =latex= :: + + Results enclosed in a =BEGIN_EXPORT latex= block. Usage example: + =:results value latex=. + +- =link=, =graphics= :: + + When used along with =file= type, the result is a link to the file + specified in =:file= header argument. However, unlike plain =file= + type, nothing is written to the disk. The block is used for its + side-effects only, as in the following example: + + #+begin_example + ,#+begin_src shell :results file link :file "download.tar.gz" + wget -c "http://example.com/download.tar.gz" + ,#+end_src + #+end_example + +- =org= :: + + Results enclosed in a =BEGIN_SRC org= block. For comma-escape, + either {{{kbd(TAB)}}} in the block, or export the file. Usage + example: =:results value org=. + +- =pp= :: + + Result converted to pretty-print source code. Enclosed in a code + block. Languages supported: Emacs Lisp, Python, and Ruby. Usage + example: =:results value pp=. + +- =raw= :: + + Interpreted as raw Org mode. Inserted directly into the buffer. + Aligned if it is a table. Usage example: =:results value raw=. + +#+cindex: @samp{wrap}, header argument +The =wrap= header argument unconditionally marks the results block by +appending strings to =#+BEGIN_= and =#+END_=. If no string is +specified, Org wraps the results in a =#+BEGIN_results= +... =#+END_results= block. It takes precedent over the =results= +value listed above. E.g., + +#+begin_example +,#+BEGIN_SRC emacs-lisp :results html :wrap EXPORT markdown +"<blink>Welcome back to the 90's</blink>" +,#+END_SRC + +,#+RESULTS: +,#+BEGIN_EXPORT markdown +<blink>Welcome back to the 90's</blink> +,#+END_EXPORT +#+end_example + +*** Handling +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Handling options after collecting the results. + +- =silent= :: + + Do not insert results in the Org mode buffer, but echo them in the + minibuffer. Usage example: =:results output silent=. + +- =replace= :: + + Default. Insert results in the Org buffer. Remove previous + results. Usage example: =:results output replace=. + +- =append= :: + + Append results to the Org buffer. Latest results are at the bottom. + Does not remove previous results. Usage example: =:results output + append=. + +- =prepend= :: + + Prepend results to the Org buffer. Latest results are at the top. + Does not remove previous results. Usage example: =:results output + prepend=. + +*** Post-processing +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{post}, header argument +#+cindex: @samp{*this*}, in @samp{post} header argument +The =post= header argument is for post-processing results from block +evaluation. When =post= has any value, Org binds the results to +~*this*~ variable for easy passing to =var= header argument +specifications (see [[*Environment of a Code Block]]). That makes results +available to other code blocks, or even for direct Emacs Lisp code +execution. + +The following two examples illustrate =post= header argument in +action. The first one shows how to attach an =ATTR_LATEX= keyword +using =post=. + +#+begin_example +,#+NAME: attr_wrap +,#+BEGIN_SRC sh :var data="" :var width="\\textwidth" :results output + echo "#+ATTR_LATEX: :width $width" + echo "$data" +,#+END_SRC + +,#+HEADER: :file /tmp/it.png +,#+BEGIN_SRC dot :post attr_wrap(width="5cm", data=*this*) :results drawer + digraph{ + a -> b; + b -> c; + c -> a; + } +,#+end_src + +,#+RESULTS: +:RESULTS: +,#+ATTR_LATEX :width 5cm +[[file:/tmp/it.png]] +:END: +#+end_example + +The second example shows use of =colnames= header argument in =post= +to pass data between code blocks. + +#+begin_example +,#+NAME: round-tbl +,#+BEGIN_SRC emacs-lisp :var tbl="" fmt="%.3f" + (mapcar (lambda (row) + (mapcar (lambda (cell) + (if (numberp cell) + (format fmt cell) + cell)) + row)) + tbl) +,#+end_src + +,#+BEGIN_SRC R :colnames yes :post round-tbl[:colnames yes](*this*) + set.seed(42) + data.frame(foo=rnorm(1)) +,#+END_SRC + +,#+RESULTS: +| foo | +|-------| +| 1.371 | +#+end_example + +** Exporting Code Blocks +:PROPERTIES: +:DESCRIPTION: Export contents and/or results. +:END: +#+cindex: code block, exporting +#+cindex: source code, exporting + +It is possible to export the /code/ of code blocks, the /results/ of +code block evaluation, /both/ the code and the results of code block +evaluation, or /none/. Org defaults to exporting /code/ for most +languages. For some languages, such as ditaa, Org defaults to +/results/. To export just the body of code blocks, see [[*Literal +Examples]]. To selectively export sub-trees of an Org document, see +[[*Exporting]]. + +#+cindex: @samp{exports}, header argument +The =exports= header argument is to specify if that part of the Org +file is exported to, say, HTML or LaTeX formats. + +- =code= :: + + The default. The body of code is included into the exported file. + Example: =:exports code=. + +- =results= :: + + The results of evaluation of the code is included in the exported + file. Example: =:exports results=. + +- =both= :: + + Both the code and results of evaluation are included in the exported + file. Example: =:exports both=. + +- =none= :: + + Neither the code nor the results of evaluation is included in the + exported file. Whether the code is evaluated at all depends on + other options. Example: =:exports none=. + +#+vindex: org-export-use-babel +To stop Org from evaluating code blocks to speed exports, use the +header argument =:eval never-export= (see [[*Evaluating Code Blocks]]). +To stop Org from evaluating code blocks for greater security, set the +~org-export-use-babel~ variable to ~nil~, but understand that header +arguments will have no effect. + +Turning off evaluation comes in handy when batch processing. For +example, markup languages for wikis, which have a high risk of +untrusted code. Stopping code block evaluation also stops evaluation +of all header arguments of the code block. This may not be desirable +in some circumstances. So during export, to allow evaluation of just +the header arguments but not any code evaluation in the source block, +set =:eval never-export= (see [[*Evaluating Code Blocks]]). + +Org never evaluates code blocks in commented sub-trees when exporting +(see [[*Comment Lines]]). On the other hand, Org does evaluate code +blocks in sub-trees excluded from export (see [[*Export Settings]]). + +** Extracting Source Code +:PROPERTIES: +:DESCRIPTION: Create pure source code files. +:END: +#+cindex: tangling +#+cindex: source code, extracting +#+cindex: code block, extracting source code + +Extracting source code from code blocks is a basic task in literate +programming. Org has features to make this easy. In literate +programming parlance, documents on creation are /woven/ with code and +documentation, and on export, the code is tangled for execution by +a computer. Org facilitates weaving and tangling for producing, +maintaining, sharing, and exporting literate programming documents. +Org provides extensive customization options for extracting source +code. + +When Org tangles code blocks, it expands, merges, and transforms them. +Then Org recomposes them into one or more separate files, as +configured through the options. During this tangling process, Org +expands variables in the source code, and resolves any noweb style +references (see [[*Noweb Reference Syntax]]). + +*** Header arguments +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+cindex: @samp{tangle}, header argument +The =tangle= header argument specifies if the code block is exported +to source file(s). + +- =yes= :: + + Export the code block to source file. The file name for the source + file is derived from the name of the Org file, and the file + extension is derived from the source code language identifier. + Example: =:tangle yes=. + +- =no= :: + + The default. Do not extract the code in a source code file. + Example: =:tangle no=. + +- {{{var(FILENAME)}}} :: + + Export the code block to source file whose file name is derived from + any string passed to the =tangle= header argument. Org derives the + file name as being relative to the directory of the Org file's + location. Example: =:tangle FILENAME=. + +#+cindex: @samp{mkdirp}, header argument +The =mkdirp= header argument creates parent directories for tangled +files if the directory does not exist. A =yes= value enables +directory creation whereas =no= inhibits it. + +#+cindex: @samp{comments}, header argument +The =comments= header argument controls inserting comments into +tangled files. These are above and beyond whatever comments may +already exist in the code block. + +- =no= :: + + The default. Do not insert any extra comments during tangling. + +- =link= :: + + Wrap the code block in comments. Include links pointing back to the + place in the Org file from where the code was tangled. + +- =yes= :: + + Kept for backward compatibility; same as =link=. + +- =org= :: + + Nearest headline text from Org file is inserted as comment. The + exact text that is inserted is picked from the leading context of + the source block. + +- =both= :: + + Includes both =link= and =org= options. + +- =noweb= :: + + Includes =link= option, expands noweb references (see [[*Noweb + Reference Syntax]]), and wraps them in link comments inside the body + of the code block. + +#+cindex: @samp{padline}, header argument +The =padline= header argument controls insertion of newlines to pad +source code in the tangled file. + +- =yes= :: + + Default. Insert a newline before and after each code block in the + tangled file. + +- =no= :: + + Do not insert newlines to pad the tangled code blocks. + +#+cindex: @samp{shebang}, header argument +The =shebang= header argument can turn results into executable script +files. By setting it to a string value---for example, =:shebang +"#!/bin/bash"=---Org inserts that string as the first line of the +tangled file that the code block is extracted to. Org then turns on +the tangled file's executable permission. + +#+cindex: @samp{tangle-mode}, header argument +The =tangle-mode= header argument specifies what permissions to set +for tangled files by ~set-file-modes~. For example, to make +a read-only tangled file, use =:tangle-mode (identity #o444)=. To +make it executable, use =:tangle-mode (identity #o755)=. It also +overrides executable permission granted by =shebang=. When multiple +source code blocks tangle to a single file with different and +conflicting =tangle-mode= header arguments, Org's behavior is +undefined. + +#+cindex: @samp{no-expand}, header argument +By default Org expands code blocks during tangling. The =no-expand= +header argument turns off such expansions. Note that one side-effect +of expansion by ~org-babel-expand-src-block~ also assigns values (see +[[*Environment of a Code Block]]) to variables. Expansions also replace +noweb references with their targets (see [[*Noweb Reference Syntax]]). +Some of these expansions may cause premature assignment, hence this +option. This option makes a difference only for tangling. It has no +effect when exporting since code blocks for execution have to be +expanded anyway. + +*** Functions +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- ~org-babel-tangle~ :: + + #+findex: org-babel-tangle + #+kindex: C-c C-v t + Tangle the current file. Bound to {{{kbd(C-c C-v t)}}}. + + With prefix argument only tangle the current code block. + +- ~org-babel-tangle-file~ :: + + #+findex: org-babel-tangle-file + #+kindex: C-c C-v f + Choose a file to tangle. Bound to {{{kbd(C-c C-v f)}}}. + +*** Hooks +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- ~org-babel-post-tangle-hook~ :: + + #+vindex: org-babel-post-tangle-hook + This hook is run from within code files tangled by + ~org-babel-tangle~, making it suitable for post-processing, + compilation, and evaluation of code in the tangled files. + +*** Jumping between code and Org +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +#+findex: org-babel-tangle-jump-to-org +Debuggers normally link errors and messages back to the source code. +But for tangled files, we want to link back to the Org file, not to +the tangled source file. To make this extra jump, Org uses +~org-babel-tangle-jump-to-org~ function with two additional source +code block header arguments: + +1. Set =padline= to true---this is the default setting. +2. Set =comments= to =link=, which makes Org insert links to the Org + file. + +** Languages +:PROPERTIES: +:DESCRIPTION: List of supported code block languages. +:END: +#+cindex: babel, languages +#+cindex: source code, languages +#+cindex: code block, languages + +Code blocks in the following languages are supported. + +#+attr_texinfo: :columns 0.25 0.25 0.25 0.20 +| Language | Identifier | Language | Identifier | +|------------+---------------+----------------+--------------| +| Asymptote | =asymptote= | Lisp | =lisp= | +| Awk | =awk= | Lua | =lua= | +| C | =C= | MATLAB | =matlab= | +| C++ | =C++=[fn:143] | Mscgen | =mscgen= | +| Clojure | =clojure= | Objective Caml | =ocaml= | +| CSS | =css= | Octave | =octave= | +| D | =D=[fn:144] | Org mode | =org= | +| ditaa | =ditaa= | Oz | =oz= | +| Emacs Calc | =calc= | Perl | =perl= | +| Emacs Lisp | =emacs-lisp= | Plantuml | =plantuml= | +| Eshell | =eshell= | Processing.js | =processing= | +| Fortran | =fortran= | Python | =python= | +| Gnuplot | =gnuplot= | R | =R= | +| GNU Screen | =screen= | Ruby | =ruby= | +| Graphviz | =dot= | Sass | =sass= | +| Haskell | =haskell= | Scheme | =scheme= | +| Java | =java= | Sed | =sed= | +| Javascript | =js= | shell | =sh= | +| LaTeX | =latex= | SQL | =sql= | +| Ledger | =ledger= | SQLite | =sqlite= | +| Lilypond | =lilypond= | Vala | =vala= | + +Additional documentation for some languages is at +https://orgmode.org/worg/org-contrib/babel/languages.html. + +#+vindex: org-babel-load-languages +By default, only Emacs Lisp is enabled for evaluation. To enable or +disable other languages, customize the ~org-babel-load-languages~ +variable either through the Emacs customization interface, or by +adding code to the init file as shown next. + +In this example, evaluation is disabled for Emacs Lisp, and enabled +for R. + +#+begin_src emacs-lisp +(org-babel-do-load-languages + 'org-babel-load-languages + '((emacs-lisp . nil) + (R . t))) +#+end_src + +Note that this is not the only way to enable a language. Org also +enables languages when loaded with ~require~ statement. For example, +the following enables execution of Clojure code blocks: + +#+begin_src emacs-lisp +(require 'ob-clojure) +#+end_src + +** Editing Source Code +:PROPERTIES: +:DESCRIPTION: Language major-mode editing. +:END: +#+cindex: code block, editing +#+cindex: source code, editing + +#+kindex: C-c ' +Use {{{kbd(C-c ')}}} to edit the current code block. It opens a new +major mode edit buffer containing the body of the source code block, +ready for any edits. Use {{{kbd(C-c ')}}} again to close the buffer +and return to the Org buffer. + +#+kindex: C-x C-s +#+vindex: org-edit-src-auto-save-idle-delay +#+cindex: auto-save, in code block editing +{{{kbd(C-x C-s)}}} saves the buffer and updates the contents of the +Org buffer. Set ~org-edit-src-auto-save-idle-delay~ to save the base +buffer after a certain idle delay time. Set +~org-edit-src-turn-on-auto-save~ to auto-save this buffer into +a separate file using Auto-save mode. + +While editing the source code in the major mode, the Org Src minor +mode remains active. It provides these customization variables as +described below. For even more variables, look in the customization +group ~org-edit-structure~. + +- ~org-src-lang-modes~ :: + + #+vindex: org-src-lang-modes + If an Emacs major-mode named ~<LANG>-mode~ exists, where + {{{var(<LANG>)}}} is the language identifier from code block's + header line, then the edit buffer uses that major mode. Use this + variable to arbitrarily map language identifiers to major modes. + +- ~org-src-window-setup~ :: + + #+vindex: org-src-window-setup + For specifying Emacs window arrangement when the new edit buffer is + created. + +- ~org-src-preserve-indentation~ :: + + #+cindex: indentation, in code blocks + #+vindex: org-src-preserve-indentation + Default is ~nil~. Source code is indented. This indentation + applies during export or tangling, and depending on the context, may + alter leading spaces and tabs. When non-~nil~, source code is + aligned with the leftmost column. No lines are modified during + export or tangling, which is very useful for white-space sensitive + languages, such as Python. + +- ~org-src-ask-before-returning-to-edit-buffer~ :: + + #+vindex: org-src-ask-before-returning-to-edit-buffer + When ~nil~, Org returns to the edit buffer without further prompts. + The default prompts for a confirmation. + +#+vindex: org-src-fontify-natively +#+vindex: org-src-block-faces +Set ~org-src-fontify-natively~ to non-~nil~ to turn on native code +fontification in the /Org/ buffer. Fontification of code blocks can +give visual separation of text and code on the display page. To +further customize the appearance of ~org-block~ for specific +languages, customize ~org-src-block-faces~. The following example +shades the background of regular blocks, and colors source blocks only +for Python and Emacs Lisp languages. + +#+begin_src emacs-lisp +(require 'color) +(set-face-attribute 'org-block nil :background + (color-darken-name + (face-attribute 'default :background) 3)) + +(setq org-src-block-faces '(("emacs-lisp" (:background "#EEE2FF")) + ("python" (:background "#E5FFB8")))) +#+end_src + +** Noweb Reference Syntax +:PROPERTIES: +:DESCRIPTION: Literate programming in Org mode. +:END: +#+cindex: code block, noweb reference +#+cindex: syntax, noweb +#+cindex: source code, noweb reference + +#+cindex: @samp{noweb-ref}, header argument +Source code blocks can include references to other source code blocks, +using a noweb[fn:145] style syntax: + +: <<CODE-BLOCK-ID>> + +#+texinfo: @noindent +where {{{var(CODE-BLOCK-ID)}}} refers to either the =NAME= of a single +source code block, or a collection of one or more source code blocks +sharing the same =noweb-ref= header argument (see [[*Using Header +Arguments]]). Org can replace such references with the source code of +the block or blocks being referenced, or, in the case of a single +source code block named with =NAME=, with the results of an evaluation +of that block. + +#+cindex: @samp{noweb}, header argument +The =noweb= header argument controls expansion of noweb syntax +references. Expansions occur when source code blocks are evaluated, +tangled, or exported. + +- =no= :: + + Default. No expansion of noweb syntax references in the body of the + code when evaluating, tangling, or exporting. + +- =yes= :: + + Expansion of noweb syntax references in the body of the code block + when evaluating, tangling, or exporting. + +- =tangle= :: + + Expansion of noweb syntax references in the body of the code block + when tangling. No expansion when evaluating or exporting. + +- =no-export= :: + + Expansion of noweb syntax references in the body of the code block + when evaluating or tangling. No expansion when exporting. + +- =strip-export= :: + + Expansion of noweb syntax references in the body of the code block + when expanding prior to evaluating or tangling. Removes noweb + syntax references when exporting. + +- =eval= :: + + Expansion of noweb syntax references in the body of the code block + only before evaluating. + +In the most simple case, the contents of a single source block is +inserted within other blocks. Thus, in following example, + +#+begin_example +,#+NAME: initialization +,#+BEGIN_SRC emacs-lisp + (setq sentence "Never a foot too far, even.") +,#+END_SRC + +,#+BEGIN_SRC emacs-lisp :noweb yes + <<initialization>> + (reverse sentence) +,#+END_SRC +#+end_example + +#+texinfo: @noindent +the second code block is expanded as + +#+begin_example +,#+BEGIN_SRC emacs-lisp :noweb yes + (setq sentence "Never a foot too far, even.") + (reverse sentence) +,#+END_SRC +#+end_example + +You may also include the contents of multiple blocks sharing a common +=noweb-ref= header argument, which can be set at the file, sub-tree, +or code block level. In the example Org file shown next, the body of +the source code in each block is extracted for concatenation to a pure +code file when tangled. + +#+begin_example +,#+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh + <<fullest-disk>> +,#+END_SRC +,* the mount point of the fullest disk + :PROPERTIES: + :header-args: :noweb-ref fullest-disk + :END: + +,** query all mounted disks +,#+BEGIN_SRC sh + df \ +,#+END_SRC + +,** strip the header row +,#+BEGIN_SRC sh + |sed '1d' \ +,#+END_SRC + +,** output mount point of fullest disk +,#+BEGIN_SRC sh + |awk '{if (u < +$5) {u = +$5; m = $6}} END {print m}' +,#+END_SRC +#+end_example + +#+cindex: @samp{noweb-sep}, header argument +By default a newline separates each noweb reference concatenation. To +use a different separator, edit the =noweb-sep= header argument. + +Alternatively, Org can include the results of evaluation of a single +code block rather than its body. Evaluation occurs when parentheses, +possibly including arguments, are appended to the code block name, as +shown below. + +: <<NAME(optional arguments)>> + +Note that in this case, a code block name set by =NAME= keyword is +required; the reference set by =noweb-ref= will not work when +evaluation is desired. + +Here is an example that demonstrates how the exported content changes +when noweb style references are used with parentheses versus without. +Given: + +#+begin_example +,#+NAME: some-code +,#+BEGIN_SRC python :var num=0 :results output :exports none + print(num*10) +,#+END_SRC +#+end_example + +#+texinfo: @noindent +this code block: + +#+begin_example +,#+BEGIN_SRC text :noweb yes + <<some-code>> +,#+END_SRC +#+end_example + +#+texinfo: @noindent +expands to: + +: print(num*10) + +Below, a similar noweb style reference is used, but with parentheses, +while setting a variable =num= to 10: + +#+begin_example +,#+BEGIN_SRC text :noweb yes + <<some-code(num=10)>> +,#+END_SRC +#+end_example + +#+texinfo: @noindent +Note that the expansion now contains the results of the code block +=some-code=, not the code block itself: + +: 100 + +Noweb insertions honor prefix characters that appear before the noweb +syntax reference. This behavior is illustrated in the following +example. Because the =<<example>>= noweb reference appears behind the +SQL comment syntax, each line of the expanded noweb reference is +commented. With: + +#+begin_example +,#+NAME: example +,#+BEGIN_SRC text + this is the + multi-line body of example +,#+END_SRC +#+end_example + +#+texinfo: @noindent +this code block: + +#+begin_example +,#+BEGIN_SRC sql :noweb yes + ---<<example>> +,#+END_SRC +#+end_example + +#+texinfo: @noindent +expands to: + +#+begin_example +,#+BEGIN_SRC sql :noweb yes + ---this is the + ---multi-line body of example +,#+END_SRC +#+end_example + +Since this change does not affect noweb replacement text without +newlines in them, inline noweb references are acceptable. + +This feature can also be used for management of indentation in +exported code snippets. With: + +#+begin_example +,#+NAME: if-true +,#+BEGIN_SRC python :exports none + print('do things when true') +,#+end_src + +,#+name: if-false +,#+begin_src python :exports none + print('do things when false') +,#+end_src +#+end_example + +#+texinfo: @noindent +this code block: + +#+begin_example +,#+begin_src python :noweb yes :results output + if true: + <<if-true>> + else: + <<if-false>> +,#+end_src +#+end_example + +#+texinfo: @noindent +expands to: + +#+begin_example +if true: + print('do things when true') +else: + print('do things when false') +#+end_example + +When in doubt about the outcome of a source code block expansion, you +can preview the results with the following command: + +- {{{kbd(C-c C-v v)}}} or {{{kbd(C-c C-v C-v)}}} (~org-babel-expand-src-block~) :: + + #+findex: org-babel-expand-src-block + #+kindex: C-c C-v v + #+kindex: C-c C-v C-v + Expand the current source code block according to its header + arguments and pop open the results in a preview buffer. + +** Library of Babel +:PROPERTIES: +:DESCRIPTION: Use and contribute to a library of useful code blocks. +:END: +#+cindex: babel, library of +#+cindex: source code, library +#+cindex: code block, library + +The "Library of Babel" is a collection of code blocks. Like +a function library, these code blocks can be called from other Org +files. A collection of useful code blocks is available on [[https://orgmode.org/worg/library-of-babel.html][Worg]]. For +remote code block evaluation syntax, see [[*Evaluating Code Blocks]]. + +#+kindex: C-c C-v i +#+findex: org-babel-lob-ingest +For any user to add code to the library, first save the code in +regular code blocks of an Org file, and then load the Org file with +~org-babel-lob-ingest~, which is bound to {{{kbd(C-c C-v i)}}}. + +** Key bindings and Useful Functions +:PROPERTIES: +:DESCRIPTION: Work quickly with code blocks. +:END: +#+cindex: code block, key bindings + +Many common Org mode key sequences are re-bound depending on +the context. + +Active key bindings in code blocks: + +#+kindex: C-c C-c +#+findex: org-babel-execute-src-block +#+kindex: C-c C-o +#+findex: org-babel-open-src-block-result +#+kindex: M-UP +#+findex: org-babel-load-in-session +#+kindex: M-DOWN +#+findex: org-babel-pop-to-session +#+attr_texinfo: :columns 0.2 0.55 +| Key binding | Function | +|--------------------+-----------------------------------| +| {{{kbd(C-c C-c)}}} | ~org-babel-execute-src-block~ | +| {{{kbd(C-c C-o)}}} | ~org-babel-open-src-block-result~ | +| {{{kbd(M-UP)}}} | ~org-babel-load-in-session~ | +| {{{kbd(M-DOWN)}}} | ~org-babel-pop-to-session~ | + +Active key bindings in Org mode buffer: + +#+kindex: C-c C-v p +#+kindex: C-c C-v C-p +#+kindex: C-c C-v n +#+kindex: C-c C-v C-n +#+kindex: C-c C-v e +#+kindex: C-c C-v C-e +#+kindex: C-c C-v o +#+kindex: C-c C-v C-o +#+kindex: C-c C-v v +#+kindex: C-c C-v C-v +#+kindex: C-c C-v u +#+kindex: C-c C-v C-u +#+kindex: C-c C-v g +#+kindex: C-c C-v C-g +#+kindex: C-c C-v r +#+kindex: C-c C-v C-r +#+kindex: C-c C-v b +#+kindex: C-c C-v C-b +#+kindex: C-c C-v s +#+kindex: C-c C-v C-s +#+kindex: C-c C-v d +#+kindex: C-c C-v C-d +#+kindex: C-c C-v t +#+kindex: C-c C-v C-t +#+kindex: C-c C-v f +#+kindex: C-c C-v C-f +#+kindex: C-c C-v c +#+kindex: C-c C-v C-c +#+kindex: C-c C-v j +#+kindex: C-c C-v C-j +#+kindex: C-c C-v l +#+kindex: C-c C-v C-l +#+kindex: C-c C-v i +#+kindex: C-c C-v C-i +#+kindex: C-c C-v I +#+kindex: C-c C-v C-I +#+kindex: C-c C-v z +#+kindex: C-c C-v C-z +#+kindex: C-c C-v a +#+kindex: C-c C-v C-a +#+kindex: C-c C-v h +#+kindex: C-c C-v C-h +#+kindex: C-c C-v x +#+kindex: C-c C-v C-x +#+findex: org-babel-previous-src-block +#+findex: org-babel-next-src-block +#+findex: org-babel-execute-maybe +#+findex: org-babel-open-src-block-result +#+findex: org-babel-expand-src-block +#+findex: org-babel-goto-src-block-head +#+findex: org-babel-goto-named-src-block +#+findex: org-babel-goto-named-result +#+findex: org-babel-execute-buffer +#+findex: org-babel-execute-subtree +#+findex: org-babel-demarcate-block +#+findex: org-babel-tangle +#+findex: org-babel-tangle-file +#+findex: org-babel-check-src-block +#+findex: org-babel-insert-header-arg +#+findex: org-babel-load-in-session +#+findex: org-babel-lob-ingest +#+findex: org-babel-view-src-block-info +#+findex: org-babel-switch-to-session-with-code +#+findex: org-babel-sha1-hash +#+findex: org-babel-describe-bindings +#+findex: org-babel-do-key-sequence-in-edit-buffer +#+attr_texinfo: :columns 0.45 0.55 +| Key binding | Function | +|------------------------------------------------+--------------------------------------------| +| {{{kbd(C-c C-v p)}}} or {{{kbd(C-c C-v C-p)}}} | ~org-babel-previous-src-block~ | +| {{{kbd(C-c C-v n)}}} or {{{kbd(C-c C-v C-n)}}} | ~org-babel-next-src-block~ | +| {{{kbd(C-c C-v e)}}} or {{{kbd(C-c C-v C-e)}}} | ~org-babel-execute-maybe~ | +| {{{kbd(C-c C-v o)}}} or {{{kbd(C-c C-v C-o)}}} | ~org-babel-open-src-block-result~ | +| {{{kbd(C-c C-v v)}}} or {{{kbd(C-c C-v C-v)}}} | ~org-babel-expand-src-block~ | +| {{{kbd(C-c C-v u)}}} or {{{kbd(C-c C-v C-u)}}} | ~org-babel-goto-src-block-head~ | +| {{{kbd(C-c C-v g)}}} or {{{kbd(C-c C-v C-g)}}} | ~org-babel-goto-named-src-block~ | +| {{{kbd(C-c C-v r)}}} or {{{kbd(C-c C-v C-r)}}} | ~org-babel-goto-named-result~ | +| {{{kbd(C-c C-v b)}}} or {{{kbd(C-c C-v C-b)}}} | ~org-babel-execute-buffer~ | +| {{{kbd(C-c C-v s)}}} or {{{kbd(C-c C-v C-s)}}} | ~org-babel-execute-subtree~ | +| {{{kbd(C-c C-v d)}}} or {{{kbd(C-c C-v C-d)}}} | ~org-babel-demarcate-block~ | +| {{{kbd(C-c C-v t)}}} or {{{kbd(C-c C-v C-t)}}} | ~org-babel-tangle~ | +| {{{kbd(C-c C-v f)}}} or {{{kbd(C-c C-v C-f)}}} | ~org-babel-tangle-file~ | +| {{{kbd(C-c C-v c)}}} or {{{kbd(C-c C-v C-c)}}} | ~org-babel-check-src-block~ | +| {{{kbd(C-c C-v j)}}} or {{{kbd(C-c C-v C-j)}}} | ~org-babel-insert-header-arg~ | +| {{{kbd(C-c C-v l)}}} or {{{kbd(C-c C-v C-l)}}} | ~org-babel-load-in-session~ | +| {{{kbd(C-c C-v i)}}} or {{{kbd(C-c C-v C-i)}}} | ~org-babel-lob-ingest~ | +| {{{kbd(C-c C-v I)}}} or {{{kbd(C-c C-v C-I)}}} | ~org-babel-view-src-block-info~ | +| {{{kbd(C-c C-v z)}}} or {{{kbd(C-c C-v C-z)}}} | ~org-babel-switch-to-session-with-code~ | +| {{{kbd(C-c C-v a)}}} or {{{kbd(C-c C-v C-a)}}} | ~org-babel-sha1-hash~ | +| {{{kbd(C-c C-v h)}}} or {{{kbd(C-c C-v C-h)}}} | ~org-babel-describe-bindings~ | +| {{{kbd(C-c C-v x)}}} or {{{kbd(C-c C-v C-x)}}} | ~org-babel-do-key-sequence-in-edit-buffer~ | + +** Batch Execution +:PROPERTIES: +:DESCRIPTION: Call functions from the command line. +:END: +#+cindex: code block, batch execution +#+cindex: source code, batch execution + +Org mode features, including working with source code facilities can +be invoked from the command line. This enables building shell scripts +for batch processing, running automated system tasks, and expanding +Org mode's usefulness. + +The sample script shows batch processing of multiple files using +~org-babel-tangle~. + +#+begin_example +#!/bin/sh +# Tangle files with Org mode +# +emacs -Q --batch --eval " + (progn + (require 'ob-tangle) + (dolist (file command-line-args-left) + (with-current-buffer (find-file-noselect file) + (org-babel-tangle)))) + " "$@" +#+end_example + +* Miscellaneous +:PROPERTIES: +:DESCRIPTION: All the rest which did not fit elsewhere. +:END: + +** Completion +:PROPERTIES: +:DESCRIPTION: @kbd{M-@key{TAB}} guesses completions. +:END: +#+cindex: completion, of @TeX{} symbols +#+cindex: completion, of TODO keywords +#+cindex: completion, of dictionary words +#+cindex: completion, of option keywords +#+cindex: completion, of tags +#+cindex: completion, of property keys +#+cindex: completion, of link abbreviations +#+cindex: @TeX{} symbol completion +#+cindex: TODO keywords completion +#+cindex: dictionary word completion +#+cindex: option keyword completion +#+cindex: tag completion +#+cindex: link abbreviations, completion of + +Org has in-buffer completions. Unlike minibuffer completions, which +are useful for quick command interactions, Org's in-buffer completions +are more suitable for content creation in Org documents. Type one or +more letters and invoke the hot key to complete the text in-place. +Depending on the context and the keys, Org offers different types of +completions. No minibuffer is involved. Such mode-specific hot keys +have become an integral part of Emacs and Org provides several +shortcuts. + +- {{{kbd(M-TAB)}}} :: + #+kindex: M-TAB + + Complete word at point. + + - At the beginning of an empty headline, complete TODO keywords. + + - After =\=, complete TeX symbols supported by the exporter. + + - After =:= in a headline, complete tags. Org deduces the list of + tags from the =TAGS= in-buffer option (see [[*Setting Tags]]), the + variable ~org-tag-alist~, or from all tags used in the current + buffer. + + - After =:= and not in a headline, complete property keys. The list + of keys is constructed dynamically from all keys used in the + current buffer. + + - After =[[=, complete link abbreviations (see [[*Link Abbreviations]]). + + - After =[[*=, complete headlines in the current buffer so that they + can be used in search links like: =[[*find this headline]]= + + - After =#+=, complete the special keywords like =TYP_TODO= or + file-specific =OPTIONS=. After option keyword is complete, + pressing {{{kbd(M-TAB)}}} again inserts example settings for this + keyword. + + - After =STARTUP= keyword, complete startup items. + + - When point is anywhere else, complete dictionary words using + Ispell. + +** Structure Templates +:PROPERTIES: +:DESCRIPTION: Quick insertion of structural elements. +:END: +#+cindex: template insertion +#+cindex: insertion, of templates + +With just a few keystrokes, it is possible to insert empty structural +blocks, such as =#+BEGIN_SRC= ... =#+END_SRC=, or to wrap existing +text in such a block. + +- {{{kbd(C-c C-\,)}}} (~org-insert-structure-template~) :: + + #+findex: org-insert-structure-template + #+kindex: C-c C-, + Prompt for a type of block structure, and insert the block at point. + If the region is active, it is wrapped in the block. First prompts + the user for keys, which are used to look up a structure type from + the variable below. If the key is {{{kbd(TAB)}}}, {{{kbd(RET)}}}, + or {{{kbd(SPC)}}}, the user is prompted to enter a block type. + +#+vindex: org-structure-template-alist +Available structure types are defined in +~org-structure-template-alist~, see the docstring for adding or +changing values. + +#+cindex: Tempo +#+cindex: template expansion +#+cindex: insertion, of templates +#+vindex: org-tempo-keywords-alist +Org Tempo expands snippets to structures defined in +~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For +example, {{{kbd(< s TAB)}}} creates a code block. Enable it by +customizing ~org-modules~ or add =(require 'org-tempo)= to your Emacs +init file[fn:146]. + +#+attr_texinfo: :columns 0.1 0.9 +| {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= | +| {{{kbd(c)}}} | =#+BEGIN_CENTER= ... =#+END_CENTER= | +| {{{kbd(C)}}} | =#+BEGIN_COMMENT= ... =#+END_COMMENT= | +| {{{kbd(e)}}} | =#+BEGIN_EXAMPLE= ... =#+END_EXAMPLE= | +| {{{kbd(E)}}} | =#+BEGIN_EXPORT= ... =#+END_EXPORT= | +| {{{kbd(h)}}} | =#+BEGIN_EXPORT html= ... =#+END_EXPORT= | +| {{{kbd(l)}}} | =#+BEGIN_EXPORT latex= ... =#+END_EXPORT= | +| {{{kbd(q)}}} | =#+BEGIN_QUOTE= ... =#+END_QUOTE= | +| {{{kbd(s)}}} | =#+BEGIN_SRC= ... =#+END_SRC= | +| {{{kbd(v)}}} | =#+BEGIN_VERSE= ... =#+END_VERSE= | + +** Speed Keys +:PROPERTIES: +:DESCRIPTION: Electric commands at the beginning of a headline. +:END: +#+cindex: speed keys + +Single keystrokes can execute custom commands in an Org file when +point is on a headline. Without the extra burden of a meta or +modifier key, Speed Keys can speed navigation or execute custom +commands. Besides faster navigation, Speed Keys may come in handy on +small mobile devices that do not have full keyboards. Speed Keys may +also work on TTY devices known for their problems when entering Emacs +key chords. + +#+vindex: org-use-speed-commands +By default, Org has Speed Keys disabled. To activate Speed Keys, set +the variable ~org-use-speed-commands~ to a non-~nil~ value. To +trigger a Speed Key, point must be at the beginning of an Org +headline, before any of the stars. + +#+vindex: org-speed-commands-user +#+findex: org-speed-command-help +Org comes with a pre-defined list of Speed Keys. To add or modify +Speed Keys, customize the variable, ~org-speed-commands-user~. For +more details, see the variable's docstring. With Speed Keys +activated, {{{kbd(M-x org-speed-command-help)}}}, or {{{kbd(?)}}} when +point is at the beginning of an Org headline, shows currently active +Speed Keys, including the user-defined ones. + +** A Cleaner Outline View +:PROPERTIES: +:DESCRIPTION: Getting rid of leading stars in the outline. +:ALT_TITLE: Clean View +:END: +#+cindex: hiding leading stars +#+cindex: dynamic indentation +#+cindex: odd-levels-only outlines +#+cindex: clean outline view + +Org's outline with stars and no indents can look cluttered for short +documents. For /book-like/ long documents, the effect is not as +noticeable. Org provides an alternate stars and indentation scheme, +as shown on the right in the following table. It displays only one +star and indents text to line up with the heading: + +#+begin_example +,* Top level headline | * Top level headline +,** Second level | * Second level +,*** Third level | * Third level +some text | some text +,*** Third level | * Third level +more text | more text +,* Another top level headline | * Another top level headline +#+end_example + +Org can achieve this in two ways, (1) by just displaying the buffer in +this way without changing it, or (2) by actually indenting every line +in the desired amount with hard spaces and hiding leading stars. + +*** Org Indent Mode + +#+cindex: Indent mode +#+findex: org-indent-mode +To display the buffer in the indented view, activate Org Indent minor +mode, using {{{kbd(M-x org-indent-mode)}}}. Text lines that are not +headlines are prefixed with virtual spaces to vertically align with +the headline text[fn:147]. + +#+vindex: org-indent-indentation-per-level +To make more horizontal space, the headlines are shifted by two +characters. Configure ~org-indent-indentation-per-level~ variable for +a different number. + +#+vindex: org-indent-mode-turns-on-hiding-stars +#+vindex: org-indent-mode-turns-off-org-adapt-indentation +By default, Org Indent mode turns off ~org-adapt-indentation~ and does +hide leading stars by locally setting ~org-hide-leading-stars~ to ~t~: +only one star on each headline is visible, the rest are masked with +the same font color as the background. If you want to customize this +default behavior, see ~org-indent-mode-turns-on-hiding-stars~ and +~org-indent-mode-turns-off-org-adapt-indentation~. + +#+vindex: org-startup-indented +To globally turn on Org Indent mode for all files, customize the +variable ~org-startup-indented~. To control it for individual files, +use =STARTUP= keyword as follows: + +: #+STARTUP: indent +: #+STARTUP: noindent + +*** Hard indentation + +It is possible to use hard spaces to achieve the indentation instead, +if the bare ASCII file should have the indented look also outside +Emacs[fn:148]. With Org's support, you have to indent all lines to +line up with the outline headers. You would use these +settings[fn:149]: + + #+begin_src emacs-lisp + (setq org-adapt-indentation t + org-hide-leading-stars t + org-odd-levels-only t) + #+end_src + +- /Indentation of text below headlines/ (~org-adapt-indentation~) :: + + #+vindex: org-adapt-indentation + The first setting modifies paragraph filling, line wrapping, and + structure editing commands to preserving or adapting the indentation + as appropriate. + +- /Hiding leading stars/ (~org-hide-leading-stars~) :: + + #+vindex: org-hide-leading-stars + #+vindex: org-hide, face + The second setting makes leading stars invisible by applying the + face ~org-hide~ to them. For per-file preference, use these file + =STARTUP= options: + + #+begin_example + ,#+STARTUP: hidestars + ,#+STARTUP: showstars + #+end_example + +- /Odd levels/ (~org-odd-levels-only~) :: + + #+vindex: org-odd-levels-only + The third setting makes Org use only odd levels, 1, 3, 5, ..., in + the outline to create more indentation. On a per-file level, + control this with: + + #+begin_example + ,#+STARTUP: odd + ,#+STARTUP: oddeven + #+end_example + + To convert a file between single and double stars layouts, use + {{{kbd(M-x org-convert-to-odd-levels)}}} and {{{kbd(M-x + org-convert-to-oddeven-levels)}}}. + +** Execute commands in the active region +:PROPERTIES: +:DESCRIPTION: Execute commands on multiple items in Org or agenda view. +:END: + +#+vindex: org-loop-over-headlines-in-active-region +When in an Org buffer and the region is active, some commands will +apply to all the subtrees in the active region. For example, hitting +{{{kbd(C-c C-s)}}} when multiple headlines are within the active region will +successively prompt you for a new schedule date and time. To disable +this, set the option ~org-loop-over-headlines-in-active-region~ to +non-~t~, activate the region and run the command normally. + +#+vindex: org-agenda-loop-over-headlines-in-active-region +~org-agenda-loop-over-headlines-in-active-region~ is the equivalent +option of the agenda buffer, where you can also use [[*Bulk remote editing selected entries][bulk editing of +selected entries]]. + +Not all commands can loop in the active region and what subtrees or +headlines are considered can be refined: see the docstrings of these +options for more details. + +** Dynamic Headline Numbering +:PROPERTIES: +:DESCRIPTION: Display and update outline numbering. +:END: + +#+cindex: Org Num mode +#+cindex: number headlines +The Org Num minor mode, toggled with {{{kbd(M-x org-num-mode)}}}, +displays outline numbering on top of headlines. It also updates it +automatically upon changes to the structure of the document. + +#+vindex: org-num-max-level +#+vindex: org-num-skip-tags +#+vindex: org-num-skip-commented +#+vindex: org-num-skip-unnumbered +By default, all headlines are numbered. You can limit numbering to +specific headlines according to their level, tags, =COMMENT= keyword, +or =UNNUMBERED= property. Set ~org-num-max-level~, +~org-num-skip-tags~, ~org-num-skip-commented~, +~org-num-skip-unnumbered~, or ~org-num-skip-footnotes~ accordingly. + +#+vindex: org-num-skip-footnotes +If ~org-num-skip-footnotes~ is non-~nil~, footnotes sections (see +[[*Creating Footnotes]]) are not numbered either. + +#+vindex: org-num-face +#+vindex: org-num-format-function +You can control how the numbering is displayed by setting +~org-num-face~ and ~org-num-format-function~. + +#+vindex: org-startup-numerated +You can also turn this mode globally for all Org files by setting the +option ~org-startup-numerated~ to =t=, or locally on a file by using +=#+startup: num=. + +** The Very Busy {{{kbd(C-c C-c)}}} Key +:PROPERTIES: +:DESCRIPTION: When in doubt, press @kbd{C-c C-c}. +:END: +#+kindex: C-c C-c +#+cindex: @kbd{C-c C-c}, overview + +The {{{kbd(C-c C-c)}}} key in Org serves many purposes depending on +the context. It is probably the most over-worked, multi-purpose key +combination in Org. Its uses are well documented throughout this +manual, but here is a consolidated list for easy reference. + +- If column view (see [[*Column View]]) is on, exit column view. + +- If any highlights shown in the buffer from the creation of a sparse + tree, or from clock display, remove such highlights. + +- If point is in one of the special =KEYWORD= lines, scan the buffer + for these lines and update the information. Also reset the Org file + cache used to temporary store the contents of URLs used as values + for keywords like =SETUPFILE=. + +- If point is inside a table, realign the table. + +- If point is on a =TBLFM= keyword, re-apply the formulas to the + entire table. + +- If the current buffer is a capture buffer, close the note and file + it. With a prefix argument, also jump to the target location after + saving the note. + +- If point is on a =<<<target>>>=, update radio targets and + corresponding links in this buffer. + +- If point is on a property line or at the start or end of a property + drawer, offer property commands. + +- If point is at a footnote reference, go to the corresponding + definition, and /vice versa/. + +- If point is on a statistics cookie, update it. + +- If point is in a plain list item with a checkbox, toggle the status + of the checkbox. + +- If point is on a numbered item in a plain list, renumber the ordered + list. + +- If point is on the =#+BEGIN= line of a dynamic block, the block is + updated. + +- If point is at a timestamp, fix the day name in the timestamp. + +** Summary of In-Buffer Settings +:PROPERTIES: +:DESCRIPTION: Overview of keywords. +:ALT_TITLE: In-buffer Settings +:END: +#+cindex: in-buffer settings +#+cindex: special keywords + +In-buffer settings start with =#+=, followed by a keyword, a colon, +and then a word for each setting. Org accepts multiple settings on +the same line. Org also accepts multiple lines for a keyword. This +manual describes these settings throughout. A summary follows here. + +#+cindex: refresh set-up +{{{kbd(C-c C-c)}}} activates any changes to the in-buffer settings. +Closing and reopening the Org file in Emacs also activates the +changes. + +#+attr_texinfo: :sep , +- =#+ARCHIVE: %s_done::= :: + + #+cindex: @samp{ARCHIVE}, keyword + #+vindex: org-archive-location + Sets the archive location of the agenda file. The corresponding + variable is ~org-archive-location~. + +- =#+CATEGORY= :: + + #+cindex: @samp{CATEGORY}, keyword + Sets the category of the agenda file, which applies to the entire + document. + +- =#+COLUMNS: %25ITEM ...= :: + + #+cindex: @samp{COLUMNS}, property + Set the default format for columns view. This format applies when + columns view is invoked in locations where no =COLUMNS= property + applies. + +- =#+CONSTANTS: name1=value1 ...= :: + + #+cindex: @samp{CONSTANTS}, keyword + #+vindex: org-table-formula-constants + #+vindex: org-table-formula + Set file-local values for constants that table formulas can use. + This line sets the local variable + ~org-table-formula-constants-local~. The global version of this + variable is ~org-table-formula-constants~. + +- =#+FILETAGS: :tag1:tag2:tag3:= :: + + #+cindex: @samp{FILETAGS}, keyword + Set tags that all entries in the file inherit from, including the + top-level entries. + +- =#+LINK: linkword replace= :: + + #+cindex: @samp{LINK}, keyword + #+vindex: org-link-abbrev-alist + Each line specifies one abbreviation for one link. Use multiple + =LINK= keywords for more, see [[*Link Abbreviations]]. The + corresponding variable is ~org-link-abbrev-alist~. + +- =#+PRIORITIES: highest lowest default= :: + + #+cindex: @samp{PRIORITIES}, keyword + #+vindex: org-priority-highest + #+vindex: org-priority-lowest + #+vindex: org-priority-default + This line sets the limits and the default for the priorities. All + three must be either letters A--Z or numbers 0--9. The highest + priority must have a lower ASCII number than the lowest priority. + +- =#+PROPERTY: Property_Name Value= :: + + #+cindex: @samp{PROPERTY}, keyword + This line sets a default inheritance value for entries in the + current buffer, most useful for specifying the allowed values of + a property. + +- =#+SETUPFILE: file= :: + + #+cindex: @samp{SETUPFILE}, keyword + The setup file or a URL pointing to such file is for additional + in-buffer settings. Org loads this file and parses it for any + settings in it only when Org opens the main file. If URL is + specified, the contents are downloaded and stored in a temporary + file cache. {{{kbd(C-c C-c)}}} on the settings line parses and + loads the file, and also resets the temporary file cache. Org also + parses and loads the document during normal exporting process. Org + parses the contents of this document as if it was included in the + buffer. It can be another Org file. To visit the file---not + a URL---use {{{kbd(C-c ')}}} while point is on the line with the + file name. + +- =#+STARTUP:= :: + + #+cindex: @samp{STARTUP}, keyword + Startup options Org uses when first visiting a file. + + #+vindex: org-startup-folded + The first set of options deals with the initial visibility of the + outline tree. The corresponding variable for global default + settings is ~org-startup-folded~ with a default value of + ~showeverything~. + + | =overview= | Top-level headlines only. | + | =content= | All headlines. | + | =showall= | No folding on any entry. | + | =showeverything= | Show even drawer contents. | + + #+vindex: org-startup-indented + Dynamic virtual indentation is controlled by the variable + ~org-startup-indented~[fn:150]. + + | =indent= | Start with Org Indent mode turned on. | + | =noindent= | Start with Org Indent mode turned off. | + + #+vindex: org-startup-numerated + Dynamic virtual numeration of headlines is controlled by the variable + ~org-startup-numerated~. + + | =num= | Start with Org num mode turned on. | + | =nonum= | Start with Org num mode turned off. | + + #+vindex: org-startup-align-all-tables + Aligns tables consistently upon visiting a file. The + corresponding variable is ~org-startup-align-all-tables~ with + ~nil~ as default value. + + | =align= | Align all tables. | + | =noalign= | Do not align tables on startup. | + + #+vindex: org-startup-shrink-all-tables + Shrink table columns with a width cookie. The corresponding + variable is ~org-startup-shrink-all-tables~ with ~nil~ as + default value. + + #+vindex: org-startup-with-inline-images + When visiting a file, inline images can be automatically + displayed. The corresponding variable is + ~org-startup-with-inline-images~, with a default value ~nil~ to + avoid delays when visiting a file. + + | =inlineimages= | Show inline images. | + | =noinlineimages= | Do not show inline images on startup. | + + #+vindex: org-log-done + #+vindex: org-log-note-clock-out + #+vindex: org-log-repeat + Logging the closing and reopening of TODO items and clock + intervals can be configured using these options (see variables + ~org-log-done~, ~org-log-note-clock-out~, and ~org-log-repeat~). + + | =logdone= | Record a timestamp when an item is marked as done. | + | =lognotedone= | Record timestamp and a note when DONE. | + | =nologdone= | Do not record when items are marked as done. | + | =logrepeat= | Record a time when reinstating a repeating item. | + | =lognoterepeat= | Record a note when reinstating a repeating item. | + | =nologrepeat= | Do not record when reinstating repeating item. | + | =lognoteclock-out= | Record a note when clocking out. | + | =nolognoteclock-out= | Do not record a note when clocking out. | + | =logreschedule= | Record a timestamp when scheduling time changes. | + | =lognotereschedule= | Record a note when scheduling time changes. | + | =nologreschedule= | Do not record when a scheduling date changes. | + | =logredeadline= | Record a timestamp when deadline changes. | + | =lognoteredeadline= | Record a note when deadline changes. | + | =nologredeadline= | Do not record when a deadline date changes. | + | =logrefile= | Record a timestamp when refiling. | + | =lognoterefile= | Record a note when refiling. | + | =nologrefile= | Do not record when refiling. | + + #+vindex: org-hide-leading-stars + #+vindex: org-odd-levels-only + Here are the options for hiding leading stars in outline + headings, and for indenting outlines. The corresponding + variables are ~org-hide-leading-stars~ and + ~org-odd-levels-only~, both with a default setting ~nil~ + (meaning =showstars= and =oddeven=). + + | =hidestars= | Make all but one of the stars starting a headline invisible. | + | =showstars= | Show all stars starting a headline. | + | =indent= | Virtual indentation according to outline level. | + | =noindent= | No virtual indentation according to outline level. | + | =odd= | Allow only odd outline levels (1, 3, ...). | + | =oddeven= | Allow all outline levels. | + + #+vindex: org-put-time-stamp-overlays + #+vindex: org-time-stamp-overlay-formats + To turn on custom format overlays over timestamps (variables + ~org-put-time-stamp-overlays~ and + ~org-time-stamp-overlay-formats~), use: + + | =customtime= | Overlay custom time format. | + + #+vindex: constants-unit-system + The following options influence the table spreadsheet (variable + ~constants-unit-system~). + + | =constcgs= | =constants.el= should use the c-g-s unit system. | + | =constSI= | =constants.el= should use the SI unit system. | + + #+vindex: org-footnote-define-inline + #+vindex: org-footnote-auto-label + #+vindex: org-footnote-auto-adjust + To influence footnote settings, use the following keywords. The + corresponding variables are ~org-footnote-define-inline~, + ~org-footnote-auto-label~, and ~org-footnote-auto-adjust~. + + | =fninline= | Define footnotes inline. | + | =fnnoinline= | Define footnotes in separate section. | + | =fnlocal= | Define footnotes near first reference, but not inline. | + | =fnprompt= | Prompt for footnote labels. | + | =fnauto= | Create =[fn:1]=-like labels automatically (default). | + | =fnconfirm= | Offer automatic label for editing or confirmation. | + | =fnadjust= | Automatically renumber and sort footnotes. | + | =nofnadjust= | Do not renumber and sort automatically. | + + #+vindex: org-hide-block-startup + To hide blocks on startup, use these keywords. The + corresponding variable is ~org-hide-block-startup~. + + | =hideblocks= | Hide all begin/end blocks on startup. | + | =nohideblocks= | Do not hide blocks on startup. | + + #+vindex: org-pretty-entities + The display of entities as UTF-8 characters is governed by the + variable ~org-pretty-entities~ and the keywords + + | =entitiespretty= | Show entities as UTF-8 characters where possible. | + | =entitiesplain= | Leave entities plain. | + +- =#+TAGS: TAG1(c1) TAG2(c2)= :: + + #+cindex: @samp{TAGS}, keyword + #+vindex: org-tag-alist + These lines (several such lines are allowed) specify the valid tags + in this file, and (potentially) the corresponding /fast tag + selection/ keys. The corresponding variable is ~org-tag-alist~. + +- =#+TODO:=, =#+SEQ_TODO:=, =#+TYP_TODO:= :: + + #+cindex: @samp{SEQ_TODO}, keyword + #+cindex: @samp{TODO}, keyword + #+cindex: @samp{TYP_TODO}, keyword + #+vindex: org-todo-keywords + These lines set the TODO keywords and their interpretation in the + current file. The corresponding variable is ~org-todo-keywords~. + +** Org Syntax +:PROPERTIES: +:DESCRIPTION: Formal description of Org's syntax. +:END: + +A reference document providing a formal description of Org's syntax is +available as [[https://orgmode.org/worg/dev/org-syntax.html][a draft on Worg]], written and maintained by Nicolas +Goaziou. It defines Org's core internal concepts such as "headlines", +"sections", "affiliated keywords", "(greater) elements" and "objects". +Each part of an Org document belongs to one of the previous +categories. + +To explore the abstract structure of an Org buffer, run this in +a buffer: + +: M-: (org-element-parse-buffer) <RET> + +#+texinfo: @noindent +It outputs a list containing the buffer's content represented as an +abstract structure. The export engine relies on the information +stored in this list. Most interactive commands---e.g., for structure +editing---also rely on the syntactic meaning of the surrounding +context. + +#+cindex: syntax checker +#+cindex: linter +#+findex: org-lint +You can probe the syntax of your documents with the command + +: M-x org-lint <RET> + +#+texinfo: @noindent +It runs a number of checks to find common mistakes. It then displays +their location in a dedicated buffer, along with a description and +a "trust level", since false-positive are possible. From there, you +can operate on the reports with the following keys: + +#+attr_texinfo: :columns 0.22 0.78 +| {{{kbd(C-j)}}}, {{{kbd(TAB)}}} | Display the offending line | +| {{{kbd(RET)}}} | Move point to the offending line | +| {{{kbd(g)}}} | Check the document again | +| {{{kbd(h)}}} | Hide all reports from the same checker | +| {{{kbd(i)}}} | Also remove them from all subsequent checks | +| {{{kbd(S)}}} | Sort reports by the column at point | + +** Context Dependent Documentation +:PROPERTIES: +:DESCRIPTION: Read documentation about current syntax. +:ALT_TITLE: Documentation Access +:END: +#+cindex: documentation +#+cindex: Info + +#+findex: org-info-find-node +#+kindex: C-c C-x I +{{{kbd(C-c C-x I)}}} in an Org file tries to open a suitable section +of the Org manual depending on the syntax at point. For example, +using it on a headline displays "Document Structure" section. + +{{{kbd(q)}}} closes the Info window. + +** Escape Character +:PROPERTIES: +:DESCRIPTION: Prevent Org from interpreting your writing. +:END: + +#+cindex: escape character +#+cindex: zero width space +You may sometimes want to write text that looks like Org syntax, but +should really read as plain text. Org may use a specific escape +character in some situations, i.e., a backslash in macros (see [[*Macro +Replacement]]) and links (see [[*Link Format]]), or a comma in source and +example blocks (see [[*Literal Examples]]). In the general case, however, +we suggest to use the zero width space. You can insert one with any +of the following: + +: C-x 8 <RET> zero width space <RET> +: C-x 8 <RET> 200B <RET> + +For example, in order to write =[[1,2]]= as-is in your document, you +may write instead + +: [X[1,2]] + +where =X= denotes the zero width space character. + +** Code Evaluation and Security Issues +:PROPERTIES: +:DESCRIPTION: Org files evaluate in-line code. +:ALT_TITLE: Code Evaluation Security +:END: + +Unlike plain text, running code comes with risk. Each source code +block, in terms of risk, is equivalent to an executable file. Org +therefore puts a few confirmation prompts by default. This is to +alert the casual user from accidentally running untrusted code. + +For users who do not run code blocks or write code regularly, Org's +default settings should suffice. However, some users may want to +tweak the prompts for fewer interruptions. To weigh the risks of +automatic execution of code blocks, here are some details about code +evaluation. + +Org evaluates code in the following circumstances: + +- /Source code blocks/ :: + + Org evaluates source code blocks in an Org file during export. Org + also evaluates a source code block with the {{{kbd(C-c C-c)}}} key + chord. Users exporting or running code blocks must load files only + from trusted sources. Be wary of customizing variables that remove + or alter default security measures. + + #+attr_texinfo: :options org-confirm-babel-evaluate + #+begin_defopt + When ~t~, Org prompts the user for confirmation before executing + each code block. When ~nil~, Org executes code blocks without + prompting the user for confirmation. When this option is set to + a custom function, Org invokes the function with these two + arguments: the source code language and the body of the code block. + The custom function must return either a ~t~ or ~nil~, which + determines if the user is prompted. Each source code language can + be handled separately through this function argument. + #+end_defopt + + For example, here is how to execute ditaa code blocks without + prompting: + + #+begin_src emacs-lisp + (defun my-org-confirm-babel-evaluate (lang body) + (not (string= lang "ditaa"))) ;don't ask for ditaa + (setq org-confirm-babel-evaluate #'my-org-confirm-babel-evaluate) + #+end_src + +- /Following =shell= and =elisp= links/ :: + + Org has two link types that can directly evaluate code (see + [[*External Links]]). Because such code is not visible, these links + have a potential risk. Org therefore prompts the user when it + encounters such links. The customization variables are: + + #+attr_texinfo: :options org-link-shell-confirm-function + #+begin_defopt + Function that prompts the user before executing a shell link. + #+end_defopt + + #+attr_texinfo: :options org-link-elisp-confirm-function + #+begin_defopt + Function that prompts the user before executing an Emacs Lisp link. + #+end_defopt + +- /Formulas in tables/ :: + + Formulas in tables (see [[*The Spreadsheet]]) are code that is evaluated + either by the Calc interpreter, or by the Emacs Lisp interpreter. + +** Interaction with Other Packages +:PROPERTIES: +:DESCRIPTION: With other Emacs packages. +:ALT_TITLE: Interaction +:END: +#+cindex: packages, interaction with other + +Org's compatibility and the level of interaction with other Emacs +packages are documented here. + +*** Packages that Org cooperates with +:PROPERTIES: +:DESCRIPTION: Packages Org cooperates with. +:ALT_TITLE: Cooperation +:END: + +- =calc.el= by Dave Gillespie :: + #+cindex: @file{calc.el} + + Org uses the Calc package for implementing spreadsheet functionality + in its tables (see [[*The Spreadsheet]]). Org also uses Calc for + embedded calculations. See [[info:calc::Embedded Mode][GNU Emacs Calc Manual]]. + +- =constants.el= by Carsten Dominik :: + #+cindex: @file{constants.el} + #+vindex: org-table-formula-constants + + Org can use names for constants in formulas in tables. Org can also + use calculation suffixes for units, such as =M= for =Mega=. For + a standard collection of such constants, install the =constants= + package. Install version 2.0 of this package, available at + [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks if the function + ~constants-get~ has been autoloaded. Installation instructions are + in the file =constants.el=. + +- =cdlatex.el= by Carsten Dominik :: + #+cindex: @file{cdlatex.el} + + Org mode can make use of the CDLaTeX package to efficiently enter + LaTeX fragments into Org files. See [[*Using CDLaTeX to enter math]]. + +- =imenu.el= by Ake Stenhoff and Lars Lindberg :: + #+cindex: @file{imenu.el} + + Imenu creates dynamic menus based on an index of items in a file. + Org mode supports Imenu menus. Enable it with a mode hook as + follows: + + #+begin_src emacs-lisp + (add-hook 'org-mode-hook + (lambda () (imenu-add-to-menubar "Imenu"))) + #+end_src + + #+vindex: org-imenu-depth + By default the index is two levels deep---you can modify the + depth using the option ~org-imenu-depth~. + +- =speedbar.el= by Eric\nbsp{}M.\nbsp{}Ludlam :: + #+cindex: @file{speedbar.el} + + Speedbar package creates a special Emacs frame for displaying files + and index items in files. Org mode supports Speedbar; users can + drill into Org files directly from the Speedbar. The {{{kbd(<)}}} + in the Speedbar frame tweaks the agenda commands to that file or to + a subtree. + +- =table.el= by Takaaki Ota :: + #+cindex: table editor, @file{table.el} + #+cindex: @file{table.el} + + Complex ASCII tables with automatic line wrapping, column- and + row-spanning, and alignment can be created using the Emacs table + package by Takaaki Ota. Org mode recognizes such tables and exports + them properly. {{{kbd(C-c ')}}} to edit these tables in a special + buffer, much like Org's code blocks. Because of interference with + other Org mode functionality, Takaaki Ota tables cannot be edited + directly in the Org buffer. + + - {{{kbd(C-c ')}}} (~org-edit-special~) :: + + #+kindex: C-c ' + #+findex: org-edit-special + Edit a =table.el= table. Works when point is in a =table.el= + table. + + - {{{kbd(C-c ~)}}} (~org-table-create-with-table.el~) :: + + #+kindex: C-c ~ + #+findex: org-table-create-with-table.el + Insert a =table.el= table. If there is already a table at point, + this command converts it between the =table.el= format and the Org + mode format. See the documentation string of the command + ~org-convert-table~ for the restrictions under which this is + possible. + +*** Packages that conflict with Org mode +:PROPERTIES: +:DESCRIPTION: Packages that lead to conflicts. +:ALT_TITLE: Conflicts +:END: + +#+cindex: shift-selection +#+vindex: org-support-shift-select +In Emacs, shift-selection combines motions of point with shift key to +enlarge regions. Emacs sets this mode by default. This conflicts +with Org's use of {{{kbd(S-<cursor>)}}} commands to change timestamps, +TODO keywords, priorities, and item bullet types, etc. Since +{{{kbd(S-<cursor>)}}} commands outside of specific contexts do not do +anything, Org offers the variable ~org-support-shift-select~ for +customization. Org mode accommodates shift selection by (i) making it +available outside of the special contexts where special commands +apply, and (ii) extending an existing active region even if point +moves across a special context. + +- =cua.el= by Kim\nbsp{}F.\nbsp{}Storm :: + + #+cindex: @file{cua.el} + #+vindex: org-replace-disputed-keys + Org key bindings conflict with {{{kbd(S-<cursor>)}}} keys used by + CUA mode. For Org to relinquish these bindings to CUA mode, + configure the variable ~org-replace-disputed-keys~. When set, Org + moves the following key bindings in Org files, and in the agenda + buffer---but not during date selection. + + #+attr_texinfo: :columns 0.4 0.4 + | {{{kbd(S-UP)}}} \rArr{} {{{kbd(M-p)}}} | {{{kbd(S-DOWN)}}} \rArr{} {{{kbd(M-n)}}} | + | {{{kbd(S-LEFT)}}} \rArr{} {{{kbd(M--)}}} | {{{kbd(S-RIGHT)}}} \rArr{} {{{kbd(M-+)}}} | + | {{{kbd(C-S-LEFT)}}} \rArr{} {{{kbd(M-S--)}}} | {{{kbd(C-S-RIGHT)}}} \rArr{} {{{kbd(M-S-+)}}} | + + #+vindex: org-disputed-keys + Yes, these are unfortunately more difficult to remember. If you + want to have other replacement keys, look at the variable + ~org-disputed-keys~. + +- =ecomplete.el= by Lars Magne Ingebrigtsen :: + + #+cindex: @file{ecomplete.el} + Ecomplete provides "electric" address completion in address header + lines in message buffers. Sadly Orgtbl mode cuts Ecomplete's power + supply: no completion happens when Orgtbl mode is enabled in message + buffers while entering text in address header lines. If one wants + to use ecomplete one should /not/ follow the advice to automagically + turn on Orgtbl mode in message buffers (see [[*The Orgtbl Minor Mode]]), + but instead---after filling in the message headers---turn on Orgtbl + mode manually when needed in the messages body. + +- =filladapt.el= by Kyle Jones :: + + #+cindex: @file{filladapt.el} + Org mode tries to do the right thing when filling paragraphs, list + items and other elements. Many users reported problems using both + =filladapt.el= and Org mode, so a safe thing to do is to disable + filladapt like this: + + #+begin_src emacs-lisp + (add-hook 'org-mode-hook 'turn-off-filladapt-mode) + #+end_src + +- =viper.el= by Michael Kifer :: + #+cindex: @file{viper.el} + #+kindex: C-c / + + Viper uses {{{kbd(C-c /)}}} and therefore makes this key not access + the corresponding Org mode command ~org-sparse-tree~. You need to + find another key for this command, or override the key in + ~viper-vi-global-user-map~ with + + #+begin_src emacs-lisp + (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree) + #+end_src + +- =windmove.el= by Hovav Shacham :: + #+cindex: @file{windmove.el} + + This package also uses the {{{kbd(S-<cursor>)}}} keys, so everything + written in the paragraph above about CUA mode also applies here. If + you want to make the windmove function active in locations where Org + mode does not have special functionality on {{{kbd(S-<cursor>)}}}, + add this to your configuration: + + #+begin_src emacs-lisp + ;; Make windmove work in Org mode: + (add-hook 'org-shiftup-final-hook 'windmove-up) + (add-hook 'org-shiftleft-final-hook 'windmove-left) + (add-hook 'org-shiftdown-final-hook 'windmove-down) + (add-hook 'org-shiftright-final-hook 'windmove-right) + #+end_src + +- =yasnippet.el= :: + + #+cindex: @file{yasnippet.el} + The way Org mode binds the {{{kbd(TAB)}}} key (binding to ~[tab]~ + instead of ~"\t"~) overrules YASnippet's access to this key. The + following code fixed this problem: + + #+begin_src emacs-lisp + (add-hook 'org-mode-hook + (lambda () + (setq-local yas/trigger-key [tab]) + (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand))) + #+end_src + + The latest version of YASnippet does not play well with Org mode. + If the above code does not fix the conflict, start by defining + the following function: + + #+begin_src emacs-lisp + (defun yas/org-very-safe-expand () + (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) + #+end_src + + Then, tell Org mode to use that function: + + #+begin_src emacs-lisp + (add-hook 'org-mode-hook + (lambda () + (make-variable-buffer-local 'yas/trigger-key) + (setq yas/trigger-key [tab]) + (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand) + (define-key yas/keymap [tab] 'yas/next-field))) + #+end_src +** Using Org on a TTY +:PROPERTIES: +:DESCRIPTION: Using Org on a tty. +:ALT_TITLE: TTY Keys +:END: +#+cindex: tty key bindings + +Org provides alternative key bindings for TTY and modern mobile +devices that cannot perform movement commands on point and key +bindings with modifier keys. Some of these workarounds may be more +cumbersome than necessary. Users should look into customizing these +further based on their usage needs. For example, the normal +{{{kbd(S-<cursor>)}}} for editing timestamp might be better with +{{{kbd(C-c .)}}} chord. + +#+attr_texinfo: :columns 0.2 0.28 0.15 0.21 +| Default | Alternative 1 | Speed key | Alternative 2 | +|----------------------+--------------------------+--------------+----------------------| +| {{{kbd(S-TAB)}}} | {{{kbd(C-u TAB)}}} | {{{kbd(C)}}} | | +| {{{kbd(M-LEFT)}}} | {{{kbd(C-c C-x l)}}} | {{{kbd(l)}}} | {{{kbd(Esc LEFT)}}} | +| {{{kbd(M-S-LEFT)}}} | {{{kbd(C-c C-x L)}}} | {{{kbd(L)}}} | | +| {{{kbd(M-RIGHT)}}} | {{{kbd(C-c C-x r)}}} | {{{kbd(r)}}} | {{{kbd(Esc RIGHT)}}} | +| {{{kbd(M-S-RIGHT)}}} | {{{kbd(C-c C-x R)}}} | {{{kbd(R)}}} | | +| {{{kbd(M-UP)}}} | {{{kbd(C-c C-x u)}}} | | {{{kbd(Esc UP)}}} | +| {{{kbd(M-S-UP)}}} | {{{kbd(C-c C-x U)}}} | {{{kbd(U)}}} | | +| {{{kbd(M-DOWN)}}} | {{{kbd(C-c C-x d)}}} | | {{{kbd(Esc DOWN)}}} | +| {{{kbd(M-S-DOWN)}}} | {{{kbd(C-c C-x D)}}} | {{{kbd(D)}}} | | +| {{{kbd(S-RET)}}} | {{{kbd(C-c C-x c)}}} | | | +| {{{kbd(M-RET)}}} | {{{kbd(C-c C-x m)}}} | | {{{kbd(Esc RET)}}} | +| {{{kbd(M-S-RET)}}} | {{{kbd(C-c C-x M)}}} | | | +| {{{kbd(S-LEFT)}}} | {{{kbd(C-c LEFT)}}} | | | +| {{{kbd(S-RIGHT)}}} | {{{kbd(C-c RIGHT)}}} | | | +| {{{kbd(S-UP)}}} | {{{kbd(C-c UP)}}} | | | +| {{{kbd(S-DOWN)}}} | {{{kbd(C-c DOWN)}}} | | | +| {{{kbd(C-S-LEFT)}}} | {{{kbd(C-c C-x LEFT)}}} | | | +| {{{kbd(C-S-RIGHT)}}} | {{{kbd(C-c C-x RIGHT)}}} | | | + +** Protocols for External Access +:PROPERTIES: +:DESCRIPTION: External access to Emacs and Org. +:ALT_TITLE: Protocols +:END: +#+cindex: protocols, for external access + +Org protocol is a tool to trigger custom actions in Emacs from +external applications. Any application that supports calling external +programs with an URL as argument may be used with this functionality. +For example, you can configure bookmarks in your web browser to send a +link to the current page to Org and create a note from it using +capture (see [[*Capture]]). You can also create a bookmark that tells +Emacs to open the local source file of a remote website you are +browsing. + +#+cindex: Org protocol, set-up +#+cindex: Installing Org protocol +In order to use Org protocol from an application, you need to register +=org-protocol://= as a valid scheme-handler. External calls are +passed to Emacs through the =emacsclient= command, so you also need to +ensure an Emacs server is running. More precisely, when the +application calls + +: emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2 + +#+texinfo: @noindent +Emacs calls the handler associated to {{{var(PROTOCOL)}}} with +argument =(:key1 val1 :key2 val2)=. + +#+cindex: protocol, new protocol +#+cindex: defining new protocols +Org protocol comes with three predefined protocols, detailed in the +following sections. Configure ~org-protocol-protocol-alist~ to define +your own. + +*** The ~store-link~ protocol +:PROPERTIES: +:DESCRIPTION: Store a link, push URL to kill-ring. +:END: +#+cindex: store-link protocol +#+cindex: protocol, store-link + +Using the ~store-link~ handler, you can copy links, to that they can +be inserted using {{{kbd(M-x org-insert-link)}}} or yanking. More +precisely, the command + +: emacsclient org-protocol://store-link?url=URL&title=TITLE + +#+texinfo: @noindent +stores the following link: + +: [[URL][TITLE]] + +In addition, {{{var(URL)}}} is pushed on the kill-ring for yanking. +You need to encode {{{var(URL)}}} and {{{var(TITLE)}}} if they contain +slashes, and probably quote those for the shell. + +To use this feature from a browser, add a bookmark with an arbitrary +name, e.g., =Org: store-link= and enter this as /Location/: + +#+begin_example +javascript:location.href='org-protocol://store-link?url='+ + encodeURIComponent(location.href); +#+end_example + +*** The ~capture~ protocol +:PROPERTIES: +:DESCRIPTION: Fill a buffer with external information. +:END: +#+cindex: capture protocol +#+cindex: protocol, capture + +Activating the "capture" handler pops up a =Capture= buffer in Emacs, +using acapture template. + +: emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY + +To use this feature, add a bookmark with an arbitrary name, e.g., +=Org: capture=, and enter this as =Location=: + +#+begin_example +javascript:location.href='org-protocol://capture?template=x'+ + '&url='+encodeURIComponent(window.location.href)+ + '&title='+encodeURIComponent(document.title)+ + '&body='+encodeURIComponent(window.getSelection()); +#+end_example + +#+vindex: org-protocol-default-template-key +The capture template to be used can be specified in the bookmark (like +=X= above). If unspecified, the template key is set in the variable +~org-protocol-default-template-key~. The following template +placeholders are available: + +#+begin_example +%:link The URL +%:description The webpage title +%:annotation Equivalent to [[%:link][%:description]] +%i The selected text +#+end_example + +*** The ~open-source~ protocol +:PROPERTIES: +:DESCRIPTION: Edit published contents. +:END: +#+cindex: open-source protocol +#+cindex: protocol, open-source + +The ~open-source~ handler is designed to help with editing local +sources when reading a document. To that effect, you can use +a bookmark with the following location: + +#+begin_example +javascript:location.href='org-protocol://open-source?&url='+ + encodeURIComponent(location.href) +#+end_example + +#+vindex: org-protocol-project-alist +The variable ~org-protocol-project-alist~ maps URLs to local file +names, by stripping URL parameters from the end and replacing the +~:base-url~ with ~:working-directory~ and ~:online-suffix~ with +~:working-suffix~. For example, assuming you own a local copy of +=https://orgmode.org/worg/= contents at =/home/user/worg=, you can set +~org-protocol-project-alist~ to the following + +#+begin_src emacs-lisp +(setq org-protocol-project-alist + '(("Worg" + :base-url "https://orgmode.org/worg/" + :working-directory "/home/user/worg/" + :online-suffix ".html" + :working-suffix ".org"))) +#+end_src + +#+texinfo: @noindent +If you are now browsing +=https://orgmode.org/worg/org-contrib/org-protocol.html= and find +a typo or have an idea about how to enhance the documentation, simply +click the bookmark and start editing. + +#+cindex: rewritten URL in open-source protocol +#+cindex: protocol, open-source rewritten URL +However, such mapping may not always yield the desired results. +Suppose you maintain an online store located at =http://example.com/=. +The local sources reside in =/home/user/example/=. It is common +practice to serve all products in such a store through one file and +rewrite URLs that do not match an existing file on the server. That +way, a request to =http://example.com/print/posters.html= might be +rewritten on the server to something like +=http://example.com/shop/products.php/posters.html.php=. The +~open-source~ handler probably cannot find a file named +=/home/user/example/print/posters.html.php= and fails. + +Such an entry in ~org-protocol-project-alist~ may hold an additional +property ~:rewrites~. This property is a list of cons cells, each of +which maps a regular expression to a path relative to the +~:working-directory~. + +Now map the URL to the path =/home/user/example/products.php= by +adding ~:rewrites~ rules like this: + +#+begin_src emacs-lisp +(setq org-protocol-project-alist + '(("example.com" + :base-url "http://example.com/" + :working-directory "/home/user/example/" + :online-suffix ".php" + :working-suffix ".php" + :rewrites (("example.com/print/" . "products.php") + ("example.com/$" . "index.php"))))) +#+end_src + +#+texinfo: @noindent +Since =example.com/$= is used as a regular expression, it maps +=http://example.com/=, =https://example.com=, +=http://www.example.com/= and similar to +=/home/user/example/index.php=. + +The ~:rewrites~ rules are searched as a last resort if and only if no +existing file name is matched. + +#+cindex: protocol, open-source, set-up mapping +#+cindex: mappings in open-source protocol +#+findex: org-protocol-create +#+findex: org-protocol-create-for-org +Two functions can help you filling ~org-protocol-project-alist~ with +valid contents: ~org-protocol-create~ and +~org-protocol-create-for-org~. The latter is of use if you're editing +an Org file that is part of a publishing project. +** Org Crypt +:PROPERTIES: +:DESCRIPTION: Encrypting Org files. +:END: + +Org Crypt encrypts the text of an entry, but not the headline, or +properties. Behind the scene, it uses the Emacs EasyPG library to +encrypt and decrypt files. + +#+vindex: org-crypt-tag-matcher +Any text below a headline that has a =crypt= tag is automatically +encrypted when the file is saved. To use a different tag, customize +the ~org-crypt-tag-matcher~ setting. + +Here is a suggestion for Org Crypt settings in Emacs init file: + +#+begin_src emacs-lisp +(require 'org-crypt) +(org-crypt-use-before-save-magic) +(setq org-tags-exclude-from-inheritance '("crypt")) + +(setq org-crypt-key nil) +;; GPG key to use for encryption +;; Either the Key ID or set to nil to use symmetric encryption. + +(setq auto-save-default nil) +;; Auto-saving does not cooperate with org-crypt.el: so you need to +;; turn it off if you plan to use org-crypt.el quite often. Otherwise, +;; you'll get an (annoying) message each time you start Org. + +;; To turn it off only locally, you can insert this: +;; +;; # -*- buffer-auto-save-file-name: nil; -*- +#+end_src + +It's possible to use different keys for different headings by +specifying the respective key as property =CRYPTKEY=, e.g.: + +#+begin_example +,* Totally secret :crypt: + :PROPERTIES: + :CRYPTKEY: 0x0123456789012345678901234567890123456789 + :END: +#+end_example + +Excluding the =crypt= tag from inheritance prevents already encrypted +text from being encrypted again. + +** Org Mobile +:PROPERTIES: +:DESCRIPTION: Viewing and capture on a mobile device. +:END: +#+cindex: smartphone + +Org Mobile is a protocol for synchronizing Org files between Emacs and +other applications, e.g., on mobile devices. It enables offline-views +and capture support for an Org mode system that is rooted on a "real" +computer. The external application can also record changes to +existing entries. + +This appendix describes Org's support for agenda view formats +compatible with Org Mobile. It also describes synchronizing changes, +such as to notes, between the mobile application and the computer. + +To change tags and TODO states in the mobile application, first +customize the variables ~org-todo-keywords~, ~org-tag-alist~ and +~org-tag-persistent-alist~. These should cover all the important tags +and TODO keywords, even if Org files use only some of them. Though +the mobile application is expected to support in-buffer settings, it +is required to understand TODO states /sets/ (see [[*Setting up keywords +for individual files]]) and /mutually exclusive/ tags (see [[*Setting +Tags]]) only for those set in these variables. + +*** Setting up the staging area +:PROPERTIES: +:DESCRIPTION: For the mobile device. +:END: + +#+vindex: org-mobile-directory +The mobile application needs access to a file directory on +a server[fn:151] to interact with Emacs. Pass its location through +the ~org-mobile-directory~ variable. If you can mount that directory +locally just set the variable to point to that directory: + +#+begin_src emacs-lisp +(setq org-mobile-directory "~/orgmobile/") +#+end_src + +Alternatively, by using TRAMP (see [[info:tramp][TRAMP User Manual]]), +~org-mobile-directory~ may point to a remote directory accessible +through, for example, SSH, SCP, or DAVS: + +#+begin_src emacs-lisp +(setq org-mobile-directory "/davs:user@remote.host:/org/webdav/") +#+end_src + +#+vindex: org-mobile-encryption +With a public server, consider encrypting the files. Org also +requires OpenSSL installed on the local computer. To turn on +encryption, set the same password in the mobile application and in +Emacs. Set the password in the variable +~org-mobile-use-encryption~[fn:152]. Note that even after the mobile +application encrypts the file contents, the file name remains visible +on the file systems of the local computer, the server, and the mobile +device. + +*** Pushing to the mobile application +:PROPERTIES: +:DESCRIPTION: Uploading Org files and agendas. +:END: + +#+findex: org-mobile-push +#+vindex: org-mobile-files +The command ~org-mobile-push~ copies files listed in +~org-mobile-files~ into the staging area. Files include agenda files +(as listed in ~org-agenda-files~). Customize ~org-mobile-files~ to +add other files. File names are staged with paths relative to +~org-directory~, so all files should be inside this directory[fn:153]. + +Push creates a special Org file =agendas.org= with custom agenda views +defined by the user[fn:154]. + +Finally, Org writes the file =index.org=, containing links to other +files. The mobile application reads this file first from the server +to determine what other files to download for agendas. For faster +downloads, it is expected to only read files whose checksums[fn:155] +have changed. + +*** Pulling from the mobile application +:PROPERTIES: +:DESCRIPTION: Integrating captured and flagged items. +:END: + +#+findex: org-mobile-pull +The command ~org-mobile-pull~ synchronizes changes with the server. +More specifically, it first pulls the Org files for viewing. It then +appends captured entries and pointers to flagged or changed entries to +the file =mobileorg.org= on the server. Org ultimately integrates its +data in an inbox file format, through the following steps: + +1. + #+vindex: org-mobile-inbox-for-pull + Org moves all entries found in =mobileorg.org=[fn:156] and appends + them to the file pointed to by the variable + ~org-mobile-inbox-for-pull~. It should reside neither in the + staging area nor on the server. Each captured entry and each + editing event is a top-level entry in the inbox file. + +2. + #+cindex: @samp{FLAGGED}, tag + After moving the entries, Org processes changes to the shared + files. Some of them are applied directly and without user + interaction. Examples include changes to tags, TODO state, + headline and body text. Entries requiring further action are + tagged as =FLAGGED=. Org marks entries with problems with an error + message in the inbox. They have to be resolved manually. + +3. Org generates an agenda view for flagged entries for user + intervention to clean up. For notes stored in flagged entries, Org + displays them in the echo area when point is on the corresponding + agenda item. + + - {{{kbd(?)}}} :: + + Pressing {{{kbd(?)}}} displays the entire flagged note in another + window. Org also pushes it to the kill ring. To store flagged + note as a normal note, use {{{kbd(? z C-y C-c C-c)}}}. Pressing + {{{kbd(?)}}} twice does these things: first it removes the + =FLAGGED= tag; second, it removes the flagged note from the + property drawer; third, it signals that manual editing of the + flagged entry is now finished. + +#+kindex: ? @r{(Agenda dispatcher)} +From the agenda dispatcher, {{{kbd(?)}}} returns to the view to finish +processing flagged entries. Note that these entries may not be the +most recent since the mobile application searches files that were last +pulled. To get an updated agenda view with changes since the last +pull, pull again. + +* Hacking +:PROPERTIES: +:DESCRIPTION: How to hack your way around. +:APPENDIX: t +:END: +#+cindex: hacking + +This appendix describes some ways a user can extend the functionality +of Org. + +** Hooks +:PROPERTIES: +:DESCRIPTION: How to reach into Org's internals. +:END: +#+cindex: hooks + +Org has a large number of hook variables for adding functionality. +This appendix illustrates using a few. A complete list of hooks with +documentation is maintained by the Worg project at +https://orgmode.org/worg/doc.html#hooks. + +** Add-on Packages +:PROPERTIES: +:DESCRIPTION: Available extensions. +:END: +#+cindex: add-on packages + +Various authors wrote a large number of add-on packages for Org. + +These packages are not part of Emacs, but they are distributed as +contributed packages with the separate release available at +https://orgmode.org. See the =contrib/README= file in the source code +directory for a list of contributed files. Worg page with more +information is at: https://orgmode.org/worg/org-contrib/. + +** Adding Hyperlink Types +:PROPERTIES: +:DESCRIPTION: New custom link types. +:END: +#+cindex: hyperlinks, adding new types + +Org has many built-in hyperlink types (see [[*Hyperlinks]]), and an +interface for adding new link types. The following example shows the +process of adding Org links to Unix man pages, which look like this + +: [[man:printf][The printf manual]] + +#+texinfo: @noindent +The following =ol-man.el= file implements it + +#+begin_src emacs-lisp +;;; ol-man.el - Support for links to man pages in Org mode +(require 'ol) + +(org-link-set-parameters "man" + :follow #'org-man-open + :export #'org-man-export + :store #'org-man-store-link) + +(defcustom org-man-command 'man + "The Emacs command to be used to display a man page." + :group 'org-link + :type '(choice (const man) (const woman))) + +(defun org-man-open (path _) + "Visit the manpage on PATH. +PATH should be a topic that can be thrown at the man command." + (funcall org-man-command path)) + +(defun org-man-store-link () + "Store a link to a man page." + (when (memq major-mode '(Man-mode woman-mode)) + ;; This is a man page, we do make this link. + (let* ((page (org-man-get-page-name)) + (link (concat "man:" page)) + (description (format "Man page for %s" page))) + (org-link-store-props + :type "man" + :link link + :description description)))) + +(defun org-man-get-page-name () + "Extract the page name from the buffer name." + ;; This works for both `Man-mode' and `woman-mode'. + (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) + (match-string 1 (buffer-name)) + (error "Cannot create link to this man page"))) + +(defun org-man-export (link description format _) + "Export a man page link from Org files." + (let ((path (format "http://man.he.net/?topic=%s§ion=all" link)) + (desc (or description link))) + (pcase format + (`html (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc)) + (`latex (format "\\href{%s}{%s}" path desc)) + (`texinfo (format "@uref{%s,%s}" path desc)) + (`ascii (format "%s (%s)" desc path)) + (t path)))) + +(provide ol-man) +;;; ol-man.el ends here +#+end_src + +#+texinfo: @noindent +To activate links to man pages in Org, enter this in the Emacs init +file: + +#+begin_src emacs-lisp +(require 'ol-man) +#+end_src + +#+texinfo: @noindent +A review of =ol-man.el=: + +1. First, =(require 'ol)= ensures that =ol.el= is loaded. + +2. + + #+findex: org-link-set-parameters + #+vindex: org-link-parameters + Then ~org-link-set-parameters~ defines a new link type with =man= + prefix and associates functions for following, exporting and + storing such links. See the variable ~org-link-parameters~ for + a complete list of possible associations. + +3. The rest of the file implements necessary variables and functions. + + For example, ~org-man-store-link~ is responsible for storing a link + when ~org-store-link~ (see [[*Handling Links]]) is called from a buffer + displaying a man page. It first checks if the major mode is + appropriate. If check fails, the function returns ~nil~, which + means it isn't responsible for creating a link to the current + buffer. Otherwise the function makes a link string by combining + the =man:= prefix with the man topic. It also provides a default + description. The function ~org-insert-link~ can insert it back + into an Org buffer later on. + +** Adding Export Back-ends +:PROPERTIES: +:DESCRIPTION: How to write new export back-ends. +:END: +#+cindex: Export, writing back-ends + +Org's export engine makes it easy for writing new back-ends. The +framework on which the engine was built makes it easy to derive new +back-ends from existing ones. + +#+findex: org-export-define-backend +#+findex: org-export-define-derived-backend +The two main entry points to the export engine are: +~org-export-define-backend~ and ~org-export-define-derived-backend~. +To grok these functions, see =ox-latex.el= for an example of defining +a new back-end from scratch, and =ox-beamer.el= for an example of +deriving from an existing engine. + +For creating a new back-end from scratch, first set its name as +a symbol in an alist consisting of elements and export functions. To +make the back-end visible to the export dispatcher, set ~:menu-entry~ +keyword. For export options specific to this back-end, set the +~:options-alist~. + +For creating a new back-end from an existing one, set +~:translate-alist~ to an alist of export functions. This alist +replaces the parent back-end functions. + +For complete documentation, see [[https://orgmode.org/worg/dev/org-export-reference.html][the Org Export Reference on Worg]]. + +** Tables in Arbitrary Syntax +:PROPERTIES: +:DESCRIPTION: Orgtbl for LaTeX and other programs. +:END: +#+cindex: tables, in other modes +#+cindex: lists, in other modes +#+cindex: Orgtbl mode + +Due to Org's success in handling tables with Orgtbl, a frequently +requested feature is the use of Org's table functions in other modes, +e.g., LaTeX. This would be hard to do in a general way without +complicated customization nightmares. Moreover, that would take Org +away from its simplicity roots that Orgtbl has proven. There is, +however, an alternate approach to accomplishing the same. + +This approach involves implementing a custom /translate/ function that +operates on a native Org /source table/ to produce a table in another +format. This strategy would keep the excellently working Orgtbl +simple and isolate complications, if any, confined to the translate +function. To add more alien table formats, we just add more translate +functions. Also the burden of developing custom translate functions +for new table formats is in the hands of those who know those formats +best. + +*** Radio tables +:PROPERTIES: +:DESCRIPTION: Sending and receiving radio tables. +:END: +#+cindex: radio tables + +Radio tables are target locations for translated tables that are not near +their source. Org finds the target location and inserts the translated +table. + +The key to finding the target location is the magic words =BEGIN/END +RECEIVE ORGTBL=. They have to appear as comments in the current mode. +If the mode is C, then: + +#+begin_example +/* BEGIN RECEIVE ORGTBL table_name */ +/* END RECEIVE ORGTBL table_name */ +#+end_example + +At the location of source, Org needs a special line to direct Orgtbl +to translate and to find the target for inserting the translated +table. For example: + +#+cindex: @samp{ORGTBL}, keyword +: #+ORGTBL: SEND table_name translation_function arguments ... + +#+texinfo: @noindent +=table_name= is the table's reference name, which is also used in the +receiver lines, and the =translation_function= is the Lisp function +that translates. This line, in addition, may also contain alternating +key and value arguments at the end. The translation function gets +these values as a property list. A few standard parameters are +already recognized and acted upon before the translation function is +called: + +- =:skip N= :: + + Skip the first N lines of the table. Hlines do count; include them + if they are to be skipped. + +- =:skipcols (n1 n2 ...)= :: + + List of columns to be skipped. First Org automatically discards + columns with calculation marks and then sends the table to the + translator function, which then skips columns as specified in + =skipcols=. + +To keep the source table intact in the buffer without being disturbed +when the source file is compiled or otherwise being worked on, use one +of these strategies: + +- Place the table in a block comment. For example, in C mode you + could wrap the table between =/*= and =*/= lines. + +- Put the table after an "end" statement. For example ~\bye~ in TeX + and ~\end{document}~ in LaTeX. + +- Comment and un-comment each line of the table during edits. The + {{{kbd(M-x orgtbl-toggle-comment)}}} command makes toggling easy. + +*** A LaTeX example of radio tables +:PROPERTIES: +:DESCRIPTION: Step by step, almost a tutorial. +:ALT_TITLE: A LaTeX example +:END: +#+cindex: @LaTeX{}, and Orgtbl mode + +To wrap a source table in LaTeX, use the =comment= environment +provided by =comment.sty=[fn:157]. To activate it, put +~\usepackage{comment}~ in the document header. Orgtbl mode inserts +a radio table skeleton[fn:158] with the command {{{kbd(M-x +orgtbl-insert-radio-table)}}}, which prompts for a table name. For +example, if =salesfigures= is the name, the template inserts: + +#+begin_example +% BEGIN RECEIVE ORGTBL salesfigures +% END RECEIVE ORGTBL salesfigures +\begin{comment} +,#+ORGTBL: SEND salesfigures orgtbl-to-latex +| | | +\end{comment} +#+end_example + +#+vindex: LaTeX-verbatim-environments +#+texinfo: @noindent +The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function +~orgtbl-to-latex~ to convert the table to LaTeX format, then insert +the table at the target (receive) location named =salesfigures=. Now +the table is ready for data entry. It can even use spreadsheet +features[fn:159]: + +#+begin_example +% BEGIN RECEIVE ORGTBL salesfigures +% END RECEIVE ORGTBL salesfigures +\begin{comment} +,#+ORGTBL: SEND salesfigures orgtbl-to-latex +| Month | Days | Nr sold | per day | +|-------+------+---------+---------| +| Jan | 23 | 55 | 2.4 | +| Feb | 21 | 16 | 0.8 | +| March | 22 | 278 | 12.6 | +,#+TBLFM: $4=$3/$2;%.1f +% $ (optional extra dollar to keep Font Lock happy, see footnote) +\end{comment} +#+end_example + +After editing, {{{kbd(C-c C-c)}}} inserts the translated table at the +target location, between the two marker lines. + +For hand-made custom tables, note that the translator needs to skip +the first two lines of the source table. Also the command has to +/splice/ out the target table without the header and footer. + +#+begin_example +\begin{tabular}{lrrr} +Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\ +% BEGIN RECEIVE ORGTBL salesfigures +% END RECEIVE ORGTBL salesfigures +\end{tabular} +% +\begin{comment} +,#+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 +| Month | Days | Nr sold | per day | +|-------+------+---------+---------| +| Jan | 23 | 55 | 2.4 | +| Feb | 21 | 16 | 0.8 | +| March | 22 | 278 | 12.6 | +,#+TBLFM: $4=$3/$2;%.1f +\end{comment} +#+end_example + +The LaTeX translator function ~orgtbl-to-latex~ is already part of +Orgtbl mode and uses a =tabular= environment to typeset the table and +marks horizontal lines with ~\hline~. For additional parameters to +control output, see [[*Translator functions]]: + +- =:splice BOOLEAN= :: + + When {{{var(BOOLEAN}}} is non-~nil~, return only table body lines; + i.e., not wrapped in =tabular= environment. Default is ~nil~. + +- =:fmt FMT= :: + + Format string to warp each field. It should contain =%s= for the + original field value. For example, to wrap each field value in + dollar symbol, you could use =:fmt "$%s$"=. Format can also wrap + a property list with column numbers and formats, for example =:fmt + (2 "$%s$" 4 "%s\\%%")=. In place of a string, a function of one + argument can be used; the function must return a formatted string. + +- =:efmt EFMT= :: + + Format numbers as exponentials. The spec should have =%s= twice for + inserting mantissa and exponent, for example ="%s\\times10^{%s}"=. This + may also be a property list with column numbers and formats, for + example =:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")=. After + {{{var(EFMT)}}} has been applied to a value, {{{var(FMT)}}}---see + above---is also applied. Functions with two arguments can be + supplied instead of strings. By default, no special formatting is + applied. + +*** Translator functions +:PROPERTIES: +:DESCRIPTION: Copy and modify. +:END: +#+cindex: HTML, and Orgtbl mode +#+cindex: translator function + +#+findex: orgtbl-to-csv +#+findex: orgtbl-to-tsv +#+findex: orgtbl-to-latex +#+findex: orgtbl-to-html +#+findex: orgtbl-to-texinfo +#+findex: orgtbl-to-unicode +#+findex: orgtbl-to-orgtbl +#+findex: orgtbl-to-generic +Orgtbl mode has built-in translator functions: ~orgtbl-to-csv~ +(comma-separated values), ~orgtbl-to-tsv~ (TAB-separated values), +~orgtbl-to-latex~, ~orgtbl-to-html~, ~orgtbl-to-texinfo~, +~orgtbl-to-unicode~ and ~orgtbl-to-orgtbl~. They use the generic +translator, ~orgtbl-to-generic~, which delegates translations to +various export back-ends. + +Properties passed to the function through the =ORGTBL SEND= line take +precedence over properties defined inside the function. For example, +this overrides the default LaTeX line endings, ~\\~, with ~\\[2mm]~: + +: #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" + +For a new language translator, define a converter function. It can be +a generic function, such as shown in this example. It marks +a beginning and ending of a table with =!BTBL!= and =!ETBL!=; +a beginning and ending of lines with =!BL!= and =!EL!=; and uses a TAB +for a field separator: + +#+begin_src emacs-lisp +(defun orgtbl-to-language (table params) + "Convert the orgtbl-mode TABLE to language." + (orgtbl-to-generic + table + (org-combine-plists + '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t") + params))) +#+end_src + +#+texinfo: @noindent +The documentation for the ~orgtbl-to-generic~ function shows +a complete list of parameters, each of which can be passed through to +~orgtbl-to-latex~, ~orgtbl-to-texinfo~, and any other function using +that generic function. + +For complicated translations the generic translator function could be +replaced by a custom translator function. Such a custom function must +take two arguments and return a single string containing the formatted +table. The first argument is the table whose lines are a list of +fields or the symbol ~hline~. The second argument is the property +list consisting of parameters specified in the =#+ORGTBL: SEND= line. +Please share your translator functions by posting them to the Org +users mailing list, at mailto:emacs-orgmode@gnu.org. + +** Dynamic Blocks +:PROPERTIES: +:DESCRIPTION: Automatically filled blocks. +:END: +#+cindex: dynamic blocks + +Org supports /dynamic blocks/ in Org documents. They are inserted +with begin and end markers like any other code block, but the contents +are updated automatically by a user function. + +#+kindex: C-c C-x x +#+findex: org-dynamic-block-insert-dblock +You can insert a dynamic block with ~org-dynamic-block-insert-dblock~, +which is bound to {{{kbd(C-c C-x x)}}} by default. For example, +{{{kbd(C-c C-x x c l o c k t a b l e RET)}}} inserts a table that +updates the work time (see [[*Clocking Work Time]]). + +Dynamic blocks can have names and function parameters. The syntax is +similar to source code block specifications: + +#+begin_example +,#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... + ... +,#+END: +#+end_example + +These commands update dynamic blocks: + +- {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) :: + + #+kindex: C-c C-x C-u + #+findex: org-dblock-update + Update dynamic block at point. + +- {{{kbd(C-u C-c C-x C-u)}}} :: + + #+kindex: C-u C-c C-x C-u + Update all dynamic blocks in the current file. + +Before updating a dynamic block, Org removes content between the +=BEGIN= and =END= markers. Org then reads the parameters on the +=BEGIN= line for passing to the writer function as a plist. The +previous content of the dynamic block becomes erased from the buffer +and appended to the plist under ~:content~. + +The syntax for naming a writer function with a dynamic block labeled +=myblock= is: ~org-dblock-write:myblock~. + +The following is an example of a dynamic block and a block writer function +that updates the time when the function was last run: + +#+begin_example +,#+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" + ... +,#+END: +#+end_example + +#+texinfo: @noindent +The dynamic block's writer function: + +#+begin_src emacs-lisp +(defun org-dblock-write:block-update-time (params) + (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) + (insert "Last block update at: " + (format-time-string fmt)))) +#+end_src + +To keep dynamic blocks up-to-date in an Org file, use the function, +~org-update-all-dblocks~ in hook, such as ~before-save-hook~. The +~org-update-all-dblocks~ function does not run if the file is not in +Org mode. + +#+findex: org-narrow-to-block +Dynamic blocks, like any other block, can be narrowed with +~org-narrow-to-block~. + +** Special Agenda Views +:PROPERTIES: +:DESCRIPTION: Customized views. +:END: +#+cindex: agenda views, user-defined + +#+vindex: org-agenda-skip-function +#+vindex: org-agenda-skip-function-global +Org provides a special hook to further limit items in agenda views: +~agenda~, ~agenda*~[fn:160], ~todo~, ~alltodo~, ~tags~, ~tags-todo~, +~tags-tree~. Specify a custom function that tests inclusion of every +matched item in the view. This function can also skip as much as is +needed. + +For a global condition applicable to agenda views, use the +~org-agenda-skip-function-global~ variable. Org uses a global +condition with ~org-agenda-skip-function~ for custom searching. + +This example defines a function for a custom view showing TODO items +with =waiting= status. Manually this is a multi-step search process, +but with a custom view, this can be automated as follows: + +The custom function searches the subtree for the =waiting= tag and +returns ~nil~ on match. Otherwise it gives the location from where +the search continues. + +#+begin_src emacs-lisp +(defun my-skip-unless-waiting () + "Skip trees that are not waiting" + (let ((subtree-end (save-excursion (org-end-of-subtree t)))) + (if (re-search-forward ":waiting:" subtree-end t) + nil ; tag found, do not skip + subtree-end))) ; tag not found, continue after end of subtree +#+end_src + +To use this custom function in a custom agenda command: + +#+begin_src emacs-lisp +(org-add-agenda-custom-command + '("b" todo "PROJECT" + ((org-agenda-skip-function 'my-skip-unless-waiting) + (org-agenda-overriding-header "Projects waiting for something: ")))) +#+end_src + +#+vindex: org-agenda-overriding-header +Note that this also binds ~org-agenda-overriding-header~ to a more +meaningful string suitable for the agenda view. + +#+vindex: org-odd-levels-only +#+vindex: org-agenda-skip-function +Search for entries with a limit set on levels for the custom search. +This is a general approach to creating custom searches in Org. To +include all levels, use =LEVEL>0=[fn:161]. Then to selectively pick +the matched entries, use ~org-agenda-skip-function~, which also +accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and +~org-agenda-skip-subtree-if~. For example: + +- =(org-agenda-skip-entry-if 'scheduled)= :: + + Skip current entry if it has been scheduled. + +- =(org-agenda-skip-entry-if 'notscheduled)= :: + + Skip current entry if it has not been scheduled. + +- =(org-agenda-skip-entry-if 'deadline)= :: + + Skip current entry if it has a deadline. + +- =(org-agenda-skip-entry-if 'scheduled 'deadline)= :: + + Skip current entry if it has a deadline, or if it is scheduled. + +- =(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))= :: + + Skip current entry if the TODO keyword is TODO or WAITING. + +- =(org-agenda-skip-entry-if 'todo 'done)= :: + + Skip current entry if the TODO keyword marks a DONE state. + +- =(org-agenda-skip-entry-if 'timestamp)= :: + + Skip current entry if it has any timestamp, may also be deadline or + scheduled. + +- =(org-agenda-skip-entry-if 'regexp "regular expression")= :: + + Skip current entry if the regular expression matches in the entry. + +- =(org-agenda-skip-entry-if 'notregexp "regular expression")= :: + + Skip current entry unless the regular expression matches. + +- =(org-agenda-skip-subtree-if 'regexp "regular expression")= :: + + Same as above, but check and skip the entire subtree. + +The following is an example of a search for =waiting= without the +special function: + +#+begin_src emacs-lisp +(org-add-agenda-custom-command + '("b" todo "PROJECT" + ((org-agenda-skip-function '(org-agenda-skip-subtree-if + 'regexp ":waiting:")) + (org-agenda-overriding-header "Projects waiting for something: ")))) +#+end_src + +** Speeding Up Your Agendas +:PROPERTIES: +:DESCRIPTION: Tips on how to speed up your agendas. +:END: +#+cindex: agenda views, optimization + +Some agenda commands slow down when the Org files grow in size or +number. Here are tips to speed up: + +- Reduce the number of Org agenda files to avoid slowdowns due to hard drive + accesses. + +- Reduce the number of DONE and archived headlines so agenda + operations that skip over these can finish faster. + +- Do not dim blocked tasks: + #+vindex: org-agenda-dim-blocked-tasks + + #+begin_src emacs-lisp + (setq org-agenda-dim-blocked-tasks nil) + #+end_src + +- Stop preparing agenda buffers on startup: + #+vindex: org-startup-folded + #+vindex: org-agenda-inhibit-startup + + #+begin_src emacs-lisp + (setq org-agenda-inhibit-startup t) + #+end_src + +- Disable tag inheritance for agendas: + #+vindex: org-agenda-show-inherited-tags + #+vindex: org-agenda-use-tag-inheritance + + #+begin_src emacs-lisp + (setq org-agenda-use-tag-inheritance nil) + #+end_src + +These options can be applied to selected agenda views. For more +details about generation of agenda views, see the docstrings for the +relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda +optimization. + +** Extracting Agenda Information +:PROPERTIES: +:DESCRIPTION: Post-processing agenda information. +:END: +#+cindex: agenda, pipe +#+cindex: scripts, for agenda processing + +Org provides commands to access agendas through Emacs batch mode. +Through this command-line interface, agendas are automated for further +processing or printing. + +#+vindex: org-agenda-custom-commands +#+findex: org-batch-agenda +~org-batch-agenda~ creates an agenda view in ASCII and outputs to +standard output. This command takes one string parameter. When +string consists of a single character, Org uses it as a key to +~org-agenda-custom-commands~. These are the same ones available +through the agenda dispatcher (see [[*The Agenda Dispatcher]]). + +This example command line directly prints the TODO list to the printer: + +: emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr + +When the string parameter length is two or more characters, Org +matches it with tags/TODO strings. For example, this example command +line prints items tagged with =shop=, but excludes items tagged with +=NewYork=: + +#+begin_example +emacs -batch -l ~/.emacs \ + -eval '(org-batch-agenda "+shop-NewYork")' | lpr +#+end_example + +#+texinfo: @noindent +An example showing on-the-fly parameter modifications: + +#+begin_example +emacs -batch -l ~/.emacs \ + -eval '(org-batch-agenda "a" \ + org-agenda-span (quote month) \ + org-agenda-include-diary nil \ + org-agenda-files (quote ("~/org/project.org")))' \ + | lpr +#+end_example + +#+texinfo: @noindent +which produces an agenda for the next 30 days from just the +=~/org/projects.org= file. + +#+findex: org-batch-agenda-csv +For structured processing of agenda output, use ~org-batch-agenda-csv~ +with the following fields: + +- category :: The category of the item +- head :: The headline, without TODO keyword, TAGS and PRIORITY +- type :: The type of the agenda entry, can be + + | ~todo~ | selected in TODO match | + | ~tagsmatch~ | selected in tags match | + | ~diary~ | imported from diary | + | ~deadline~ | a deadline | + | ~scheduled~ | scheduled | + | ~timestamp~ | appointment, selected by timestamp | + | ~closed~ | entry was closed on date | + | ~upcoming-deadline~ | warning about nearing deadline | + | ~past-scheduled~ | forwarded scheduled item | + | ~block~ | entry has date block including date | + +- todo :: The TODO keyword, if any +- tags :: All tags including inherited ones, separated by colons +- date :: The relevant date, like =2007-2-14= +- time :: The time, like =15:00-16:50= +- extra :: String with extra planning info +- priority-l :: The priority letter if any was given +- priority-n :: The computed numerical priority + +If the selection of the agenda item was based on a timestamp, +including those items with =DEADLINE= and =SCHEDULED= keywords, then +Org includes date and time in the output. + +If the selection of the agenda item was based on a timestamp (or +deadline/scheduled), then Org includes date and time in the output. + +Here is an example of a post-processing script in Perl. It takes the +CSV output from Emacs and prints with a checkbox: + +#+begin_src perl +#!/usr/bin/perl + +# define the Emacs command to run +$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; + +# run it and capture the output +$agenda = qx{$cmd 2>/dev/null}; + +# loop over all lines +foreach $line (split(/\n/,$agenda)) { + # get the individual values + ($category,$head,$type,$todo,$tags,$date,$time,$extra, + $priority_l,$priority_n) = split(/,/,$line); + # process and print + print "[ ] $head\n"; +} +#+end_src + +** Using the Property API +:PROPERTIES: +:DESCRIPTION: Writing programs that use entry properties. +:END: +#+cindex: API, for properties +#+cindex: properties, API + +Here is a description of the functions that can be used to work with +properties. + +#+attr_texinfo: :options org-entry-properties &optional pom which +#+begin_defun +Get all properties of the entry at point-or-marker {{{var(POM)}}}. +This includes the TODO keyword, the tags, time strings for deadline, +scheduled, and clocking, and any additional properties defined in the +entry. The return value is an alist. Keys may occur multiple times +if the property key was used several times. {{{var(POM)}}} may also +be ~nil~, in which case the current entry is used. If +{{{var(WHICH)}}} is ~nil~ or ~all~, get all properties. If +{{{var(WHICH)}}} is ~special~ or ~standard~, only get that subclass. +#+end_defun + +#+vindex: org-use-property-inheritance +#+findex: org-insert-property-drawer +#+attr_texinfo: :options org-entry-get pom property &optional inherit +#+begin_defun +Get value of {{{var(PROPERTY)}}} for entry at point-or-marker +{{{var(POM)}}}. By default, this only looks at properties defined +locally in the entry. If {{{var(INHERIT)}}} is non-~nil~ and the +entry does not have the property, then also check higher levels of the +hierarchy. If {{{var(INHERIT)}}} is the symbol ~selective~, use +inheritance if and only if the setting of +~org-use-property-inheritance~ selects {{{var(PROPERTY)}}} for +inheritance. +#+end_defun + +#+attr_texinfo: :options org-entry-delete pom property +#+begin_defun +Delete the property {{{var(PROPERTY)}}} from entry at point-or-marker +{{{var(POM)}}}. +#+end_defun + +#+attr_texinfo: :options org-entry-put pom property value +#+begin_defun +Set {{{var(PROPERTY)}}} to {{{var(VALUES)}}} for entry at +point-or-marker POM. +#+end_defun + +#+attr_texinfo: :options org-buffer-property-keys &optional include-specials +#+begin_defun +Get all property keys in the current buffer. +#+end_defun + +#+attr_texinfo: :options org-insert-property-drawer +#+begin_defun +Insert a property drawer for the current entry. Also +#+end_defun + +#+attr_texinfo: :options org-entry-put-multivalued-property pom property &rest values +#+begin_defun +Set {{{var(PROPERTY)}}} at point-or-marker {{{var(POM)}}} to +{{{var(VALUES)}}}. {{{var(VALUES)}}} should be a list of strings. +They are concatenated, with spaces as separators. +#+end_defun + +#+attr_texinfo: :options org-entry-get-multivalued-property pom property +#+begin_defun +Treat the value of the property {{{var(PROPERTY)}}} as +a whitespace-separated list of values and return the values as a list +of strings. +#+end_defun + +#+attr_texinfo: :options org-entry-add-to-multivalued-property pom property value +#+begin_defun +Treat the value of the property {{{var(PROPERTY)}}} as +a whitespace-separated list of values and make sure that +{{{var(VALUE)}}} is in this list. +#+end_defun + +#+attr_texinfo: :options org-entry-remove-from-multivalued-property pom property value +#+begin_defun +Treat the value of the property {{{var(PROPERTY)}}} as +a whitespace-separated list of values and make sure that +{{{var(VALUE)}}} is /not/ in this list. +#+end_defun + +#+attr_texinfo: :options org-entry-member-in-multivalued-property pom property value +#+begin_defun +Treat the value of the property {{{var(PROPERTY)}}} as +a whitespace-separated list of values and check if {{{var(VALUE)}}} is +in this list. +#+end_defun + +#+attr_texinfo: :options org-property-allowed-value-functions +#+begin_defopt +Hook for functions supplying allowed values for a specific property. +The functions must take a single argument, the name of the property, +and return a flat list of allowed values. If =:ETC= is one of the +values, use the values as completion help, but allow also other values +to be entered. The functions must return ~nil~ if they are not +responsible for this property. +#+end_defopt + +** Using the Mapping API +:PROPERTIES: +:DESCRIPTION: Mapping over all or selected entries. +:END: +#+cindex: API, for mapping +#+cindex: mapping entries, API + +Org has sophisticated mapping capabilities to find all entries +satisfying certain criteria. Internally, this functionality is used +to produce agenda views, but there is also an API that can be used to +execute arbitrary functions for each or selected entries. The main +entry point for this API is: + +#+attr_texinfo: :options org-map-entries func &optional match scope &rest skip +#+begin_defun +Call {{{var(FUNC)}}} at each headline selected by {{{var(MATCH)}}} in +{{{var(SCOPE)}}}. + +{{{var(FUNC)}}} is a function or a Lisp form. With point positioned +at the beginning of the headline, call the function without arguments. +Org returns an alist of return values of calls to the function. + +To avoid preserving point, Org wraps the call to {{{var(FUNC)}}} in +~save-excursion~ form. After evaluation, Org moves point to the end +of the line that was just processed. Search continues from that point +forward. This may not always work as expected under some conditions, +such as if the current sub-tree was removed by a previous archiving +operation. In such rare circumstances, Org skips the next entry +entirely when it should not. To stop Org from such skips, make +{{{var(FUNC)}}} set the variable ~org-map-continue-from~ to a specific +buffer position. + +{{{var(MATCH)}}} is a tags/property/TODO match. Org iterates only +matched headlines. Org iterates over all headlines when +{{{var(MATCH)}}} is ~nil~ or ~t~. + +{{{var(SCOPE)}}} determines the scope of this command. It can be any +of: + +- ~nil~ :: + + The current buffer, respecting the restriction, if any. + +- ~tree~ :: + + The subtree started with the entry at point. + +- ~region~ :: + + The entries within the active region, if any. + +- ~file~ :: + + The current buffer, without restriction. + +- ~file-with-archives~ :: + + The current buffer, and any archives associated with it. + +- ~agenda~ :: + + All agenda files. + +- ~agenda-with-archives~ :: + + All agenda files with any archive files associated with them. + +- list of filenames :: + + If this is a list, all files in the list are scanned. + +#+texinfo: @noindent +The remaining arguments are treated as settings for the scanner's +skipping facilities. Valid arguments are: + +- ~archive~ :: + + Skip trees with the =ARCHIVE= tag. + +- ~comment~ :: + + Skip trees with the COMMENT keyword. + +- function or Lisp form :: + + #+vindex: org-agenda-skip-function + Used as value for ~org-agenda-skip-function~, so whenever the + function returns ~t~, {{{var(FUNC)}}} is called for that entry and + search continues from the point where the function leaves it. +#+end_defun + +The mapping routine can call any arbitrary function, even functions +that change meta data or query the property API (see [[*Using the +Property API]]). Here are some handy functions: + +#+attr_texinfo: :options org-todo &optional arg +#+begin_defun +Change the TODO state of the entry. See the docstring of the +functions for the many possible values for the argument +{{{var(ARG)}}}. +#+end_defun + +#+attr_texinfo: :options org-priority &optional action +#+begin_defun +Change the priority of the entry. See the docstring of this function +for the possible values for {{{var(ACTION)}}}. +#+end_defun + +#+attr_texinfo: :options org-toggle-tag tag &optional onoff +#+begin_defun +Toggle the tag {{{var(TAG)}}} in the current entry. Setting +{{{var(ONOFF)}}} to either ~on~ or ~off~ does not toggle tag, but +ensure that it is either on or off. +#+end_defun + +#+attr_texinfo: :options org-promote +#+begin_defun +Promote the current entry. +#+end_defun + +#+attr_texinfo: :options org-demote +#+begin_defun +Demote the current entry. +#+end_defun + +This example turns all entries tagged with =TOMORROW= into TODO +entries with keyword =UPCOMING=. Org ignores entries in comment trees +and archive trees. + +#+begin_src emacs-lisp +(org-map-entries '(org-todo "UPCOMING") + "+TOMORROW" 'file 'archive 'comment) +#+end_src + +The following example counts the number of entries with TODO keyword +=WAITING=, in all agenda files. + +#+begin_src emacs-lisp +(length (org-map-entries t "/+WAITING" 'agenda)) +#+end_src + +* History and Acknowledgments +:PROPERTIES: +:DESCRIPTION: How Org came into being. +:APPENDIX: t +:END: + +** From Carsten +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +Org was born in 2003, out of frustration over the user interface of +the Emacs Outline mode. I was trying to organize my notes and +projects, and using Emacs seemed to be the natural way to go. +However, having to remember eleven different commands with two or +three keys per command, only to hide and show parts of the outline +tree, that seemed entirely unacceptable to me. Also, when using +outlines to take notes, I constantly wanted to restructure the tree, +organizing it parallel to my thoughts and plans. /Visibility cycling/ +and /structure editing/ were originally implemented in the package +=outline-magic.el=, but quickly moved to the more general =org.el=. +As this environment became comfortable for project planning, the next +step was adding /TODO entries/, basic /timestamps/, and /table +support/. These areas highlighted the two main goals that Org still +has today: to be a new, outline-based, plain text mode with innovative +and intuitive editing features, and to incorporate project planning +functionality directly into a notes file. + +Since the first release, literally thousands of emails to me or to the +[[mailto:emacs-orgmode@gnu.org][mailing list]] have provided a constant stream of bug reports, feedback, +new ideas, and sometimes patches and add-on code. Many thanks to +everyone who has helped to improve this package. I am trying to keep +here a list of the people who had significant influence in shaping one +or more aspects of Org. The list may not be complete, if I have +forgotten someone, please accept my apologies and let me know. + +Before I get to this list, a few special mentions are in order: + +- Bastien Guerry :: + + Bastien has written a large number of extensions to Org (most of + them integrated into the core by now), including the LaTeX exporter + and the plain list parser. His support during the early days was + central to the success of this project. Bastien also invented Worg, + helped establishing the Web presence of Org, and sponsored hosting + costs for the orgmode.org website. Bastien stepped in as maintainer + of Org between 2011 and 2013, at a time when I desperately needed + a break. + +- Eric Schulte and Dan Davison :: + + Eric and Dan are jointly responsible for the Org Babel system, which + turns Org into a multi-language environment for evaluating code and + doing literate programming and reproducible research. This has + become one of Org's killer features that define what Org is today. + +- John Wiegley :: + + John has contributed a number of great ideas and patches directly to + Org, including the attachment system (=org-attach.el=), integration + with Apple Mail (=org-mac-message.el=), hierarchical dependencies of + TODO items, habit tracking (=org-habits.el=), and encryption + (=org-crypt.el=). Also, the capture system is really an extended + copy of his great =remember.el=. + +- Sebastian Rose :: + + Without Sebastian, the HTML/XHTML publishing of Org would be the + pitiful work of an ignorant amateur. Sebastian has pushed this part + of Org onto a much higher level. He also wrote =org-info.js=, + a JavaScript program for displaying webpages derived from Org using + an Info-like or a folding interface with single-key navigation. + +See below for the full list of contributions! Again, please let me +know what I am missing here! + +** From Bastien +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +I (Bastien) have been maintaining Org between 2011 and 2013. This +appendix would not be complete without adding a few more +acknowledgments and thanks. + +I am first grateful to Carsten for his trust while handing me over the +maintainership of Org. His unremitting support is what really helped +me getting more confident over time, with both the community and the +code. + +When I took over maintainership, I knew I would have to make Org more +collaborative than ever, as I would have to rely on people that are +more knowledgeable than I am on many parts of the code. Here is +a list of the persons I could rely on, they should really be +considered co-maintainers, either of the code or the community: + +- Eric Schulte :: + + Eric is maintaining the Babel parts of Org. His reactivity here + kept me away from worrying about possible bugs here and let me focus + on other parts. + +- Nicolas Goaziou :: + + Nicolas is maintaining the consistency of the deepest parts of Org. + His work on =org-element.el= and =ox.el= has been outstanding, and + it opened the doors for many new ideas and features. He rewrote + many of the old exporters to use the new export engine, and helped + with documenting this major change. More importantly (if that's + possible), he has been more than reliable during all the work done + for Org 8.0, and always very reactive on the mailing list. + +- Achim Gratz :: + + Achim rewrote the building process of Org, turning some /ad hoc/ + tools into a flexible and conceptually clean process. He patiently + coped with the many hiccups that such a change can create for users. + +- Nick Dokos :: + + The Org mode mailing list would not be such a nice place without + Nick, who patiently helped users so many times. It is impossible to + overestimate such a great help, and the list would not be so active + without him. + +I received support from so many users that it is clearly impossible to +be fair when shortlisting a few of them, but Org's history would not +be complete if the ones above were not mentioned in this manual. + +** List of Contributions +:PROPERTIES: +:UNNUMBERED: notoc +:END: + +- Russell Adams came up with the idea for drawers. + +- Thomas Baumann wrote =ol-bbdb.el= and =ol-mhe.el=. + +- Christophe Bataillon created the great unicorn logo that we use on + the Org mode website. + +- Alex Bochannek provided a patch for rounding timestamps. + +- Jan Böcker wrote =ol-docview.el=. + +- Brad Bozarth showed how to pull RSS feed data into Org files. + +- Tom Breton wrote =org-choose.el=. + +- Charles Cave's suggestion sparked the implementation of templates + for Remember, which are now templates for capture. + +- Pavel Chalmoviansky influenced the agenda treatment of items with + specified time. + +- Gregory Chernov patched support for Lisp forms into table + calculations and improved XEmacs compatibility, in particular by + porting =nouline.el= to XEmacs. + +- Sacha Chua suggested copying some linking code from Planner. + +- Baoqiu Cui contributed the DocBook exporter. + +- Eddward DeVilla proposed and tested checkbox statistics. He also + came up with the idea of properties, and that there should be an API + for them. + +- Nick Dokos tracked down several nasty bugs. + +- Kees Dullemond used to edit projects lists directly in HTML and so + inspired some of the early development, including HTML export. He + also asked for a way to narrow wide table columns. + +- Thomas\nbsp{}S.\nbsp{}Dye contributed documentation on Worg and helped + integrating the Org Babel documentation into the manual. + +- Christian Egli converted the documentation into Texinfo format, + inspired the agenda, patched CSS formatting into the HTML exporter, + and wrote =org-taskjuggler.el=. + +- David Emery provided a patch for custom CSS support in exported HTML + agendas. + +- Nic Ferrier contributed mailcap and XOXO support. + +- Miguel\nbsp{}A.\nbsp{}Figueroa-Villanueva implemented hierarchical checkboxes. + +- John Foerch figured out how to make incremental search show context + around a match in a hidden outline tree. + +- Raimar Finken wrote =org-git-line.el=. + +- Mikael Fornius works as a mailing list moderator. + +- Austin Frank works as a mailing list moderator. + +- Eric Fraga drove the development of Beamer export with ideas and + testing. + +- Barry Gidden did proofreading the manual in preparation for the book + publication through Network Theory Ltd. + +- Niels Giesen had the idea to automatically archive DONE trees. + +- Nicolas Goaziou rewrote much of the plain list code. + +- Kai Grossjohann pointed out key-binding conflicts with other + packages. + +- Brian Gough of Network Theory Ltd publishes the Org mode manual as + a book. + +- Bernt Hansen has driven much of the support for auto-repeating + tasks, task state change logging, and the clocktable. His clear + explanations have been critical when we started to adopt the Git + version control system. + +- Manuel Hermenegildo has contributed various ideas, small fixes and + patches. + +- Phil Jackson wrote =ol-irc.el=. + +- Scott Jaderholm proposed footnotes, control over whitespace between + folded entries, and column view for properties. + +- Matt Jones wrote MobileOrg Android. + +- Tokuya Kameshima wrote =org-wl.el= and =org-mew.el=. + +- Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also + provided frequent feedback and some patches. + +- Matt Lundin has proposed last-row references for table formulas and + named invisible anchors. He has also worked a lot on the FAQ. + +- David Maus wrote =org-atom.el=, maintains the issues file for Org, + and is a prolific contributor on the mailing list with competent + replies, small fixes and patches. + +- Jason\nbsp{}F.\nbsp{}McBrayer suggested agenda export to CSV format. + +- Max Mikhanosha came up with the idea of refiling. + +- Dmitri Minaev sent a patch to set priority limits on a per-file + basis. + +- Stefan Monnier provided a patch to keep the Emacs Lisp compiler + happy. + +- Richard Moreland wrote MobileOrg for the iPhone. + +- Rick Moynihan proposed allowing multiple TODO sequences in a file + and being able to quickly restrict the agenda to a subtree. + +- Todd Neal provided patches for links to Info files and Elisp forms. + +- Greg Newman refreshed the unicorn logo into its current form. + +- Tim O'Callaghan suggested in-file links, search options for general + file links, and tags. + +- Osamu Okano wrote =orgcard2ref.pl=, a Perl program to create a text + version of the reference card. + +- Takeshi Okano translated the manual and David O'Toole's tutorial + into Japanese. + +- Oliver Oppitz suggested multi-state TODO items. + +- Scott Otterson sparked the introduction of descriptive text for + links, among other things. + +- Pete Phillips helped during the development of the TAGS feature, + and provided frequent feedback. + +- Martin Pohlack provided the code snippet to bundle character + insertion into bundles of 20 for undo. + +- T.\nbsp{}V.\nbsp{}Raman reported bugs and suggested improvements. + +- Matthias Rempe (Oelde) provided ideas, Windows support, and quality + control. + +- Paul Rivier provided the basic implementation of named footnotes. + He also acted as mailing list moderator for some time. + +- Kevin Rogers contributed code to access VM files on remote hosts. + +- Frank Ruell solved the mystery of the =keymapp nil= bug, a conflict + with =allout.el=. + +- Jason Riedy generalized the send-receive mechanism for Orgtbl + tables with extensive patches. + +- Philip Rooke created the Org reference card, provided lots of + feedback, developed and applied standards to the Org documentation. + +- Christian Schlauer proposed angular brackets around links, among + other things. + +- Paul Sexton wrote =org-ctags.el=. + +- Tom Shannon's =organizer-mode.el= inspired linking to VM/BBDB/Gnus. + +- Ilya Shlyakhter proposed the Archive Sibling, line numbering in + literal examples, and remote highlighting for referenced code lines. + +- Stathis Sideris wrote the =ditaa.jar= ASCII to PNG converter that is + now packaged into Org's =contrib/= directory. + +- Daniel Sinder came up with the idea of internal archiving by locking + subtrees. + +- Dale Smith proposed link abbreviations. + +- James TD Smith has contributed a large number of patches for + useful tweaks and features. + +- Adam Spiers asked for global linking commands, inspired the link + extension system, added support for Mairix, and proposed the mapping + API. + +- Ulf Stegemann created the table to translate special symbols to + HTML, LaTeX, UTF-8, Latin-1 and ASCII. + +- Andy Stewart contributed code to =ol-w3m.el=, to copy + HTML content with links transformation to Org syntax. + +- David O'Toole wrote =org-publish.el= and drafted the + manual chapter about publishing. + +- Jambunathan\nbsp{}K.\nbsp{}contributed the ODT exporter. + +- Sebastien Vauban reported many issues with LaTeX and Beamer export + and enabled source code highlighting in Gnus. + +- Stefan Vollmar organized a video-recorded talk at the + Max-Planck-Institute for Neurology. He also inspired the creation + of a concept index for HTML export. + +- Jürgen Vollmer contributed code generating the table of contents in + HTML output. + +- Samuel Wales has provided important feedback and bug reports. + +- Chris Wallace provided a patch implementing the =QUOTE= block. + +- David Wainberg suggested archiving, and improvements to the + linking system. + +- Carsten Wimmer suggested some changes and helped fix a bug in + linking to Gnus. + +- Roland Winkler requested additional key bindings to make Org work on + a TTY. + +- Piotr Zielinski wrote =org-mouse.el=, proposed agenda + blocks and contributed various ideas and code snippets. + +- Marco Wahl wrote =ol-eww.el=. + +* GNU Free Documentation License +:PROPERTIES: +:APPENDIX: t +:DESCRIPTION: The license for this documentation. +:END: + +#+texinfo: @include doclicense.texi + +* Main Index +:PROPERTIES: +:INDEX: cp +:DESCRIPTION: An index of Org's concepts and features. +:END: + +* Key Index +:PROPERTIES: +:DESCRIPTION: Key bindings and where they are described. +:INDEX: ky +:END: + +* Command and Function Index +:PROPERTIES: +:DESCRIPTION: Command names and some internal functions. +:INDEX: fn +:END: + +* Variable Index +:PROPERTIES: +:DESCRIPTION: Variables mentioned in the manual. +:INDEX: vr +:END: + +This is not a complete index of variables and faces, only the ones +that are mentioned in the manual. For a more complete list, use +{{{kbd(M-x org-customize)}}} and then click yourself through the tree. + +* Copying +:PROPERTIES: +:copying: t +:END: + +This manual is for Org version {{{version}}}. + +Copyright \copy 2004--2021 Free Software Foundation, Inc. + +#+begin_quote +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover Texts being "A GNU Manual," +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled "GNU Free Documentation License." + +(a) The FSF's Back-Cover Text is: "You have the freedom to copy and +modify this GNU manual." +#+end_quote + +* Export Setup :noexport: + +#+setupfile: org-setup.org + +#+export_file_name: org.texi + +#+texinfo_dir_category: Emacs editing modes +#+texinfo_dir_title: Org Mode: (org) +#+texinfo_dir_desc: Outline-based notes management and organizer + +* Footnotes + +[fn:1] If you do not use Font Lock globally turn it on in Org buffer +with =(add-hook 'org-mode-hook 'turn-on-font-lock)=. + +[fn:2] Please consider subscribing to the mailing list in order to +minimize the work the mailing list moderators have to do. + +[fn:3] See the variables ~org-special-ctrl-a/e~, ~org-special-ctrl-k~, +and ~org-ctrl-k-protect-subtree~ to configure special behavior of +{{{kbd(C-a)}}}, {{{kbd(C-e)}}}, and {{{kbd(C-k)}}} in headlines. Note +also that clocking only works with headings indented less than 30 +stars. + +[fn:4] See, however, the option ~org-cycle-emulate-tab~. + +[fn:5] The indirect buffer contains the entire buffer, but is narrowed +to the current tree. Editing the indirect buffer also changes the +original buffer, but without affecting visibility in that buffer. For +more information about indirect buffers, see [[info:emacs#Indirect Buffers][GNU Emacs Manual]]. + +[fn:6] When ~org-agenda-inhibit-startup~ is non-~nil~, Org does not +honor the default visibility state when first opening a file for the +agenda (see [[*Speeding Up Your Agendas]]). + +[fn:7] See also the variable ~org-show-context-detail~ to decide how +much context is shown around each match. + +[fn:8] This depends on the option ~org-remove-highlights-with-change~. + +[fn:9] When using =*= as a bullet, lines must be indented so that they +are not interpreted as headlines. Also, when you are hiding leading +stars to get a clean outline view, plain list items starting with +a star may be hard to distinguish from true headlines. In short: even +though =*= is supported, it may be better to not use it for plain list +items. + +[fn:10] You can filter out any of them by configuring +~org-plain-list-ordered-item-terminator~. + +[fn:11] You can also get =a.=, =A.=, =a)= and =A)= by configuring +~org-list-allow-alphabetical~. To minimize confusion with normal +text, those are limited to one character only. Beyond that limit, +bullets automatically become numbers. + +[fn:12] If there's a checkbox in the item, the cookie must be put +/before/ the checkbox. If you have activated alphabetical lists, you +can also use counters like =[@b]=. + +[fn:13] If you do not want the item to be split, customize the +variable ~org-M-RET-may-split-line~. + +[fn:14] If you want to cycle around items that way, you may customize +~org-list-use-circular-motion~. + +[fn:15] See ~org-list-use-circular-motion~ for a cyclic behavior. + +[fn:16] Many desktops intercept {{{kbd(M-TAB)}}} to switch windows. +Use {{{kbd(C-M-i)}}} or {{{kbd(ESC TAB)}}} instead. + +[fn:17] To insert a vertical bar into a table field, use =\vert= or, +inside a word =abc\vert{}def=. + +[fn:18] Org understands references typed by the user as =B4=, but it +does not use this syntax when offering a formula for editing. You can +customize this behavior using the variable +~org-table-use-standard-references~. + +[fn:19] The computation time scales as O(N^2) because table +{{{var(FOO)}}} is parsed for each field to be copied. + +[fn:20] The file =constants.el= can supply the values of constants in +two different unit systems, =SI= and =cgs=. Which one is used depends +on the value of the variable ~constants-unit-system~. You can use the +=STARTUP= options =constSI= and =constcgs= to set this value for the +current buffer. + +[fn:21] The printf reformatting is limited in precision because the +value passed to it is converted into an "integer" or "double". The +"integer" is limited in size by truncating the signed value to 32 +bits. The "double" is limited in precision to 64 bits overall which +leaves approximately 16 significant decimal digits. + +[fn:22] Such names must start with an alphabetic character and use +only alphanumeric/underscore characters. + +[fn:23] Plain URIs are recognized only for a well-defined set of +schemes. See [[*External Links]]. Unlike URI syntax, they cannot contain +parenthesis or white spaces, either. URIs within angle brackets have +no such limitation. + +[fn:24] More accurately, the precise behavior depends on how point +arrived there---see [[info:elisp#Invisible Text][Invisible Text]]. + +[fn:25] To insert a link targeting a headline, in-buffer completion +can be used. Just type a star followed by a few optional letters into +the buffer and press {{{kbd(M-TAB)}}}. All headlines in the current +buffer are offered as completions. + +[fn:26] When targeting a =NAME= keyword, the =CAPTION= keyword is +mandatory in order to get proper numbering (see [[*Captions]]). + +[fn:27] The actual behavior of the search depends on the value of the +variable ~org-link-search-must-match-exact-headline~. If its value is +~nil~, then a fuzzy text search is done. If it is ~t~, then only the +exact headline is matched, ignoring spaces and statistic cookies. If +the value is ~query-to-create~, then an exact headline is searched; if +it is not found, then the user is queried to create it. + +[fn:28] If the headline contains a timestamp, it is removed from the +link, which results in a wrong link---you should avoid putting +a timestamp in the headline. + +[fn:29] The Org Id library must first be loaded, either through +~org-customize~, by enabling ~id~ in ~org-modules~, or by adding +=(require 'org-id)= in your Emacs init file. + +[fn:30] Note that you do not have to use this command to insert +a link. Links in Org are plain text, and you can type or paste them +straight into the buffer. By using this command, the links are +automatically enclosed in double brackets, and you will be asked for +the optional descriptive text. + +[fn:31] After insertion of a stored link, the link will be removed +from the list of stored links. To keep it in the list for later use, +use a triple {{{kbd(C-u)}}} prefix argument to {{{kbd(C-c C-l)}}}, or +configure the option ~org-link-keep-stored-after-insertion~. + +[fn:32] This works if a function has been defined in the ~:complete~ +property of a link in ~org-link-parameters~. + +[fn:33] See the variable ~org-link-use-indirect-buffer-for-internals~. + +[fn:34] For backward compatibility, line numbers can also follow a +single colon. + +[fn:35] Of course, you can make a document that contains only long +lists of TODO items, but this is not required. + +[fn:36] Changing the variable ~org-todo-keywords~ only becomes +effective after restarting Org mode in a buffer. + +[fn:37] This is also true for the {{{kbd(t)}}} command in the agenda +buffer. + +[fn:38] All characters are allowed except =@=, =^= and =!=, which have +a special meaning here. + +[fn:39] Check also the variable ~org-fast-tag-selection-include-todo~, +it allows you to change the TODO state through the tags interface (see +[[*Setting Tags]]), in case you like to mingle the two concepts. Note +that this means you need to come up with unique keys across both sets +of keywords. + +[fn:40] Org mode parses these lines only when Org mode is activated +after visiting a file. {{{kbd(C-c C-c)}}} with point in a line +starting with =#+= is simply restarting Org mode for the current +buffer. + +[fn:41] The corresponding in-buffer setting is: =#+STARTUP: logdone=. + +[fn:42] The corresponding in-buffer setting is: =#+STARTUP: +lognotedone=. + +[fn:43] See the variable ~org-log-states-order-reversed~. + +[fn:44] Note that the =LOGBOOK= drawer is unfolded when pressing +{{{kbd(SPC)}}} in the agenda to show an entry---use {{{kbd(C-u +SPC)}}} to keep it folded here. + +[fn:45] It is possible that Org mode records two timestamps when you +are using both ~org-log-done~ and state change logging. However, it +never prompts for two notes: if you have configured both, the state +change recording note takes precedence and cancel the closing note. + +[fn:46] See also the option ~org-priority-start-cycle-with-default~. + +[fn:47] To keep subtasks out of the global TODO list, see the option +~org-agenda-todo-list-sublevels~. + +[fn:48] With the exception of description lists. But you can allow it +by modifying ~org-list-automatic-rules~ accordingly. + +[fn:49] Set the variable ~org-hierarchical-checkbox-statistics~ if you +want such cookies to count all checkboxes below the cookie, not just +those belonging to direct children. + +[fn:50] {{{kbd(C-u C-c C-c)}}} on the /first/ item of a list with no +checkbox adds checkboxes to the rest of the list. + +[fn:51] As with all these in-buffer settings, pressing {{{kbd(C-c +C-c)}}} activates any changes in the line. + +[fn:52] This is only true if the search does not involve more complex +tests including properties (see [[*Property Searches]]). + +[fn:53] To extend this default list to all tags used in all agenda +files (see [[*Agenda Views]]), customize the variable +~org-complete-tags-always-offer-all-agenda-tags~. + +[fn:54] Keys are automatically assigned to tags that have no +configured keys. + +[fn:55] If more than one summary type applies to the same property, +the parent values are computed according to the first of them. + +[fn:56] An age can be defined as a duration, using units defined in +~org-duration-units~, e.g., =3d 1h=. If any value in the column is as +such, the summary is also expressed as a duration. + +[fn:57] Please note that the =COLUMNS= definition must be on a single +line; it is wrapped here only because of formatting constraints. + +[fn:58] Contributed packages are not part of Emacs, but are +distributed with the main distribution of Org---visit +[[https://orgmode.org]]. + +[fn:59] The Org date format is inspired by the standard ISO 8601 +date/time format. To use an alternative format, see [[*Custom time +format]]. The day name is optional when you type the date yourself. +However, any date inserted or modified by Org adds that day name, for +reading convenience. + +[fn:60] When working with the standard diary expression functions, you +need to be very careful with the order of the arguments. That order +depends evilly on the variable ~calendar-date-style~. For example, to +specify a date December 12, 2005, the call might look like +=(diary-date 12 1 2005)= or =(diary-date 1 12 2005)= or =(diary-date +2005 12 1)=, depending on the settings. This has been the source of +much confusion. Org mode users can resort to special versions of +these functions like ~org-date~ or ~org-anniversary~. These work just +like the corresponding ~diary-~ functions, but with stable ISO order +of arguments (year, month, day) wherever applicable, independent of +the value of ~calendar-date-style~. + +[fn:61] See the variable ~org-read-date-prefer-future~. You may set +that variable to the symbol ~time~ to even make a time before now +shift the date to tomorrow. + +[fn:62] If you do not need/want the calendar, configure the variable +~org-popup-calendar-for-date-prompt~. + +[fn:63] You can also use the calendar command {{{kbd(.)}}} to jump to +today's date, but if you are inserting an hour specification for your +timestamp, {{{kbd(.)}}} will then insert a dot after the hour. By contrast, +{{{kbd(C-.)}}} will always jump to today's date. + +[fn:64] If you find this distracting, turn off the display with +~org-read-date-display-live~. + +[fn:65] It will still be listed on that date after it has been marked +as done. If you do not like this, set the variable +~org-agenda-skip-scheduled-if-done~. + +[fn:66] The =SCHEDULED= and =DEADLINE= dates are inserted on the line +right below the headline. Do not put any text between this line and +the headline. + +[fn:67] Note the corresponding =STARTUP= options =logredeadline=, +=lognoteredeadline=, and =nologredeadline=. + +[fn:68] Note the corresponding =STARTUP= options =logreschedule=, +=lognotereschedule=, and =nologreschedule=. + +[fn:69] Org does not repeat inactive timestamps, however. See +[[*Timestamps]]. + +[fn:70] In fact, the target state is taken from, in this sequence, the +=REPEAT_TO_STATE= property, the variable ~org-todo-repeat-to-state~ if +it is a string, the previous TODO state if ~org-todo-repeat-to-state~ +is ~t~, or the first state of the TODO state sequence. + +[fn:71] You can change this using the option ~org-log-repeat~, or the +=STARTUP= options =logrepeat=, =lognoterepeat=, and =nologrepeat=. +With =lognoterepeat=, you will also be prompted for a note. + +[fn:72] Clocking only works if all headings are indented with less +than 30 stars. This is a hard-coded limitation of ~lmax~ in +~org-clock-sum~. + +[fn:73] To resume the clock under the assumption that you have worked +on this task while outside Emacs, use =(setq org-clock-persist t)=. + +[fn:74] To add an effort estimate "on the fly", hook a function doing +this to ~org-clock-in-prepare-hook~. + +[fn:75] The last reset of the task is recorded by the =LAST_REPEAT= +property. + +[fn:76] See also the variable ~org-clock-mode-line-total~. + +[fn:77] The corresponding in-buffer setting is: =#+STARTUP: +lognoteclock-out=. + +[fn:78] When using ~:step~, ~untilnow~ starts from the beginning of +2003, not the beginning of time. + +[fn:79] Language terms can be set through the variable +~org-clock-clocktable-language-setup~. + +[fn:80] Note that all parameters must be specified in a single +line---the line is broken here only to fit it into the manual. + +[fn:81] On computers using macOS, idleness is based on actual user +idleness, not just Emacs' idle time. For X11, you can install +a utility program =x11idle.c=, available in the =contrib/scripts/= +directory of the Org Git distribution, or install the xprintidle +package and set it to the variable ~org-clock-x11idle-program-name~ if +you are running Debian, to get the same general treatment of idleness. +On other systems, idle time refers to Emacs idle time only. + +[fn:82] Please note the pitfalls of summing hierarchical data in +a flat list (see [[*Using Column View in the Agenda]]). + +[fn:83] Note the corresponding =STARTUP= options =logrefile=, +=lognoterefile=, and =nologrefile=. + +[fn:84] Org used to offer four different targets for date/week tree +capture. Now, Org automatically translates these to use +~file+olp+datetree~, applying the ~:time-prompt~ and ~:tree-type~ +properties. Please rewrite your date/week-tree targets using +~file+olp+datetree~ since the older targets are now deprecated. + +[fn:85] A date tree is an outline structure with years on the highest +level, months or ISO weeks as sublevels and then dates on the lowest +level. Tags are allowed in the tree structure. + +[fn:86] When the file name is not absolute, Org assumes it is relative +to ~org-directory~. + +[fn:87] If you need one of these sequences literally, escape the =%= +with a backslash. + +[fn:88] If you define your own link types (see [[*Adding Hyperlink +Types]]), any property you store with ~org-store-link-props~ can be +accessed in capture templates in a similar way. + +[fn:89] This is always the other, not the user. See the variable +~org-link-from-user-regexp~. + +[fn:90] If you move entries or Org files from one directory to +another, you may want to configure ~org-attach-id-dir~ to contain +an absolute path. + +[fn:91] If the value of that variable is not a list, but a single file +name, then the list of agenda files in maintained in that external +file. + +[fn:92] When using the dispatcher, pressing {{{kbd(<)}}} before +selecting a command actually limits the command to the current file, +and ignores ~org-agenda-files~ until the next dispatcher command. + +[fn:93] For backward compatibility, you can also press {{{kbd(1)}}} to +restrict to the current buffer. + +[fn:94] For backward compatibility, you can also press {{{kbd(0)}}} to +restrict to the current region/subtree. + +[fn:95] For backward compatibility, the universal prefix argument +{{{kbd(C-u)}}} causes all TODO entries to be listed before the agenda. +This feature is deprecated, use the dedicated TODO list, or a block +agenda instead (see [[*Block agenda]]). + +[fn:96] The variable ~org-anniversary~ used in the example is just +like ~diary-anniversary~, but the argument order is always according +to ISO and therefore independent of the value of +~calendar-date-style~. + +[fn:97] You can, however, disable this by setting +~org-agenda-search-headline-for-time~ variable to a ~nil~ value. + +[fn:98] Custom agenda commands can preset a filter by binding one of +the variables ~org-agenda-tag-filter-preset~, +~org-agenda-category-filter-preset~, ~org-agenda-effort-filter-preset~ +or ~org-agenda-regexp-filter-preset~ as an option. This filter is +then applied to the view and persists as a basic filter through +refreshes and more secondary filtering. The filter is a global +property of the entire agenda view---in a block agenda, you should +only set this in the global options section, not in the section of an +individual block. + +[fn:99] Only tags filtering is respected here, effort filtering is +ignored. + +[fn:100] You can also create persistent custom functions through +~org-agenda-bulk-custom-functions~. + +[fn:101] This file is parsed for the agenda when +~org-agenda-include-diary~ is set. + +[fn:102] You can provide a description for a prefix key by inserting +a cons cell with the prefix and the description. + +[fn:103] /Planned/ means here that these entries have some planning +information attached to them, like a time-stamp, a scheduled or +a deadline string. See ~org-agenda-entry-types~ on how to set what +planning information is taken into account. + +[fn:104] For HTML you need to install Hrvoje Nikšić's =htmlize.el= +as an Emacs package from MELPA or from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Nikšić's repository]]. + +[fn:105] To create PDF output, the Ghostscript ps2pdf utility must be +installed on the system. Selecting a PDF file also creates the +postscript file. + +[fn:106] If you want to store standard views like the weekly agenda or +the global TODO list as well, you need to define custom commands for +them in order to be able to specify file names. + +[fn:107] Quoting depends on the system you use, please check the FAQ +for examples. + +[fn:108] You can turn this on by default by setting the variable +~org-pretty-entities~, or on a per-file base with the =STARTUP= option +=entitiespretty=. + +[fn:109] This behavior can be disabled with =-= export setting (see +[[*Export Settings]]). + +[fn:110] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX +system. Many of the features described here as "LaTeX" are really +from TeX, but for simplicity I am blurring this distinction. + +[fn:111] When MathJax is used, only the environments recognized by +MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is +used to create images, any LaTeX environment is handled. + +[fn:112] These are respectively available at +[[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]] +and from the ImageMagick suite. Choose the converter by setting the +variable ~org-preview-latex-default-process~ accordingly. + +[fn:113] Org mode has a method to test if point is inside such +a fragment, see the documentation of the function +~org-inside-LaTeX-fragment-p~. + +[fn:114] This works automatically for the HTML backend (it requires +version 1.34 of the =htmlize.el= package, which you need to install). +Fontified code chunks in LaTeX can be achieved using either the +[[https://www.ctan.org/pkg/listings][listings]] package or the [[https://www.ctan.org/pkg/minted][minted]] package. Refer to +~org-export-latex-listings~ for details. + +[fn:115] Source code in code blocks may also be evaluated either +interactively or on export. See [[*Working with Source Code]] for more +information on evaluating code blocks. + +[fn:116] Adding =-k= to =-n -r= /keeps/ the labels in the source code +while using line numbers for the links, which might be useful to +explain those in an Org mode example code. + +[fn:117] You may select a different mode with the variable +~org-edit-fixed-width-region-mode~. + +[fn:118] What Emacs considers to be an image depends on +~image-file-name-extensions~ and ~image-file-name-regexps~. + +[fn:119] The variable ~org-startup-with-inline-images~ can be set +within a buffer with the =STARTUP= options =inlineimages= and +=noinlineimages=. + +[fn:120] The corresponding in-buffer setting is: =#+STARTUP: fninline= +or =#+STARTUP: nofninline=. + +[fn:121] The corresponding in-buffer options are =#+STARTUP: fnadjust= +and =#+STARTUP: nofnadjust=. + +[fn:122] The variable ~org-export-date-timestamp-format~ defines how +this timestamp are exported. + +[fn:123] DEFINITION NOT FOUND. + +[fn:124] At the moment, some export back-ends do not obey this +specification. For example, LaTeX export excludes every unnumbered +headline from the table of contents. + +[fn:125] Note that ~org-link-search-must-match-exact-headline~ is +locally bound to non-~nil~. Therefore, ~org-link-search~ only matches +headlines and named elements. + +[fn:126] Since commas separate the arguments, commas within arguments +have to be escaped with the backslash character. So only those +backslash characters before a comma need escaping with another +backslash character. + +[fn:127] For a less drastic behavior, consider using a select tag (see +[[*Export Settings]]) instead. + +[fn:128] If =BEAMER_ENV= is set, Org export adds =B_environment= tag +to make it visible. The tag serves as a visual aid and has no +semantic relevance. + +[fn:129] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by +[[http://www.mathjax.org][MathJax]]. + +[fn:130] Please note that exported formulas are part of an HTML +document, and that signs such as =<=, =>=, or =&= have special +meanings. See [[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax TeX and LaTeX support]]. + +[fn:131] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn +about extensions. + +[fn:132] If the classes on TODO keywords and tags lead to conflicts, +use the variables ~org-html-todo-kwd-class-prefix~ and +~org-html-tag-class-prefix~ to make them unique. + +[fn:133] This does not allow setting different bibliography compilers +for different files. However, "smart" LaTeX compilation systems, such +as latexmk, can select the correct bibliography compiler. + +[fn:134] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications +(OpenDocument) Version 1.2]]. + +[fn:135] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]]. + +[fn:136] See [[http://dlmf.nist.gov/LaTeXML/]]. + +[fn:137] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]] + +[fn:138] See the =<table:table-template>= element of the +OpenDocument-v1.2 specification. + +[fn:139] See the attributes =table:template-name=, +=table:use-first-row-styles=, =table:use-last-row-styles=, +=table:use-first-column-styles=, =table:use-last-column-styles=, +=table:use-banding-rows-styles=, and =table:use-banding-column-styles= +of the =<table:table>= element in the OpenDocument-v1.2 specification. + +[fn:140] If the publishing directory is the same as the source +directory, =file.org= is exported as =file.org.org=, so you probably +do not want to do this. + +[fn:141] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used +to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding. + +[fn:142] Actually, the constructs =call_<name>()= and =src_<lang>{}= +are not evaluated when they appear in a keyword (see [[*Summary of +In-Buffer Settings]]). + +[fn:143] C++ language is handled in =ob-C.el=. Even though the +identifier for such source blocks is =C++=, you activate it by loading +the C language. + +[fn:144] D language is handled in =ob-C.el=. Even though the +identifier for such source blocks is =D=, you activate it by loading +the C language. + +[fn:145] For noweb literate programming details, see +http://www.cs.tufts.edu/~nr/noweb/. + +[fn:146] For more information, please refer to the commentary section +in =org-tempo.el=. + +[fn:147] Org Indent mode also sets ~wrap-prefix~ correctly for +indenting and wrapping long lines of headlines or text. This minor +mode also handles Visual Line mode and directly applied settings +through ~word-wrap~. + +[fn:148] This works, but requires extra effort. Org Indent mode is +more convenient for most applications. + +[fn:149] ~org-adapt-indentation~ can also be set to ='headline-data=, +in which case only data lines below the headline will be indented. + +[fn:150] Note that Org Indent mode also sets the ~wrap-prefix~ +property, such that Visual Line mode (or purely setting ~word-wrap~) +wraps long lines, including headlines, correctly indented. + +[fn:151] For a server to host files, consider using a WebDAV server, +such as [[https://nextcloud.com][Nextcloud]]. Additional help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]]. + +[fn:152] If Emacs is configured for safe storing of passwords, then +configure the variable ~org-mobile-encryption-password~; please read +the docstring of that variable. + +[fn:153] Symbolic links in ~org-directory~ need to have the same name +as their targets. + +[fn:154] While creating the agendas, Org mode forces =ID= properties +on all referenced entries, so that these entries can be uniquely +identified if Org Mobile flags them for further action. To avoid +setting properties configure the variable +~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies +on outline paths, assuming they are unique. + +[fn:155] Checksums are stored automatically in the file +=checksums.dat=. + +[fn:156] The file will be empty after this operation. + +[fn:157] https://www.ctan.org/pkg/comment + +[fn:158] By default this works only for LaTeX, HTML, and Texinfo. +Configure the variable ~orgtbl-radio-table-templates~ to install +templates for other modes. + +[fn:159] If the =TBLFM= keyword contains an odd number of dollar +characters, this may cause problems with Font Lock in LaTeX mode. As +shown in the example you can fix this by adding an extra line inside +the =comment= environment that is used to balance the dollar +expressions. If you are using AUCTeX with the font-latex library, +a much better solution is to add the =comment= environment to the +variable ~LaTeX-verbatim-environments~. + +[fn:160] The ~agenda*~ view is the same as ~agenda~ except that it +only considers /appointments/, i.e., scheduled and deadline items that +have a time specification =[h]h:mm= in their time-stamps. + +[fn:161] Note that, for ~org-odd-levels-only~, a level number +corresponds to order in the hierarchy, not to the number of stars. diff --git a/doc/misc/org.texi b/doc/misc/org.texi deleted file mode 100644 index 8902d628875..00000000000 --- a/doc/misc/org.texi +++ /dev/null @@ -1,23148 +0,0 @@ -\input texinfo @c -*- texinfo -*- -@c %**start of header -@setfilename org.info -@settitle The Org Manual -@documentencoding UTF-8 -@documentlanguage en -@set txicodequoteundirected -@set txicodequotebacktick -@set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage} -@set MAINTAINER Bastien Guerry -@set MAINTAINEREMAIL @email{bzg@gnu.org} -@set MAINTAINERCONTACT @uref{mailto:bzg@gnu.org,contact the maintainer} -@c %**end of header - -@copying -This manual is for Org version 9.4. - -Copyright @copyright{} 2004--2021 Free Software Foundation, Inc. - -@quotation -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' -and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License.'' - -(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual.'' - -@end quotation -@end copying - -@dircategory Emacs editing modes -@direntry -* Org Mode: (org). Outline-based notes management and organizer. -@end direntry - -@finalout -@titlepage -@title The Org Manual -@subtitle Release 9.4 -@author The Org Mode Developers -@page -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@contents - -@ifnottex -@node Top -@top The Org Manual - -@insertcopying -@end ifnottex - -@menu -* Introduction:: Getting started. -* Document Structure:: A tree works like your brain. -* Tables:: Pure magic for quick formatting. -* Hyperlinks:: Notes in context. -* TODO Items:: Every tree branch can be a TODO item. -* Tags:: Tagging headlines and matching sets of tags. -* Properties and Columns:: Storing information about an entry. -* Dates and Times:: Making items useful for planning. -* Refiling and Archiving:: Moving and copying information with ease. -* Capture and Attachments:: Dealing with external data. -* Agenda Views:: Collecting information into views. -* Markup for Rich Contents:: Compose beautiful documents. -* Exporting:: Sharing and publishing notes. -* Publishing:: Create a web site of linked Org files. -* Working with Source Code:: Export, evaluate, and tangle code blocks. -* Miscellaneous:: All the rest which did not fit elsewhere. -* Hacking:: How to hack your way around. -* History and Acknowledgments:: How Org came into being. -* GNU Free Documentation License:: The license for this documentation. -* Main Index:: An index of Org's concepts and features. -* Key Index:: Key bindings and where they are described. -* Command and Function Index:: Command names and some internal functions. -* Variable Index:: Variables mentioned in the manual. - -@detailmenu ---- The Detailed Node Listing --- - -Introduction - -* Summary:: Brief summary of what Org does. -* Installation:: Installing Org. -* Activation:: How to activate Org for certain buffers. -* Feedback:: Bug reports, ideas, patches, etc. -* Conventions:: Typesetting conventions used in this manual. - -Document Structure - -* Headlines:: How to typeset Org tree headlines. -* Visibility Cycling:: Show and hide, much simplified. -* Motion:: Jumping to other headlines. -* Structure Editing:: Changing sequence and level of headlines. -* Sparse Trees:: Matches embedded in context. -* Plain Lists:: Additional structure within an entry. -* Drawers:: Tucking stuff away. -* Blocks:: Folding blocks. - -Visibility Cycling - -* Global and local cycling:: Cycling through various visibility states. -* Initial visibility:: Setting the initial visibility state. -* Catching invisible edits:: Preventing mistakes when editing invisible parts. - -Tables - -* Built-in Table Editor:: Simple tables. -* Column Width and Alignment:: Overrule the automatic settings. -* Column Groups:: Grouping to trigger vertical lines. -* Orgtbl Mode:: The table editor as minor mode. -* The Spreadsheet:: The table editor has spreadsheet capabilities. -* Org Plot:: Plotting from Org tables. - -The Spreadsheet - -* References:: How to refer to another field or range. -* Formula syntax for Calc:: Using Calc to compute stuff. -* Formula syntax for Lisp:: Writing formulas in Emacs Lisp. -* Durations and time values:: How to compute durations and time values. -* Field and range formulas:: Formula for specific (ranges of) fields. -* Column formulas:: Formulas valid for an entire column. -* Lookup functions:: Lookup functions for searching tables. -* Editing and debugging formulas:: Fixing formulas. -* Updating the table:: Recomputing all dependent fields. -* Advanced features:: Field and column names, automatic recalculation... - -Hyperlinks - -* Link Format:: How links in Org are formatted. -* Internal Links:: Links to other places in the current file. -* Radio Targets:: Make targets trigger links in plain text. -* External Links:: URL-like links to the world. -* Handling Links:: Creating, inserting and following. -* Using Links Outside Org:: Linking from my C source code? -* Link Abbreviations:: Shortcuts for writing complex links. -* Search Options:: Linking to a specific location. -* Custom Searches:: When the default search is not enough. - -TODO Items - -* TODO Basics:: Marking and displaying TODO entries. -* TODO Extensions:: Workflow and assignments. -* Progress Logging:: Dates and notes for progress. -* Priorities:: Some things are more important than others. -* Breaking Down Tasks:: Splitting a task into manageable pieces. -* Checkboxes:: Tick-off lists. - -TODO Extensions - -* Workflow states:: From TODO to DONE in steps. -* TODO types:: I do this, Fred does the rest. -* Multiple sets in one file:: Mixing it all, still finding your way. -* Fast access to TODO states:: Single letter selection of state. -* Per-file keywords:: Different files, different requirements. -* Faces for TODO keywords:: Highlighting states. -* TODO dependencies:: When one task needs to wait for others. - -Progress Logging - -* Closing items:: When was this entry marked as done? -* Tracking TODO state changes:: When did the status change? -* Tracking your habits:: How consistent have you been? - -Tags - -* Tag Inheritance:: Tags use the tree structure of an outline. -* Setting Tags:: How to assign tags to a headline. -* Tag Hierarchy:: Create a hierarchy of tags. -* Tag Searches:: Searching for combinations of tags. - -Properties and Columns - -* Property Syntax:: How properties are spelled out. -* Special Properties:: Access to other Org mode features. -* Property Searches:: Matching property values. -* Property Inheritance:: Passing values down a tree. -* Column View:: Tabular viewing and editing. - -Column View - -* Defining columns:: The COLUMNS format property. -* Using column view:: How to create and use column view. -* Capturing column view:: A dynamic block for column view. - -Defining columns - -* Scope of column definitions:: Where defined, where valid? -* Column attributes:: Appearance and content of a column. - -Dates and Times - -* Timestamps:: Assigning a time to a tree entry. -* Creating Timestamps:: Commands to insert timestamps. -* Deadlines and Scheduling:: Planning your work. -* Clocking Work Time:: Tracking how long you spend on a task. -* Effort Estimates:: Planning work effort in advance. -* Timers:: Notes with a running timer. - -Creating Timestamps - -* The date/time prompt:: How Org mode helps you enter dates and times. -* Custom time format:: Making dates look different. - -Deadlines and Scheduling - -* Inserting deadline/schedule:: Planning items. -* Repeated tasks:: Items that show up again and again. - -Clocking Work Time - -* Clocking commands:: Starting and stopping a clock. -* The clock table:: Detailed reports. -* Resolving idle time:: Resolving time when you've been idle. - -Refiling and Archiving - -* Refile and Copy:: Moving/copying a tree from one place to another. -* Archiving:: What to do with finished products. - -Archiving - -* Moving subtrees:: Moving a tree to an archive file. -* Internal archiving:: Switch off a tree but keep it in the file. - -Capture and Attachments - -* Capture:: Capturing new stuff. -* Attachments:: Attach files to outlines. -* RSS Feeds:: Getting input from RSS feeds. - -Capture - -* Setting up capture:: Where notes will be stored. -* Using capture:: Commands to invoke and terminate capture. -* Capture templates:: Define the outline of different note types. - -Capture templates - -* Template elements:: What is needed for a complete template entry. -* Template expansion:: Filling in information about time and context. -* Templates in contexts:: Only show a template in a specific context. - -Attachments - -* Attachment defaults and dispatcher:: How to access attachment commands -* Attachment options:: Configuring the attachment system -* Attachment links:: Hyperlink access to attachments -* Automatic version-control with Git:: Everything safely stored away -* Attach from Dired:: Using dired to select an attachment - -Agenda Views - -* Agenda Files:: Files being searched for agenda information. -* Agenda Dispatcher:: Keyboard access to agenda views. -* Built-in Agenda Views:: What is available out of the box? -* Presentation and Sorting:: How agenda items are prepared for display. -* Agenda Commands:: Remote editing of Org trees. -* Custom Agenda Views:: Defining special searches and views. -* Exporting Agenda Views:: Writing a view to a file. -* Agenda Column View:: Using column view for collected entries. - -Built-in Agenda Views - -* Weekly/daily agenda:: The calendar page with current tasks. -* Global TODO list:: All unfinished action items. -* Matching tags and properties:: Structured information with fine-tuned search. -* Search view:: Find entries by searching for text. -* Stuck projects:: Find projects you need to review. - -Presentation and Sorting - -* Categories:: Not all tasks are equal. -* Time-of-day specifications:: How the agenda knows the time. -* Sorting of agenda items:: The order of things. -* Filtering/limiting agenda items:: Dynamically narrow the agenda. - -Custom Agenda Views - -* Storing searches:: Type once, use often. -* Block agenda:: All the stuff you need in a single buffer. -* Setting options:: Changing the rules. - -Markup for Rich Contents - -* Paragraphs:: The basic unit of text. -* Emphasis and Monospace:: Bold, italic, etc. -* Subscripts and Superscripts:: Simple syntax for raising/lowering text. -* Special Symbols:: Greek letters and other symbols. -* Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents. -* Literal Examples:: Source code examples with special formatting. -* Images:: Display an image. -* Captions:: Describe tables, images... -* Horizontal Rules:: Make a line. -* Creating Footnotes:: Edit and read footnotes. - -Embedded @LaTeX{} - -* @LaTeX{} fragments:: Complex formulas made easy. -* Previewing @LaTeX{} fragments:: What will this snippet look like? -* CD@LaTeX{} mode:: Speed up entering of formulas. - -Exporting - -* The Export Dispatcher:: The main interface. -* Export Settings:: Common export settings. -* Table of Contents:: The if and where of the table of contents. -* Include Files:: Include additional files into a document. -* Macro Replacement:: Use macros to create templates. -* Comment Lines:: What will not be exported. -* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding. -* Beamer Export:: Producing presentations and slides. -* HTML Export:: Exporting to HTML. -* @LaTeX{} Export:: Exporting to @LaTeX{} and processing to PDF. -* Markdown Export:: Exporting to Markdown. -* OpenDocument Text Export:: Exporting to OpenDocument Text. -* Org Export:: Exporting to Org. -* Texinfo Export:: Exporting to Texinfo. -* iCalendar Export:: Exporting to iCalendar. -* Other Built-in Back-ends:: Exporting to a man page. -* Advanced Export Configuration:: Fine-tuning the export output. -* Export in Foreign Buffers:: Author tables and lists in Org syntax. - -Beamer Export - -* Beamer export commands:: For creating Beamer documents. -* Beamer specific export settings:: For customizing Beamer export. -* Frames and Blocks in Beamer:: For composing Beamer slides. -* Beamer specific syntax:: For using in Org documents. -* Editing support:: Editing support. -* A Beamer example:: A complete presentation. - -HTML Export - -* HTML export commands:: Invoking HTML export. -* HTML specific export settings:: Settings for HTML export. -* HTML doctypes:: Exporting various (X)HTML flavors. -* HTML preamble and postamble:: Inserting preamble and postamble. -* Quoting HTML tags:: Using direct HTML in Org files. -* Headlines in HTML export:: Formatting headlines. -* Links in HTML export:: Inserting and formatting links. -* Tables in HTML export:: How to modify the formatting of tables. -* Images in HTML export:: How to insert figures into HTML output. -* Math formatting in HTML export:: Beautiful math also on the web. -* Text areas in HTML export:: An alternate way to show an example. -* CSS support:: Changing the appearance of the output. -* JavaScript support:: Info and folding in a web browser. - -@LaTeX{} Export - -* @LaTeX{}/PDF export commands:: For producing @LaTeX{} and PDF documents. -* @LaTeX{} specific export settings:: Unique to this @LaTeX{} back-end. -* @LaTeX{} header and sectioning:: Setting up the export file structure. -* Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code. -* Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}. -* Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output. -* Plain lists in @LaTeX{} export:: Attributes specific to lists. -* Source blocks in @LaTeX{} export:: Attributes specific to source code blocks. -* Example blocks in @LaTeX{} export:: Attributes specific to example blocks. -* Special blocks in @LaTeX{} export:: Attributes specific to special blocks. -* Horizontal rules in @LaTeX{} export:: Attributes specific to horizontal rules. - -OpenDocument Text Export - -* Pre-requisites for ODT export:: Required packages. -* ODT export commands:: Invoking export. -* ODT specific export settings:: Configuration options. -* Extending ODT export:: Producing DOC, PDF files. -* Applying custom styles:: Styling the output. -* Links in ODT export:: Handling and formatting links. -* Tables in ODT export:: Org tables conversions. -* Images in ODT export:: Inserting images. -* Math formatting in ODT export:: Formatting @LaTeX{} fragments. -* Labels and captions in ODT export:: Rendering objects. -* Literal examples in ODT export:: For source code and example blocks. -* Advanced topics in ODT export:: For power users. - -Math formatting in ODT export - -* @LaTeX{} math snippets:: Embedding in @LaTeX{} format. -* MathML and OpenDocument formula files:: Embedding in native format. - -Texinfo Export - -* Texinfo export commands:: Invoking commands. -* Texinfo specific export settings:: Setting the environment. -* Texinfo file header:: Generating the header. -* Texinfo title and copyright page:: Creating preamble pages. -* Info directory file:: Installing a manual in Info file hierarchy. -* Headings and sectioning structure:: Building document structure. -* Indices:: Creating indices. -* Quoting Texinfo code:: Incorporating literal Texinfo code. -* Plain lists in Texinfo export:: List attributes. -* Tables in Texinfo export:: Table attributes. -* Images in Texinfo export:: Image attributes. -* Quotations in Texinfo export:: Quote block attributes. -* Special blocks in Texinfo export:: Special block attributes. -* A Texinfo example:: Processing Org to Texinfo. - -Export in Foreign Buffers - -* Bare HTML:: Exporting HTML without CSS, Javascript, etc. - -Publishing - -* Configuration:: Defining projects. -* Uploading Files:: How to get files up on the server. -* Sample Configuration:: Example projects. -* Triggering Publication:: Publication commands. - -Configuration - -* Project alist:: The central configuration variable. -* Sources and destinations:: From here to there. -* Selecting files:: What files are part of the project? -* Publishing action:: Setting the function doing the publishing. -* Publishing options:: Tweaking HTML/@LaTeX{} export. -* Publishing links:: Which links keep working after publishing? -* Site map:: Generating a list of all pages. -* Generating an index:: An index that reaches across pages. - -Sample Configuration - -* Simple example:: One-component publishing. -* Complex example:: A multi-component publishing example. - -Working with Source Code - -* Features Overview:: Enjoy the versatility of source blocks. -* Structure of Code Blocks:: Code block syntax described. -* Using Header Arguments:: Different ways to set header arguments. -* Environment of a Code Block:: Arguments, sessions, working directory... -* Evaluating Code Blocks:: Place results of evaluation in the Org buffer. -* Results of Evaluation:: Choosing a results type, post-processing... -* Exporting Code Blocks:: Export contents and/or results. -* Extracting Source Code:: Create pure source code files. -* Languages:: List of supported code block languages. -* Editing Source Code:: Language major-mode editing. -* Noweb Reference Syntax:: Literate programming in Org mode. -* Library of Babel:: Use and contribute to a library of useful code blocks. -* Key bindings and Useful Functions:: Work quickly with code blocks. -* Batch Execution:: Call functions from the command line. - -Miscellaneous - -* Completion:: @kbd{M-@key{TAB}} guesses completions. -* Structure Templates:: Quick insertion of structural elements. -* Speed Keys:: Electric commands at the beginning of a headline. -* Clean View:: Getting rid of leading stars in the outline. -* Execute commands in the active region:: Execute commands on multiple items in Org or agenda view. -* Dynamic Headline Numbering:: Display and update outline numbering. -* The Very Busy @kbd{C-c C-c} Key:: When in doubt, press @kbd{C-c C-c}. -* In-buffer Settings:: Overview of keywords. -* Org Syntax:: Formal description of Org's syntax. -* Documentation Access:: Read documentation about current syntax. -* Escape Character:: Prevent Org from interpreting your writing. -* Code Evaluation Security:: Org files evaluate in-line code. -* Interaction:: With other Emacs packages. -* TTY Keys:: Using Org on a tty. -* Protocols:: External access to Emacs and Org. -* Org Crypt:: Encrypting Org files. -* Org Mobile:: Viewing and capture on a mobile device. - -Clean View - -* Org Indent Mode:: -* Hard indentation:: - -Interaction - -* Cooperation:: Packages Org cooperates with. -* Conflicts:: Packages that lead to conflicts. - -Protocols - -* The @code{store-link} protocol:: Store a link, push URL to kill-ring. -* The @code{capture} protocol:: Fill a buffer with external information. -* The @code{open-source} protocol:: Edit published contents. - -Org Mobile - -* Setting up the staging area:: For the mobile device. -* Pushing to the mobile application:: Uploading Org files and agendas. -* Pulling from the mobile application:: Integrating captured and flagged items. - -Hacking - -* Hooks: Hooks (2). How to reach into Org's internals. -* Add-on Packages:: Available extensions. -* Adding Hyperlink Types:: New custom link types. -* Adding Export Back-ends:: How to write new export back-ends. -* Tables in Arbitrary Syntax:: Orgtbl for LaTeX and other programs. -* Dynamic Blocks:: Automatically filled blocks. -* Special Agenda Views:: Customized views. -* Speeding Up Your Agendas:: Tips on how to speed up your agendas. -* Extracting Agenda Information:: Post-processing agenda information. -* Using the Property API:: Writing programs that use entry properties. -* Using the Mapping API:: Mapping over all or selected entries. - -Tables in Arbitrary Syntax - -* Radio tables:: Sending and receiving radio tables. -* A @LaTeX{} example:: Step by step, almost a tutorial. -* Translator functions:: Copy and modify. - -@end detailmenu -@end menu - -@node Introduction -@chapter Introduction - -@cindex introduction - -@menu -* Summary:: Brief summary of what Org does. -* Installation:: Installing Org. -* Activation:: How to activate Org for certain buffers. -* Feedback:: Bug reports, ideas, patches, etc. -* Conventions:: Typesetting conventions used in this manual. -@end menu - -@node Summary -@section Summary - -@cindex summary - -Org is a mode for keeping notes, maintaining TODO lists, and project -planning with a fast and effective plain-text markup language. It -also is an authoring system with unique support for literate -programming and reproducible research. - -Org is implemented on top of Outline mode, which makes it possible to -keep the content of large files well structured. Visibility cycling -and structure editing help to work with the tree. Tables are easily -created with a built-in table editor. Plain text URL-like links -connect to websites, emails, Usenet messages, BBDB entries, and any -files related to the projects. - -Org develops organizational tasks around notes files that contain -lists or information about projects as plain text. Project planning -and task management make use of metadata which is part of an outline -node. Based on this data, specific entries can be extracted in -queries and create dynamic @emph{agenda views} that also integrate the -Emacs calendar and diary. Org can be used to implement many different -project planning schemes, such as David Allen's GTD system. - -Org files can serve as a single source authoring system with export to -many different formats such as HTML, @LaTeX{}, Open Document, and -Markdown. New export backends can be derived from existing ones, or -defined from scratch. - -Org files can include source code blocks, which makes Org uniquely -suited for authoring technical documents with code examples. Org -source code blocks are fully functional; they can be evaluated in -place and their results can be captured in the file. This makes it -possible to create a single file reproducible research compendium. - -Org keeps simple things simple. When first fired up, it should feel -like a straightforward, easy to use outliner. Complexity is not -imposed, but a large amount of functionality is available when needed. -Org is a toolbox. Many users actually run only a---very -personal---fraction of Org's capabilities, and know that there is more -whenever they need it. - -All of this is achieved with strictly plain text files, the most -portable and future-proof file format. Org runs in Emacs. Emacs is -one of the most widely ported programs, so that Org mode is available -on every major platform. - -@cindex FAQ -There is a website for Org which provides links to the newest version -of Org, as well as additional information, frequently asked questions -(FAQ), links to tutorials, etc. This page is located at -@uref{https://orgmode.org}. - -@cindex print edition -An earlier version (7.3) of this manual is available as a @uref{http://www.network-theory.co.uk/org/manual/, paperback -book from Network Theory Ltd.}. - -@node Installation -@section Installation - -@cindex installation - -Org is included in all recent distributions of GNU Emacs, so you -probably do not need to install it. Most users will simply activate -Org and begin exploring its many features. - -If, for one reason or another, you want to install Org on top of this -pre-packaged version, there are three ways to do it: - -@itemize -@item -by using the Emacs package system; -@item -by downloading Org as an archive; or -@item -by using Org's git repository. -@end itemize - -We @strong{strongly recommend} sticking to a single installation method. - -@anchor{Using Emacs packaging system} -@subheading Using Emacs packaging system - -Recent Emacs distributions include a packaging system which lets you -install Elisp libraries. You can install Org from the ``package menu'', -with @kbd{M-x list-packages}. See @ref{Package Menu,Package Menu,,emacs,}. - -@quotation Important -You need to do this in a session where no @samp{.org} file has been -visited, i.e., where no Org built-in function have been loaded. -Otherwise autoload Org functions will mess up the installation. - -@end quotation - -If you want to use Org's package repository, check out the @uref{https://orgmode.org/elpa.html, Org ELPA -page}. - -@anchor{Downloading Org as an archive} -@subheading Downloading Org as an archive - -You can download Org latest release from @uref{https://orgmode.org/, Org's website}. In this case, -make sure you set the load path correctly in your Emacs init file: - -@lisp -(add-to-list 'load-path "~/path/to/orgdir/lisp") -@end lisp - -The downloaded archive contains contributed libraries that are not -included in Emacs. If you want to use them, add the @samp{contrib/} -directory to your load path: - -@lisp -(add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t) -@end lisp - -Optionally, you can compile the files and/or install them in your -system. Run @samp{make help} to list compilation and installation options. - -@anchor{Using Org's git repository} -@subheading Using Org's git repository - -You can clone Org's repository and install Org like this: - -@example -$ cd ~/src/ -$ git clone https://code.orgmode.org/bzg/org-mode.git -$ cd org-mode/ -$ make autoloads -@end example - -Note that in this case, @samp{make autoloads} is mandatory: it defines -Org's version in @samp{org-version.el} and Org's autoloads in -@samp{org-loaddefs.el}. - -Remember to add the correct load path as described in the method -above. - -You can also compile with @samp{make}, generate the documentation with -@samp{make doc}, create a local configuration with @samp{make config} and -install Org with @samp{make install}. Please run @samp{make help} to get the -list of compilation/installation options. - -For more detailed explanations on Org's build system, please check the -Org Build System page on @uref{https://orgmode.org/worg/dev/org-build-system.html, Worg}. - -@node Activation -@section Activation - -@cindex activation -@cindex autoload -@cindex ELPA -@cindex global key bindings -@cindex key bindings, global - -Org mode buffers need Font Lock to be turned on: this is the default -in Emacs@footnote{If you do not use Font Lock globally turn it on in Org buffer -with @samp{(add-hook 'org-mode-hook 'turn-on-font-lock)}.}. - -There are compatibility issues between Org mode and some other Elisp -packages (see @ref{Conflicts}). Please take the -time to check the list. - -@findex org-agenda -@findex org-capture -@findex org-store-link -For a better experience, the three Org commands @code{org-store-link}, -@code{org-capture} and @code{org-agenda} ought to be accessible anywhere in -Emacs, not just in Org buffers. To that effect, you need to bind them -to globally available keys, like the ones reserved for users (see -@ref{Key Binding Conventions,,,elisp,}). Here are suggested bindings, -please modify the keys to your own liking. - -@lisp -(global-set-key (kbd "C-c l") 'org-store-link) -(global-set-key (kbd "C-c a") 'org-agenda) -(global-set-key (kbd "C-c c") 'org-capture) -@end lisp - -@cindex Org mode, turning on -Files with the @samp{.org} extension use Org mode by default. To turn on -Org mode in a file that does not have the extension @samp{.org}, make the -first line of a file look like this: - -@example -MY PROJECTS -*- mode: org; -*- -@end example - - -@vindex org-insert-mode-line-in-empty-file -@noindent -which selects Org mode for this buffer no matter what the file's name -is. See also the variable @code{org-insert-mode-line-in-empty-file}. - -Many commands in Org work on the region if the region is @emph{active}. To -make use of this, you need to have Transient Mark mode turned on, -which is the default. If you do not like it, you can create an active -region by using the mouse to select a region, or pressing -@kbd{C-@key{SPC}} twice before moving point. - -@node Feedback -@section Feedback - -@cindex feedback -@cindex bug reports -@cindex reporting a bug -@cindex maintainer -@cindex author - -If you find problems with Org, or if you have questions, remarks, or -ideas about it, please send an email to the Org mailing list -@email{emacs-orgmode@@gnu.org}. You can subscribe to the list @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, from this -web page}. If you are not a member of the mailing list, your mail will -be passed to the list after a moderator has approved it@footnote{Please consider subscribing to the mailing list in order to -minimize the work the mailing list moderators have to do.}. We ask -you to read and respect the @uref{https://www.gnu.org/philosophy/kind-communication.html, GNU Kind Communications Guidelines} when -sending messages on this mailing list. - -@findex org-version -@findex org-submit-bug-report -For bug reports, please first try to reproduce the bug with the latest -version of Org available---if you are running an outdated version, it -is quite possible that the bug has been fixed already. If the bug -persists, prepare a report and provide as much information as -possible, including the version information of Emacs (@kbd{M-x emacs-version}) and Org (@kbd{M-x org-version}), as well as -the Org related setup in the Emacs init file. The easiest way to do -this is to use the command - -@example -M-x org-submit-bug-report <RET> -@end example - - -@noindent -which puts all this information into an Emacs mail buffer so that you -only need to add your description. If you are not sending the Email -from within Emacs, please copy and paste the content into your Email -program. - -Sometimes you might face a problem due to an error in your Emacs or -Org mode setup. Before reporting a bug, it is very helpful to start -Emacs with minimal customizations and reproduce the problem. Doing so -often helps you determine if the problem is with your customization or -with Org mode itself. You can start a typical minimal session with -a command like the example below. - -@example -$ emacs -Q -l /path/to/minimal-org.el -@end example - - -However if you are using Org mode as distributed with Emacs, a minimal -setup is not necessary. In that case it is sufficient to start Emacs -as @samp{emacs -Q}. The @samp{minimal-org.el} setup file can have contents as -shown below. - -@lisp -;;; Minimal setup to load latest `org-mode'. - -;; Activate debugging. -(setq debug-on-error t - debug-on-signal nil - debug-on-quit nil) - -;; Add latest Org mode to load path. -(add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp")) -(add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t)) -@end lisp - -If an error occurs, a ``backtrace'' can be very useful---see below on -how to create one. Often a small example file helps, along with clear -information about: - -@enumerate -@item -What exactly did you do? -@item -What did you expect to happen? -@item -What happened instead? -@end enumerate - -Thank you for helping to improve this program. - -@anchor{How to create a useful backtrace} -@subheading How to create a useful backtrace - -@cindex backtrace of an error -If working with Org produces an error with a message you do not -understand, you may have hit a bug. The best way to report this is by -providing, in addition to what was mentioned above, a backtrace. This -is information from the built-in debugger about where and how the -error occurred. Here is how to produce a useful backtrace: - -@enumerate -@item -Reload uncompiled versions of all Org mode Lisp files. The -backtrace contains much more information if it is produced with -uncompiled code. To do this, use - -@example -C-u M-x org-reload <RET> -@end example - - -@noindent -or, from the menu: Org @arrow{} Refresh/Reload @arrow{} Reload Org uncompiled. - -@item -Then, activate the debugger: - -@example -M-x toggle-debug-on-error <RET> -@end example - - -@noindent -or, from the menu: Options @arrow{} Enter Debugger on Error. - -@item -Do whatever you have to do to hit the error. Do not forget to -document the steps you take. - -@item -When you hit the error, a @samp{*Backtrace*} buffer appears on the -screen. Save this buffer to a file---for example using @kbd{C-x C-w}---and attach it to your bug report. -@end enumerate - -@node Conventions -@section Typesetting Conventions Used in this Manual - - - -@anchor{TODO keywords tags properties etc} -@subheading TODO keywords, tags, properties, etc. - -Org uses various syntactical elements: TODO keywords, tags, property -names, keywords, blocks, etc. In this manual we use the following -conventions: - -@table @asis -@item @samp{TODO} -@itemx @samp{WAITING} -TODO keywords are written with all capitals, even if they are -user-defined. - -@item @samp{boss} -@itemx @samp{ARCHIVE} -Tags are case-sensitive. User-defined tags are written in -lowercase; built-in tags with special meaning are written as they -should appear in the document, usually with all capitals. - -@item @samp{Release} -@itemx @samp{PRIORITY} -User-defined properties are capitalized; built-in properties with -special meaning are written with all capitals. - -@item @samp{TITLE} -@itemx @samp{BEGIN} @dots{} @samp{END} -Keywords and blocks are written in uppercase to enhance their -readability, but you can use lowercase in your Org files. -@end table - -@anchor{Key bindings and commands} -@subheading Key bindings and commands - -The manual lists both the keys and the corresponding commands for -accessing a functionality. Org mode often uses the same key for -different functions, depending on context. The command that is bound -to such keys has a generic name, like @code{org-metaright}. In the manual -we will, wherever possible, give the function that is internally -called by the generic command. For example, in the chapter on -document structure, @kbd{M-@key{RIGHT}} will be listed to call -@code{org-do-demote}, while in the chapter on tables, it will be listed to -call @code{org-table-move-column-right}. - -@node Document Structure -@chapter Document Structure - -@cindex document structure -@cindex structure of document -Org is an outliner. Outlines allow a document to be organized in -a hierarchical structure, which, least for me, is the best -representation of notes and thoughts. An overview of this structure -is achieved by folding, i.e., hiding large parts of the document to -show only the general document structure and the parts currently being -worked on. Org greatly simplifies the use of outlines by compressing -the entire show and hide functionalities into a single command, -@code{org-cycle}, which is bound to the @kbd{@key{TAB}} key. - -@menu -* Headlines:: How to typeset Org tree headlines. -* Visibility Cycling:: Show and hide, much simplified. -* Motion:: Jumping to other headlines. -* Structure Editing:: Changing sequence and level of headlines. -* Sparse Trees:: Matches embedded in context. -* Plain Lists:: Additional structure within an entry. -* Drawers:: Tucking stuff away. -* Blocks:: Folding blocks. -@end menu - -@node Headlines -@section Headlines - -@cindex headlines -@cindex outline tree -@vindex org-special-ctrl-a/e -@vindex org-special-ctrl-k -@vindex org-ctrl-k-protect-subtree - -Headlines define the structure of an outline tree. Org headlines -start on the left margin@footnote{See the variables @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, -and @code{org-ctrl-k-protect-subtree} to configure special behavior of -@kbd{C-a}, @kbd{C-e}, and @kbd{C-k} in headlines. Note -also that clocking only works with headings indented less than 30 -stars.} with one or more stars followed by -a space. For example: - -@example -* Top level headline -** Second level -*** Third level - some text -*** Third level - more text -* Another top level headline -@end example - -@vindex org-footnote-section -The name defined in @code{org-footnote-section} is reserved. Do not use it -as a title for your own headings. - -Some people find the many stars too noisy and would prefer an outline -that has whitespace followed by a single star as headline starters. -This can be achieved using a Org Indent minor mode. See @ref{Clean View} for more information. - -Headlines are not numbered. However, you may want to dynamically -number some, or all, of them. See @ref{Dynamic Headline Numbering}. - -@vindex org-cycle-separator-lines -An empty line after the end of a subtree is considered part of it and -is hidden when the subtree is folded. However, if you leave at least -two empty lines, one empty line remains visible after folding the -subtree, in order to structure the collapsed view. See the variable -@code{org-cycle-separator-lines} to modify this behavior. - -@node Visibility Cycling -@section Visibility Cycling - -@cindex cycling, visibility -@cindex visibility cycling -@cindex trees, visibility -@cindex show hidden text -@cindex hide text - -@menu -* Global and local cycling:: Cycling through various visibility states. -* Initial visibility:: Setting the initial visibility state. -* Catching invisible edits:: Preventing mistakes when editing invisible parts. -@end menu - -@node Global and local cycling -@subsection Global and local cycling - -@cindex subtree visibility states -@cindex subtree cycling -@cindex folded, subtree visibility state -@cindex children, subtree visibility state -@cindex subtree, subtree visibility state - -Outlines make it possible to hide parts of the text in the buffer. -Org uses just two commands, bound to @kbd{@key{TAB}} and -@kbd{S-@key{TAB}} to change the visibility in the buffer. - -@table @asis -@item @kbd{@key{TAB}} (@code{org-cycle}) -@kindex TAB -@findex org-cycle -@emph{Subtree cycling}: Rotate current subtree among the states - -@example -,-> FOLDED -> CHILDREN -> SUBTREE --. -'-----------------------------------' -@end example - -@vindex org-cycle-emulate-tab -Point must be on a headline for this to work@footnote{See, however, the option @code{org-cycle-emulate-tab}.}. - -@item @kbd{S-@key{TAB}} (@code{org-global-cycle}) -@itemx @kbd{C-u @key{TAB}} -@cindex global visibility states -@cindex global cycling -@cindex overview, global visibility state -@cindex contents, global visibility state -@cindex show all, global visibility state -@kindex C-u TAB -@kindex S-TAB -@findex org-global-cycle -@emph{Global cycling}: Rotate the entire buffer among the states - -@example -,-> OVERVIEW -> CONTENTS -> SHOW ALL --. -'--------------------------------------' -@end example - -When @kbd{S-@key{TAB}} is called with a numeric prefix argument -@var{N}, view contents only up to headlines of level -@var{N}. - -Note that inside tables (see @ref{Tables}), @kbd{S-@key{TAB}} jumps to the -previous field instead. - -@vindex org-cycle-global-at-bob -You can run global cycling using @kbd{@key{TAB}} only if point is at -the very beginning of the buffer, but not on a headline, and -@code{org-cycle-global-at-bob} is set to a non-@code{nil} value. - -@item @kbd{C-u C-u @key{TAB}} (@code{org-set-startup-visibility}) -@cindex startup visibility -@kindex C-u C-u TAB -@findex org-set-startup-visibility -Switch back to the startup visibility of the buffer (see @ref{Initial visibility}). - -@item @kbd{C-u C-u C-u @key{TAB}} (@code{outline-show-all}) -@cindex show all, command -@kindex C-u C-u C-u TAB -@findex outline-show-all -Show all, including drawers. - -@item @kbd{C-c C-r} (@code{org-reveal}) -@cindex revealing context -@kindex C-c C-r -@findex org-reveal -Reveal context around point, showing the current entry, the -following heading and the hierarchy above. It is useful for working -near a location that has been exposed by a sparse tree command (see -@ref{Sparse Trees}) or an agenda command (see @ref{Agenda Commands}). With a prefix argument, show, on each level, all sibling -headings. With a double prefix argument, also show the entire -subtree of the parent. - -@item @kbd{C-c C-k} (@code{outline-show-branches}) -@cindex show branches, command -@kindex C-c C-k -@findex outline-show-branches -Expose all the headings of the subtree, but not their bodies. - -@item @kbd{C-c @key{TAB}} (@code{outline-show-children}) -@cindex show children, command -@kindex C-c TAB -@findex outline-show-children -Expose all direct children of the subtree. With a numeric prefix -argument @var{N}, expose all children down to level -@var{N}. - -@item @kbd{C-c C-x b} (@code{org-tree-to-indirect-buffer}) -@kindex C-c C-x b -@findex org-tree-to-indirect-buffer -Show the current subtree in an indirect buffer@footnote{The indirect buffer contains the entire buffer, but is narrowed -to the current tree. Editing the indirect buffer also changes the -original buffer, but without affecting visibility in that buffer. For -more information about indirect buffers, see @ref{Indirect Buffers,GNU Emacs Manual,,emacs,}.}. With -a numeric prefix argument @var{N}, go up to level @var{N} -and then take that tree. If @var{N} is negative then go up -that many levels. With a @kbd{C-u} prefix, do not remove the -previously used indirect buffer. - -@item @kbd{C-c C-x v} (@code{org-copy-visible}) -@kindex C-c C-x v -@findex org-copy-visible -Copy the @emph{visible} text in the region into the kill ring. -@end table - -@node Initial visibility -@subsection Initial visibility - -@vindex org-startup-folded -When Emacs first visits an Org file, the global state is set to -@code{showeverything}, i.e., all file content is visible@footnote{When @code{org-agenda-inhibit-startup} is non-@code{nil}, Org does not -honor the default visibility state when first opening a file for the -agenda (see @ref{Speeding Up Your Agendas}).}. This can -be configured through the variable @code{org-startup-folded}, or on -a per-file basis by adding one of the following lines anywhere in the -buffer: - -@cindex @samp{STARTUP}, keyword -@example -#+STARTUP: overview -#+STARTUP: content -#+STARTUP: showall -#+STARTUP: showeverything -@end example - -@cindex @samp{VISIBILITY}, property -Furthermore, any entries with a @samp{VISIBILITY} property (see @ref{Properties and Columns}) get their visibility adapted accordingly. Allowed values -for this property are @samp{folded}, @samp{children}, @samp{content}, and @samp{all}. - -@table @asis -@item @kbd{C-u C-u @key{TAB}} (@code{org-set-startup-visibility}) -@kindex C-u C-u TAB -@findex org-set-startup-visibility -Switch back to the startup visibility of the buffer, i.e., whatever -is requested by startup options and @samp{VISIBILITY} properties in -individual entries. -@end table - -@node Catching invisible edits -@subsection Catching invisible edits - -@cindex edits, catching invisible - -@vindex org-catch-invisible-edits -Sometimes you may inadvertently edit an invisible part of the buffer -and be confused on what has been edited and how to undo the mistake. -Setting @code{org-catch-invisible-edits} to non-@code{nil} helps preventing -this. See the docstring of this option on how Org should catch -invisible edits and process them. - -@node Motion -@section Motion - -@cindex motion, between headlines -@cindex jumping, to headlines -@cindex headline navigation - -The following commands jump to other headlines in the buffer. - -@table @asis -@item @kbd{C-c C-n} (@code{org-next-visible-heading}) -@kindex C-c C-n -@findex org-next-visible-heading -Next heading. - -@item @kbd{C-c C-p} (@code{org-previous-visible-heading}) -@kindex C-c C-p -@findex org-previous-visible-heading -Previous heading. - -@item @kbd{C-c C-f} (@code{org-forward-heading-same-level}) -@kindex C-c C-f -@findex org-forward-heading-same-level -Next heading same level. - -@item @kbd{C-c C-b} (@code{org-backward-heading-same-level}) -@kindex C-c C-b -@findex org-backward-heading-same-level -Previous heading same level. - -@item @kbd{C-c C-u} (@code{outline-up-heading}) -@kindex C-c C-u -@findex outline-up-heading -Backward to higher level heading. - -@item @kbd{C-c C-j} (@code{org-goto}) -@kindex C-c C-j -@findex org-goto -@vindex org-goto-auto-isearch -Jump to a different place without changing the current outline -visibility. Shows the document structure in a temporary buffer, -where you can use the following keys to find your destination: - -@multitable @columnfractions 0.3 0.7 -@item @kbd{@key{TAB}} -@tab Cycle visibility. -@item @kbd{@key{DOWN}} / @kbd{@key{UP}} -@tab Next/previous visible headline. -@item @kbd{@key{RET}} -@tab Select this location. -@item @kbd{/} -@tab Do a Sparse-tree search -@end multitable - -@noindent -The following keys work if you turn off @code{org-goto-auto-isearch} - -@multitable @columnfractions 0.3 0.7 -@item @kbd{n} / @kbd{p} -@tab Next/previous visible headline. -@item @kbd{f} / @kbd{b} -@tab Next/previous headline same level. -@item @kbd{u} -@tab One level up. -@item @kbd{0} @dots{} @kbd{9} -@tab Digit argument. -@item @kbd{q} -@tab Quit. -@end multitable - -@vindex org-goto-interface -@noindent -See also the variable @code{org-goto-interface}. -@end table - -@node Structure Editing -@section Structure Editing - -@cindex structure editing -@cindex headline, promotion and demotion -@cindex promotion, of subtrees -@cindex demotion, of subtrees -@cindex subtree, cut and paste -@cindex pasting, of subtrees -@cindex cutting, of subtrees -@cindex copying, of subtrees -@cindex sorting, of subtrees -@cindex subtrees, cut and paste - -@table @asis -@item @kbd{M-@key{RET}} (@code{org-meta-return}) -@kindex M-RET -@findex org-meta-return -@vindex org-M-RET-may-split-line -Insert a new heading, item or row. - -If the command is used at the @emph{beginning} of a line, and if there is -a heading or a plain list item (see @ref{Plain Lists}) at point, the new -heading/item is created @emph{before} the current line. When used at the -beginning of a regular line of text, turn that line into a heading. - -When this command is used in the middle of a line, the line is split -and the rest of the line becomes the new item or headline. If you -do not want the line to be split, customize -@code{org-M-RET-may-split-line}. - -Calling the command with a @kbd{C-u} prefix unconditionally -inserts a new heading at the end of the current subtree, thus -preserving its contents. With a double @kbd{C-u C-u} prefix, -the new heading is created at the end of the parent subtree instead. - -@item @kbd{C-@key{RET}} (@code{org-insert-heading-respect-content}) -@kindex C-RET -@findex org-insert-heading-respect-content -Insert a new heading at the end of the current subtree. - -@item @kbd{M-S-@key{RET}} (@code{org-insert-todo-heading}) -@kindex M-S-RET -@findex org-insert-todo-heading -@vindex org-treat-insert-todo-heading-as-state-change -Insert new TODO entry with same level as current heading. See also -the variable @code{org-treat-insert-todo-heading-as-state-change}. - -@item @kbd{C-S-@key{RET}} (@code{org-insert-todo-heading-respect-content}) -@kindex C-S-RET -@findex org-insert-todo-heading-respect-content -Insert new TODO entry with same level as current heading. Like -@kbd{C-@key{RET}}, the new headline is inserted after the current -subtree. - -@item @kbd{@key{TAB}} (@code{org-cycle}) -@kindex TAB -@findex org-cycle -In a new entry with no text yet, the first @kbd{@key{TAB}} demotes -the entry to become a child of the previous one. The next -@kbd{@key{TAB}} makes it a parent, and so on, all the way to top -level. Yet another @kbd{@key{TAB}}, and you are back to the initial -level. - -@item @kbd{M-@key{LEFT}} (@code{org-do-promote}) -@itemx @kbd{M-@key{RIGHT}} (@code{org-do-demote}) -@kindex M-LEFT -@findex org-do-promote -@kindex M-RIGHT -@findex org-do-demote -Promote or demote current heading by one level. - -@cindex region, active -@cindex active region -@cindex transient mark mode -When there is an active region---i.e., when Transient Mark mode is -active---promotion and demotion work on all headlines in the region. -To select a region of headlines, it is best to place both point and -mark at the beginning of a line, mark at the beginning of the first -headline, and point at the line just after the last headline to -change. - -@item @kbd{M-S-@key{LEFT}} (@code{org-promote-subtree}) -@kindex M-S-LEFT -@findex org-promote-subtree -Promote the current subtree by one level. - -@item @kbd{M-S-@key{RIGHT}} (@code{org-demote-subtree}) -@kindex M-S-RIGHT -@findex org-demote-subtree -Demote the current subtree by one level. - -@item @kbd{M-@key{UP}} (@code{org-move-subtree-up}) -@kindex M-UP -@findex org-move-subtree-up -Move subtree up, i.e., swap with previous subtree of same level. - -@item @kbd{M-@key{DOWN}} (@code{org-move-subtree-down}) -@kindex M-DOWN -@findex org-move-subtree-down -Move subtree down, i.e., swap with next subtree of same level. - -@item @kbd{C-c @@} (@code{org-mark-subtree}) -@kindex C-c @@ -@findex org-mark-subtree -Mark the subtree at point. Hitting repeatedly marks subsequent -subtrees of the same level as the marked subtree. - -@item @kbd{C-c C-x C-w} (@code{org-cut-subtree}) -@kindex C-c C-x C-w -@findex org-cut-subtree -Kill subtree, i.e., remove it from buffer but save in kill ring. -With a numeric prefix argument N, kill N sequential subtrees. - -@item @kbd{C-c C-x M-w} (@code{org-copy-subtree}) -@kindex C-c C-x M-w -@findex org-copy-subtree -Copy subtree to kill ring. With a numeric prefix argument N, copy -the N sequential subtrees. - -@item @kbd{C-c C-x C-y} (@code{org-paste-subtree}) -@kindex C-c C-x C-y -@findex org-paste-subtree -Yank subtree from kill ring. This does modify the level of the -subtree to make sure the tree fits in nicely at the yank position. -The yank level can also be specified with a numeric prefix argument, -or by yanking after a headline marker like @samp{****}. - -@item @kbd{C-y} (@code{org-yank}) -@kindex C-y -@findex org-yank -@vindex org-yank-adjusted-subtrees -@vindex org-yank-folded-subtrees -Depending on the variables @code{org-yank-adjusted-subtrees} and -@code{org-yank-folded-subtrees}, Org's internal @code{yank} command pastes -subtrees folded and in a clever way, using the same command as -@kbd{C-c C-x C-y}. With the default settings, no level -adjustment takes place, but the yanked tree is folded unless doing -so would swallow text previously visible. Any prefix argument to -this command forces a normal @code{yank} to be executed, with the prefix -passed along. A good way to force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it yanks previous kill -items plainly, without adjustment and folding. - -@item @kbd{C-c C-x c} (@code{org-clone-subtree-with-time-shift}) -@kindex C-c C-x c -@findex org-clone-subtree-with-time-shift -Clone a subtree by making a number of sibling copies of it. You are -prompted for the number of copies to make, and you can also specify -if any timestamps in the entry should be shifted. This can be -useful, for example, to create a number of tasks related to a series -of lectures to prepare. For more details, see the docstring of the -command @code{org-clone-subtree-with-time-shift}. - -@item @kbd{C-c C-w} (@code{org-refile}) -@kindex C-c C-w -@findex org-refile -Refile entry or region to a different location. See @ref{Refile and Copy}. - -@item @kbd{C-c ^} (@code{org-sort}) -@kindex C-c ^ -@findex org-sort -Sort same-level entries. When there is an active region, all -entries in the region are sorted. Otherwise the children of the -current headline are sorted. The command prompts for the sorting -method, which can be alphabetically, numerically, by time---first -timestamp with active preferred, creation time, scheduled time, -deadline time---by priority, by TODO keyword---in the sequence the -keywords have been defined in the setup---or by the value of -a property. Reverse sorting is possible as well. You can also -supply your own function to extract the sorting key. With -a @kbd{C-u} prefix, sorting is case-sensitive. - -@item @kbd{C-x n s} (@code{org-narrow-to-subtree}) -@kindex C-x n s -@findex org-narrow-to-subtree -Narrow buffer to current subtree. - -@item @kbd{C-x n b} (@code{org-narrow-to-block}) -@kindex C-x n b -@findex org-narrow-to-block -Narrow buffer to current block. - -@item @kbd{C-x n w} (@code{widen}) -@kindex C-x n w -@findex widen -Widen buffer to remove narrowing. - -@item @kbd{C-c *} (@code{org-toggle-heading}) -@kindex C-c * -@findex org-toggle-heading -Turn a normal line or plain list item into a headline---so that it -becomes a subheading at its location. Also turn a headline into -a normal line by removing the stars. If there is an active region, -turn all lines in the region into headlines. If the first line in -the region was an item, turn only the item lines into headlines. -Finally, if the first line is a headline, remove the stars from all -headlines in the region. -@end table - -Note that when point is inside a table (see @ref{Tables}), the Meta-Cursor -keys have different functionality. - -@node Sparse Trees -@section Sparse Trees - -@cindex sparse trees -@cindex trees, sparse -@cindex folding, sparse trees -@cindex occur, command - -@vindex org-show-context-detail -An important feature of Org mode is the ability to construct @emph{sparse -trees} for selected information in an outline tree, so that the entire -document is folded as much as possible, but the selected information -is made visible along with the headline structure above it@footnote{See also the variable @code{org-show-context-detail} to decide how -much context is shown around each match.}. -Just try it out and you will see immediately how it works. - -Org mode contains several commands creating such trees, all these -commands can be accessed through a dispatcher: - -@table @asis -@item @kbd{C-c /} (@code{org-sparse-tree}) -@kindex C-c / -@findex org-sparse-tree -This prompts for an extra key to select a sparse-tree creating -command. - -@item @kbd{C-c / r} or @kbd{C-c / /} (@code{org-occur}) -@kindex C-c / r -@kindex C-c / / -@findex org-occur -@vindex org-remove-highlights-with-change -Prompts for a regexp and shows a sparse tree with all matches. If -the match is in a headline, the headline is made visible. If the -match is in the body of an entry, headline and body are made -visible. In order to provide minimal context, also the full -hierarchy of headlines above the match is shown, as well as the -headline following the match. Each match is also highlighted; the -highlights disappear when the buffer is changed by an editing -command, or by pressing @kbd{C-c C-c}@footnote{This depends on the option @code{org-remove-highlights-with-change}.}. When called with -a @kbd{C-u} prefix argument, previous highlights are kept, so -several calls to this command can be stacked. - -@item @kbd{M-g n} or @kbd{M-g M-n} (@code{next-error}) -@kindex M-g n -@kindex M-g M-n -@findex next-error -Jump to the next sparse tree match in this buffer. - -@item @kbd{M-g p} or @kbd{M-g M-p} (@code{previous-error}) -@kindex M-g p -@kindex M-g M-p -@findex previous-error -Jump to the previous sparse tree match in this buffer. -@end table - -@vindex org-agenda-custom-commands -For frequently used sparse trees of specific search strings, you can -use the variable @code{org-agenda-custom-commands} to define fast keyboard -access to specific sparse trees. These commands will then be -accessible through the agenda dispatcher (see @ref{Agenda Dispatcher}). -For example: - -@lisp -(setq org-agenda-custom-commands - '(("f" occur-tree "FIXME"))) -@end lisp - -@noindent -defines the key @kbd{f} as a shortcut for creating a sparse tree -matching the string @samp{FIXME}. - -The other sparse tree commands select headings based on TODO keywords, -tags, or properties and are discussed later in this manual. - -@kindex C-c C-e C-v -@cindex printing sparse trees -@cindex visible text, printing -To print a sparse tree, you can use the Emacs command -@code{ps-print-buffer-with-faces} which does not print invisible parts of -the document. Or you can use the command @kbd{C-c C-e C-v} to -export only the visible part of the document and print the resulting -file. - -@node Plain Lists -@section Plain Lists - -@cindex plain lists -@cindex lists, plain -@cindex lists, ordered -@cindex ordered lists - -Within an entry of the outline tree, hand-formatted lists can provide -additional structure. They also provide a way to create lists of -checkboxes (see @ref{Checkboxes}). Org supports editing such lists, and -every exporter (see @ref{Exporting}) can parse and format them. - -Org knows ordered lists, unordered lists, and description lists. - -@itemize -@item -@emph{Unordered} list items start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented so that they -are not interpreted as headlines. Also, when you are hiding leading -stars to get a clean outline view, plain list items starting with -a star may be hard to distinguish from true headlines. In short: even -though @samp{*} is supported, it may be better to not use it for plain list -items.} as bullets. - -@item -@vindex org-plain-list-ordered-item-terminator -@vindex org-alphabetical-lists -@emph{Ordered} list items start with a numeral followed by either -a period or a right parenthesis@footnote{You can filter out any of them by configuring -@code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and @samp{A)} by configuring -@code{org-list-allow-alphabetical}. To minimize confusion with normal -text, those are limited to one character only. Beyond that limit, -bullets automatically become numbers.} -If you want a list to start with a different value---e.g., -20---start the text of the item with @samp{[@@20]}@footnote{If there's a checkbox in the item, the cookie must be put -@emph{before} the checkbox. If you have activated alphabetical lists, you -can also use counters like @samp{[@@b]}.}. Those -constructs can be used in any item of the list in order to enforce -a particular numbering. - -@item -@emph{Description} list items are unordered list items, and contain the -separator @samp{::} to distinguish the description @emph{term} from the -description. -@end itemize - -Items belonging to the same list must have the same indentation on the -first line. In particular, if an ordered list reaches number @samp{10.}, -then the 2-digit numbers must be written left-aligned with the other -numbers in the list. An item ends before the next line that is less -or equally indented than its bullet/number. - -A list ends whenever every item has ended, which means before any line -less or equally indented than items at top level. It also ends before -two blank lines. In that case, all items are closed. Here is an -example: - -@example -* Lord of the Rings -My favorite scenes are (in this order) -1. The attack of the Rohirrim -2. Eowyn's fight with the witch king - + this was already my favorite scene in the book - + I really like Miranda Otto. -3. Peter Jackson being shot by Legolas - - on DVD only - He makes a really funny face when it happens. -But in the end, no individual scenes matter but the film as a whole. -Important actors in this film are: -- Elijah Wood :: He plays Frodo -- Sean Astin :: He plays Sam, Frodo's friend. I still remember him - very well from his role as Mikey Walsh in /The Goonies/. -@end example - -Org supports these lists by tuning filling and wrapping commands to -deal with them correctly, and by exporting them properly (see -@ref{Exporting}). Since indentation is what governs the structure of these -lists, many structural constructs like @samp{#+BEGIN_} blocks can be -indented to signal that they belong to a particular item. - -@vindex org-list-demote-modify-bullet -@vindex org-list-indent-offset -If you find that using a different bullet for a sub-list---than that -used for the current list-level---improves readability, customize the -variable @code{org-list-demote-modify-bullet}. To get a greater difference -of indentation between items and theirs sub-items, customize -@code{org-list-indent-offset}. - -@vindex org-list-automatic-rules -The following commands act on items when point is in the first line of -an item---the line with the bullet or number. Some of them imply the -application of automatic rules to keep list structure intact. If some -of these actions get in your way, configure @code{org-list-automatic-rules} -to disable them individually. - -@table @asis -@item @kbd{@key{TAB}} (@code{org-cycle}) -@cindex cycling, in plain lists -@kindex TAB -@findex org-cycle -@vindex org-cycle-include-plain-lists -Items can be folded just like headline levels. Normally this works -only if point is on a plain list item. For more details, see the -variable @code{org-cycle-include-plain-lists}. If this variable is set -to @code{integrate}, plain list items are treated like low-level -headlines. The level of an item is then given by the indentation of -the bullet/number. Items are always subordinate to real headlines, -however; the hierarchies remain completely separated. In a new item -with no text yet, the first @kbd{@key{TAB}} demotes the item to -become a child of the previous one. Subsequent @kbd{@key{TAB}}s move -the item to meaningful levels in the list and eventually get it back -to its initial position. - -@item @kbd{M-@key{RET}} (@code{org-insert-heading}) -@kindex M-RET -@findex org-insert-heading -@vindex org-M-RET-may-split-line -Insert new item at current level. With a prefix argument, force -a new heading (see @ref{Structure Editing}). If this command is used in -the middle of an item, that item is @emph{split} in two, and the second -part becomes the new item@footnote{If you do not want the item to be split, customize the -variable @code{org-M-RET-may-split-line}.}. If this command is executed -@emph{before item's body}, the new item is created @emph{before} the current -one. - -@item @kbd{M-S-@key{RET}} -@kindex M-S-RET -Insert a new item with a checkbox (see @ref{Checkboxes}). - -@item @kbd{S-@key{UP}} -@itemx @kbd{S-@key{DOWN}} -@kindex S-UP -@kindex S-DOWN -@cindex shift-selection-mode -@vindex org-support-shift-select -@vindex org-list-use-circular-motion -Jump to the previous/next item in the current list, but only if -@code{org-support-shift-select} is off@footnote{If you want to cycle around items that way, you may customize -@code{org-list-use-circular-motion}.}. If not, you can still use -paragraph jumping commands like @kbd{C-@key{UP}} and -@kbd{C-@key{DOWN}} to quite similar effect. - -@item @kbd{M-@key{UP}} -@itemx @kbd{M-@key{DOWN}} -@kindex M-UP -@kindex M-DOWN -Move the item including subitems up/down@footnote{See @code{org-list-use-circular-motion} for a cyclic behavior.}, i.e., swap with -previous/next item of same indentation. If the list is ordered, -renumbering is automatic. - -@item @kbd{M-@key{LEFT}} -@itemx @kbd{M-@key{RIGHT}} -@kindex M-LEFT -@kindex M-RIGHT -Decrease/increase the indentation of an item, leaving children -alone. - -@item @kbd{M-S-@key{LEFT}} -@itemx @kbd{M-S-@key{RIGHT}} -@kindex M-S-LEFT -@kindex M-S-RIGHT -Decrease/increase the indentation of the item, including subitems. -Initially, the item tree is selected based on current indentation. -When these commands are executed several times in direct succession, -the initially selected region is used, even if the new indentation -would imply a different hierarchy. To use the new hierarchy, break -the command chain by moving point. - -As a special case, using this command on the very first item of -a list moves the whole list. This behavior can be disabled by -configuring @code{org-list-automatic-rules}. The global indentation of -a list has no influence on the text @emph{after} the list. - -@item @kbd{C-c C-c} -@kindex C-c C-c -If there is a checkbox (see @ref{Checkboxes}) in the item line, toggle -the state of the checkbox. In any case, verify bullets and -indentation consistency in the whole list. - -@item @kbd{C-c -} -@kindex C-c - -@vindex org-plain-list-ordered-item-terminator -Cycle the entire list level through the different itemize/enumerate -bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them, depending -on @code{org-plain-list-ordered-item-terminator}, the type of list, and -its indentation. With a numeric prefix argument N, select the Nth -bullet from this list. If there is an active region when calling -this, all lines are converted to list items. With a prefix -argument, the selected text is changed into a single item. If the -first line already was a list item, any item marker is removed from -the list. Finally, even without an active region, a normal line is -converted into a list item. - -@item @kbd{C-c *} -@kindex C-c * -Turn a plain list item into a headline---so that it becomes -a subheading at its location. See @ref{Structure Editing}, for -a detailed explanation. - -@item @kbd{C-c C-*} -@kindex C-c C-* -Turn the whole plain list into a subtree of the current heading. -Checkboxes (see @ref{Checkboxes}) become @samp{TODO}, respectively @samp{DONE}, -keywords when unchecked, respectively checked. - -@item @kbd{S-@key{LEFT}} -@itemx @kbd{S-@key{RIGHT}} -@vindex org-support-shift-select -@kindex S-LEFT -@kindex S-RIGHT -This command also cycles bullet styles when point is in on the -bullet or anywhere in an item line, details depending on -@code{org-support-shift-select}. - -@item @kbd{C-c ^} -@kindex C-c ^ -@cindex sorting, of plain list -Sort the plain list. Prompt for the sorting method: numerically, -alphabetically, by time, or by custom function. -@end table - -@node Drawers -@section Drawers - -@cindex drawers -@cindex visibility cycling, drawers - -Sometimes you want to keep information associated with an entry, but -you normally do not want to see it. For this, Org mode has @emph{drawers}. -They can contain anything but a headline and another drawer. Drawers -look like this: - -@example -** This is a headline -Still outside the drawer -:DRAWERNAME: -This is inside the drawer. -:END: -After the drawer. -@end example - -@kindex C-c C-x d -@findex org-insert-drawer -You can interactively insert a drawer at point by calling -@code{org-insert-drawer}, which is bound to @kbd{C-c C-x d}. With an -active region, this command puts the region inside the drawer. With -a prefix argument, this command calls @code{org-insert-property-drawer}, -which creates a @samp{PROPERTIES} drawer right below the current headline. -Org mode uses this special drawer for storing properties (see -@ref{Properties and Columns}). You cannot use it for anything else. - -Completion over drawer keywords is also possible using -@kbd{M-@key{TAB}}@footnote{Many desktops intercept @kbd{M-@key{TAB}} to switch windows. -Use @kbd{C-M-i} or @kbd{@key{ESC} @key{TAB}} instead.}. - -Visibility cycling (see @ref{Visibility Cycling}) on the headline hides and -shows the entry, but keep the drawer collapsed to a single line. In -order to look inside the drawer, you need to move point to the drawer -line and press @kbd{@key{TAB}} there. - -You can also arrange for state change notes (see @ref{Tracking TODO state changes}) and clock times (see @ref{Clocking Work Time}) to be stored in -a @samp{LOGBOOK} drawer. If you want to store a quick note there, in -a similar way to state changes, use - -@table @asis -@item @kbd{C-c C-z} -@kindex C-c C-z -Add a time-stamped note to the @samp{LOGBOOK} drawer. -@end table - -@node Blocks -@section Blocks - -@vindex org-hide-block-startup -@cindex blocks, folding - -Org mode uses @samp{#+BEGIN} @dots{} @samp{#+END} blocks for various purposes from -including source code examples (see @ref{Literal Examples}) to capturing -time logging information (see @ref{Clocking Work Time}). These blocks can -be folded and unfolded by pressing @kbd{@key{TAB}} in the @samp{#+BEGIN} -line. You can also get all blocks folded at startup by configuring -the variable @code{org-hide-block-startup} or on a per-file basis by using - -@cindex STARTUP, keyword -@example -#+STARTUP: hideblocks -#+STARTUP: nohideblocks -@end example - -@node Tables -@chapter Tables - -@cindex tables -@cindex editing tables - -Org comes with a fast and intuitive table editor. Spreadsheet-like -calculations are supported using the Emacs Calc package (see @ref{Top,GNU Emacs -Calculator Manual,,calc,}). - -@menu -* Built-in Table Editor:: Simple tables. -* Column Width and Alignment:: Overrule the automatic settings. -* Column Groups:: Grouping to trigger vertical lines. -* Orgtbl Mode:: The table editor as minor mode. -* The Spreadsheet:: The table editor has spreadsheet capabilities. -* Org Plot:: Plotting from Org tables. -@end menu - -@node Built-in Table Editor -@section Built-in Table Editor - -@cindex table editor, built-in - -@cindex header lines, in tables -@cindex horizontal rule, in tables -@cindex row separator, in tables -@cindex table syntax -Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} -as the first non-whitespace character is considered part of a table. -@samp{|} is also the column separator@footnote{To insert a vertical bar into a table field, use @samp{\vert} or, -inside a word @samp{abc\vert@{@}def}.}. Moreover, a line starting -with @samp{|-} is a horizontal rule. It separates rows explicitly. Rows -before the first horizontal rule are header lines. A table might look -like this: - -@example -| Name | Phone | Age | -|-------+-------+-----| -| Peter | 1234 | 17 | -| Anna | 4321 | 25 | -@end example - -A table is re-aligned automatically each time you press -@kbd{@key{TAB}}, @kbd{@key{RET}} or @kbd{C-c C-c} inside the table. -@kbd{@key{TAB}} also moves to the next field---@kbd{@key{RET}} to the -next row---and creates new table rows at the end of the table or -before horizontal lines. The indentation of the table is set by the -first line. Horizontal rules are automatically expanded on every -re-align to span the whole table width. So, to create the above -table, you would only type - -@example -|Name|Phone|Age| -|- -@end example - -@noindent -and then press @kbd{@key{TAB}} to align the table and start filling in -fields. Even faster would be to type @samp{|Name|Phone|Age} followed by -@kbd{C-c @key{RET}}. - -When typing text into a field, Org treats @kbd{DEL}, -@kbd{Backspace}, and all character keys in a special way, so that -inserting and deleting avoids shifting other fields. Also, when -typing @emph{immediately} after point was moved into a new field with -@kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}, the field is -automatically made blank. If this behavior is too unpredictable for -you, configure the option @code{org-table-auto-blank-field}. - -@anchor{Creation and conversion} -@subheading Creation and conversion - -@table @asis -@item @kbd{C-c |} (@code{org-table-create-or-convert-from-region}) -@kindex C-c | -@findex org-table-create-or-convert-from-region -Convert the active region to table. If every line contains at least -one @kbd{@key{TAB}} character, the function assumes that the material -is tab separated. If every line contains a comma, comma-separated -values (CSV) are assumed. If not, lines are split at whitespace -into fields. You can use a prefix argument to force a specific -separator: @kbd{C-u} forces CSV, @kbd{C-u C-u} forces -@kbd{@key{TAB}}, @kbd{C-u C-u C-u} prompts for a regular -expression to match the separator, and a numeric argument -N indicates that at least N consecutive spaces, or alternatively -a @kbd{@key{TAB}} will be the separator. - -If there is no active region, this command creates an empty Org -table. But it is easier just to start typing, like @kbd{| N a m e | P h o n e | A g e @key{RET} | - @key{TAB}}. -@end table - -@anchor{Re-aligning and field motion} -@subheading Re-aligning and field motion - -@table @asis -@item @kbd{C-c C-c} (@code{org-table-align}) -@kindex C-c C-c -@findex org-table-align -Re-align the table without moving point. - -@item @kbd{@key{TAB}} (@code{org-table-next-field}) -@kindex TAB -@findex org-table-next-field -Re-align the table, move to the next field. Creates a new row if -necessary. - -@item @kbd{C-c @key{SPC}} (@code{org-table-blank-field}) -@kindex C-c SPC -@findex org-table-blank-field -Blank the field at point. - -@item @kbd{S-@key{TAB}} (@code{org-table-previous-field}) -@kindex S-TAB -@findex org-table-previous-field -Re-align, move to previous field. - -@item @kbd{@key{RET}} (@code{org-table-next-row}) -@kindex RET -@findex org-table-next-row -Re-align the table and move down to next row. Creates a new row if -necessary. At the beginning or end of a line, @kbd{@key{RET}} still -inserts a new line, so it can be used to split a table. - -@item @kbd{M-a} (@code{org-table-beginning-of-field}) -@kindex M-a -@findex org-table-beginning-of-field -Move to beginning of the current table field, or on to the previous -field. - -@item @kbd{M-e} (@code{org-table-end-of-field}) -@kindex M-e -@findex org-table-end-of-field -Move to end of the current table field, or on to the next field. -@end table - -@anchor{Column and row editing} -@subheading Column and row editing - -@table @asis -@item @kbd{M-@key{LEFT}} (@code{org-table-move-column-left}) -@kindex M-LEFT -@findex org-table-move-column-left -Move the current column left. - -@item @kbd{M-@key{RIGHT}} (@code{org-table-move-column-right}) -@kindex M-RIGHT -@findex org-table-move-column-right -Move the current column right. - -@item @kbd{M-S-@key{LEFT}} (@code{org-table-delete-column}) -@kindex M-S-LEFT -@findex org-table-delete-column -Kill the current column. - -@item @kbd{M-S-@key{RIGHT}} (@code{org-table-insert-column}) -@kindex M-S-RIGHT -@findex org-table-insert-column -Insert a new column at point position. Move the recent column and -all cells to the right of this column to the right. - -@item @kbd{M-@key{UP}} (@code{org-table-move-row-up}) -@kindex M-UP -@findex org-table-move-row-up -Move the current row up. - -@item @kbd{M-@key{DOWN}} (@code{org-table-move-row-down}) -@kindex M-DOWN -@findex org-table-move-row-down -Move the current row down. - -@item @kbd{M-S-@key{UP}} (@code{org-table-kill-row}) -@kindex M-S-UP -@findex org-table-kill-row -Kill the current row or horizontal line. - -@item @kbd{S-@key{UP}} (@code{org-table-move-cell-up}) -@kindex S-UP -@findex org-table-move-cell-up -Move cell up by swapping with adjacent cell. - -@item @kbd{S-@key{DOWN}} (@code{org-table-move-cell-down}) -@kindex S-DOWN -@findex org-table-move-cell-down -Move cell down by swapping with adjacent cell. - -@item @kbd{S-@key{LEFT}} (@code{org-table-move-cell-left}) -@kindex S-LEFT -@findex org-table-move-cell-left -Move cell left by swapping with adjacent cell. - -@item @kbd{S-@key{RIGHT}} (@code{org-table-move-cell-right}) -@kindex S-RIGHT -@findex org-table-move-cell-right -Move cell right by swapping with adjacent cell. - -@item @kbd{M-S-@key{DOWN}} (@code{org-table-insert-row}) -@kindex M-S-DOWN -@findex org-table-insert-row -Insert a new row above the current row. With a prefix argument, the -line is created below the current one. - -@item @kbd{C-c -} (@code{org-table-insert-hline}) -@kindex C-c - -@findex org-table-insert-hline -Insert a horizontal line below current row. With a prefix argument, -the line is created above the current line. - -@item @kbd{C-c @key{RET}} (@code{org-table-hline-and-move}) -@kindex C-c RET -@findex org-table-hline-and-move -Insert a horizontal line below current row, and move point into the -row below that line. - -@item @kbd{C-c ^} (@code{org-table-sort-lines}) -@kindex C-c ^ -@findex org-table-sort-lines -Sort the table lines in the region. The position of point indicates -the column to be used for sorting, and the range of lines is the -range between the nearest horizontal separator lines, or the entire -table. If point is before the first column, you are prompted for -the sorting column. If there is an active region, the mark -specifies the first line and the sorting column, while point should -be in the last line to be included into the sorting. The command -prompts for the sorting type, alphabetically, numerically, or by -time. You can sort in normal or reverse order. You can also supply -your own key extraction and comparison functions. When called with -a prefix argument, alphabetic sorting is case-sensitive. -@end table - -@anchor{Regions} -@subheading Regions - -@table @asis -@item @kbd{C-c C-x M-w} (@code{org-table-copy-region}) -@kindex C-c C-x M-w -@findex org-table-copy-region -Copy a rectangular region from a table to a special clipboard. -Point and mark determine edge fields of the rectangle. If there is -no active region, copy just the current field. The process ignores -horizontal separator lines. - -@item @kbd{C-c C-x C-w} (@code{org-table-cut-region}) -@kindex C-c C-x C-w -@findex org-table-cut-region -Copy a rectangular region from a table to a special clipboard, and -blank all fields in the rectangle. So this is the ``cut'' operation. - -@item @kbd{C-c C-x C-y} (@code{org-table-paste-rectangle}) -@kindex C-c C-x C-y -@findex org-table-paste-rectangle -Paste a rectangular region into a table. The upper left corner ends -up in the current field. All involved fields are overwritten. If -the rectangle does not fit into the present table, the table is -enlarged as needed. The process ignores horizontal separator lines. - -@item @kbd{M-@key{RET}} (@code{org-table-wrap-region}) -@kindex M-RET -@findex org-table-wrap-region -Split the current field at point position and move the rest to the -line below. If there is an active region, and both point and mark -are in the same column, the text in the column is wrapped to minimum -width for the given number of lines. A numeric prefix argument may -be used to change the number of desired lines. If there is no -region, but you specify a prefix argument, the current field is made -blank, and the content is appended to the field above. -@end table - -@anchor{Calculations} -@subheading Calculations - -@cindex formula, in tables -@cindex calculations, in tables - -@table @asis -@item @kbd{C-c +} (@code{org-table-sum}) -@kindex C-c + -@findex org-table-sum -Sum the numbers in the current column, or in the rectangle defined -by the active region. The result is shown in the echo area and can -be inserted with @kbd{C-y}. - -@item @kbd{S-@key{RET}} (@code{org-table-copy-down}) -@kindex S-RET -@findex org-table-copy-down -@vindex org-table-copy-increment -When current field is empty, copy from first non-empty field above. -When not empty, copy current field down to next row and move point -along with it. - -Depending on the variable @code{org-table-copy-increment}, integer and -time stamp field values, and fields prefixed or suffixed with -a whole number, can be incremented during copy. Also, a @code{0} prefix -argument temporarily disables the increment. - -This key is also used by shift-selection and related modes (see -@ref{Conflicts}). -@end table - -@anchor{Miscellaneous (1)} -@subheading Miscellaneous - -@table @asis -@item @kbd{C-c `} (@code{org-table-edit-field}) -@kindex C-c ` -@findex org-table-edit-field -Edit the current field in a separate window. This is useful for -fields that are not fully visible (see @ref{Column Width and Alignment}). -When called with a @kbd{C-u} prefix, just make the full field -visible, so that it can be edited in place. When called with two -@kbd{C-u} prefixes, make the editor window follow point through -the table and always show the current field. The follow mode exits -automatically when point leaves the table, or when you repeat this -command with @kbd{C-u C-u C-c `}. - -@item @kbd{M-x org-table-import} -@findex org-table-import -Import a file as a table. The table should be TAB or whitespace -separated. Use, for example, to import a spreadsheet table or data -from a database, because these programs generally can write -TAB-separated text files. This command works by inserting the file -into the buffer and then converting the region to a table. Any -prefix argument is passed on to the converter, which uses it to -determine the separator. - -@item @kbd{C-c |} (@code{org-table-create-or-convert-from-region}) -@kindex C-c | -@findex org-table-create-or-convert-from-region -Tables can also be imported by pasting tabular text into the Org -buffer, selecting the pasted text with @kbd{C-x C-x} and then -using the @kbd{C-c |} command (see @ref{Creation and conversion}). - -@item @kbd{M-x org-table-export} -@findex org-table-export -@vindex org-table-export-default-format -Export the table, by default as a TAB-separated file. Use for data -exchange with, for example, spreadsheet or database programs. The -format used to export the file can be configured in the variable -@code{org-table-export-default-format}. You may also use properties -@samp{TABLE_EXPORT_FILE} and @samp{TABLE_EXPORT_FORMAT} to specify the file -name and the format for table export in a subtree. Org supports -quite general formats for exported tables. The exporter format is -the same as the format used by Orgtbl radio tables, see @ref{Translator functions}, for a detailed description. - -@item @kbd{M-x org-table-header-line-mode} -@findex org-table-header-line-mode -@vindex org-table-header-line-p -Turn on the display of the first data row of the table at point in -the window header line when this first row is not visible anymore in -the buffer. You can activate this minor mode by default by setting -the option @code{org-table-header-line-p} to @code{t}. - -@item @kbd{M-x org-table-transpose-table-at-point} -@findex org-table-transpose-table-at-point -Transpose the table at point and eliminate hlines. -@end table - -@node Column Width and Alignment -@section Column Width and Alignment - -@cindex narrow columns in tables -@cindex alignment in tables - -The width of columns is automatically determined by the table editor. -The alignment of a column is determined automatically from the -fraction of number-like versus non-number fields in the column. - -@vindex org-table-automatic-realign -Editing a field may modify alignment of the table. Moving -a contiguous row or column---i.e., using @kbd{@key{TAB}} or -@kbd{@key{RET}}---automatically re-aligns it. If you want to disable -this behavior, set @code{org-table-automatic-realign} to @code{nil}. In any -case, you can always align manually a table: - -@table @asis -@item @kbd{C-c C-c} (@code{org-table-align}) -@kindex C-c C-c -@findex org-table-align -Align the current table. -@end table - -@vindex org-startup-align-all-tables -Setting the option @code{org-startup-align-all-tables} re-aligns all tables -in a file upon visiting it. You can also set this option on -a per-file basis with: - -@example -#+STARTUP: align -#+STARTUP: noalign -@end example - -Sometimes a single field or a few fields need to carry more text, -leading to inconveniently wide columns. Maybe you want to hide away -several columns or display them with a fixed width, regardless of -content, as shown in the following example. - -@example -|---+---------------------+--------| |---+-------…+…| -| | <6> | | | | <6> …|…| -| 1 | one | some | ----\ | 1 | one …|…| -| 2 | two | boring | ----/ | 2 | two …|…| -| 3 | This is a long text | column | | 3 | This i…|…| -|---+---------------------+--------| |---+-------…+…| -@end example - -To set the width of a column, one field anywhere in the column may -contain just the string @samp{<N>} where @var{N} specifies the width -as a number of characters. You control displayed width of columns -with the following tools: - -@table @asis -@item @kbd{C-c @key{TAB}} (@code{org-table-toggle-column-width}) -@kindex C-c TAB -@findex org-table-toggle-column-width -Shrink or expand current column. - -If a width cookie specifies a width W for the column, shrinking it -displays the first W visible characters only. Otherwise, the column -is shrunk to a single character. - -When called before the first column or after the last one, ask for -a list of column ranges to operate on. - -@item @kbd{C-u C-c @key{TAB}} (@code{org-table-shrink}) -@kindex C-u C-c TAB -@findex org-table-shrink -Shrink all columns with a column width. Expand the others. - -@item @kbd{C-u C-u C-c @key{TAB}} (@code{org-table-expand}) -@kindex C-u C-u C-c TAB -@findex org-table-expand -Expand all columns. -@end table - -To see the full text of a shrunk field, hold the mouse over it: -a tool-tip window then shows the full contents of the field. -Alternatively, @kbd{C-h .} (@code{display-local-help}) reveals them, -too. For convenience, any change near the shrunk part of a column -expands it. - -@vindex org-startup-shrink-all-tables -Setting the option @code{org-startup-shrink-all-tables} shrinks all columns -containing a width cookie in a file the moment it is visited. You can -also set this option on a per-file basis with: - -@example -#+STARTUP: shrink -@end example - - -If you would like to overrule the automatic alignment of number-rich -columns to the right and of string-rich columns to the left, you can -use @samp{<r>}, @samp{<c>} or @samp{<l>} in a similar fashion. You may also combine -alignment and field width like this: @samp{<r10>}. - -Lines which only contain these formatting cookies are removed -automatically upon exporting the document. - -@node Column Groups -@section Column Groups - -@cindex grouping columns in tables - -When Org exports tables, it does so by default without vertical lines -because that is visually more satisfying in general. Occasionally -however, vertical lines can be useful to structure a table into groups -of columns, much like horizontal lines can do for groups of rows. In -order to specify column groups, you can use a special row where the -first field contains only @samp{/}. The further fields can either contain -@samp{<} to indicate that this column should start a group, @samp{>} to indicate -the end of a column, or @samp{<>} (no space between @samp{<} and @samp{>}) to make -a column a group of its own. Upon export, boundaries between column -groups are marked with vertical lines. Here is an example: - -@example -| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | -|---+-----+-----+-----+---------+------------| -| / | < | | > | < | > | -| 1 | 1 | 1 | 1 | 1 | 1 | -| 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | -| 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | -|---+-----+-----+-----+---------+------------| -#+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1))) -@end example - -It is also sufficient to just insert the column group starters after -every vertical line you would like to have: - -@example -| N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | -|---+-----+-----+-----+---------+------------| -| / | < | | | < | | -@end example - -@node Orgtbl Mode -@section The Orgtbl Minor Mode - -@cindex Orgtbl mode -@cindex minor mode for tables - -@findex orgtbl-mode -If you like the intuitive way the Org table editor works, you might -also want to use it in other modes like Text mode or Mail mode. The -minor mode Orgtbl mode makes this possible. You can always toggle the -mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for -example in Message mode, use - -@lisp -(add-hook 'message-mode-hook 'turn-on-orgtbl) -@end lisp - -Furthermore, with some special setup, it is possible to maintain -tables in arbitrary syntax with Orgtbl mode. For example, it is -possible to construct @LaTeX{} tables with the underlying ease and power -of Orgtbl mode, including spreadsheet capabilities. For details, see -@ref{Tables in Arbitrary Syntax}. - -@node The Spreadsheet -@section The Spreadsheet - -@cindex calculations, in tables -@cindex spreadsheet capabilities -@cindex Calc package - -The table editor makes use of the Emacs Calc package to implement -spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms -to derive fields from other fields. While fully featured, Org's -implementation is not identical to other spreadsheets. For example, -Org knows the concept of a @emph{column formula} that will be applied to -all non-header fields in a column without having to copy the formula -to each relevant field. There is also a formula debugger, and a -formula editor with features for highlighting fields in the table -corresponding to the references at point in the formula, moving these -references by arrow keys. - -@menu -* References:: How to refer to another field or range. -* Formula syntax for Calc:: Using Calc to compute stuff. -* Formula syntax for Lisp:: Writing formulas in Emacs Lisp. -* Durations and time values:: How to compute durations and time values. -* Field and range formulas:: Formula for specific (ranges of) fields. -* Column formulas:: Formulas valid for an entire column. -* Lookup functions:: Lookup functions for searching tables. -* Editing and debugging formulas:: Fixing formulas. -* Updating the table:: Recomputing all dependent fields. -* Advanced features:: Field and column names, automatic recalculation... -@end menu - -@node References -@subsection References - -@cindex references - -To compute fields in the table from other fields, formulas must -reference other fields or ranges. In Org, fields can be referenced by -name, by absolute coordinates, and by relative coordinates. To find -out what the coordinates of a field are, press @kbd{C-c ?} in -that field, or press @kbd{C-c @}} to toggle the display of a grid. - -@anchor{Field references} -@subsubheading Field references - -@cindex field references -@cindex references, to fields -Formulas can reference the value of another field in two ways. Like -in any other spreadsheet, you may reference fields with -a letter/number combination like @samp{B3}, meaning the second field in the -third row. However, Org prefers to use another, more general -representation that looks like this:@footnote{Org understands references typed by the user as @samp{B4}, but it -does not use this syntax when offering a formula for editing. You can -customize this behavior using the variable -@code{org-table-use-standard-references}.} - -@example -@@ROW$COLUMN -@end example - - -Column specifications can be absolute like @samp{$1}, @samp{$2}, @dots{}, @samp{$N}, or -relative to the current column, i.e., the column of the field which is -being computed, like @samp{$+1} or @samp{$-2}. @samp{$<} and @samp{$>} are immutable -references to the first and last column, respectively, and you can use -@samp{$>>>} to indicate the third column from the right. - -The row specification only counts data lines and ignores horizontal -separator lines, or ``hlines''. Like with columns, you can use absolute -row numbers @samp{@@1}, @samp{@@2}, @dots{}, @samp{@@N}, and row numbers relative to the -current row like @samp{@@+3} or @samp{@@-1}. @samp{@@<} and @samp{@@>} are immutable -references the first and last row in the table, respectively. You may -also specify the row relative to one of the hlines: @samp{@@I} refers to the -first hline, @samp{@@II} to the second, etc. @samp{@@-I} refers to the first such -line above the current line, @samp{@@+I} to the first such line below the -current line. You can also write @samp{@@III+2} which is the second data -line after the third hline in the table. - -@samp{@@0} and @samp{$0} refer to the current row and column, respectively, i.e., -to the row/column for the field being computed. Also, if you omit -either the column or the row part of the reference, the current -row/column is implied. - -Org's references with @emph{unsigned} numbers are fixed references in the -sense that if you use the same reference in the formula for two -different fields, the same field is referenced each time. Org's -references with @emph{signed} numbers are floating references because the -same reference operator can reference different fields depending on -the field being calculated by the formula. - -Here are a few examples: - -@multitable @columnfractions 0.2 0.8 -@item @samp{@@2$3} -@tab 2nd row, 3rd column (same as @samp{C2}) -@item @samp{$5} -@tab column 5 in the current row (same as @samp{E&}) -@item @samp{@@2} -@tab current column, row 2 -@item @samp{@@-1$-3} -@tab field one row up, three columns to the left -@item @samp{@@-I$2} -@tab field just under hline above current row, column 2 -@item @samp{@@>$5} -@tab field in the last row, in column 5 -@end multitable - -@anchor{Range references} -@subsubheading Range references - -@cindex range references -@cindex references, to ranges -You may reference a rectangular range of fields by specifying two -field references connected by two dots @samp{..}. The ends are included in -the range. If both fields are in the current row, you may simply use -@samp{$2..$7}, but if at least one field is in a different row, you need to -use the general @samp{@@ROW$COLUMN} format at least for the first field, -i.e., the reference must start with @samp{@@} in order to be interpreted -correctly. Examples: - -@multitable @columnfractions 0.2 0.8 -@item @samp{$1..$3} -@tab first three fields in the current row -@item @samp{$P..$Q} -@tab range, using column names (see @ref{Advanced features}) -@item @samp{$<<<..$>>} -@tab start in third column, continue to the last but one -@item @samp{@@2$1..@@4$3} -@tab nine fields between these two fields (same as @samp{A2..C4}) -@item @samp{@@-1$-2..@@-1} -@tab 3 fields in the row above, starting from 2 columns on the left -@item @samp{@@I..II} -@tab between first and second hline, short for @samp{@@I..@@II} -@end multitable - -@noindent -Range references return a vector of values that can be fed into Calc -vector functions. Empty fields in ranges are normally suppressed, so -that the vector contains only the non-empty fields. For other options -with the mode switches @samp{E}, @samp{N} and examples, see @ref{Formula syntax for Calc}. - -@anchor{Field coordinates in formulas} -@subsubheading Field coordinates in formulas - -@cindex field coordinates -@cindex coordinates, of field -@cindex row, of field coordinates -@cindex column, of field coordinates -@vindex org-table-current-column -@vindex org-table-current-dline -One of the very first actions during evaluation of Calc formulas and -Lisp formulas is to substitute @samp{@@#} and @samp{$#} in the formula with the -row or column number of the field where the current result will go to. -The traditional Lisp formula equivalents are @code{org-table-current-dline} -and @code{org-table-current-column}. Examples: - -@table @asis -@item @samp{if(@@# % 2, $#, string(""))} -Insert column number on odd rows, set field to empty on even rows. - -@item @samp{$2 = '(identity remote(FOO, @@@@#$1))} -Copy text or values of each row of column 1 of the table named -@var{FOO} into column 2 of the current table. - -@item @samp{@@3 = 2 * remote(FOO, @@1$$#)} -Insert the doubled value of each column of row 1 of the table -named @var{FOO} into row 3 of the current table. -@end table - -@noindent -For the second and third examples, table @var{FOO} must have at -least as many rows or columns as the current table. Note that this is -inefficient@footnote{The computation time scales as O(N^2) because table -@var{FOO} is parsed for each field to be copied.} for large number of rows. - -@anchor{Named references} -@subsubheading Named references - -@cindex named references -@cindex references, named -@cindex name, of column or field -@cindex constants, in calculations -@cindex @samp{CONSTANTS}, keyword -@vindex org-table-formula-constants - -@samp{$name} is interpreted as the name of a column, parameter or constant. -Constants are defined globally through the variable -@code{org-table-formula-constants}, and locally---for the file---through -a line like this example: - -@example -#+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 -@end example - - -@vindex constants-unit-system -@pindex constants.el -Also, properties (see @ref{Properties and Columns}) can be used as -constants in table formulas: for a property @samp{Xyz} use the name -@samp{$PROP_Xyz}, and the property will be searched in the current outline -entry and in the hierarchy above it. If you have the @samp{constants.el} -package, it will also be used to resolve constants, including natural -constants like @samp{$h} for Planck's constant, and units like @samp{$km} for -kilometers@footnote{The file @samp{constants.el} can supply the values of constants in -two different unit systems, @samp{SI} and @samp{cgs}. Which one is used depends -on the value of the variable @code{constants-unit-system}. You can use the -@samp{STARTUP} options @samp{constSI} and @samp{constcgs} to set this value for the -current buffer.}. Column names and parameters can be specified in -special table lines. These are described below, see @ref{Advanced features}. All names must start with a letter, and further consist -of letters and numbers. - -@anchor{Remote references} -@subsubheading Remote references - -@cindex remote references -@cindex references, remote -@cindex references, to a different table -@cindex name, of column or field -@cindex @samp{NAME}, keyword -You may also reference constants, fields and ranges from a different -table, either in the current file or even in a different file. The -syntax is - -@example -remote(NAME,REF) -@end example - - -@noindent -where @var{NAME} can be the name of a table in the current file -as set by a @samp{#+NAME:} line before the table. It can also be the ID of -an entry, even in a different file, and the reference then refers to -the first table in that entry. @var{REF} is an absolute field or -range reference as described above for example @samp{@@3$3} or @samp{$somename}, -valid in the referenced table. - -@cindex table indirection -When @var{NAME} has the format @samp{@@ROW$COLUMN}, it is substituted -with the name or ID found in this field of the current table. For -example @samp{remote($1, @@@@>$2)} @result{} @samp{remote(year_2013, @@@@>$1)}. The format -@samp{B3} is not supported because it can not be distinguished from a plain -table name or ID@. - -@node Formula syntax for Calc -@subsection Formula syntax for Calc - -@cindex formula syntax, Calc -@cindex syntax, of formulas - -A formula can be any algebraic expression understood by the Emacs Calc -package. Note that Calc has the non-standard convention that @samp{/} has -lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as -@samp{(a/(b*c))}. Before evaluation by @code{calc-eval} (see @ref{Calling Calc from Your Programs,Calling Calc from -Your Lisp Programs,,calc,}), variable substitution takes place according to -the rules described above. - -@cindex vectors, in table calculations -The range vectors can be directly fed into the Calc vector functions -like @code{vmean} and @code{vsum}. - -@cindex format specifier, in spreadsheet -@cindex mode, for Calc -@vindex org-calc-default-modes -A formula can contain an optional mode string after a semicolon. This -string consists of flags to influence Calc and other modes during -execution. By default, Org uses the standard Calc modes (precision -12, angular units degrees, fraction and symbolic modes off). The -display format, however, has been changed to @samp{(float 8)} to keep -tables compact. The default settings can be configured using the -variable @code{org-calc-default-modes}. - -@table @asis -@item @samp{p20} -Set the internal Calc calculation precision to 20 digits. - -@item @samp{n3}, @samp{s3}, @samp{e2}, @samp{f4} -Normal, scientific, engineering or fixed format of the result of -Calc passed back to Org. Calc formatting is unlimited in precision -as long as the Calc calculation precision is greater. - -@item @samp{D}, @samp{R} -Degree and radian angle modes of Calc. - -@item @samp{F}, @samp{S} -Fraction and symbolic modes of Calc. - -@item @samp{T}, @samp{t}, @samp{U} -Duration computations in Calc or Lisp, @ref{Durations and time values}. - -@item @samp{E} -If and how to consider empty fields. Without @samp{E} empty fields in -range references are suppressed so that the Calc vector or Lisp list -contains only the non-empty fields. With @samp{E} the empty fields are -kept. For empty fields in ranges or empty field references the -value @samp{nan} (not a number) is used in Calc formulas and the empty -string is used for Lisp formulas. Add @samp{N} to use 0 instead for both -formula types. For the value of a field the mode @samp{N} has higher -precedence than @samp{E}. - -@item @samp{N} -Interpret all fields as numbers, use 0 for non-numbers. See the -next section to see how this is essential for computations with Lisp -formulas. In Calc formulas it is used only occasionally because -there number strings are already interpreted as numbers without @samp{N}. - -@item @samp{L} -Literal, for Lisp formulas only. See the next section. -@end table - -Unless you use large integer numbers or high-precision calculation and -display for floating point numbers you may alternatively provide -a @code{printf} format specifier to reformat the Calc result after it has -been passed back to Org instead of letting Calc already do the -formatting@footnote{The printf reformatting is limited in precision because the -value passed to it is converted into an ``integer'' or ``double''. The -``integer'' is limited in size by truncating the signed value to 32 -bits. The ``double'' is limited in precision to 64 bits overall which -leaves approximately 16 significant decimal digits.}. A few examples: - -@multitable {aaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{$1+$2} -@tab Sum of first and second field -@item @samp{$1+$2;%.2f} -@tab Same, format result to two decimals -@item @samp{exp($2)+exp($1)} -@tab Math functions can be used -@item @samp{$0;%.1f} -@tab Reformat current cell to 1 decimal -@item @samp{($3-32)*5/9} -@tab Degrees F @arrow{} C conversion -@item @samp{$c/$1/$cm} -@tab Hz @arrow{} cm conversion, using @samp{constants.el} -@item @samp{tan($1);Dp3s1} -@tab Compute in degrees, precision 3, display SCI 1 -@item @samp{sin($1);Dp3%.1e} -@tab Same, but use @code{printf} specifier for display -@item @samp{vmean($2..$7)} -@tab Compute column range mean, using vector function -@item @samp{vmean($2..$7);EN} -@tab Same, but treat empty fields as 0 -@item @samp{taylor($3,x=7,2)} -@tab Taylor series of $3, at x=7, second degree -@end multitable - -Calc also contains a complete set of logical operations (see @ref{Logical Operations,Logical -Operations,,calc,}). For example - -@table @asis -@item @samp{if($1 < 20, teen, string(""))} -@samp{"teen"} if age @samp{$1} is less than 20, else the Org table result -field is set to empty with the empty string. - -@item @samp{if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1} -Sum of the first two columns. When at least one of the input fields -is empty the Org table result field is set to empty. @samp{E} is -required to not convert empty fields to 0. @samp{f-1} is an optional -Calc format string similar to @samp{%.1f} but leaves empty results empty. - -@item @samp{if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E} -Mean value of a range unless there is any empty field. Every field -in the range that is empty is replaced by @samp{nan} which lets @samp{vmean} -result in @samp{nan}. Then @samp{typeof =} 12= detects the @samp{nan} from @code{vmean} -and the Org table result field is set to empty. Use this when the -sample set is expected to never have missing values. - -@item @samp{if("$1..$7" == "[]", string(""), vmean($1..$7))} -Mean value of a range with empty fields skipped. Every field in the -range that is empty is skipped. When all fields in the range are -empty the mean value is not defined and the Org table result field -is set to empty. Use this when the sample set can have a variable -size. - -@item @samp{vmean($1..$7); EN} -To complete the example before: Mean value of a range with empty -fields counting as samples with value 0. Use this only when -incomplete sample sets should be padded with 0 to the full size. -@end table - -You can add your own Calc functions defined in Emacs Lisp with -@code{defmath} and use them in formula syntax for Calc. - -@node Formula syntax for Lisp -@subsection Emacs Lisp forms as formulas - -@cindex Lisp forms, as table formulas - -It is also possible to write a formula in Emacs Lisp. This can be -useful for string manipulation and control structures, if Calc's -functionality is not enough. - -If a formula starts with a single-quote followed by an opening -parenthesis, then it is evaluated as a Lisp form. The evaluation -should return either a string or a number. Just as with Calc -formulas, you can specify modes and a @code{printf} format after -a semicolon. - -With Emacs Lisp forms, you need to be conscious about the way field -references are interpolated into the form. By default, a reference is -interpolated as a Lisp string (in double-quotes) containing the field. -If you provide the @samp{N} mode switch, all referenced elements are -numbers---non-number fields will be zero---and interpolated as Lisp -numbers, without quotes. If you provide the @samp{L} flag, all fields are -interpolated literally, without quotes. For example, if you want a -reference to be interpreted as a string by the Lisp form, enclose the -reference operator itself in double-quotes, like @samp{"$3"}. Ranges are -inserted as space-separated fields, so you can embed them in list or -vector syntax. - -Here are a few examples---note how the @samp{N} mode is used when we do -computations in Lisp: - -@table @asis -@item @samp{'(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))} -Swap the first two characters of the content of column 1. - -@item @samp{'(+ $1 $2);N} -Add columns 1 and 2, equivalent to Calc's @samp{$1+$2}. - -@item @samp{'(apply '+ '($1..$4));N} -Compute the sum of columns 1 to 4, like Calc's @samp{vsum($1..$4)}. -@end table - -@node Durations and time values -@subsection Durations and time values - -@cindex duration, computing -@cindex time, computing -@vindex org-table-duration-custom-format - -If you want to compute time values use the @samp{T}, @samp{t}, or @samp{U} flag, -either in Calc formulas or Elisp formulas: - -@example -| Task 1 | Task 2 | Total | -|---------+----------+----------| -| 2:12 | 1:47 | 03:59:00 | -| 2:12 | 1:47 | 03:59 | -| 3:02:20 | -2:07:00 | 0.92 | -#+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;U::@@4$3=$1+$2;t -@end example - -Input duration values must be of the form @samp{HH:MM[:SS]}, where seconds -are optional. With the @samp{T} flag, computed durations are displayed as -@samp{HH:MM:SS} (see the first formula above). With the @samp{U} flag, seconds -are omitted so that the result is only @samp{HH:MM} (see second formula -above). Zero-padding of the hours field depends upon the value of the -variable @code{org-table-duration-hour-zero-padding}. - -With the @samp{t} flag, computed durations are displayed according to the -value of the option @code{org-table-duration-custom-format}, which defaults -to @code{hours} and displays the result as a fraction of hours (see the -third formula in the example above). - -Negative duration values can be manipulated as well, and integers are -considered as seconds in addition and subtraction. - -@node Field and range formulas -@subsection Field and range formulas - -@cindex field formula -@cindex range formula -@cindex formula, for individual table field -@cindex formula, for range of fields - -To assign a formula to a particular field, type it directly into the -field, preceded by @samp{:=}, for example @samp{vsum(@@II..III)}. When you press -@kbd{@key{TAB}} or @kbd{@key{RET}} or @kbd{C-c C-c} with point -still in the field, the formula is stored as the formula for this -field, evaluated, and the current field is replaced with the result. - -@cindex @samp{TBLFM}, keyword -Formulas are stored in a special @samp{TBLFM} keyword located directly -below the table. If you type the equation in the fourth field of the -third data line in the table, the formula looks like @samp{@@3$4=$1+$2}. -When inserting/deleting/swapping column and rows with the appropriate -commands, @emph{absolute references} (but not relative ones) in stored -formulas are modified in order to still reference the same field. To -avoid this from happening, in particular in range references, anchor -ranges at the table borders (using @samp{@@<}, @samp{@@>}, @samp{$<}, @samp{$>}), or at -hlines using the @samp{@@I} notation. Automatic adaptation of field -references does not happen if you edit the table structure with normal -editing commands---you must fix the formulas yourself. - -Instead of typing an equation into the field, you may also use the -following command - -@table @asis -@item @kbd{C-u C-c =} (@code{org-table-eval-formula}) -@kindex C-u C-c = -@findex org-table-eval-formula -Install a new formula for the current field. The command prompts -for a formula with default taken from the @samp{TBLFM} keyword, -applies it to the current field, and stores it. -@end table - -The left-hand side of a formula can also be a special expression in -order to assign the formula to a number of different fields. There is -no keyboard shortcut to enter such range formulas. To add them, use -the formula editor (see @ref{Editing and debugging formulas}) or edit -the @samp{TBLFM} keyword directly. - -@table @asis -@item @samp{$2=} -Column formula, valid for the entire column. This is so common that -Org treats these formulas in a special way, see @ref{Column formulas}. - -@item @samp{@@3=} -Row formula, applies to all fields in the specified row. @samp{@@>=} -means the last row. - -@item @samp{@@1$2..@@4$3=} -Range formula, applies to all fields in the given rectangular range. -This can also be used to assign a formula to some but not all fields -in a row. - -@item @samp{$NAME=} -Named field, see @ref{Advanced features}. -@end table - -@node Column formulas -@subsection Column formulas - -@cindex column formula -@cindex formula, for table column - -When you assign a formula to a simple column reference like @samp{$3=}, the -same formula is used in all fields of that column, with the following -very convenient exceptions: (i) If the table contains horizontal -separator hlines with rows above and below, everything before the -first such hline is considered part of the table @emph{header} and is not -modified by column formulas. Therefore a header is mandatory when you -use column formulas and want to add hlines to group rows, like for -example to separate a total row at the bottom from the summand rows -above. (ii) Fields that already get a value from a field/range -formula are left alone by column formulas. These conditions make -column formulas very easy to use. - -To assign a formula to a column, type it directly into any field in -the column, preceded by an equal sign, like @samp{=$1+$2}. When you press -@kbd{@key{TAB}} or @kbd{@key{RET}} or @kbd{C-c C-c} with point -still in the field, the formula is stored as the formula for the -current column, evaluated and the current field replaced with the -result. If the field contains only @samp{=}, the previously stored formula -for this column is used. For each column, Org only remembers the most -recently used formula. In the @samp{TBLFM} keyword, column formulas look -like @samp{$4=$1+$2}. The left-hand side of a column formula can not be -the name of column, it must be the numeric column reference or @samp{$>}. - -Instead of typing an equation into the field, you may also use the -following command: - -@table @asis -@item @kbd{C-c =} (@code{org-table-eval-formula}) -@kindex C-c = -@findex org-table-eval-formula -Install a new formula for the current column and replace current -field with the result of the formula. The command prompts for -a formula, with default taken from the @samp{TBLFM} keyword, applies it -to the current field and stores it. With a numeric prefix argument, -e.g., @kbd{C-5 C-c =}, the command applies it to that many -consecutive fields in the current column. -@end table - -@node Lookup functions -@subsection Lookup functions - -@cindex lookup functions in tables -@cindex table lookup functions - -Org has three predefined Emacs Lisp functions for lookups in tables. - -@table @asis -@item @samp{(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)} -@findex org-lookup-first -Searches for the first element @var{S} in list -@var{S-LIST} for which -@lisp -(PREDICATE VAL S) -@end lisp -is non-@code{nil}; returns the value from the corresponding position in -list @var{R-LIST}. The default @var{PREDICATE} is -@code{equal}. Note that the parameters @var{VAL} and @var{S} -are passed to @var{PREDICATE} in the same order as the -corresponding parameters are in the call to @code{org-lookup-first}, -where @var{VAL} precedes @var{S-LIST}. If -@var{R-LIST} is @code{nil}, the matching element @var{S} of -@var{S-LIST} is returned. - -@item @samp{(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)} -@findex org-lookup-last -Similar to @code{org-lookup-first} above, but searches for the @emph{last} -element for which @var{PREDICATE} is non-@code{nil}. - -@item @samp{(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)} -@findex org-lookup-all -Similar to @code{org-lookup-first}, but searches for @emph{all} elements for -which @var{PREDICATE} is non-@code{nil}, and returns @emph{all} -corresponding values. This function can not be used by itself in -a formula, because it returns a list of values. However, powerful -lookups can be built when this function is combined with other Emacs -Lisp functions. -@end table - -If the ranges used in these functions contain empty fields, the @samp{E} -mode for the formula should usually be specified: otherwise empty -fields are not included in @var{S-LIST} and/or @var{R-LIST} -which can, for example, result in an incorrect mapping from an element -of @var{S-LIST} to the corresponding element of -@var{R-LIST}. - -These three functions can be used to implement associative arrays, -count matching cells, rank results, group data, etc. For practical -examples see @uref{https://orgmode.org/worg/org-tutorials/org-lookups.html, this tutorial on Worg}. - -@node Editing and debugging formulas -@subsection Editing and debugging formulas - -@cindex formula editing -@cindex editing, of table formulas - -@vindex org-table-use-standard-references -You can edit individual formulas in the minibuffer or directly in the -field. Org can also prepare a special buffer with all active formulas -of a table. When offering a formula for editing, Org converts -references to the standard format (like @samp{B3} or @samp{D&}) if possible. If -you prefer to only work with the internal format (like @samp{@@3$2} or -@samp{$4}), configure the variable @code{org-table-use-standard-references}. - -@table @asis -@item @kbd{C-c =} or @kbd{C-u C-c =} (@code{org-table-eval-formula}) -@kindex C-c = -@kindex C-u C-c = -@findex org-table-eval-formula -Edit the formula associated with the current column/field in the -minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}. - -@item @kbd{C-u C-u C-c =} (@code{org-table-eval-formula}) -@kindex C-u C-u C-c = -@findex org-table-eval-formula -Re-insert the active formula (either a field formula, or a column -formula) into the current field, so that you can edit it directly in -the field. The advantage over editing in the minibuffer is that you -can use the command @kbd{C-c ?}. - -@item @kbd{C-c ?} (@code{org-table-field-info}) -@kindex C-c ? -@findex org-table-field-info -While editing a formula in a table field, highlight the field(s) -referenced by the reference at point position in the formula. - -@item @kbd{C-c @}} (@code{org-table-toggle-coordinate-overlays}) -@kindex C-c @} -@findex org-table-toggle-coordinate-overlays -Toggle the display of row and column numbers for a table, using -overlays. These are updated each time the table is aligned; you can -force it with @kbd{C-c C-c}. - -@item @kbd{C-c @{} (@code{org-table-toggle-formula-debugger}) -@kindex C-c @{ -@findex org-table-toggle-formula-debugger -Toggle the formula debugger on and off. See below. - -@item @kbd{C-c '} (@code{org-table-edit-formulas}) -@kindex C-c ' -@findex org-table-edit-formulas -Edit all formulas for the current table in a special buffer, where -the formulas are displayed one per line. If the current field has -an active formula, point in the formula editor marks it. While -inside the special buffer, Org automatically highlights any field or -range reference at point position. You may edit, remove and add -formulas, and use the following commands: - -@table @asis -@item @kbd{C-c C-c} or @kbd{C-x C-s} (@code{org-table-fedit-finish}) -@kindex C-x C-s -@kindex C-c C-c -@findex org-table-fedit-finish -Exit the formula editor and store the modified formulas. With -@kbd{C-u} prefix, also apply the new formulas to the -entire table. - -@item @kbd{C-c C-q} (@code{org-table-fedit-abort}) -@kindex C-c C-q -@findex org-table-fedit-abort -Exit the formula editor without installing changes. - -@item @kbd{C-c C-r} (@code{org-table-fedit-toggle-ref-type}) -@kindex C-c C-r -@findex org-table-fedit-toggle-ref-type -Toggle all references in the formula editor between standard (like -@samp{B3}) and internal (like @samp{@@3$2}). - -@item @kbd{@key{TAB}} (@code{org-table-fedit-lisp-indent}) -@kindex TAB -@findex org-table-fedit-lisp-indent -Pretty-print or indent Lisp formula at point. When in a line -containing a Lisp formula, format the formula according to Emacs -Lisp rules. Another @kbd{@key{TAB}} collapses the formula back -again. In the open formula, @kbd{@key{TAB}} re-indents just like -in Emacs Lisp mode. - -@item @kbd{M-@key{TAB}} (@code{lisp-complete-symbol}) -@kindex M-TAB -@findex lisp-complete-symbol -Complete Lisp symbols, just like in Emacs Lisp mode. - -@item @kbd{S-@key{UP}}, @kbd{S-@key{DOWN}}, @kbd{S-@key{LEFT}}, @kbd{S-@key{RIGHT}} -@kindex S-UP -@kindex S-DOWN -@kindex S-LEFT -@kindex S-RIGHT -@findex org-table-fedit-ref-up -@findex org-table-fedit-ref-down -@findex org-table-fedit-ref-left -@findex org-table-fedit-ref-right -Shift the reference at point. For example, if the reference is -@samp{B3} and you press @kbd{S-@key{RIGHT}}, it becomes @samp{C3}. This also -works for relative references and for hline references. - -@item @kbd{M-S-@key{UP}} (@code{org-table-fedit-line-up}) -@kindex M-S-UP -@findex org-table-fedit-line-up -Move the test line for column formulas up in the Org buffer. - -@item @kbd{M-S-@key{DOWN}} (@code{org-table-fedit-line-down}) -@kindex M-S-DOWN -@findex org-table-fedit-line-down -Move the test line for column formulas down in the Org buffer. - -@item @kbd{M-@key{UP}} (@code{org-table-fedit-scroll-up}) -@kindex M-UP -@findex org-table-fedit-scroll-up -Scroll up the window displaying the table. - -@item @kbd{M-@key{DOWN}} (@code{org-table-fedit-scroll-down}) -@kindex M-DOWN -@findex org-table-fedit-scroll-down -Scroll down the window displaying the table. - -@item @kbd{C-c @}} -@kindex C-c @} -@findex org-table-toggle-coordinate-overlays -Turn the coordinate grid in the table on and off. -@end table -@end table - -Making a table field blank does not remove the formula associated with -the field, because that is stored in a different line---the @samp{TBLFM} -keyword line. During the next recalculation, the field will be filled -again. To remove a formula from a field, you have to give an empty -reply when prompted for the formula, or to edit the @samp{TBLFM} keyword. - -@kindex C-c C-c -You may edit the @samp{TBLFM} keyword directly and re-apply the changed -equations with @kbd{C-c C-c} in that line or with the normal -recalculation commands in the table. - -@anchor{Using multiple @samp{TBLFM} lines} -@subsubheading Using multiple @samp{TBLFM} lines - -@cindex multiple formula lines -@cindex @samp{TBLFM} keywords, multiple -@cindex @samp{TBLFM}, switching - -@kindex C-c C-c -You may apply the formula temporarily. This is useful when you want -to switch the formula applied to the table. Place multiple @samp{TBLFM} -keywords right after the table, and then press @kbd{C-c C-c} on -the formula to apply. Here is an example: - -@example -| x | y | -|---+---| -| 1 | | -| 2 | | -#+TBLFM: $2=$1*1 -#+TBLFM: $2=$1*2 -@end example - -@noindent -Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields: - -@example -| x | y | -|---+---| -| 1 | 2 | -| 2 | 4 | -#+TBLFM: $2=$1*1 -#+TBLFM: $2=$1*2 -@end example - -@noindent -If you recalculate this table, with @kbd{C-u C-c *}, for example, -you get the following result from applying only the first @samp{TBLFM} -keyword. - -@example -| x | y | -|---+---| -| 1 | 1 | -| 2 | 2 | -#+TBLFM: $2=$1*1 -#+TBLFM: $2=$1*2 -@end example - -@anchor{Debugging formulas} -@subsubheading Debugging formulas - -@cindex formula debugging -@cindex debugging, of table formulas - -When the evaluation of a formula leads to an error, the field content -becomes the string @samp{#ERROR}. If you would like to see what is going -on during variable substitution and calculation in order to find -a bug, turn on formula debugging in the Tbl menu and repeat the -calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in -a field. Detailed information are displayed. - -@node Updating the table -@subsection Updating the table - -@cindex recomputing table fields -@cindex updating, table - -Recalculation of a table is normally not automatic, but needs to be -triggered by a command. To make recalculation at least -semi-automatic, see @ref{Advanced features}. - -In order to recalculate a line of a table or the entire table, use the -following commands: - -@table @asis -@item @kbd{C-c *} (@code{org-table-recalculate}) -@kindex C-c * -@findex org-table-recalculate -Recalculate the current row by first applying the stored column -formulas from left to right, and all field/range formulas in the -current row. - -@item @kbd{C-u C-c *} or @kbd{C-u C-c C-c} -@kindex C-u C-c * -@kindex C-u C-c C-c -Recompute the entire table, line by line. Any lines before the -first hline are left alone, assuming that these are part of the -table header. - -@item @kbd{C-u C-u C-c *} or @kbd{C-u C-u C-c C-c} (@code{org-table-iterate}) -@kindex C-u C-u C-c * -@kindex C-u C-u C-c C-c -@findex org-table-iterate -Iterate the table by recomputing it until no further changes occur. -This may be necessary if some computed fields use the value of other -fields that are computed @emph{later} in the calculation sequence. - -@item @kbd{M-x org-table-recalculate-buffer-tables} -@findex org-table-recalculate-buffer-tables -Recompute all tables in the current buffer. - -@item @kbd{M-x org-table-iterate-buffer-tables} -@findex org-table-iterate-buffer-tables -Iterate all tables in the current buffer, in order to converge -table-to-table dependencies. -@end table - -@node Advanced features -@subsection Advanced features - -If you want the recalculation of fields to happen automatically, or if -you want to be able to assign @emph{names}@footnote{Such names must start with an alphabetic character and use -only alphanumeric/underscore characters.} to fields and columns, -you need to reserve the first column of the table for special marking -characters. - -@table @asis -@item @kbd{C-#} (@code{org-table-rotate-recalc-marks}) -@kindex C-# -@findex org-table-rotate-recalc-marks -Rotate the calculation mark in first column through the states @samp{#}, -@samp{*}, @samp{!}, @samp{$}. When there is an active region, change all marks in -the region. -@end table - -Here is an example of a table that collects exam results of students -and makes use of these features: - -@example -|---+---------+--------+--------+--------+-------+------| -| | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | -|---+---------+--------+--------+--------+-------+------| -| ! | | P1 | P2 | P3 | Tot | | -| # | Maximum | 10 | 15 | 25 | 50 | 10.0 | -| ^ | | m1 | m2 | m3 | mt | | -|---+---------+--------+--------+--------+-------+------| -| # | Peter | 10 | 8 | 23 | 41 | 8.2 | -| # | Sam | 2 | 4 | 3 | 9 | 1.8 | -|---+---------+--------+--------+--------+-------+------| -| | Average | | | | 25.0 | | -| ^ | | | | | at | | -| $ | max=50 | | | | | | -|---+---------+--------+--------+--------+-------+------| -#+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f -@end example - -@quotation Important -Please note that for these special tables, recalculating the table -with @kbd{C-u C-c *} only affects rows that are marked @samp{#} or -@samp{*}, and fields that have a formula assigned to the field itself. The -column formulas are not applied in rows with empty first field. - -@end quotation - -@cindex marking characters, tables -The marking characters have the following meaning: - -@table @asis -@item @samp{!} -The fields in this line define names for the columns, so that you -may refer to a column as @samp{$Tot} instead of @samp{$6}. - -@item @samp{^} -This row defines names for the fields @emph{above} the row. With such -a definition, any formula in the table may use @samp{$m1} to refer to the -value @samp{10}. Also, if you assign a formula to a names field, it is -stored as @samp{$name = ...}. - -@item @samp{_} -Similar to @samp{^}, but defines names for the fields in the row @emph{below}. - -@item @samp{$} -Fields in this row can define @emph{parameters} for formulas. For -example, if a field in a @samp{$} row contains @samp{max=50}, then formulas in -this table can refer to the value 50 using @samp{$max}. Parameters work -exactly like constants, only that they can be defined on a per-table -basis. - -@item @samp{#} -Fields in this row are automatically recalculated when pressing -@kbd{@key{TAB}} or @kbd{@key{RET}} or @kbd{S-@key{TAB}} in this row. -Also, this row is selected for a global recalculation with -@kbd{C-u C-c *}. Unmarked lines are left alone by this -command. - -@item @samp{*} -Selects this line for global recalculation with @kbd{C-u C-c *}, but not for automatic recalculation. Use this when automatic -recalculation slows down editing too much. - -@item @samp{/} -Do not export this line. Useful for lines that contain the -narrowing @samp{<N>} markers or column group markers. -@end table - -Finally, just to whet your appetite for what can be done with the -fantastic Calc package, here is a table that computes the Taylor -series of degree n at location x for a couple of functions. - -@example -|---+-------------+---+-----+--------------------------------------| -| | Func | n | x | Result | -|---+-------------+---+-----+--------------------------------------| -| # | exp(x) | 1 | x | 1 + x | -| # | exp(x) | 2 | x | 1 + x + x^2 / 2 | -| # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | -| # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | -| # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | -| * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | -|---+-------------+---+-----+--------------------------------------| -#+TBLFM: $5=taylor($2,$4,$3);n3 -@end example - -@node Org Plot -@section Org Plot - -@cindex graph, in tables -@cindex plot tables using Gnuplot - -Org Plot can produce graphs of information stored in Org tables, -either graphically or in ASCII art. - -@anchor{Graphical plots using Gnuplot} -@subheading Graphical plots using Gnuplot - -@cindex @samp{PLOT}, keyword -Org Plot can produce 2D and 3D graphs of information stored in Org -tables using @uref{http://www.gnuplot.info/, Gnuplot} and @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html, Gnuplot mode}. To see this in action, ensure -that you have both Gnuplot and Gnuplot mode installed on your system, -then call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot} on the -following table. - -@example -#+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" -| Sede | Max cites | H-index | -|-----------+-----------+---------| -| Chile | 257.72 | 21.39 | -| Leeds | 165.77 | 19.68 | -| Sao Paolo | 71.00 | 11.50 | -| Stockholm | 134.19 | 14.33 | -| Morelia | 257.56 | 17.67 | -@end example - -Notice that Org Plot is smart enough to apply the table's headers as -labels. Further control over the labels, type, content, and -appearance of plots can be exercised through the @samp{PLOT} keyword -preceding a table. See below for a complete list of Org Plot options. -For more information and examples see the @uref{https://orgmode.org/worg/org-tutorials/org-plot.html, Org Plot tutorial}. - -@anchor{Plot options} -@subsubheading Plot options - -@table @asis -@item @samp{set} -Specify any Gnuplot option to be set when graphing. - -@item @samp{title} -Specify the title of the plot. - -@item @samp{ind} -Specify which column of the table to use as the @samp{x} axis. - -@item @samp{deps} -Specify the columns to graph as a Lisp style list, surrounded by -parentheses and separated by spaces for example @samp{dep:(3 4)} to graph -the third and fourth columns. Defaults to graphing all other -columns aside from the @samp{ind} column. - -@item @samp{type} -Specify whether the plot is @samp{2d}, @samp{3d}, or @samp{grid}. - -@item @samp{with} -Specify a @samp{with} option to be inserted for every column being -plotted, e.g., @samp{lines}, @samp{points}, @samp{boxes}, @samp{impulses}. Defaults to -@samp{lines}. - -@item @samp{file} -If you want to plot to a file, specify -@samp{"path/to/desired/output-file"}. - -@item @samp{labels} -List of labels to be used for the @samp{deps}. Defaults to the column -headers if they exist. - -@item @samp{line} -Specify an entire line to be inserted in the Gnuplot script. - -@item @samp{map} -When plotting @samp{3d} or @samp{grid} types, set this to @samp{t} to graph a flat -mapping rather than a @samp{3d} slope. - -@item @samp{timefmt} -Specify format of Org mode timestamps as they will be parsed by -Gnuplot. Defaults to @samp{%Y-%m-%d-%H:%M:%S}. - -@item @samp{script} -If you want total control, you can specify a script file---place the -file name between double-quotes---which will be used to plot. -Before plotting, every instance of @samp{$datafile} in the specified -script will be replaced with the path to the generated data file. -Note: even if you set this option, you may still want to specify the -plot type, as that can impact the content of the data file. -@end table - -@anchor{ASCII bar plots} -@subheading ASCII bar plots - -While point is on a column, typing @kbd{C-c `` a} or @kbd{M-x orgtbl-ascii-plot} create a new column containing an ASCII-art bars -plot. The plot is implemented through a regular column formula. When -the source column changes, the bar plot may be updated by refreshing -the table, for example typing @kbd{C-u C-c *}. - -@example -| Sede | Max cites | | -|---------------+-----------+--------------| -| Chile | 257.72 | WWWWWWWWWWWW | -| Leeds | 165.77 | WWWWWWWh | -| Sao Paolo | 71.00 | WWW; | -| Stockholm | 134.19 | WWWWWW: | -| Morelia | 257.56 | WWWWWWWWWWWH | -| Rochefourchat | 0.00 | | -#+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12) -@end example - -The formula is an Elisp call. - -@defun orgtbl-ascii-draw value min max &optional width -Draw an ASCII bar in a table. - -@var{VALUE} is the value to plot. - -@var{MIN} is the value displayed as an empty bar. @var{MAX} -is the value filling all the @var{WIDTH}. Sources values outside -this range are displayed as @samp{too small} or @samp{too large}. - -@var{WIDTH} is the number of characters of the bar plot. It -defaults to @samp{12}. -@end defun - -@node Hyperlinks -@chapter Hyperlinks - -@cindex hyperlinks - -Like HTML, Org provides support for links inside a file, external -links to other files, Usenet articles, emails, and much more. - -@menu -* Link Format:: How links in Org are formatted. -* Internal Links:: Links to other places in the current file. -* Radio Targets:: Make targets trigger links in plain text. -* External Links:: URL-like links to the world. -* Handling Links:: Creating, inserting and following. -* Using Links Outside Org:: Linking from my C source code? -* Link Abbreviations:: Shortcuts for writing complex links. -* Search Options:: Linking to a specific location. -* Custom Searches:: When the default search is not enough. -@end menu - -@node Link Format -@section Link Format - -@cindex link format -@cindex format, of links - -@cindex angle bracket links -@cindex plain links -Org recognizes plain URIs, possibly wrapped within angle -brackets@footnote{Plain URIs are recognized only for a well-defined set of -schemes. See @ref{External Links}. Unlike URI syntax, they cannot contain -parenthesis or white spaces, either. URIs within angle brackets have -no such limitation.}, and activate them as clickable links. - -@cindex bracket links -The general link format, however, looks like this: - -@example -[[LINK][DESCRIPTION]] -@end example - - -@noindent -or alternatively - -@example -[[LINK]] -@end example - - -@cindex escape syntax, for links -@cindex backslashes, in links -Some @samp{\}, @samp{[} and @samp{]} characters in the @var{LINK} part need to -be ``escaped'', i.e., preceded by another @samp{\} character. More -specifically, the following characters, and only them, must be -escaped: - -@enumerate -@item -all @samp{[} and @samp{]} characters, -@item -every @samp{\} character preceding either @samp{]} or @samp{[}, -@item -every @samp{\} character at the end of the link. -@end enumerate - -@findex org-link-escape -Functions inserting links (see @ref{Handling Links}) properly escape -ambiguous characters. You only need to bother about the rules above -when inserting directly, or yanking, a URI within square brackets. -When in doubt, you may use the function @code{org-link-escape}, which turns -a link string into its escaped form. - -Once a link in the buffer is complete, with all brackets present, Org -changes the display so that @samp{DESCRIPTION} is displayed instead of -@samp{[[LINK][DESCRIPTION]]} and @samp{LINK} is displayed instead of @samp{[[LINK]]}. -Links are highlighted in the @code{org-link} face, which, by default, is an -underlined face. - -You can directly edit the visible part of a link. This can be either -the @var{LINK} part, if there is no description, or the -@var{DESCRIPTION} part otherwise. To also edit the invisible -@var{LINK} part, use @kbd{C-c C-l} with point on the link -(see @ref{Handling Links}). - -If you place point at the beginning or just behind the end of the -displayed text and press @kbd{@key{BS}}, you remove -the---invisible---bracket at that location@footnote{More accurately, the precise behavior depends on how point -arrived there---see @ref{Invisible Text,Invisible Text,,elisp,}.}. This makes the link -incomplete and the internals are again displayed as plain text. -Inserting the missing bracket hides the link internals again. To show -the internal structure of all links, use the menu: Org @arrow{} Hyperlinks @arrow{} -Literal links. - -@node Internal Links -@section Internal Links - -@cindex internal links -@cindex links, internal - -A link that does not look like a URL---i.e., does not start with -a known scheme or a file name---refers to the current document. You -can follow it with @kbd{C-c C-o} when point is on the link, or -with a mouse click (see @ref{Handling Links}). - -@cindex @samp{CUSTOM_ID}, property -Org provides several refinements to internal navigation within -a document. Most notably, a construct like @samp{[[#my-custom-id]]} -specifically targets the entry with the @samp{CUSTOM_ID} property set to -@samp{my-custom-id}. Also, an internal link looking like @samp{[[*Some -section]]} points to a headline with the name @samp{Some section}@footnote{To insert a link targeting a headline, in-buffer completion -can be used. Just type a star followed by a few optional letters into -the buffer and press @kbd{M-@key{TAB}}. All headlines in the current -buffer are offered as completions.}. - -@cindex targets, for links -When the link does not belong to any of the cases above, Org looks for -a @emph{dedicated target}: the same string in double angular brackets, like -@samp{<<My Target>>}. - -@cindex @samp{NAME}, keyword -If no dedicated target exists, the link tries to match the exact name -of an element within the buffer. Naming is done, unsurprisingly, with -the @samp{NAME} keyword, which has to be put in the line before the element -it refers to, as in the following example - -@example -#+NAME: My Target -| a | table | -|----+------------| -| of | four cells | -@end example - -@vindex org-link-search-must-match-exact-headline -Ultimately, if none of the above succeeds, Org searches for a headline -that is exactly the link text but may also include a TODO keyword and -tags, or initiates a plain text search, according to the value of -@code{org-link-search-must-match-exact-headline}. - -Note that you must make sure custom IDs, dedicated targets, and names -are unique throughout the document. Org provides a linter to assist -you in the process, if needed. See @ref{Org Syntax}. - -During export, internal links are used to mark objects and assign them -a number. Marked objects are then referenced by links pointing to -them. In particular, links without a description appear as the number -assigned to the marked object@footnote{When targeting a @samp{NAME} keyword, the @samp{CAPTION} keyword is -mandatory in order to get proper numbering (see @ref{Captions}).}. In the following excerpt from -an Org buffer - -@example -1. one item -2. <<target>>another item -Here we refer to item [[target]]. -@end example - -@noindent -The last sentence will appear as @samp{Here we refer to item 2} when -exported. - -In non-Org files, the search looks for the words in the link text. In -the above example the search would be for @samp{target}. - -Following a link pushes a mark onto Org's own mark ring. You can -return to the previous position with @kbd{C-c &}. Using this -command several times in direct succession goes back to positions -recorded earlier. - -@node Radio Targets -@section Radio Targets - -@cindex radio targets -@cindex targets, radio -@cindex links, radio targets - -Org can automatically turn any occurrences of certain target names in -normal text into a link. So without explicitly creating a link, the -text connects to the target radioing its position. Radio targets are -enclosed by triple angular brackets. For example, a target @samp{<<<My -Target>>>} causes each occurrence of @samp{my target} in normal text to -become activated as a link. The Org file is scanned automatically for -radio targets only when the file is first loaded into Emacs. To -update the target list during editing, press @kbd{C-c C-c} with -point on or at a target. - -@node External Links -@section External Links - -@cindex links, external -@cindex external links -@cindex attachment links -@cindex BBDB links -@cindex Elisp links -@cindex file links -@cindex Gnus links -@cindex Help links -@cindex IRC links -@cindex Info links -@cindex MH-E links -@cindex Rmail links -@cindex shell links -@cindex URL links -@cindex Usenet links - -Org supports links to files, websites, Usenet and email messages, BBDB -database entries and links to both IRC conversations and their logs. -External links are URL-like locators. They start with a short -identifying string followed by a colon. There can be no space after -the colon. - -Here is the full set of built-in link types: - -@table @asis -@item @samp{file} -File links. File name may be remote, absolute, or relative. - -Additionally, you can specify a line number, or a text search. -In Org files, you may link to a headline name, a custom ID, or a -code reference instead. - -As a special case, ``file'' prefix may be omitted if the file name -is complete, e.g., it starts with @samp{./}, or @samp{/}. - -@item @samp{attachment} -Same as file links but for files and folders attached to the current -node (see @ref{Attachments}). Attachment links are intended to behave -exactly as file links but for files relative to the attachment -directory. - -@item @samp{bbdb} -Link to a BBDB record, with possible regexp completion. - -@item @samp{docview} -Link to a document opened with DocView mode. You may specify a page -number. - -@item @samp{doi} -Link to an electronic resource, through its handle. - -@item @samp{elisp} -Execute an Elisp command upon activation. - -@item @samp{gnus}, @samp{rmail}, @samp{mhe} -Link to messages or folders from a given Emacs' MUA@. - -@item @samp{help} -Display documentation of a symbol in @samp{*Help*} buffer. - -@item @samp{http}, @samp{https} -Web links. - -@item @samp{id} -Link to a specific headline by its ID property, in an Org file. - -@item @samp{info} -Link to an Info manual, or to a specific node. - -@item @samp{irc} -Link to an IRC channel. - -@item @samp{mailto} -Link to message composition. - -@item @samp{news} -Usenet links. - -@item @samp{shell} -Execute a shell command upon activation. -@end table - -The following table illustrates the link types above, along with their -options: - -@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@headitem Link Type -@tab Example -@item http -@tab @samp{http://staff.science.uva.nl/c.dominik/} -@item https -@tab @samp{https://orgmode.org/} -@item doi -@tab @samp{doi:10.1000/182} -@item file -@tab @samp{file:/home/dominik/images/jupiter.jpg} -@item -@tab @samp{/home/dominik/images/jupiter.jpg} (same as above) -@item -@tab @samp{file:papers/last.pdf} -@item -@tab @samp{./papers/last.pdf} (same as above) -@item -@tab @samp{file:/ssh:me@@some.where:papers/last.pdf} (remote) -@item -@tab @samp{/ssh:me@@some.where:papers/last.pdf} (same as above) -@item -@tab @samp{file:sometextfile::NNN} (jump to line number) -@item -@tab @samp{file:projects.org} -@item -@tab @samp{file:projects.org::some words} (text search)@footnote{The actual behavior of the search depends on the value of the -variable @code{org-link-search-must-match-exact-headline}. If its value is -@code{nil}, then a fuzzy text search is done. If it is @code{t}, then only the -exact headline is matched, ignoring spaces and statistic cookies. If -the value is @code{query-to-create}, then an exact headline is searched; if -it is not found, then the user is queried to create it.} -@item -@tab @samp{file:projects.org::*task title} (headline search) -@item -@tab @samp{file:projects.org::#custom-id} (headline search) -@item attachment -@tab @samp{attachment:projects.org} -@item -@tab @samp{attachment:projects.org::some words} (text search) -@item docview -@tab @samp{docview:papers/last.pdf::NNN} -@item id -@tab @samp{id:B7423F4D-2E8A-471B-8810-C40F074717E9} -@item news -@tab @samp{news:comp.emacs} -@item mailto -@tab @samp{mailto:adent@@galaxy.net} -@item mhe -@tab @samp{mhe:folder} (folder link) -@item -@tab @samp{mhe:folder#id} (message link) -@item rmail -@tab @samp{rmail:folder} (folder link) -@item -@tab @samp{rmail:folder#id} (message link) -@item gnus -@tab @samp{gnus:group} (group link) -@item -@tab @samp{gnus:group#id} (article link) -@item bbdb -@tab @samp{bbdb:R.*Stallman} (record with regexp) -@item irc -@tab @samp{irc:/irc.com/#emacs/bob} -@item help -@tab @samp{help:org-store-link} -@item info -@tab @samp{info:org#External links} -@item shell -@tab @samp{shell:ls *.org} -@item elisp -@tab @samp{elisp:(find-file "Elisp.org")} (Elisp form to evaluate) -@item -@tab @samp{elisp:org-agenda} (interactive Elisp command) -@end multitable - -@cindex VM links -@cindex Wanderlust links -On top of these built-in link types, additional ones are available -through the @samp{contrib/} directory (see @ref{Installation}). For example, -these links to VM or Wanderlust messages are available when you load -the corresponding libraries from the @samp{contrib/} directory: - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{vm:folder} -@tab VM folder link -@item @samp{vm:folder#id} -@tab VM message link -@item @samp{vm://myself@@some.where.org/folder#id} -@tab VM on remote machine -@item @samp{vm-imap:account:folder} -@tab VM IMAP folder link -@item @samp{vm-imap:account:folder#id} -@tab VM IMAP message link -@item @samp{wl:folder} -@tab Wanderlust folder link -@item @samp{wl:folder#id} -@tab Wanderlust message link -@end multitable - -For information on customizing Org to add new link types, see @ref{Adding Hyperlink Types}. - -A link should be enclosed in double brackets and may contain -descriptive text to be displayed instead of the URL (see @ref{Link Format}), for example: - -@example -[[https://www.gnu.org/software/emacs/][GNU Emacs]] -@end example - - -If the description is a file name or URL that points to an image, HTML -export (see @ref{HTML Export}) inlines the image as a clickable button. If -there is no description at all and the link points to an image, that -image is inlined into the exported HTML file. - -@cindex square brackets, around links -@cindex angular brackets, around links -@cindex plain text external links -Org also recognizes external links amid normal text and activates them -as links. If spaces must be part of the link (for example in -@samp{bbdb:R.*Stallman}), or if you need to remove ambiguities about the -end of the link, enclose the link in square or angular brackets. - -@node Handling Links -@section Handling Links - -@cindex links, handling - -Org provides methods to create a link in the correct syntax, to insert -it into an Org file, and to follow the link. - -@findex org-store-link -@cindex storing links -The main function is @code{org-store-link}, called with @kbd{M-x org-store-link}. Because of its importance, we suggest to bind it -to a widely available key (see @ref{Activation}). It stores a link to the -current location. The link is stored for later insertion into an Org -buffer---see below. The kind of link that is created depends on the -current buffer: - -@table @asis -@item @emph{Org mode buffers} -For Org files, if there is a @samp{<<target>>} at point, the link points -to the target. Otherwise it points to the current headline, which -is also the description@footnote{If the headline contains a timestamp, it is removed from the -link, which results in a wrong link---you should avoid putting -a timestamp in the headline.}. - -@vindex org-id-link-to-org-use-id -@cindex @samp{CUSTOM_ID}, property -@cindex @samp{ID}, property -If the headline has a @samp{CUSTOM_ID} property, store a link to this -custom ID@. In addition or alternatively, depending on the value of -@code{org-id-link-to-org-use-id}, create and/or use a globally unique -@samp{ID} property for the link@footnote{The Org Id library must first be loaded, either through -@code{org-customize}, by enabling @code{id} in @code{org-modules}, or by adding -@samp{(require 'org-id)} in your Emacs init file.}. So using this command in Org -buffers potentially creates two links: a human-readable link from -the custom ID, and one that is globally unique and works even if the -entry is moved from file to file. Later, when inserting the link, -you need to decide which one to use. - -@item @emph{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus} -@vindex org-link-email-description-format -Pretty much all Emacs mail clients are supported. The link points -to the current article, or, in some Gnus buffers, to the group. The -description is constructed according to the variable -@code{org-link-email-description-format}. By default, it refers to the -addressee and the subject. - -@item @emph{Web browsers: W3, W3M and EWW} -Here the link is the current URL, with the page title as the -description. - -@item @emph{Contacts: BBDB} -Links created in a BBDB buffer point to the current entry. - -@item @emph{Chat: IRC} -@vindex org-irc-links-to-logs -For IRC links, if the variable @code{org-irc-link-to-logs} is non-@code{nil}, -create a @samp{file} style link to the relevant point in the logs for the -current conversation. Otherwise store an @samp{irc} style link to the -user/channel/server under the point. - -@item @emph{Other files} -For any other file, the link points to the file, with a search -string (see @ref{Search Options}) pointing to the contents -of the current line. If there is an active region, the selected -words form the basis of the search string. You can write custom Lisp -functions to select the search string and perform the search for -particular file types (see @ref{Custom Searches}). - -You can also define dedicated links to other files. See @ref{Adding Hyperlink Types}. - -@item @emph{Agenda view} -When point is in an agenda view, the created link points to the -entry referenced by the current line. -@end table - -From an Org buffer, the following commands create, navigate or, more -generally, act on links. - -@table @asis -@item @kbd{C-c C-l} (@code{org-insert-link}) -@kindex C-c C-l -@findex org-insert-link -@cindex link completion -@cindex completion, of links -@cindex inserting links -@vindex org-link-keep-stored-after-insertion -Insert a link@footnote{Note that you do not have to use this command to insert -a link. Links in Org are plain text, and you can type or paste them -straight into the buffer. By using this command, the links are -automatically enclosed in double brackets, and you will be asked for -the optional descriptive text.}. This prompts for a link to be inserted into -the buffer. You can just type a link, using text for an internal -link, or one of the link type prefixes mentioned in the examples -above. The link is inserted into the buffer, along with -a descriptive text@footnote{After insertion of a stored link, the link will be removed -from the list of stored links. To keep it in the list for later use, -use a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or -configure the option @code{org-link-keep-stored-after-insertion}.}. If some text was selected at this time, -it becomes the default description. - -@table @asis -@item @emph{Inserting stored links} -All links stored during the current session are part of the -history for this prompt, so you can access them with @kbd{@key{UP}} -and @kbd{@key{DOWN}} (or @kbd{M-p}, @kbd{M-n}). - -@item @emph{Completion support} -Completion with @kbd{@key{TAB}} helps you to insert valid link -prefixes like @samp{http} or @samp{ftp}, including the prefixes defined -through link abbreviations (see @ref{Link Abbreviations}). If you -press @kbd{@key{RET}} after inserting only the prefix, Org offers -specific completion support for some link types@footnote{This works if a function has been defined in the @code{:complete} -property of a link in @code{org-link-parameters}.}. For -example, if you type @kbd{f i l e @key{RET}}---alternative access: -@kbd{C-u C-c C-l}, see below---Org offers file name -completion, and after @kbd{b b d b @key{RET}} you can complete -contact names. -@end table - -@item @kbd{C-u C-c C-l} -@cindex file name completion -@cindex completion, of file names -@kindex C-u C-c C-l -When @kbd{C-c C-l} is called with a @kbd{C-u} prefix -argument, insert a link to a file. You may use file name completion -to select the name of the file. The path to the file is inserted -relative to the directory of the current Org file, if the linked -file is in the current directory or in a sub-directory of it, or if -the path is written relative to the current directory using @samp{../}. -Otherwise an absolute path is used, if possible with @samp{~/} for your -home directory. You can force an absolute path with two -@kbd{C-u} prefixes. - -@item @kbd{C-c C-l} (with point on existing link) -@cindex following links -When point is on an existing link, @kbd{C-c C-l} allows you to -edit the link and description parts of the link. - -@item @kbd{C-c C-o} (@code{org-open-at-point}) -@kindex C-c C-o -@findex org-open-at-point -@vindex org-file-apps -Open link at point. This launches a web browser for URL (using -@code{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for -the corresponding links, and execute the command in a shell link. -When point is on an internal link, this command runs the -corresponding search. When point is on the tags part of a headline, -it creates the corresponding tags view (see @ref{Matching tags and properties}). If point is on a timestamp, it compiles the agenda for -that date. Furthermore, it visits text and remote files in @samp{file} -links with Emacs and select a suitable application for local -non-text files. Classification of files is based on file extension -only. See option @code{org-file-apps}. If you want to override the -default application and visit the file with Emacs, use -a @kbd{C-u} prefix. If you want to avoid opening in Emacs, use -a @kbd{C-u C-u} prefix. - -@vindex org-link-frame-setup -If point is on a headline, but not on a link, offer all links in the -headline and entry text. If you want to setup the frame -configuration for following links, customize @code{org-link-frame-setup}. - -@item @kbd{@key{RET}} -@vindex org-return-follows-link -@kindex RET -When @code{org-return-follows-link} is set, @kbd{@key{RET}} also follows -the link at point. - -@item @kbd{mouse-2} or @kbd{mouse-1} -@kindex mouse-2 -@kindex mouse-1 -On links, @kbd{mouse-1} and @kbd{mouse-2} opens the link -just as @kbd{C-c C-o} does. - -@item @kbd{mouse-3} -@vindex org-link-use-indirect-buffer-for-internals -@kindex mouse-3 -Like @kbd{mouse-2}, but force file links to be opened with -Emacs, and internal links to be displayed in another window@footnote{See the variable @code{org-link-use-indirect-buffer-for-internals}.}. - -@item @kbd{C-c %} (@code{org-mark-ring-push}) -@kindex C-c % -@findex org-mark-ring-push -@cindex mark ring -Push the current position onto the Org mark ring, to be able to -return easily. Commands following an internal link do this -automatically. - -@item @kbd{C-c &} (@code{org-mark-ring-goto}) -@kindex C-c & -@findex org-mark-ring-goto -@cindex links, returning to -Jump back to a recorded position. A position is recorded by the -commands following internal links, and by @kbd{C-c %}. Using -this command several times in direct succession moves through a ring -of previously recorded positions. - -@item @kbd{C-c C-x C-n} (@code{org-next-link}) -@itemx @kbd{C-c C-x C-p} (@code{org-previous-link}) -@kindex C-c C-x C-p -@findex org-previous-link -@kindex C-c C-x C-n -@findex org-next-link -@cindex links, finding next/previous -Move forward/backward to the next link in the buffer. At the limit -of the buffer, the search fails once, and then wraps around. The -key bindings for this are really too long; you might want to bind -this also to @kbd{M-n} and @kbd{M-p}. - -@lisp -(with-eval-after-load 'org - (define-key org-mode-map (kbd "M-n") 'org-next-link) - (define-key org-mode-map (kbd "M-p") 'org-previous-link)) -@end lisp -@end table - -@node Using Links Outside Org -@section Using Links Outside Org - -@findex org-insert-link-global -@findex org-open-at-point-global -You can insert and follow links that have Org syntax not only in Org, -but in any Emacs buffer. For this, Org provides two functions: -@code{org-insert-link-global} and @code{org-open-at-point-global}. - -You might want to bind them to globally available keys. See -@ref{Activation} for some advice. - -@node Link Abbreviations -@section Link Abbreviations - -@cindex link abbreviations -@cindex abbreviation, links - -Long URL can be cumbersome to type, and often many similar links are -needed in a document. For this you can use link abbreviations. An -abbreviated link looks like this - -@example -[[linkword:tag][description]] -@end example - - -@noindent -@vindex org-link-abbrev-alist -where the tag is optional. The @emph{linkword} must be a word, starting -with a letter, followed by letters, numbers, @samp{-}, and @samp{_}. -Abbreviations are resolved according to the information in the -variable @code{org-link-abbrev-alist} that relates the linkwords to -replacement text. Here is an example: - -@lisp -(setq org-link-abbrev-alist - '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") - ("Nu Html Checker" . "https://validator.w3.org/nu/?doc=%h") - ("duckduckgo" . "https://duckduckgo.com/?q=%s") - ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1") - ("ads" . "https://ui.adsabs.harvard.edu/search/q=%20author%3A\"%s\""))) -@end lisp - -If the replacement text contains the string @samp{%s}, it is replaced with -the tag. Using @samp{%h} instead of @samp{%s} percent-encodes the tag (see the -example above, where we need to encode the URL parameter). Using -@samp{%(my-function)} passes the tag to a custom Lisp function, and replace -it by the resulting string. - -If the replacement text do not contain any specifier, it is simply -appended to the string in order to create the link. - -Instead of a string, you may also specify a Lisp function to create -the link. Such a function will be called with the tag as the only -argument. - -With the above setting, you could link to a specific bug with -@samp{[[bugzilla:129]]}, search the web for @samp{OrgMode} with @samp{[[duckduckgo:OrgMode]]}, -show the map location of the Free Software Foundation @samp{[[gmap:51 -Franklin Street, Boston]]} or of Carsten office @samp{[[omap:Science Park 904, -Amsterdam, The Netherlands]]} and find out what the Org author is doing -besides Emacs hacking with @samp{[[ads:Dominik,C]]}. - -If you need special abbreviations just for a single Org buffer, you -can define them in the file with - -@cindex @samp{LINK}, keyword -@example -#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= -#+LINK: duckduckgo https://duckduckgo.com/?q=%s -@end example - -In-buffer completion (see @ref{Completion}) can be used after @samp{[} to -complete link abbreviations. You may also define a Lisp function that -implements special (e.g., completion) support for inserting such a -link with @kbd{C-c C-l}. Such a function should not accept any -arguments, and should return the full link with a prefix. You can set -the link completion function like this: - -@lisp -(org-link-set-parameter "type" :complete #'some-completion-function) -@end lisp - -@node Search Options -@section Search Options in File Links - -@cindex search option in file links -@cindex file links, searching -@cindex attachment links, searching - -File links can contain additional information to make Emacs jump to a -particular location in the file when following a link. This can be a -line number or a search option after a double colon@footnote{For backward compatibility, line numbers can also follow a -single colon.}. For -example, when the command @code{org-store-link} creates a link (see -@ref{Handling Links}) to a file, it encodes the words in the current line -as a search string that can be used to find this line back later when -following the link with @kbd{C-c C-o}. - -Note that all search options apply for Attachment links in the same -way that they apply for File links. - -Here is the syntax of the different ways to attach a search to a file -link, together with explanations for each: - -@example -[[file:~/code/main.c::255]] -[[file:~/xx.org::My Target]] -[[file:~/xx.org::*My Target]] -[[file:~/xx.org::#my-custom-id]] -[[file:~/xx.org::/regexp/]] -[[attachment:main.c::255]] -@end example - -@table @asis -@item @samp{255} -Jump to line 255. - -@item @samp{My Target} -Search for a link target @samp{<<My Target>>}, or do a text search for -@samp{my target}, similar to the search in internal links, see @ref{Internal Links}. In HTML export (see @ref{HTML Export}), such a file link becomes -a HTML reference to the corresponding named anchor in the linked -file. - -@item @samp{*My Target} -In an Org file, restrict search to headlines. - -@item @samp{#my-custom-id} -Link to a heading with a @samp{CUSTOM_ID} property - -@item @samp{/REGEXP/} -Do a regular expression search for @var{REGEXP}. This uses the -Emacs command @code{occur} to list all matches in a separate window. If -the target file is in Org mode, @code{org-occur} is used to create -a sparse tree with the matches. -@end table - -As a degenerate case, a file link with an empty file name can be used -to search the current file. For example, @samp{[[file:::find me]]} does -a search for @samp{find me} in the current file, just as @samp{[[find me]]} -would. - -@node Custom Searches -@section Custom Searches - -@cindex custom search strings -@cindex search strings, custom - -The default mechanism for creating search strings and for doing the -actual search related to a file link may not work correctly in all -cases. For example, Bib@TeX{} database files have many entries like -@code{year="1993"} which would not result in good search strings, because -the only unique identification for a Bib@TeX{} entry is the citation key. - -@vindex org-create-file-search-functions -@vindex org-execute-file-search-functions -If you come across such a problem, you can write custom functions to -set the right search string for a particular file type, and to do the -search for the string in the file. Using @code{add-hook}, these functions -need to be added to the hook variables -@code{org-create-file-search-functions} and -@code{org-execute-file-search-functions}. See the docstring for these -variables for more information. Org actually uses this mechanism for -Bib@TeX{} database files, and you can use the corresponding code as an -implementation example. See the file @samp{ol-bibtex.el}. - -@node TODO Items -@chapter TODO Items - -@cindex TODO items - -Org mode does not maintain TODO lists as separate documents@footnote{Of course, you can make a document that contains only long -lists of TODO items, but this is not required.}. -Instead, TODO items are an integral part of the notes file, because -TODO items usually come up while taking notes! With Org mode, simply -mark any entry in a tree as being a TODO item. In this way, -information is not duplicated, and the entire context from which the -TODO item emerged is always present. - -Of course, this technique for managing TODO items scatters them -throughout your notes file. Org mode compensates for this by -providing methods to give you an overview of all the things that you -have to do. - -@menu -* TODO Basics:: Marking and displaying TODO entries. -* TODO Extensions:: Workflow and assignments. -* Progress Logging:: Dates and notes for progress. -* Priorities:: Some things are more important than others. -* Breaking Down Tasks:: Splitting a task into manageable pieces. -* Checkboxes:: Tick-off lists. -@end menu - -@node TODO Basics -@section Basic TODO Functionality - -Any headline becomes a TODO item when it starts with the word @samp{TODO}, -for example: - -@example -*** TODO Write letter to Sam Fortune -@end example - - -The most important commands to work with TODO entries are: - -@table @asis -@item @kbd{C-c C-t} (@code{org-todo}) -@kindex C-c C-t -@cindex cycling, of TODO states -Rotate the TODO state of the current item among - -@example -,-> (unmarked) -> TODO -> DONE --. -'--------------------------------' -@end example - -If TODO keywords have fast access keys (see @ref{Fast access to TODO states}), prompt for a TODO keyword through the fast selection -interface; this is the default behavior when -@code{org-use-fast-todo-selection} is non-@code{nil}. - -The same state changing can also be done ``remotely'' from the agenda -buffer with the @kbd{t} command key (see @ref{Agenda Commands}). - -@item @kbd{S-@key{RIGHT}} @kbd{S-@key{LEFT}} -@kindex S-RIGHT -@kindex S-LEFT -@vindex org-treat-S-cursor-todo-selection-as-state-change -Select the following/preceding TODO state, similar to cycling. -Useful mostly if more than two TODO states are possible (see -@ref{TODO Extensions}). See also @ref{Conflicts}, for a discussion of the interaction with -shift-selection. See also the variable -@code{org-treat-S-cursor-todo-selection-as-state-change}. - -@item @kbd{C-c / t} (@code{org-show-todo-tree}) -@kindex C-c / t -@cindex sparse tree, for TODO -@vindex org-todo-keywords -@findex org-show-todo-tree -View TODO items in a @emph{sparse tree} (see @ref{Sparse Trees}). Folds the -entire buffer, but shows all TODO items---with not-DONE state---and -the headings hierarchy above them. With a prefix argument, or by -using @kbd{C-c / T}, search for a specific TODO@. You are -prompted for the keyword, and you can also give a list of keywords -like @samp{KWD1|KWD2|...} to list entries that match any one of these -keywords. With a numeric prefix argument N, show the tree for the -Nth keyword in the variable @code{org-todo-keywords}. With two prefix -arguments, find all TODO states, both un-done and done. - -@item @kbd{M-x org-agenda t} (@code{org-todo-list}) -@kindex t @r{(Agenda dispatcher)} -Show the global TODO list. Collects the TODO items (with not-DONE -states) from all agenda files (see @ref{Agenda Views}) into a single -buffer. The new buffer is in Org Agenda mode, which provides -commands to examine and manipulate the TODO entries from the new -buffer (see @ref{Agenda Commands}). See @ref{Global TODO list}, for more information. - -@item @kbd{S-M-@key{RET}} (@code{org-insert-todo-heading}) -@kindex S-M-RET -@findex org-insert-todo-heading -Insert a new TODO entry below the current one. -@end table - -@vindex org-todo-state-tags-triggers -Changing a TODO state can also trigger tag changes. See the docstring -of the option @code{org-todo-state-tags-triggers} for details. - -@node TODO Extensions -@section Extended Use of TODO Keywords - -@cindex extended TODO keywords - -@vindex org-todo-keywords -By default, marked TODO entries have one of only two states: TODO and -DONE@. Org mode allows you to classify TODO items in more complex ways -with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With special -setup, the TODO keyword system can work differently in different -files. - -Note that @emph{tags} are another way to classify headlines in general and -TODO items in particular (see @ref{Tags}). - -@menu -* Workflow states:: From TODO to DONE in steps. -* TODO types:: I do this, Fred does the rest. -* Multiple sets in one file:: Mixing it all, still finding your way. -* Fast access to TODO states:: Single letter selection of state. -* Per-file keywords:: Different files, different requirements. -* Faces for TODO keywords:: Highlighting states. -* TODO dependencies:: When one task needs to wait for others. -@end menu - -@node Workflow states -@subsection TODO keywords as workflow states - -@cindex TODO workflow -@cindex workflow states as TODO keywords - -You can use TODO keywords to indicate different, possibly @emph{sequential} -states in the process of working on an item, for example@footnote{Changing the variable @code{org-todo-keywords} only becomes -effective after restarting Org mode in a buffer.}: - -@lisp -(setq org-todo-keywords - '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) -@end lisp - -The vertical bar separates the TODO keywords (states that @emph{need -action}) from the DONE states (which need @emph{no further action}). If -you do not provide the separator bar, the last state is used as the -DONE state. - -@cindex completion, of TODO keywords -With this setup, the command @kbd{C-c C-t} cycles an entry from -@samp{TODO} to @samp{FEEDBACK}, then to @samp{VERIFY}, and finally to @samp{DONE} and -@samp{DELEGATED}. You may also use a numeric prefix argument to quickly -select a specific state. For example @kbd{C-3 C-c C-t} changes -the state immediately to @samp{VERIFY}. Or you can use @kbd{S-@key{RIGHT}} -and @kbd{S-@key{LEFT}} to go forward and backward through the states. -If you define many keywords, you can use in-buffer completion (see -@ref{Completion}) or a special one-key selection scheme (see @ref{Fast access to TODO states}) to insert these words into the buffer. -Changing a TODO state can be logged with a timestamp, see @ref{Tracking TODO state changes}, for more information. - -@node TODO types -@subsection TODO keywords as types - -@cindex TODO types -@cindex names as TODO keywords -@cindex types as TODO keywords - -The second possibility is to use TODO keywords to indicate different -@emph{types} of action items. For example, you might want to indicate that -items are for ``work'' or ``home''. Or, when you work with several people -on a single project, you might want to assign action items directly to -persons, by using their names as TODO keywords. This type of -functionality is actually much better served by using tags (see -@ref{Tags}), so the TODO implementation is kept just for backward -compatibility. - -Using TODO types, it would be set up like this: - -@lisp -(setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) -@end lisp - -In this case, different keywords do not indicate states, but -rather different types. So the normal work flow would be to assign -a task to a person, and later to mark it DONE@. Org mode supports this -style by adapting the workings of the command @kbd{C-c C-t}@footnote{This is also true for the @kbd{t} command in the agenda -buffer.}. When used several times in succession, it still -cycles through all names, in order to first select the right type for -a task. But when you return to the item after some time and execute -@kbd{C-c C-t} again, it will switch from any name directly to -@samp{DONE}. Use prefix arguments or completion to quickly select -a specific name. You can also review the items of a specific TODO -type in a sparse tree by using a numeric prefix to @kbd{C-c / t}. -For example, to see all things Lucy has to do, you would use -@kbd{C-3 C-c / t}. To collect Lucy's items from all agenda files -into a single buffer, you would use the numeric prefix argument as -well when creating the global TODO list: @kbd{C-3 M-x org-agenda t}. - -@node Multiple sets in one file -@subsection Multiple keyword sets in one file - -@cindex TODO keyword sets - -Sometimes you may want to use different sets of TODO keywords in -parallel. For example, you may want to have the basic TODO/DONE, but -also a workflow for bug fixing, and a separate state indicating that -an item has been canceled---so it is not DONE, but also does not -require action. Your setup would then look like this: - -@lisp -(setq org-todo-keywords - '((sequence "TODO" "|" "DONE") - (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") - (sequence "|" "CANCELED"))) -@end lisp - -The keywords should all be different, this helps Org mode keep track -of which subsequence should be used for a given entry. In this setup, -@kbd{C-c C-t} only operates within a sub-sequence, so it switches -from @samp{DONE} to (nothing) to @samp{TODO}, and from @samp{FIXED} to (nothing) to -@samp{REPORT}. Therefore you need a mechanism to initially select the -correct sequence. In addition to typing a keyword or using completion -(see @ref{Completion}), you may also apply the following commands: - -@table @asis -@item @kbd{C-u C-u C-c C-t} -@itemx @kbd{C-S-@key{RIGHT}} -@itemx @kbd{C-S-@key{LEFT}} -@kindex C-S-RIGHT -@kindex C-S-LEFT -@kindex C-u C-u C-c C-t -These keys jump from one TODO sub-sequence to the next. In the -above example, @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{RIGHT}} -would jump from @samp{TODO} or @samp{DONE} to @samp{REPORT}, and any of the words -in the second row to @samp{CANCELED}. Note that the @kbd{C-S-} key -binding conflict with shift-selection (see @ref{Conflicts}). - -@item @kbd{S-@key{RIGHT}} -@itemx @kbd{S-@key{LEFT}} -@kindex S-RIGHT -@kindex S-LEFT -@kbd{S-@key{LEFT}} and @kbd{S-@key{RIGHT}} walk through @emph{all} keywords -from all sub-sequences, so for example @kbd{S-@key{RIGHT}} would -switch from @samp{DONE} to @samp{REPORT} in the example above. For -a discussion of the interaction with shift-selection, see @ref{Conflicts}. -@end table - -@node Fast access to TODO states -@subsection Fast access to TODO states - -If you would like to quickly change an entry to an arbitrary TODO -state instead of cycling through the states, you can set up keys for -single-letter access to the states. This is done by adding the -selection character after each keyword, in parentheses@footnote{All characters are allowed except @samp{@@}, @samp{^} and @samp{!}, which have -a special meaning here.}. For -example: - -@lisp -(setq org-todo-keywords - '((sequence "TODO(t)" "|" "DONE(d)") - (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") - (sequence "|" "CANCELED(c)"))) -@end lisp - -@vindex org-fast-tag-selection-include-todo -If you then press @kbd{C-c C-t} followed by the selection key, -the entry is switched to this state. @kbd{@key{SPC}} can be used to -remove any TODO keyword from an entry@footnote{Check also the variable @code{org-fast-tag-selection-include-todo}, -it allows you to change the TODO state through the tags interface (see -@ref{Setting Tags}), in case you like to mingle the two concepts. Note -that this means you need to come up with unique keys across both sets -of keywords.}. - -@node Per-file keywords -@subsection Setting up keywords for individual files - -@cindex keyword options -@cindex per-file keywords -@cindex @samp{TODO}, keyword -@cindex @samp{TYP_TODO}, keyword -@cindex @samp{SEQ_TODO}, keyword - -It can be very useful to use different aspects of the TODO mechanism -in different files. For file-local settings, you need to add special -lines to the file which set the keywords and interpretation for that -file only. For example, to set one of the two examples discussed -above, you need one of the following lines, starting in column zero -anywhere in the file: - -@example -#+TODO: TODO FEEDBACK VERIFY | DONE CANCELED -@end example - - -You may also write @samp{#+SEQ_TODO} to be explicit about the -interpretation, but it means the same as @samp{#+TODO}, or - -@example -#+TYP_TODO: Fred Sara Lucy Mike | DONE -@end example - - -A setup for using several sets in parallel would be: - -@example -#+TODO: TODO | DONE -#+TODO: REPORT BUG KNOWNCAUSE | FIXED -#+TODO: | CANCELED -@end example - -@cindex completion, of option keywords -@kindex M-TAB -To make sure you are using the correct keyword, type @samp{#+} into the -buffer and then use @kbd{M-@key{TAB}} to complete it (see @ref{Completion}). - -@cindex DONE, final TODO keyword -Remember that the keywords after the vertical bar---or the last -keyword if no bar is there---must always mean that the item is DONE, -although you may use a different word. After changing one of these -lines, use @kbd{C-c C-c} with point still in the line to make the -changes known to Org mode@footnote{Org mode parses these lines only when Org mode is activated -after visiting a file. @kbd{C-c C-c} with point in a line -starting with @samp{#+} is simply restarting Org mode for the current -buffer.}. - -@node Faces for TODO keywords -@subsection Faces for TODO keywords - -@cindex faces, for TODO keywords - -@vindex org-todo, face -@vindex org-done, face -@vindex org-todo-keyword-faces -Org mode highlights TODO keywords with special faces: @code{org-todo} for -keywords indicating that an item still has to be acted upon, and -@code{org-done} for keywords indicating that an item is finished. If you -are using more than two different states, you might want to use -special faces for some of them. This can be done using the variable -@code{org-todo-keyword-faces}. For example: - -@lisp -(setq org-todo-keyword-faces - '(("TODO" . org-warning) ("STARTED" . "yellow") - ("CANCELED" . (:foreground "blue" :weight bold)))) -@end lisp - -@vindex org-faces-easy-properties -While using a list with face properties as shown for @samp{CANCELED} -@emph{should} work, this does not always seem to be the case. If -necessary, define a special face and use that. A string is -interpreted as a color. The variable @code{org-faces-easy-properties} -determines if that color is interpreted as a foreground or -a background color. - -@node TODO dependencies -@subsection TODO dependencies - -@cindex TODO dependencies -@cindex dependencies, of TODO states - -@vindex org-enforce-todo-dependencies -@cindex @samp{ORDERED}, property -The structure of Org files---hierarchy and lists---makes it easy to -define TODO dependencies. Usually, a parent TODO task should not be -marked as done until all TODO subtasks, or children tasks, are marked -as done. Sometimes there is a logical sequence to (sub)tasks, so that -one subtask cannot be acted upon before all siblings above it have -been marked as done. If you customize the variable -@code{org-enforce-todo-dependencies}, Org blocks entries from changing -state to DONE while they have TODO children that are not DONE@. -Furthermore, if an entry has a property @samp{ORDERED}, each of its TODO -children is blocked until all earlier siblings are marked as done. -Here is an example: - -@example -* TODO Blocked until (two) is done -** DONE one -** TODO two - -* Parent -:PROPERTIES: -:ORDERED: t -:END: -** TODO a -** TODO b, needs to wait for (a) -** TODO c, needs to wait for (a) and (b) -@end example - -@cindex TODO dependencies, @samp{NOBLOCKING} -@cindex @samp{NOBLOCKING}, property -You can ensure an entry is never blocked by using the @samp{NOBLOCKING} -property (see @ref{Properties and Columns}): - -@example -* This entry is never blocked -:PROPERTIES: -:NOBLOCKING: t -:END: -@end example - -@table @asis -@item @kbd{C-c C-x o} (@code{org-toggle-ordered-property}) -@kindex C-c C-x o -@findex org-toggle-ordered-property -@vindex org-track-ordered-property-with-tag -Toggle the @samp{ORDERED} property of the current entry. A property is -used for this behavior because this should be local to the current -entry, not inherited from entries above like a tag (see @ref{Tags}). -However, if you would like to @emph{track} the value of this property -with a tag for better visibility, customize the variable -@code{org-track-ordered-property-with-tag}. - -@item @kbd{C-u C-u C-u C-c C-t} -@kindex C-u C-u C-u C-u C-c C-t -Change TODO state, regardless of any state blocking. -@end table - -@vindex org-agenda-dim-blocked-tasks -If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries -that cannot be marked as done because of unmarked children are shown -in a dimmed font or even made invisible in agenda views (see @ref{Agenda Views}). - -@cindex checkboxes and TODO dependencies -@vindex org-enforce-todo-dependencies -You can also block changes of TODO states by using checkboxes (see -@ref{Checkboxes}). If you set the variable -@code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked -checkboxes is blocked from switching to DONE@. - -If you need more complex dependency structures, for example -dependencies between entries in different trees or files, check out -the contributed module @samp{org-depend.el}. - -@node Progress Logging -@section Progress Logging - -@cindex progress logging -@cindex logging, of progress - -To record a timestamp and a note when changing a TODO state, call the -command @code{org-todo} with a prefix argument. - -@table @asis -@item @kbd{C-u C-c C-t} (@code{org-todo}) -@kindex C-u C-c C-t -Prompt for a note and record a the time of the TODO state change. -The note is inserted as a list item below the headline, but can also -be placed into a drawer, see @ref{Tracking TODO state changes}. -@end table - -If you want to be more systematic, Org mode can automatically record a -timestamp and optionally a note when you mark a TODO item as DONE, or -even each time you change the state of a TODO item. This system is -highly configurable, settings can be on a per-keyword basis and can be -localized to a file or even a subtree. For information on how to -clock working time for a task, see @ref{Clocking Work Time}. - -@menu -* Closing items:: When was this entry marked as done? -* Tracking TODO state changes:: When did the status change? -* Tracking your habits:: How consistent have you been? -@end menu - -@node Closing items -@subsection Closing items - -The most basic automatic logging is to keep track of @emph{when} a certain -TODO item was marked as done. This can be achieved with@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: logdone}.} - -@lisp -(setq org-log-done 'time) -@end lisp - -@vindex org-closed-keep-when-no-todo -@noindent -Then each time you turn an entry from a TODO (not-done) state into any -of the DONE states, a line @samp{CLOSED: [timestamp]} is inserted just -after the headline. If you turn the entry back into a TODO item -through further state cycling, that line is removed again. If you -turn the entry back to a non-TODO state (by pressing @kbd{C-c C-t @key{SPC}} for example), that line is also removed, unless you set -@code{org-closed-keep-when-no-todo} to non-@code{nil}. If you want to record -a note along with the timestamp, use@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: -lognotedone}.} - -@lisp -(setq org-log-done 'note) -@end lisp - -@noindent -You are then prompted for a note, and that note is stored below the -entry with a @samp{Closing Note} heading. - -@node Tracking TODO state changes -@subsection Tracking TODO state changes - -@cindex drawer, for state change recording - -@vindex org-log-states-order-reversed -@vindex org-log-into-drawer -@cindex @samp{LOG_INTO_DRAWER}, property -You might want to automatically keep track of when a state change -occurred and maybe take a note about this change. You can either -record just a timestamp, or a time-stamped note. These records are -inserted after the headline as an itemized list, newest first@footnote{See the variable @code{org-log-states-order-reversed}.}. -When taking a lot of notes, you might want to get the notes out of the -way into a drawer (see @ref{Drawers}). Customize the variable -@code{org-log-into-drawer} to get this behavior---the recommended drawer -for this is called @samp{LOGBOOK}@footnote{Note that the @samp{LOGBOOK} drawer is unfolded when pressing -@kbd{@key{SPC}} in the agenda to show an entry---use @kbd{C-u @key{SPC}} to keep it folded here.}. You can also overrule the -setting of this variable for a subtree by setting a @samp{LOG_INTO_DRAWER} -property. - -Since it is normally too much to record a note for every state, Org -mode expects configuration on a per-keyword basis for this. This is -achieved by adding special markers @samp{!} (for a timestamp) or @samp{@@} (for -a note with timestamp) in parentheses after each keyword. For -example, with the setting - -@lisp -(setq org-todo-keywords - '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)"))) -@end lisp - -@noindent -To record a timestamp without a note for TODO keywords configured with -@samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted. - -@vindex org-log-done -You not only define global TODO keywords and fast access keys, but -also request that a time is recorded when the entry is set to @samp{DONE}, -and that a note is recorded when switching to @samp{WAIT} or -@samp{CANCELED}@footnote{It is possible that Org mode records two timestamps when you -are using both @code{org-log-done} and state change logging. However, it -never prompts for two notes: if you have configured both, the state -change recording note takes precedence and cancel the closing note.}. The setting for @samp{WAIT} is even more special: the -@samp{!} after the slash means that in addition to the note taken when -entering the state, a timestamp should be recorded when @emph{leaving} the -@samp{WAIT} state, if and only if the @emph{target} state does not configure -logging for entering it. So it has no effect when switching from -@samp{WAIT} to @samp{DONE}, because @samp{DONE} is configured to record a timestamp -only. But when switching from @samp{WAIT} back to @samp{TODO}, the @samp{/!} in the -@samp{WAIT} setting now triggers a timestamp even though @samp{TODO} has no -logging configured. - -You can use the exact same syntax for setting logging preferences local -to a buffer: - -@example -#+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) -@end example - - -@cindex @samp{LOGGING}, property -In order to define logging settings that are local to a subtree or -a single item, define a @samp{LOGGING} property in this entry. Any -non-empty @samp{LOGGING} property resets all logging settings to @code{nil}. -You may then turn on logging for this specific tree using @samp{STARTUP} -keywords like @samp{lognotedone} or @samp{logrepeat}, as well as adding state -specific settings like @samp{TODO(!)}. For example: - -@example -* TODO Log each state with only a time - :PROPERTIES: - :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) - :END: -* TODO Only log when switching to WAIT, and when repeating - :PROPERTIES: - :LOGGING: WAIT(@@) logrepeat - :END: -* TODO No logging at all - :PROPERTIES: - :LOGGING: nil - :END: -@end example - -@node Tracking your habits -@subsection Tracking your habits - -@cindex habits -@cindex @samp{STYLE}, property - -Org has the ability to track the consistency of a special category of -TODO, called ``habits.'' To use habits, you have to enable the @code{habits} -module by customizing the variable @code{org-modules}. - -A habit has the following properties: - -@enumerate -@item -The habit is a TODO item, with a TODO keyword representing an open -state. - -@item -The property @samp{STYLE} is set to the value @samp{habit} (see @ref{Properties and Columns}). - -@item -The TODO has a scheduled date, usually with a @samp{.+} style repeat -interval. A @samp{++} style may be appropriate for habits with time -constraints, e.g., must be done on weekends, or a @samp{+} style for an -unusual habit that can have a backlog, e.g., weekly reports. - -@item -The TODO may also have minimum and maximum ranges specified by -using the syntax @samp{.+2d/3d}, which says that you want to do the task -at least every three days, but at most every two days. - -@item -State logging for the DONE state is enabled (see @ref{Tracking TODO state changes}), in order for historical data to be represented in -the consistency graph. If it is not enabled it is not an error, -but the consistency graphs are largely meaningless. -@end enumerate - -To give you an idea of what the above rules look like in action, here's an -actual habit with some history: - -@example -** TODO Shave - SCHEDULED: <2009-10-17 Sat .+2d/4d> - :PROPERTIES: - :STYLE: habit - :LAST_REPEAT: [2009-10-19 Mon 00:36] - :END: - - State "DONE" from "TODO" [2009-10-15 Thu] - - State "DONE" from "TODO" [2009-10-12 Mon] - - State "DONE" from "TODO" [2009-10-10 Sat] - - State "DONE" from "TODO" [2009-10-04 Sun] - - State "DONE" from "TODO" [2009-10-02 Fri] - - State "DONE" from "TODO" [2009-09-29 Tue] - - State "DONE" from "TODO" [2009-09-25 Fri] - - State "DONE" from "TODO" [2009-09-19 Sat] - - State "DONE" from "TODO" [2009-09-16 Wed] - - State "DONE" from "TODO" [2009-09-12 Sat] -@end example - -What this habit says is: I want to shave at most every 2 days---given -by the @samp{SCHEDULED} date and repeat interval---and at least every -4 days. If today is the 15th, then the habit first appears in the -agenda (see @ref{Agenda Views}) on Oct 17, after the minimum of 2 days has -elapsed, and will appear overdue on Oct 19, after four days have -elapsed. - -What's really useful about habits is that they are displayed along -with a consistency graph, to show how consistent you've been at -getting that task done in the past. This graph shows every day that -the task was done over the past three weeks, with colors for each day. -The colors used are: - -@table @asis -@item Blue -If the task was not to be done yet on that day. -@item Green -If the task could have been done on that day. -@item Yellow -If the task was going to be overdue the next day. -@item Red -If the task was overdue on that day. -@end table - -In addition to coloring each day, the day is also marked with an -asterisk if the task was actually done that day, and an exclamation -mark to show where the current day falls in the graph. - -There are several configuration variables that can be used to change -the way habits are displayed in the agenda. - -@table @asis -@item @code{org-habit-graph-column} -@vindex org-habit-graph-column -The buffer column at which the consistency graph should be drawn. -This overwrites any text in that column, so it is a good idea to -keep your habits' titles brief and to the point. - -@item @code{org-habit-preceding-days} -@vindex org-habit-preceding-days -The amount of history, in days before today, to appear in -consistency graphs. - -@item @code{org-habit-following-days} -@vindex org-habit-following-days -The number of days after today that appear in consistency graphs. - -@item @code{org-habit-show-habits-only-for-today} -@vindex org-habit-show-habits-only-for-today -If non-@code{nil}, only show habits in today's agenda view. The default -value is @code{t}. Pressing @kbd{C-u K} in the agenda toggles this -variable. -@end table - -Lastly, pressing @kbd{K} in the agenda buffer causes habits to -temporarily be disabled and do not appear at all. Press @kbd{K} -again to bring them back. They are also subject to tag filtering, if -you have habits which should only be done in certain contexts, for -example. - -@node Priorities -@section Priorities - -@cindex priorities -@cindex priority cookie - -If you use Org mode extensively, you may end up with enough TODO items -that it starts to make sense to prioritize them. Prioritizing can be -done by placing a @emph{priority cookie} into the headline of a TODO item -right after the TODO keyword, like this: - -@example -*** TODO [#A] Write letter to Sam Fortune -@end example - - -@vindex org-priority-faces -By default, Org mode supports three priorities: @samp{A}, @samp{B}, and @samp{C}. -@samp{A} is the highest priority. An entry without a cookie is treated as -equivalent if it had priority @samp{B}. Priorities make a difference only -for sorting in the agenda (see @ref{Weekly/daily agenda}). Outside the -agenda, they have no inherent meaning to Org mode. The cookies are -displayed with the face defined by the variable @code{org-priority-faces}, -which can be customized. - -You can also use numeric values for priorities, such as - -@example -*** TODO [#1] Write letter to Sam Fortune -@end example - - -When using numeric priorities, you need to set @code{org-priority-highest}, -@code{org-priority-lowest} and @code{org-priority-default} to integers, which -must all be strictly inferior to 65. - -Priorities can be attached to any outline node; they do not need to be -TODO items. - -@table @asis -@item @kbd{C-c ,} (@code{org-priority}) -@kindex C-c , -@findex org-priority -Set the priority of the current headline. The command prompts for -a priority character @samp{A}, @samp{B} or @samp{C}. When you press @kbd{@key{SPC}} -instead, the priority cookie, if one is set, is removed from the -headline. The priorities can also be changed ``remotely'' from the -agenda buffer with the @kbd{,} command (see @ref{Agenda Commands}). - -@item @kbd{S-@key{UP}} (@code{org-priority-up}) -@itemx @kbd{S-@key{DOWN}} (@code{org-priority-down}) -@kindex S-UP -@kindex S-DOWN -@findex org-priority-up -@findex org-priority-down -@vindex org-priority-start-cycle-with-default -Increase/decrease the priority of the current headline@footnote{See also the option @code{org-priority-start-cycle-with-default}.}. Note -that these keys are also used to modify timestamps (see @ref{Creating Timestamps}). See also @ref{Conflicts}, for -a discussion of the interaction with shift-selection. -@end table - -@vindex org-priority-highest -@vindex org-priority-lowest -@vindex org-priority-default -You can change the range of allowed priorities by setting the -variables @code{org-priority-highest}, @code{org-priority-lowest}, and -@code{org-priority-default}. For an individual buffer, you may set these -values (highest, lowest, default) like this (please make sure that the -highest priority is earlier in the alphabet than the lowest priority): - -@cindex @samp{PRIORITIES}, keyword -@example -#+PRIORITIES: A C B -@end example - - -Or, using numeric values: - -@example -#+PRIORITIES: 1 10 5 -@end example - -@node Breaking Down Tasks -@section Breaking Down Tasks into Subtasks - -@cindex tasks, breaking down -@cindex statistics, for TODO items - -@vindex org-agenda-todo-list-sublevels -It is often advisable to break down large tasks into smaller, -manageable subtasks. You can do this by creating an outline tree -below a TODO item, with detailed subtasks on the tree@footnote{To keep subtasks out of the global TODO list, see the option -@code{org-agenda-todo-list-sublevels}.}. To keep -an overview of the fraction of subtasks that have already been marked -as done, insert either @samp{[/]} or @samp{[%]} anywhere in the headline. These -cookies are updated each time the TODO status of a child changes, or -when pressing @kbd{C-c C-c} on the cookie. For example: - -@example -* Organize Party [33%] -** TODO Call people [1/2] -*** TODO Peter -*** DONE Sarah -** TODO Buy food -** DONE Talk to neighbor -@end example - -@cindex @samp{COOKIE_DATA}, property -If a heading has both checkboxes and TODO children below it, the -meaning of the statistics cookie become ambiguous. Set the property -@samp{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve this issue. - -@vindex org-hierarchical-todo-statistics -If you would like to have the statistics cookie count any TODO entries -in the subtree (not just direct children), configure the variable -@code{org-hierarchical-todo-statistics}. To do this for a single subtree, -include the word @samp{recursive} into the value of the @samp{COOKIE_DATA} -property. - -@example -* Parent capturing statistics [2/20] - :PROPERTIES: - :COOKIE_DATA: todo recursive - :END: -@end example - -If you would like a TODO entry to automatically change to DONE when -all children are done, you can use the following setup: - -@lisp -(defun org-summary-todo (n-done n-not-done) - "Switch entry to DONE when all subentries are done, to TODO otherwise." - (let (org-log-done org-log-states) ; turn off logging - (org-todo (if (= n-not-done 0) "DONE" "TODO")))) - -(add-hook 'org-after-todo-statistics-hook 'org-summary-todo) -@end lisp - -Another possibility is the use of checkboxes to identify (a hierarchy -of) a large number of subtasks (see @ref{Checkboxes}). - -@node Checkboxes -@section Checkboxes - -@cindex checkboxes - -@vindex org-list-automatic-rules -Every item in a plain list@footnote{With the exception of description lists. But you can allow it -by modifying @code{org-list-automatic-rules} accordingly.} (see @ref{Plain Lists}) can be made into -a checkbox by starting it with the string @samp{[ ]}. This feature is -similar to TODO items (see @ref{TODO Items}), but is more lightweight. -Checkboxes are not included into the global TODO list, so they are -often great to split a task into a number of simple steps. Or you can -use them in a shopping list. - -Here is an example of a checkbox list. - -@example -* TODO Organize party [2/4] - - [-] call people [1/3] - - [ ] Peter - - [X] Sarah - - [ ] Sam - - [X] order food - - [ ] think about what music to play - - [X] talk to the neighbors -@end example - -Checkboxes work hierarchically, so if a checkbox item has children -that are checkboxes, toggling one of the children checkboxes makes the -parent checkbox reflect if none, some, or all of the children are -checked. - -@cindex statistics, for checkboxes -@cindex checkbox statistics -@cindex @samp{COOKIE_DATA}, property -@vindex org-hierarchical-checkbox-statistics -The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies -indicating how many checkboxes present in this entry have been checked -off, and the total number of checkboxes present. This can give you an -idea on how many checkboxes remain, even without opening a folded -entry. The cookies can be placed into a headline or into (the first -line of) a plain list item. Each cookie covers checkboxes of direct -children structurally below the headline/item on which the cookie -appears@footnote{Set the variable @code{org-hierarchical-checkbox-statistics} if you -want such cookies to count all checkboxes below the cookie, not just -those belonging to direct children.}. You have to insert the cookie yourself by typing -either @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as -in the examples above. With @samp{[%]} you get information about the -percentage of checkboxes checked (in the above example, this would be -@samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can count -either checkboxes below the heading or TODO states of children, and it -displays whatever was changed last. Set the property @samp{COOKIE_DATA} to -either @samp{checkbox} or @samp{todo} to resolve this issue. - -@cindex blocking, of checkboxes -@cindex checkbox blocking -@cindex @samp{ORDERED}, property -If the current outline node has an @samp{ORDERED} property, checkboxes must -be checked off in sequence, and an error is thrown if you try to check -off a box while there are unchecked boxes above it. - -The following commands work with checkboxes: - -@table @asis -@item @kbd{C-c C-c} (@code{org-toggle-checkbox}) -@kindex C-c C-c -@findex org-toggle-checkbox -Toggle checkbox status or---with prefix argument---checkbox presence -at point. With a single prefix argument, add an empty checkbox or -remove the current one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no -checkbox adds checkboxes to the rest of the list.}. With a double prefix argument, set -it to @samp{[-]}, which is considered to be an intermediate state. - -@item @kbd{C-c C-x C-b} (@code{org-toggle-checkbox}) -@kindex C-c C-x C-b -Toggle checkbox status or---with prefix argument---checkbox presence -at point. With double prefix argument, set it to @samp{[-]}, which is -considered to be an intermediate state. - -@itemize -@item -If there is an active region, toggle the first checkbox in the -region and set all remaining boxes to the same status as the -first. With a prefix argument, add or remove the checkbox for all -items in the region. - -@item -If point is in a headline, toggle checkboxes in the region between -this headline and the next---so @emph{not} the entire subtree. - -@item -If there is no active region, just toggle the checkbox at point. -@end itemize - -@item @kbd{C-c C-x C-r} (@code{org-toggle-radio-button}) -@kindex C-c C-x C-r -@findex org-toggle-radio-button -@cindex radio button, checkbox as -Toggle checkbox status by using the checkbox of the item at point as -a radio button: when the checkbox is turned on, all other checkboxes -on the same level will be turned off. With a universal prefix -argument, toggle the presence of the checkbox. With a double prefix -argument, set it to @samp{[-]}. - -@findex org-list-checkbox-radio-mode -@kbd{C-c C-c} can be told to consider checkboxes as radio buttons by -setting @samp{#+ATTR_ORG: :radio t} right before the list or by calling -@kbd{M-x org-list-checkbox-radio-mode} to activate this minor mode. - -@item @kbd{M-S-@key{RET}} (@code{org-insert-todo-heading}) -@kindex M-S-RET -@findex org-insert-todo-heading -Insert a new item with a checkbox. This works only if point is -already in a plain list item (see @ref{Plain Lists}). - -@item @kbd{C-c C-x o} (@code{org-toggle-ordered-property}) -@kindex C-c C-x o -@findex org-toggle-ordered-property -@vindex org-track-ordered-property-with-tag -Toggle the @samp{ORDERED} property of the entry, to toggle if checkboxes -must be checked off in sequence. A property is used for this -behavior because this should be local to the current entry, not -inherited like a tag. However, if you would like to @emph{track} the -value of this property with a tag for better visibility, customize -@code{org-track-ordered-property-with-tag}. - -@item @kbd{C-c #} (@code{org-update-statistics-cookies}) -@kindex C-c # -@findex org-update-statistics-cookies -Update the statistics cookie in the current outline entry. When -called with a @kbd{C-u} prefix, update the entire file. -Checkbox statistic cookies are updated automatically if you toggle -checkboxes with @kbd{C-c C-c} and make new ones with -@kbd{M-S-@key{RET}}. TODO statistics cookies update when changing -TODO states. If you delete boxes/entries or add/change them by -hand, use this command to get things back into sync. -@end table - -@node Tags -@chapter Tags - -@cindex tags -@cindex headline tagging -@cindex matching, tags -@cindex sparse tree, tag based - -An excellent way to implement labels and contexts for -cross-correlating information is to assign @emph{tags} to headlines. Org -mode has extensive support for tags. - -@vindex org-tag-faces -Every headline can contain a list of tags; they occur at the end of -the headline. Tags are normal words containing letters, numbers, @samp{_}, -and @samp{@@}. Tags must be preceded and followed by a single colon, e.g., -@samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}. Tags -by default are in bold face with the same color as the headline. You -may specify special faces for specific tags using the variable -@code{org-tag-faces}, in much the same way as you can for TODO keywords -(see @ref{Faces for TODO keywords}). - -@menu -* Tag Inheritance:: Tags use the tree structure of an outline. -* Setting Tags:: How to assign tags to a headline. -* Tag Hierarchy:: Create a hierarchy of tags. -* Tag Searches:: Searching for combinations of tags. -@end menu - -@node Tag Inheritance -@section Tag Inheritance - -@cindex tag inheritance -@cindex inheritance, of tags -@cindex sublevels, inclusion into tags match - -@emph{Tags} make use of the hierarchical structure of outline trees. If -a heading has a certain tag, all subheadings inherit the tag as well. -For example, in the list - -@example -* Meeting with the French group :work: -** Summary by Frank :boss:notes: -*** TODO Prepare slides for him :action: -@end example - -@noindent -the final heading has the tags @samp{work}, @samp{boss}, @samp{notes}, and @samp{action} -even though the final heading is not explicitly marked with those -tags. You can also set tags that all entries in a file should inherit -just as if these tags were defined in a hypothetical level zero that -surrounds the entire file. Use a line like this@footnote{As with all these in-buffer settings, pressing @kbd{C-c C-c} activates any changes in the line.} - -@cindex @samp{FILETAGS}, keyword -@example -#+FILETAGS: :Peter:Boss:Secret: -@end example - - -@vindex org-use-tag-inheritance -@vindex org-tags-exclude-from-inheritance -To limit tag inheritance to specific tags, or to turn it off entirely, -use the variables @code{org-use-tag-inheritance} and -@code{org-tags-exclude-from-inheritance}. - -@vindex org-tags-match-list-sublevels -When a headline matches during a tags search while tag inheritance is -turned on, all the sublevels in the same tree---for a simple match -form---match as well@footnote{This is only true if the search does not involve more complex -tests including properties (see @ref{Property Searches}).}. The list of matches may then become -very long. If you only want to see the first tags match in a subtree, -configure the variable @code{org-tags-match-list-sublevels} (not -recommended). - -@vindex org-agenda-use-tag-inheritance -Tag inheritance is relevant when the agenda search tries to match -a tag, either in the @code{tags} or @code{tags-todo} agenda types. In other -agenda types, @code{org-use-tag-inheritance} has no effect. Still, you may -want to have your tags correctly set in the agenda, so that tag -filtering works fine, with inherited tags. Set -@code{org-agenda-use-tag-inheritance} to control this: the default value -includes all agenda types, but setting this to @code{nil} can really speed -up agenda generation. - -@node Setting Tags -@section Setting Tags - -@cindex setting tags -@cindex tags, setting - -@kindex M-TAB -Tags can simply be typed into the buffer at the end of a headline. -After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is -also a special command for inserting tags: - -@table @asis -@item @kbd{C-c C-q} (@code{org-set-tags-command}) -@kindex C-c C-q -@findex org-set-tags-command -@cindex completion, of tags -@vindex org-tags-column -Enter new tags for the current headline. Org mode either offers -completion or a special single-key interface for setting tags, see -below. After pressing @kbd{@key{RET}}, the tags are inserted and -aligned to @code{org-tags-column}. When called with a @kbd{C-u} -prefix, all tags in the current buffer are aligned to that column, -just to make things look nice. Tags are automatically realigned -after promotion, demotion, and TODO state changes (see @ref{TODO Basics}). - -@item @kbd{C-c C-c} (@code{org-set-tags-command}) -@kindex C-c C-c -When point is in a headline, this does the same as @kbd{C-c C-q}. -@end table - -@vindex org-complete-tags-always-offer-all-agenda-tags -@vindex org-tag-alist -@cindex @samp{TAGS}, keyword -Org supports tag insertion based on a @emph{list of tags}. By default this -list is constructed dynamically, containing all tags currently used in -the buffer@footnote{To extend this default list to all tags used in all agenda -files (see @ref{Agenda Views}), customize the variable -@code{org-complete-tags-always-offer-all-agenda-tags}.}. You may also globally specify a hard list of tags -with the variable @code{org-tag-alist}. Finally you can set the default -tags for a given file using the @samp{TAGS} keyword, like - -@example -#+TAGS: @@work @@home @@tennisclub -#+TAGS: laptop car pc sailboat -@end example - -If you have globally defined your preferred set of tags using the -variable @code{org-tag-alist}, but would like to use a dynamic tag list in -a specific file, add an empty @samp{TAGS} keyword to that file: - -@example -#+TAGS: -@end example - - -@vindex org-tag-persistent-alist -If you have a preferred set of tags that you would like to use in -every file, in addition to those defined on a per-file basis by @samp{TAGS} -keyword, then you may specify a list of tags with the variable -@code{org-tag-persistent-alist}. You may turn this off on a per-file basis -by adding a @samp{STARTUP} keyword to that file: - -@example -#+STARTUP: noptag -@end example - - -By default Org mode uses the standard minibuffer completion facilities -for entering tags. However, it also implements another, quicker, tag -selection method called @emph{fast tag selection}. This allows you to -select and deselect tags with just a single key press. For this to -work well you should assign unique letters to most of your commonly -used tags. You can do this globally by configuring the variable -@code{org-tag-alist} in your Emacs init file. For example, you may find -the need to tag many items in different files with @samp{@@home}. In this -case you can set something like: - -@lisp -(setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) -@end lisp - -If the tag is only relevant to the file you are working on, then you -can instead set the @samp{TAGS} keyword as: - -@example -#+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) -@end example - - -The tags interface shows the available tags in a splash window. If -you want to start a new line after a specific tag, insert @samp{\n} into -the tag list - -@example -#+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p) -@end example - - -@noindent -or write them in two lines: - -@example -#+TAGS: @@work(w) @@home(h) @@tennisclub(t) -#+TAGS: laptop(l) pc(p) -@end example - -You can also group together tags that are mutually exclusive by using -braces, as in: - -@example -#+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p) -@end example - - -@noindent -you indicate that at most one of @samp{@@work}, @samp{@@home}, and @samp{@@tennisclub} -should be selected. Multiple such groups are allowed. - -Do not forget to press @kbd{C-c C-c} with point in one of these -lines to activate any changes. - -To set these mutually exclusive groups in the variable -@code{org-tags-alist}, you must use the dummy tags @code{:startgroup} and -@code{:endgroup} instead of the braces. Similarly, you can use @code{:newline} -to indicate a line break. The previous example would be set globally -by the following configuration: - -@lisp -(setq org-tag-alist '((:startgroup . nil) - ("@@work" . ?w) ("@@home" . ?h) - ("@@tennisclub" . ?t) - (:endgroup . nil) - ("laptop" . ?l) ("pc" . ?p))) -@end lisp - -If at least one tag has a selection key then pressing @kbd{C-c C-c} automatically presents you with a special interface, listing -inherited tags, the tags of the current headline, and a list of all -valid tags with corresponding keys@footnote{Keys are automatically assigned to tags that have no -configured keys.}. - -Pressing keys assigned to tags adds or removes them from the list of -tags in the current line. Selecting a tag in a group of mutually -exclusive tags turns off any other tag from that group. - -In this interface, you can also use the following special keys: - -@table @asis -@item @kbd{@key{TAB}} -@kindex TAB -Enter a tag in the minibuffer, even if the tag is not in the -predefined list. You can complete on all tags present in the -buffer. You can also add several tags: just separate them with -a comma. - -@item @kbd{@key{SPC}} -@kindex SPC -Clear all tags for this line. - -@item @kbd{@key{RET}} -@kindex RET -Accept the modified set. - -@item @kbd{C-g} -@kindex C-g -Abort without installing changes. - -@item @kbd{q} -@kindex q -If @kbd{q} is not assigned to a tag, it aborts like -@kbd{C-g}. - -@item @kbd{!} -@kindex ! -Turn off groups of mutually exclusive tags. Use this to (as an -exception) assign several tags from such a group. - -@item @kbd{C-c} -@kindex C-c C-c -Toggle auto-exit after the next change (see below). If you are -using expert mode, the first @kbd{C-c} displays the selection -window. -@end table - -This method lets you assign tags to a headline with very few keys. -With the above setup, you could clear the current tags and set -@samp{@@home}, @samp{laptop} and @samp{pc} tags with just the following keys: -@kbd{C-c C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to @samp{@@work} -would be done with @kbd{C-c C-c w @key{RET}} or alternatively with -@kbd{C-c C-c C-c w}. Adding the non-predefined tag @samp{sarah} could -be done with @kbd{C-c C-c @key{TAB} s a r a h @key{RET}}. - -@vindex org-fast-tag-selection-single-key -If you find that most of the time you need only a single key press to -modify your list of tags, set the variable -@code{org-fast-tag-selection-single-key}. Then you no longer have to press -@kbd{@key{RET}} to exit fast tag selection---it exits after the first -change. If you then occasionally need more keys, press @kbd{C-c} -to turn off auto-exit for the current tag selection process (in -effect: start selection with @kbd{C-c C-c C-c} instead of -@kbd{C-c C-c}). If you set the variable to the value @code{expert}, -the special window is not even shown for single-key tag selection, it -comes up only when you press an extra @kbd{C-c}. - -@node Tag Hierarchy -@section Tag Hierarchy - -@cindex group tags -@cindex tags, groups -@cindex tags hierarchy - -Tags can be defined in hierarchies. A tag can be defined as a @emph{group -tag} for a set of other tags. The group tag can be seen as the -``broader term'' for its set of tags. Defining multiple group tags and -nesting them creates a tag hierarchy. - -One use-case is to create a taxonomy of terms (tags) that can be used -to classify nodes in a document or set of documents. - -When you search for a group tag, it return matches for all members in -the group and its subgroups. In an agenda view, filtering by a group -tag displays or hide headlines tagged with at least one of the members -of the group or any of its subgroups. This makes tag searches and -filters even more flexible. - -You can set group tags by using brackets and inserting a colon between -the group tag and its related tags---beware that all whitespaces are -mandatory so that Org can parse this line correctly: - -@example -#+TAGS: [ GTD : Control Persp ] -@end example - - -In this example, @samp{GTD} is the group tag and it is related to two other -tags: @samp{Control}, @samp{Persp}. Defining @samp{Control} and @samp{Persp} as group -tags creates a hierarchy of tags: - -@example -#+TAGS: [ Control : Context Task ] -#+TAGS: [ Persp : Vision Goal AOF Project ] -@end example - -That can conceptually be seen as a hierarchy of tags: - -@itemize -@item -@samp{GTD} -@itemize -@item -@samp{Persp} -@itemize -@item -@samp{Vision} -@item -@samp{Goal} -@item -@samp{AOF} -@item -@samp{Project} -@end itemize -@item -@samp{Control} -@itemize -@item -@samp{Context} -@item -@samp{Task} -@end itemize -@end itemize -@end itemize - -You can use the @code{:startgrouptag}, @code{:grouptags} and @code{:endgrouptag} -keyword directly when setting @code{org-tag-alist} directly: - -@lisp -(setq org-tag-alist '((:startgrouptag) - ("GTD") - (:grouptags) - ("Control") - ("Persp") - (:endgrouptag) - (:startgrouptag) - ("Control") - (:grouptags) - ("Context") - ("Task") - (:endgrouptag))) -@end lisp - -The tags in a group can be mutually exclusive if using the same group -syntax as is used for grouping mutually exclusive tags together; using -curly brackets. - -@example -#+TAGS: @{ Context : @@Home @@Work @@Call @} -@end example - - -When setting @code{org-tag-alist} you can use @code{:startgroup} and @code{:endgroup} -instead of @code{:startgrouptag} and @code{:endgrouptag} to make the tags -mutually exclusive. - -Furthermore, the members of a group tag can also be regular -expressions, creating the possibility of a more dynamic and rule-based -tag structure. The regular expressions in the group must be specified -within curly brackets. Here is an expanded example: - -@example -#+TAGS: [ Vision : @{V@@.+@} ] -#+TAGS: [ Goal : @{G@@.+@} ] -#+TAGS: [ AOF : @{AOF@@.+@} ] -#+TAGS: [ Project : @{P@@.+@} ] -@end example - -Searching for the tag @samp{Project} now lists all tags also including -regular expression matches for @samp{P@@.+}, and similarly for tag searches -on @samp{Vision}, @samp{Goal} and @samp{AOF}. For example, this would work well for -a project tagged with a common project-identifier, e.g., -@samp{P@@2014_OrgTags}. - -@kindex C-c C-x q -@findex org-toggle-tags-groups -@vindex org-group-tags -If you want to ignore group tags temporarily, toggle group tags -support with @code{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. -If you want to disable tag groups completely, set @code{org-group-tags} to -@code{nil}. - -@node Tag Searches -@section Tag Searches - -@cindex tag searches -@cindex searching for tags - -Once a system of tags has been set up, it can be used to collect -related information into special lists. - -@table @asis -@item @kbd{C-c / m} or @kbd{C-c \} (@code{org-match-sparse-tree}) -@kindex C-c / m -@kindex C-c \ -@findex org-match-sparse-tree -Create a sparse tree with all headlines matching a tags search. -With a @kbd{C-u} prefix argument, ignore headlines that are not -a TODO line. - -@item @kbd{M-x org-agenda m} (@code{org-tags-view}) -@kindex m @r{(Agenda dispatcher)} -@findex org-tags-view -Create a global list of tag matches from all agenda files. See -@ref{Matching tags and properties}. - -@item @kbd{M-x org-agenda M} (@code{org-tags-view}) -@kindex M @r{(Agenda dispatcher)} -@vindex org-tags-match-list-sublevels -Create a global list of tag matches from all agenda files, but check -only TODO items and force checking subitems (see the option -@code{org-tags-match-list-sublevels}). -@end table - -These commands all prompt for a match string which allows basic -Boolean logic like @samp{+boss+urgent-project1}, to find entries with tags -@samp{boss} and @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find -entries which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of -the search string is rich and allows also matching against TODO -keywords, entry levels and properties. For a complete description -with many examples, see @ref{Matching tags and properties}. - -@node Properties and Columns -@chapter Properties and Columns - -@cindex properties - -A property is a key-value pair associated with an entry. Properties -can be set so they are associated with a single entry, with every -entry in a tree, or with the whole buffer. - -There are two main applications for properties in Org mode. First, -properties are like tags, but with a value. Imagine maintaining -a file where you document bugs and plan releases for a piece of -software. Instead of using tags like @samp{release_1}, @samp{release_2}, you -can use a property, say @samp{Release}, that in different subtrees has -different values, such as @samp{1.0} or @samp{2.0}. Second, you can use -properties to implement (very basic) database capabilities in an Org -buffer. Imagine keeping track of your music CDs, where properties -could be things such as the album, artist, date of release, number of -tracks, and so on. - -Properties can be conveniently edited and viewed in column view (see -@ref{Column View}). - -@menu -* Property Syntax:: How properties are spelled out. -* Special Properties:: Access to other Org mode features. -* Property Searches:: Matching property values. -* Property Inheritance:: Passing values down a tree. -* Column View:: Tabular viewing and editing. -@end menu - -@node Property Syntax -@section Property Syntax - -@cindex property syntax -@cindex drawer, for properties - -Properties are key--value pairs. When they are associated with -a single entry or with a tree they need to be inserted into a special -drawer (see @ref{Drawers}) with the name @samp{PROPERTIES}, which has to be -located right below a headline, and its planning line (see @ref{Deadlines and Scheduling}) when applicable. Each property is specified on -a single line, with the key---surrounded by colons---first, and the -value after it. Keys are case-insensitive. Here is an example: - -@example -* CD collection -** Classic -*** Goldberg Variations - :PROPERTIES: - :Title: Goldberg Variations - :Composer: J.S. Bach - :Artist: Glenn Gould - :Publisher: Deutsche Grammophon - :NDisks: 1 - :END: -@end example - -Depending on the value of @code{org-use-property-inheritance}, a property -set this way is associated either with a single entry, or with the -sub-tree defined by the entry, see @ref{Property Inheritance}. - -You may define the allowed values for a particular property @samp{Xyz} by -setting a property @samp{Xyz_ALL}. This special property is @emph{inherited}, -so if you set it in a level 1 entry, it applies to the entire tree. -When allowed values are defined, setting the corresponding property -becomes easier and is less prone to typing errors. For the example -with the CD collection, we can pre-define publishers and the number of -disks in a box like this: - -@example -* CD collection - :PROPERTIES: - :NDisks_ALL: 1 2 3 4 - :Publisher_ALL: "Deutsche Grammophon" Philips EMI - :END: -@end example - -Properties can be inserted on buffer level. That means they apply -before the first headline and can be inherited by all entries in a -file. Property blocks defined before first headline needs to be -located at the top of the buffer, allowing only comments above. - -Properties can also be defined using lines like: - -@cindex @samp{_ALL} suffix, in properties -@cindex @samp{PROPERTY}, keyword -@example -#+PROPERTY: NDisks_ALL 1 2 3 4 -@end example - - -@cindex @samp{+} suffix, in properties -If you want to add to the value of an existing property, append a @samp{+} -to the property name. The following results in the property @samp{var} -having the value @samp{foo=1 bar=2}. - -@example -#+PROPERTY: var foo=1 -#+PROPERTY: var+ bar=2 -@end example - -It is also possible to add to the values of inherited properties. The -following results in the @samp{Genres} property having the value @samp{Classic -Baroque} under the @samp{Goldberg Variations} subtree. - -@example -* CD collection -** Classic - :PROPERTIES: - :Genres: Classic - :END: -*** Goldberg Variations - :PROPERTIES: - :Title: Goldberg Variations - :Composer: J.S. Bach - :Artist: Glenn Gould - :Publisher: Deutsche Grammophon - :NDisks: 1 - :Genres+: Baroque - :END: -@end example - -Note that a property can only have one entry per drawer. - -@vindex org-global-properties -Property values set with the global variable @code{org-global-properties} -can be inherited by all entries in all Org files. - -The following commands help to work with properties: - -@table @asis -@item @kbd{M-@key{TAB}} (@code{pcomplete}) -@kindex M-TAB -@findex pcomplete -After an initial colon in a line, complete property keys. All keys -used in the current file are offered as possible completions. - -@item @kbd{C-c C-x p} (@code{org-set-property}) -@kindex C-c C-x p -@findex org-set-property -Set a property. This prompts for a property name and a value. If -necessary, the property drawer is created as well. - -@item @kbd{C-u M-x org-insert-drawer} -@findex org-insert-drawer -Insert a property drawer into the current entry. The drawer is -inserted early in the entry, but after the lines with planning -information like deadlines. If before first headline the drawer is -inserted at the top of the drawer after any potential comments. - -@item @kbd{C-c C-c} (@code{org-property-action}) -@kindex C-c C-c -@findex org-property-action -With point in a property drawer, this executes property commands. - -@item @kbd{C-c C-c s} (@code{org-set-property}) -@kindex C-c C-c s -@findex org-set-property -Set a property in the current entry. Both the property and the -value can be inserted using completion. - -@item @kbd{S-@key{RIGHT}} (@code{org-property-next-allowed-values}) -@itemx @kbd{S-@key{LEFT}} (@code{org-property-previous-allowed-value}) -@kindex S-RIGHT -@kindex S-LEFT -Switch property at point to the next/previous allowed value. - -@item @kbd{C-c C-c d} (@code{org-delete-property}) -@kindex C-c C-c d -@findex org-delete-property -Remove a property from the current entry. - -@item @kbd{C-c C-c D} (@code{org-delete-property-globally}) -@kindex C-c C-c D -@findex org-delete-property-globally -Globally remove a property, from all entries in the current file. - -@item @kbd{C-c C-c c} (@code{org-compute-property-at-point}) -@kindex C-c C-c c -@findex org-compute-property-at-point -Compute the property at point, using the operator and scope from the -nearest column format definition. -@end table - -@node Special Properties -@section Special Properties - -@cindex properties, special - -Special properties provide an alternative access method to Org mode -features, like the TODO state or the priority of an entry, discussed -in the previous chapters. This interface exists so that you can -include these states in a column view (see @ref{Column View}), or to use -them in queries. The following property names are special and should -not be used as keys in the properties drawer: - -@cindex @samp{ALLTAGS}, special property -@cindex @samp{BLOCKED}, special property -@cindex @samp{CLOCKSUM}, special property -@cindex @samp{CLOCKSUM_T}, special property -@cindex @samp{CLOSED}, special property -@cindex @samp{DEADLINE}, special property -@cindex @samp{FILE}, special property -@cindex @samp{ITEM}, special property -@cindex @samp{PRIORITY}, special property -@cindex @samp{SCHEDULED}, special property -@cindex @samp{TAGS}, special property -@cindex @samp{TIMESTAMP}, special property -@cindex @samp{TIMESTAMP_IA}, special property -@cindex @samp{TODO}, special property -@multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{ALLTAGS} -@tab All tags, including inherited ones. -@item @samp{BLOCKED} -@tab @code{t} if task is currently blocked by children or siblings. -@item @samp{CATEGORY} -@tab The category of an entry. -@item @samp{CLOCKSUM} -@tab The sum of CLOCK intervals in the subtree. @code{org-clock-sum} -@item -@tab must be run first to compute the values in the current buffer. -@item @samp{CLOCKSUM_T} -@tab The sum of CLOCK intervals in the subtree for today. -@item -@tab @code{org-clock-sum-today} must be run first to compute the -@item -@tab values in the current buffer. -@item @samp{CLOSED} -@tab When was this entry closed? -@item @samp{DEADLINE} -@tab The deadline timestamp. -@item @samp{FILE} -@tab The filename the entry is located in. -@item @samp{ITEM} -@tab The headline of the entry. -@item @samp{PRIORITY} -@tab The priority of the entry, a string with a single letter. -@item @samp{SCHEDULED} -@tab The scheduling timestamp. -@item @samp{TAGS} -@tab The tags defined directly in the headline. -@item @samp{TIMESTAMP} -@tab The first keyword-less timestamp in the entry. -@item @samp{TIMESTAMP_IA} -@tab The first inactive timestamp in the entry. -@item @samp{TODO} -@tab The TODO keyword of the entry. -@end multitable - -@node Property Searches -@section Property Searches - -@cindex properties, searching -@cindex searching, of properties - -To create sparse trees and special lists with selection based on -properties, the same commands are used as for tag searches (see @ref{Tag Searches}). - -@table @asis -@item @kbd{C-c / m} or @kbd{C-c \} (@code{org-match-sparse-tree}) -@kindex C-c / m -@kindex C-c \ -@findex org-match-sparse-tree -Create a sparse tree with all matching entries. With -a @kbd{C-u} prefix argument, ignore headlines that are not -a TODO line. - -@item @kbd{M-x org-agenda m} (@code{org-tags-view}) -@kindex m @r{(Agenda dispatcher)} -@findex org-tags-view -Create a global list of tag/property matches from all agenda files. - -@item @kbd{M-x org-agenda M} (@code{org-tags-view}) -@kindex M @r{(Agenda dispatcher)} -@vindex org-tags-match-list-sublevels -Create a global list of tag matches from all agenda files, but check -only TODO items and force checking of subitems (see the option -@code{org-tags-match-list-sublevels}). -@end table - -The syntax for the search string is described in @ref{Matching tags and properties}. - -There is also a special command for creating sparse trees based on a -single property: - -@table @asis -@item @kbd{C-c / p} -@kindex C-c / p -Create a sparse tree based on the value of a property. This first -prompts for the name of a property, and then for a value. A sparse -tree is created with all entries that define this property with the -given value. If you enclose the value in curly braces, it is -interpreted as a regular expression and matched against the property -values. -@end table - -@node Property Inheritance -@section Property Inheritance - -@cindex properties, inheritance -@cindex inheritance, of properties - -@vindex org-use-property-inheritance -The outline structure of Org documents lends itself to an inheritance -model of properties: if the parent in a tree has a certain property, -the children can inherit this property. Org mode does not turn this -on by default, because it can slow down property searches -significantly and is often not needed. However, if you find -inheritance useful, you can turn it on by setting the variable -@code{org-use-property-inheritance}. It may be set to @code{t} to make all -properties inherited from the parent, to a list of properties that -should be inherited, or to a regular expression that matches inherited -properties. If a property has the value @code{nil}, this is interpreted as -an explicit un-define of the property, so that inheritance search -stops at this value and returns @code{nil}. - -Org mode has a few properties for which inheritance is hard-coded, at -least for the special applications for which they are used: - -@table @asis -@item @code{COLUMNS} -@cindex @samp{COLUMNS}, property -The @samp{COLUMNS} property defines the format of column view (see -@ref{Column View}). It is inherited in the sense that the level where -a @samp{COLUMNS} property is defined is used as the starting point for -a column view table, independently of the location in the subtree -from where columns view is turned on. - -@item @code{CATEGORY} -@cindex @samp{CATEGORY}, property -For agenda view, a category set through a @samp{CATEGORY} property -applies to the entire subtree. - -@item @code{ARCHIVE} -@cindex @samp{ARCHIVE}, property -For archiving, the @samp{ARCHIVE} property may define the archive -location for the entire subtree (see @ref{Moving subtrees}). - -@item @code{LOGGING} -@cindex @samp{LOGGING}, property -The @samp{LOGGING} property may define logging settings for an entry or -a subtree (see @ref{Tracking TODO state changes}). -@end table - -@node Column View -@section Column View - -A great way to view and edit properties in an outline tree is @emph{column -view}. In column view, each outline node is turned into a table row. -Columns in this table provide access to properties of the entries. -Org mode implements columns by overlaying a tabular structure over the -headline of each item. While the headlines have been turned into -a table row, you can still change the visibility of the outline tree. -For example, you get a compact table by switching to ``contents'' -view---@kbd{S-@key{TAB}} @kbd{S-@key{TAB}}, or simply @kbd{c} -while column view is active---but you can still open, read, and edit -the entry below each headline. Or, you can switch to column view -after executing a sparse tree command and in this way get a table only -for the selected items. Column view also works in agenda buffers (see -@ref{Agenda Views}) where queries have collected selected items, possibly -from a number of files. - -@menu -* Defining columns:: The COLUMNS format property. -* Using column view:: How to create and use column view. -* Capturing column view:: A dynamic block for column view. -@end menu - -@node Defining columns -@subsection Defining columns - -@cindex column view, for properties -@cindex properties, column view - -Setting up a column view first requires defining the columns. This is -done by defining a column format line. - -@menu -* Scope of column definitions:: Where defined, where valid? -* Column attributes:: Appearance and content of a column. -@end menu - -@node Scope of column definitions -@subsubsection Scope of column definitions - -To specify a format that only applies to a specific tree, add -a @samp{COLUMNS} property to the top node of that tree, for example: - -@example -** Top node for columns view - :PROPERTIES: - :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO - :END: -@end example - -A @samp{COLUMNS} property within a property drawer before first headline -will apply to the entire file. As an addition to property drawers, -keywords can also be defined for an entire file using a line like: - -@cindex @samp{COLUMNS}, keyword -@example -#+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO -@end example - - -If a @samp{COLUMNS} property is present in an entry, it defines columns for -the entry itself, and for the entire subtree below it. Since the -column definition is part of the hierarchical structure of the -document, you can define columns on level 1 that are general enough -for all sublevels, and more specific columns further down, when you -edit a deeper part of the tree. - -@node Column attributes -@subsubsection Column attributes - -A column definition sets the attributes of a column. The general -definition looks like this: - -@example -%[WIDTH]PROPERTY[(TITLE)][@{SUMMARY-TYPE@}] -@end example - - -@noindent -Except for the percent sign and the property name, all items are -optional. The individual parts have the following meaning: - -@table @asis -@item @var{WIDTH} -An integer specifying the width of the column in characters. If -omitted, the width is determined automatically. - -@item @var{PROPERTY} -The property that should be edited in this column. Special -properties representing meta data are allowed here as well (see -@ref{Special Properties}). - -@item @var{TITLE} -The header text for the column. If omitted, the property name is -used. - -@item @var{SUMMARY-TYPE} -The summary type. If specified, the column values for parent nodes -are computed from the children@footnote{If more than one summary type applies to the same property, -the parent values are computed according to the first of them.}. - -Supported summary types are: - -@multitable {aaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{+} -@tab Sum numbers in this column. -@item @samp{+;%.1f} -@tab Like @samp{+}, but format result with @samp{%.1f}. -@item @samp{$} -@tab Currency, short for @samp{+;%.2f}. -@item @samp{min} -@tab Smallest number in column. -@item @samp{max} -@tab Largest number. -@item @samp{mean} -@tab Arithmetic mean of numbers. -@item @samp{X} -@tab Checkbox status, @samp{[X]} if all children are @samp{[X]}. -@item @samp{X/} -@tab Checkbox status, @samp{[n/m]}. -@item @samp{X%} -@tab Checkbox status, @samp{[n%]}. -@item @samp{:} -@tab Sum times, HH:MM, plain numbers are minutes. -@item @samp{:min} -@tab Smallest time value in column. -@item @samp{:max} -@tab Largest time value. -@item @samp{:mean} -@tab Arithmetic mean of time values. -@item @samp{@@min} -@tab Minimum age@footnote{An age can be defined as a duration, using units defined in -@code{org-duration-units}, e.g., @samp{3d 1h}. If any value in the column is as -such, the summary is also expressed as a duration.} (in days/hours/mins/seconds). -@item @samp{@@max} -@tab Maximum age (in days/hours/mins/seconds). -@item @samp{@@mean} -@tab Arithmetic mean of ages (in days/hours/mins/seconds). -@item @samp{est+} -@tab Add low-high estimates. -@end multitable - -@vindex org-columns-summary-types -You can also define custom summary types by setting -@code{org-columns-summary-types}. -@end table - -The @samp{est+} summary type requires further explanation. It is used for -combining estimates, expressed as low-high ranges. For example, -instead of estimating a particular task will take 5 days, you might -estimate it as 5--6 days if you're fairly confident you know how much -work is required, or 1--10 days if you do not really know what needs -to be done. Both ranges average at 5.5 days, but the first represents -a more predictable delivery. - -When combining a set of such estimates, simply adding the lows and -highs produces an unrealistically wide result. Instead, @samp{est+} adds -the statistical mean and variance of the subtasks, generating a final -estimate from the sum. For example, suppose you had ten tasks, each -of which was estimated at 0.5 to 2 days of work. Straight addition -produces an estimate of 5 to 20 days, representing what to expect if -everything goes either extremely well or extremely poorly. In -contrast, @samp{est+} estimates the full job more realistically, at 10--15 -days. - -Here is an example for a complete columns definition, along with -allowed values@footnote{Please note that the @samp{COLUMNS} definition must be on a single -line; it is wrapped here only because of formatting constraints.}. - -@example -:COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \ - %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T -:Owner_ALL: Tammy Mark Karl Lisa Don -:Status_ALL: "In progress" "Not started yet" "Finished" "" -:Approved_ALL: "[ ]" "[X]" -@end example - -@noindent -The first column, @samp{%25ITEM}, means the first 25 characters of the item -itself, i.e., of the headline. You probably always should start the -column definition with the @samp{ITEM} specifier. The other specifiers -create columns @samp{Owner} with a list of names as allowed values, for -@samp{Status} with four different possible values, and for a checkbox field -@samp{Approved}. When no width is given after the @samp{%} character, the -column is exactly as wide as it needs to be in order to fully display -all values. The @samp{Approved} column does have a modified title -(@samp{Approved?}, with a question mark). Summaries are created for the -@samp{Time_Estimate} column by adding time duration expressions like HH:MM, -and for the @samp{Approved} column, by providing an @samp{[X]} status if all -children have been checked. The @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns -are special, they lists the sums of CLOCK intervals in the subtree, -either for all clocks or just for today. - -@node Using column view -@subsection Using column view - - - -@anchor{Turning column view on or off} -@subsubheading Turning column view on or off - -@table @asis -@item @kbd{C-c C-x C-c} (@code{org-columns}) -@kindex C-c C-x C-c -@vindex org-columns -@vindex org-columns-default-format -Turn on column view. If point is before the first headline in the -file, column view is turned on for the entire file, using the -@samp{#+COLUMNS} definition. If point is somewhere inside the outline, -this command searches the hierarchy, up from point, for a @samp{COLUMNS} -property that defines a format. When one is found, the column view -table is established for the tree starting at the entry that -contains the @samp{COLUMNS} property. If no such property is found, the -format is taken from the @samp{#+COLUMNS} line or from the variable -@code{org-columns-default-format}, and column view is established for the -current entry and its subtree. - -@item @kbd{r} or @kbd{g} on a columns view line (@code{org-columns-redo}) -@kindex r -@kindex g -@findex org-columns-redo -Recreate the column view, to include recent changes made in the -buffer. - -@item @kbd{C-c C-c} or @kbd{q} on a columns view line (@code{org-columns-quit}) -@kindex q -@kindex C-c C-c -@findex org-columns-quit -Exit column view. -@end table - -@anchor{Editing values} -@subsubheading Editing values - -@table @asis -@item @kbd{@key{LEFT}}, @kbd{@key{RIGHT}}, @kbd{@key{UP}}, @kbd{@key{DOWN}} -Move through the column view from field to field. - -@item @kbd{1..9,0} -@kindex 1..9,0 -Directly select the Nth allowed value, @kbd{0} selects the -10th value. - -@item @kbd{n} or @kbd{S-@key{RIGHT}} (@code{org-columns-next-allowed-value}) -@itemx @kbd{p} or @kbd{S-@key{LEFT}} (@code{org-columns-previous-allowed-value}) -@kindex n -@kindex S-RIGHT -@kindex p -@kindex S-LEFT -@findex org-columns-next-allowed-value -@findex org-columns-previous-allowed-value -Switch to the next/previous allowed value of the field. For this, -you have to have specified allowed values for a property. - -@item @kbd{e} (@code{org-columns-edit-value}) -@kindex e -@findex org-columns-edit-value -Edit the property at point. For the special properties, this -invokes the same interface that you normally use to change that -property. For example, the tag completion or fast selection -interface pops up when editing a @samp{TAGS} property. - -@item @kbd{C-c C-c} (@code{org-columns-toggle-or-columns-quit}) -@kindex C-c C-c -@findex org-columns-toggle-or-columns-quit -When there is a checkbox at point, toggle it. Else exit column -view. - -@item @kbd{v} (@code{org-columns-show-value}) -@kindex v -@findex org-columns-show-value -View the full value of this property. This is useful if the width -of the column is smaller than that of the value. - -@item @kbd{a} (@code{org-columns-edit-allowed}) -@kindex a -@findex org-columns-edit-allowed -Edit the list of allowed values for this property. If the list is -found in the hierarchy, the modified values is stored there. If no -list is found, the new value is stored in the first entry that is -part of the current column view. -@end table - -@anchor{Modifying column view on-the-fly} -@subsubheading Modifying column view on-the-fly - -@table @asis -@item @kbd{<} (@code{org-columns-narrow}) -@itemx @kbd{>} (@code{org-columns-widen}) -@kindex < -@kindex > -@findex org-columns-narrow -@findex org-columns-widen -Make the column narrower/wider by one character. - -@item @kbd{S-M-@key{RIGHT}} (@code{org-columns-new}) -@kindex S-M-RIGHT -@findex org-columns-new -Insert a new column, to the left of the current column. - -@item @kbd{S-M-@key{LEFT}} (@code{org-columns-delete}) -@kindex S-M-LEFT -@findex org-columns-delete -Delete the current column. -@end table - -@node Capturing column view -@subsection Capturing column view - -Since column view is just an overlay over a buffer, it cannot be -exported or printed directly. If you want to capture a column view, -use a @samp{columnview} dynamic block (see @ref{Dynamic Blocks}). The frame of -this block looks like this: - -@cindex @samp{BEGIN columnview} -@example -* The column view -#+BEGIN: columnview :hlines 1 :id "label" - -#+END: -@end example - -This dynamic block has the following parameters: - -@table @asis -@item @samp{:id} -This is the most important parameter. Column view is a feature that -is often localized to a certain (sub)tree, and the capture block -might be at a different location in the file. To identify the tree -whose view to capture, you can use four values: - -@table @asis -@item @samp{local} -Use the tree in which the capture block is located. - -@item @samp{global} -Make a global view, including all headings in the file. - -@item @samp{file:FILENAME} -Run column view at the top of the @var{FILENAME} file. - -@item @samp{LABEL} -@cindex @samp{ID}, property -Call column view in the tree that has an @samp{ID} property with the -value @var{LABEL}. You can use @kbd{M-x org-id-copy} to -create a globally unique ID for the current entry and copy it to -the kill-ring. -@end table - -@item @samp{:match} -When set to a string, use this as a tags/property match filter to -select only a subset of the headlines in the scope set by the @code{:id} -parameter. -@end table - - -@table @asis -@item @samp{:hlines} -When @code{t}, insert an hline after every line. When a number N, insert -an hline before each headline with level @code{<= N}. - -@item @samp{:vlines} -When non-@code{nil}, force column groups to get vertical lines. - -@item @samp{:maxlevel} -When set to a number, do not capture entries below this level. - -@item @samp{:skip-empty-rows} -When non-@code{nil}, skip rows where the only non-empty specifier of -the column view is @samp{ITEM}. - -@item @samp{:exclude-tags} -List of tags to exclude from column view table: entries with these -tags will be excluded from the column view. - -@item @samp{:indent} -When non-@code{nil}, indent each @samp{ITEM} field according to its level. - -@item @samp{:format} -Specify a column attribute (see @ref{Column attributes}) for the dynamic -block. -@end table - -The following commands insert or update the dynamic block: - -@table @asis -@item @code{org-columns-insert-dblock} -@kindex C-c C-x x -@findex org-columns-insert-dblock -Insert a dynamic block capturing a column view. Prompt for the -scope or ID of the view. - -This command can be invoked by calling -@code{org-dynamic-block-insert-dblock} (@kbd{C-c C-x x}) and -selecting ``columnview'' (see @ref{Dynamic Blocks}). - -@item @kbd{C-c C-c} @kbd{C-c C-x C-u} (@code{org-dblock-update}) -@kindex C-c C-c -@kindex C-c C-x C-u -@findex org-dblock-update -Update dynamic block at point. point needs to be in the @samp{#+BEGIN} -line of the dynamic block. - -@item @kbd{C-u C-c C-x C-u} (@code{org-update-all-dblocks}) -@kindex C-u C-c C-x C-u -Update all dynamic blocks (see @ref{Dynamic Blocks}). This is useful if -you have several clock table blocks, column-capturing blocks or -other dynamic blocks in a buffer. -@end table - -You can add formulas to the column view table and you may add plotting -instructions in front of the table---these survive an update of the -block. If there is a @samp{TBLFM} keyword after the table, the table is -recalculated automatically after an update. - -An alternative way to capture and process property values into a table -is provided by Eric Schulte's @samp{org-collector.el}, which is -a contributed package@footnote{Contributed packages are not part of Emacs, but are -distributed with the main distribution of Org---visit -@uref{https://orgmode.org}.}. It provides a general API to collect -properties from entries in a certain scope, and arbitrary Lisp -expressions to process these values before inserting them into a table -or a dynamic block. - -@node Dates and Times -@chapter Dates and Times - -@cindex dates -@cindex times -@cindex timestamp -@cindex date stamp - -To assist project planning, TODO items can be labeled with a date -and/or a time. The specially formatted string carrying the date and -time information is called a @emph{timestamp} in Org mode. This may be -a little confusing because timestamp is often used as indicating when -something was created or last changed. However, in Org mode this term -is used in a much wider sense. - -@menu -* Timestamps:: Assigning a time to a tree entry. -* Creating Timestamps:: Commands to insert timestamps. -* Deadlines and Scheduling:: Planning your work. -* Clocking Work Time:: Tracking how long you spend on a task. -* Effort Estimates:: Planning work effort in advance. -* Timers:: Notes with a running timer. -@end menu - -@node Timestamps -@section Timestamps - -@cindex timestamps -@cindex ranges, time -@cindex date stamps -@cindex deadlines -@cindex scheduling - -A timestamp is a specification of a date (possibly with a time or -a range of times) in a special format, either @samp{<2003-09-16 Tue>} or -@samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue 12:00-12:30>}@footnote{The Org date format is inspired by the standard ISO 8601 -date/time format. To use an alternative format, see @ref{Custom time format}. The day name is optional when you type the date yourself. -However, any date inserted or modified by Org adds that day name, for -reading convenience.}. -A timestamp can appear anywhere in the headline or body of an Org tree -entry. Its presence causes entries to be shown on specific dates in -the agenda (see @ref{Weekly/daily agenda}). We distinguish: - -@table @asis -@item Plain timestamp; Event; Appointment -@cindex timestamp -@cindex appointment -A simple timestamp just assigns a date/time to an item. This is -just like writing down an appointment or event in a paper agenda. -In the agenda display, the headline of an entry associated with -a plain timestamp is shown exactly on that date. - -@example -* Meet Peter at the movies - <2006-11-01 Wed 19:15> -* Discussion on climate change - <2006-11-02 Thu 20:00-22:00> -@end example - -@item Timestamp with repeater interval -@cindex timestamp, with repeater interval -A timestamp may contain a @emph{repeater interval}, indicating that it -applies not only on the given date, but again and again after -a certain interval of N days (d), weeks (w), months (m), or years -(y). The following shows up in the agenda every Wednesday: - -@example -* Pick up Sam at school - <2007-05-16 Wed 12:30 +1w> -@end example - -@item Diary-style expression entries -@cindex diary style timestamps -@cindex sexp timestamps -For more complex date specifications, Org mode supports using the -special expression diary entries implemented in the Emacs Calendar -package@footnote{When working with the standard diary expression functions, you -need to be very careful with the order of the arguments. That order -depends evilly on the variable @code{calendar-date-style}. For example, to -specify a date December 12, 2005, the call might look like -@samp{(diary-date 12 1 2005)} or @samp{(diary-date 1 12 2005)} or @samp{(diary-date -2005 12 1)}, depending on the settings. This has been the source of -much confusion. Org mode users can resort to special versions of -these functions like @code{org-date} or @code{org-anniversary}. These work just -like the corresponding @code{diary-} functions, but with stable ISO order -of arguments (year, month, day) wherever applicable, independent of -the value of @code{calendar-date-style}.}. For example, with optional time: - -@example -* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month - <%%(diary-float t 4 2)> -@end example - -@item Time/Date range -@cindex timerange -@cindex date range -Two timestamps connected by @samp{--} denote a range. The headline is -shown on the first and last day of the range, and on any dates that -are displayed and fall in the range. Here is an example: - -@example -** Meeting in Amsterdam - <2004-08-23 Mon>--<2004-08-26 Thu> -@end example - -@item Inactive timestamp -@cindex timestamp, inactive -@cindex inactive timestamp -Just like a plain timestamp, but with square brackets instead of -angular ones. These timestamps are inactive in the sense that they -do @emph{not} trigger an entry to show up in the agenda. - -@example -* Gillian comes late for the fifth time - [2006-11-01 Wed] -@end example -@end table - -@node Creating Timestamps -@section Creating Timestamps - -For Org mode to recognize timestamps, they need to be in the specific -format. All commands listed below produce timestamps in the correct -format. - -@table @asis -@item @kbd{C-c .} (@code{org-time-stamp}) -@kindex C-c . -@findex org-time-stamp -Prompt for a date and insert a corresponding timestamp. When point -is at an existing timestamp in the buffer, the command is used to -modify this timestamp instead of inserting a new one. When this -command is used twice in succession, a time range is inserted. - -@kindex C-u C-c . -@vindex org-time-stamp-rounding-minutes -When called with a prefix argument, use the alternative format which -contains date and time. The default time can be rounded to -multiples of 5 minutes. See the option -@code{org-time-stamp-rounding-minutes}. - -@kindex C-u C-u C-c . -With two prefix arguments, insert an active timestamp with the -current time without prompting. - -@item @kbd{C-c !} (@code{org-time-stamp-inactive}) -@kindex C-c ! -@kindex C-u C-c ! -@kindex C-u C-u C-c ! -@findex org-time-stamp-inactive -Like @kbd{C-c .}, but insert an inactive timestamp that does -not cause an agenda entry. - -@item @kbd{C-c C-c} -@kindex C-c C-c -Normalize timestamp, insert or fix day name if missing or wrong. - -@item @kbd{C-c <} (@code{org-date-from-calendar}) -@kindex C-c < -@findex org-date-from-calendar -Insert a timestamp corresponding to point date in the calendar. - -@item @kbd{C-c >} (@code{org-goto-calendar}) -@kindex C-c > -@findex org-goto-calendar -Access the Emacs calendar for the current date. If there is -a timestamp in the current line, go to the corresponding date -instead. - -@item @kbd{C-c C-o} (@code{org-open-at-point}) -@kindex C-c C-o -@findex org-open-at-point -Access the agenda for the date given by the timestamp or -range at -point (see @ref{Weekly/daily agenda}). - -@item @kbd{S-@key{LEFT}} (@code{org-timestamp-down-day}) -@itemx @kbd{S-@key{RIGHT}} (@code{org-timestamp-up-day}) -@kindex S-LEFT -@kindex S-RIGHT -@findex org-timestamp-down-day -@findex org-timestamp-up-day -Change date at point by one day. These key bindings conflict with -shift-selection and related modes (see @ref{Conflicts}). - -@item @kbd{S-@key{UP}} (@code{org-timestamp-up}) -@itemx @kbd{S-@key{DOWN}} (@code{org-timestamp-down}) -@kindex S-UP -@kindex S-DOWN -On the beginning or enclosing bracket of a timestamp, change its -type. Within a timestamp, change the item under point. Point can -be on a year, month, day, hour or minute. When the timestamp -contains a time range like @samp{15:30-16:30}, modifying the first time -also shifts the second, shifting the time block with constant -length. To change the length, modify the second time. Note that if -point is in a headline and not at a timestamp, these same keys -modify the priority of an item (see @ref{Priorities}). The key bindings -also conflict with shift-selection and related modes (see @ref{Conflicts}). - -@item @kbd{C-c C-y} (@code{org-evaluate-time-range}) -@kindex C-c C-y -@findex org-evaluate-time-range -@cindex evaluate time range -Evaluate a time range by computing the difference between start and -end. With a prefix argument, insert result after the time range (in -a table: into the following column). -@end table - -@menu -* The date/time prompt:: How Org mode helps you enter dates and times. -* Custom time format:: Making dates look different. -@end menu - -@node The date/time prompt -@subsection The date/time prompt - -@cindex date, reading in minibuffer -@cindex time, reading in minibuffer - -@vindex org-read-date-prefer-future -When Org mode prompts for a date/time, the default is shown in default -date/time format, and the prompt therefore seems to ask for a specific -format. But it in fact accepts date/time information in a variety of -formats. Generally, the information should start at the beginning of -the string. Org mode finds whatever information is in there and -derives anything you have not specified from the @emph{default date and -time}. The default is usually the current date and time, but when -modifying an existing timestamp, or when entering the second stamp of -a range, it is taken from the stamp in the buffer. When filling in -information, Org mode assumes that most of the time you want to enter -a date in the future: if you omit the month/year and the given -day/month is @emph{before} today, it assumes that you mean a future -date@footnote{See the variable @code{org-read-date-prefer-future}. You may set -that variable to the symbol @code{time} to even make a time before now -shift the date to tomorrow.}. If the date has been automatically shifted into the -future, the time prompt shows this with @samp{(=>F)}. - -For example, let's assume that today is @strong{June 13, 2006}. Here is how -various inputs are interpreted, the items filled in by Org mode are in -@strong{bold}. - -@multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{3-2-5} -@tab @result{} 2003-02-05 -@item @samp{2/5/3} -@tab @result{} 2003-02-05 -@item @samp{14} -@tab @result{} @strong{2006}-@strong{06}-14 -@item @samp{12} -@tab @result{} @strong{2006}-@strong{07}-12 -@item @samp{2/5} -@tab @result{} @strong{2007}-02-05 -@item @samp{Fri} -@tab @result{} nearest Friday (default date or later) -@item @samp{sep 15} -@tab @result{} @strong{2006}-09-15 -@item @samp{feb 15} -@tab @result{} @strong{2007}-02-15 -@item @samp{sep 12 9} -@tab @result{} 2009-09-12 -@item @samp{12:45} -@tab @result{} @strong{2006}-@strong{06}-@strong{13} 12:45 -@item @samp{22 sept 0:34} -@tab @result{} @strong{2006}-09-22 0:34 -@item @samp{w4} -@tab @result{} ISO week for of the current year @strong{2006} -@item @samp{2012 w4 fri} -@tab @result{} Friday of ISO week 4 in 2012 -@item @samp{2012-w04-5} -@tab @result{} Same as above -@end multitable - -Furthermore you can specify a relative date by giving, as the @emph{first} -thing in the input: a plus/minus sign, a number and a letter---@samp{d}, -@samp{w}, @samp{m} or @samp{y}---to indicate change in days, weeks, months, or -years. With a single plus or minus, the date is always relative to -today. With a double plus or minus, it is relative to the default -date. If instead of a single letter, you use the abbreviation of day -name, the date is the Nth such day, e.g.: - -@multitable {aaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{+0} -@tab @result{} today -@item @samp{.} -@tab @result{} today -@item @samp{+4d} -@tab @result{} four days from today -@item @samp{+4} -@tab @result{} same as +4d -@item @samp{+2w} -@tab @result{} two weeks from today -@item @samp{++5} -@tab @result{} five days from default date -@item @samp{+2tue} -@tab @result{} second Tuesday from now -@end multitable - -@vindex parse-time-months -@vindex parse-time-weekdays -The function understands English month and weekday abbreviations. If -you want to use un-abbreviated names and/or other languages, configure -the variables @code{parse-time-months} and @code{parse-time-weekdays}. - -@vindex org-read-date-force-compatible-dates -Not all dates can be represented in a given Emacs implementation. By -default Org mode forces dates into the compatibility range 1970--2037 -which works on all Emacs implementations. If you want to use dates -outside of this range, read the docstring of the variable -@code{org-read-date-force-compatible-dates}. - -You can specify a time range by giving start and end times or by -giving a start time and a duration (in HH:MM format). Use one or two -dash(es) as the separator in the former case and use @samp{+} as the -separator in the latter case, e.g.: - -@multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaa} -@item @samp{11am-1:15pm} -@tab @result{} 11:00-13:15 -@item @samp{11am--1:15pm} -@tab @result{} same as above -@item @samp{11am+2:15} -@tab @result{} same as above -@end multitable - -@cindex calendar, for selecting date -@vindex org-popup-calendar-for-date-prompt -Parallel to the minibuffer prompt, a calendar is popped up@footnote{If you do not need/want the calendar, configure the variable -@code{org-popup-calendar-for-date-prompt}.}. -When you exit the date prompt, either by clicking on a date in the -calendar, or by pressing @kbd{@key{RET}}, the date selected in the -calendar is combined with the information entered at the prompt. You -can control the calendar fully from the minibuffer: - -@kindex < -@kindex > -@kindex M-v -@kindex C-v -@kindex mouse-1 -@kindex S-RIGHT -@kindex S-LEFT -@kindex S-DOWN -@kindex S-UP -@kindex M-S-RIGHT -@kindex M-S-LEFT -@kindex RET -@kindex . -@kindex C-. -@multitable @columnfractions 0.25 0.55 -@item @kbd{@key{RET}} -@tab Choose date at point in calendar. -@item @kbd{mouse-1} -@tab Select date by clicking on it. -@item @kbd{S-@key{RIGHT}} -@tab One day forward. -@item @kbd{S-@key{LEFT}} -@tab One day backward. -@item @kbd{S-@key{DOWN}} -@tab One week forward. -@item @kbd{S-@key{UP}} -@tab One week backward. -@item @kbd{M-S-@key{RIGHT}} -@tab One month forward. -@item @kbd{M-S-@key{LEFT}} -@tab One month backward. -@item @kbd{>} -@tab Scroll calendar forward by one month. -@item @kbd{<} -@tab Scroll calendar backward by one month. -@item @kbd{M-v} -@tab Scroll calendar forward by 3 months. -@item @kbd{C-v} -@tab Scroll calendar backward by 3 months. -@item @kbd{C-.} -@tab Select today's date@footnote{You can also use the calendar command @kbd{.} to jump to -today's date, but if you are inserting an hour specification for your -timestamp, @kbd{.} will then insert a dot after the hour. By contrast, -@kbd{C-.} will always jump to today's date.} -@end multitable - -@vindex org-read-date-display-live -The actions of the date/time prompt may seem complex, but I assure you -they will grow on you, and you will start getting annoyed by pretty -much any other way of entering a date/time out there. To help you -understand what is going on, the current interpretation of your input -is displayed live in the minibuffer@footnote{If you find this distracting, turn off the display with -@code{org-read-date-display-live}.}. - -@node Custom time format -@subsection Custom time format - -@cindex custom date/time format -@cindex time format, custom -@cindex date format, custom - -@vindex org-display-custom-times -@vindex org-time-stamp-custom-formats -Org mode uses the standard ISO notation for dates and times as it is -defined in ISO 8601. If you cannot get used to this and require -another representation of date and time to keep you happy, you can get -it by customizing the variables @code{org-display-custom-times} and -@code{org-time-stamp-custom-formats}. - -@table @asis -@item @kbd{C-c C-x C-t} (@code{org-toggle-time-stamp-overlays}) -@kindex C-c C-x C-t -@findex org-toggle-time-stamp-overlays -Toggle the display of custom formats for dates and times. -@end table - -Org mode needs the default format for scanning, so the custom -date/time format does not @emph{replace} the default format. Instead, it -is put @emph{over} the default format using text properties. This has the -following consequences: - -@itemize -@item -You cannot place point onto a timestamp anymore, only before or -after. - -@item -The @kbd{S-@key{UP}} and @kbd{S-@key{DOWN}} keys can no longer be used -to adjust each component of a timestamp. If point is at the -beginning of the stamp, @kbd{S-@key{UP}} and @kbd{S-@key{DOWN}} change -the stamp by one day, just like @kbd{S-@key{LEFT}} -@kbd{S-@key{RIGHT}}. At the end of the stamp, change the time by one -minute. - -@item -If the timestamp contains a range of clock times or a repeater, -these are not overlaid, but remain in the buffer as they were. - -@item -When you delete a timestamp character-by-character, it only -disappears from the buffer after @emph{all} (invisible) characters -belonging to the ISO timestamp have been removed. - -@item -If the custom timestamp format is longer than the default and you -are using dates in tables, table alignment will be messed up. If -the custom format is shorter, things do work as expected. -@end itemize - -@node Deadlines and Scheduling -@section Deadlines and Scheduling - -A timestamp may be preceded by special keywords to facilitate -planning. Both the timestamp and the keyword have to be positioned -immediately after the task they refer to. - -@table @asis -@item @samp{DEADLINE} -@cindex @samp{DEADLINE} marker -Meaning: the task---most likely a TODO item, though not -necessarily---is supposed to be finished on that date. - -@vindex org-deadline-warning-days -On the deadline date, the task is listed in the agenda. In -addition, the agenda for @emph{today} carries a warning about the -approaching or missed deadline, starting @code{org-deadline-warning-days} -before the due date, and continuing until the entry is marked as -done. An example: - -@example -*** TODO write article about the Earth for the Guide - DEADLINE: <2004-02-29 Sun> - The editor in charge is [[bbdb:Ford Prefect]] -@end example - -@vindex org-agenda-skip-deadline-prewarning-if-scheduled -You can specify a different lead time for warnings for a specific -deadlines using the following syntax. Here is an example with -a warning period of 5 days @samp{DEADLINE: <2004-02-29 Sun -5d>}. This -warning is deactivated if the task gets scheduled and you set -@code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}. - -@item @samp{SCHEDULED} -@cindex @samp{SCHEDULED} marker -Meaning: you are planning to start working on that task on the given -date. - -@vindex org-agenda-skip-scheduled-if-done -The headline is listed under the given date@footnote{It will still be listed on that date after it has been marked -as done. If you do not like this, set the variable -@code{org-agenda-skip-scheduled-if-done}.}. In addition, -a reminder that the scheduled date has passed is present in the -compilation for @emph{today}, until the entry is marked as done, i.e., -the task is automatically forwarded until completed. - -@example -*** TODO Call Trillian for a date on New Years Eve. - SCHEDULED: <2004-12-25 Sat> -@end example - -@vindex org-scheduled-delay-days -@vindex org-agenda-skip-scheduled-delay-if-deadline -If you want to @emph{delay} the display of this task in the agenda, use -@samp{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on -the 25th but will appear two days later. In case the task contains -a repeater, the delay is considered to affect all occurrences; if -you want the delay to only affect the first scheduled occurrence of -the task, use @samp{--2d} instead. See @code{org-scheduled-delay-days} and -@code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to -control this globally or per agenda. - -@quotation Important -Scheduling an item in Org mode should @emph{not} be understood in the -same way that we understand @emph{scheduling a meeting}. Setting a date -for a meeting is just a simple appointment, you should mark this -entry with a simple plain timestamp, to get this item shown on the -date where it applies. This is a frequent misunderstanding by Org -users. In Org mode, @emph{scheduling} means setting a date when you want -to start working on an action item. - -@end quotation -@end table - -You may use timestamps with repeaters in scheduling and deadline -entries. Org mode issues early and late warnings based on the -assumption that the timestamp represents the @emph{nearest instance} of the -repeater. However, the use of diary expression entries like - -@example -<%%(diary-float t 42)> -@end example - - -@noindent -in scheduling and deadline timestamps is limited. Org mode does not -know enough about the internals of each function to issue early and -late warnings. However, it shows the item on each day where the -expression entry matches. - -@menu -* Inserting deadline/schedule:: Planning items. -* Repeated tasks:: Items that show up again and again. -@end menu - -@node Inserting deadline/schedule -@subsection Inserting deadlines or schedules - -The following commands allow you to quickly insert a deadline or to -schedule an item:@footnote{The @samp{SCHEDULED} and @samp{DEADLINE} dates are inserted on the line -right below the headline. Do not put any text between this line and -the headline.} - -@table @asis -@item @kbd{C-c C-d} (@code{org-deadline}) -@kindex C-c C-d -@findex org-deadline -@vindex org-log-redeadline -Insert @samp{DEADLINE} keyword along with a stamp. The insertion happens -in the line directly following the headline. Remove any @samp{CLOSED} -timestamp . When called with a prefix argument, also remove any -existing deadline from the entry. Depending on the variable -@code{org-log-redeadline}, take a note when changing an existing -deadline@footnote{Note the corresponding @samp{STARTUP} options @samp{logredeadline}, -@samp{lognoteredeadline}, and @samp{nologredeadline}.}. - -@item @kbd{C-c C-s} (@code{org-schedule}) -@kindex C-c C-s -@findex org-schedule -@vindex org-log-reschedule -Insert @samp{SCHEDULED} keyword along with a stamp. The insertion -happens in the line directly following the headline. Remove any -@samp{CLOSED} timestamp. When called with a prefix argument, also remove -the scheduling date from the entry. Depending on the variable -@code{org-log-reschedule}, take a note when changing an existing -scheduling time@footnote{Note the corresponding @samp{STARTUP} options @samp{logreschedule}, -@samp{lognotereschedule}, and @samp{nologreschedule}.}. - -@item @kbd{C-c / d} (@code{org-check-deadlines}) -@kindex C-c / d -@findex org-check-deadlines -@cindex sparse tree, for deadlines -@vindex org-deadline-warning-days -Create a sparse tree with all deadlines that are either past-due, or -which will become due within @code{org-deadline-warning-days}. With -@kbd{C-u} prefix, show all deadlines in the file. With -a numeric prefix, check that many days. For example, @kbd{C-1 C-c / d} shows all deadlines due tomorrow. - -@item @kbd{C-c / b} (@code{org-check-before-date}) -@kindex C-c / b -@findex org-check-before-date -Sparse tree for deadlines and scheduled items before a given date. - -@item @kbd{C-c / a} (@code{org-check-after-date}) -@kindex C-c / a -@findex org-check-after-date -Sparse tree for deadlines and scheduled items after a given date. -@end table - -Note that @code{org-schedule} and @code{org-deadline} supports setting the date -by indicating a relative time e.g., @samp{+1d} sets the date to the next -day after today, and @samp{--1w} sets the date to the previous week before -any current timestamp. - -@node Repeated tasks -@subsection Repeated tasks - -@cindex tasks, repeated -@cindex repeated tasks - -Some tasks need to be repeated again and again. Org mode helps to -organize such tasks using a so-called repeater in a @samp{DEADLINE}, -@samp{SCHEDULED}, or plain timestamps@footnote{Org does not repeat inactive timestamps, however. See -@ref{Timestamps}.}. In the following example: - -@example -** TODO Pay the rent - DEADLINE: <2005-10-01 Sat +1m> -@end example - -@noindent -the @samp{+1m} is a repeater; the intended interpretation is that the task -has a deadline on @samp{<2005-10-01>} and repeats itself every (one) month -starting from that time. You can use yearly, monthly, weekly, daily -and hourly repeat cookies by using the @samp{y}, @samp{m}, @samp{w}, @samp{d} and @samp{h} -letters. If you need both a repeater and a special warning period in -a deadline entry, the repeater should come first and the warning -period last - -@example -DEADLINE: <2005-10-01 Sat +1m -3d> -@end example - - -@vindex org-todo-repeat-to-state -Deadlines and scheduled items produce entries in the agenda when they -are over-due, so it is important to be able to mark such an entry as -done once you have done so. When you mark a @samp{DEADLINE} or -a @samp{SCHEDULED} with the TODO keyword @samp{DONE}, it no longer produces -entries in the agenda. The problem with this is, however, is that -then also the @emph{next} instance of the repeated entry will not be -active. Org mode deals with this in the following way: when you try -to mark such an entry as done, using @kbd{C-c C-t}, it shifts the -base date of the repeating timestamp by the repeater interval, and -immediately sets the entry state back to TODO@footnote{In fact, the target state is taken from, in this sequence, the -@samp{REPEAT_TO_STATE} property, the variable @code{org-todo-repeat-to-state} if -it is a string, the previous TODO state if @code{org-todo-repeat-to-state} -is @code{t}, or the first state of the TODO state sequence.}. In the example -above, setting the state to @samp{DONE} would actually switch the date like -this: - -@example -** TODO Pay the rent - DEADLINE: <2005-11-01 Tue +1m> -@end example - -To mark a task with a repeater as DONE, use @kbd{C-- 1 C-c C-t}, -i.e., @code{org-todo} with a numeric prefix argument of @samp{-1}. - -@vindex org-log-repeat -A timestamp@footnote{You can change this using the option @code{org-log-repeat}, or the -@samp{STARTUP} options @samp{logrepeat}, @samp{lognoterepeat}, and @samp{nologrepeat}. -With @samp{lognoterepeat}, you will also be prompted for a note.} is added under the deadline, to keep a record that -you actually acted on the previous instance of this deadline. - -As a consequence of shifting the base date, this entry is no longer -visible in the agenda when checking past dates, but all future -instances will be visible. - -With the @samp{+1m} cookie, the date shift is always exactly one month. So -if you have not paid the rent for three months, marking this entry -DONE still keeps it as an overdue deadline. Depending on the task, -this may not be the best way to handle it. For example, if you forgot -to call your father for 3 weeks, it does not make sense to call him -3 times in a single day to make up for it. Finally, there are tasks, -like changing batteries, which should always repeat a certain time -@emph{after} the last time you did it. For these tasks, Org mode has -special repeaters @samp{++} and @samp{.+}. For example: - -@example -** TODO Call Father - DEADLINE: <2008-02-10 Sun ++1w> - Marking this DONE shifts the date by at least one week, but also - by as many weeks as it takes to get this date into the future. - However, it stays on a Sunday, even if you called and marked it - done on Saturday. - -** TODO Empty kitchen trash - DEADLINE: <2008-02-08 Fri 20:00 ++1d> - Marking this DONE shifts the date by at least one day, and also - by as many days as it takes to get the timestamp into the future. - Since there is a time in the timestamp, the next deadline in the - future will be on today's date if you complete the task before - 20:00. - -** TODO Check the batteries in the smoke detectors - DEADLINE: <2005-11-01 Tue .+1m> - Marking this DONE shifts the date to one month after today. - -** TODO Wash my hands - DEADLINE: <2019-04-05 08:00 Sun .+1h> - Marking this DONE shifts the date to exactly one hour from now. -@end example - -@vindex org-agenda-skip-scheduled-if-deadline-is-shown -You may have both scheduling and deadline information for a specific -task. If the repeater is set for the scheduling information only, you -probably want the repeater to be ignored after the deadline. If so, -set the variable @code{org-agenda-skip-scheduled-if-deadline-is-shown} to -@code{repeated-after-deadline}. However, any scheduling information -without a repeater is no longer relevant once the task is done, and -thus, removed upon repeating the task. If you want both scheduling -and deadline information to repeat after the same interval, set the -same repeater for both timestamps. - -An alternative to using a repeater is to create a number of copies of -a task subtree, with dates shifted in each copy. The command -@kbd{C-c C-x c} was created for this purpose; it is described in -@ref{Structure Editing}. - -@node Clocking Work Time -@section Clocking Work Time - -@cindex clocking time -@cindex time clocking - -Org mode allows you to clock the time you spend on specific tasks in -a project. When you start working on an item, you can start the -clock. When you stop working on that task, or when you mark the task -done, the clock is stopped and the corresponding time interval is -recorded. It also computes the total time spent on each -subtree@footnote{Clocking only works if all headings are indented with less -than 30 stars. This is a hard-coded limitation of @code{lmax} in -@code{org-clock-sum}.} of a project. And it remembers a history or tasks -recently clocked, so that you can jump quickly between a number of -tasks absorbing your time. - -To save the clock history across Emacs sessions, use: - -@lisp -(setq org-clock-persist 'history) -(org-clock-persistence-insinuate) -@end lisp - -@vindex org-clock-persist -When you clock into a new task after resuming Emacs, the incomplete -clock@footnote{To resume the clock under the assumption that you have worked -on this task while outside Emacs, use @samp{(setq org-clock-persist t)}.} is retrieved (see @ref{Resolving idle time (1)}) and you are -prompted about what to do with it. - -@menu -* Clocking commands:: Starting and stopping a clock. -* The clock table:: Detailed reports. -* Resolving idle time:: Resolving time when you've been idle. -@end menu - -@node Clocking commands -@subsection Clocking commands - -@table @asis -@item @kbd{C-c C-x C-i} (@code{org-clock-in}) -@kindex C-c C-x C-i -@findex org-clock-in -@vindex org-clock-into-drawer -@vindex org-clock-continuously -@cindex @samp{LOG_INTO_DRAWER}, property -Start the clock on the current item (clock-in). This inserts the -@samp{CLOCK} keyword together with a timestamp. If this is not the first -clocking of this item, the multiple @samp{CLOCK} lines are wrapped into -a @samp{LOGBOOK} drawer (see also the variable @code{org-clock-into-drawer}). -You can also overrule the setting of this variable for a subtree by -setting a @samp{CLOCK_INTO_DRAWER} or @samp{LOG_INTO_DRAWER} property. When -called with a @kbd{C-u} prefix argument, select the task from -a list of recently clocked tasks. With two @kbd{C-u C-u} -prefixes, clock into the task at point and mark it as the default -task; the default task is always be available with letter -@kbd{d} when selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force continuous clocking by starting the -clock when the last clock stopped. - -@cindex @samp{CLOCK_MODELINE_TOTAL}, property -@cindex @samp{LAST_REPEAT}, property -@vindex org-clock-mode-line-total -@vindex org-clock-in-prepare-hook -While the clock is running, Org shows the current clocking time in -the mode line, along with the title of the task. The clock time -shown is all time ever clocked for this task and its children. If -the task has an effort estimate (see @ref{Effort Estimates}), the mode -line displays the current clocking time against it@footnote{To add an effort estimate ``on the fly'', hook a function doing -this to @code{org-clock-in-prepare-hook}.}. If the -task is a repeating one (see @ref{Repeated tasks}), show only the time -since the last reset of the task@footnote{The last reset of the task is recorded by the @samp{LAST_REPEAT} -property.}. You can exercise more -control over show time with the @samp{CLOCK_MODELINE_TOTAL} property. It -may have the values @samp{current} to show only the current clocking -instance, @samp{today} to show all time clocked on this tasks today---see -also the variable @code{org-extend-today-until}, @code{all} to include all -time, or @code{auto} which is the default@footnote{See also the variable @code{org-clock-mode-line-total}.}. Clicking with -@kbd{mouse-1} onto the mode line entry pops up a menu with -clocking options. - -@item @kbd{C-c C-x C-o} (@code{org-clock-out}) -@kindex C-c C-x C-o -@findex org-clock-out -@vindex org-log-note-clock-out -Stop the clock (clock-out). This inserts another timestamp at the -same location where the clock was last started. It also directly -computes the resulting time in inserts it after the time range as -@samp{=>HH:MM}. See the variable @code{org-log-note-clock-out} for the -possibility to record an additional note together with the clock-out -timestamp@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: -lognoteclock-out}.}. - -@item @kbd{C-c C-x C-x} (@code{org-clock-in-last}) -@kindex C-c C-x C-x -@findex org-clock-in-last -@vindex org-clock-continuously -Re-clock the last clocked task. With one @kbd{C-u} prefix -argument, select the task from the clock history. With two -@kbd{C-u} prefixes, force continuous clocking by starting the -clock when the last clock stopped. - -@item @kbd{C-c C-x C-e} (@code{org-clock-modify-effort-estimate}) -@kindex C-c C-x C-e -@findex org-clock-modify-effort-estimate -Update the effort estimate for the current clock task. - -@item @kbd{C-c C-c} or @kbd{C-c C-y} (@code{org-evaluate-time-range}) -@kindex C-c C-c -@kindex C-c C-y -@findex org-evaluate-time-range -Recompute the time interval after changing one of the timestamps. -This is only necessary if you edit the timestamps directly. If you -change them with @kbd{S-<cursor>} keys, the update is -automatic. - -@item @kbd{C-S-@key{UP}} (@code{org-clock-timestamps-up}) -@itemx @kbd{C-S-@key{DOWN}} (@code{org-clock-timestamps-down}) -@kindex C-S-UP -@findex org-clock-timestamps-up -@kindex C-S-DOWN -@findex org-clock-timestamps-down -On CLOCK log lines, increase/decrease both timestamps so that the -clock duration keeps the same value. - -@item @kbd{S-M-@key{UP}} (@code{org-timestamp-up}) -@itemx @kbd{S-M-@key{DOWN}} (@code{org-timestamp-down}) -@kindex S-M-UP -@findex org-clock-timestamp-up -@kindex S-M-DOWN -@findex org-clock-timestamp-down -On @samp{CLOCK} log lines, increase/decrease the timestamp at point and -the one of the previous, or the next, clock timestamp by the same -duration. For example, if you hit @kbd{S-M-@key{UP}} to increase -a clocked-out timestamp by five minutes, then the clocked-in -timestamp of the next clock is increased by five minutes. - -@item @kbd{C-c C-t} (@code{org-todo}) -@kindex C-c C-t -@findex org-todo -Changing the TODO state of an item to DONE automatically stops the -clock if it is running in this same item. - -@item @kbd{C-c C-x C-q} (@code{org-clock-cancel}) -@kindex C-c C-x C-q -@findex org-clock-cancel -Cancel the current clock. This is useful if a clock was started by -mistake, or if you ended up working on something else. - -@item @kbd{C-c C-x C-j} (@code{org-clock-goto}) -@kindex C-c C-x C-j -@findex or-clock-goto -Jump to the headline of the currently clocked in task. With -a @kbd{C-u} prefix argument, select the target task from a list -of recently clocked tasks. - -@item @kbd{C-c C-x C-d} (@code{org-clock-display}) -@kindex C-c C-x C-d -@findex org-clock-display -@vindex org-remove-highlights-with-change -Display time summaries for each subtree in the current buffer. This -puts overlays at the end of each headline, showing the total time -recorded under that heading, including the time of any subheadings. -You can use visibility cycling to study the tree, but the overlays -disappear when you change the buffer (see variable -@code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. -@end table - -The @kbd{l} key may be used in the agenda (see @ref{Weekly/daily agenda}) to show which tasks have been worked on or closed during -a day. - -@strong{Important:} note that both @code{org-clock-out} and @code{org-clock-in-last} -can have a global keybinding and do not modify the window disposition. - -@node The clock table -@subsection The clock table - -@cindex clocktable, dynamic block -@cindex report, of clocked time - -Org mode can produce quite complex reports based on the time clocking -information. Such a report is called a @emph{clock table}, because it is -formatted as one or several Org tables. - -@table @asis -@item @code{org-clock-report} -@kindex C-c C-x x -@findex org-clock-report -Insert or update a clock table. When called with a prefix argument, -jump to the first clock table in the current document and update it. -The clock table includes archived trees. - -This command can be invoked by calling -@code{org-dynamic-block-insert-dblock} (@kbd{C-c C-x x}) and -selecting ``clocktable'' (see @ref{Dynamic Blocks}). - -@item @kbd{C-c C-c} or @kbd{C-c C-x C-u} (@code{org-dblock-update}) -@kindex C-c C-c -@kindex C-c C-x C-u -@findex org-dblock-update -Update dynamic block at point. Point needs to be in the @samp{BEGIN} -line of the dynamic block. - -@item @kbd{C-u C-c C-x C-u} -@kindex C-u C-c C-x C-u -Update all dynamic blocks (see @ref{Dynamic Blocks}). This is useful if -you have several clock table blocks in a buffer. - -@item @kbd{S-@key{LEFT}} -@itemx @kbd{S-@key{RIGHT}} (@code{org-clocktable-try-shift}) -@kindex S-LEFT -@kindex S-RIGHT -@findex org-clocktable-try-shift -Shift the current @samp{:block} interval and update the table. Point -needs to be in the @samp{#+BEGIN: clocktable} line for this command. If -@samp{:block} is @samp{today}, it is shifted to @samp{today-1}, etc. -@end table - -Here is an example of the frame for a clock table as it is inserted -into the buffer by @code{org-clock-report}: - -@cindex @samp{BEGIN clocktable} -@example -#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file -#+END: clocktable -@end example - -@vindex org-clocktable-defaults -The @samp{#+BEGIN} line contains options to define the scope, structure, -and formatting of the report. Defaults for all these options can be -configured in the variable @code{org-clocktable-defaults}. - -First there are options that determine which clock entries are to -be selected: - -@table @asis -@item @samp{:maxlevel} -Maximum level depth to which times are listed in the table. Clocks -at deeper levels are summed into the upper level. - -@item @samp{:scope} -The scope to consider. This can be any of the following: - -@multitable {aaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{nil} -@tab the current buffer or narrowed region -@item @samp{file} -@tab the full current buffer -@item @samp{subtree} -@tab the subtree where the clocktable is located -@item @samp{treeN} -@tab the surrounding level N tree, for example @samp{tree3} -@item @samp{tree} -@tab the surrounding level 1 tree -@item @samp{agenda} -@tab all agenda files -@item @samp{("file" ...)} -@tab scan these files -@item @samp{FUNCTION} -@tab scan files returned by calling @var{FUNCTION} with no argument -@item @samp{file-with-archives} -@tab current file and its archives -@item @samp{agenda-with-archives} -@tab all agenda files, including archives -@end multitable - -@item @samp{:block} -The time block to consider. This block is specified either -absolutely, or relative to the current time and may be any of these -formats: - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaa} -@item @samp{2007-12-31} -@tab New year eve 2007 -@item @samp{2007-12} -@tab December 2007 -@item @samp{2007-W50} -@tab ISO-week 50 in 2007 -@item @samp{2007-Q2} -@tab 2nd quarter in 2007 -@item @samp{2007} -@tab the year 2007 -@item @samp{today}, @samp{yesterday}, @samp{today-N} -@tab a relative day -@item @samp{thisweek}, @samp{lastweek}, @samp{thisweek-N} -@tab a relative week -@item @samp{thismonth}, @samp{lastmonth}, @samp{thismonth-N} -@tab a relative month -@item @samp{thisyear}, @samp{lastyear}, @samp{thisyear-N} -@tab a relative year -@item @samp{untilnow}@footnote{When using @code{:step}, @code{untilnow} starts from the beginning of -2003, not the beginning of time.} -@tab all clocked time ever -@end multitable - -@vindex org-clock-display-default-range -When this option is not set, Org falls back to the value in -@code{org-clock-display-default-range}, which defaults to the current -year. - -Use @kbd{S-@key{LEFT}} or @kbd{S-@key{RIGHT}} to shift the time -interval. - -@item @samp{:tstart} -A time string specifying when to start considering times. Relative -times like @samp{"<-2w>"} can also be used. See @ref{Matching tags and properties} for relative time syntax. - -@item @samp{:tend} -A time string specifying when to stop considering times. Relative -times like @samp{"<now>"} can also be used. See @ref{Matching tags and properties} for relative time syntax. - -@item @samp{:wstart} -The starting day of the week. The default is 1 for Monday. - -@item @samp{:mstart} -The starting day of the month. The default is 1 for the first. - -@item @samp{:step} -Set to @samp{day}, @samp{week}, @samp{semimonth}, @samp{month}, or @samp{year} to split the -table into chunks. To use this, either @samp{:block}, or @samp{:tstart} and -@samp{:tend} are required. - -@item @samp{:stepskip0} -When non-@code{nil}, do not show steps that have zero time. - -@item @samp{:fileskip0} -When non-@code{nil}, do not show table sections from files which did not -contribute. - -@item @samp{:match} -A tags match to select entries that should contribute. See -@ref{Matching tags and properties} for the match syntax. -@end table - -@findex org-clocktable-write-default -Then there are options that determine the formatting of the table. -There options are interpreted by the function -@code{org-clocktable-write-default}, but you can specify your own function -using the @samp{:formatter} parameter. - -@table @asis -@item @samp{:emphasize} -When non-@code{nil}, emphasize level one and level two items. - -@item @samp{:lang} -Language@footnote{Language terms can be set through the variable -@code{org-clock-clocktable-language-setup}.} to use for descriptive cells like ``Task''. - -@item @samp{:link} -Link the item headlines in the table to their origins. - -@item @samp{:narrow} -An integer to limit the width of the headline column in the Org -table. If you write it like @samp{50!}, then the headline is also -shortened in export. - -@item @samp{:indent} -Indent each headline field according to its level. - -@item @samp{:hidefiles} -Hide the file column when multiple files are used to produce the -table. - -@item @samp{:tcolumns} -Number of columns to be used for times. If this is smaller than -@samp{:maxlevel}, lower levels are lumped into one column. - -@item @samp{:level} -Should a level number column be included? - -@item @samp{:sort} -A cons cell containing the column to sort and a sorting type. E.g., -@samp{:sort (1 . ?a)} sorts the first column alphabetically. - -@item @samp{:compact} -Abbreviation for @samp{:level nil :indent t :narrow 40! :tcolumns 1}. -All are overwritten except if there is an explicit @samp{:narrow}. - -@item @samp{:timestamp} -A timestamp for the entry, when available. Look for @samp{SCHEDULED}, -@samp{DEADLINE}, @samp{TIMESTAMP} and @samp{TIMESTAMP_IA} special properties (see -@ref{Special Properties}), in this order. - -@item @samp{:tags} -When this flag is non-@code{nil}, show the headline's tags. - -@item @samp{:properties} -List of properties shown in the table. Each property gets its own -column. - -@item @samp{:inherit-props} -When this flag is non-@code{nil}, the values for @samp{:properties} are -inherited. - -@item @samp{:formula} -Content of a @samp{TBLFM} keyword to be added and evaluated. As -a special case, @samp{:formula %} adds a column with % time. If you do -not specify a formula here, any existing formula below the clock -table survives updates and is evaluated. - -@item @samp{:formatter} -A function to format clock data and insert it into the buffer. -@end table - -To get a clock summary of the current level 1 tree, for the current -day, you could write: - -@example -#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t -#+END: clocktable -@end example - -@noindent -To use a specific time range you could write@footnote{Note that all parameters must be specified in a single -line---the line is broken here only to fit it into the manual.} - -@example -#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" - :tend "<2006-08-10 Thu 12:00>" -#+END: clocktable -@end example - -@noindent -A range starting a week ago and ending right now could be written as - -@example -#+BEGIN: clocktable :tstart "<-1w>" :tend "<now>" -#+END: clocktable -@end example - -@noindent -A summary of the current subtree with % times would be - -@example -#+BEGIN: clocktable :scope subtree :link t :formula % -#+END: clocktable -@end example - -@noindent -A horizontally compact representation of everything clocked during -last week would be - -@example -#+BEGIN: clocktable :scope agenda :block lastweek :compact t -#+END: clocktable -@end example - -@node Resolving idle time -@subsection Resolving idle time and continuous clocking - - - -@anchor{Resolving idle time (1)} -@subsubheading Resolving idle time - -@cindex resolve idle time -@cindex idle, resolve, dangling - -If you clock in on a work item, and then walk away from your -computer---perhaps to take a phone call---you often need to -``resolve'' the time you were away by either subtracting it from the -current clock, or applying it to another one. - -@vindex org-clock-idle-time -@vindex org-clock-x11idle-program-name -By customizing the variable @code{org-clock-idle-time} to some integer, -such as 10 or 15, Emacs can alert you when you get back to your -computer after being idle for that many minutes@footnote{On computers using macOS, idleness is based on actual user -idleness, not just Emacs' idle time. For X11, you can install -a utility program @samp{x11idle.c}, available in the @samp{contrib/scripts/} -directory of the Org Git distribution, or install the xprintidle -package and set it to the variable @code{org-clock-x11idle-program-name} if -you are running Debian, to get the same general treatment of idleness. -On other systems, idle time refers to Emacs idle time only.}, and ask what -you want to do with the idle time. There will be a question waiting -for you when you get back, indicating how much idle time has passed -constantly updated with the current amount, as well as a set of -choices to correct the discrepancy: - -@table @asis -@item @kbd{k} -@kindex k -To keep some or all of the minutes and stay clocked in, press -@kbd{k}. Org asks how many of the minutes to keep. Press -@kbd{@key{RET}} to keep them all, effectively changing nothing, or -enter a number to keep that many minutes. - -@item @kbd{K} -@kindex K -If you use the shift key and press @kbd{K}, it keeps however -many minutes you request and then immediately clock out of that -task. If you keep all of the minutes, this is the same as just -clocking out of the current task. - -@item @kbd{s} -@kindex s -To keep none of the minutes, use @kbd{s} to subtract all the -away time from the clock, and then check back in from the moment you -returned. - -@item @kbd{S} -@kindex S -To keep none of the minutes and just clock out at the start of the -away time, use the shift key and press @kbd{S}. Remember that -using shift always leave you clocked out, no matter which option you -choose. - -@item @kbd{C} -@kindex C -To cancel the clock altogether, use @kbd{C}. Note that if -instead of canceling you subtract the away time, and the resulting -clock amount is less than a minute, the clock is still canceled -rather than cluttering up the log with an empty entry. -@end table - -What if you subtracted those away minutes from the current clock, and -now want to apply them to a new clock? Simply clock in to any task -immediately after the subtraction. Org will notice that you have -subtracted time ``on the books'', so to speak, and will ask if you want -to apply those minutes to the next task you clock in on. - -There is one other instance when this clock resolution magic occurs. -Say you were clocked in and hacking away, and suddenly your cat chased -a mouse who scared a hamster that crashed into your UPS's power -button! You suddenly lose all your buffers, but thanks to auto-save -you still have your recent Org mode changes, including your last clock -in. - -If you restart Emacs and clock into any task, Org will notice that you -have a dangling clock which was never clocked out from your last -session. Using that clock's starting time as the beginning of the -unaccounted-for period, Org will ask how you want to resolve that -time. The logic and behavior is identical to dealing with away time -due to idleness; it is just happening due to a recovery event rather -than a set amount of idle time. - -You can also check all the files visited by your Org agenda for -dangling clocks at any time using @kbd{M-x org-resolve-clocks @key{RET}} (or @kbd{C-c C-x C-z}). - -@anchor{Continuous clocking} -@subsubheading Continuous clocking - -@cindex continuous clocking - -@vindex org-clock-continuously -You may want to start clocking from the time when you clocked out the -previous task. To enable this systematically, set -@code{org-clock-continuously} to non-@code{nil}. Each time you clock in, Org -retrieves the clock-out time of the last clocked entry for this -session, and start the new clock from there. - -If you only want this from time to time, use three universal prefix -arguments with @code{org-clock-in} and two @kbd{C-u C-u} with -@code{org-clock-in-last}. - -@anchor{Clocking out automatically after some idle time} -@subsubheading Clocking out automatically after some idle time - -@cindex auto clocking out after idle time - -@vindex org-clock-auto-clockout-timer -When you often forget to clock out before being idle and you don't -want to manually set the clocking time to take into account, you can -set @code{org-clock-auto-clockout-timer} to a number of seconds and add -@samp{(org-clock-auto-clockout-insinuate)} to your @samp{.emacs} file. - -When the clock is running and Emacs is idle for more than this number -of seconds, the clock will be clocked out automatically. - -Use @samp{M-x org-clock-toggle-auto-clockout RET} to temporarily turn this -on or off. - -@node Effort Estimates -@section Effort Estimates - -@cindex effort estimates -@cindex @samp{EFFORT}, property -@vindex org-effort-property - -If you want to plan your work in a very detailed way, or if you need -to produce offers with quotations of the estimated work effort, you -may want to assign effort estimates to entries. If you are also -clocking your work, you may later want to compare the planned effort -with the actual working time, a great way to improve planning -estimates. - -Effort estimates are stored in a special property @samp{EFFORT}. Multiple -formats are supported, such as @samp{3:12}, @samp{1:23:45}, or @samp{1d3h5min}; see -the file @samp{org-duration.el} for more detailed information about the -format. - -You can set the effort for an entry with the following commands: - -@table @asis -@item @kbd{C-c C-x e} (@code{org-set-effort}) -@kindex C-c C-x e -@findex org-set-effort -Set the effort estimate for the current entry. With a prefix -argument, set it to the next allowed value---see below. This -command is also accessible from the agenda with the @kbd{e} -key. - -@item @kbd{C-c C-x C-e} (@code{org-clock-modify-effort-estimate}) -@kindex C-c C-x C-e -@findex org-clock-modify-effort-estimate -Modify the effort estimate of the item currently being clocked. -@end table - -Clearly the best way to work with effort estimates is through column -view (see @ref{Column View}). You should start by setting up discrete -values for effort estimates, and a @samp{COLUMNS} format that displays -these values together with clock sums---if you want to clock your -time. For a specific buffer you can use: - -@example -#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 -#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM -@end example - -@noindent -@vindex org-global-properties -@vindex org-columns-default-format -or, even better, you can set up these values globally by customizing -the variables @code{org-global-properties} and -@code{org-columns-default-format}. In particular if you want to use this -setup also in the agenda, a global setup may be advised. - -The way to assign estimates to individual items is then to switch to -column mode, and to use @kbd{S-@key{RIGHT}} and @kbd{S-@key{LEFT}} to -change the value. The values you enter are immediately summed up in -the hierarchy. In the column next to it, any clocked time is -displayed. - -@vindex org-agenda-columns-add-appointments-to-effort-sum -If you switch to column view in the daily/weekly agenda, the effort -column summarizes the estimated work effort for each day@footnote{Please note the pitfalls of summing hierarchical data in -a flat list (see @ref{Agenda Column View}).}, and -you can use this to find space in your schedule. To get an overview -of the entire part of the day that is committed, you can set the -option @code{org-agenda-columns-add-appointments-to-effort-sum}. The -appointments on a day that take place over a specified time interval -are then also added to the load estimate of the day. - -Effort estimates can be used in secondary agenda filtering that is -triggered with the @kbd{/} key in the agenda (see @ref{Agenda Commands}). If you have these estimates defined consistently, -two or three key presses narrow down the list to stuff that fits into -an available time slot. - -@node Timers -@section Taking Notes with a Relative Timer - -@cindex relative timer -@cindex countdown timer - -Org provides two types of timers. There is a relative timer that -counts up, which can be useful when taking notes during, for example, -a meeting or a video viewing. There is also a countdown timer. - -The relative and countdown are started with separate commands. - -@table @asis -@item @kbd{C-c C-x 0} (@code{org-timer-start}) -@kindex C-c C-x 0 -@findex org-timer-start -Start or reset the relative timer. By default, the timer is set -to 0. When called with a @kbd{C-u} prefix, prompt the user for -a starting offset. If there is a timer string at point, this is -taken as the default, providing a convenient way to restart taking -notes after a break in the process. When called with a double -prefix argument @kbd{C-u C-u}, change all timer strings in the -active region by a certain amount. This can be used to fix timer -strings if the timer was not started at exactly the right moment. - -@item @kbd{C-c C-x ;} (@code{org-timer-set-timer}) -@kindex C-c C-x ; -@findex org-timer-set-timer -@vindex org-timer-default-timer -Start a countdown timer. The user is prompted for a duration. -@code{org-timer-default-timer} sets the default countdown value. Giving -a numeric prefix argument overrides this default value. This -command is available as @kbd{;} in agenda buffers. -@end table - -Once started, relative and countdown timers are controlled with the -same commands. - -@table @asis -@item @kbd{C-c C-x .} (@code{org-timer}) -@kindex C-c C-x . -@findex org-timer -Insert a relative time into the buffer. The first time you use -this, the timer starts. Using a prefix argument restarts it. - -@item @kbd{C-c C-x -} (@code{org-timer-item}) -@kindex C-c C-x - -@findex org-timer-item -Insert a description list item with the current relative time. With -a prefix argument, first reset the timer to 0. - -@item @kbd{M-@key{RET}} (@code{org-insert-heading}) -@kindex M-RET -@findex org-insert-heading -Once the timer list is started, you can also use @kbd{M-@key{RET}} to -insert new timer items. - -@item @kbd{C-c C-x ,} (@code{org-timer-pause-or-continue}) -@kindex C-c C-x , -@findex org-timer-pause-or-continue -Pause the timer, or continue it if it is already paused. - -@item @kbd{C-c C-x _} (@code{org-timer-stop}) -@kindex C-c C-x _ -@findex org-timer-stop -Stop the timer. After this, you can only start a new timer, not -continue the old one. This command also removes the timer from the -mode line. -@end table - -@node Refiling and Archiving -@chapter Refiling and Archiving - -@cindex refiling notes -@cindex copying notes -@cindex archiving - -Once information is in the system, it may need to be moved around. -Org provides Refile, Copy and Archive commands for this. Refile and -Copy helps with moving and copying outlines. Archiving helps to keep -the system compact and fast. - -@menu -* Refile and Copy:: Moving/copying a tree from one place to another. -* Archiving:: What to do with finished products. -@end menu - -@node Refile and Copy -@section Refile and Copy - -@cindex refiling notes -@cindex copying notes - -When reviewing the captured data, you may want to refile or to copy -some of the entries into a different list, for example into a project. -Cutting, finding the right location, and then pasting the note is -cumbersome. To simplify this process, you can use the following -special command: - -@table @asis -@item @kbd{C-c C-w} (@code{org-refile}) -@kindex C-c C-w -@findex org-refile -@vindex org-reverse-note-order -@vindex org-refile-targets -@vindex org-refile-use-outline-path -@vindex org-outline-path-complete-in-steps -@vindex org-refile-allow-creating-parent-nodes -@vindex org-log-refile -Refile the entry or region at point. This command offers possible -locations for refiling the entry and lets you select one with -completion. The item (or all items in the region) is filed below -the target heading as a subitem. Depending on -@code{org-reverse-note-order}, it is either the first or last subitem. - -By default, all level 1 headlines in the current buffer are -considered to be targets, but you can have more complex definitions -across a number of files. See the variable @code{org-refile-targets} for -details. If you would like to select a location via -a file-path-like completion along the outline path, see the -variables @code{org-refile-use-outline-path} and -@code{org-outline-path-complete-in-steps}. If you would like to be able -to create new nodes as new parents for refiling on the fly, check -the variable @code{org-refile-allow-creating-parent-nodes}. When the -variable @code{org-log-refile}@footnote{Note the corresponding @samp{STARTUP} options @samp{logrefile}, -@samp{lognoterefile}, and @samp{nologrefile}.} is set, a timestamp or a note is -recorded whenever an entry is refiled. - -@item @kbd{C-u C-c C-w} -@kindex C-u C-c C-w -Use the refile interface to jump to a heading. - -@item @kbd{C-u C-u C-c C-w} (@code{org-refile-goto-last-stored}) -@kindex C-u C-u C-c C-w -@findex org-refile-goto-last-stored -Jump to the location where @code{org-refile} last moved a tree to. - -@item @kbd{C-2 C-c C-w} -@kindex C-2 C-c C-w -Refile as the child of the item currently being clocked. - -@item @kbd{C-3 C-c C-w} -@kindex C-3 C-c C-w -@vindex org-refile-keep -Refile and keep the entry in place. Also see @code{org-refile-keep} to -make this the default behavior, and beware that this may result in -duplicated @samp{ID} properties. - -@item @kbd{C-0 C-c C-w} or @kbd{C-u C-u C-u C-c C-w} (@code{org-refile-cache-clear}) -@kindex C-u C-u C-u C-c C-w -@kindex C-0 C-c C-w -@findex org-refile-cache-clear -@vindex org-refile-use-cache -Clear the target cache. Caching of refile targets can be turned on -by setting @code{org-refile-use-cache}. To make the command see new -possible targets, you have to clear the cache with this command. - -@item @kbd{C-c M-w} (@code{org-refile-copy}) -@kindex C-c M-w -@findex org-refile-copy -Copying works like refiling, except that the original note is not -deleted. -@end table - -@node Archiving -@section Archiving - -@cindex archiving - -When a project represented by a (sub)tree is finished, you may want to -move the tree out of the way and to stop it from contributing to the -agenda. Archiving is important to keep your working files compact and -global searches like the construction of agenda views fast. - -@table @asis -@item @kbd{C-c C-x C-a} (@code{org-archive-subtree-default}) -@kindex C-c C-x C-a -@findex org-archive-subtree-default -@vindex org-archive-default-command -Archive the current entry using the command specified in the -variable @code{org-archive-default-command}. -@end table - -@menu -* Moving subtrees:: Moving a tree to an archive file. -* Internal archiving:: Switch off a tree but keep it in the file. -@end menu - -@node Moving subtrees -@subsection Moving a tree to an archive file - -@cindex external archiving - -The most common archiving action is to move a project tree to another -file, the archive file. - -@table @asis -@item @kbd{C-c C-x C-s} or short @kbd{C-c $} (@code{org-archive-subtree}) -@kindex C-c C-x C-s -@kindex C-c $ -@findex org-archive-subtree -@vindex org-archive-location -Archive the subtree starting at point position to the location given -by @code{org-archive-location}. - -@item @kbd{C-u C-c C-x C-s} -@kindex C-u C-c C-x C-s -Check if any direct children of the current headline could be moved -to the archive. To do this, check each subtree for open TODO -entries. If none is found, the command offers to move it to the -archive location. If point is @emph{not} on a headline when this command -is invoked, check level 1 trees. - -@item @kbd{C-u C-u C-c C-x C-s} -@kindex C-u C-u C-c C-x C-s -As above, but check subtree for timestamps instead of TODO entries. -The command offers to archive the subtree if it @emph{does} contain -a timestamp, and that timestamp is in the past. -@end table - -@cindex archive locations -The default archive location is a file in the same directory as the -current file, with the name derived by appending @samp{_archive} to the -current file name. You can also choose what heading to file archived -items under, with the possibility to add them to a datetree in a file. -For information and examples on how to specify the file and the -heading, see the documentation string of the variable -@code{org-archive-location}. - -There is also an in-buffer option for setting this variable, for -example: - -@cindex @samp{ARCHIVE}, keyword -@example -#+ARCHIVE: %s_done:: -@end example - - -@cindex ARCHIVE, property -If you would like to have a special archive location for a single -entry or a (sub)tree, give the entry an @samp{ARCHIVE} property with the -location as the value (see @ref{Properties and Columns}). - -@vindex org-archive-save-context-info -When a subtree is moved, it receives a number of special properties -that record context information like the file from where the entry -came, its outline path the archiving time etc. Configure the variable -@code{org-archive-save-context-info} to adjust the amount of information -added. - -@vindex org-archive-subtree-save-file-p -When @code{org-archive-subtree-save-file-p} is non-@code{nil}, save the target -archive buffer. - -@node Internal archiving -@subsection Internal archiving - -@cindex @samp{ARCHIVE}, tag -If you want to just switch off---for agenda views---certain subtrees -without moving them to a different file, you can use the @samp{ARCHIVE} -tag. - -A headline that is marked with the @samp{ARCHIVE} tag (see @ref{Tags}) stays at -its location in the outline tree, but behaves in the following way: - -@itemize -@item -@vindex org-cycle-open-archived-trees -It does not open when you attempt to do so with a visibility cycling -command (see @ref{Visibility Cycling}). You can force cycling archived -subtrees with @kbd{C-@key{TAB}}, or by setting the option -@code{org-cycle-open-archived-trees}. Also normal outline commands, like -@code{outline-show-all}, open archived subtrees. - -@item -@vindex org-sparse-tree-open-archived-trees -During sparse tree construction (see @ref{Sparse Trees}), matches in -archived subtrees are not exposed, unless you configure the option -@code{org-sparse-tree-open-archived-trees}. - -@item -@vindex org-agenda-skip-archived-trees -During agenda view construction (see @ref{Agenda Views}), the content of -archived trees is ignored unless you configure the option -@code{org-agenda-skip-archived-trees}, in which case these trees are -always included. In the agenda you can press @kbd{v a} to get -archives temporarily included. - -@item -@vindex org-export-with-archived-trees -Archived trees are not exported (see @ref{Exporting}), only the headline -is. Configure the details using the variable -@code{org-export-with-archived-trees}. - -@item -@vindex org-columns-skip-archived-trees -Archived trees are excluded from column view unless the variable -@code{org-columns-skip-archived-trees} is configured to @code{nil}. -@end itemize - -The following commands help manage the @samp{ARCHIVE} tag: - -@table @asis -@item @kbd{C-c C-x a} (@code{org-toggle-archive-tag}) -@kindex C-c C-x a -@findex org-toggle-archive-tag -Toggle the archive tag for the current headline. When the tag is -set, the headline changes to a shadowed face, and the subtree below -it is hidden. - -@item @kbd{C-u C-c C-x a} -@kindex C-u C-c C-x a -Check if any direct children of the current headline should be -archived. To do this, check each subtree for open TODO entries. If -none is found, the command offers to set the @samp{ARCHIVE} tag for the -child. If point is @emph{not} on a headline when this command is -invoked, check the level 1 trees. - -@item @kbd{C-c C-@key{TAB}} (@code{org-force-cycle-archived}) -@kindex C-TAB -Cycle a tree even if it is tagged with @samp{ARCHIVE}. - -@item @kbd{C-c C-x A} (@code{org-archive-to-archive-sibling}) -@kindex C-c C-x A -@findex org-archive-to-archive-sibling -Move the current entry to the @emph{Archive Sibling}. This is a sibling -of the entry with the heading @samp{Archive} and the archive tag. The -entry becomes a child of that sibling and in this way retains a lot -of its original context, including inherited tags and approximate -position in the outline. -@end table - -@node Capture and Attachments -@chapter Capture and Attachments - -@cindex capture -@cindex attachments -@cindex RSS feeds -@cindex Atom feeds -@cindex protocols, for external access - -An important part of any organization system is the ability to quickly -capture new ideas and tasks, and to associate reference material with -them. Org does this using a process called @emph{capture}. It also can -store files related to a task (@emph{attachments}) in a special directory. -Finally, it can parse RSS feeds for information. To learn how to let -external programs (for example a web browser) trigger Org to capture -material, see @ref{Protocols}. - -@menu -* Capture:: Capturing new stuff. -* Attachments:: Attach files to outlines. -* RSS Feeds:: Getting input from RSS feeds. -@end menu - -@node Capture -@section Capture - -@cindex capture - -Capture lets you quickly store notes with little interruption of your -work flow. Org's method for capturing new items is heavily inspired -by John Wiegley's excellent Remember package. - -@menu -* Setting up capture:: Where notes will be stored. -* Using capture:: Commands to invoke and terminate capture. -* Capture templates:: Define the outline of different note types. -@end menu - -@node Setting up capture -@subsection Setting up capture - -The following customization sets a default target file for notes. - -@vindex org-default-notes-file -@lisp -(setq org-default-notes-file (concat org-directory "/notes.org")) -@end lisp - -You may also define a global key for capturing new material (see -@ref{Activation}). - -@node Using capture -@subsection Using capture - -@table @asis -@item @kbd{M-x org-capture} (@code{org-capture}) -@findex org-capture -@cindex date tree -Display the capture templates menu. If you have templates defined -(see @ref{Capture templates}), it offers these templates for selection or -use a new Org outline node as the default template. It inserts the -template into the target file and switch to an indirect buffer -narrowed to this new node. You may then insert the information you -want. - -@item @kbd{C-c C-c} (@code{org-capture-finalize}) -@kindex C-c C-c @r{(Capture buffer)} -@findex org-capture-finalize -Once you have finished entering information into the capture buffer, -@kbd{C-c C-c} returns you to the window configuration before -the capture process, so that you can resume your work without -further distraction. When called with a prefix argument, finalize -and then jump to the captured item. - -@item @kbd{C-c C-w} (@code{org-capture-refile}) -@kindex C-c C-w @r{(Capture buffer)} -@findex org-capture-refile -Finalize the capture process by refiling the note to a different -place (see @ref{Refile and Copy}). Please realize that this is a normal -refiling command that will be executed---so point position at the -moment you run this command is important. If you have inserted -a tree with a parent and children, first move point back to the -parent. Any prefix argument given to this command is passed on to -the @code{org-refile} command. - -@item @kbd{C-c C-k} (@code{org-capture-kill}) -@kindex C-c C-k @r{(Capture buffer)} -@findex org-capture-kill -Abort the capture process and return to the previous state. -@end table - -@kindex k c @r{(Agenda)} -You can also call @code{org-capture} in a special way from the agenda, -using the @kbd{k c} key combination. With this access, any -timestamps inserted by the selected capture template defaults to the -date at point in the agenda, rather than to the current date. - -To find the locations of the last stored capture, use @code{org-capture} -with prefix commands: - -@table @asis -@item @kbd{C-u M-x org-capture} -Visit the target location of a capture template. You get to select -the template in the usual way. - -@item @kbd{C-u C-u M-x org-capture} -Visit the last stored capture item in its buffer. -@end table - -@vindex org-capture-bookmark -@vindex org-capture-last-stored -You can also jump to the bookmark @code{org-capture-last-stored}, which is -automatically created unless you set @code{org-capture-bookmark} to @code{nil}. - -To insert the capture at point in an Org buffer, call @code{org-capture} -with a @kbd{C-0} prefix argument. - -@node Capture templates -@subsection Capture templates - -@cindex templates, for Capture - -You can use templates for different types of capture items, and for -different target locations. The easiest way to create such templates -is through the customize interface. - -@table @asis -@item @kbd{C} -@kindex C @r{(Capture menu} -@vindex org-capture-templates -Customize the variable @code{org-capture-templates}. -@end table - -Before we give the formal description of template definitions, let's -look at an example. Say you would like to use one template to create -general TODO entries, and you want to put these entries under the -heading @samp{Tasks} in your file @samp{~/org/gtd.org}. Also, a date tree in -the file @samp{journal.org} should capture journal entries. A possible -configuration would look like: - -@lisp -(setq org-capture-templates - '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") - "* TODO %?\n %i\n %a") - ("j" "Journal" entry (file+datetree "~/org/journal.org") - "* %?\nEntered on %U\n %i\n %a"))) -@end lisp - -If you then press @kbd{t} from the capture menu, Org will prepare -the template for you like this: - -@example -* TODO - [[file:LINK TO WHERE YOU INITIATED CAPTURE]] -@end example - -@noindent -During expansion of the template, @samp{%a} has been replaced by a link to -the location from where you called the capture command. This can be -extremely useful for deriving tasks from emails, for example. You -fill in the task definition, press @kbd{C-c C-c} and Org returns -you to the same place where you started the capture process. - -To define special keys to capture to a particular template without -going through the interactive template selection, you can create your -key binding like this: - -@lisp -(define-key global-map (kbd "C-c x") - (lambda () (interactive) (org-capture nil "x"))) -@end lisp - -@menu -* Template elements:: What is needed for a complete template entry. -* Template expansion:: Filling in information about time and context. -* Templates in contexts:: Only show a template in a specific context. -@end menu - -@node Template elements -@subsubsection Template elements - -Now lets look at the elements of a template definition. Each entry in -@code{org-capture-templates} is a list with the following items: - -@table @asis -@item keys -The keys that selects the template, as a string, characters only, -for example @samp{"a"}, for a template to be selected with a single key, -or @samp{"bt"} for selection with two keys. When using several keys, -keys using the same prefix key must be sequential in the list and -preceded by a 2-element entry explaining the prefix key, for -example: - -@lisp -("b" "Templates for marking stuff to buy") -@end lisp - -If you do not define a template for the @kbd{C} key, this key -opens the Customize buffer for this complex variable. - -@item description -A short string describing the template, shown during selection. - -@item type -The type of entry, a symbol. Valid values are: - -@table @asis -@item @code{entry} -An Org mode node, with a headline. Will be filed as the child of -the target entry or as a top-level entry. The target file should -be an Org file. - -@item @code{item} -A plain list item, placed in the first plain list at the target -location. Again the target file should be an Org file. - -@item @code{checkitem} -A checkbox item. This only differs from the plain list item by -the default template. - -@item @code{table-line} -A new line in the first table at the target location. Where -exactly the line will be inserted depends on the properties -@code{:prepend} and @code{:table-line-pos} (see below). - -@item @code{plain} -Text to be inserted as it is. -@end table - -@item target -@vindex org-default-notes-file -@vindex org-directory -Specification of where the captured item should be placed. In Org -files, targets usually define a node. Entries will become children -of this node. Other types will be added to the table or list in the -body of this node. Most target specifications contain a file name. -If that file name is the empty string, it defaults to -@code{org-default-notes-file}. A file can also be given as a variable or -as a function called with no argument. When an absolute path is not -specified for a target, it is taken as relative to @code{org-directory}. - -Valid values are: - -@table @asis -@item @samp{(file "path/to/file")} -Text will be placed at the beginning or end of that file. - -@item @samp{(id "id of existing org entry")} -Filing as child of this entry, or in the body of the entry. - -@item @samp{(file+headline "filename" "node headline")} -Fast configuration if the target heading is unique in the file. - -@item @samp{(file+olp "filename" "Level 1 heading" "Level 2" ...)} -For non-unique headings, the full path is safer. - -@item @samp{(file+regexp "filename" "regexp to find location")} -Use a regular expression to position point. - -@item @samp{(file+olp+datetree "filename" [ "Level 1 heading" ...])} -This target@footnote{Org used to offer four different targets for date/week tree -capture. Now, Org automatically translates these to use -@code{file+olp+datetree}, applying the @code{:time-prompt} and @code{:tree-type} -properties. Please rewrite your date/week-tree targets using -@code{file+olp+datetree} since the older targets are now deprecated.} creates a heading in a date tree@footnote{A date tree is an outline structure with years on the highest -level, months or ISO weeks as sublevels and then dates on the lowest -level. Tags are allowed in the tree structure.} for -today's date. If the optional outline path is given, the tree -will be built under the node it is pointing to, instead of at top -level. Check out the @code{:time-prompt} and @code{:tree-type} properties -below for additional options. - -@item @samp{(file+function "filename" function-finding-location)} -A function to find the right location in the file. - -@item @samp{(clock)} -File to the entry that is currently being clocked. - -@item @samp{(function function-finding-location)} -Most general way: write your own function which both visits the -file and moves point to the right location. -@end table - -@item template -The template for creating the capture item. If you leave this -empty, an appropriate default template will be used. Otherwise this -is a string with escape codes, which will be replaced depending on -time and context of the capture call. You may also get this -template string from a file@footnote{When the file name is not absolute, Org assumes it is relative -to @code{org-directory}.}, or dynamically, from a function -using either syntax: - -@example -(file "/path/to/template-file") -(function FUNCTION-RETURNING-THE-TEMPLATE) -@end example - -@item properties -The rest of the entry is a property list of additional options. -Recognized properties are: - -@table @asis -@item @code{:prepend} -Normally new captured information will be appended at the target -location (last child, last table line, last list item, @dots{}). -Setting this property changes that. - -@item @code{:immediate-finish} -When set, do not offer to edit the information, just file it away -immediately. This makes sense if the template only needs -information that can be added automatically. - -@item @code{:jump-to-captured} -When set, jump to the captured entry when finished. - -@item @code{:empty-lines} -Set this to the number of lines to insert before and after the new -item. Default 0, and the only other common value is 1. - -@item @code{:empty-lines-after} -Set this to the number of lines that should be inserted after the -new item. Overrides @code{:empty-lines} for the number of lines -inserted after. - -@item @code{:empty-lines-before} -Set this to the number of lines that should be inserted before the -new item. Overrides @code{:empty-lines} for the number lines inserted -before. - -@item @code{:clock-in} -Start the clock in this item. - -@item @code{:clock-keep} -Keep the clock running when filing the captured entry. - -@item @code{:clock-resume} -If starting the capture interrupted a clock, restart that clock -when finished with the capture. Note that @code{:clock-keep} has -precedence over @code{:clock-resume}. When setting both to non-@code{nil}, -the current clock will run and the previous one will not be -resumed. - -@item @code{:time-prompt} -Prompt for a date/time to be used for date/week trees and when -filling the template. Without this property, capture uses the -current date and time. Even if this property has not been set, -you can force the same behavior by calling @code{org-capture} with -a @kbd{C-1} prefix argument. - -@item @code{:tree-type} -Use @code{week} to make a week tree instead of the month-day tree, -i.e., place the headings for each day under a heading with the -current ISO week. Use @code{month} to group entries by month -only. Default is to group entries by day. - -@item @code{:unnarrowed} -Do not narrow the target buffer, simply show the full buffer. -Default is to narrow it so that you only see the new material. - -@item @code{:table-line-pos} -Specification of the location in the table where the new line -should be inserted. It should be a string like @samp{II-3} meaning -that the new line should become the third line before the second -horizontal separator line. - -@item @code{:kill-buffer} -If the target file was not yet visited when capture was invoked, -kill the buffer again after capture is completed. - -@item @code{:no-save} -Do not save the target file after finishing the capture. -@end table -@end table - -@node Template expansion -@subsubsection Template expansion - -In the template itself, special ``%-escapes''@footnote{If you need one of these sequences literally, escape the @samp{%} -with a backslash.} allow dynamic -insertion of content. The templates are expanded in the order given -here: - -@table @asis -@item @samp{%[FILE]} -Insert the contents of the file given by @var{FILE}. - -@item @samp{%(EXP)} -Evaluate Elisp expression @var{EXP} and replace it with the -result. The @var{EXP} form must return a string. Only -placeholders pre-existing within the template, or introduced with -@samp{%[file]}, are expanded this way. Since this happens after -expanding non-interactive ``%-escapes'', those can be used to fill the -expression. - -@item @samp{%<FORMAT>} -The result of format-time-string on the @var{FORMAT} -specification. - -@item @samp{%t} -Timestamp, date only. - -@item @samp{%T} -Timestamp, with date and time. - -@item @samp{%u}, @samp{%U} -Like @samp{%t}, @samp{%T} above, but inactive timestamps. - -@item @samp{%i} -Initial content, the region when capture is called while the region -is active. If there is text before @samp{%i} on the same line, such as -indentation, and @samp{%i} is not inside a @samp{%(exp)} form, that prefix is -added before every line in the inserted text. - -@item @samp{%a} -Annotation, normally the link created with @code{org-store-link}. - -@item @samp{%A} -Like @samp{%a}, but prompt for the description part. - -@item @samp{%l} -Like @samp{%a}, but only insert the literal link. - -@item @samp{%c} -Current kill ring head. - -@item @samp{%x} -Content of the X clipboard. - -@item @samp{%k} -Title of the currently clocked task. - -@item @samp{%K} -Link to the currently clocked task. - -@item @samp{%n} -User name (taken from @code{user-full-name}). - -@item @samp{%f} -File visited by current buffer when org-capture was called. - -@item @samp{%F} -Full path of the file or directory visited by current buffer. - -@item @samp{%:keyword} -Specific information for certain link types, see below. - -@item @samp{%^g} -Prompt for tags, with completion on tags in target file. - -@item @samp{%^G} -Prompt for tags, with completion all tags in all agenda files. - -@item @samp{%^t} -Like @samp{%t}, but prompt for date. Similarly @samp{%^T}, @samp{%^u}, @samp{%^U}. You -may define a prompt like @samp{%^@{Birthday@}t}. - -@item @samp{%^C} -Interactive selection of which kill or clip to use. - -@item @samp{%^L} -Like @samp{%^C}, but insert as link. - -@item @samp{%^@{PROP@}p} -Prompt the user for a value for property @var{PROP}. - -@item @samp{%^@{PROMPT@}} -Prompt the user for a string and replace this sequence with it. You -may specify a default value and a completion table with -@samp{%^@{prompt|default|completion2|completion3...@}}. The arrow keys -access a prompt-specific history. - -@item @samp{%\N} -Insert the text entered at the @var{N}th @samp{%^@{PROMPT@}}, where -@var{N} is a number, starting from 1. - -@item @samp{%?} -After completing the template, position point here. -@end table - -@vindex org-store-link-props -For specific link types, the following keywords are defined@footnote{If you define your own link types (see @ref{Adding Hyperlink Types}), any property you store with @code{org-store-link-props} can be -accessed in capture templates in a similar way.}: - -@vindex org-link-from-user-regexp -@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@headitem Link type -@tab Available keywords -@item bbdb -@tab @samp{%:name}, @samp{%:company} -@item irc -@tab @samp{%:server}, @samp{%:port}, @samp{%:nick} -@item mh, rmail -@tab @samp{%:type}, @samp{%:subject}, @samp{%:message-id} -@item -@tab @samp{%:from}, @samp{%:fromname}, @samp{%:fromaddress} -@item -@tab @samp{%:to}, @samp{%:toname}, @samp{%:toaddress} -@item -@tab @samp{%:date} (message date header field) -@item -@tab @samp{%:date-timestamp} (date as active timestamp) -@item -@tab @samp{%:date-timestamp-inactive} (date as inactive timestamp) -@item -@tab @samp{%:fromto} (either ``to NAME'' or ``from NAME'')@footnote{This is always the other, not the user. See the variable -@code{org-link-from-user-regexp}.} -@item gnus -@tab @samp{%:group}, for messages also all email fields -@item w3, w3m -@tab @samp{%:url} -@item info -@tab @samp{%:file}, @samp{%:node} -@item calendar -@tab @samp{%:date} -@item org-protocol -@tab @samp{%:link}, @samp{%:description}, @samp{%:annotation} -@end multitable - -@node Templates in contexts -@subsubsection Templates in contexts - -@vindex org-capture-templates-contexts -To control whether a capture template should be accessible from -a specific context, you can customize -@code{org-capture-templates-contexts}. Let's say, for example, that you -have a capture template ``p'' for storing Gnus emails containing -patches. Then you would configure this option like this: - -@lisp -(setq org-capture-templates-contexts - '(("p" (in-mode . "message-mode")))) -@end lisp - -You can also tell that the command key @kbd{p} should refer to -another template. In that case, add this command key like this: - -@lisp -(setq org-capture-templates-contexts - '(("p" "q" (in-mode . "message-mode")))) -@end lisp - -See the docstring of the variable for more information. - -@node Attachments -@section Attachments - -@cindex attachments - -It is often useful to associate reference material with an outline -node. Small chunks of plain text can simply be stored in the subtree -of a project. Hyperlinks (see @ref{Hyperlinks}) can establish associations -with files that live elsewhere on a local, or even remote, computer, -like emails or source code files belonging to a project. - -Another method is @emph{attachments}, which are files located in a -directory belonging to an outline node. Org uses directories either -named by a unique ID of each entry, or by a @samp{DIR} property. - -@menu -* Attachment defaults and dispatcher:: How to access attachment commands -* Attachment options:: Configuring the attachment system -* Attachment links:: Hyperlink access to attachments -* Automatic version-control with Git:: Everything safely stored away -* Attach from Dired:: Using dired to select an attachment -@end menu - -@node Attachment defaults and dispatcher -@subsection Attachment defaults and dispatcher - -By default, Org attach uses ID properties when adding attachments to -outline nodes. This makes working with attachments fully automated. -There is no decision needed for folder-name or location. ID-based -directories are by default located in the @samp{data/} directory, which -lives in the same directory where your Org file lives@footnote{If you move entries or Org files from one directory to -another, you may want to configure @code{org-attach-id-dir} to contain -an absolute path.}. - -When attachments are made using @code{org-attach} a default tag @samp{ATTACH} is -added to the node that gets the attachments. - -For more control over the setup, see @ref{Attachment options}. - -The following commands deal with attachments: - -@table @asis -@item @kbd{C-c C-a} (@code{org-attach}) -@kindex C-c C-a -@findex org-attach -The dispatcher for commands related to the attachment system. After -these keys, a list of commands is displayed and you must press an -additional key to select a command: - -@table @asis -@item @kbd{a} (@code{org-attach-attach}) -@kindex C-c C-a a -@findex org-attach-attach -@vindex org-attach-method -Select a file and move it into the task's attachment directory. -The file is copied, moved, or linked, depending on -@code{org-attach-method}. Note that hard links are not supported on -all systems. - -@item @kbd{c}/@kbd{m}/@kbd{l} -@kindex C-c C-a c -@kindex C-c C-a m -@kindex C-c C-a l -Attach a file using the copy/move/link method. Note that hard -links are not supported on all systems. - -@item @kbd{b} (@code{org-attach-buffer}) -@kindex C-c C-a b -@findex org-attach-buffer -Select a buffer and save it as a file in the task's attachment -directory. - -@item @kbd{n} (@code{org-attach-new}) -@kindex C-c C-a n -@findex org-attach-new -Create a new attachment as an Emacs buffer. - -@item @kbd{z} (@code{org-attach-sync}) -@kindex C-c C-a z -@findex org-attach-sync -Synchronize the current task with its attachment directory, in -case you added attachments yourself. - -@item @kbd{o} (@code{org-attach-open}) -@kindex C-c C-a o -@findex org-attach-open -@vindex org-file-apps -Open current task's attachment. If there is more than one, prompt -for a file name first. Opening follows the rules set by -@code{org-file-apps}. For more details, see the information on -following hyperlinks (see @ref{Handling Links}). - -@item @kbd{O} (@code{org-attach-open-in-emacs}) -@kindex C-c C-a O -@findex org-attach-open-in-emacs -Also open the attachment, but force opening the file in Emacs. - -@item @kbd{f} (@code{org-attach-reveal}) -@kindex C-c C-a f -@findex org-attach-reveal -Open the current task's attachment directory. - -@item @kbd{F} (@code{org-attach-reveal-in-emacs}) -@kindex C-c C-a F -@findex org-attach-reveal-in-emacs -Also open the directory, but force using Dired in Emacs. - -@item @kbd{d} (@code{org-attach-delete-one}) -@kindex C-c C-a d -Select and delete a single attachment. - -@item @kbd{D} (@code{org-attach-delete-all}) -@kindex C-c C-a D -Delete all of a task's attachments. A safer way is to open the -directory in Dired and delete from there. - -@item @kbd{s} (@code{org-attach-set-directory}) -@kindex C-c C-a s -@cindex @samp{DIR}, property -Set a specific directory as the entry's attachment directory. -This works by putting the directory path into the @samp{DIR} -property. - -@item @kbd{S} (@code{org-attach-unset-directory}) -@kindex C-c C-a S -@cindex @samp{DIR}, property -Remove the attachment directory. This command removes the @samp{DIR} -property and asks the user to either move content inside that -folder, if an @samp{ID} property is set, delete the content, or to -leave the attachment directory as is but no longer attached to the -outline node. -@end table -@end table - -@node Attachment options -@subsection Attachment options - -There are a couple of options for attachments that are worth -mentioning. - -@table @asis -@item @code{org-attach-id-dir} -@vindex org-attach-id-dir -The directory where attachments are stored when @samp{ID} is used as -method. - -@item @code{org-attach-dir-relative} -@vindex org-attach-dir-relative -When setting the @samp{DIR} property on a node using @kbd{C-c C-a s} -(@code{org-attach-set-directory}), absolute links are entered by default. -This option changes that to relative links. - -@item @code{org-attach-use-inheritance} -@vindex org-attach-use-inheritance -By default folders attached to an outline node are inherited from -parents according to @code{org-use-property-inheritance}. If one instead -want to set inheritance specifically for Org attach that can be done -using @code{org-attach-use-inheritance}. Inheriting documents through -the node hierarchy makes a lot of sense in most cases. Especially -when using attachment links (see @ref{Attachment links}). The following -example shows one use case for attachment inheritance: - -@example -* Chapter A ... - :PROPERTIES: - :DIR: Chapter A/ - :END: -** Introduction -Some text - -#+NAME: Image 1 -[[attachment:image 1.jpg]] -@end example - -Without inheritance one would not be able to resolve the link to -@samp{image 1.jpg}, since the link is inside a sub-heading to @samp{Chapter - A}. - -Inheritance works the same way for both @samp{ID} and @samp{DIR} property. If -both properties are defined on the same headline then @samp{DIR} takes -precedence. This is also true if inheritance is enabled. If @samp{DIR} -is inherited from a parent node in the outline, that property still -takes precedence over an @samp{ID} property defined on the node itself. - -@item @code{org-attach-method} -@vindex org-attach-method -When attaching files using the dispatcher @kbd{C-c C-a} it -defaults to copying files. The behavior can be changed by -customizing @code{org-attach-method}. Options are Copy, Move/Rename, -Hard link or Symbolic link. - -@item @code{org-attach-preferred-new-method} -@vindex org-attach-preferred-new-method -This customization lets you choose the default way to attach to -nodes without existing @samp{ID} and @samp{DIR} property. It defaults to @code{id} -but can also be set to @code{dir}, @code{ask} or @code{nil}. - -@item @code{org-attach-archive-delete} -@vindex org-attach-archive-delete -Configure this to determine if attachments should be deleted or not -when a subtree that has attachments is archived. - -@item @code{org-attach-auto-tag} -@vindex org-attach-auto-tag -When attaching files to a heading it will be assigned a tag -according to what is set here. - -@item @code{org-attach-id-to-path-function-list} -@vindex org-attach-id-to-path-function-list -When @samp{ID} is used for attachments, the ID is parsed into a part of a -directory-path. See @code{org-attach-id-uuid-folder-format} for the -default function. Define a new one and add it as first element in -@code{org-attach-id-to-path-function-list} if you want the folder -structure in any other way. All functions in this list will be -tried when resolving existing ID's into paths, to maintain backward -compatibility with existing folders in your system. - -@item @code{org-attach-store-link-p} -@vindex org-attach-store-link-p -Stores a link to the file that is being attached. The link is -stored in @code{org-stored-links} for later insertion with @kbd{C-c C-l} (see @ref{Handling Links}). Depending on what option is set in -@code{org-attach-store-link-p}, the link is stored to either the original -location as a file link, the attachment location as an attachment -link or to the attachment location as a file link. - -@item @code{org-attach-commands} -@vindex org-attach-commands -List of all commands used in the attach dispatcher. - -@item @code{org-attach-expert} -@vindex org-attach-expert -Do not show the splash buffer with the attach dispatcher when -@code{org-attach-expert} is set to non-@code{nil}. -@end table - -See customization group @samp{Org Attach} if you want to change the -default settings. - -@node Attachment links -@subsection Attachment links - -Attached files and folders can be referenced using attachment links. -This makes it easy to refer to the material added to an outline node. -Especially if it was attached using the unique ID of the entry! - -@example -* TODO Some task - :PROPERTIES: - :ID: 95d50008-c12e-479f-a4f2-cc0238205319 - :END: -See attached document for more information: [[attachment:info.org]] -@end example - -See @ref{External Links} for more information about these links. - -@node Automatic version-control with Git -@subsection Automatic version-control with Git - -If the directory attached to an outline node is a Git repository, Org -can be configured to automatically commit changes to that repository -when it sees them. - -To make Org mode take care of versioning of attachments for you, add -the following to your Emacs config: - -@lisp -(require 'org-attach-git) -@end lisp - -@node Attach from Dired -@subsection Attach from Dired - -@cindex attach from Dired -@findex org-attach-dired-to-subtree - -It is possible to attach files to a subtree from a Dired buffer. To -use this feature, have one window in Dired mode containing the file(s) -to be attached and another window with point in the subtree that shall -get the attachments. In the Dired window, with point on a file, -@kbd{M-x org-attach-dired-to-subtree} attaches the file to the -subtree using the attachment method set by variable -@code{org-attach-method}. When files are marked in the Dired window then -all marked files get attached. - -Add the following lines to the Emacs init file to have @kbd{C-c C-x a} attach files in Dired buffers. - -@lisp -(add-hook 'dired-mode-hook - (lambda () - (define-key dired-mode-map - (kbd "C-c C-x a") - #'org-attach-dired-to-subtree))) -@end lisp - -The following code shows how to bind the previous command with -a specific attachment method. - -@lisp -(add-hook 'dired-mode-hook - (lambda () - (define-key dired-mode-map (kbd "C-c C-x c") - (lambda () - (interactive) - (let ((org-attach-method 'cp)) - (call-interactively #'org-attach-dired-to-subtree)))))) -@end lisp - -@node RSS Feeds -@section RSS Feeds - -@cindex RSS feeds -@cindex Atom feeds - -Org can add and change entries based on information found in RSS feeds -and Atom feeds. You could use this to make a task out of each new -podcast in a podcast feed. Or you could use a phone-based -note-creating service on the web to import tasks into Org. To access -feeds, configure the variable @code{org-feed-alist}. The docstring of this -variable has detailed information. With the following - -@lisp -(setq org-feed-alist - '(("Slashdot" - "http://rss.slashdot.org/Slashdot/slashdot" - "~/txt/org/feeds.org" "Slashdot Entries"))) -@end lisp - -@noindent -new items from the feed provided by @samp{rss.slashdot.org} result in new -entries in the file @samp{~/org/feeds.org} under the heading @samp{Slashdot -Entries}, whenever the following command is used: - -@table @asis -@item @kbd{C-c C-x g} (@code{org-feed-update-all}) -@kindex C-c C-x g -Collect items from the feeds configured in @code{org-feed-alist} and act -upon them. - -@item @kbd{C-c C-x G} (@code{org-feed-goto-inbox}) -@kindex C-c C-x G -Prompt for a feed name and go to the inbox configured for this feed. -@end table - -Under the same headline, Org creates a drawer @samp{FEEDSTATUS} in which it -stores information about the status of items in the feed, to avoid -adding the same item several times. - -For more information, including how to read atom feeds, see -@samp{org-feed.el} and the docstring of @code{org-feed-alist}. - -@node Agenda Views -@chapter Agenda Views - -@cindex agenda views - -Due to the way Org works, TODO items, time-stamped items, and tagged -headlines can be scattered throughout a file or even a number of -files. To get an overview of open action items, or of events that are -important for a particular date, this information must be collected, -sorted and displayed in an organized way. - -Org can select items based on various criteria and display them in -a separate buffer. Six different view types are provided: - -@itemize -@item -an @emph{agenda} that is like a calendar and shows information for -specific dates, - -@item -a @emph{TODO list} that covers all unfinished action items, - -@item -a @emph{match view}, showings headlines based on the tags, properties, -and TODO state associated with them, - -@item -a @emph{text search view} that shows all entries from multiple files that -contain specified keywords, - -@item -a @emph{stuck projects view} showing projects that currently do not move -along, and - -@item -@emph{custom views} that are special searches and combinations of -different views. -@end itemize - -The extracted information is displayed in a special @emph{agenda buffer}. -This buffer is read-only, but provides commands to visit the -corresponding locations in the original Org files, and even to edit -these files remotely. - -@vindex org-agenda-skip-comment-trees -@vindex org-agenda-skip-archived-trees -@cindex commented entries, in agenda views -@cindex archived entries, in agenda views -By default, the report ignores commented (see @ref{Comment Lines}) and -archived (see @ref{Internal archiving}) entries. You can override this by -setting @code{org-agenda-skip-comment-trees} and -@code{org-agenda-skip-archived-trees} to @code{nil}. - -@vindex org-agenda-window-setup -@vindex org-agenda-restore-windows-after-quit -Two variables control how the agenda buffer is displayed and whether -the window configuration is restored when the agenda exits: -@code{org-agenda-window-setup} and @code{org-agenda-restore-windows-after-quit}. - -@menu -* Agenda Files:: Files being searched for agenda information. -* Agenda Dispatcher:: Keyboard access to agenda views. -* Built-in Agenda Views:: What is available out of the box? -* Presentation and Sorting:: How agenda items are prepared for display. -* Agenda Commands:: Remote editing of Org trees. -* Custom Agenda Views:: Defining special searches and views. -* Exporting Agenda Views:: Writing a view to a file. -* Agenda Column View:: Using column view for collected entries. -@end menu - -@node Agenda Files -@section Agenda Files - -@cindex agenda files -@cindex files for agenda - -@vindex org-agenda-files -The information to be shown is normally collected from all @emph{agenda -files}, the files listed in the variable @code{org-agenda-files}@footnote{If the value of that variable is not a list, but a single file -name, then the list of agenda files in maintained in that external -file.}. -If a directory is part of this list, all files with the extension -@samp{.org} in this directory are part of the list. - -Thus, even if you only work with a single Org file, that file should -be put into the list@footnote{When using the dispatcher, pressing @kbd{<} before -selecting a command actually limits the command to the current file, -and ignores @code{org-agenda-files} until the next dispatcher command.}. You can customize @code{org-agenda-files}, -but the easiest way to maintain it is through the following commands - -@table @asis -@item @kbd{C-c [} (@code{org-agenda-file-to-front}) -@kindex C-c [ -@findex org-agenda-file-to-front -@cindex files, adding to agenda list -Add current file to the list of agenda files. The file is added to -the front of the list. If it was already in the list, it is moved -to the front. With a prefix argument, file is added/moved to the -end. - -@item @kbd{C-c ]} (@code{org-remove-file}) -@kindex C-c ] -@findex org-remove-file -Remove current file from the list of agenda files. - -@item @kbd{C-'} -@itemx @kbd{C-,} (@code{org-cycle-agenda-files}) -@kindex C-' -@kindex C-, -@findex org-cycle-agenda-files -@cindex cycling, of agenda files -Cycle through agenda file list, visiting one file after the other. - -@item @kbd{M-x org-switchb} -@findex org-switchb -Command to use an Iswitchb-like interface to switch to and between -Org buffers. -@end table - -@noindent -The Org menu contains the current list of files and can be used to -visit any of them. - -If you would like to focus the agenda temporarily on a file not in -this list, or on just one file in the list, or even on only a subtree -in a file, then this can be done in different ways. For a single -agenda command, you may press @kbd{<} once or several times in -the dispatcher (see @ref{Agenda Dispatcher}). To restrict the agenda -scope for an extended period, use the following commands: - -@table @asis -@item @kbd{C-c C-x <} (@code{org-agenda-set-restriction-lock}) -@kindex C-c C-x < -@findex org-agenda-set-restriction-lock -Restrict the agenda to the current subtree. If there already is -a restriction at point, remove it. When called with a universal -prefix argument or with point before the first headline in a file, -set the agenda scope to the entire file. This restriction remains -in effect until removed with @kbd{C-c C-x >}, or by typing -either @kbd{<} or @kbd{>} in the agenda dispatcher. If -there is a window displaying an agenda view, the new restriction -takes effect immediately. - -@item @kbd{C-c C-x >} (@code{org-agenda-remove-restriction-lock}) -@kindex C-c C-x > -@findex org-agenda-remove-restriction-lock -Remove the restriction created by @kbd{C-c C-x <}. -@end table - -When working with Speedbar, you can use the following commands in the -Speedbar frame: - -@table @asis -@item @kbd{<} (@code{org-speedbar-set-agenda-restriction}) -@findex org-speedbar-set-agenda-restriction -Restrict the agenda to the item---either an Org file or a subtree in -such a file---at point in the Speedbar frame. If agenda is already -restricted there, remove the restriction. If there is a window -displaying an agenda view, the new restriction takes effect -immediately. - -@item @kbd{>} (@code{org-agenda-remove-restriction-lock}) -@findex org-agenda-remove-restriction-lock -Remove the restriction. -@end table - -@node Agenda Dispatcher -@section The Agenda Dispatcher - -@cindex agenda dispatcher -@cindex dispatching agenda commands - -The views are created through a dispatcher, accessible with @kbd{M-x org-agenda}, or, better, bound to a global key (see @ref{Activation}). -It displays a menu from which an additional letter is required to -execute a command. The dispatcher offers the following default -commands: - -@table @asis -@item @kbd{a} -Create the calendar-like agenda (see @ref{Weekly/daily agenda}). - -@item @kbd{t} -@itemx @kbd{T} -Create a list of all TODO items (see @ref{Global TODO list}). - -@item @kbd{m} -@itemx @kbd{M} -Create a list of headlines matching a given expression (see -@ref{Matching tags and properties}). - -@item @kbd{s} -@kindex s @r{(Agenda dispatcher)} -Create a list of entries selected by a boolean expression of -keywords and/or regular expressions that must or must not occur in -the entry. - -@item @kbd{/} -@kindex / @r{(Agenda dispatcher)} -@vindex org-agenda-text-search-extra-files -Search for a regular expression in all agenda files and additionally -in the files listed in @code{org-agenda-text-search-extra-files}. This -uses the Emacs command @code{multi-occur}. A prefix argument can be used -to specify the number of context lines for each match, default is -@enumerate -@item -@end enumerate - -@item @kbd{#} -Create a list of stuck projects (see @ref{Stuck projects}). - -@item @kbd{!} -Configure the list of stuck projects (see @ref{Stuck projects}). - -@item @kbd{<} -@kindex < @r{(Agenda dispatcher)} -Restrict an agenda command to the current buffer@footnote{For backward compatibility, you can also press @kbd{1} to -restrict to the current buffer.}. If -narrowing is in effect restrict to the narrowed part of the buffer. -After pressing @kbd{<}, you still need to press the character -selecting the command. - -@item @kbd{< <} -@kindex < < @r{(Agenda dispatcher)} -If there is an active region, restrict the following agenda command -to the region. Otherwise, restrict it to the current -subtree@footnote{For backward compatibility, you can also press @kbd{0} to -restrict to the current region/subtree.}. After pressing @kbd{< <}, you still need to -press the character selecting the command. - -@item @kbd{*} -@kindex * @r{(Agenda dispatcher)} -@vindex org-agenda-sticky -@findex org-toggle-sticky-agenda -Toggle sticky agenda views. By default, Org maintains only a single -agenda buffer and rebuilds it each time you change the view, to make -sure everything is always up to date. If you switch between views -often and the build time bothers you, you can turn on sticky agenda -buffers (make this the default by customizing the variable -@code{org-agenda-sticky}). With sticky agendas, the dispatcher only -switches to the selected view, you need to update it by hand with -@kbd{r} or @kbd{g}. You can toggle sticky agenda view any -time with @code{org-toggle-sticky-agenda}. -@end table - -You can also define custom commands that are accessible through the -dispatcher, just like the default commands. This includes the -possibility to create extended agenda buffers that contain several -blocks together, for example the weekly agenda, the global TODO list -and a number of special tags matches. See @ref{Custom Agenda Views}. - -@node Built-in Agenda Views -@section The Built-in Agenda Views - -In this section we describe the built-in views. - -@menu -* Weekly/daily agenda:: The calendar page with current tasks. -* Global TODO list:: All unfinished action items. -* Matching tags and properties:: Structured information with fine-tuned search. -* Search view:: Find entries by searching for text. -* Stuck projects:: Find projects you need to review. -@end menu - -@node Weekly/daily agenda -@subsection Weekly/daily agenda - -@cindex agenda -@cindex weekly agenda -@cindex daily agenda - -The purpose of the weekly/daily @emph{agenda} is to act like a page of -a paper agenda, showing all the tasks for the current week or day. - -@table @asis -@item @kbd{M-x org-agenda a} (@code{org-agenda-list}) -@kindex a @r{(Agenda dispatcher)} -@findex org-agenda-list -@cindex org-agenda, command -Compile an agenda for the current week from a list of Org files. -The agenda shows the entries for each day. With a numeric prefix -argument@footnote{For backward compatibility, the universal prefix argument -@kbd{C-u} causes all TODO entries to be listed before the agenda. -This feature is deprecated, use the dedicated TODO list, or a block -agenda instead (see @ref{Block agenda}).}---like @kbd{C-u 2 1 M-x org-agenda a}---you may -set the number of days to be displayed. -@end table - -@vindex org-agenda-span -@vindex org-agenda-start-day -@vindex org-agenda-start-on-weekday -The default number of days displayed in the agenda is set by the -variable @code{org-agenda-span}. This variable can be set to any number of -days you want to see by default in the agenda, or to a span name, such -a @code{day}, @code{week}, @code{month} or @code{year}. For weekly agendas, the default -is to start on the previous Monday (see -@code{org-agenda-start-on-weekday}). You can also set the start date using -a date shift: @samp{(setq org-agenda-start-day "+10d")} starts the agenda -ten days from today in the future. - -Remote editing from the agenda buffer means, for example, that you can -change the dates of deadlines and appointments from the agenda buffer. -The commands available in the Agenda buffer are listed in @ref{Agenda Commands}. - -@anchor{Calendar/Diary integration} -@subsubheading Calendar/Diary integration - -@cindex calendar integration -@cindex diary integration - -Emacs contains the calendar and diary by Edward@tie{}M@.@tie{}Reingold. The -calendar displays a three-month calendar with holidays from different -countries and cultures. The diary allows you to keep track of -anniversaries, lunar phases, sunrise/set, recurrent appointments -(weekly, monthly) and more. In this way, it is quite complementary to -Org. It can be very useful to combine output from Org with the diary. - -In order to include entries from the Emacs diary into Org mode's -agenda, you only need to customize the variable - -@lisp -(setq org-agenda-include-diary t) -@end lisp - -@noindent -After that, everything happens automatically. All diary entries -including holidays, anniversaries, etc., are included in the agenda -buffer created by Org mode. @kbd{@key{SPC}}, @kbd{@key{TAB}}, and -@kbd{@key{RET}} can be used from the agenda buffer to jump to the diary -file in order to edit existing diary entries. The @kbd{i} -command to insert new entries for the current date works in the agenda -buffer, as well as the commands @kbd{S}, @kbd{M}, and -@kbd{C} to display Sunrise/Sunset times, show lunar phases and to -convert to other calendars, respectively. @kbd{c} can be used to -switch back and forth between calendar and agenda. - -If you are using the diary only for expression entries and holidays, -it is faster to not use the above setting, but instead to copy or even -move the entries into an Org file. Org mode evaluates diary-style -expression entries, and does it faster because there is no overhead -for first creating the diary display. Note that the expression -entries must start at the left margin, no whitespace is allowed before -them, as seen in the following segment of an Org file:@footnote{The variable @code{org-anniversary} used in the example is just -like @code{diary-anniversary}, but the argument order is always according -to ISO and therefore independent of the value of -@code{calendar-date-style}.} - -@example -* Holidays - :PROPERTIES: - :CATEGORY: Holiday - :END: -%%(org-calendar-holiday) ; special function for holiday names - -* Birthdays - :PROPERTIES: - :CATEGORY: Ann - :END: -%%(org-anniversary 1956 5 14) Arthur Dent is %d years old -%%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old -@end example - -@anchor{Anniversaries from BBDB} -@subsubheading Anniversaries from BBDB - -@cindex BBDB, anniversaries -@cindex anniversaries, from BBDB - -@findex org-bbdb-anniversaries -If you are using the Insidious Big Brother Database to store your -contacts, you very likely prefer to store anniversaries in BBDB rather -than in a separate Org or diary file. Org supports this and can show -BBDB anniversaries as part of the agenda. All you need to do is to -add the following to one of your agenda files: - -@example -* Anniversaries - :PROPERTIES: - :CATEGORY: Anniv - :END: -%%(org-bbdb-anniversaries) -@end example - -You can then go ahead and define anniversaries for a BBDB record. -Basically, you need a field named @samp{anniversary} for the BBDB record -which contains the date in the format @samp{YYYY-MM-DD} or @samp{MM-DD}, -followed by a space and the class of the anniversary (@samp{birthday}, -@samp{wedding}, or a format string). If you omit the class, it defaults to -@samp{birthday}. Here are a few examples, the header for the file -@samp{ol-bbdb.el} contains more detailed information. - -@example -1973-06-22 -06-22 -1955-08-02 wedding -2008-04-14 %s released version 6.01 of Org mode, %d years ago -@end example - -After a change to BBDB, or for the first agenda display during an -Emacs session, the agenda display suffers a short delay as Org updates -its hash with anniversaries. However, from then on things will be -very fast, much faster in fact than a long list of -@samp{%%(diary-anniversary)} entries in an Org or Diary file. - -@findex org-bbdb-anniversaries-future -If you would like to see upcoming anniversaries with a bit of -forewarning, you can use the following instead: - -@example -* Anniversaries - :PROPERTIES: - :CATEGORY: Anniv - :END: -%%(org-bbdb-anniversaries-future 3) -@end example - -That will give you three days' warning: on the anniversary date itself -and the two days prior. The argument is optional: if omitted, it -defaults to 7. - -@anchor{Appointment reminders} -@subsubheading Appointment reminders - -@cindex @file{appt.el} -@cindex appointment reminders -@cindex appointment -@cindex reminders - -@cindex APPT_WARNTIME, keyword -Org can interact with Emacs appointments notification facility. To -add the appointments of your agenda files, use the command -@code{org-agenda-to-appt}. This command lets you filter through the list -of your appointments and add only those belonging to a specific -category or matching a regular expression. It also reads -a @samp{APPT_WARNTIME} property which overrides the value of -@code{appt-message-warning-time} for this appointment. See the docstring -for details. - -@node Global TODO list -@subsection The global TODO list - -@cindex global TODO list -@cindex TODO list, global - -The global TODO list contains all unfinished TODO items formatted and -collected into a single place. - -@table @asis -@item @kbd{M-x org-agenda t} (@code{org-todo-list}) -@kindex t @r{(Agenda dispatcher)} -@findex org-todo-list -Show the global TODO list. This collects the TODO items from all -agenda files (see @ref{Agenda Views}) into a single buffer. By default, -this lists items with a state the is not a DONE state. The buffer -is in Agenda mode, so there are commands to examine and manipulate -the TODO entries directly from that buffer (see @ref{Agenda Commands}). - -@item @kbd{M-x org-agenda T} (@code{org-todo-list}) -@kindex T @r{(Agenda dispatcher)} -@findex org-todo-list -@cindex TODO keyword matching -@vindex org-todo-keywords -Like the above, but allows selection of a specific TODO keyword. -You can also do this by specifying a prefix argument to -@kbd{t}. You are prompted for a keyword, and you may also -specify several keywords by separating them with @samp{|} as the boolean -OR operator. With a numeric prefix, the Nth keyword in -@code{org-todo-keywords} is selected. - -@kindex r -The @kbd{r} key in the agenda buffer regenerates it, and you -can give a prefix argument to this command to change the selected -TODO keyword, for example @kbd{3 r}. If you often need -a search for a specific keyword, define a custom command for it (see -@ref{Agenda Dispatcher}). - -Matching specific TODO keywords can also be done as part of a tags -search (see @ref{Tag Searches}). -@end table - -Remote editing of TODO items means that you can change the state of -a TODO entry with a single key press. The commands available in the -TODO list are described in @ref{Agenda Commands}. - -@cindex sublevels, inclusion into TODO list -Normally the global TODO list simply shows all headlines with TODO -keywords. This list can become very long. There are two ways to keep -it more compact: - -@itemize -@item -@vindex org-agenda-todo-ignore-scheduled -@vindex org-agenda-todo-ignore-deadlines -@vindex org-agenda-todo-ignore-timestamp -@vindex org-agenda-todo-ignore-with-date -Some people view a TODO item that has been @emph{scheduled} for execution -or have a @emph{deadline} (see @ref{Timestamps}) as no longer @emph{open}. -Configure the variables @code{org-agenda-todo-ignore-scheduled} to -exclude some or all scheduled items from the global TODO list, -@code{org-agenda-todo-ignore-deadlines} to exclude some or all items with -a deadline set, @code{org-agenda-todo-ignore-timestamp} to exclude some -or all items with an active timestamp other than a DEADLINE or -a SCHEDULED timestamp and/or @code{org-agenda-todo-ignore-with-date} to -exclude items with at least one active timestamp. - -@item -@vindex org-agenda-todo-list-sublevels -TODO items may have sublevels to break up the task into subtasks. -In such cases it may be enough to list only the highest level TODO -headline and omit the sublevels from the global list. Configure the -variable @code{org-agenda-todo-list-sublevels} to get this behavior. -@end itemize - -@node Matching tags and properties -@subsection Matching tags and properties - -@cindex matching, of tags -@cindex matching, of properties -@cindex tags view -@cindex match view - -If headlines in the agenda files are marked with @emph{tags} (see @ref{Tags}), -or have properties (see @ref{Properties and Columns}), you can select -headlines based on this metadata and collect them into an agenda -buffer. The match syntax described here also applies when creating -sparse trees with @kbd{C-c / m}. - -@table @asis -@item @kbd{M-x org-agenda m} (@code{org-tags-view}) -@kindex m @r{(Agenda dispatcher)} -@findex org-tags-view -Produce a list of all headlines that match a given set of tags. The -command prompts for a selection criterion, which is a boolean logic -expression with tags, like @samp{+work+urgent-withboss} or @samp{work|home} -(see @ref{Tags}). If you often need a specific search, define a custom -command for it (see @ref{Agenda Dispatcher}). - -@item @kbd{M-x org-agenda M} (@code{org-tags-view}) -@kindex M @r{(Agenda dispatcher)} -@findex org-tags-view -@vindex org-tags-match-list-sublevels -@vindex org-agenda-tags-todo-honor-ignore-options -Like @kbd{m}, but only select headlines that are also TODO -items and force checking subitems (see the variable -@code{org-tags-match-list-sublevels}). To exclude scheduled/deadline -items, see the variable @code{org-agenda-tags-todo-honor-ignore-options}. -Matching specific TODO keywords together with a tags match is also -possible, see @ref{Tag Searches}. -@end table - -The commands available in the tags list are described in @ref{Agenda Commands}. - -@cindex boolean logic, for agenda searches -A search string can use Boolean operators @samp{&} for AND and @samp{|} for OR@. -@samp{&} binds more strongly than @samp{|}. Parentheses are currently not -implemented. Each element in the search is either a tag, a regular -expression matching tags, or an expression like @samp{PROPERTY OPERATOR -VALUE} with a comparison operator, accessing a property value. Each -element may be preceded by @samp{-} to select against it, and @samp{+} is -syntactic sugar for positive selection. The AND operator @samp{&} is -optional when @samp{+} or @samp{-} is present. Here are some examples, using -only tags. - -@table @asis -@item @samp{+work-boss} -Select headlines tagged @samp{work}, but discard those also tagged -@samp{boss}. - -@item @samp{work|laptop} -Selects lines tagged @samp{work} or @samp{laptop}. - -@item @samp{work|laptop+night} -Like before, but require the @samp{laptop} lines to be tagged also -@samp{night}. -@end table - -@cindex regular expressions, with tags search -Instead of a tag, you may also specify a regular expression enclosed -in curly braces. For example, @samp{work+@{^boss.*@}} matches headlines that -contain the tag @samp{:work:} and any tag @emph{starting} with @samp{boss}. - -@cindex group tags, as regular expressions -Group tags (see @ref{Tag Hierarchy}) are expanded as regular expressions. -E.g., if @samp{work} is a group tag for the group @samp{:work:lab:conf:}, then -searching for @samp{work} also searches for @samp{@{\(?:work\|lab\|conf\)@}} and -searching for @samp{-work} searches for all headlines but those with one of -the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}). - -@cindex TODO keyword matching, with tags search -@cindex level, for tags/property match -@cindex category, for tags/property match -@vindex org-odd-levels-only -You may also test for properties (see @ref{Properties and Columns}) at the -same time as matching tags. The properties may be real properties, or -special properties that represent other metadata (see @ref{Special Properties}). For example, the property @samp{TODO} represents the TODO -keyword of the entry. Or, the property @samp{LEVEL} represents the level -of an entry. So searching @samp{+LEVEL=3+boss-TODO="DONE"} lists all level -three headlines that have the tag @samp{boss} and are @emph{not} marked with the -TODO keyword @samp{DONE}. In buffers with @code{org-odd-levels-only} set, -@samp{LEVEL} does not count the number of stars, but @samp{LEVEL=2} corresponds -to 3 stars etc. - -Here are more examples: - -@table @asis -@item @samp{work+TODO="WAITING"} -Select @samp{work}-tagged TODO lines with the specific TODO keyword -@samp{WAITING}. - -@item @samp{work+TODO="WAITING"|home+TODO="WAITING"} -Waiting tasks both at work and at home. -@end table - -When matching properties, a number of different operators can be used -to test the value of a property. Here is a complex example: - -@example -+work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 - +With=@{Sarah|Denny@}+SCHEDULED>="<2008-10-11>" -@end example - -@noindent -The type of comparison depends on how the comparison value is written: - -@itemize -@item -If the comparison value is a plain number, a numerical comparison is -done, and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, @samp{>=}, and -@samp{<>}. - -@item -If the comparison value is enclosed in double-quotes, a string -comparison is done, and the same operators are allowed. - -@item -If the comparison value is enclosed in double-quotes @emph{and} angular -brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are -assumed to be date/time specifications in the standard Org way, and -the comparison is done accordingly. Valid values also include -@samp{"<now>"} for now (including time), @samp{"<today>"}, and @samp{"<tomorrow>"} -for these days at 0:00 hours, i.e., without a time specification. -You can also use strings like @samp{"<+5d>"} or @samp{"<-2m>"} with units @samp{d}, -@samp{w}, @samp{m}, and @samp{y} for day, week, month, and year, respectively. - -@item -If the comparison value is enclosed in curly braces, a regexp match -is performed, with @samp{=} meaning that the regexp matches the property -value, and @samp{<>} meaning that it does not match. -@end itemize - -So the search string in the example finds entries tagged @samp{work} but -not @samp{boss}, which also have a priority value @samp{A}, a @samp{Coffee} property -with the value @samp{unlimited}, an @samp{EFFORT} property that is numerically -smaller than 2, a @samp{With} property that is matched by the regular -expression @samp{Sarah|Denny}, and that are scheduled on or after October -11, 2008. - -You can configure Org mode to use property inheritance during -a search, but beware that this can slow down searches considerably. -See @ref{Property Inheritance}, for details. - -For backward compatibility, and also for typing speed, there is also -a different way to test TODO states in a search. For this, terminate -the tags/property part of the search string (which may include several -terms connected with @samp{|}) with a @samp{/} and then specify a Boolean -expression just for TODO keywords. The syntax is then similar to that -for tags, but should be applied with care: for example, a positive -selection on several TODO keywords cannot meaningfully be combined -with boolean AND@. However, @emph{negative selection} combined with AND can -be meaningful. To make sure that only lines are checked that actually -have any TODO keyword (resulting in a speed-up), use @kbd{M-x org-agenda M}, or equivalently start the TODO part after the slash -with @samp{!}. Using @kbd{M-x org-agenda M} or @samp{/!} does not match -TODO keywords in a DONE state. Examples: - -@table @asis -@item @samp{work/WAITING} -Same as @samp{work+TODO="WAITING"}. - -@item @samp{work/!-WAITING-NEXT} -Select @samp{work}-tagged TODO lines that are neither @samp{WAITING} nor -@samp{NEXT}. - -@item @samp{work/!+WAITING|+NEXT} -Select @samp{work}-tagged TODO lines that are either @samp{WAITING} or @samp{NEXT}. -@end table - -@node Search view -@subsection Search view - -@cindex search view -@cindex text search -@cindex searching, for text - -This agenda view is a general text search facility for Org mode -entries. It is particularly useful to find notes. - -@table @asis -@item @kbd{M-x org-agenda s} (@code{org-search-view}) -@kindex s @r{(Agenda dispatcher)} -@findex org-search-view -This is a special search that lets you select entries by matching -a substring or specific words using a boolean logic. -@end table - -For example, the search string @samp{computer equipment} matches entries -that contain @samp{computer equipment} as a substring, even if the two -words are separated by more space or a line break. - -Search view can also search for specific keywords in the entry, using -Boolean logic. The search string @samp{+computer -+wifi -ethernet -@{8\.11[bg]@}} matches note entries that contain the -keywords @samp{computer} and @samp{wifi}, but not the keyword @samp{ethernet}, and -which are also not matched by the regular expression @samp{8\.11[bg]}, -meaning to exclude both @samp{8.11b} and @samp{8.11g}. The first @samp{+} is -necessary to turn on boolean search, other @samp{+} characters are -optional. For more details, see the docstring of the command -@code{org-search-view}. - -You can incrementally and conveniently adjust a boolean search from -the agenda search view with the following keys - -@multitable @columnfractions 0.1 0.6 -@item @kbd{[} -@tab Add a positive search word -@item @kbd{]} -@tab Add a negative search word -@item @kbd{@{} -@tab Add a positive regular expression -@item @kbd{@}} -@tab Add a negative regular expression -@end multitable - -@vindex org-agenda-text-search-extra-files -Note that in addition to the agenda files, this command also searches -the files listed in @code{org-agenda-text-search-extra-files}. - -@node Stuck projects -@subsection Stuck projects - -@pindex GTD, Getting Things Done - -If you are following a system like David Allen's GTD to organize your -work, one of the ``duties'' you have is a regular review to make sure -that all projects move along. A @emph{stuck} project is a project that has -no defined next actions, so it never shows up in the TODO lists Org -mode produces. During the review, you need to identify such projects -and define next actions for them. - -@table @asis -@item @kbd{M-x org-agenda #} (@code{org-agenda-list-stuck-projects}) -@kindex # @r{(Agenda dispatcher)} -@findex org-agenda-list-stuck-projects -List projects that are stuck. - -@item @kbd{M-x org-agenda !} -@kindex ! @r{(Agenda dispatcher)} -@vindex org-stuck-projects -Customize the variable @code{org-stuck-projects} to define what a stuck -project is and how to find it. -@end table - -You almost certainly need to configure this view before it works for -you. The built-in default assumes that all your projects are level-2 -headlines, and that a project is not stuck if it has at least one -entry marked with a TODO keyword @samp{TODO} or @samp{NEXT} or @samp{NEXTACTION}. - -Let's assume that you, in your own way of using Org mode, identify -projects with a tag @samp{:PROJECT:}, and that you use a TODO keyword -@samp{MAYBE} to indicate a project that should not be considered yet. -Let's further assume that the TODO keyword @samp{DONE} marks finished -projects, and that @samp{NEXT} and @samp{TODO} indicate next actions. The tag -@samp{:@@shop:} indicates shopping and is a next action even without the -NEXT tag. Finally, if the project contains the special word @samp{IGNORE} -anywhere, it should not be listed either. In this case you would -start by identifying eligible projects with a tags/TODO match (see -@ref{Tag Searches}) @samp{+PROJECT/-MAYBE-DONE}, and then check for @samp{TODO}, -@samp{NEXT}, @samp{@@shop}, and @samp{IGNORE} in the subtree to identify projects that -are not stuck. The correct customization for this is: - -@lisp -(setq org-stuck-projects - '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@shop") - "\\<IGNORE\\>")) -@end lisp - -Note that if a project is identified as non-stuck, the subtree of this -entry is searched for stuck projects. - -@node Presentation and Sorting -@section Presentation and Sorting - -@cindex presentation, of agenda items - -@vindex org-agenda-prefix-format -@vindex org-agenda-tags-column -Before displaying items in an agenda view, Org mode visually prepares -the items and sorts them. Each item occupies a single line. The line -starts with a @emph{prefix} that contains the @emph{category} (see @ref{Categories}) -of the item and other important information. You can customize in -which column tags are displayed through @code{org-agenda-tags-column}. You -can also customize the prefix using the option -@code{org-agenda-prefix-format}. This prefix is followed by a cleaned-up -version of the outline headline associated with the item. - -@menu -* Categories:: Not all tasks are equal. -* Time-of-day specifications:: How the agenda knows the time. -* Sorting of agenda items:: The order of things. -* Filtering/limiting agenda items:: Dynamically narrow the agenda. -@end menu - -@node Categories -@subsection Categories - -@cindex category -@cindex @samp{CATEGORY}, keyword - -The category is a broad label assigned to each agenda item. By -default, the category is simply derived from the file name, but you -can also specify it with a special line in the buffer, like -this: - -@example -#+CATEGORY: Thesis -@end example - - -@cindex @samp{CATEGORY}, property -If you would like to have a special category for a single entry or -a (sub)tree, give the entry a @samp{CATEGORY} property with the special -category you want to apply as the value. - -@vindex org-agenda-category-icon-alist -The display in the agenda buffer looks best if the category is not -longer than 10 characters. You can set up icons for category by -customizing the @code{org-agenda-category-icon-alist} variable. - -@node Time-of-day specifications -@subsection Time-of-day specifications - -@cindex time-of-day specification - -Org mode checks each agenda item for a time-of-day specification. The -time can be part of the timestamp that triggered inclusion into the -agenda, for example - -@example -<2005-05-10 Tue 19:00> -@end example - - -@noindent -Time ranges can be specified with two timestamps: - -@example -<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15> -@end example - - -@vindex org-agenda-search-headline-for-time -In the headline of the entry itself, a time(range)---like @samp{12:45} or -a @samp{8:30-1pm}---may also appear as plain text@footnote{You can, however, disable this by setting -@code{org-agenda-search-headline-for-time} variable to a @code{nil} value.}. - -If the agenda integrates the Emacs diary (see @ref{Weekly/daily agenda}), -time specifications in diary entries are recognized as well. - -For agenda display, Org mode extracts the time and displays it in -a standard 24 hour format as part of the prefix. The example times in -the previous paragraphs would end up in the agenda like this: - -@example - 8:30-13:00 Arthur Dent lies in front of the bulldozer -12:45...... Ford Prefect arrives and takes Arthur to the pub -19:00...... The Vogon reads his poem -20:30-22:15 Marvin escorts the Hitchhikers to the bridge -@end example - -@cindex time grid -If the agenda is in single-day mode, or for the display of today, the -timed entries are embedded in a time grid, like - -@example - 8:00...... ------------------ - 8:30-13:00 Arthur Dent lies in front of the bulldozer -10:00...... ------------------ -12:00...... ------------------ -12:45...... Ford Prefect arrives and takes Arthur to the pub -14:00...... ------------------ -16:00...... ------------------ -18:00...... ------------------ -19:00...... The Vogon reads his poem -20:00...... ------------------ -20:30-22:15 Marvin escorts the Hitchhikers to the bridge -@end example - -@vindex org-agenda-use-time-grid -@vindex org-agenda-time-grid -The time grid can be turned on and off with the variable -@code{org-agenda-use-time-grid}, and can be configured with -@code{org-agenda-time-grid}. - -@node Sorting of agenda items -@subsection Sorting of agenda items - -@cindex sorting, of agenda items -@cindex priorities, of agenda items - -Before being inserted into a view, the items are sorted. How this is -done depends on the type of view. - -@itemize -@item -@vindex org-agenda-files -For the daily/weekly agenda, the items for each day are sorted. The -default order is to first collect all items containing an explicit -time-of-day specification. These entries are shown at the beginning -of the list, as a @emph{schedule} for the day. After that, items remain -grouped in categories, in the sequence given by @code{org-agenda-files}. -Within each category, items are sorted by priority (see -@ref{Priorities}), which is composed of the base priority (2000 for -priority @samp{A}, 1000 for @samp{B}, and 0 for @samp{C}), plus additional -increments for overdue scheduled or deadline items. - -@item -For the TODO list, items remain in the order of categories, but -within each category, sorting takes place according to priority (see -@ref{Priorities}). The priority used for sorting derives from the -priority cookie, with additions depending on how close an item is to -its due or scheduled date. - -@item -For tags matches, items are not sorted at all, but just appear in -the sequence in which they are found in the agenda files. -@end itemize - -@vindex org-agenda-sorting-strategy -Sorting can be customized using the variable -@code{org-agenda-sorting-strategy}, and may also include criteria based on -the estimated effort of an entry (see @ref{Effort Estimates}). - -@node Filtering/limiting agenda items -@subsection Filtering/limiting agenda items - -@vindex org-agenda-category-filter-preset -@vindex org-agenda-tag-filter-preset -@vindex org-agenda-effort-filter-preset -@vindex org-agenda-regexp-filter-preset -Agenda built-in or custom commands are statically defined. Agenda -filters and limits allow to flexibly narrow down the list of agenda -entries. - -@emph{Filters} only change the visibility of items, are very fast and are -mostly used interactively@footnote{Custom agenda commands can preset a filter by binding one of -the variables @code{org-agenda-tag-filter-preset}, -@code{org-agenda-category-filter-preset}, @code{org-agenda-effort-filter-preset} -or @code{org-agenda-regexp-filter-preset} as an option. This filter is -then applied to the view and persists as a basic filter through -refreshes and more secondary filtering. The filter is a global -property of the entire agenda view---in a block agenda, you should -only set this in the global options section, not in the section of an -individual block.}. You can switch quickly between -different filters without having to recreate the agenda. @emph{Limits} on -the other hand take effect before the agenda buffer is populated, so -they are mostly useful when defined as local variables within custom -agenda commands. - -@anchor{Filtering in the agenda} -@subsubheading Filtering in the agenda - -@cindex agenda filtering -@cindex filtering entries, in agenda -@cindex tag filtering, in agenda -@cindex category filtering, in agenda -@cindex top headline filtering, in agenda -@cindex effort filtering, in agenda -@cindex query editing, in agenda - -The general filtering command is @code{org-agenda-filter}, bound to -@kbd{/}. Before we introduce it, we describe commands for -individual filter types. All filtering commands handle prefix -arguments in the same way: A single @kbd{C-u} prefix negates the -filter, so it removes lines selected by the filter. A double prefix -adds the new filter condition to the one(s) already in place, so -filter elements are accumulated. - -@table @asis -@item @kbd{\} (@code{org-agenda-filter-by-tag}) -@findex org-agenda-filter-by-tag -Filter the agenda view with respect to a tag. You are prompted for -a tag selection letter; @kbd{@key{SPC}} means any tag at all. -Pressing @kbd{@key{TAB}} at that prompt offers completion to select a -tag, including any tags that do not have a selection character. The -command then hides all entries that do not contain or inherit this -tag. Pressing @kbd{+} or @kbd{-} at the prompt switches -between filtering for and against the next tag. To clear the -filter, press @kbd{\} twice (once to call the command again, -and once at the prompt). - -@item @kbd{<} (@code{org-agenda-filter-by-category}) -@findex org-agenda-filter-by-category -Filter by category of the line at point, and show only entries with -this category. When called with a prefix argument, hide all entries -with the category at point. To clear the filter, call this command -again by pressing @kbd{<}. - -@item @kbd{=} (@code{org-agenda-filter-by-regexp}) -@findex org-agenda-filter-by-regexp -Filter the agenda view by a regular expression: only show agenda -entries matching the regular expression the user entered. To clear -the filter, call the command again by pressing @kbd{=}. - -@item @kbd{_} (@code{org-agenda-filter-by-effort}) -@findex org-agenda-filter-by-effort -Filter the agenda view with respect to effort estimates, so select -tasks that take the right amount of time. You first need to set up -a list of efforts globally, for example - -@lisp -(setq org-global-properties - '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) -@end lisp - -@vindex org-sort-agenda-noeffort-is-high -You can then filter for an effort by first typing an operator, one -of @kbd{<}, @kbd{>} and @kbd{=}, and then the -one-digit index of an effort estimate in your array of allowed -values, where @kbd{0} means the 10th value. The filter then -restricts to entries with effort smaller-or-equal, equal, or -larger-or-equal than the selected value. For application of the -operator, entries without a defined effort are treated according to -the value of @code{org-sort-agenda-noeffort-is-high}. To clear the -filter, press @kbd{_} twice (once to call the command again, -and once at the first prompt). - -@item @kbd{^} (@code{org-agenda-filter-by-top-headline}) -@findex org-agenda-filter-by-top-headline -Filter the current agenda view and only display items that fall -under the same top-level headline as the current entry. To clear -the filter, call this command again by pressing @kbd{^}. - -@item @kbd{/} (@code{org-agenda-filter}) -@findex org-agenda-filter -This is the unified interface to four of the five filter methods -described above. At the prompt, specify different filter elements -in a single string, with full completion support. For example, - -@example -+work-John+<0:10-/plot/ -@end example - - -selects entries with category @samp{work} and effort estimates below 10 -minutes, and deselects entries with tag @samp{John} or matching the -regexp @samp{plot}. You can leave @samp{+} out if that does not lead to -ambiguities. The sequence of elements is arbitrary. The filter -syntax assumes that there is no overlap between categories and tags. -Otherwise, tags take priority. If you reply to the prompt with the -empty string, all filtering is removed. If a filter is specified, -it replaces all current filters. But if you call the command with -a double prefix argument, or if you add an additional @samp{+} (e.g., -@samp{++work}) to the front of the string, the new filter elements are -added to the active ones. A single prefix argument applies the -entire filter in a negative sense. - -@item @kbd{|} (@code{org-agenda-filter-remove-all}) -Remove all filters in the current agenda view. -@end table - -@anchor{Computed tag filtering} -@subsubheading Computed tag filtering - -@vindex org-agenda-auto-exclude-function -If the variable @code{org-agenda-auto-exclude-function} is set to -a user-defined function, that function can select tags that should be -used as a tag filter when requested. The function will be called with -lower-case versions of all tags represented in the current view. The -function should return @samp{"-tag"} if the filter should remove -entries with that tag, @samp{"+tag"} if only entries with this tag should -be kept, or @samp{nil} if that tag is irrelevant. For example, let's say -you use a @samp{Net} tag to identify tasks which need network access, an -@samp{Errand} tag for errands in town, and a @samp{Call} tag for making phone -calls. You could auto-exclude these tags based on the availability of -the Internet, and outside of business hours, with something like this: - -@lisp -(defun my-auto-exclude-fn (tag) - (when (cond ((string= tag "net") - (/= 0 (call-process "/sbin/ping" nil nil nil - "-c1" "-q" "-t1" "mail.gnu.org"))) - ((member tag '("errand" "call")) - (let ((hr (nth 2 (decode-time)))) - (or (< hr 8) (> hr 21))))) - (concat "-" tag))) - -(setq org-agenda-auto-exclude-function #'my-auto-exclude-fn) -@end lisp - -You can apply this self-adapting filter by using a triple prefix -argument to @code{org-agenda-filter}, i.e.@tie{}press @kbd{C-u C-u C-u /}, -or by pressing @kbd{@key{RET}} in @code{org-agenda-filter-by-tag}. - -@anchor{Setting limits for the agenda} -@subsubheading Setting limits for the agenda - -@cindex limits, in agenda - -Here is a list of options that you can set, either globally, or -locally in your custom agenda views (see @ref{Custom Agenda Views}). - -@table @asis -@item @code{org-agenda-max-entries} -@vindex org-agenda-max-entries -Limit the number of entries. - -@item @code{org-agenda-max-effort} -@vindex org-agenda-max-effort -Limit the duration of accumulated efforts (as minutes). - -@item @code{org-agenda-max-todos} -@vindex org-agenda-max-todos -Limit the number of entries with TODO keywords. - -@item @code{org-agenda-max-tags} -@vindex org-agenda-max-tags -Limit the number of tagged entries. -@end table - -When set to a positive integer, each option excludes entries from -other categories: for example, @samp{(setq org-agenda-max-effort 100)} -limits the agenda to 100 minutes of effort and exclude any entry that -has no effort property. If you want to include entries with no effort -property, use a negative value for @code{org-agenda-max-effort}. One -useful setup is to use @code{org-agenda-max-entries} locally in a custom -command. For example, this custom command displays the next five -entries with a @samp{NEXT} TODO keyword. - -@lisp -(setq org-agenda-custom-commands - '(("n" todo "NEXT" - ((org-agenda-max-entries 5))))) -@end lisp - -Once you mark one of these five entry as DONE, rebuilding the agenda -will again the next five entries again, including the first entry that -was excluded so far. - -You can also dynamically set temporary limits, which are lost when -rebuilding the agenda: - -@table @asis -@item @kbd{~} (@code{org-agenda-limit-interactively}) -@findex org-agenda-limit-interactively -This prompts for the type of limit to apply and its value. -@end table - -@node Agenda Commands -@section Commands in the Agenda Buffer - -@cindex commands, in agenda buffer - -Entries in the agenda buffer are linked back to the Org file or diary -file where they originate. You are not allowed to edit the agenda -buffer itself, but commands are provided to show and jump to the -original entry location, and to edit the Org files ``remotely'' from the -agenda buffer. In this way, all information is stored only once, -removing the risk that your agenda and note files may diverge. - -Some commands can be executed with mouse clicks on agenda lines. For -the other commands, point needs to be in the desired line. - -@anchor{Motion (1)} -@subheading Motion - -@cindex motion commands in agenda - -@table @asis -@item @kbd{n} (@code{org-agenda-next-line}) -@kindex n -@findex org-agenda-next-line -Next line (same as @kbd{@key{DOWN}} and @kbd{C-n}). - -@item @kbd{p} (@code{org-agenda-previous-line}) -@kindex p -@findex org-agenda-previous-line -Previous line (same as @kbd{@key{UP}} and @kbd{C-p}). -@end table - -@anchor{View/Go to Org file} -@subheading View/Go to Org file - -@cindex view file commands in agenda - -@table @asis -@item @kbd{@key{SPC}} or @kbd{mouse-3} (@code{org-agenda-show-and-scroll-up}) -@kindex SPC -@kindex mouse-3 -@findex org-agenda-show-and-scroll-up -Display the original location of the item in another window. -With a prefix argument, make sure that drawers stay folded. - -@item @kbd{L} (@code{org-agenda-recenter}) -@findex org-agenda-recenter -Display original location and recenter that window. - -@item @kbd{@key{TAB}} or @kbd{mouse-2} (@code{org-agenda-goto}) -@kindex TAB -@kindex mouse-2 -@findex org-agenda-goto -Go to the original location of the item in another window. - -@item @kbd{@key{RET}} (@code{org-agenda-switch-to}) -@kindex RET -@findex org-agenda-switch-to -Go to the original location of the item and delete other windows. - -@item @kbd{F} (@code{org-agenda-follow-mode}) -@kindex F -@findex org-agenda-follow-mode -@vindex org-agenda-start-with-follow-mode -Toggle Follow mode. In Follow mode, as you move point through the -agenda buffer, the other window always shows the corresponding -location in the Org file. The initial setting for this mode in new -agenda buffers can be set with the variable -@code{org-agenda-start-with-follow-mode}. - -@item @kbd{C-c C-x b} (@code{org-agenda-tree-to-indirect-buffer}) -@kindex C-c C-x b -@findex org-agenda-tree-to-indirect-buffer -Display the entire subtree of the current item in an indirect -buffer. With a numeric prefix argument N, go up to level N and then -take that tree. If N is negative, go up that many levels. With -a @kbd{C-u} prefix, do not remove the previously used indirect -buffer. - -@item @kbd{C-c C-o} (@code{org-agenda-open-link}) -@kindex C-c C-o -@findex org-agenda-open-link -Follow a link in the entry. This offers a selection of any links in -the text belonging to the referenced Org node. If there is only one -link, follow it without a selection prompt. -@end table - -@anchor{Change display} -@subheading Change display - -@cindex change agenda display -@cindex display changing, in agenda - -@table @asis -@item @kbd{A} -@kindex A -Interactively select another agenda view and append it to the -current view. - -@item @kbd{o} -@kindex o -Delete other windows. - -@item @kbd{v d} or short @kbd{d} (@code{org-agenda-day-view}) -@kindex v d -@kindex d -@findex org-agenda-day-view -Switch to day view. When switching to day view, this setting -becomes the default for subsequent agenda refreshes. A numeric -prefix argument may be used to jump directly to a specific day of -the year. For example, @kbd{32 d} jumps to February 1st. When -setting day view, a year may be encoded in the prefix argument as -well. For example, @kbd{200712 d} jumps to January 12, 2007. -If such a year specification has only one or two digits, it is -expanded into one of the 30 next years or the last 69 years. - -@item @kbd{v w} or short @kbd{w} (@code{org-agenda-week-view}) -@kindex v w -@kindex w -@findex org-agenda-week-view -Switch to week view. When switching week view, this setting becomes -the default for subsequent agenda refreshes. A numeric prefix -argument may be used to jump directly to a specific day of the ISO -week. For example @kbd{9 w} to ISO week number 9. When -setting week view, a year may be encoded in the prefix argument as -well. For example, @kbd{200712 w} jumps to week 12 in 2007. -If such a year specification has only one or two digits, it is -expanded into one of the 30 next years or the last 69 years. - -@item @kbd{v m} (@code{org-agenda-month-view}) -@kindex v m -@findex org-agenda-month-view -Switch to month view. Because month views are slow to create, they -do not become the default for subsequent agenda refreshes. -A numeric prefix argument may be used to jump directly to a specific -day of the month. When setting month view, a year may be encoded in -the prefix argument as well. For example, @kbd{200712 m} jumps -to December, 2007. If such a year specification has only one or two -digits, it is expanded into one of the 30 next years or the last 69 -years. - -@item @kbd{v y} (@code{org-agenda-year-view}) -@kindex v y -@findex org-agenda-year-view -Switch to year view. Because year views are slow to create, they do -not become the default for subsequent agenda refreshes. A numeric -prefix argument may be used to jump directly to a specific day of -the year. - -@item @kbd{v @key{SPC}} (@code{org-agenda-reset-view}) -@kindex v SPC -@findex org-agenda-reset-view -@vindex org-agenda-span -Reset the current view to @code{org-agenda-span}. - -@item @kbd{f} (@code{org-agenda-later}) -@kindex f -@findex org-agenda-later -Go forward in time to display the span following the current one. -For example, if the display covers a week, switch to the following -week. With a prefix argument, repeat that many times. - -@item @kbd{b} (@code{org-agenda-earlier}) -@kindex b -@findex org-agenda-earlier -Go backward in time to display earlier dates. - -@item @kbd{.} (@code{org-agenda-goto-today}) -@kindex . -@findex org-agenda-goto-today -Go to today. - -@item @kbd{j} (@code{org-agenda-goto-date}) -@kindex j -@findex org-agenda-goto-date -Prompt for a date and go there. - -@item @kbd{J} (@code{org-agenda-clock-goto}) -@kindex J -@findex org-agenda-clock-goto -Go to the currently clocked-in task @emph{in the agenda buffer}. - -@item @kbd{D} (@code{org-agenda-toggle-diary}) -@kindex D -@findex org-agenda-toggle-diary -Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. - -@item @kbd{v l} or @kbd{v L} or short @kbd{l} (@code{org-agenda-log-mode}) -@kindex v l -@kindex l -@kindex v L -@findex org-agenda-log-mode -@vindex org-log-done -@vindex org-agenda-log-mode-items -Toggle Logbook mode. In Logbook mode, entries that were marked as -done while logging was on (see the variable @code{org-log-done}) are -shown in the agenda, as are entries that have been clocked on that -day. You can configure the entry types that should be included in -log mode using the variable @code{org-agenda-log-mode-items}. When -called with a @kbd{C-u} prefix argument, show all possible -logbook entries, including state changes. When called with two -prefix arguments @kbd{C-u C-u}, show only logging information, -nothing else. @kbd{v L} is equivalent to @kbd{C-u v l}. - -@item @kbd{v [} or short @kbd{[} (@code{org-agenda-manipulate-query-add}) -@kindex v [ -@kindex [ -@findex org-agenda-manipulate-query-add -Include inactive timestamps into the current view. Only for -weekly/daily agenda. - -@item @kbd{v a} (@code{org-agenda-archives-mode}) -@kindex v a -@findex org-agenda-archives-mode -Toggle Archives mode. In Archives mode, trees that are archived -(see @ref{Internal archiving}) are also scanned when producing the -agenda. To exit archives mode, press @kbd{v a} again. - -@item @kbd{v A} -@kindex v A -Toggle Archives mode. Include all archive files as well. - -@item @kbd{v R} or short @kbd{R} (@code{org-agenda-clockreport-mode}) -@kindex v R -@kindex R -@findex org-agenda-clockreport-mode -@vindex org-agenda-start-with-clockreport-mode -@vindex org-clock-report-include-clocking-task -Toggle Clockreport mode. In Clockreport mode, the daily/weekly -agenda always shows a table with the clocked times for the time span -and file scope covered by the current agenda view. The initial -setting for this mode in new agenda buffers can be set with the -variable @code{org-agenda-start-with-clockreport-mode}. By using -a prefix argument when toggling this mode (i.e., @kbd{C-u R}), -the clock table does not show contributions from entries that are -hidden by agenda filtering@footnote{Only tags filtering is respected here, effort filtering is -ignored.}. See also the variable -@code{org-clock-report-include-clocking-task}. - -@item @kbd{v c} -@kindex v c -@vindex org-agenda-clock-consistency-checks -Show overlapping clock entries, clocking gaps, and other clocking -problems in the current agenda range. You can then visit clocking -lines and fix them manually. See the variable -@code{org-agenda-clock-consistency-checks} for information on how to -customize the definition of what constituted a clocking problem. To -return to normal agenda display, press @kbd{l} to exit Logbook -mode. - -@item @kbd{v E} or short @kbd{E} (@code{org-agenda-entry-text-mode}) -@kindex v E -@kindex E -@findex org-agenda-entry-text-mode -@vindex org-agenda-start-with-entry-text-mode -@vindex org-agenda-entry-text-maxlines -Toggle entry text mode. In entry text mode, a number of lines from -the Org outline node referenced by an agenda line are displayed -below the line. The maximum number of lines is given by the -variable @code{org-agenda-entry-text-maxlines}. Calling this command -with a numeric prefix argument temporarily modifies that number to -the prefix value. - -@item @kbd{G} (@code{org-agenda-toggle-time-grid}) -@kindex G -@vindex org-agenda-use-time-grid -@vindex org-agenda-time-grid -Toggle the time grid on and off. See also the variables -@code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. - -@item @kbd{r} (@code{org-agenda-redo}) -@itemx @kbd{g} -@kindex r -@kindex g -@findex org-agenda-redo -Recreate the agenda buffer, for example to reflect the changes after -modification of the timestamps of items with @kbd{S-@key{LEFT}} and -@kbd{S-@key{RIGHT}}. When the buffer is the global TODO list, -a prefix argument is interpreted to create a selective list for -a specific TODO keyword. - -@item @kbd{C-x C-s} or short @kbd{s} (@code{org-save-all-org-buffers}) -@kindex C-x C-s -@findex org-save-all-org-buffers -@kindex s -Save all Org buffers in the current Emacs session, and also the -locations of IDs. - -@item @kbd{C-c C-x C-c} (@code{org-agenda-columns}) -@kindex C-c C-x C-c -@findex org-agenda-columns -@vindex org-columns-default-format -Invoke column view (see @ref{Column View}) in the agenda buffer. The -column view format is taken from the entry at point, or, if there is -no entry at point, from the first entry in the agenda view. So -whatever the format for that entry would be in the original buffer -(taken from a property, from a @samp{COLUMNS} keyword, or from the -default variable @code{org-columns-default-format}) is used in the -agenda. - -@item @kbd{C-c C-x >} (@code{org-agenda-remove-restriction-lock}) -@kindex C-c C-x > -@findex org-agenda-remove-restriction-lock -Remove the restriction lock on the agenda, if it is currently -restricted to a file or subtree (see @ref{Agenda Files}). - -@item @kbd{M-@key{UP}} (@code{org-agenda-drag-line-backward}) -@kindex M-UP -@findex org-agenda-drag-line-backward -Drag the line at point backward one line. With a numeric prefix -argument, drag backward by that many lines. - -Moving agenda lines does not persist after an agenda refresh and -does not modify the contributing Org files. - -@item @kbd{M-@key{DOWN}} (@code{org-agenda-drag-line-forward}) -@kindex M-DOWN -@findex org-agenda-drag-line-forward -Drag the line at point forward one line. With a numeric prefix -argument, drag forward by that many lines. -@end table - -@anchor{Remote editing} -@subheading Remote editing - -@cindex remote editing, from agenda - -@table @asis -@item @kbd{0--9} -Digit argument. - -@item @kbd{C-_} (@code{org-agenda-undo}) -@kindex C-_ -@findex org-agenda-undo -@cindex undoing remote-editing events -@cindex remote editing, undo -Undo a change due to a remote editing command. The change is undone -both in the agenda buffer and in the remote buffer. - -@item @kbd{t} (@code{org-agenda-todo}) -@kindex t -@findex org-agenda-todo -Change the TODO state of the item, both in the agenda and in the -original Org file. A prefix arg is passed through to the @code{org-todo} -command, so for example a @kbd{C-u} prefix are will trigger -taking a note to document the state change. - -@item @kbd{C-S-@key{RIGHT}} (@code{org-agenda-todo-nextset}) -@kindex C-S-RIGHT -@findex org-agenda-todo-nextset -Switch to the next set of TODO keywords. - -@item @kbd{C-S-@key{LEFT}}, @code{org-agenda-todo-previousset} -@kindex C-S-LEFT -Switch to the previous set of TODO keywords. - -@item @kbd{C-k} (@code{org-agenda-kill}) -@kindex C-k -@findex org-agenda-kill -@vindex org-agenda-confirm-kill -Delete the current agenda item along with the entire subtree -belonging to it in the original Org file. If the text to be deleted -remotely is longer than one line, the kill needs to be confirmed by -the user. See variable @code{org-agenda-confirm-kill}. - -@item @kbd{C-c C-w} (@code{org-agenda-refile}) -@kindex C-c C-w -@findex org-agenda-refile -Refile the entry at point. - -@item @kbd{C-c C-x C-a} or short @kbd{a} (@code{org-agenda-archive-default-with-confirmation}) -@kindex C-c C-x C-a -@kindex a -@findex org-agenda-archive-default-with-confirmation -@vindex org-archive-default-command -Archive the subtree corresponding to the entry at point using the -default archiving command set in @code{org-archive-default-command}. -When using the @kbd{a} key, confirmation is required. - -@item @kbd{C-c C-x a} (@code{org-agenda-toggle-archive-tag}) -@kindex C-c C-x a -@findex org-agenda-toggle-archive-tag -Toggle the archive tag (see @ref{Internal archiving}) for the current -headline. - -@item @kbd{C-c C-x A} (@code{org-agenda-archive-to-archive-sibling}) -@kindex C-c C-x A -@findex org-agenda-archive-to-archive-sibling -Move the subtree corresponding to the current entry to its @emph{archive -sibling}. - -@item @kbd{C-c C-x C-s} or short @kbd{$} (@code{org-agenda-archive}) -@kindex C-c C-x C-s -@kindex $ -@findex org-agenda-archive -Archive the subtree corresponding to the current headline. This -means the entry is moved to the configured archive location, most -likely a different file. - -@item @kbd{T} (@code{org-agenda-show-tags}) -@kindex T -@findex org-agenda-show-tags -@vindex org-agenda-show-inherited-tags -Show all tags associated with the current item. This is useful if -you have turned off @code{org-agenda-show-inherited-tags}, but still want -to see all tags of a headline occasionally. - -@item @kbd{:} (@code{org-agenda-set-tags}) -@kindex : -@findex org-agenda-set-tags -Set tags for the current headline. If there is an active region in -the agenda, change a tag for all headings in the region. - -@item @kbd{,} (@code{org-agenda-priority}) -@kindex , -@findex org-agenda-priority -Set the priority for the current item. Org mode prompts for the -priority character. If you reply with @kbd{@key{SPC}}, the priority -cookie is removed from the entry. - -@item @kbd{+} or @kbd{S-@key{UP}} (@code{org-agenda-priority-up}) -@kindex + -@kindex S-UP -@findex org-agenda-priority-up -Increase the priority of the current item. The priority is changed -in the original buffer, but the agenda is not resorted. Use the -@kbd{r} key for this. - -@item @kbd{-} or @kbd{S-@key{DOWN}} (@code{org-agenda-priority-down}) -@kindex - -@kindex S-DOWN -@findex org-agenda-priority-down -Decrease the priority of the current item. - -@item @kbd{C-c C-x e} or short @kbd{e} (@code{org-agenda-set-effort}) -@kindex e -@kindex C-c C-x e -@findex org-agenda-set-effort -Set the effort property for the current item. - -@item @kbd{C-c C-z} or short @kbd{z} (@code{org-agenda-add-note}) -@kindex z -@kindex C-c C-z -@findex org-agenda-add-note -@vindex org-log-into-drawer -Add a note to the entry. This note is recorded, and then filed to -the same location where state change notes are put. Depending on -@code{org-log-into-drawer}, this may be inside a drawer. - -@item @kbd{C-c C-a} (@code{org-attach}) -@kindex C-c C-a -@findex org-attach -Dispatcher for all command related to attachments. - -@item @kbd{C-c C-s} (@code{org-agenda-schedule}) -@kindex C-c C-s -@findex org-agenda-schedule -Schedule this item. With a prefix argument, remove the -scheduling timestamp - -@item @kbd{C-c C-d} (@code{org-agenda-deadline}) -@kindex C-c C-d -@findex org-agenda-deadline -Set a deadline for this item. With a prefix argument, remove the -deadline. - -@item @kbd{S-@key{RIGHT}} (@code{org-agenda-do-date-later}) -@kindex S-RIGHT -@findex org-agenda-do-date-later -Change the timestamp associated with the current line by one day -into the future. If the date is in the past, the first call to this -command moves it to today. With a numeric prefix argument, change -it by that many days. For example, @kbd{3 6 5 S-@key{RIGHT}} changes -it by a year. With a @kbd{C-u} prefix, change the time by one -hour. If you immediately repeat the command, it will continue to -change hours even without the prefix argument. With a double -@kbd{C-u C-u} prefix, do the same for changing minutes. The -stamp is changed in the original Org file, but the change is not -directly reflected in the agenda buffer. Use @kbd{r} or -@kbd{g} to update the buffer. - -@item @kbd{S-@key{LEFT}} (@code{org-agenda-do-date-earlier}) -@kindex S-LEFT -@findex org-agenda-do-date-earlier -Change the timestamp associated with the current line by one day -into the past. - -@item @kbd{>} (@code{org-agenda-date-prompt}) -@kindex > -@findex org-agenda-date-prompt -Change the timestamp associated with the current line. The key -@kbd{>} has been chosen, because it is the same as -@kbd{S-.} on my keyboard. - -@item @kbd{I} (@code{org-agenda-clock-in}) -@kindex I -@findex org-agenda-clock-in -Start the clock on the current item. If a clock is running already, -it is stopped first. - -@item @kbd{O} (@code{org-agenda-clock-out}) -@kindex O -@findex org-agenda-clock-out -Stop the previously started clock. - -@item @kbd{X} (@code{org-agenda-clock-cancel}) -@kindex X -@findex org-agenda-clock-cancel -Cancel the currently running clock. - -@item @kbd{J} (@code{org-agenda-clock-goto}) -@kindex J -@findex org-agenda-clock-goto -Jump to the running clock in another window. - -@item @kbd{k} (@code{org-agenda-capture}) -@kindex k -@findex org-agenda-capture -@cindex capturing, from agenda -@vindex org-capture-use-agenda-date -Like @code{org-capture}, but use the date at point as the default date -for the capture template. See @code{org-capture-use-agenda-date} to make -this the default behavior of @code{org-capture}. -@end table - -@anchor{Bulk remote editing selected entries} -@subheading Bulk remote editing selected entries - -@cindex remote editing, bulk, from agenda -@vindex org-agenda-bulk-custom-functions - -@table @asis -@item @kbd{m} (@code{org-agenda-bulk-mark}) -@kindex m -@findex org-agenda-bulk-mark - -Mark the entry at point for bulk action. If there is an active -region in the agenda, mark the entries in the region. With numeric -prefix argument, mark that many successive entries. - -@item @kbd{*} (@code{org-agenda-bulk-mark-all}) -@kindex * -@findex org-agenda-bulk-mark-all - -Mark all visible agenda entries for bulk action. - -@item @kbd{u} (@code{org-agenda-bulk-unmark}) -@kindex u -@findex org-agenda-bulk-unmark - -Unmark entry for bulk action. - -@item @kbd{U} (@code{org-agenda-bulk-remove-all-marks}) -@kindex U -@findex org-agenda-bulk-remove-all-marks - -Unmark all marked entries for bulk action. - -@item @kbd{M-m} (@code{org-agenda-bulk-toggle}) -@kindex M-m -@findex org-agenda-bulk-toggle - -Toggle mark of the entry at point for bulk action. - -@item @kbd{M-*} (@code{org-agenda-bulk-toggle-all}) -@kindex M-* -@findex org-agenda-bulk-toggle-all - -Toggle mark of every entry for bulk action. - -@item @kbd{%} (@code{org-agenda-bulk-mark-regexp}) -@kindex % -@findex org-agenda-bulk-mark-regexp - -Mark entries matching a regular expression for bulk action. - -@item @kbd{B} (@code{org-agenda-bulk-action}) -@kindex B -@findex org-agenda-bulk-action -@vindex org-agenda-bulk-persistent-marks - -Bulk action: act on all marked entries in the agenda. This prompts -for another key to select the action to be applied. The prefix -argument to @kbd{B} is passed through to the @kbd{s} and -@kbd{d} commands, to bulk-remove these special timestamps. By -default, marks are removed after the bulk. If you want them to -persist, set @code{org-agenda-bulk-persistent-marks} to @code{t} or hit -@kbd{p} at the prompt. - -@table @asis -@item @kbd{p} -Toggle persistent marks. - -@item @kbd{$} -Archive all selected entries. - -@item @kbd{A} -Archive entries by moving them to their respective archive -siblings. - -@item @kbd{t} -Change TODO state. This prompts for a single TODO keyword and -changes the state of all selected entries, bypassing blocking and -suppressing logging notes---but not timestamps. - -@item @kbd{+} -Add a tag to all selected entries. - -@item @kbd{-} -Remove a tag from all selected entries. - -@item @kbd{s} -Schedule all items to a new date. To shift existing schedule -dates by a fixed number of days, use something starting with -double plus at the prompt, for example @samp{++8d} or @samp{++2w}. - -@item @kbd{d} -Set deadline to a specific date. - -@item @kbd{r} -Prompt for a single refile target and move all entries. The -entries are no longer in the agenda; refresh (@kbd{g}) to -bring them back. - -@item @kbd{S} -Reschedule randomly into the coming N days. N is prompted for. -With a prefix argument (@kbd{C-u B S}), scatter only across -weekdays. - -@item @kbd{f} -@vindex org-agenda-bulk-custom-functions -Apply a function@footnote{You can also create persistent custom functions through -@code{org-agenda-bulk-custom-functions}.} to marked entries. For example, the -function below sets the @samp{CATEGORY} property of the entries to -@samp{web}. - -@lisp -(defun set-category () - (interactive "P") - (let ((marker (or (org-get-at-bol 'org-hd-marker) - (org-agenda-error)))) - (org-with-point-at marker - (org-back-to-heading t) - (org-set-property "CATEGORY" "web")))) -@end lisp -@end table -@end table - -@anchor{Calendar commands} -@subheading Calendar commands - -@cindex calendar commands, from agenda - -@table @asis -@item @kbd{c} (@code{org-agenda-goto-calendar}) -@kindex c -@findex org-agenda-goto-calendar -Open the Emacs calendar and go to the date at point in the agenda. - -@item @kbd{c} (@code{org-calendar-goto-agenda}) -@kindex c -@findex org-calendar-goto-agenda -When in the calendar, compute and show the Org agenda for the date -at point. - -@item @kbd{i} (@code{org-agenda-diary-entry}) -@kindex i -@findex org-agenda-diary-entry - -@cindex diary entries, creating from agenda -Insert a new entry into the diary, using the date at point and (for -block entries) the date at the mark. This adds to the Emacs diary -file@footnote{This file is parsed for the agenda when -@code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i} command in the -calendar. The diary file pops up in another window, where you can -add the entry. - -@vindex org-agenda-diary-file -If you configure @code{org-agenda-diary-file} to point to an Org file, -Org creates entries in that file instead. Most entries are stored -in a date-based outline tree that will later make it easy to archive -appointments from previous months/years. The tree is built under an -entry with a @samp{DATE_TREE} property, or else with years as top-level -entries. Emacs prompts you for the entry text---if you specify it, -the entry is created in @code{org-agenda-diary-file} without further -interaction. If you directly press @kbd{@key{RET}} at the prompt -without typing text, the target file is shown in another window for -you to finish the entry there. See also the @kbd{k r} command. - -@item @kbd{M} (@code{org-agenda-phases-of-moon}) -@kindex M -@findex org-agenda-phases-of-moon -Show the phases of the moon for the three months around current -date. - -@item @kbd{S} (@code{org-agenda-sunrise-sunset}) -@kindex S -@findex org-agenda-sunrise-sunset -Show sunrise and sunset times. The geographical location must be -set with calendar variables, see the documentation for the Emacs -calendar. - -@item @kbd{C} (@code{org-agenda-convert-date}) -@kindex C -@findex org-agenda-convert-date -Convert the date at point into many other cultural and historic -calendars. - -@item @kbd{H} (@code{org-agenda-holidays}) -@kindex H -@findex org-agenda-holidays -Show holidays for three months around point date. -@end table - -@anchor{Quit and exit} -@subheading Quit and exit - -@table @asis -@item @kbd{q} (@code{org-agenda-quit}) -@kindex q -@findex org-agenda-quit - -Quit agenda, remove the agenda buffer. - -@item @kbd{x} (@code{org-agenda-exit}) -@kindex x -@findex org-agenda-exit - -@cindex agenda files, removing buffers -Exit agenda, remove the agenda buffer and all buffers loaded by -Emacs for the compilation of the agenda. Buffers created by the -user to visit Org files are not removed. -@end table - -@node Custom Agenda Views -@section Custom Agenda Views - -@cindex custom agenda views -@cindex agenda views, custom - -Custom agenda commands serve two purposes: to store and quickly access -frequently used TODO and tags searches, and to create special -composite agenda buffers. Custom agenda commands are accessible -through the dispatcher (see @ref{Agenda Dispatcher}), just like the -default commands. - -@menu -* Storing searches:: Type once, use often. -* Block agenda:: All the stuff you need in a single buffer. -* Setting options:: Changing the rules. -@end menu - -@node Storing searches -@subsection Storing searches - -The first application of custom searches is the definition of keyboard -shortcuts for frequently used searches, either creating an agenda -buffer, or a sparse tree (the latter covering of course only the -current buffer). - -@kindex C @r{(Agenda dispatcher)} -@vindex org-agenda-custom-commands -@cindex agenda views, main example -@cindex agenda, as an agenda views -@cindex agenda*, as an agenda views -@cindex tags, as an agenda view -@cindex todo, as an agenda view -@cindex tags-todo -@cindex todo-tree -@cindex occur-tree -@cindex tags-tree -Custom commands are configured in the variable -@code{org-agenda-custom-commands}. You can customize this variable, for -example by pressing @kbd{C} from the agenda dispatcher (see @ref{Agenda Dispatcher}). You can also directly set it with Emacs Lisp in -the Emacs init file. The following example contains all valid agenda -views: - -@lisp -(setq org-agenda-custom-commands - '(("x" agenda) - ("y" agenda*) - ("w" todo "WAITING") - ("W" todo-tree "WAITING") - ("u" tags "+boss-urgent") - ("v" tags-todo "+boss-urgent") - ("U" tags-tree "+boss-urgent") - ("f" occur-tree "\\<FIXME\\>") - ("h" . "HOME+Name tags searches") ;description for "h" prefix - ("hl" tags "+home+Lisa") - ("hp" tags "+home+Peter") - ("hk" tags "+home+Kim"))) -@end lisp - -The initial string in each entry defines the keys you have to press -after the dispatcher command in order to access the command. Usually -this is just a single character, but if you have many similar -commands, you can also define two-letter combinations where the first -character is the same in several combinations and serves as a prefix -key@footnote{You can provide a description for a prefix key by inserting -a cons cell with the prefix and the description.}. The second parameter is the search type, followed by the -string or regular expression to be used for the matching. The example -above will therefore define: - -@table @asis -@item @kbd{x} -as a global search for agenda entries planned@footnote{@emph{Planned} means here that these entries have some planning -information attached to them, like a time-stamp, a scheduled or -a deadline string. See @code{org-agenda-entry-types} on how to set what -planning information is taken into account.} this week/day. - -@item @kbd{y} -as the same search, but only for entries with an hour specification -like @samp{[h]h:mm}---think of them as appointments. - -@item @kbd{w} -as a global search for TODO entries with @samp{WAITING} as the TODO -keyword. - -@item @kbd{W} -as the same search, but only in the current buffer and displaying -the results as a sparse tree. - -@item @kbd{u} -as a global tags search for headlines tagged @samp{boss} but not -@samp{urgent}. - -@item @kbd{v} -The same search, but limiting it to headlines that are also TODO -items. - -@item @kbd{U} -as the same search, but only in the current buffer and displaying -the result as a sparse tree. - -@item @kbd{f} -to create a sparse tree (again, current buffer only) with all -entries containing the word @samp{FIXME}. - -@item @kbd{h} -as a prefix command for a @samp{HOME} tags search where you have to press -an additional key (@kbd{l}, @kbd{p} or @kbd{k}) to -select a name (Lisa, Peter, or Kim) as additional tag to match. -@end table - -Note that @code{*-tree} agenda views need to be called from an Org buffer -as they operate on the current buffer only. - -@node Block agenda -@subsection Block agenda - -@cindex block agenda -@cindex agenda, with block views - -Another possibility is the construction of agenda views that comprise -the results of @emph{several} commands, each of which creates a block in -the agenda buffer. The available commands include @code{agenda} for the -daily or weekly agenda (as created with @kbd{a}) , @code{alltodo} for -the global TODO list (as constructed with @kbd{t}), @code{stuck} for -the list of stuck projects (as obtained with @kbd{#}) and the -matching commands discussed above: @code{todo}, @code{tags}, and @code{tags-todo}. - -Here are two examples: - -@lisp -(setq org-agenda-custom-commands - '(("h" "Agenda and Home-related tasks" - ((agenda "") - (tags-todo "home") - (tags "garden"))) - ("o" "Agenda and Office-related tasks" - ((agenda "") - (tags-todo "work") - (tags "office"))))) -@end lisp - -@noindent -This defines @kbd{h} to create a multi-block view for stuff you -need to attend to at home. The resulting agenda buffer contains your -agenda for the current week, all TODO items that carry the tag @samp{home}, -and also all lines tagged with @samp{garden}. Finally the command -@kbd{o} provides a similar view for office tasks. - -@node Setting options -@subsection Setting options for custom commands - -@cindex options, for custom agenda views - -@vindex org-agenda-custom-commands -Org mode contains a number of variables regulating agenda construction -and display. The global variables define the behavior for all agenda -commands, including the custom commands. However, if you want to -change some settings just for a single custom view, you can do so. -Setting options requires inserting a list of variable names and values -at the right spot in @code{org-agenda-custom-commands}. For example: - -@lisp -(setq org-agenda-custom-commands - '(("w" todo "WAITING" - ((org-agenda-sorting-strategy '(priority-down)) - (org-agenda-prefix-format " Mixed: "))) - ("U" tags-tree "+boss-urgent" - ((org-show-context-detail 'minimal))) - ("N" search "" - ((org-agenda-files '("~org/notes.org")) - (org-agenda-text-search-extra-files nil))))) -@end lisp - -@noindent -Now the @kbd{w} command sorts the collected entries only by -priority, and the prefix format is modified to just say @samp{Mixed:} -instead of giving the category of the entry. The sparse tags tree of -@kbd{U} now turns out ultra-compact, because neither the headline -hierarchy above the match, nor the headline following the match are -shown. The command @kbd{N} does a text search limited to only -a single file. - -For command sets creating a block agenda, @code{org-agenda-custom-commands} -has two separate spots for setting options. You can add options that -should be valid for just a single command in the set, and options that -should be valid for all commands in the set. The former are just -added to the command entry; the latter must come after the list of -command entries. Going back to the block agenda example (see @ref{Block agenda}), let's change the sorting strategy for the @kbd{h} -commands to @code{priority-down}, but let's sort the results for @samp{garden} -tags query in the opposite order, @code{priority-up}. This would look like -this: - -@lisp -(setq org-agenda-custom-commands - '(("h" "Agenda and Home-related tasks" - ((agenda) - (tags-todo "home") - (tags "garden" - ((org-agenda-sorting-strategy '(priority-up))))) - ((org-agenda-sorting-strategy '(priority-down)))) - ("o" "Agenda and Office-related tasks" - ((agenda) - (tags-todo "work") - (tags "office"))))) -@end lisp - -As you see, the values and parentheses setting is a little complex. -When in doubt, use the customize interface to set this variable---it -fully supports its structure. Just one caveat: when setting options -in this interface, the @emph{values} are just Lisp expressions. So if the -value is a string, you need to add the double-quotes around the value -yourself. - -@vindex org-agenda-custom-commands-contexts -To control whether an agenda command should be accessible from -a specific context, you can customize -@code{org-agenda-custom-commands-contexts}. Let's say for example that you -have an agenda command @kbd{o} displaying a view that you only -need when reading emails. Then you would configure this option like -this: - -@lisp -(setq org-agenda-custom-commands-contexts - '(("o" (in-mode . "message-mode")))) -@end lisp - -You can also tell that the command key @kbd{o} should refer to -another command key @kbd{r}. In that case, add this command key -like this: - -@lisp -(setq org-agenda-custom-commands-contexts - '(("o" "r" (in-mode . "message-mode")))) -@end lisp - -See the docstring of the variable for more information. - -@node Exporting Agenda Views -@section Exporting Agenda Views - -@cindex agenda views, exporting - -If you are away from your computer, it can be very useful to have -a printed version of some agenda views to carry around. Org mode can -export custom agenda views as plain text, HTML@footnote{For HTML you need to install Hrvoje Nikšić's @samp{htmlize.el} -as an Emacs package from MELPA or from @uref{https://github.com/hniksic/emacs-htmlize, Hrvoje Nikšić's repository}.}, Postscript, -PDF@footnote{To create PDF output, the Ghostscript ps2pdf utility must be -installed on the system. Selecting a PDF file also creates the -postscript file.}, and iCalendar files. If you want to do this only -occasionally, use the following command: - -@table @asis -@item @kbd{C-x C-w} (@code{org-agenda-write}) -@kindex C-x C-w -@findex org-agenda-write -@cindex exporting agenda views -@cindex agenda views, exporting - -@vindex org-agenda-exporter-settings -Write the agenda view to a file. -@end table - -If you need to export certain agenda views frequently, you can -associate any custom agenda command with a list of output file -names@footnote{If you want to store standard views like the weekly agenda or -the global TODO list as well, you need to define custom commands for -them in order to be able to specify file names.}. Here is an example that first defines custom commands -for the agenda and the global TODO list, together with a number of -files to which to export them. Then we define two block agenda -commands and specify file names for them as well. File names can be -relative to the current working directory, or absolute. - -@lisp -(setq org-agenda-custom-commands - '(("X" agenda "" nil ("agenda.html" "agenda.ps")) - ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) - ("h" "Agenda and Home-related tasks" - ((agenda "") - (tags-todo "home") - (tags "garden")) - nil - ("~/views/home.html")) - ("o" "Agenda and Office-related tasks" - ((agenda) - (tags-todo "work") - (tags "office")) - nil - ("~/views/office.ps" "~/calendars/office.ics")))) -@end lisp - -The extension of the file name determines the type of export. If it -is @samp{.html}, Org mode uses the htmlize package to convert the buffer to -HTML and save it to this file name. If the extension is @samp{.ps}, -@code{ps-print-buffer-with-faces} is used to produce Postscript output. If -the extension is @samp{.ics}, iCalendar export is run export over all files -that were used to construct the agenda, and limit the export to -entries listed in the agenda. Any other extension produces a plain -ASCII file. - -The export files are @emph{not} created when you use one of those -commands interactively because this might use too much overhead. -Instead, there is a special command to produce @emph{all} specified -files in one step: - -@table @asis -@item @kbd{e} (@code{org-store-agenda-views}) -@kindex e @r{(Agenda dispatcher)} -@findex org-store-agenda-views -Export all agenda views that have export file names associated with -them. -@end table - -You can use the options section of the custom agenda commands to also -set options for the export commands. For example: - -@lisp -(setq org-agenda-custom-commands - '(("X" agenda "" - ((ps-number-of-columns 2) - (ps-landscape-mode t) - (org-agenda-prefix-format " [ ] ") - (org-agenda-with-colors nil) - (org-agenda-remove-tags t)) - ("theagenda.ps")))) -@end lisp - -@noindent -@vindex org-agenda-exporter-settings -This command sets two options for the Postscript exporter, to make it -print in two columns in landscape format---the resulting page can be -cut in two and then used in a paper agenda. The remaining settings -modify the agenda prefix to omit category and scheduling information, -and instead include a checkbox to check off items. We also remove the -tags to make the lines compact, and we do not want to use colors for -the black-and-white printer. Settings specified in -@code{org-agenda-exporter-settings} also apply, e.g., - -@lisp -(setq org-agenda-exporter-settings - '((ps-number-of-columns 2) - (ps-landscape-mode t) - (org-agenda-add-entry-text-maxlines 5) - (htmlize-output-type 'css))) -@end lisp - -@noindent -but the settings in @code{org-agenda-custom-commands} take precedence. - -From the command line you may also use: - -@example -emacs -eval (org-batch-store-agenda-views) -kill -@end example - -@noindent -or, if you need to modify some parameters@footnote{Quoting depends on the system you use, please check the FAQ -for examples.} - -@example -emacs -eval '(org-batch-store-agenda-views \ - org-agenda-span (quote month) \ - org-agenda-start-day "2007-11-01" \ - org-agenda-include-diary nil \ - org-agenda-files (quote ("~/org/project.org")))' \ - -kill -@end example - -@noindent -which creates the agenda views restricted to the file -@samp{~/org/project.org}, without diary entries and with a 30-day extent. - -You can also extract agenda information in a way that allows further -processing by other programs. See @ref{Extracting Agenda Information}, for -more information. - -@node Agenda Column View -@section Using Column View in the Agenda - -@cindex column view, in agenda -@cindex agenda, column view - -Column view (see @ref{Column View}) is normally used to view and edit -properties embedded in the hierarchical structure of an Org file. It -can be quite useful to use column view also from the agenda, where -entries are collected by certain criteria. - -@table @asis -@item @kbd{C-c C-x C-c} (@code{org-agenda-columns}) -@kindex C-c C-x C-c -@findex org-agenda-columns - -Turn on column view in the agenda. -@end table - -To understand how to use this properly, it is important to realize -that the entries in the agenda are no longer in their proper outline -environment. This causes the following issues: - -@enumerate -@item -@vindex org-columns-default-format-for-agenda -@vindex org-columns-default-format -Org needs to make a decision which columns format to use. Since -the entries in the agenda are collected from different files, and -different files may have different columns formats, this is a -non-trivial problem. Org first checks if -@code{org-overriding-columns-format} is currently set, and if so, takes -the format from there. You should set this variable only in the -@emph{local settings section} of a custom agenda command (see @ref{Custom Agenda Views}) to make it valid for that specific agenda view. If -no such binding exists, it checks, in sequence, -@code{org-columns-default-format-for-agenda}, the format associated with -the first item in the agenda (through a property or a @samp{#+COLUMNS} -setting in that buffer) and finally @code{org-columns-default-format}. - -@item -@cindex @samp{CLOCKSUM}, special property -If any of the columns has a summary type defined (see @ref{Column attributes}), turning on column view in the agenda visits all -relevant agenda files and make sure that the computations of this -property are up to date. This is also true for the special -@samp{CLOCKSUM} property. Org then sums the values displayed in the -agenda. In the daily/weekly agenda, the sums cover a single day; -in all other views they cover the entire block. - -It is important to realize that the agenda may show the same entry -@emph{twice}---for example as scheduled and as a deadline---and it may -show two entries from the same hierarchy (for example a @emph{parent} -and its @emph{child}). In these cases, the summation in the agenda -leads to incorrect results because some values count double. - -@item -When the column view in the agenda shows the @samp{CLOCKSUM} property, -that is always the entire clocked time for this item. So even in -the daily/weekly agenda, the clocksum listed in column view may -originate from times outside the current view. This has the -advantage that you can compare these values with a column listing -the planned total effort for a task---one of the major -applications for column view in the agenda. If you want -information about clocked time in the displayed period use clock -table mode (press @kbd{R} in the agenda). - -@item -@cindex @samp{CLOCKSUM_T}, special property -When the column view in the agenda shows the @samp{CLOCKSUM_T} property, -that is always today's clocked time for this item. So even in the -weekly agenda, the clocksum listed in column view only originates -from today. This lets you compare the time you spent on a task for -today, with the time already spent---via @samp{CLOCKSUM}---and with -the planned total effort for it. -@end enumerate - -@node Markup for Rich Contents -@chapter Markup for Rich Contents - -Org is primarily about organizing and searching through your -plain-text notes. However, it also provides a lightweight yet robust -markup language for rich text formatting and more. For instance, you -may want to center or emphasize text. Or you may need to insert -a formula or image in your writing. Org offers syntax for all of this -and more. Used in conjunction with the export framework (see -@ref{Exporting}), you can author beautiful documents in Org---like the fine -manual you are currently reading. - -@menu -* Paragraphs:: The basic unit of text. -* Emphasis and Monospace:: Bold, italic, etc. -* Subscripts and Superscripts:: Simple syntax for raising/lowering text. -* Special Symbols:: Greek letters and other symbols. -* Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents. -* Literal Examples:: Source code examples with special formatting. -* Images:: Display an image. -* Captions:: Describe tables, images... -* Horizontal Rules:: Make a line. -* Creating Footnotes:: Edit and read footnotes. -@end menu - -@node Paragraphs -@section Paragraphs - -@cindex paragraphs, markup rules -Paragraphs are separated by at least one empty line. If you need to -enforce a line break within a paragraph, use @samp{\\} at the end of -a line. - -@cindex line breaks, markup rules -To preserve the line breaks, indentation and blank lines in a region, -but otherwise use normal formatting, you can use this construct, which -can also be used to format poetry. - -@cindex @samp{BEGIN_VERSE} -@cindex verse blocks -@example -#+BEGIN_VERSE - Great clouds overhead - Tiny black birds rise and fall - Snow covers Emacs - - ---AlexSchroeder -#+END_VERSE -@end example - -When quoting a passage from another document, it is customary to -format this as a paragraph that is indented on both the left and the -right margin. You can include quotations in Org documents like this: - -@cindex @samp{BEGIN_QUOTE} -@cindex quote blocks -@example -#+BEGIN_QUOTE -Everything should be made as simple as possible, -but not any simpler ---Albert Einstein -#+END_QUOTE -@end example - -If you would like to center some text, do it like this: - -@cindex @samp{BEGIN_CENTER} -@cindex center blocks -@example -#+BEGIN_CENTER -Everything should be made as simple as possible, \\ -but not any simpler -#+END_CENTER -@end example - -@node Emphasis and Monospace -@section Emphasis and Monospace - -@cindex underlined text, markup rules -@cindex bold text, markup rules -@cindex italic text, markup rules -@cindex verbatim text, markup rules -@cindex code text, markup rules -@cindex strike-through text, markup rules - -You can make words @samp{*bold*}, @samp{/italic/}, @samp{_underlined_}, @samp{=verbatim=} -and @samp{~code~}, and, if you must, @samp{+strike-through+}. Text in the code -and verbatim string is not processed for Org specific syntax; it is -exported verbatim. - -@vindex org-fontify-emphasized-text -To turn off fontification for marked up text, you can set -@code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of -available markup syntax, you can customize @code{org-emphasis-alist}. - -@node Subscripts and Superscripts -@section Subscripts and Superscripts - -@cindex subscript -@cindex superscript - -@samp{^} and @samp{_} are used to indicate super- and subscripts. To increase -the readability of ASCII text, it is not necessary, but OK, to -surround multi-character sub- and superscripts with curly braces. For -example - -@example -The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand, -the radius of Alpha Centauri is R_@{Alpha Centauri@} = 1.28 x R_@{sun@}. -@end example - -@vindex org-use-sub-superscripts -If you write a text where the underscore is often used in a different -context, Org's convention to always interpret these as subscripts can -get in your way. Configure the variable @code{org-use-sub-superscripts} to -change this convention. For example, when setting this variable to -@code{@{@}}, @samp{a_b} is not interpreted as a subscript, but @samp{a_@{b@}} is. - -You can set @code{org-use-sub-superscripts} in a file using the export -option @samp{^:} (see @ref{Export Settings}). For example, @samp{#+OPTIONS: ^:@{@}} -sets @code{org-use-sub-superscripts} to @code{@{@}} and limits super- and -subscripts to the curly bracket notation. - -You can also toggle the visual display of super- and subscripts: - -@table @asis -@item @kbd{C-c C-x \} (@code{org-toggle-pretty-entities}) -@kindex C-c C-x \ -@findex org-toggle-pretty-entities -This command formats sub- and superscripts in a WYSIWYM way. -@end table - -@vindex org-pretty-entities -@vindex org-pretty-entities-include-sub-superscripts -Set both @code{org-pretty-entities} and -@code{org-pretty-entities-include-sub-superscripts} to @code{t} to start with -super- and subscripts @emph{visually} interpreted as specified by the -option @code{org-use-sub-superscripts}. - -@node Special Symbols -@section Special Symbols - -@cindex math symbols -@cindex special symbols -@cindex entities - -You can use @LaTeX{}-like syntax to insert special symbols---named -entities---like @samp{\alpha} to indicate the Greek letter, or @samp{\to} to indicate -an arrow. Completion for these symbols is available, just type @samp{\} -and maybe a few letters, and press @kbd{M-@key{TAB}} to see possible -completions. If you need such a symbol inside a word, terminate it -with a pair of curly brackets. For example - -@example -Pro tip: Given a circle \Gamma of diameter d, the length of its -circumference is \pi@{@}d. -@end example - -@findex org-entities-help -@vindex org-entities-user -A large number of entities is provided, with names taken from both -HTML and @LaTeX{}; you can comfortably browse the complete list from -a dedicated buffer using the command @code{org-entities-help}. It is also -possible to provide your own special symbols in the variable -@code{org-entities-user}. - -During export, these symbols are transformed into the native format of -the exporter back-end. Strings like @samp{\alpha} are exported as @samp{α} in -the HTML output, and as @samp{\(\alpha\)} in the @LaTeX{} output. Similarly, @samp{\nbsp} -becomes @samp{ } in HTML and @samp{~} in @LaTeX{}. - -@cindex special symbols, in-buffer display -If you would like to see entities displayed as UTF-8 characters, use -the following command@footnote{You can turn this on by default by setting the variable -@code{org-pretty-entities}, or on a per-file base with the @samp{STARTUP} option -@samp{entitiespretty}.}: - -@table @asis -@item @kbd{C-c C-x \} (@code{org-toggle-pretty-entities}) -@kindex C-c C-x \ -@findex org-toggle-pretty-entities - -Toggle display of entities as UTF-8 characters. This does not -change the buffer content which remains plain ASCII, but it overlays -the UTF-8 character for display purposes only. -@end table - -@cindex shy hyphen, special symbol -@cindex dash, special symbol -@cindex ellipsis, special symbol -In addition to regular entities defined above, Org exports in -a special way@footnote{This behavior can be disabled with @samp{-} export setting (see -@ref{Export Settings}).} the following commonly used character -combinations: @samp{\-} is treated as a shy hyphen, @samp{--} and @samp{---} are -converted into dashes, and @samp{...} becomes a compact set of dots. - -@node Embedded @LaTeX{} -@section Embedded @LaTeX{} - -@cindex @TeX{} interpretation -@cindex @LaTeX{} interpretation - -Plain ASCII is normally sufficient for almost all note taking. -Exceptions include scientific notes, which often require mathematical -symbols and the occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on Donald@tie{}E@.@tie{}Knuth's @TeX{} -system. Many of the features described here as ``@LaTeX{}'' are really -from @TeX{}, but for simplicity I am blurring this distinction.} is widely used to -typeset scientific documents. Org mode supports embedding @LaTeX{} code -into its files, because many academics are used to writing and reading -@LaTeX{} source code, and because it can be readily processed to produce -pretty output for a number of export back-ends. - -@menu -* @LaTeX{} fragments:: Complex formulas made easy. -* Previewing @LaTeX{} fragments:: What will this snippet look like? -* CD@LaTeX{} mode:: Speed up entering of formulas. -@end menu - -@node @LaTeX{} fragments -@subsection @LaTeX{} fragments - -@cindex @LaTeX{} fragments - -@vindex org-format-latex-header -Org mode can contain @LaTeX{} math fragments, and it supports ways to -process these for several export back-ends. When exporting to @LaTeX{}, -the code is left as it is. When exporting to HTML, Org can use either -@uref{http://www.mathjax.org, MathJax} (see @ref{Math formatting in HTML export}) or transcode the math -into images (see @ref{Previewing @LaTeX{} fragments}). - -@LaTeX{} fragments do not need any special marking at all. The following -snippets are identified as @LaTeX{} source code: - -@itemize -@item -Environments of any kind@footnote{When MathJax is used, only the environments recognized by -MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is -used to create images, any @LaTeX{} environment is handled.}. The only requirement is that the -@samp{\begin} statement appears on a new line, preceded by only -whitespace. - -@item -Text within the usual @LaTeX{} math delimiters. To avoid conflicts -with currency specifications, single @samp{$} characters are only -recognized as math delimiters if the enclosed text contains at most -two line breaks, is directly attached to the @samp{$} characters with no -whitespace in between, and if the closing @samp{$} is followed by -whitespace, punctuation or a dash. For the other delimiters, there -is no such restriction, so when in doubt, use @samp{\(...\)} as inline -math delimiters. -@end itemize - -@noindent -For example: - -@example -\begin@{equation@} % arbitrary environments, -x=\sqrt@{b@} % even tables, figures -\end@{equation@} % etc - -If $a^2=b$ and \( b=2 \), then the solution must be -either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. -@end example - -@vindex org-export-with-latex -@LaTeX{} processing can be configured with the variable -@code{org-export-with-latex}. The default setting is @code{t} which means -MathJax for HTML, and no processing for ASCII and @LaTeX{} back-ends. -You can also set this variable on a per-file basis using one of these -lines: - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{#+OPTIONS: tex:t} -@tab Do the right thing automatically (MathJax) -@item @samp{#+OPTIONS: tex:nil} -@tab Do not process @LaTeX{} fragments at all -@item @samp{#+OPTIONS: tex:verbatim} -@tab Verbatim export, for jsMath or so -@end multitable - -@node Previewing @LaTeX{} fragments -@subsection Previewing @LaTeX{} fragments - -@cindex @LaTeX{} fragments, preview - -@vindex org-preview-latex-default-process -If you have a working @LaTeX{} installation and @samp{dvipng}, @samp{dvisvgm} or -@samp{convert} installed@footnote{These are respectively available at -@uref{http://sourceforge.net/projects/dvipng/}, @uref{http://dvisvgm.bplaced.net/} -and from the ImageMagick suite. Choose the converter by setting the -variable @code{org-preview-latex-default-process} accordingly.}, @LaTeX{} fragments can be processed to -produce images of the typeset expressions to be used for inclusion -while exporting to HTML (see @ref{@LaTeX{} fragments}), or for inline -previewing within Org mode. - -@vindex org-format-latex-options -@vindex org-format-latex-header -You can customize the variables @code{org-format-latex-options} and -@code{org-format-latex-header} to influence some aspects of the preview. -In particular, the @code{:scale} (and for HTML export, @code{:html-scale}) -property of the former can be used to adjust the size of the preview -images. - -@table @asis -@item @kbd{C-c C-x C-l} (@code{org-latex-preview}) -@kindex C-c C-x C-l -@findex org-latex-preview - -Produce a preview image of the @LaTeX{} fragment at point and overlay -it over the source code. If there is no fragment at point, process -all fragments in the current entry---between two headlines. - -When called with a single prefix argument, clear all images in the -current entry. Two prefix arguments produce a preview image for all -fragments in the buffer, while three of them clear all the images in -that buffer. -@end table - -@vindex org-startup-with-latex-preview -You can turn on the previewing of all @LaTeX{} fragments in a file with - -@example -#+STARTUP: latexpreview -@end example - - -To disable it, simply use - -@example -#+STARTUP: nolatexpreview -@end example - -@node CD@LaTeX{} mode -@subsection Using CD@LaTeX{} to enter math - -@cindex CD@LaTeX{} - -CD@LaTeX{} mode is a minor mode that is normally used in combination with -a major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of -environments and math templates. Inside Org mode, you can make use of -some of the features of CD@LaTeX{} mode. You need to install -@samp{cdlatex.el} and @samp{texmathp.el} (the latter comes also with AUC@TeX{}) -using @uref{https://melpa.org/, MELPA} with the @uref{https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html, Emacs packaging system} or alternatively from -@uref{https://staff.fnwi.uva.nl/c.dominik/Tools/cdlatex/}. Do not use -CD@LaTeX{} mode itself under Org mode, but use the special version Org -CD@LaTeX{} minor mode that comes as part of Org. Turn it on for the -current buffer with @kbd{M-x org-cdlatex-mode}, or for all Org -files with - -@lisp -(add-hook 'org-mode-hook 'turn-on-org-cdlatex) -@end lisp - -When this mode is enabled, the following features are present (for -more details see the documentation of CD@LaTeX{} mode): - -@table @asis -@item @kbd{C-c @{} -@kindex C-c @{ - -Insert an environment template. - -@item @kbd{@key{TAB}} -@kindex TAB - -The @kbd{@key{TAB}} key expands the template if point is inside -a @LaTeX{} fragment@footnote{Org mode has a method to test if point is inside such -a fragment, see the documentation of the function -@code{org-inside-LaTeX-fragment-p}.}. For example, @kbd{@key{TAB}} expands @samp{fr} -to @samp{\frac@{@}@{@}} and position point correctly inside the first brace. -Another @kbd{@key{TAB}} gets you into the second brace. - -Even outside fragments, @kbd{@key{TAB}} expands environment -abbreviations at the beginning of a line. For example, if you write -@samp{equ} at the beginning of a line and press @kbd{@key{TAB}}, this -abbreviation is expanded to an @samp{equation} environment. To get -a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. - -@item @kbd{^} -@itemx @kbd{_} -@kindex _ -@kindex ^ -@vindex cdlatex-simplify-sub-super-scripts - -Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment -inserts these characters together with a pair of braces. If you use -@kbd{@key{TAB}} to move out of the braces, and if the braces surround -only a single character or macro, they are removed again (depending -on the variable @code{cdlatex-simplify-sub-super-scripts}). - -@item @kbd{`} -@kindex ` - -Pressing the backquote followed by a character inserts math macros, -also outside @LaTeX{} fragments. If you wait more than 1.5 seconds -after the backquote, a help window pops up. - -@item @kbd{'} -@kindex ' - -Pressing the single-quote followed by another character modifies the -symbol before point with an accent or a font. If you wait more than -1.5 seconds after the single-quote, a help window pops up. -Character modification works only inside @LaTeX{} fragments; outside -the quote is normal. -@end table - -@node Literal Examples -@section Literal Examples - -@cindex literal examples, markup rules -@cindex code line references, markup rules - -You can include literal examples that should not be subjected to -markup. Such examples are typeset in monospace, so this is well -suited for source code and similar examples. - -@cindex @samp{BEGIN_EXAMPLE} -@cindex example block -@example -#+BEGIN_EXAMPLE - Some example from a text file. -#+END_EXAMPLE -@end example - -@cindex comma escape, in literal examples -There is one limitation, however. You must insert a comma right -before lines starting with either @samp{*}, @samp{,*}, @samp{#+} or @samp{,#+}, as those -may be interpreted as outlines nodes or some other special syntax. -Org transparently strips these additional commas whenever it accesses -the contents of the block. - -@example -#+BEGIN_EXAMPLE -,* I am no real headline -#+END_EXAMPLE -@end example - -For simplicity when using small examples, you can also start the -example lines with a colon followed by a space. There may also be -additional whitespace before the colon: - -@example -Here is an example - : Some example from a text file. -@end example - -@cindex formatting source code, markup rules -@vindex org-latex-listings -If the example is source code from a programming language, or any -other text that can be marked up by Font Lock in Emacs, you can ask -for the example to look like the fontified Emacs buffer@footnote{This works automatically for the HTML backend (it requires -version 1.34 of the @samp{htmlize.el} package, which you need to install). -Fontified code chunks in @LaTeX{} can be achieved using either the -@uref{https://www.ctan.org/pkg/listings, listings} package or the @uref{https://www.ctan.org/pkg/minted, minted} package. Refer to -@code{org-export-latex-listings} for details.}. This -is done with the code block, where you also need to specify the name -of the major mode that should be used to fontify the example@footnote{Source code in code blocks may also be evaluated either -interactively or on export. See @ref{Working with Source Code} for more -information on evaluating code blocks.}, -see @ref{Structure Templates} for shortcuts to easily insert code blocks. - -@cindex @samp{BEGIN_SRC} -@cindex source block -@example -#+BEGIN_SRC emacs-lisp - (defun org-xor (a b) - "Exclusive or." - (if a (not b) b)) - #+END_SRC -@end example - -Both in @samp{example} and in @samp{src} snippets, you can add a @samp{-n} switch to -the end of the @samp{#+BEGIN} line, to get the lines of the example -numbered. The @samp{-n} takes an optional numeric argument specifying the -starting line number of the block. If you use a @samp{+n} switch, the -numbering from the previous numbered snippet is continued in the -current one. The @samp{+n} switch can also take a numeric argument. This -adds the value of the argument to the last line of the previous block -to determine the starting line number. - -@example -#+BEGIN_SRC emacs-lisp -n 20 - ;; This exports with line number 20. - (message "This is line 21") -#+END_SRC - -#+BEGIN_SRC emacs-lisp +n 10 - ;; This is listed as line 31. - (message "This is line 32") -#+END_SRC -@end example - -In literal examples, Org interprets strings like @samp{(ref:name)} as -labels, and use them as targets for special hyperlinks like -@samp{[[(name)]]}---i.e., the reference name enclosed in single parenthesis. -In HTML, hovering the mouse over such a link remote-highlights the -corresponding code line, which is kind of cool. - -You can also add a @samp{-r} switch which @emph{removes} the labels from the -source code@footnote{Adding @samp{-k} to @samp{-n -r} @emph{keeps} the labels in the source code -while using line numbers for the links, which might be useful to -explain those in an Org mode example code.}. With the @samp{-n} switch, links to these references -are labeled by the line numbers from the code listing. Otherwise -links use the labels with no parentheses. Here is an example: - -@example -#+BEGIN_SRC emacs-lisp -n -r - (save-excursion (ref:sc) - (goto-char (point-min)) (ref:jump) -#+END_SRC -In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]] -jumps to point-min. -@end example - -@cindex indentation, in source blocks -Source code and examples may be @emph{indented} in order to align nicely -with the surrounding text, and in particular with plain list structure -(see @ref{Plain Lists}). By default, Org only retains the relative -indentation between lines, e.g., when exporting the contents of the -block. However, you can use the @samp{-i} switch to also preserve the -global indentation, if it does matter. See @ref{Editing Source Code}. - -@vindex org-coderef-label-format -If the syntax for the label format conflicts with the language syntax, -use a @samp{-l} switch to change the format, for example - -@example -#+BEGIN_SRC pascal -n -r -l "((%s))" -@end example - - -@noindent -See also the variable @code{org-coderef-label-format}. - -HTML export also allows examples to be published as text areas (see -@ref{Text areas in HTML export}). - -Because the @samp{#+BEGIN} @dots{} @samp{#+END} patterns need to be added so often, -a shortcut is provided (see @ref{Structure Templates}). - -@table @asis -@item @kbd{C-c '} (@code{org-edit-special}) -@kindex C-c ' -@findex org-edit-special -Edit the source code example at point in its native mode. This -works by switching to a temporary buffer with the source code. You -need to exit by pressing @kbd{C-c '} again. The edited version -then replaces the old version in the Org buffer. Fixed-width -regions---where each line starts with a colon followed by -a space---are edited using Artist mode@footnote{You may select a different mode with the variable -@code{org-edit-fixed-width-region-mode}.} to allow creating -ASCII drawings easily. Using this command in an empty line creates -a new fixed-width region. -@end table - -@cindex storing link, in a source code buffer -Calling @code{org-store-link} (see @ref{Handling Links}) while editing a source -code example in a temporary buffer created with @kbd{C-c '} -prompts for a label. Make sure that it is unique in the current -buffer, and insert it with the proper formatting like @samp{(ref:label)} at -the end of the current line. Then the label is stored as a link -@samp{(label)}, for retrieval with @kbd{C-c C-l}. - -@node Images -@section Images - -@cindex inlining images -@cindex images, markup rules -An image is a link to an image file@footnote{What Emacs considers to be an image depends on -@code{image-file-name-extensions} and @code{image-file-name-regexps}.} that does not have -a description part, for example - -@example -./img/cat.jpg -@end example - - -If you wish to define a caption for the image (see @ref{Captions}) and -maybe a label for internal cross references (see @ref{Internal Links}), -make sure that the link is on a line by itself and precede it with -@samp{CAPTION} and @samp{NAME} keywords as follows: - -@example -#+CAPTION: This is the caption for the next figure link (or table) -#+NAME: fig:SED-HR4049 -[[./img/a.jpg]] -@end example - -Such images can be displayed within the buffer with the following -command: - -@table @asis -@item @kbd{C-c C-x C-v} (@code{org-toggle-inline-images}) -@kindex C-c C-x C-v -@findex org-toggle-inline-images -@vindex org-startup-with-inline-images -Toggle the inline display of linked images. When called with -a prefix argument, also display images that do have a link -description. You can ask for inline images to be displayed at -startup by configuring the variable -@code{org-startup-with-inline-images}@footnote{The variable @code{org-startup-with-inline-images} can be set -within a buffer with the @samp{STARTUP} options @samp{inlineimages} and -@samp{noinlineimages}.}. -@end table - -@node Captions -@section Captions - -@cindex captions, markup rules -@cindex @samp{CAPTION}, keyword - -You can assign a caption to a specific part of a document by inserting -a @samp{CAPTION} keyword immediately before it: - -@example -#+CAPTION: This is the caption for the next table (or link) -| ... | ... | -|-----+-----| -@end example - -Optionally, the caption can take the form: - -@example -#+CAPTION[Short caption]: Longer caption. -@end example - - -Even though images and tables are prominent examples of captioned -structures, the same caption mechanism can apply to many -others---e.g., @LaTeX{} equations, source code blocks. Depending on the -export back-end, those may or may not be handled. - -@node Horizontal Rules -@section Horizontal Rules - -@cindex horizontal rules, markup rules -A line consisting of only dashes, and at least 5 of them, is exported -as a horizontal line. - -@node Creating Footnotes -@section Creating Footnotes - -@cindex footnotes - -A footnote is started by a footnote marker in square brackets in -column 0, no indentation allowed. It ends at the next footnote -definition, headline, or after two consecutive empty lines. The -footnote reference is simply the marker in square brackets, inside -text. Markers always start with @samp{fn:}. For example: - -@example -The Org homepage[fn:1] now looks a lot better than it used to. -... -[fn:1] The link is: https://orgmode.org -@end example - -Org mode extends the number-based syntax to @emph{named} footnotes and -optional inline definition. Here are the valid references: - -@table @asis -@item @samp{[fn:NAME]} -A named footnote reference, where @var{NAME} is a unique -label word, or, for simplicity of automatic creation, a number. - -@item @samp{[fn:: This is the inline definition of this footnote]} -An anonymous footnote where the definition is given directly at the -reference point. - -@item @samp{[fn:NAME: a definition]} -An inline definition of a footnote, which also specifies a name for -the note. Since Org allows multiple references to the same note, -you can then use @samp{[fn:NAME]} to create additional references. -@end table - -@vindex org-footnote-auto-label -Footnote labels can be created automatically, or you can create names -yourself. This is handled by the variable @code{org-footnote-auto-label} -and its corresponding @samp{STARTUP} keywords. See the docstring of that -variable for details. - -The following command handles footnotes: - -@table @asis -@item @kbd{C-c C-x f} -The footnote action command. - -@kindex C-c C-x f -When point is on a footnote reference, jump to the definition. When -it is at a definition, jump to the---first---reference. - -@vindex org-footnote-define-inline -@vindex org-footnote-section -Otherwise, create a new footnote. Depending on the variable -@code{org-footnote-define-inline}@footnote{The corresponding in-buffer setting is: @samp{#+STARTUP: fninline} -or @samp{#+STARTUP: nofninline}.}, the definition is placed right -into the text as part of the reference, or separately into the -location determined by the variable @code{org-footnote-section}. - -When this command is called with a prefix argument, a menu of -additional options is offered: - -@multitable @columnfractions 0.1 0.9 -@item @kbd{s} -@tab Sort the footnote definitions by reference sequence. -@item @kbd{r} -@tab Renumber the simple @samp{fn:N} footnotes. -@item @kbd{S} -@tab Short for first @kbd{r}, then @kbd{s} action. -@item @kbd{n} -@tab Rename all footnotes into a @samp{fn:1} @dots{} @samp{fn:n} sequence. -@item @kbd{d} -@tab Delete the footnote at point, including definition and references. -@end multitable - -@vindex org-footnote-auto-adjust -Depending on the variable @code{org-footnote-auto-adjust}@footnote{The corresponding in-buffer options are @samp{#+STARTUP: fnadjust} -and @samp{#+STARTUP: nofnadjust}.}, -renumbering and sorting footnotes can be automatic after each -insertion or deletion. - -@item @kbd{C-c C-c} -@kindex C-c C-c -If point is on a footnote reference, jump to the definition. If it -is at the definition, jump back to the reference. When called at -a footnote location with a prefix argument, offer the same menu as -@kbd{C-c C-x f}. - -@item @kbd{C-c C-o} or @kbd{mouse-1/2} -@kindex C-c C-o -@kindex mouse-1 -@kindex mouse-2 -Footnote labels are also links to the corresponding definition or -reference, and you can use the usual commands to follow these links. -@end table - -@node Exporting -@chapter Exporting - -@cindex exporting - -At some point you might want to print your notes, publish them on the -web, or share them with people not using Org. Org can convert and -export documents to a variety of other formats while retaining as much -structure (see @ref{Document Structure}) and markup (see @ref{Markup for Rich Contents}) as possible. - -@cindex export back-end -The libraries responsible for translating Org files to other formats -are called @emph{back-ends}. Org ships with support for the following -back-ends: - -@itemize -@item -@emph{ascii} (ASCII format) -@item -@emph{beamer} (@LaTeX{} Beamer format) -@item -@emph{html} (HTML format) -@item -@emph{icalendar} (iCalendar format) -@item -@emph{latex} (@LaTeX{} format) -@item -@emph{md} (Markdown format) -@item -@emph{odt} (OpenDocument Text format) -@item -@emph{org} (Org format) -@item -@emph{texinfo} (Texinfo format) -@item -@emph{man} (Man page format) -@end itemize - -Users can install libraries for additional formats from the Emacs -packaging system. For easy discovery, these packages have a common -naming scheme: @code{ox-NAME}, where @var{NAME} is a format. For -example, @code{ox-koma-letter} for @emph{koma-letter} back-end. More libraries -can be found in the @samp{contrib/} directory (see @ref{Installation}). - -@vindex org-export-backends -Org only loads back-ends for the following formats by default: ASCII, -HTML, iCalendar, @LaTeX{}, and ODT@. Additional back-ends can be loaded -in either of two ways: by configuring the @code{org-export-backends} -variable, or by requiring libraries in the Emacs init file. For -example, to load the Markdown back-end, add this to your Emacs config: - -@lisp -(require 'ox-md) -@end lisp - -@menu -* The Export Dispatcher:: The main interface. -* Export Settings:: Common export settings. -* Table of Contents:: The if and where of the table of contents. -* Include Files:: Include additional files into a document. -* Macro Replacement:: Use macros to create templates. -* Comment Lines:: What will not be exported. -* ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding. -* Beamer Export:: Producing presentations and slides. -* HTML Export:: Exporting to HTML. -* @LaTeX{} Export:: Exporting to @LaTeX{} and processing to PDF. -* Markdown Export:: Exporting to Markdown. -* OpenDocument Text Export:: Exporting to OpenDocument Text. -* Org Export:: Exporting to Org. -* Texinfo Export:: Exporting to Texinfo. -* iCalendar Export:: Exporting to iCalendar. -* Other Built-in Back-ends:: Exporting to a man page. -* Advanced Export Configuration:: Fine-tuning the export output. -* Export in Foreign Buffers:: Author tables and lists in Org syntax. -@end menu - -@node The Export Dispatcher -@section The Export Dispatcher - -@cindex dispatcher, for export commands -@cindex export, dispatcher - -The export dispatcher is the main interface for Org's exports. -A hierarchical menu presents the currently configured export formats. -Options are shown as easy toggle switches on the same screen. - -@vindex org-export-dispatch-use-expert-ui -Org also has a minimal prompt interface for the export dispatcher. -When the variable @code{org-export-dispatch-use-expert-ui} is set to -a non-@code{nil} value, Org prompts in the minibuffer. To switch back to -the hierarchical menu, press @kbd{?}. - -@table @asis -@item @kbd{C-c C-e} (@code{org-export}) -@kindex C-c C-e -@findex org-export - -Invokes the export dispatcher interface. The options show default -settings. The @kbd{C-u} prefix argument preserves options from -the previous export, including any sub-tree selections. -@end table - -Org exports the entire buffer by default. If the Org buffer has an -active region, then Org exports just that region. - -Within the dispatcher interface, the following key combinations can -further alter what is exported, and how. - -@table @asis -@item @kbd{C-a} -@kindex C-c C-e C-a - -Toggle asynchronous export. Asynchronous export uses an external -Emacs process with a specially configured initialization file to -complete the exporting process in the background, without tying-up -Emacs. This is particularly useful when exporting long documents. - -Output from an asynchronous export is saved on the @emph{export stack}. -To view this stack, call the export dispatcher with a double -@kbd{C-u} prefix argument. If already in the export dispatcher -menu, @kbd{&} displays the stack. - -@vindex org-export-in-background -You can make asynchronous export the default by setting -@code{org-export-in-background}. - -@vindex org-export-async-init-file -You can set the initialization file used by the background process -by setting @code{org-export-async-init-file}. - -@item @kbd{C-b} -@kindex C-c C-e C-b - -Toggle body-only export. Useful for excluding headers and footers -in the export. Affects only those back-end formats that have -sections like @samp{<head>...</head>} in HTML@. - -@item @kbd{C-s} -@kindex C-c C-e C-s - -Toggle sub-tree export. When turned on, Org exports only the -sub-tree starting from point position at the time the export -dispatcher was invoked. Org uses the top heading of this sub-tree -as the document's title. If point is not on a heading, Org uses the -nearest enclosing header. If point is in the document preamble, Org -signals an error and aborts export. - -@vindex org-export-initial-scope -To make sub-tree export the default, customize the variable -@code{org-export-initial-scope}. - -@item @kbd{C-v} -@kindex C-c C-e C-v - -Toggle visible-only export. This is useful for exporting only -certain parts of an Org document by adjusting the visibility of -particular headings. -@end table - -@node Export Settings -@section Export Settings - -@cindex options, for export -@cindex Export, settings - -@cindex @samp{OPTIONS}, keyword -Export options can be set: globally with variables; for an individual -file by making variables buffer-local with in-buffer settings (see -@ref{In-buffer Settings}); by setting individual keywords or -specifying them in compact form with the @samp{OPTIONS} keyword; or for -a tree by setting properties (see @ref{Properties and Columns}). Options -set at a specific level override options set at a more general level. - -@cindex @samp{SETUPFILE}, keyword -In-buffer settings may appear anywhere in the file, either directly or -indirectly through a file included using @samp{#+SETUPFILE: filename or -URL} syntax. Option keyword sets tailored to a particular back-end -can be inserted from the export dispatcher (see @ref{The Export Dispatcher}) using the @samp{Insert template} command by pressing -@kbd{#}. To insert keywords individually, a good way to make -sure the keyword is correct is to type @samp{#+} and then to use -@kbd{M-@key{TAB}}@footnote{Many desktops intercept @kbd{M-@key{TAB}} to switch windows. -Use @kbd{C-M-i} or @kbd{@key{ESC} @key{TAB}} instead.} for completion. - -The export keywords available for every back-end, and their equivalent -global variables, include: - -@table @asis -@item @samp{AUTHOR} -@cindex @samp{AUTHOR}, keyword -@vindex user-full-name -The document author (@code{user-full-name}). - -@item @samp{CREATOR} -@cindex @samp{CREATOR}, keyword -@vindex org-expot-creator-string -Entity responsible for output generation -(@code{org-export-creator-string}). - -@item @samp{DATE} -@cindex @samp{DATE}, keyword -@vindex org-export-date-timestamp-format -A date or a time-stamp@footnote{The variable @code{org-export-date-timestamp-format} defines how -this timestamp are exported.}. - -@item @samp{EMAIL} -@cindex @samp{EMAIL}, keyword -@vindex user-mail-address -The email address (@code{user-mail-address}). - -@item @samp{LANGUAGE} -@cindex @samp{LANGUAGE}, keyword -@vindex org-export-default-language -Language to use for translating certain strings -(@code{org-export-default-language}). With @samp{#+LANGUAGE: fr}, for -example, Org translates @samp{Table of contents} to the French @samp{Table des - matières}@footnote{DEFINITION NOT FOUND@.}. - -@item @samp{SELECT_TAGS} -@cindex @samp{SELECT_TAGS}, keyword -@vindex org-export-select-tags -The default value is @samp{("export")}. When a tree is tagged with -@samp{export} (@code{org-export-select-tags}), Org selects that tree and its -sub-trees for export. Org excludes trees with @samp{noexport} tags, see -below. When selectively exporting files with @samp{export} tags set, Org -does not export any text that appears before the first headline. - -@item @samp{EXCLUDE_TAGS} -@cindex @samp{EXCLUDE_TAGS}, keyword -@vindex org-export-exclude-tags -The default value is @samp{("noexport")}. When a tree is tagged with -@samp{noexport} (@code{org-export-exclude-tags}), Org excludes that tree and -its sub-trees from export. Entries tagged with @samp{noexport} are -unconditionally excluded from the export, even if they have an -@samp{export} tag. Even if a sub-tree is not exported, Org executes any -code blocks contained there. - -@item @samp{TITLE} -@cindex @samp{TITLE}, keyword -@cindex document title -Org displays this title. For long titles, use multiple @samp{#+TITLE} -lines. - -@item @samp{EXPORT_FILE_NAME} -@cindex @samp{EXPORT_FILE_NAME}, keyword -The name of the output file to be generated. Otherwise, Org -generates the file name based on the buffer name and the extension -based on the back-end format. -@end table - -The @samp{OPTIONS} keyword is a compact form. To configure multiple -options, use several @samp{OPTIONS} lines. @samp{OPTIONS} recognizes the -following arguments. - -@table @asis -@item @code{'} -@vindex org-export-with-smart-quotes -Toggle smart quotes (@code{org-export-with-smart-quotes}). Depending on -the language used, when activated, Org treats pairs of double quotes -as primary quotes, pairs of single quotes as secondary quotes, and -single quote marks as apostrophes. - -@item @code{*} -@vindex org-export-with-emphasize -Toggle emphasized text (@code{org-export-with-emphasize}). - -@item @code{-} -@vindex org-export-with-special-strings -Toggle conversion of special strings -(@code{org-export-with-special-strings}). - -@item @code{:} -@vindex org-export-with-fixed-width -Toggle fixed-width sections (@code{org-export-with-fixed-width}). - -@item @code{<} -@vindex org-export-with-timestamps -Toggle inclusion of time/date active/inactive stamps -(@code{org-export-with-timestamps}). - -@item @code{\n} -@vindex org-export-preserve-breaks -Toggles whether to preserve line breaks -(@code{org-export-preserve-breaks}). - -@item @code{^} -@vindex org-export-with-sub-superscripts -Toggle @TeX{}-like syntax for sub- and superscripts. If you write -@samp{^:@{@}}, @samp{a_@{b@}} is interpreted, but the simple @samp{a_b} is left as it -is (@code{org-export-with-sub-superscripts}). - -@item @code{arch} -@vindex org-export-with-archived-trees -Configure how archived trees are exported. When set to @code{headline}, -the export process skips the contents and processes only the -headlines (@code{org-export-with-archived-trees}). - -@item @code{author} -@vindex org-export-with-author -Toggle inclusion of author name into exported file -(@code{org-export-with-author}). - -@item @code{broken-links} -@vindex org-export-with-broken-links -Toggles if Org should continue exporting upon finding a broken -internal link. When set to @code{mark}, Org clearly marks the problem -link in the output (@code{org-export-with-broken-links}). - -@item @code{c} -@vindex org-export-with-clocks -Toggle inclusion of @samp{CLOCK} keywords (@code{org-export-with-clocks}). - -@item @code{creator} -@vindex org-export-with-creator -Toggle inclusion of creator information in the exported file -(@code{org-export-with-creator}). - -@item @code{d} -@vindex org-export-with-drawers -Toggles inclusion of drawers, or list of drawers to include, or list -of drawers to exclude (@code{org-export-with-drawers}). - -@item @code{date} -@vindex org-export-with-date -Toggle inclusion of a date into exported file -(@code{org-export-with-date}). - -@item @code{e} -@vindex org-export-with-entities -Toggle inclusion of entities (@code{org-export-with-entities}). - -@item @code{email} -@vindex org-export-with-email -Toggle inclusion of the author's e-mail into exported file -(@code{org-export-with-email}). - -@item @code{f} -@vindex org-export-with-footnotes -Toggle the inclusion of footnotes (@code{org-export-with-footnotes}). - -@item @code{H} -@vindex org-export-headline-levels -Set the number of headline levels for export -(@code{org-export-headline-levels}). Below that level, headlines are -treated differently. In most back-ends, they become list items. - -@item @code{inline} -@vindex org-export-with-inlinetasks -Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}). - -@item @code{num} -@vindex org-export-with-section-numbers -@cindex @samp{UNNUMBERED}, property -Toggle section-numbers (@code{org-export-with-section-numbers}). When -set to number N, Org numbers only those headlines at level N or -above. Set @samp{UNNUMBERED} property to non-@code{nil} to disable numbering -of heading and subheadings entirely. Moreover, when the value is -@samp{notoc} the headline, and all its children, do not appear in the -table of contents either (see @ref{Table of Contents}). - -@item @code{p} -@vindex org-export-with-planning -Toggle export of planning information (@code{org-export-with-planning}). -``Planning information'' comes from lines located right after the -headline and contain any combination of these cookies: @samp{SCHEDULED}, -@samp{DEADLINE}, or @samp{CLOSED}. - -@item @code{pri} -@vindex org-export-with-priority -Toggle inclusion of priority cookies -(@code{org-export-with-priority}). - -@item @code{prop} -@vindex org-export-with-properties -Toggle inclusion of property drawers, or list the properties to -include (@code{org-export-with-properties}). - -@item @code{stat} -@vindex org-export-with-statistics-cookies -Toggle inclusion of statistics cookies -(@code{org-export-with-statistics-cookies}). - -@item @code{tags} -@vindex org-export-with-tags -Toggle inclusion of tags, may also be @code{not-in-toc} -(@code{org-export-with-tags}). - -@item @code{tasks} -@vindex org-export-with-tasks -Toggle inclusion of tasks (TODO items); or @code{nil} to remove all -tasks; or @code{todo} to remove done tasks; or list the keywords to keep -(@code{org-export-with-tasks}). - -@item @code{tex} -@vindex org-export-with-latex -@code{nil} does not export; @code{t} exports; @code{verbatim} keeps everything in -verbatim (@code{org-export-with-latex}). - -@item @code{timestamp} -@vindex org-export-time-stamp-file -Toggle inclusion of the creation time in the exported file -(@code{org-export-time-stamp-file}). - -@item @code{title} -@vindex org-export-with-title -Toggle inclusion of title (@code{org-export-with-title}). - -@item @code{toc} -@vindex org-export-with-toc -Toggle inclusion of the table of contents, or set the level limit -(@code{org-export-with-toc}). - -@item @code{todo} -@vindex org-export-with-todo-keywords -Toggle inclusion of TODO keywords into exported text -(@code{org-export-with-todo-keywords}). - -@item @code{|} -@vindex org-export-with-tables -Toggle inclusion of tables (@code{org-export-with-tables}). -@end table - -When exporting sub-trees, special node properties can override the -above keywords. These properties have an @samp{EXPORT_} prefix. For -example, @samp{DATE} becomes, @samp{EXPORT_DATE} when used for a specific -sub-tree. Except for @samp{SETUPFILE}, all other keywords listed above -have an @samp{EXPORT_} equivalent. - -@cindex @samp{BIND}, keyword -@vindex org-export-allow-bind-keywords -If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables can -become buffer-local during export by using the @samp{BIND} keyword. Its -syntax is @samp{#+BIND: variable value}. This is particularly useful for -in-buffer settings that cannot be changed using keywords. - -@node Table of Contents -@section Table of Contents - -@cindex table of contents -@cindex list of tables -@cindex list of listings - -@cindex @samp{toc}, in @samp{OPTIONS} keyword -@vindex org-export-with-toc -The table of contents includes all headlines in the document. Its -depth is therefore the same as the headline levels in the file. If -you need to use a different depth, or turn it off entirely, set the -@code{org-export-with-toc} variable accordingly. You can achieve the same -on a per file basis, using the following @samp{toc} item in @samp{OPTIONS} -keyword: - -@example -#+OPTIONS: toc:2 (only include two levels in TOC) -#+OPTIONS: toc:nil (no default TOC at all) -@end example - -@cindex excluding entries from table of contents -@cindex table of contents, exclude entries -Org includes both numbered and unnumbered headlines in the table of -contents@footnote{At the moment, some export back-ends do not obey this -specification. For example, @LaTeX{} export excludes every unnumbered -headline from the table of contents.}. If you need to exclude an unnumbered headline, -along with all its children, set the @samp{UNNUMBERED} property to @samp{notoc} -value. - -@example -* Subtree not numbered, not in table of contents either - :PROPERTIES: - :UNNUMBERED: notoc - :END: -@end example - -@cindex @samp{TOC}, keyword -Org normally inserts the table of contents directly before the first -headline of the file. To move the table of contents to a different -location, first turn off the default with @code{org-export-with-toc} -variable or with @samp{#+OPTIONS: toc:nil}. Then insert @samp{#+TOC: headlines -N} at the desired location(s). - -@example -#+OPTIONS: toc:nil -... -#+TOC: headlines 2 -@end example - -To adjust the table of contents depth for a specific section of the -Org document, append an additional @samp{local} parameter. This parameter -becomes a relative depth for the current level. The following example -inserts a local table of contents, with direct children only. - -@example -* Section -#+TOC: headlines 1 local -@end example - -Note that for this feature to work properly in @LaTeX{} export, the Org -file requires the inclusion of the titletoc package. Because of -compatibility issues, titletoc has to be loaded @emph{before} hyperref. -Customize the @code{org-latex-default-packages-alist} variable. - -The following example inserts a table of contents that links to the -children of the specified target. - -@example -* Target - :PROPERTIES: - :CUSTOM_ID: TargetSection - :END: -** Heading A -** Heading B -* Another section -#+TOC: headlines 1 :target #TargetSection -@end example - -The @samp{:target} attribute is supported in HTML, Markdown, ODT, and ASCII export. - -Use the @samp{TOC} keyword to generate list of tables---respectively, all -listings---with captions. - -@example -#+TOC: listings -#+TOC: tables -@end example - -@cindex @samp{ALT_TITLE}, property -Normally Org uses the headline for its entry in the table of contents. -But with @samp{ALT_TITLE} property, a different entry can be specified for -the table of contents. - -@node Include Files -@section Include Files - -@cindex include files, during export -@cindex export, include files -@cindex @samp{INCLUDE}, keyword - -During export, you can include the content of another file. For -example, to include your @samp{.emacs} file, you could use: - -@example -#+INCLUDE: "~/.emacs" src emacs-lisp -@end example - - -@noindent -The first parameter is the file name to include. The optional second -parameter specifies the block type: @samp{example}, @samp{export} or @samp{src}. The -optional third parameter specifies the source code language to use for -formatting the contents. This is relevant to both @samp{export} and @samp{src} -block types. - -If an included file is specified as having a markup language, Org -neither checks for valid syntax nor changes the contents in any way. -For example and source blocks, Org code-escapes the contents before -inclusion. - -@cindex @samp{minlevel}, include -If an included file is not specified as having any markup language, -Org assumes it be in Org format and proceeds as usual with a few -exceptions. Org makes the footnote labels (see @ref{Creating Footnotes}) -in the included file local to that file. The contents of the included -file belong to the same structure---headline, item---containing the -@samp{INCLUDE} keyword. In particular, headlines within the file become -children of the current section. That behavior can be changed by -providing an additional keyword parameter, @samp{:minlevel}. It shifts the -headlines in the included file to become the lowest level. For -example, this syntax makes the included file a sibling of the current -top-level headline: - -@example -#+INCLUDE: "~/my-book/chapter2.org" :minlevel 1 -@end example - - -@cindex @samp{lines}, include -Inclusion of only portions of files are specified using ranges -parameter with @samp{:lines} keyword. The line at the upper end of the -range will not be included. The start and/or the end of the range may -be omitted to use the obvious defaults. - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{#+INCLUDE: "~/.emacs" :lines "5-10"} -@tab Include lines 5 to 10, 10 excluded -@item @samp{#+INCLUDE: "~/.emacs" :lines "-10"} -@tab Include lines 1 to 10, 10 excluded -@item @samp{#+INCLUDE: "~/.emacs" :lines "10-"} -@tab Include lines from 10 to EOF -@end multitable - -Inclusions may specify a file-link to extract an object matched by -@code{org-link-search}@footnote{Note that @code{org-link-search-must-match-exact-headline} is -locally bound to non-@code{nil}. Therefore, @code{org-link-search} only matches -headlines and named elements.} (see @ref{Search Options}). The -ranges for @samp{:lines} keyword are relative to the requested element. -Therefore, - -@example -#+INCLUDE: "./paper.org::*conclusion" :lines 1-20 -@end example - - -@noindent -includes the first 20 lines of the headline named @samp{conclusion}. - -@cindex @samp{only-contents}, include -To extract only the contents of the matched object, set -@samp{:only-contents} property to non-@code{nil}. This omits any planning lines -or property drawers. For example, to include the body of the heading -with the custom ID @samp{theory}, you can use - -@example -#+INCLUDE: "./paper.org::#theory" :only-contents t -@end example - - -The following command allows navigating to the included document: - -@table @asis -@item @kbd{C-c '} (@code{org-edit~special}) -@kindex C-c ' -@findex org-edit-special - -Visit the included file at point. -@end table - -@node Macro Replacement -@section Macro Replacement - -@cindex macro replacement, during export -@cindex @samp{MACRO}, keyword - -@vindex org-export-global-macros -Macros replace text snippets during export. Macros are defined -globally in @code{org-export-global-macros}, or document-wise with the -following syntax: - -@example -#+MACRO: name replacement text; $1, $2 are arguments -@end example - - -@noindent -which can be referenced using @samp{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate the arguments, commas within arguments -have to be escaped with the backslash character. So only those -backslash characters before a comma need escaping with another -backslash character.}. For -example - -@example -#+MACRO: poem Rose is $1, violet's $2. Life's ordered: Org assists you. -@{@{@{poem(red,blue)@}@}@} -@end example - -@noindent -becomes - -@example -Rose is red, violet's blue. Life's ordered: Org assists you. -@end example - - -As a special case, Org parses any replacement text starting with -@samp{(eval} as an Emacs Lisp expression and evaluates it accordingly. -Within such templates, arguments become strings. Thus, the following -macro - -@example -#+MACRO: gnustamp (eval (concat "GNU/" (capitalize $1))) -@end example - - -@noindent -turns @samp{@{@{@{gnustamp(linux)@}@}@}} into @samp{GNU/Linux} during export. - -Org recognizes macro references in following Org markup areas: -paragraphs, headlines, verse blocks, tables cells and lists. Org also -recognizes macro references in keywords, such as @samp{CAPTION}, @samp{TITLE}, -@samp{AUTHOR}, @samp{DATE}, and for some back-end specific export options. - -Org comes with following pre-defined macros: - -@table @asis -@item @samp{@{@{@{keyword(NAME)@}@}@}} -@itemx @samp{@{@{@{title@}@}@}} -@itemx @samp{@{@{@{author@}@}@}} -@itemx @samp{@{@{@{email@}@}@}} -@cindex @samp{keyword}, macro -@cindex @samp{title}, macro -@cindex @samp{author}, macro -@cindex @samp{email}, macro -The @samp{keyword} macro collects all values from @var{NAME} -keywords throughout the buffer, separated with white space. -@samp{title}, @samp{author} and @samp{email} macros are shortcuts for, -respectively, @samp{@{@{@{keyword(TITLE)@}@}@}}, @samp{@{@{@{keyword(AUTHOR)@}@}@}} and -@samp{@{@{@{keyword(EMAIL)@}@}@}}. - -@item @samp{@{@{@{date@}@}@}} -@itemx @samp{@{@{@{date(FORMAT)@}@}@}} -@cindex @samp{date}, macro -This macro refers to the @samp{DATE} keyword. @var{FORMAT} is an -optional argument to the @samp{date} macro that is used only if @samp{DATE} is -a single timestamp. @var{FORMAT} should be a format string -understood by @code{format-time-string}. - -@item @samp{@{@{@{time(FORMAT)@}@}@}} -@itemx @samp{@{@{@{modification-time(FORMAT, VC)@}@}@}} -@cindex @samp{time}, macro -@cindex @samp{modification-time}, macro -These macros refer to the document's date and time of export and -date and time of modification. @var{FORMAT} is a string -understood by @code{format-time-string}. If the second argument to the -@code{modification-time} macro is non-@code{nil}, Org uses @samp{vc.el} to retrieve -the document's modification time from the version control system. -Otherwise Org reads the file attributes. - -@item @samp{@{@{@{input-file@}@}@}} -@cindex @samp{input-file}, macro -This macro refers to the filename of the exported file. - -@item @samp{@{@{@{property(PROPERTY-NAME)@}@}@}} -@itemx @samp{@{@{@{property(PROPERTY-NAME, SEARCH OPTION)@}@}@}} -@cindex @samp{property}, macro -This macro returns the value of property @var{PROPERTY-NAME} in -the current entry. If @var{SEARCH-OPTION} (see @ref{Search Options}) refers to a remote entry, use it instead. - -@item @samp{@{@{@{n@}@}@}} -@itemx @samp{@{@{@{n(NAME)@}@}@}} -@itemx @samp{@{@{@{n(NAME, ACTION)@}@}@}} -@cindex @samp{n}, macro -@cindex counter, macro -This macro implements custom counters by returning the number of -times the macro has been expanded so far while exporting the buffer. -You can create more than one counter using different @var{NAME} -values. If @var{ACTION} is @samp{-}, previous value of the counter -is held, i.e., the specified counter is not incremented. If the -value is a number, the specified counter is set to that value. If -it is any other non-empty string, the specified counter is reset -to 1. You may leave @var{NAME} empty to reset the default -counter. -@end table - -@cindex @samp{results}, macro -Moreover, inline source blocks (see @ref{Structure of Code Blocks}) use the -special @samp{results} macro to mark their output. As such, you are -advised against re-defining it, unless you know what you are doing. - -@vindex org-hide-macro-markers -The surrounding brackets can be made invisible by setting -@code{org-hide-macro-markers} to a non-@code{nil} value. - -Org expands macros at the very beginning of the export process. - -@node Comment Lines -@section Comment Lines - -@cindex exporting, not - -@cindex comment lines -Lines starting with zero or more whitespace characters followed by one -@samp{#} and a whitespace are treated as comments and, as such, are not -exported. - -@cindex @samp{BEGIN_COMMENT} -@cindex comment block -Likewise, regions surrounded by @samp{#+BEGIN_COMMENT} @dots{} @samp{#+END_COMMENT} -are not exported. - -@cindex comment trees -Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after -any other keyword or priority cookie, comments out the entire subtree. -In this case, the subtree is not exported and no code block within it -is executed either@footnote{For a less drastic behavior, consider using a select tag (see -@ref{Export Settings}) instead.}. The command below helps changing the -comment status of a headline. - -@table @asis -@item @kbd{C-c ;} (@code{org-toggle-comment}) -@kindex C-c ; -@findex org-toggle-comment - -Toggle the @samp{COMMENT} keyword at the beginning of an entry. -@end table - -@node ASCII/Latin-1/UTF-8 export -@section ASCII/Latin-1/UTF-8 export - -@cindex ASCII export -@cindex Latin-1 export -@cindex UTF-8 export - -ASCII export produces an output file containing only plain ASCII -characters. This is the simplest and most direct text output. It -does not contain any Org markup. Latin-1 and UTF-8 export use -additional characters and symbols available in these encoding -standards. All three of these export formats offer the most basic of -text output for maximum portability. - -@vindex org-ascii-text-width -On export, Org fills and justifies text according to the text width -set in @code{org-ascii-text-width}. - -@vindex org-ascii-links-to-notes -Org exports links using a footnote-like style where the descriptive -part is in the text and the link is in a note before the next heading. -See the variable @code{org-ascii-links-to-notes} for details. - -@anchor{ASCII export commands} -@subheading ASCII export commands - -@table @asis -@item @kbd{C-c C-e t a} (@code{org-ascii-export-to-ascii}) -@itemx @kbd{C-c C-e t l} -@itemx @kbd{C-c C-e t u} -@kindex C-c C-e t a -@kindex C-c C-e t l -@kindex C-c C-e t u -@findex org-ascii-export-to-ascii - -Export as an ASCII file with a @samp{.txt} extension. For @samp{myfile.org}, -Org exports to @samp{myfile.txt}, overwriting without warning. For -@samp{myfile.txt}, Org exports to @samp{myfile.txt.txt} in order to prevent -data loss. - -@item @kbd{C-c C-e t A} (@code{org-ascii-export-to-ascii}) -@itemx @kbd{C-c C-e t L} -@itemx @kbd{C-c C-e t U} -@kindex C-c C-e t A -@kindex C-c C-e t L -@kindex C-c C-e t U -@findex org-ascii-export-as-ascii - -Export to a temporary buffer. Does not create a file. -@end table - -@anchor{ASCII specific export settings} -@subheading ASCII specific export settings - -The ASCII export back-end has one extra keyword for customizing ASCII -output. Setting this keyword works similar to the general options -(see @ref{Export Settings}). - -@table @asis -@item @samp{SUBTITLE} -@cindex @samp{SUBTITLE}, keyword -The document subtitle. For long subtitles, use multiple -@samp{#+SUBTITLE} lines in the Org file. Org prints them on one -continuous line, wrapping into multiple lines if necessary. -@end table - -@anchor{Header and sectioning structure} -@subheading Header and sectioning structure - -Org converts the first three outline levels into headlines for ASCII -export. The remaining levels are turned into lists. To change this -cut-off point where levels become lists, see @ref{Export Settings}. - -@anchor{Quoting ASCII text} -@subheading Quoting ASCII text - -To insert text within the Org file by the ASCII back-end, use one the -following constructs, inline, keyword, or export block: - -@cindex @samp{ASCII}, keyword -@cindex @samp{BEGIN_EXPORT ascii} -@example -Inline text @@@@ascii:and additional text@@@@ within a paragraph. - -#+ASCII: Some text - -#+BEGIN_EXPORT ascii -Org exports text in this block only when using ASCII back-end. -#+END_EXPORT -@end example - -@anchor{ASCII specific attributes} -@subheading ASCII specific attributes - -@cindex @samp{ATTR_ASCII}, keyword -@cindex horizontal rules, in ASCII export - -ASCII back-end recognizes only one attribute, @samp{:width}, which -specifies the width of a horizontal rule in number of characters. The -keyword and syntax for specifying widths is: - -@example -#+ATTR_ASCII: :width 10 ------ -@end example - -@anchor{ASCII special blocks} -@subheading ASCII special blocks - -@cindex special blocks, in ASCII export -@cindex @samp{BEGIN_JUSTIFYLEFT} -@cindex @samp{BEGIN_JUSTIFYRIGHT} - -Besides @samp{#+BEGIN_CENTER} blocks (see @ref{Paragraphs}), ASCII back-end has -these two left and right justification blocks: - -@example -#+BEGIN_JUSTIFYLEFT -It's just a jump to the left... -#+END_JUSTIFYLEFT - -#+BEGIN_JUSTIFYRIGHT -...and then a step to the right. -#+END_JUSTIFYRIGHT -@end example - -@node Beamer Export -@section Beamer Export - -@cindex Beamer export - -Org uses Beamer export to convert an Org file tree structure into -high-quality interactive slides for presentations. Beamer is a @LaTeX{} -document class for creating presentations in PDF, HTML, and other -popular display formats. - -@menu -* Beamer export commands:: For creating Beamer documents. -* Beamer specific export settings:: For customizing Beamer export. -* Frames and Blocks in Beamer:: For composing Beamer slides. -* Beamer specific syntax:: For using in Org documents. -* Editing support:: Editing support. -* A Beamer example:: A complete presentation. -@end menu - -@node Beamer export commands -@subsection Beamer export commands - -@table @asis -@item @kbd{C-c C-e l b} (@code{org-beamer-export-to-latex}) -@kindex C-c C-e l b -@findex org-beamer-export-to-latex - -Export as @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org}, Org -exports to @samp{myfile.tex}, overwriting without warning. - -@item @kbd{C-c C-e l B} (@code{org-beamer-export-as-latex}) -@kindex C-c C-e l B -@findex org-beamer-export-as-latex - -Export to a temporary buffer. Does not create a file. - -@item @kbd{C-c C-e l P} (@code{org-beamer-export-to-pdf}) -@kindex C-c C-e l P -@findex org-beamer-export-to-pdf - -Export as @LaTeX{} file and then convert it to PDF format. - -@item @kbd{C-c C-e l O} -@kindex C-c C-e l O - -Export as @LaTeX{} file, convert it to PDF format, and then open the -PDF file. -@end table - -@node Beamer specific export settings -@subsection Beamer specific export settings - -Beamer export back-end has several additional keywords for customizing -Beamer output. These keywords work similar to the general options -settings (see @ref{Export Settings}). - -@table @asis -@item @samp{BEAMER_THEME} -@cindex @samp{BEAMER_THEME}, keyword -@vindex org-beamer-theme -The Beamer layout theme (@code{org-beamer-theme}). Use square brackets -for options. For example: - -@example -#+BEAMER_THEME: Rochester [height=20pt] -@end example - -@item @samp{BEAMER_FONT_THEME} -@cindex @samp{BEAMER_FONT_THEME}, keyword -The Beamer font theme. - -@item @samp{BEAMER_INNER_THEME} -@cindex @samp{BEAMER_INNER_THEME}, keyword -The Beamer inner theme. - -@item @samp{BEAMER_OUTER_THEME} -@cindex @samp{BEAMER_OUTER_THEME}, keyword -The Beamer outer theme. - -@item @samp{BEAMER_HEADER} -@cindex @samp{BEAMER_HEADER}, keyword -Arbitrary lines inserted in the preamble, just before the @samp{hyperref} -settings. - -@item @samp{DESCRIPTION} -@cindex @samp{DESCRIPTION}, keyword -The document description. For long descriptions, use multiple -@samp{DESCRIPTION} keywords. By default, @samp{hyperref} inserts -@samp{DESCRIPTION} as metadata. Use @code{org-latex-hyperref-template} to -configure document metadata. Use @code{org-latex-title-command} to -configure typesetting of description as part of front matter. - -@item @samp{KEYWORDS} -@cindex @samp{KEYWORDS}, keyword -The keywords for defining the contents of the document. Use -multiple @samp{KEYWORDS} lines if necessary. By default, @samp{hyperref} -inserts @samp{KEYWORDS} as metadata. Use @code{org-latex-hyperref-template} -to configure document metadata. Use @code{org-latex-title-command} to -configure typesetting of keywords as part of front matter. - -@item @samp{SUBTITLE} -@cindex @samp{SUBTITLE}, keyword -Document's subtitle. For typesetting, use -@code{org-beamer-subtitle-format} string. Use -@code{org-latex-hyperref-template} to configure document metadata. Use -@code{org-latex-title-command} to configure typesetting of subtitle as -part of front matter. -@end table - -@node Frames and Blocks in Beamer -@subsection Frames and Blocks in Beamer - -Org transforms heading levels into Beamer's sectioning elements, -frames and blocks. Any Org tree with a not-too-deep-level nesting -should in principle be exportable as a Beamer presentation. - -@itemize -@item -@vindex org-beamer-frame-level -Org headlines become Beamer frames when the heading level in Org is -equal to @code{org-beamer-frame-level} or @samp{H} value in a @samp{OPTIONS} line -(see @ref{Export Settings}). - -@cindex @samp{BEAMER_ENV}, property -Org overrides headlines to frames conversion for the current tree of -an Org file if it encounters the @samp{BEAMER_ENV} property set to -@samp{frame} or @samp{fullframe}. Org ignores whatever -@code{org-beamer-frame-level} happens to be for that headline level in -the Org tree. In Beamer terminology, a full frame is a frame -without its title. - -@item -Org exports a Beamer frame's objects as block environments. Org can -enforce wrapping in special block types when @samp{BEAMER_ENV} property -is set@footnote{If @samp{BEAMER_ENV} is set, Org export adds @samp{B_environment} tag -to make it visible. The tag serves as a visual aid and has no -semantic relevance.}. For valid values see -@code{org-beamer-environments-default}. To add more values, see -@code{org-beamer-environments-extra}. -@vindex org-beamer-environments-default -@vindex org-beamer-environments-extra - -@item -@cindex @samp{BEAMER_REF}, property -If @samp{BEAMER_ENV} is set to @samp{appendix}, Org exports the entry as an -appendix. When set to @samp{note}, Org exports the entry as a note -within the frame or between frames, depending on the entry's heading -level. When set to @samp{noteNH}, Org exports the entry as a note -without its title. When set to @samp{againframe}, Org exports the entry -with @samp{\againframe} command, which makes setting the @samp{BEAMER_REF} -property mandatory because @samp{\againframe} needs frame to resume. - -When @samp{ignoreheading} is set, Org export ignores the entry's headline -but not its content. This is useful for inserting content between -frames. It is also useful for properly closing a @samp{column} -environment. @@end itemize - -@cindex @samp{BEAMER_ACT}, property -@cindex @samp{BEAMER_OPT}, property -When @samp{BEAMER_ACT} is set for a headline, Org export translates that -headline as an overlay or action specification. When enclosed in -square brackets, Org export makes the overlay specification -a default. Use @samp{BEAMER_OPT} to set any options applicable to the -current Beamer frame or block. The Beamer export back-end wraps -with appropriate angular or square brackets. It also adds the -@samp{fragile} option for any code that may require a verbatim block. - -@cindex @samp{BEAMER_COL}, property -To create a column on the Beamer slide, use the @samp{BEAMER_COL} -property for its headline in the Org file. Set the value of -@samp{BEAMER_COL} to a decimal number representing the fraction of the -total text width. Beamer export uses this value to set the column's -width and fills the column with the contents of the Org entry. If -the Org entry has no specific environment defined, Beamer export -ignores the heading. If the Org entry has a defined environment, -Beamer export uses the heading as title. Behind the scenes, Beamer -export automatically handles @LaTeX{} column separations for contiguous -headlines. To manually adjust them for any unique configurations -needs, use the @samp{BEAMER_ENV} property. -@end itemize - -@node Beamer specific syntax -@subsection Beamer specific syntax - -Since Org's Beamer export back-end is an extension of the @LaTeX{} -back-end, it recognizes other @LaTeX{} specific syntax---for example, -@samp{#+LATEX:} or @samp{#+ATTR_LATEX:}. See @ref{@LaTeX{} Export}, for details. - -Beamer export wraps the table of contents generated with @samp{toc:t} -@samp{OPTION} keyword in a @samp{frame} environment. Beamer export does not -wrap the table of contents generated with @samp{TOC} keyword (see @ref{Table of Contents}). Use square brackets for specifying options. - -@example -#+TOC: headlines [currentsection] -@end example - - -Insert Beamer-specific code using the following constructs: - -@cindex @samp{BEAMER}, keyword -@cindex @samp{BEGIN_EXPORT beamer} -@example -#+BEAMER: \pause - -#+BEGIN_EXPORT beamer - Only Beamer export back-end exports this. -#+END_BEAMER - -Text @@@@beamer:some code@@@@ within a paragraph. -@end example - -Inline constructs, such as the last one above, are useful for adding -overlay specifications to objects with @code{bold}, @code{item}, @code{link}, -@code{radio-target} and @code{target} types. Enclose the value in angular -brackets and place the specification at the beginning of the object as -shown in this example: - -@example -A *@@@@beamer:<2->@@@@useful* feature -@end example - - -@cindex @samp{ATTR_BEAMER}, keyword -Beamer export recognizes the @samp{ATTR_BEAMER} keyword with the following -attributes from Beamer configurations: @samp{:environment} for changing -local Beamer environment, @samp{:overlay} for specifying Beamer overlays in -angular or square brackets, and @samp{:options} for inserting optional -arguments. - -@example -#+ATTR_BEAMER: :environment nonindentlist -- item 1, not indented -- item 2, not indented -- item 3, not indented -@end example - -@example -#+ATTR_BEAMER: :overlay <+-> -- item 1 -- item 2 -@end example - -@example -#+ATTR_BEAMER: :options [Lagrange] -Let $G$ be a finite group, and let $H$ be -a subgroup of $G$. Then the order of $H$ divides the order of $G$. -@end example - -@node Editing support -@subsection Editing support - -Org Beamer mode is a special minor mode for faster editing of Beamer -documents. - -@example -#+STARTUP: beamer -@end example - - -@table @asis -@item @kbd{C-c C-b} (@code{org-beamer-select-environment}) -@kindex C-c C-b -@findex org-beamer-select-environment - -Org Beamer mode provides this key for quicker selections in Beamer -normal environments, and for selecting the @samp{BEAMER_COL} property. -@end table - -@node A Beamer example -@subsection A Beamer example - -Here is an example of an Org document ready for Beamer export. - -@example -#+TITLE: Example Presentation -#+AUTHOR: Carsten Dominik -#+OPTIONS: H:2 toc:t num:t -#+LATEX_CLASS: beamer -#+LATEX_CLASS_OPTIONS: [presentation] -#+BEAMER_THEME: Madrid -#+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) - -* This is the first structural section - -** Frame 1 -*** Thanks to Eric Fraga :B_block: - :PROPERTIES: - :BEAMER_COL: 0.48 - :BEAMER_ENV: block - :END: - for the first viable Beamer setup in Org -*** Thanks to everyone else :B_block: - :PROPERTIES: - :BEAMER_COL: 0.48 - :BEAMER_ACT: <2-> - :BEAMER_ENV: block - :END: - for contributing to the discussion -**** This will be formatted as a beamer note :B_note: - :PROPERTIES: - :BEAMER_env: note - :END: -** Frame 2 (where we will not use columns) -*** Request - Please test this stuff! -@end example - -@node HTML Export -@section HTML Export - -@cindex HTML export - -Org mode contains an HTML exporter with extensive HTML formatting -compatible with XHTML 1.0 strict standard. - -@menu -* HTML export commands:: Invoking HTML export. -* HTML specific export settings:: Settings for HTML export. -* HTML doctypes:: Exporting various (X)HTML flavors. -* HTML preamble and postamble:: Inserting preamble and postamble. -* Quoting HTML tags:: Using direct HTML in Org files. -* Headlines in HTML export:: Formatting headlines. -* Links in HTML export:: Inserting and formatting links. -* Tables in HTML export:: How to modify the formatting of tables. -* Images in HTML export:: How to insert figures into HTML output. -* Math formatting in HTML export:: Beautiful math also on the web. -* Text areas in HTML export:: An alternate way to show an example. -* CSS support:: Changing the appearance of the output. -* JavaScript support:: Info and folding in a web browser. -@end menu - -@node HTML export commands -@subsection HTML export commands - -@table @asis -@item @kbd{C-c C-e h h} (@code{org-html-export-to-html}) -@kindex C-c C-e h h -@kindex C-c C-e h o -@findex org-html-export-to-html - -Export as HTML file with a @samp{.html} extension. For @samp{myfile.org}, Org -exports to @samp{myfile.html}, overwriting without warning. @{@{@{kbd@{C-c -C-e h o)@}@}@} exports to HTML and opens it in a web browser. - -@item @kbd{C-c C-e h H} (@code{org-html-export-as-html}) -@kindex C-c C-e h H -@findex org-html-export-as-html - -Exports to a temporary buffer. Does not create a file. -@end table - -@node HTML specific export settings -@subsection HTML specific export settings - -HTML export has a number of keywords, similar to the general options -settings described in @ref{Export Settings}. - -@table @asis -@item @samp{DESCRIPTION} -@cindex @samp{DESCRIPTION}, keyword -This is the document's description, which the HTML exporter inserts -it as a HTML meta tag in the HTML file. For long descriptions, use -multiple @samp{DESCRIPTION} lines. The exporter takes care of wrapping -the lines properly. - -@item @samp{HTML_DOCTYPE} -@cindex @samp{HTML_DOCTYPE}, keyword -@vindex org-html-doctype -Specify the document type, for example: HTML5 (@code{org-html-doctype}). - -@item @samp{HTML_CONTAINER} -@cindex @samp{HTML_CONTAINER}, keyword -@vindex org-html-container-element -Specify the HTML container, such as @samp{div}, for wrapping sections and -elements (@code{org-html-container-element}). - -@item @samp{HTML_LINK_HOME} -@cindex @samp{HTML_LINK_HOME}, keyword -@vindex org-html-link-home -The URL for home link (@code{org-html-link-home}). - -@item @samp{HTML_LINK_UP} -@cindex @samp{HTML_LINK_UP}, keyword -@vindex org-html-link-up -The URL for the up link of exported HTML pages (@code{org-html-link-up}). - -@item @samp{HTML_MATHJAX} -@cindex @samp{HTML_MATHJAX}, keyword -@vindex org-html-mathjax-options -Options for MathJax (@code{org-html-mathjax-options}). MathJax is used -to typeset @LaTeX{} math in HTML documents. See @ref{Math formatting in HTML export}, for an example. - -@item @samp{HTML_HEAD} -@cindex @samp{HTML_HEAD}, keyword -@vindex org-html-head -Arbitrary lines for appending to the HTML document's head -(@code{org-html-head}). - -@item @samp{HTML_HEAD_EXTRA} -@cindex @samp{HTML_HEAD_EXTRA}, keyword -@vindex org-html-head-extra -More arbitrary lines for appending to the HTML document's head -(@code{org-html-head-extra}). - -@item @samp{KEYWORDS} -@cindex @samp{KEYWORDS}, keyword -Keywords to describe the document's content. HTML exporter inserts -these keywords as HTML meta tags. For long keywords, use multiple -@samp{KEYWORDS} lines. - -@item @samp{LATEX_HEADER} -@cindex @samp{LATEX_HEADER}, keyword -Arbitrary lines for appending to the preamble; HTML exporter appends -when transcoding @LaTeX{} fragments to images (see @ref{Math formatting in HTML export}). - -@item @samp{SUBTITLE} -@cindex @samp{SUBTITLE}, keyword -The document's subtitle. HTML exporter formats subtitle if document -type is @samp{HTML5} and the CSS has a @samp{subtitle} class. -@end table - -Some of these keywords are explained in more detail in the following -sections of the manual. - -@node HTML doctypes -@subsection HTML doctypes - -Org can export to various (X)HTML flavors. - -@vindex org-html-doctype -@vindex org-html-doctype-alist -Set the @code{org-html-doctype} variable for different (X)HTML variants. -Depending on the variant, the HTML exporter adjusts the syntax of HTML -conversion accordingly. Org includes the following ready-made -variants: - -@itemize -@item -@code{"html4-strict"} -@item -@code{"html4-transitional"} -@item -@code{"html4-frameset"} -@item -@code{"xhtml-strict"} -@item -@code{"xhtml-transitional"} -@item -@code{"xhtml-frameset"} -@item -@code{"xhtml-11"} -@item -@code{"html5"} -@item -@code{"xhtml5"} -@end itemize - -@noindent -See the variable @code{org-html-doctype-alist} for details. The default is -@code{"xhtml-strict"}. - -@vindex org-html-html5-fancy -@cindex @samp{HTML5}, export new elements -Org's HTML exporter does not by default enable new block elements -introduced with the HTML5 standard. To enable them, set -@code{org-html-html5-fancy} to non-@code{nil}. Or use an @samp{OPTIONS} line in the -file to set @samp{html5-fancy}. - -HTML5 documents can now have arbitrary @samp{#+BEGIN} @dots{} @samp{#+END} blocks. -For example: - -@example -#+BEGIN_aside - Lorem ipsum -#+END_aside -@end example - -@noindent -exports to: - -@example -<aside> - <p>Lorem ipsum</p> -</aside> -@end example - -@noindent -while this: - -@example -#+ATTR_HTML: :controls controls :width 350 -#+BEGIN_video -#+HTML: <source src="movie.mp4" type="video/mp4"> -#+HTML: <source src="movie.ogg" type="video/ogg"> -Your browser does not support the video tag. -#+END_video -@end example - -@noindent -exports to: - -@example -<video controls="controls" width="350"> - <source src="movie.mp4" type="video/mp4"> - <source src="movie.ogg" type="video/ogg"> - <p>Your browser does not support the video tag.</p> -</video> -@end example - -@vindex org-html-html5-elements -When special blocks do not have a corresponding HTML5 element, the -HTML exporter reverts to standard translation (see -@code{org-html-html5-elements}). For example, @samp{#+BEGIN_lederhosen} exports -to @code{<div class="lederhosen">}. - -Special blocks cannot have headlines. For the HTML exporter to wrap -the headline and its contents in @code{<section>} or @code{<article>} tags, set -the @samp{HTML_CONTAINER} property for the headline. - -@node HTML preamble and postamble -@subsection HTML preamble and postamble - -@vindex org-html-preamble -@vindex org-html-postamble -@vindex org-html-preamble-format -@vindex org-html-postamble-format -@vindex org-html-validation-link -@vindex org-export-creator-string -@vindex org-export-time-stamp-file - -The HTML exporter has delineations for preamble and postamble. The -default value for @code{org-html-preamble} is @code{t}, which makes the HTML -exporter insert the preamble. See the variable -@code{org-html-preamble-format} for the format string. - -Set @code{org-html-preamble} to a string to override the default format -string. If the string is a function, the HTML exporter expects the -function to return a string upon execution. The HTML exporter inserts -this string in the preamble. The HTML exporter does not insert -a preamble if @code{org-html-preamble} is set @code{nil}. - -The default value for @code{org-html-postamble} is @code{auto}, which makes the -HTML exporter build a postamble from looking up author's name, email -address, creator's name, and date. Set @code{org-html-postamble} to @code{t} to -insert the postamble in the format specified in the -@code{org-html-postamble-format} variable. The HTML exporter does not -insert a postamble if @code{org-html-postamble} is set to @code{nil}. - -@node Quoting HTML tags -@subsection Quoting HTML tags - -The HTML export back-end transforms @samp{<} and @samp{>} to @samp{<} and @samp{>}. -To include raw HTML code in the Org file so the HTML export back-end -can insert that HTML code in the output, use this inline syntax: -@samp{@@@@html:...@@@@}. For example: - -@example -@@@@html:<b>@@@@bold text@@@@html:</b>@@@@ -@end example - - -@cindex @samp{HTML}, keyword -@cindex @samp{BEGIN_EXPORT html} -For larger raw HTML code blocks, use these HTML export code blocks: - -@example -#+HTML: Literal HTML code for export - -#+BEGIN_EXPORT html - All lines between these markers are exported literally -#+END_EXPORT -@end example - -@node Headlines in HTML export -@subsection Headlines in HTML export - -@cindex headlines, in HTML export - -Headlines are exported to @samp{<h1>}, @samp{<h2>}, etc. Each headline gets the -@samp{id} attribute from @samp{CUSTOM_ID} property, or a unique generated value, -see @ref{Internal Links}. - -@vindex org-html-self-link-headlines -When @code{org-html-self-link-headlines} is set to a non-@code{nil} value, the -text of the headlines is also wrapped in @samp{<a>} tags. These tags have -a @samp{href} attribute making the headlines link to themselves. - -@node Links in HTML export -@subsection Links in HTML export - -@cindex links, in HTML export -@cindex internal links, in HTML export -@cindex external links, in HTML export - -The HTML export back-end transforms Org's internal links (see -@ref{Internal Links}) to equivalent HTML links in the output. The back-end -similarly handles Org's automatic links created by radio targets (see -@ref{Radio Targets}) similarly. For Org links to external files, the -back-end transforms the links to @emph{relative} paths. - -@vindex org-html-link-org-files-as-html -For Org links to other @samp{.org} files, the back-end automatically -changes the file extension to @samp{.html} and makes file paths relative. -If the @samp{.org} files have an equivalent @samp{.html} version at the same -location, then the converted links should work without any further -manual intervention. However, to disable this automatic path -translation, set @code{org-html-link-org-files-as-html} to @code{nil}. When -disabled, the HTML export back-end substitutes the ID-based links in -the HTML output. For more about linking files when publishing to -a directory, see @ref{Publishing links}. - -Org files can also have special directives to the HTML export -back-end. For example, by using @samp{#+ATTR_HTML} lines to specify new -format attributes to @code{<a>} or @code{<img>} tags. This example shows -changing the link's title and style: - -@cindex @samp{ATTR_HTML}, keyword -@example -#+ATTR_HTML: :title The Org mode homepage :style color:red; -[[https://orgmode.org]] -@end example - -@node Tables in HTML export -@subsection Tables in HTML export - -@cindex tables, in HTML -@vindex org-export-html-table-tag - -The HTML export back-end uses @code{org-html-table-default-attributes} when -exporting Org tables to HTML@. By default, the exporter does not draw -frames and cell borders. To change for this for a table, use the -following lines before the table in the Org file: - -@cindex @samp{CAPTION}, keyword -@cindex @samp{ATTR_HTML}, keyword -@example -#+CAPTION: This is a table with lines around and between cells -#+ATTR_HTML: :border 2 :rules all :frame border -@end example - -The HTML export back-end preserves column groupings in Org tables (see -@ref{Column Groups}) when exporting to HTML@. - -Additional options for customizing tables for HTML export. - -@table @asis -@item @code{org-html-table-align-individual-fields} -@vindex org-html-table-align-individual-fields -Non-@code{nil} attaches style attributes for alignment to each table -field. - -@item @code{org-html-table-caption-above} -@vindex org-html-table-caption-above -Non-@code{nil} places caption string at the beginning of the table. - -@item @code{org-html-table-data-tags} -@vindex org-html-table-data-tags -Opening and ending tags for table data fields. - -@item @code{org-html-table-default-attributes} -@vindex org-html-table-default-attributes -Default attributes and values for table tags. - -@item @code{org-html-table-header-tags} -@vindex org-html-table-header-tags -Opening and ending tags for table's header fields. - -@item @code{org-html-table-row-tags} -@vindex org-html-table-row-tags -Opening and ending tags for table rows. - -@item @code{org-html-table-use-header-tags-for-first-column} -@vindex org-html-table-use-header-tags-for-first-column -Non-@code{nil} formats column one in tables with header tags. -@end table - -@node Images in HTML export -@subsection Images in HTML export - -@cindex images, inline in HTML -@cindex inlining images in HTML - -The HTML export back-end has features to convert Org image links to -HTML inline images and HTML clickable image links. - -@vindex org-html-inline-images -When the link in the Org file has no description, the HTML export -back-end by default in-lines that image. For example: -@samp{[[file:myimg.jpg]]} is in-lined, while @samp{[[file:myimg.jpg][the image]]} links to the text, -@samp{the image}. For more details, see the variable -@code{org-html-inline-images}. - -On the other hand, if the description part of the Org link is itself -another link, such as @samp{file:} or @samp{http:} URL pointing to an image, the -HTML export back-end in-lines this image and links to the main image. -This Org syntax enables the back-end to link low-resolution thumbnail -to the high-resolution version of the image, as shown in this example: - -@example -[[file:highres.jpg][file:thumb.jpg]] -@end example - - -To change attributes of in-lined images, use @samp{#+ATTR_HTML} lines in -the Org file. This example shows realignment to right, and adds @code{alt} -and @code{title} attributes in support of text viewers and modern web -accessibility standards. - -@cindex @samp{CAPTION}, keyword -@cindex @samp{ATTR_HTML}, keyword -@example -#+CAPTION: A black cat stalking a spider -#+ATTR_HTML: :alt cat/spider image :title Action! :align right -[[./img/a.jpg]] -@end example - -The HTML export back-end copies the @samp{http} links from the Org file -as-is. - -@node Math formatting in HTML export -@subsection Math formatting in HTML export - -@cindex MathJax -@cindex dvipng -@cindex dvisvgm -@cindex ImageMagick - -@vindex org-html-mathjax-options~ -@LaTeX{} math snippets (see @ref{@LaTeX{} fragments}) can be displayed in two -different ways on HTML pages. The default is to use the @uref{http://www.mathjax.org, MathJax}, -which should work out of the box with Org@footnote{By default Org loads MathJax from @uref{https://cdnjs.com, cdnjs.com} as recommended by -@uref{http://www.mathjax.org, MathJax}.}@footnote{Please note that exported formulas are part of an HTML -document, and that signs such as @samp{<}, @samp{>}, or @samp{&} have special -meanings. See @uref{http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents, MathJax @TeX{} and @LaTeX{} support}.}. Some MathJax -display options can be configured via @code{org-html-mathjax-options}, or -in the buffer. For example, with the following settings, - -@example -#+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler -#+HTML_MATHJAX: cancel.js noErrors.js -@end example - -@noindent -equation labels are displayed on the left margin and equations are -five em from the left margin. In addition, it loads the two MathJax -extensions @samp{cancel.js} and @samp{noErrors.js}@footnote{See @uref{http://docs.mathjax.org/en/latest/tex.html#tex-extensions, @TeX{} and @LaTeX{} extensions} in the @uref{http://docs.mathjax.org, MathJax manual} to learn -about extensions.}. - -@vindex org-html-mathjax-template -See the docstring of @code{org-html-mathjax-options} for all supported -variables. The MathJax template can be configure via -@code{org-html-mathjax-template}. - -If you prefer, you can also request that @LaTeX{} fragments are processed -into small images that will be inserted into the browser page. Before -the availability of MathJax, this was the default method for Org -files. This method requires that the dvipng program, dvisvgm or -ImageMagick suite is available on your system. You can still get this -processing with - -@example -#+OPTIONS: tex:dvipng -@end example - - -@example -#+OPTIONS: tex:dvisvgm -@end example - - -@noindent -or - -@example -#+OPTIONS: tex:imagemagick -@end example - -@node Text areas in HTML export -@subsection Text areas in HTML export - -@cindex text areas, in HTML -Before Org mode's Babel, one popular approach to publishing code in -HTML was by using @samp{:textarea}. The advantage of this approach was -that copying and pasting was built into browsers with simple -JavaScript commands. Even editing before pasting was made simple. - -The HTML export back-end can create such text areas. It requires an -@samp{#+ATTR_HTML} line as shown in the example below with the @samp{:textarea} -option. This must be followed by either an example or a source code -block. Other Org block types do not honor the @samp{:textarea} option. - -By default, the HTML export back-end creates a text area 80 characters -wide and height just enough to fit the content. Override these -defaults with @samp{:width} and @samp{:height} options on the @samp{#+ATTR_HTML} -line. - -@example -#+ATTR_HTML: :textarea t :width 40 -#+BEGIN_EXAMPLE - (defun org-xor (a b) - "Exclusive or." - (if a (not b) b)) -#+END_EXAMPLE -@end example - -@node CSS support -@subsection CSS support - -@cindex CSS, for HTML export -@cindex HTML export, CSS - -@vindex org-export-html-todo-kwd-class-prefix -@vindex org-export-html-tag-class-prefix -You can modify the CSS style definitions for the exported file. The -HTML exporter assigns the following special CSS classes@footnote{If the classes on TODO keywords and tags lead to conflicts, -use the variables @code{org-html-todo-kwd-class-prefix} and -@code{org-html-tag-class-prefix} to make them unique.} to -appropriate parts of the document---your style specifications may -change these, in addition to any of the standard classes like for -headlines, tables, etc. - -@multitable {aaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{p.author} -@tab author information, including email -@item @code{p.date} -@tab publishing date -@item @code{p.creator} -@tab creator info, about org mode version -@item @code{.title} -@tab document title -@item @code{.subtitle} -@tab document subtitle -@item @code{.todo} -@tab TODO keywords, all not-done states -@item @code{.done} -@tab the DONE keywords, all states that count as done -@item @code{.WAITING} -@tab each TODO keyword also uses a class named after itself -@item @code{.timestamp} -@tab timestamp -@item @code{.timestamp-kwd} -@tab keyword associated with a timestamp, like @samp{SCHEDULED} -@item @code{.timestamp-wrapper} -@tab span around keyword plus timestamp -@item @code{.tag} -@tab tag in a headline -@item @code{._HOME} -@tab each tag uses itself as a class, ``@@'' replaced by ``_'' -@item @code{.target} -@tab target for links -@item @code{.linenr} -@tab the line number in a code example -@item @code{.code-highlighted} -@tab for highlighting referenced code lines -@item @code{div.outline-N} -@tab div for outline level N (headline plus text) -@item @code{div.outline-text-N} -@tab extra div for text at outline level N -@item @code{.section-number-N} -@tab section number in headlines, different for each level -@item @code{.figure-number} -@tab label like ``Figure 1:'' -@item @code{.table-number} -@tab label like ``Table 1:'' -@item @code{.listing-number} -@tab label like ``Listing 1:'' -@item @code{div.figure} -@tab how to format an in-lined image -@item @code{pre.src} -@tab formatted source code -@item @code{pre.example} -@tab normal example -@item @code{p.verse} -@tab verse paragraph -@item @code{div.footnotes} -@tab footnote section headline -@item @code{p.footnote} -@tab footnote definition paragraph, containing a footnote -@item @code{.footref} -@tab a footnote reference number (always a <sup>) -@item @code{.footnum} -@tab footnote number in footnote definition (always <sup>) -@item @code{.org-svg} -@tab default class for a linked @samp{.svg} image -@end multitable - -@vindex org-html-style-default -@vindex org-html-head -@vindex org-html-head-extra -@cindex @samp{HTML_INCLUDE_STYLE}, keyword -The HTML export back-end includes a compact default style in each -exported HTML file. To override the default style with another style, -use these keywords in the Org file. They will replace the global -defaults the HTML exporter uses. - -@cindex @samp{HTML_HEAD}, keyword -@cindex @samp{HTML_HEAD_EXTRA}, keyword -@example -#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" /> -#+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" /> -@end example - -@vindex org-html-head-include-default-style -To just turn off the default style, customize -@code{org-html-head-include-default-style} variable, or use this option -line in the Org file. - -@cindex @samp{html-style}, @samp{OPTIONS} item -@example -#+OPTIONS: html-style:nil -@end example - - -For longer style definitions, either use several @samp{HTML_HEAD} and -@samp{HTML_HEAD_EXTRA} keywords, or use @code{<style> ... </style>} blocks -around them. Both of these approaches can avoid referring to an -external file. - -@cindex @samp{HTML_CONTAINER_CLASS}, property -@cindex @samp{HTML_HEADLINE_CLASS}, property -In order to add styles to a sub-tree, use the @samp{HTML_CONTAINER_CLASS} -property to assign a class to the tree. In order to specify CSS -styles for a particular headline, you can use the ID specified in -a @samp{CUSTOM_ID} property. You can also assign a specific class to -a headline with the @samp{HTML_HEADLINE_CLASS} property. - -Never change the @code{org-html-style-default} constant. Instead use other -simpler ways of customizing as described above. - -@node JavaScript support -@subsection JavaScript supported display of web pages - -Sebastian Rose has written a JavaScript program especially designed to -allow two different ways of viewing HTML files created with Org. One -is an @emph{Info}-like mode where each section is displayed separately and -navigation can be done with the @kbd{n} and @kbd{p} keys, and some other -keys as well, press @kbd{?} for an overview of the available keys. The -second one has a @emph{folding} view, much like Org provides inside Emacs. -The script is available at @uref{https://orgmode.org/org-info.js} and the -documentation at @uref{https://orgmode.org/worg/code/org-info-js/}. The -script is hosted on @uref{https://orgmode.org}, but for reliability, prefer -installing it on your own web server. - -To use this program, just add this line to the Org file: - -@cindex @samp{INFOJS_OPT}, keyword -@example -#+INFOJS_OPT: view:info toc:nil -@end example - - -@noindent -The HTML header now has the code needed to automatically invoke the -script. For setting options, use the syntax from the above line for -options described below: - -@table @asis -@item @samp{path:} -The path to the script. The default is to grab the script from -@uref{https://orgmode.org/org-info.js}, but you might want to have a local -copy and use a path like @samp{../scripts/org-info.js}. - -@item @samp{view:} -Initial view when the website is first shown. Possible values are: - -@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{info} -@tab Info-like interface with one section per page -@item @samp{overview} -@tab Folding interface, initially showing only top-level -@item @samp{content} -@tab Folding interface, starting with all headlines visible -@item @samp{showall} -@tab Folding interface, all headlines and text visible -@end multitable - -@item @samp{sdepth:} -Maximum headline level still considered as an independent section -for info and folding modes. The default is taken from -@code{org-export-headline-levels}, i.e., the @samp{H} switch in @samp{OPTIONS}. If -this is smaller than in @code{org-export-headline-levels}, each -info/folding section can still contain child headlines. - -@item @samp{toc:} -Should the table of contents @emph{initially} be visible? Even when -@samp{nil}, you can always get to the ``toc'' with @kbd{i}. - -@item @samp{tdepth:} -The depth of the table of contents. The defaults are taken from the -variables @code{org-export-headline-levels} and @code{org-export-with-toc}. - -@item @samp{ftoc:} -Does the CSS of the page specify a fixed position for the ``toc''? If -yes, the toc is displayed as a section. - -@item @samp{ltoc:} -Should there be short contents (children) in each section? Make -this @samp{above} if the section should be above initial text. - -@item @samp{mouse:} -Headings are highlighted when the mouse is over them. Should be -@samp{underline} (default) or a background color like @samp{#cccccc}. - -@item @samp{buttons:} -Should view-toggle buttons be everywhere? When @samp{nil} (the default), -only one such button is present. -@end table - -@vindex org-infojs-options -@vindex org-export-html-use-infojs -You can choose default values for these options by customizing the -variable @code{org-infojs-options}. If you always want to apply the script -to your pages, configure the variable @code{org-export-html-use-infojs}. - -@node @LaTeX{} Export -@section @LaTeX{} Export - -@cindex @LaTeX{} export -@cindex PDF export - -The @LaTeX{} export back-end can handle complex documents, incorporate -standard or custom @LaTeX{} document classes, generate documents using -alternate @LaTeX{} engines, and produce fully linked PDF files with -indexes, bibliographies, and tables of contents, destined for -interactive online viewing or high-quality print publication. - -While the details are covered in-depth in this section, here are some -quick references to variables for the impatient: for engines, see -@code{org-latex-compiler}; for build sequences, see -@code{org-latex-pdf-process}; for packages, see -@code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}. - -An important note about the @LaTeX{} export back-end: it is sensitive to -blank lines in the Org document. That's because @LaTeX{} itself depends -on blank lines to tell apart syntactical elements, such as paragraphs. - -@menu -* @LaTeX{}/PDF export commands:: For producing @LaTeX{} and PDF documents. -* @LaTeX{} specific export settings:: Unique to this @LaTeX{} back-end. -* @LaTeX{} header and sectioning:: Setting up the export file structure. -* Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code. -* Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}. -* Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output. -* Plain lists in @LaTeX{} export:: Attributes specific to lists. -* Source blocks in @LaTeX{} export:: Attributes specific to source code blocks. -* Example blocks in @LaTeX{} export:: Attributes specific to example blocks. -* Special blocks in @LaTeX{} export:: Attributes specific to special blocks. -* Horizontal rules in @LaTeX{} export:: Attributes specific to horizontal rules. -@end menu - -@node @LaTeX{}/PDF export commands -@subsection @LaTeX{}/PDF export commands - -@table @asis -@item @kbd{C-c C-e l l} (@code{org-latex-export-to-latex}) -@kindex C-c C-e l l -@findex org-latex-export-to-latex~ -Export to a @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org}, -Org exports to @samp{myfile.tex}, overwriting without warning. - -@item @kbd{C-c C-e l L} (@code{org-latex-export-as-latex}) -@kindex C-c C-e l L -@findex org-latex-export-as-latex -Export to a temporary buffer. Do not create a file. - -@item @kbd{C-c C-e l p} (@code{org-latex-export-to-pdf}) -@kindex C-c C-e l p -@findex org-latex-export-to-pdf -Export as @LaTeX{} file and convert it to PDF file. - -@item @kbd{C-c C-e l o} -@kindex C-c C-e l o -Export as @LaTeX{} file and convert it to PDF, then open the PDF using -the default viewer. - -@item @kbd{M-x org-export-region-as-latex} -Convert the region to @LaTeX{} under the assumption that it was in Org -mode syntax before. This is a global command that can be invoked in -any buffer. -@end table - -@vindex org-latex-compiler -@vindex org-latex-bibtex-compiler -@vindex org-latex-default-packages-alist -@cindex pdflatex -@cindex xelatex -@cindex lualatex -@cindex @samp{LATEX_COMPILER}, keyword -The @LaTeX{} export back-end can use any of these @LaTeX{} engines: -@samp{pdflatex}, @samp{xelatex}, and @samp{lualatex}. These engines compile @LaTeX{} -files with different compilers, packages, and output options. The -@LaTeX{} export back-end finds the compiler version to use from -@code{org-latex-compiler} variable or the @samp{#+LATEX_COMPILER} keyword in the -Org file. See the docstring for the -@code{org-latex-default-packages-alist} for loading packages with certain -compilers. Also see @code{org-latex-bibtex-compiler} to set the -bibliography compiler@footnote{This does not allow setting different bibliography compilers -for different files. However, ``smart'' @LaTeX{} compilation systems, such -as latexmk, can select the correct bibliography compiler.}. - -@node @LaTeX{} specific export settings -@subsection @LaTeX{} specific export settings - -The @LaTeX{} export back-end has several additional keywords for -customizing @LaTeX{} output. Setting these keywords works similar to the -general options (see @ref{Export Settings}). - -@table @asis -@item @samp{DESCRIPTION} -@cindex @samp{DESCRIPTION}, keyword -@vindex org-latex-hyperref-template -@vindex org-latex-title-command -The document's description. The description along with author name, -keywords, and related file metadata are inserted in the output file -by the hyperref package. See @code{org-latex-hyperref-template} for -customizing metadata items. See @code{org-latex-title-command} for -typesetting description into the document's front matter. Use -multiple @samp{DESCRIPTION} keywords for long descriptions. - -@item @samp{LANGUAGE} -@cindex @samp{LANGUAGE}, keyword -@vindex org-latex-packages-alist -In order to be effective, the @samp{babel} or @samp{polyglossia} -packages---according to the @LaTeX{} compiler used---must be loaded -with the appropriate language as argument. This can be accomplished -by modifying the @code{org-latex-packages-alist} variable, e.g., with the -following snippet: - -@lisp -(add-to-list 'org-latex-packages-alist - '("AUTO" "babel" t ("pdflatex"))) -(add-to-list 'org-latex-packages-alist - '("AUTO" "polyglossia" t ("xelatex" "lualatex"))) -@end lisp - -@item @samp{LATEX_CLASS} -@cindex @samp{LATEX_CLASS}, keyword -@vindex org-latex-default-class -@vindex org-latex-classes -This is @LaTeX{} document class, such as @emph{article}, @emph{report}, @emph{book}, -and so on, which contain predefined preamble and headline level -mapping that the @LaTeX{} export back-end needs. The back-end reads -the default class name from the @code{org-latex-default-class} variable. -Org has @emph{article} as the default class. A valid default class must -be an element of @code{org-latex-classes}. - -@item @samp{LATEX_CLASS_OPTIONS} -@cindex @samp{LATEX_CLASS_OPTIONS}, keyword -Options the @LaTeX{} export back-end uses when calling the @LaTeX{} -document class. - -@item @samp{LATEX_COMPILER} -@cindex @samp{LATEX_COMPILER}, keyword -@vindex org-latex-compiler -The compiler, such as @samp{pdflatex}, @samp{xelatex}, @samp{lualatex}, for -producing the PDF@. See @code{org-latex-compiler}. - -@item @samp{LATEX_HEADER} -@itemx @samp{LATEX_HEADER_EXTRA} -@cindex @samp{LATEX_HEADER}, keyword -@cindex @samp{LATEX_HEADER_EXTRA}, keyword -@vindex org-latex-classes -Arbitrary lines to add to the document's preamble, before the -hyperref settings. See @code{org-latex-classes} for adjusting the -structure and order of the @LaTeX{} headers. - -@item @samp{KEYWORDS} -@cindex @samp{KEYWORDS}, keyword -@vindex org-latex-hyperref-template -@vindex org-latex-title-command -The keywords for the document. The description along with author -name, keywords, and related file metadata are inserted in the output -file by the hyperref package. See @code{org-latex-hyperref-template} for -customizing metadata items. See @code{org-latex-title-command} for -typesetting description into the document's front matter. Use -multiple @samp{KEYWORDS} lines if necessary. - -@item @samp{SUBTITLE} -@cindex @samp{SUBTITLE}, keyword -@vindex org-latex-subtitle-separate -@vindex org-latex-subtitle-format -The document's subtitle. It is typeset as per -@code{org-latex-subtitle-format}. If @code{org-latex-subtitle-separate} is -non-@code{nil}, it is typed outside of the @code{\title} macro. See -@code{org-latex-hyperref-template} for customizing metadata items. See -@code{org-latex-title-command} for typesetting description into the -document's front matter. -@end table - -The following sections have further details. - -@node @LaTeX{} header and sectioning -@subsection @LaTeX{} header and sectioning structure - -@cindex @LaTeX{} class -@cindex @LaTeX{} sectioning structure -@cindex @LaTeX{} header -@cindex header, for @LaTeX{} files -@cindex sectioning structure, for @LaTeX{} export - -The @LaTeX{} export back-end converts the first three of Org's outline -levels into @LaTeX{} headlines. The remaining Org levels are exported as -lists. To change this globally for the cut-off point between levels -and lists, (see @ref{Export Settings}). - -By default, the @LaTeX{} export back-end uses the @emph{article} class. - -@vindex org-latex-default-class -@vindex org-latex-classes -@vindex org-latex-default-packages-alist -@vindex org-latex-packages-alist -To change the default class globally, edit @code{org-latex-default-class}. -To change the default class locally in an Org file, add option lines -@samp{#+LATEX_CLASS: myclass}. To change the default class for just a part -of the Org file, set a sub-tree property, @samp{EXPORT_LATEX_CLASS}. The -class name entered here must be valid member of @code{org-latex-classes}. -This variable defines a header template for each class into which the -exporter splices the values of @code{org-latex-default-packages-alist} and -@code{org-latex-packages-alist}. Use the same three variables to define -custom sectioning or custom classes. - -@cindex @samp{LATEX_CLASS}, keyword -@cindex @samp{LATEX_CLASS_OPTIONS}, keyword -@cindex @samp{EXPORT_LATEX_CLASS}, property -@cindex @samp{EXPORT_LATEX_CLASS_OPTIONS}, property -The @LaTeX{} export back-end sends the @samp{LATEX_CLASS_OPTIONS} keyword and -@samp{EXPORT_LATEX_CLASS_OPTIONS} property as options to the @LaTeX{} -@code{\documentclass} macro. The options and the syntax for specifying -them, including enclosing them in square brackets, follow @LaTeX{} -conventions. - -@example -#+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn] -@end example - - -@cindex @samp{LATEX_HEADER}, keyword -@cindex @samp{LATEX_HEADER_EXTRA}, keyword -The @LaTeX{} export back-end appends values from @samp{LATEX_HEADER} and -@samp{LATEX_HEADER_EXTRA} keywords to the @LaTeX{} header. The docstring for -@code{org-latex-classes} explains in more detail. Also note that @LaTeX{} -export back-end does not append @samp{LATEX_HEADER_EXTRA} to the header -when previewing @LaTeX{} snippets (see @ref{Previewing @LaTeX{} fragments}). - -A sample Org file with the above headers: - -@example -#+LATEX_CLASS: article -#+LATEX_CLASS_OPTIONS: [a4paper] -#+LATEX_HEADER: \usepackage@{xyz@} - -* Headline 1 - some text -* Headline 2 - some more text -@end example - -@node Quoting @LaTeX{} code -@subsection Quoting @LaTeX{} code - -The @LaTeX{} export back-end can insert any arbitrary @LaTeX{} code, see -@ref{Embedded @LaTeX{}}. There are three ways to embed such code in the Org -file and they all use different quoting syntax. - -@cindex inline, in @LaTeX{} export -Inserting in-line quoted with @@ symbols: - -@example -Code embedded in-line @@@@latex:any arbitrary LaTeX code@@@@ in a paragraph. -@end example - - -@cindex @samp{LATEX}, keyword -Inserting as one or more keyword lines in the Org file: - -@example -#+LATEX: any arbitrary LaTeX code -@end example - - -@cindex @samp{BEGIN_EXPORT latex} -Inserting as an export block in the Org file, where the back-end -exports any code between begin and end markers: - -@example -#+BEGIN_EXPORT latex - any arbitrary LaTeX code -#+END_EXPORT -@end example - -@node Tables in @LaTeX{} export -@subsection Tables in @LaTeX{} export - -@cindex tables, in @LaTeX{} export - -The @LaTeX{} export back-end can pass several @LaTeX{} attributes for table -contents and layout. Besides specifying a label (see @ref{Internal Links}) -and a caption (see @ref{Captions}), the other valid @LaTeX{} attributes -include: - -@table @asis -@item @samp{:mode} -@vindex org-latex-default-table-mode -The @LaTeX{} export back-end wraps the table differently depending on -the mode for accurate rendering of math symbols. Mode is either -@samp{table}, @samp{math}, @samp{inline-math} or @samp{verbatim}. - -For @samp{math} or @samp{inline-math} mode, @LaTeX{} export back-end wraps the -table in a math environment, but every cell in it is exported as-is. -The @LaTeX{} export back-end determines the default mode from -@code{org-latex-default-table-mode}. The @LaTeX{} export back-end merges -contiguous tables in the same mode into a single environment. - -@item @samp{:environment} -@vindex org-latex-default-table-environment -Set the default @LaTeX{} table environment for the @LaTeX{} export -back-end to use when exporting Org tables. Common @LaTeX{} table -environments are provided by these packages: tabularx, longtable, -array, tabu, and bmatrix. For packages, such as tabularx and tabu, -or any newer replacements, include them in the -@code{org-latex-packages-alist} variable so the @LaTeX{} export back-end can -insert the appropriate load package headers in the converted @LaTeX{} -file. Look in the docstring for the @code{org-latex-packages-alist} -variable for configuring these packages for @LaTeX{} snippet previews, -if any. - -@item @samp{:caption} -Use @samp{CAPTION} keyword to set a simple caption for a table (see -@ref{Captions}). For custom captions, use @samp{:caption} attribute, which -accepts raw @LaTeX{} code. @samp{:caption} value overrides @samp{CAPTION} value. - -@item @samp{:float} -@itemx @samp{:placement} -The table environments by default are not floats in @LaTeX{}. To make -them floating objects use @samp{:float} with one of the following -options: @samp{sideways}, @samp{multicolumn}, @samp{t}, and @samp{nil}. - -@LaTeX{} floats can also have additional layout @samp{:placement} -attributes. These are the usual @samp{[h t b p ! H]} permissions -specified in square brackets. Note that for @samp{:float sideways} -tables, the @LaTeX{} export back-end ignores @samp{:placement} attributes. - -@item @samp{:align} -@itemx @samp{:font} -@itemx @samp{:width} -The @LaTeX{} export back-end uses these attributes for regular tables -to set their alignments, fonts, and widths. - -@item @samp{:spread} -When @samp{:spread} is non-@code{nil}, the @LaTeX{} export back-end spreads or -shrinks the table by the @samp{:width} for tabu and longtabu -environments. @samp{:spread} has no effect if @samp{:width} is not set. - -@item @samp{:booktabs} -@itemx @samp{:center} -@itemx @samp{:rmlines} -@vindex org-latex-tables-booktabs -@vindex org-latex-tables-centered -All three commands are toggles. @samp{:booktabs} brings in modern -typesetting enhancements to regular tables. The booktabs package -has to be loaded through @code{org-latex-packages-alist}. @samp{:center} is -for centering the table. @samp{:rmlines} removes all but the very first -horizontal line made of ASCII characters from ``table.el'' tables -only. - -@item @samp{:math-prefix} -@itemx @samp{:math-suffix} -@itemx @samp{:math-arguments} -The @LaTeX{} export back-end inserts @samp{:math-prefix} string value in -a math environment before the table. The @LaTeX{} export back-end -inserts @samp{:math-suffix} string value in a math environment after the -table. The @LaTeX{} export back-end inserts @samp{:math-arguments} string -value between the macro name and the table's contents. -@samp{:math-arguments} comes in use for matrix macros that require more -than one argument, such as @samp{qbordermatrix}. -@end table - -@LaTeX{} table attributes help formatting tables for a wide range of -situations, such as matrix product or spanning multiple pages: - -@example -#+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l -| ... | ... | -| ... | ... | - -#+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times -| a | b | -| c | d | -#+ATTR_LATEX: :mode math :environment bmatrix -| 1 | 2 | -| 3 | 4 | -@end example - -Set the caption with the @LaTeX{} command -@samp{\bicaption@{HeadingA@}@{HeadingB@}}: - -@example -#+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@} -| ... | ... | -| ... | ... | -@end example - -@node Images in @LaTeX{} export -@subsection Images in @LaTeX{} export - -@cindex images, inline in LaTeX -@cindex inlining images in LaTeX -@cindex @samp{ATTR_LATEX}, keyword - -The @LaTeX{} export back-end processes image links in Org files that do -not have descriptions, such as these links @samp{[[file:img.jpg]]} or -@samp{[[./img.jpg]]}, as direct image insertions in the final PDF output. In -the PDF, they are no longer links but actual images embedded on the -page. The @LaTeX{} export back-end uses @samp{\includegraphics} macro to -insert the image. But for TikZ (@uref{http://sourceforge.net/projects/pgf/}) -images, the back-end uses an @code{\input} macro wrapped within -a @code{tikzpicture} environment. - -For specifying image @samp{:width}, @samp{:height}, @samp{:scale} and other @samp{:options}, -use this syntax: - -@example -#+ATTR_LATEX: :width 5cm :options angle=90 -[[./img/sed-hr4049.pdf]] -@end example - -A @samp{:scale} attribute overrides both @samp{:width} and @samp{:height} attributes. - -For custom commands for captions, use the @samp{:caption} attribute. It -overrides the default @samp{#+CAPTION} value: - -@example -#+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@} -[[./img/sed-hr4049.pdf]] -@end example - -When captions follow the method as described in @ref{Captions}, the @LaTeX{} -export back-end wraps the picture in a floating @samp{figure} environment. -To float an image without specifying a caption, set the @samp{:float} -attribute to one of the following: - -@table @asis -@item @samp{t} -For a standard @samp{figure} environment; used by default whenever an -image has a caption. - -@item @samp{multicolumn} -To span the image across multiple columns of a page; the back-end -wraps the image in a @samp{figure*} environment. - -@item @samp{wrap} -For text to flow around the image on the right; the figure occupies -the left half of the page. - -@item @samp{sideways} -For a new page with the image sideways, rotated ninety degrees, in -a @samp{sidewaysfigure} environment; overrides @samp{:placement} setting. - -@item @samp{nil} -To avoid a @samp{:float} even if using a caption. -@end table - -Use the @samp{placement} attribute to modify a floating environment's -placement. - -@example -#+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@} -[[./img/hst.png]] -@end example - -@vindex org-latex-images-centered -@cindex center image in LaTeX export -@cindex image, centering in LaTeX export -The @LaTeX{} export back-end centers all images by default. Setting -@samp{:center} to @samp{nil} disables centering. To disable centering globally, -set @code{org-latex-images-centered} to @samp{t}. - -Set the @samp{:comment-include} attribute to non-@code{nil} value for the @LaTeX{} -export back-end to comment out the @samp{\includegraphics} macro. - -@node Plain lists in @LaTeX{} export -@subsection Plain lists in @LaTeX{} export - -@cindex plain lists, in @LaTeX{} export -@cindex @samp{ATTR_LATEX}, keyword -The @LaTeX{} export back-end accepts the @samp{environment} and @samp{options} -attributes for plain lists. Both attributes work together for -customizing lists, as shown in the examples: - -@example -#+LATEX_HEADER: \usepackage[inline]@{enumitem@} -Some ways to say "Hello": -#+ATTR_LATEX: :environment itemize* -#+ATTR_LATEX: :options [label=@{@}, itemjoin=@{,@}, itemjoin*=@{, and@}] -- Hola -- Bonjour -- Guten Tag. -@end example - -Since @LaTeX{} supports only four levels of nesting for lists, use an -external package, such as @samp{enumitem} in @LaTeX{}, for levels deeper than -four: - -@example -#+LATEX_HEADER: \usepackage@{enumitem@} -#+LATEX_HEADER: \renewlist@{itemize@}@{itemize@}@{9@} -#+LATEX_HEADER: \setlist[itemize]@{label=$\circ$@} -- One - - Two - - Three - - Four - - Five -@end example - -@node Source blocks in @LaTeX{} export -@subsection Source blocks in @LaTeX{} export - -@cindex source blocks, in @LaTeX{} export -@cindex @samp{ATTR_LATEX}, keyword - -The @LaTeX{} export back-end can make source code blocks into floating -objects through the attributes @samp{:float} and @samp{:options}. For @samp{:float}: - -@table @asis -@item @samp{t} -Makes a source block float; by default floats any source block with -a caption. - -@item @samp{multicolumn} -Spans the source block across multiple columns of a page. - -@item @samp{nil} -Avoids a @samp{:float} even if using a caption; useful for source code -blocks that may not fit on a page. -@end table - -@example -#+ATTR_LATEX: :float nil -#+BEGIN_SRC emacs-lisp - Lisp code that may not fit in a single page. -#+END_SRC -@end example - -@vindex org-latex-listings-options -@vindex org-latex-minted-options -The @LaTeX{} export back-end passes string values in @samp{:options} to @LaTeX{} -packages for customization of that specific source block. In the -example below, the @samp{:options} are set for Minted. Minted is a source -code highlighting @LaTeX{} package with many configurable options. - -@example -#+ATTR_LATEX: :options commentstyle=\bfseries -#+BEGIN_SRC emacs-lisp - (defun Fib (n) - (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2))))) -#+END_SRC -@end example - -To apply similar configuration options for all source blocks in -a file, use the @code{org-latex-listings-options} and -@code{org-latex-minted-options} variables. - -@node Example blocks in @LaTeX{} export -@subsection Example blocks in @LaTeX{} export - -@cindex example blocks, in @LaTeX{} export -@cindex verbatim blocks, in @LaTeX{} export -@cindex @samp{ATTR_LATEX}, keyword - -The @LaTeX{} export back-end wraps the contents of example blocks in -a @samp{verbatim} environment. To change this behavior to use another -environment globally, specify an appropriate export filter (see -@ref{Advanced Export Configuration}). To change this behavior to use -another environment for each block, use the @samp{:environment} parameter -to specify a custom environment. - -@example -#+ATTR_LATEX: :environment myverbatim -#+BEGIN_EXAMPLE - This sentence is false. -#+END_EXAMPLE -@end example - -@node Special blocks in @LaTeX{} export -@subsection Special blocks in @LaTeX{} export - -@cindex special blocks, in @LaTeX{} export -@cindex abstract, in @LaTeX{} export -@cindex proof, in @LaTeX{} export -@cindex @samp{ATTR_LATEX}, keyword - -For other special blocks in the Org file, the @LaTeX{} export back-end -makes a special environment of the same name. The back-end also takes -@samp{:options}, if any, and appends as-is to that environment's opening -string. For example: - -@example -#+BEGIN_abstract - We demonstrate how to solve the Syracuse problem. -#+END_abstract - -#+ATTR_LATEX: :options [Proof of important theorem] -#+BEGIN_proof - ... - Therefore, any even number greater than 2 is the sum of two primes. -#+END_proof -@end example - -@noindent -exports to - -@example -\begin@{abstract@} - We demonstrate how to solve the Syracuse problem. -\end@{abstract@} - -\begin@{proof@}[Proof of important theorem] - ... - Therefore, any even number greater than 2 is the sum of two primes. -\end@{proof@} -@end example - -If you need to insert a specific caption command, use @samp{:caption} -attribute. It overrides standard @samp{CAPTION} value, if any. For -example: - -@example -#+ATTR_LATEX: :caption \MyCaption@{HeadingA@} -#+BEGIN_proof - ... -#+END_proof -@end example - -@node Horizontal rules in @LaTeX{} export -@subsection Horizontal rules in @LaTeX{} export - -@cindex horizontal rules, in @LaTeX{} export -@cindex @samp{ATTR_LATEX}, keyword - -The @LaTeX{} export back-end converts horizontal rules by the specified -@samp{:width} and @samp{:thickness} attributes. For example: - -@example -#+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt ------ -@end example - -@node Markdown Export -@section Markdown Export - -@cindex Markdown export - -The Markdown export back-end, ``md'', converts an Org file to Markdown -format, as defined at @uref{http://daringfireball.net/projects/markdown/}. - -Since it is built on top of the HTML back-end (see @ref{HTML Export}), it -converts every Org construct not defined in Markdown syntax, such as -tables, to HTML@. - -@anchor{Markdown export commands} -@subheading Markdown export commands - -@table @asis -@item @kbd{C-c C-e m m} (@code{org-md-export-to-markdown}) -@kindex C-c C-c m m -@findex org-md-export-to-markdown -Export to a text file with Markdown syntax. For @samp{myfile.org}, Org -exports to @samp{myfile.md}, overwritten without warning. - -@item @kbd{C-c C-e m M} (@code{org-md-export-as-markdown}) -@kindex C-c C-c m M -@findex org-md-export-as-markdown -Export to a temporary buffer. Does not create a file. - -@item @kbd{C-c C-e m o} -@kindex C-c C-e m o -Export as a text file with Markdown syntax, then open it. -@end table - -@anchor{Header and sectioning structure (1)} -@subheading Header and sectioning structure - -@vindex org-md-headline-style -Based on @code{org-md-headline-style}, Markdown export can generate -headlines of both @emph{atx} and @emph{setext} types. @emph{atx} limits headline -levels to two whereas @emph{setext} limits headline levels to six. Beyond -these limits, the export back-end converts headlines to lists. To set -a limit to a level before the absolute limit (see @ref{Export Settings}). - -@node OpenDocument Text Export -@section OpenDocument Text Export - -@cindex ODT -@cindex OpenDocument -@cindex export, OpenDocument -@cindex LibreOffice - -The ODT export back-end handles creating of OpenDocument Text (ODT) -format. Documents created by this exporter use the -@cite{OpenDocument-v1.2 specification}@footnote{See @uref{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html, Open Document Format for Office Applications -(OpenDocument) Version 1.2}.} and are compatible -with LibreOffice 3.4. - -@menu -* Pre-requisites for ODT export:: Required packages. -* ODT export commands:: Invoking export. -* ODT specific export settings:: Configuration options. -* Extending ODT export:: Producing DOC, PDF files. -* Applying custom styles:: Styling the output. -* Links in ODT export:: Handling and formatting links. -* Tables in ODT export:: Org tables conversions. -* Images in ODT export:: Inserting images. -* Math formatting in ODT export:: Formatting @LaTeX{} fragments. -* Labels and captions in ODT export:: Rendering objects. -* Literal examples in ODT export:: For source code and example blocks. -* Advanced topics in ODT export:: For power users. -@end menu - -@node Pre-requisites for ODT export -@subsection Pre-requisites for ODT export - -@cindex zip - -The ODT export back-end relies on the zip program to create the final -compressed ODT output. Check if @samp{zip} is locally available and -executable. Without it, export cannot finish. - -@node ODT export commands -@subsection ODT export commands - -@table @asis -@item @kbd{C-c C-e o o} (@code{org-export-to-odt}) -@kindex C-c C-e o o -@findex org-export-to-odt -Export as OpenDocument Text file. - -@cindex @samp{EXPORT_FILE_NAME}, property -@vindex org-odt-preferred-output-format - -If @code{org-odt-preferred-output-format} is specified, the ODT export -back-end automatically converts the exported file to that format. - -For @samp{myfile.org}, Org exports to @samp{myfile.odt}, overwriting without -warning. The ODT export back-end exports a region only if a region -was active. - -If the selected region is a single tree, the ODT export back-end -makes the tree head the document title. Incidentally, @kbd{C-c @@} selects the current sub-tree. If the tree head entry has, or -inherits, an @samp{EXPORT_FILE_NAME} property, the ODT export back-end -uses that for file name. - -@item @kbd{C-c C-e o O} -@kindex C-c C-e o O -Export as an OpenDocument Text file and open the resulting file. - -@vindex org-export-odt-preferred-output-format -If @code{org-export-odt-preferred-output-format} is specified, open the -converted file instead. See @ref{Automatically exporting to other formats}. -@end table - -@node ODT specific export settings -@subsection ODT specific export settings - -The ODT export back-end has several additional keywords for -customizing ODT output. Setting these keywords works similar to the -general options (see @ref{Export Settings}). - -@table @asis -@item @samp{DESCRIPTION} -@cindex @samp{DESCRIPTION}, keyword -This is the document's description, which the ODT export back-end -inserts as document metadata. For long descriptions, use multiple -lines, prefixed with @samp{DESCRIPTION}. - -@item @samp{KEYWORDS} -@cindex @samp{KEYWORDS}, keyword -The keywords for the document. The ODT export back-end inserts the -description along with author name, keywords, and related file -metadata as metadata in the output file. Use multiple @samp{KEYWORDS} if -necessary. - -@item @samp{ODT_STYLES_FILE} -@cindex @samp{ODT_STYLES_FILE}, keyword -@vindex org-odt-styles-file -The ODT export back-end uses the @code{org-odt-styles-file} by default. -See @ref{Applying custom styles} for details. - -@item @samp{SUBTITLE} -@cindex @samp{SUBTITLE}, keyword -The document subtitle. -@end table - -@node Extending ODT export -@subsection Extending ODT export - -The ODT export back-end can produce documents in other formats besides -ODT using a specialized ODT converter process. Its common interface -works with popular converters to produce formats such as @samp{doc}, or -convert a document from one format, say @samp{csv}, to another format, say -@samp{xls}. - -@cindex @file{unoconv} -@vindex org-odt-convert-process -Customize @code{org-odt-convert-process} variable to point to @samp{unoconv}, -which is the ODT's preferred converter. Working installations of -LibreOffice would already have @samp{unoconv} installed. Alternatively, -other converters may be substituted here. See @ref{Configuring a document converter}. - -@anchor{Automatically exporting to other formats} -@subsubheading Automatically exporting to other formats - -@vindex org-odt-preferred-output-format -If ODT format is just an intermediate step to get to other formats, -such as @samp{doc}, @samp{docx}, @samp{rtf}, or @samp{pdf}, etc., then extend the ODT -export back-end to directly produce that format. Specify the final -format in the @code{org-odt-preferred-output-format} variable. This is one -way to extend (see @ref{ODT export commands}). - -@anchor{Converting between document formats} -@subsubheading Converting between document formats - -The Org export back-end is made to be inter-operable with a wide range -of text document format converters. Newer generation converters, such -as LibreOffice and Pandoc, can handle hundreds of formats at once. -Org provides a consistent interaction with whatever converter is -installed. Here are some generic commands: - -@table @asis -@item @kbd{M-x org-odt-convert} -@findex org-odt-convert -Convert an existing document from one format to another. With -a prefix argument, opens the newly produced file. -@end table - -@node Applying custom styles -@subsection Applying custom styles - -@cindex styles, custom -@cindex template, custom - -The ODT export back-end comes with many OpenDocument styles (see -@ref{Working with OpenDocument style files}). To expand or further -customize these built-in style sheets, either edit the style sheets -directly or generate them using an application such as LibreOffice. -The example here shows creating a style using LibreOffice. - -@anchor{Applying custom styles the easy way} -@subsubheading Applying custom styles: the easy way - -@enumerate -@item -Create a sample @samp{example.org} file with settings as shown below, -and export it to ODT format. - -@example -#+OPTIONS: H:10 num:t -@end example - -@item -Open the above @samp{example.odt} using LibreOffice. Use the @emph{Stylist} -to locate the target styles, which typically have the ``Org'' prefix. -Open one, modify, and save as either OpenDocument Text (ODT) or -OpenDocument Template (OTT) file. - -@item -@vindex org-odt-styles-file -Customize the variable @code{org-odt-styles-file} and point it to the -newly created file. For additional configuration options, see -@ref{x-overriding-factory-styles, , Overriding factory styles}. - -@cindex @samp{ODT_STYLES_FILE}, keyword -To apply an ODT style to a particular file, use the -@samp{ODT_STYLES_FILE} keyword as shown in the example below: - -@example -#+ODT_STYLES_FILE: "/path/to/example.ott" -@end example - - -@noindent -or - -@example -#+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png")) -@end example -@end enumerate - -@anchor{Using third-party styles and templates} -@subsubheading Using third-party styles and templates - -The ODT export back-end relies on many templates and style names. -Using third-party styles and templates can lead to mismatches. -Templates derived from built in ODT templates and styles seem to have -fewer problems. - -@node Links in ODT export -@subsection Links in ODT export - -@cindex links, in ODT export - -ODT exporter creates native cross-references for internal links. It -creates Internet-style links for all other links. - -A link with no description and pointing to a regular, un-itemized, -outline heading is replaced with a cross-reference and section number -of the heading. - -A @samp{\ref@{label@}}-style reference to an image, table etc., is replaced -with a cross-reference and sequence number of the labeled entity. See -@ref{Labels and captions in ODT export}. - -@node Tables in ODT export -@subsection Tables in ODT export - -@cindex tables, in ODT export - -The ODT export back-end handles native Org mode tables (see @ref{Tables}) -and simple @samp{table.el} tables. Complex @samp{table.el} tables having column -or row spans are not supported. Such tables are stripped from the -exported document. - -By default, the ODT export back-end exports a table with top and -bottom frames and with ruled lines separating row and column groups -(see @ref{Column Groups}). All tables are typeset to occupy the same -width. The ODT export back-end honors any table alignments and -relative widths for columns (see @ref{Column Width and Alignment}). - -Note that the ODT export back-end interprets column widths as weighted -ratios, the default weight being 1. - -@cindex @samp{ATTR_ODT}, keyword -Specifying @samp{:rel-width} property on an @samp{ATTR_ODT} line controls the -width of the table. For example: - -@example -#+ATTR_ODT: :rel-width 50 -| Area/Month | Jan | Feb | Mar | Sum | -|---------------+-------+-------+-------+-------| -| / | < | | | < | -| <l13> | <r5> | <r5> | <r5> | <r6> | -| North America | 1 | 21 | 926 | 948 | -| Middle East | 6 | 75 | 844 | 925 | -| Asia Pacific | 9 | 27 | 790 | 826 | -|---------------+-------+-------+-------+-------| -| Sum | 16 | 123 | 2560 | 2699 | -@end example - -On export, the above table takes 50% of text width area. The exporter -sizes the columns in the ratio: 13:5:5:5:6. The first column is -left-aligned and rest of the columns, right-aligned. Vertical rules -separate the header and the last column. Horizontal rules separate -the header and the last row. - -For even more customization, create custom table styles and associate -them with a table using the @samp{ATTR_ODT} keyword. See @ref{Customizing tables in ODT export}. - -@node Images in ODT export -@subsection Images in ODT export - -@cindex images, embedding in ODT -@cindex embedding images in ODT - -@anchor{Embedding images} -@subsubheading Embedding images - -The ODT export back-end processes image links in Org files that do not -have descriptions, such as these links @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, -as direct image insertions in the final output. Either of these -examples works: - -@example -[[file:img.png]] -@end example - - -@example -[[./img.png]] -@end example - -@anchor{Embedding clickable images} -@subsubheading Embedding clickable images - -For clickable images, provide a link whose description is another link -to an image file. For example, to embed an image -@samp{org-mode-unicorn.png} which when clicked jumps to @uref{https://orgmode.org} -website, do the following - -@example -[[https://orgmode.org][./org-mode-unicorn.png]] -@end example - -@anchor{Sizing and scaling of embedded images} -@subsubheading Sizing and scaling of embedded images - -@cindex @samp{ATTR_ODT}, keyword - -Control the size and scale of the embedded images with the @samp{ATTR_ODT} -attribute. - -@cindex identify, ImageMagick -@vindex org-odt-pixels-per-inch -The ODT export back-end starts with establishing the size of the image -in the final document. The dimensions of this size are measured in -centimeters. The back-end then queries the image file for its -dimensions measured in pixels. For this measurement, the back-end -relies on ImageMagick's identify program or Emacs @code{create-image} and -@code{image-size} API@. ImageMagick is the preferred choice for large file -sizes or frequent batch operations. The back-end then converts the -pixel dimensions using @code{org-odt-pixels-per-inch} into the familiar 72 -dpi or 96 dpi. The default value for this is in -@code{display-pixels-per-inch}, which can be tweaked for better results -based on the capabilities of the output device. Here are some common -image scaling operations: - -@table @asis -@item Explicitly size the image -To embed @samp{img.png} as a 10 cm x 10 cm image, do the following: - -@example -#+ATTR_ODT: :width 10 :height 10 -[[./img.png]] -@end example - -@item Scale the image -To embed @samp{img.png} at half its size, do the following: - -@example -#+ATTR_ODT: :scale 0.5 -[[./img.png]] -@end example - -@item Scale the image to a specific width -To embed @samp{img.png} with a width of 10 cm while retaining the -original height:width ratio, do the following: - -@example -#+ATTR_ODT: :width 10 -[[./img.png]] -@end example - -@item Scale the image to a specific height -To embed @samp{img.png} with a height of 10 cm while retaining the -original height:width ratio, do the following: - -@example -#+ATTR_ODT: :height 10 -[[./img.png]] -@end example -@end table - -@anchor{Anchoring of images} -@subsubheading Anchoring of images - -@cindex @samp{ATTR_ODT}, keyword -The ODT export back-end can anchor images to @samp{as-char}, @samp{paragraph}, -or @samp{page}. Set the preferred anchor using the @samp{:anchor} property of -the @samp{ATTR_ODT} line. - -To create an image that is anchored to a page: - -@example -#+ATTR_ODT: :anchor page -[[./img.png]] -@end example - -@node Math formatting in ODT export -@subsection Math formatting in ODT export - -The ODT exporter has special support for handling math. - -@menu -* @LaTeX{} math snippets:: Embedding in @LaTeX{} format. -* MathML and OpenDocument formula files:: Embedding in native format. -@end menu - -@node @LaTeX{} math snippets -@subsubsection @LaTeX{} math snippets - -@LaTeX{} math snippets (see @ref{@LaTeX{} fragments}) can be embedded in the ODT -document in one of the following ways: - -@table @asis -@item MathML -@cindex MathML -Add this line to the Org file. This option is activated on -a per-file basis. - -@example -#+OPTIONS: tex:t -@end example - - -With this option, @LaTeX{} fragments are first converted into MathML -fragments using an external @LaTeX{}-to-MathML converter program. The -resulting MathML fragments are then embedded as an OpenDocument -Formula in the exported document. - -@vindex org-latex-to-mathml-convert-command -@vindex org-latex-to-mathml-jar-file -You can specify the @LaTeX{}-to-MathML converter by customizing the -variables @code{org-latex-to-mathml-convert-command} and -@code{org-latex-to-mathml-jar-file}. - -If you prefer to use MathToWeb@footnote{See @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}.} as your converter, you can -configure the above variables as shown below. - -@lisp -(setq org-latex-to-mathml-convert-command - "java -jar %j -unicode -force -df %o %I" - org-latex-to-mathml-jar-file - "/path/to/mathtoweb.jar") -@end lisp - -@noindent -or, to use @LaTeX{}ML@footnote{See @uref{http://dlmf.nist.gov/LaTeXML/}.} instead, - -@lisp -(setq org-latex-to-mathml-convert-command - "latexmlmath \"%i\" --presentationmathml=%o") -@end lisp - -To quickly verify the reliability of the @LaTeX{}-to-MathML -converter, use the following commands: - -@table @asis -@item @kbd{M-x org-export-as-odf} -Convert a @LaTeX{} math snippet to an OpenDocument formula (@samp{.odf}) -file. - -@item @kbd{M-x org-export-as-odf-and-open} -Convert a @LaTeX{} math snippet to an OpenDocument formula (@samp{.odf}) -file and open the formula file with the system-registered -application. -@end table - -@item PNG images -@cindex dvipng -@cindex dvisvgm -@cindex ImageMagick -Add this line to the Org file. This option is activated on -a per-file basis. - -@example -#+OPTIONS: tex:dvipng -@end example - - -@example -#+OPTIONS: tex:dvisvgm -@end example - - -@noindent -or - -@example -#+OPTIONS: tex:imagemagick -@end example - - -Under this option, @LaTeX{} fragments are processed into PNG or SVG -images and the resulting images are embedded in the exported -document. This method requires dvipng program, dvisvgm or -ImageMagick programs. -@end table - -@node MathML and OpenDocument formula files -@subsubsection MathML and OpenDocument formula files - -When embedding @LaTeX{} math snippets in ODT documents is not reliable, -there is one more option to try. Embed an equation by linking to its -MathML (@samp{.mml}) source or its OpenDocument formula (@samp{.odf}) file as -shown below: - -@example -[[./equation.mml]] -@end example - - -@noindent -or - -@example -[[./equation.odf]] -@end example - -@node Labels and captions in ODT export -@subsection Labels and captions in ODT export - -ODT format handles labeling and captioning of objects based on their -types. Inline images, tables, @LaTeX{} fragments, and Math formulas are -numbered and captioned separately. Each object also gets a unique -sequence number based on its order of first appearance in the Org -file. Each category has its own sequence. A caption is just a label -applied to these objects. - -@example -#+CAPTION: Bell curve -#+NAME: fig:SED-HR4049 -[[./img/a.png]] -@end example - -When rendered, it may show as follows in the exported document: - -@example -Figure 2: Bell curve -@end example - - -@vindex org-odt-category-map-alist -To modify the category component of the caption, customize the option -@code{org-odt-category-map-alist}. For example, to tag embedded images -with the string ``Illustration'' instead of the default string ``Figure'', -use the following setting: - -@lisp -(setq org-odt-category-map-alist - '(("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p))) -@end lisp - -With the above modification, the previous example changes to: - -@example -Illustration 2: Bell curve -@end example - -@node Literal examples in ODT export -@subsection Literal examples in ODT export - -The ODT export back-end supports literal examples (see @ref{Literal Examples}) with full fontification. Internally, the ODT export -back-end relies on @samp{htmlfontify.el} to generate the style definitions -needed for fancy listings. The auto-generated styles get @samp{OrgSrc} -prefix and inherit colors from the faces used by Emacs Font Lock -library for that source language. - -@vindex org-odt-fontify-srcblocks -For custom fontification styles, customize the -@code{org-odt-create-custom-styles-for-srcblocks} option. - -@vindex org-odt-create-custom-styles-for-srcblocks -To turn off fontification of literal examples, customize the -@code{org-odt-fontify-srcblocks} option. - -@node Advanced topics in ODT export -@subsection Advanced topics in ODT export - -The ODT export back-end has extensive features useful for power users -and frequent uses of ODT formats. - -@anchor{Configuring a document converter} -@subsubheading Configuring a document converter - -@cindex convert -@cindex doc, docx, rtf -@cindex converter - -The ODT export back-end works with popular converters with little or -no extra configuration. See @ref{Extending ODT export}. The following is -for unsupported converters or tweaking existing defaults. - -@table @asis -@item Register the converter -@vindex org-export-odt-convert-processes -Add the name of the converter to the @code{org-odt-convert-processes} -variable. Note that it also requires how the converter is invoked -on the command line. See the variable's docstring for details. - -@item Configure its capabilities -@vindex org-export-odt-convert-capabilities -Specify which formats the converter can handle by customizing the -variable @code{org-odt-convert-capabilities}. Use the entry for the -default values in this variable for configuring the new converter. -Also see its docstring for details. - -@item Choose the converter -@vindex org-export-odt-convert-process -Select the newly added converter as the preferred one by customizing -the option @code{org-odt-convert-process}. -@end table - -@anchor{Working with OpenDocument style files} -@subsubheading Working with OpenDocument style files - -@cindex styles, custom -@cindex template, custom - -This section explores the internals of the ODT exporter; the means by which -it produces styled documents; the use of automatic and custom OpenDocument -styles. - -The ODT exporter relies on two files for generating its output. These -files are bundled with the distribution under the directory pointed to -by the variable @code{org-odt-styles-dir}. The two files are: - -@table @asis -@item @samp{OrgOdtStyles.xml} @anchor{x-orgodtstyles-xml} -This file contributes to the @samp{styles.xml} file of the final ODT -document. This file gets modified for the following purposes: - -@enumerate -@item -To control outline numbering based on user settings; - -@item -To add styles generated by @samp{htmlfontify.el} for fontification of -code blocks. -@end enumerate - -@item @samp{OrgOdtContentTemplate.xml} @anchor{x-orgodtcontenttemplate-xml} -This file contributes to the @samp{content.xml} file of the final ODT -document. The contents of the Org outline are inserted between the -@samp{<office:text>} @dots{} @samp{</office:text>} elements of this file. - -Apart from serving as a template file for the final @samp{content.xml}, -the file serves the following purposes: - -@enumerate -@item -It contains automatic styles for formatting of tables which are -referenced by the exporter; - -@item -It contains @samp{<text:sequence-decl>} @dots{} @samp{</text:sequence-decl>} -elements that control numbering of tables, images, equations, and -similar entities. -@end enumerate -@end table - -@anchor{x-overriding-factory-styles} The following two variables control -the location from where the ODT exporter picks up the custom styles -and content template files. Customize these variables to override the -factory styles used by the exporter. - -@table @asis -@item @code{org-odt-styles-file} -The ODT export back-end uses the file pointed to by this variable, -such as @samp{styles.xml}, for the final output. It can take one of the -following values: - -@table @asis -@item @samp{FILE.xml} -Use this file instead of the default @samp{styles.xml} - -@item @samp{FILE.odt} or @samp{FILE.ott} -Use the @samp{styles.xml} contained in the specified OpenDocument -Text or Template file - -@item @samp{FILE.odt} or @samp{FILE.ott} and a subset of included files -Use the @samp{styles.xml} contained in the specified OpenDocument Text -or Template file. Additionally extract the specified member files -and embed those within the final ODT document. - -Use this option if the @samp{styles.xml} file references additional -files like header and footer images. - -@item @code{nil} -Use the default @samp{styles.xml}. -@end table - -@item @code{org-odt-content-template-file} -Use this variable to specify the blank @samp{content.xml} used in the -final output. -@end table - -@anchor{Creating one-off styles} -@subsubheading Creating one-off styles - -The ODT export back-end can read embedded raw OpenDocument XML from -the Org file. Such direct formatting is useful for one-off instances. - -@table @asis -@item Embedding ODT tags as part of regular text -Enclose OpenDocument syntax in @samp{@@@@odt:...@@@@} for inline markup. For -example, to highlight a region of text do the following: - -@example -@@@@odt:<text:span text:style-name="Highlight">This is highlighted -text</text:span>@@@@. But this is regular text. -@end example - -@strong{Hint:} To see the above example in action, edit the @samp{styles.xml} -(see @ref{x-orgodtstyles-xml, , Factory styles}) and add a custom @emph{Highlight} style as shown -below: - -@example -<style:style style:name="Highlight" style:family="text"> - <style:text-properties fo:background-color="#ff0000"/> -</style:style> -@end example - -@item Embedding a one-line OpenDocument XML -@cindex @samp{ODT}, keyword -The ODT export back-end can read one-liner options with @samp{#+ODT:} in -the Org file. For example, to force a page break: - -@example -#+ODT: <text:p text:style-name="PageBreak"/> -@end example - -@strong{Hint:} To see the above example in action, edit your -@samp{styles.xml} (see @ref{x-orgodtstyles-xml, , Factory styles}) and add a custom @samp{PageBreak} -style as shown below. - -@example -<style:style style:name="PageBreak" style:family="paragraph" - style:parent-style-name="Text_20_body"> - <style:paragraph-properties fo:break-before="page"/> -</style:style> -@end example - -@item Embedding a block of OpenDocument XML -The ODT export back-end can also read ODT export blocks for -OpenDocument XML@. Such blocks use the @samp{#+BEGIN_EXPORT odt} -@dots{} @samp{#+END_EXPORT} constructs. - -For example, to create a one-off paragraph that uses bold text, do -the following: - -@example -#+BEGIN_EXPORT odt - <text:p text:style-name="Text_20_body_20_bold"> - This paragraph is specially formatted and uses bold text. - </text:p> -#+END_EXPORT -@end example -@end table - -@anchor{Customizing tables in ODT export} -@subsubheading Customizing tables in ODT export - -@cindex tables, in ODT export -@cindex @samp{ATTR_ODT}, keyword - -Override the default table format by specifying a custom table style -with the @samp{#+ATTR_ODT} line. For a discussion on default formatting of -tables, see @ref{Tables in ODT export}. - -This feature closely mimics the way table templates are defined in the -OpenDocument-v1.2 specification@footnote{@uref{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html, OpenDocument-v1.2 Specification}}. - -@vindex org-odt-table-styles -For quick preview of this feature, install the settings below and export the -table that follows: - -@lisp -(setq org-export-odt-table-styles - (append org-export-odt-table-styles - '(("TableWithHeaderRowAndColumn" "Custom" - ((use-first-row-styles . t) - (use-first-column-styles . t))) - ("TableWithFirstRowandLastRow" "Custom" - ((use-first-row-styles . t) - (use-last-row-styles . t)))))) -@end lisp - -@example -#+ATTR_ODT: :style TableWithHeaderRowAndColumn -| Name | Phone | Age | -| Peter | 1234 | 17 | -| Anna | 4321 | 25 | -@end example - -The example above used @samp{Custom} template and installed two table -styles @samp{TableWithHeaderRowAndColumn} and -@samp{TableWithFirstRowandLastRow}. @strong{Important:} The OpenDocument styles -needed for producing the above template were pre-defined. They are -available in the section marked @samp{Custom Table Template} in -@samp{OrgOdtContentTemplate.xml} (see @ref{x-orgodtcontenttemplate-xml, , Factory styles}). For adding new -templates, define new styles there. - -To use this feature proceed as follows: - -@enumerate -@item -Create a table template@footnote{See the @samp{<table:table-template>} element of the -OpenDocument-v1.2 specification.}. - -A table template is set of @samp{table-cell} and @samp{paragraph} styles for -each of the following table cell categories: - -@itemize -@item -Body -@item -First column -@item -Last column -@item -First row -@item -Last row -@item -Even row -@item -Odd row -@item -Even column -@item -Odd Column -@end itemize - -The names for the above styles must be chosen based on the name of -the table template using a well-defined convention. - -The naming convention is better illustrated with an example. For -a table template with the name @samp{Custom}, the needed style names are -listed in the following table. - -@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@headitem Cell type -@tab Cell style -@tab Paragraph style -@item Body -@tab @samp{CustomTableCell} -@tab @samp{CustomTableParagraph} -@item First column -@tab @samp{CustomFirstColumnTableCell} -@tab @samp{CustomFirstColumnTableParagraph} -@item Last column -@tab @samp{CustomLastColumnTableCell} -@tab @samp{CustomLastColumnTableParagraph} -@item First row -@tab @samp{CustomFirstRowTableCell} -@tab @samp{CustomFirstRowTableParagraph} -@item Last row -@tab @samp{CustomLastRowTableCell} -@tab @samp{CustomLastRowTableParagraph} -@item Even row -@tab @samp{CustomEvenRowTableCell} -@tab @samp{CustomEvenRowTableParagraph} -@item Odd row -@tab @samp{CustomOddRowTableCell} -@tab @samp{CustomOddRowTableParagraph} -@item Even column -@tab @samp{CustomEvenColumnTableCell} -@tab @samp{CustomEvenColumnTableParagraph} -@item Odd column -@tab @samp{CustomOddColumnTableCell} -@tab @samp{CustomOddColumnTableParagraph} -@end multitable - -To create a table template with the name @samp{Custom}, define the above -styles in the @samp{<office:automatic-styles>} @dots{} -@samp{</office:automatic-styles>} element of the content template file -(see @ref{x-orgodtcontenttemplate-xml, , Factory styles}). - -@item -Define a table style@footnote{See the attributes @samp{table:template-name}, -@samp{table:use-first-row-styles}, @samp{table:use-last-row-styles}, -@samp{table:use-first-column-styles}, @samp{table:use-last-column-styles}, -@samp{table:use-banding-rows-styles}, and @samp{table:use-banding-column-styles} -of the @samp{<table:table>} element in the OpenDocument-v1.2 specification.}. - -@vindex org-odt-table-styles -To define a table style, create an entry for the style in the -variable @code{org-odt-table-styles} and specify the following: - -@itemize -@item -the name of the table template created in step (1), -@item -the set of cell styles in that template that are to be activated. -@end itemize - -For example, the entry below defines two different table styles -@samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow} -based on the same template @samp{Custom}. The styles achieve their -intended effect by selectively activating the individual cell -styles in that template. - -@lisp -(setq org-export-odt-table-styles - (append org-export-odt-table-styles - '(("TableWithHeaderRowAndColumn" "Custom" - ((use-first-row-styles . t) - (use-first-column-styles . t))) - ("TableWithFirstRowandLastRow" "Custom" - ((use-first-row-styles . t) - (use-last-row-styles . t)))))) -@end lisp - -@item -Associate a table with the table style. - -To do this, specify the table style created in step (2) as part of -the @samp{ATTR_ODT} line as shown below. - -@example -#+ATTR_ODT: :style TableWithHeaderRowAndColumn -| Name | Phone | Age | -| Peter | 1234 | 17 | -| Anna | 4321 | 25 | -@end example -@end enumerate - -@anchor{Validating OpenDocument XML} -@subsubheading Validating OpenDocument XML - -Sometimes ODT format files may not open due to @samp{.odt} file corruption. -To verify if such a file is corrupt, validate it against the -OpenDocument Relax NG Compact (RNC) syntax schema. But first the -@samp{.odt} files have to be decompressed using @samp{zip}. Note that @samp{.odt} -files are ZIP archives: @ref{File Archives,,,emacs,}. The contents of -ODT files are in XML@. For general help with validation---and -schema-sensitive editing---of XML files: @ref{Introduction,,,nxml-mode,}. - -@vindex org-export-odt-schema-dir -Customize @code{org-odt-schema-dir} to point to a directory with -OpenDocument RNC files and the needed schema-locating rules. The ODT -export back-end takes care of updating the -@code{rng-schema-locating-files}. - -@node Org Export -@section Org Export - -@cindex Org export -@emph{org} export back-end creates a normalized version of the Org document -in current buffer. The exporter evaluates Babel code (see @ref{Evaluating Code Blocks}) and removes content specific to other back-ends. - -@anchor{Org export commands} -@subheading Org export commands - -@table @asis -@item @kbd{C-c C-e O o} (@code{org-org-export-to-org}) -@kindex C-c C-e O o -@findex org-org-export-to-org -Export as an Org file with a @samp{.org} extension. For @samp{myfile.org}, -Org exports to @samp{myfile.org.org}, overwriting without warning. - -@item @kbd{C-c C-e O v} (~~) -@kindex C-c C-e O v -Export to an Org file, then open it. -@end table - -@node Texinfo Export -@section Texinfo Export - -@menu -* Texinfo export commands:: Invoking commands. -* Texinfo specific export settings:: Setting the environment. -* Texinfo file header:: Generating the header. -* Texinfo title and copyright page:: Creating preamble pages. -* Info directory file:: Installing a manual in Info file hierarchy. -* Headings and sectioning structure:: Building document structure. -* Indices:: Creating indices. -* Quoting Texinfo code:: Incorporating literal Texinfo code. -* Plain lists in Texinfo export:: List attributes. -* Tables in Texinfo export:: Table attributes. -* Images in Texinfo export:: Image attributes. -* Quotations in Texinfo export:: Quote block attributes. -* Special blocks in Texinfo export:: Special block attributes. -* A Texinfo example:: Processing Org to Texinfo. -@end menu - -@node Texinfo export commands -@subsection Texinfo export commands - -@table @asis -@item @kbd{C-c C-e i t} (@code{org-texinfo-export-to-texinfo}) -@kindex C-c C-e i t -@findex org-texinfo-export-to-texinfo -Export as a Texinfo file with @samp{.texi} extension. For @samp{myfile.org}, -Org exports to @samp{myfile.texi}, overwriting without warning. - -@item @kbd{C-c C-e i i} (@code{org-texinfo-export-to-info}) -@kindex C-c C-e i i -@findex org-texinfo-export-to-info -@vindex org-texinfo-info-process -Export to Texinfo format first and then process it to make an Info -file. To generate other formats, such as DocBook, customize the -@code{org-texinfo-info-process} variable. -@end table - -@node Texinfo specific export settings -@subsection Texinfo specific export settings - -The Texinfo export back-end has several additional keywords for -customizing Texinfo output. Setting these keywords works similar to -the general options (see @ref{Export Settings}). - -@table @asis -@item @samp{SUBTITLE} -@cindex @samp{SUBTITLE}, keyword -The document subtitle. - -@item @samp{SUBAUTHOR} -@cindex @samp{SUBAUTHOR}, keyword -Additional authors for the document. - -@item @samp{TEXINFO_FILENAME} -@cindex @samp{TEXINFO_FILENAME}, keyword -The Texinfo filename. - -@item @samp{TEXINFO_CLASS} -@cindex @samp{TEXINFO_CLASS}, keyword -@vindex org-texinfo-default-class -The default document class (@code{org-texinfo-default-class}), which must -be a member of @code{org-texinfo-classes}. - -@item @samp{TEXINFO_HEADER} -@cindex @samp{TEXINFO_HEADER}, keyword -Arbitrary lines inserted at the end of the header. - -@item @samp{TEXINFO_POST_HEADER} -@cindex @samp{TEXINFO_POST_HEADER}, keyword -Arbitrary lines inserted after the end of the header. - -@item @samp{TEXINFO_DIR_CATEGORY} -@cindex @samp{TEXINFO_DIR_CATEGORY}, keyword -The directory category of the document. - -@item @samp{TEXINFO_DIR_TITLE} -@cindex @samp{TEXINFO_DIR_TITLE}, keyword -The directory title of the document. - -@item @samp{TEXINFO_DIR_DESC} -@cindex @samp{TEXINFO_DIR_DESC}, keyword -The directory description of the document. - -@item @samp{TEXINFO_PRINTED_TITLE} -@cindex @samp{TEXINFO_PRINTED_TITLE}, keyword -The printed title of the document. -@end table - -@node Texinfo file header -@subsection Texinfo file header - -@cindex @samp{TEXINFO_FILENAME}, keyword -After creating the header for a Texinfo file, the Texinfo back-end -automatically generates a name and destination path for the Info file. -To override this default with a more sensible path and name, specify -the @samp{TEXINFO_FILENAME} keyword. - -@vindex org-texinfo-coding-system -@cindex @samp{TEXINFO_HEADER}, keyword -Along with the output's file name, the Texinfo header also contains -language details (see @ref{Export Settings}) and encoding system as set in -the @code{org-texinfo-coding-system} variable. Insert @samp{TEXINFO_HEADER} -keywords for each additional command in the header, for example: - -@example -#+TEXINFO_HEADER: @@synindex -@end example - - -@cindex @samp{TEXINFO_CLASS}, keyword -@vindex org-texinfo-classes -Instead of repeatedly installing the same set of commands, define -a class in @code{org-texinfo-classes} once, and then activate it in the -document by setting the @samp{TEXINFO_CLASS} keyword to that class. - -@node Texinfo title and copyright page -@subsection Texinfo title and copyright page - -@cindex @samp{TEXINFO_PRINTED_TITLE}, keyword -The default template for hard copy output has a title page with -@samp{TITLE} and @samp{AUTHOR} keywords (see @ref{Export Settings}). To replace the -regular title with something different for the printed version, use -the @samp{TEXINFO_PRINTED_TITLE} and @samp{SUBTITLE} keywords. Both expect raw -Texinfo code for setting their values. - -@cindex @samp{SUBAUTHOR}, keyword -If one @samp{AUTHOR} line is not sufficient, add multiple @samp{SUBAUTHOR} -keywords. They have to be set in raw Texinfo code. - -@example -#+AUTHOR: Jane Smith -#+SUBAUTHOR: John Doe -#+TEXINFO_PRINTED_TITLE: This Long Title@@@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@} -@end example - -@cindex @samp{COPYING}, property -Copying material is defined in a dedicated headline with a non-@code{nil} -@samp{COPYING} property. The back-end inserts the contents within -a @samp{@@copying} command at the beginning of the document. The heading -itself does not appear in the structure of the document. - -Copyright information is printed on the back of the title page. - -@example -* Legalese - :PROPERTIES: - :COPYING: t - :END: - - This is a short example of a complete Texinfo file, version 1.0. - - Copyright \copy 2016 Free Software Foundation, Inc. -@end example - -@node Info directory file -@subsection Info directory file - -@cindex @samp{dir} file, in Texinfo export -@cindex Info directory file, in Texinfo export -@cindex @code{install-info}, in Texinfo export - -@cindex @samp{TEXINFO_DIR_CATEGORY}, keyword -@cindex @samp{TEXINFO_DIR_TITLE}, keyword -@cindex @samp{TEXINFO_DIR_DESC}, keyword -The end result of the Texinfo export process is the creation of an -Info file. This Info file's metadata has variables for category, -title, and description: @samp{TEXINFO_DIR_CATEGORY}, @samp{TEXINFO_DIR_TITLE}, -and @samp{TEXINFO_DIR_DESC} keywords that establish where in the Info -hierarchy the file fits. - -Here is an example that writes to the Info directory file: - -@example -#+TEXINFO_DIR_CATEGORY: Emacs -#+TEXINFO_DIR_TITLE: Org Mode: (org) -#+TEXINFO_DIR_DESC: Outline-based notes management and organizer -@end example - -@node Headings and sectioning structure -@subsection Headings and sectioning structure - -@vindex org-texinfo-classes -@vindex org-texinfo-default-class -@cindex @samp{TEXINFO_CLASS}, keyword -The Texinfo export back-end uses a pre-defined scheme to convert Org -headlines to equivalent Texinfo structuring commands. A scheme like -this maps top-level headlines to numbered chapters tagged as -@code{@@chapter} and lower-level headlines to unnumbered chapters tagged as -@code{@@unnumbered}. To override such mappings to introduce @code{@@part} or -other Texinfo structuring commands, define a new class in -@code{org-texinfo-classes}. Activate the new class with the -@samp{TEXINFO_CLASS} keyword. When no new class is defined and activated, -the Texinfo export back-end defaults to the -@code{org-texinfo-default-class}. - -If an Org headline's level has no associated Texinfo structuring -command, or is below a certain threshold (see @ref{Export Settings}), then -the Texinfo export back-end makes it into a list item. - -@cindex @samp{APPENDIX}, property -The Texinfo export back-end makes any headline with a non-@code{nil} -@samp{APPENDIX} property into an appendix. This happens independent of the -Org headline level or the @samp{TEXINFO_CLASS} keyword. - -@cindex @samp{ALT_TITLE}, property -@cindex @samp{DESCRIPTION}, property -The Texinfo export back-end creates a menu entry after the Org -headline for each regular sectioning structure. To override this with -a shorter menu entry, use the @samp{ALT_TITLE} property (see @ref{Table of Contents}). Texinfo menu entries also have an option for a longer -@samp{DESCRIPTION} property. Here's an example that uses both to override -the default menu entry: - -@example -* Controlling Screen Display - :PROPERTIES: - :ALT_TITLE: Display - :DESCRIPTION: Controlling Screen Display - :END: -@end example - -@cindex Top node, in Texinfo export -The text before the first headline belongs to the @emph{Top} node, i.e., -the node in which a reader enters an Info manual. As such, it is -expected not to appear in printed output generated from the @samp{.texi} -file. See @ref{The Top Node,,,texinfo,}, for more information. - -@node Indices -@subsection Indices - -@cindex @samp{CINDEX}, keyword -@cindex concept index, in Texinfo export -@cindex @samp{FINDEX}, keyword -@cindex function index, in Texinfo export -@cindex @samp{KINDEX}, keyword -@cindex keystroke index, in Texinfo export -@cindex @samp{PINDEX}, keyword -@cindex program index, in Texinfo export -@cindex @samp{TINDEX}, keyword -@cindex data type index, in Texinfo export -@cindex @samp{VINDEX}, keyword -@cindex variable index, in Texinfo export -The Texinfo export back-end recognizes these indexing keywords if used -in the Org file: @samp{CINDEX}, @samp{FINDEX}, @samp{KINDEX}, @samp{PINDEX}, @samp{TINDEX} and -@samp{VINDEX}. Write their value as verbatim Texinfo code; in particular, -@samp{@{}, @samp{@}} and @samp{@@} characters need to be escaped with @samp{@@} if they do not -belong to a Texinfo command. - -@example -#+CINDEX: Defining indexing entries -@end example - - -@cindex @samp{INDEX}, property -For the back-end to generate an index entry for a headline, set the -@samp{INDEX} property to @samp{cp} or @samp{vr}. These abbreviations come from -Texinfo that stand for concept index and variable index. The Texinfo -manual has abbreviations for all other kinds of indexes. The back-end -exports the headline as an unnumbered chapter or section command, and -then inserts the index after its contents. - -@example -* Concept Index - :PROPERTIES: - :INDEX: cp - :END: -@end example - -@node Quoting Texinfo code -@subsection Quoting Texinfo code - -Use any of the following three methods to insert or escape raw Texinfo -code: - -@cindex @samp{TEXINFO}, keyword -@cindex @samp{BEGIN_EXPORT texinfo} -@example -Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU. - -#+TEXINFO: @@need800 -This paragraph is preceded by... - -#+BEGIN_EXPORT texinfo - @@auindex Johnson, Mark - @@auindex Lakoff, George -#+END_EXPORT -@end example - -@node Plain lists in Texinfo export -@subsection Plain lists in Texinfo export - -@cindex @samp{ATTR_TEXINFO}, keyword -@cindex two-column tables, in Texinfo export -@cindex table-type, Texinfo attribute -The Texinfo export back-end by default converts description lists in -the Org file using the default command @samp{@@table}, which results in -a table with two columns. To change this behavior, set @samp{:table-type} -attribute to either @samp{ftable} or @samp{vtable} value. For more information, -see @ref{Two-column Tables,,,texinfo,}. - -@vindex org-texinfo-table-default-markup -@cindex indic, Texinfo attribute -The Texinfo export back-end by default also applies a text highlight -based on the defaults stored in @code{org-texinfo-table-default-markup}. -To override the default highlight command, specify another one with -the @samp{:indic} attribute. - -@cindex multiple items in Texinfo lists -@cindex sep, Texinfo attribute -Org syntax is limited to one entry per list item. Nevertheless, the -Texinfo export back-end can split that entry according to any text -provided through the @samp{:sep} attribute. Each part then becomes a new -entry in the first column of the table. - -The following example illustrates all the attributes above: - -@example -#+ATTR_TEXINFO: :table-type vtable :sep , :indic asis -- foo, bar :: This is the common text for variables foo and bar. -@end example - -@noindent -becomes - -@example -@@vtable @@asis -@@item foo -@@itemx bar -This is the common text for variables foo and bar. -@@end table -@end example - -@cindex lettered lists, in Texinfo export -@cindex enum, Texinfo attribute -Ordered lists are numbered when exported to Texinfo format. Such -numbering obeys any counter (see @ref{Plain Lists}) in the first item of -the list. The @samp{:enum} attribute also let you start the list at -a specific number, or switch to a lettered list, as illustrated here - -@example -#+ATTR_TEXINFO: :enum A -1. Alpha -2. Bravo -3. Charlie -@end example - -@node Tables in Texinfo export -@subsection Tables in Texinfo export - -@cindex @samp{ATTR_TEXINFO}, keyword -When exporting tables, the Texinfo export back-end uses the widest -cell width in each column. To override this and instead specify as -fractions of line length, use the @samp{:columns} attribute. See example -below. - -@example -#+ATTR_TEXINFO: :columns .5 .5 -| a cell | another cell | -@end example - -@node Images in Texinfo export -@subsection Images in Texinfo export - -@cindex @samp{ATTR_TEXINFO}, keyword -Insert a file link to the image in the Org file, and the Texinfo -export back-end inserts the image. These links must have the usual -supported image extensions and no descriptions. To scale the image, -use @samp{:width} and @samp{:height} attributes. For alternate text, use @samp{:alt} -and specify the text using Texinfo code, as shown in the example: - -@example -#+ATTR_TEXINFO: :width 1in :alt Alternate @@i@{text@} -[[ridt.pdf]] -@end example - -@node Quotations in Texinfo export -@subsection Quotations in Texinfo export - -@cindex @samp{ATTR_TEXINFO}, keyword -You can write the text of a quotation within a quote block (see -@ref{Paragraphs}). You may also emphasize some text at the beginning of -the quotation with the @samp{:tag} attribute. - -@example -#+ATTR_TEXINFO: :tag Warning -#+BEGIN_QUOTE -Striking your thumb with a hammer may cause severe pain and discomfort. -#+END_QUOTE -@end example - -To specify the author of the quotation, use the @samp{:author} attribute. - -@example -#+ATTR_TEXINFO: :author King Arthur -#+BEGIN_QUOTE -The Lady of the Lake, her arm clad in the purest shimmering samite, -held aloft Excalibur from the bosom of the water, signifying by divine -providence that I, Arthur, was to carry Excalibur. That is why I am -your king. -#+END_QUOTE -@end example - -@node Special blocks in Texinfo export -@subsection Special blocks in Texinfo export - -@cindex @samp{ATTR_TEXINFO}, keyword - -The Texinfo export back-end converts special blocks to commands with -the same name. It also adds any @samp{:options} attributes to the end of -the command, as shown in this example: - -@example -#+ATTR_TEXINFO: :options org-org-export-to-org ... -#+BEGIN_defun - A somewhat obsessive function name. -#+END_defun -@end example - -@noindent -becomes - -@example -@@defun org-org-export-to-org ... - A somewhat obsessive function name. -@@end defun -@end example - -@node A Texinfo example -@subsection A Texinfo example - -Here is a more detailed example Org file. See -@ref{GNU Sample Texts,,,texinfo,} for an equivalent example using -Texinfo code. - -@example -#+TITLE: GNU Sample @{@{@{version@}@}@} -#+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@} -#+AUTHOR: A.U. Thor -#+EMAIL: bug-sample@@gnu.org - -#+OPTIONS: ':t toc:t author:t email:t -#+LANGUAGE: en - -#+MACRO: version 2.0 -#+MACRO: updated last updated 4 March 2014 - -#+TEXINFO_FILENAME: sample.info -#+TEXINFO_HEADER: @@syncodeindex pg cp - -#+TEXINFO_DIR_CATEGORY: Texinfo documentation system -#+TEXINFO_DIR_TITLE: sample: (sample) -#+TEXINFO_DIR_DESC: Invoking sample - -#+TEXINFO_PRINTED_TITLE: GNU Sample - -This manual is for GNU Sample (version @{@{@{version@}@}@}, -@{@{@{updated@}@}@}). - -* Copying - :PROPERTIES: - :COPYING: t - :END: - - This manual is for GNU Sample (version @{@{@{version@}@}@}, - @{@{@{updated@}@}@}), which is an example in the Texinfo documentation. - - Copyright \copy 2016 Free Software Foundation, Inc. - - #+BEGIN_QUOTE - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation License, - Version 1.3 or any later version published by the Free Software - Foundation; with no Invariant Sections, with no Front-Cover Texts, - and with no Back-Cover Texts. A copy of the license is included in - the section entitled "GNU Free Documentation License". - #+END_QUOTE - -* Invoking sample - - #+PINDEX: sample - #+CINDEX: invoking @@command@{sample@} - - This is a sample manual. There is no sample program to invoke, but - if there were, you could see its basic usage and command line - options here. - -* GNU Free Documentation License - :PROPERTIES: - :APPENDIX: t - :END: - - #+INCLUDE: fdl.org - -* Index - :PROPERTIES: - :INDEX: cp - :END: -@end example - -@node iCalendar Export -@section iCalendar Export - -@cindex iCalendar export - -A large part of Org mode's interoperability success is its ability to -easily export to or import from external applications. The iCalendar -export back-end takes calendar data from Org files and exports to the -standard iCalendar format. - -@vindex org-icalendar-include-todo -@vindex org-icalendar-use-deadline -@vindex org-icalendar-use-scheduled -The iCalendar export back-end can also incorporate TODO entries based -on the configuration of the @code{org-icalendar-include-todo} variable. -The back-end exports plain timestamps as @samp{VEVENT}, TODO items as -@samp{VTODO}, and also create events from deadlines that are in non-TODO -items. The back-end uses the deadlines and scheduling dates in Org -TODO items for setting the start and due dates for the iCalendar TODO -entry. Consult the @code{org-icalendar-use-deadline} and -@code{org-icalendar-use-scheduled} variables for more details. - -@vindex org-icalendar-categories -@vindex org-icalendar-alarm-time -For tags on the headline, the iCalendar export back-end makes them -into iCalendar categories. To tweak the inheritance of tags and TODO -states, configure the variable @code{org-icalendar-categories}. To assign -clock alarms based on time, configure the @code{org-icalendar-alarm-time} -variable. - -@vindex org-icalendar-store-UID -@cindex @samp{ID}, property -The iCalendar format standard requires globally unique identifier---or -UID---for each entry. The iCalendar export back-end creates UIDs -during export. To save a copy of the UID in the Org file set the -variable @code{org-icalendar-store-UID}. The back-end looks for the @samp{ID} -property of the entry for re-using the same UID for subsequent -exports. - -Since a single Org entry can result in multiple iCalendar -entries---timestamp, deadline, scheduled item, or TODO item---Org adds -prefixes to the UID, depending on which part of the Org entry -triggered the creation of the iCalendar entry. Prefixing ensures UIDs -remains unique, yet enable synchronization programs trace the -connections. - -@table @asis -@item @kbd{C-c C-e c f} (@code{org-icalendar-export-to-ics}) -@kindex C-c C-e c f -@findex org-icalendar-export-to-ics -Create iCalendar entries from the current Org buffer and store them -in the same directory, using a file extension @samp{.ics}. - -@item @kbd{C-c C-e c a} (@code{org-icalendar-export-agenda-files}) -@kindex C-c C-e c a -@findex org-icalendar-export-agenda-files -Create iCalendar entries from Org files in @code{org-agenda-files} and -store in a separate iCalendar file for each Org file. - -@item @kbd{C-c C-e c c} (@code{org-icalendar-combine-agenda-files}) -@kindex C-c C-e c c -@findex org-icalendar-combine-agenda-files -@vindex org-icalendar-combined-agenda-file -Create a combined iCalendar file from Org files in -@code{org-agenda-files} and write it to -@code{org-icalendar-combined-agenda-file} file name. -@end table - -@cindex @samp{SUMMARY}, property -@cindex @samp{DESCRIPTION}, property -@cindex @samp{LOCATION}, property -@cindex @samp{TIMEZONE}, property -@cindex @samp{CLASS}, property -The iCalendar export back-end includes @samp{SUMMARY}, @samp{DESCRIPTION}, -@samp{LOCATION}, @samp{TIMEZONE} and @samp{CLASS} properties from the Org entries -when exporting. To force the back-end to inherit the @samp{LOCATION}, -@samp{TIMEZONE} and @samp{CLASS} properties, configure the -@code{org-use-property-inheritance} variable. - -@vindex org-icalendar-include-body -When Org entries do not have @samp{SUMMARY}, @samp{DESCRIPTION}, @samp{LOCATION} and -@samp{CLASS} properties, the iCalendar export back-end derives the summary -from the headline, and derives the description from the body of the -Org item. The @code{org-icalendar-include-body} variable limits the -maximum number of characters of the content are turned into its -description. - -The @samp{TIMEZONE} property can be used to specify a per-entry time zone, -and is applied to any entry with timestamp information. Time zones -should be specified as per the IANA time zone database format, e.g., -@samp{Asia/Almaty}. Alternately, the property value can be @samp{UTC}, to force -UTC time for this entry only. - -The @samp{CLASS} property can be used to specify a per-entry visibility -class or access restrictions, and is applied to any entry with class -information. The iCalendar standard defines three visibility classes: -@table @asis -@item @samp{PUBLIC} -The entry is publicly visible (this is the default). -@item @samp{CONFIDENTIAL} -Only a limited group of clients get access to the -event. -@item @samp{PRIVATE} -The entry can be retrieved only by its owner. -@end table -The server should treat unknown class properties the same as -@samp{PRIVATE}. - -Exporting to iCalendar format depends in large part on the -capabilities of the destination application. Some are more lenient -than others. Consult the Org mode FAQ for advice on specific -applications. - -@node Other Built-in Back-ends -@section Other Built-in Back-ends - -Other export back-ends included with Org are: - -@itemize -@item -@samp{ox-man.el}: Export to a man page. -@end itemize - -To activate such back-ends, either customize @code{org-export-backends} or -load directly with @samp{(require 'ox-man)}. On successful load, the -back-end adds new keys in the export dispatcher (see @ref{The Export Dispatcher}). - -Follow the comment section of such files, for example, @samp{ox-man.el}, -for usage and configuration details. - -@node Advanced Export Configuration -@section Advanced Export Configuration - - - -@anchor{Hooks} -@subheading Hooks - -@vindex org-export-before-processing-hook -@vindex org-export-before-parsing-hook -The export process executes two hooks before the actual exporting -begins. The first hook, @code{org-export-before-processing-hook}, runs -before any expansions of macros, Babel code, and include keywords in -the buffer. The second hook, @code{org-export-before-parsing-hook}, runs -before the buffer is parsed. - -Functions added to these hooks are called with a single argument: the -export back-end actually used, as a symbol. You may use them for -heavy duty structural modifications of the document. For example, you -can remove every headline in the buffer during export like this: - -@lisp -(defun my-headline-removal (backend) - "Remove all headlines in the current buffer. -BACKEND is the export back-end being used, as a symbol." - (org-map-entries - (lambda () (delete-region (point) (line-beginning-position 2))))) - -(add-hook 'org-export-before-parsing-hook 'my-headline-removal) -@end lisp - -@anchor{Filters} -@subheading Filters - -@cindex Filters, exporting -Filters are lists of functions to be applied to certain parts for -a given back-end. The output from the first function in the filter is -passed on to the next function in the filter. The final output is the -output from the final function in the filter. - -The Org export process has many filter sets applicable to different -types of objects, plain text, parse trees, export options, and final -output formats. The filters are named after the element type or -object type: @code{org-export-filter-TYPE-functions}, where @var{TYPE} -is the type targeted by the filter. Valid types are: - -@multitable @columnfractions 0.33 0.33 0.33 -@item body -@tab bold -@tab babel-call -@item center-block -@tab clock -@tab code -@item diary-sexp -@tab drawer -@tab dynamic-block -@item entity -@tab example-block -@tab export-block -@item export-snippet -@tab final-output -@tab fixed-width -@item footnote-definition -@tab footnote-reference -@tab headline -@item horizontal-rule -@tab inline-babel-call -@tab inline-src-block -@item inlinetask -@tab italic -@tab item -@item keyword -@tab latex-environment -@tab latex-fragment -@item line-break -@tab link -@tab node-property -@item options -@tab paragraph -@tab parse-tree -@item plain-list -@tab plain-text -@tab planning -@item property-drawer -@tab quote-block -@tab radio-target -@item section -@tab special-block -@tab src-block -@item statistics-cookie -@tab strike-through -@tab subscript -@item superscript -@tab table -@tab table-cell -@item table-row -@tab target -@tab timestamp -@item underline -@tab verbatim -@tab verse-block -@end multitable - -Here is an example filter that replaces non-breaking spaces @code{ } in the -Org buffer with @samp{~} for the @LaTeX{} back-end. - -@lisp -(defun my-latex-filter-nobreaks (text backend info) - "Ensure \" \" are properly handled in LaTeX export." - (when (org-export-derived-backend-p backend 'latex) - (replace-regexp-in-string " " "~" text))) - -(add-to-list 'org-export-filter-plain-text-functions - 'my-latex-filter-nobreaks) -@end lisp - -A filter requires three arguments: the code to be transformed, the -name of the back-end, and some optional information about the export -process. The third argument can be safely ignored. Note the use of -@code{org-export-derived-backend-p} predicate that tests for @emph{latex} -back-end or any other back-end, such as @emph{beamer}, derived from -@emph{latex}. - -@anchor{Defining filters for individual files} -@subheading Defining filters for individual files - -The Org export can filter not just for back-ends, but also for -specific files through the @samp{BIND} keyword. Here is an example with -two filters; one removes brackets from time stamps, and the other -removes strike-through text. The filter functions are defined in -a code block in the same Org file, which is a handy location for -debugging. - -@example -#+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp) -#+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through) -#+BEGIN_SRC emacs-lisp :exports results :results none - (defun tmp-f-timestamp (s backend info) - (replace-regexp-in-string "&[lg]t;\\|[][]" "" s)) - (defun tmp-f-strike-through (s backend info) "") -#+END_SRC -@end example - -@anchor{Extending an existing back-end} -@subheading Extending an existing back-end - -Some parts of the conversion process can be extended for certain -elements so as to introduce a new or revised translation. That is how -the HTML export back-end was extended to handle Markdown format. The -extensions work seamlessly so any aspect of filtering not done by the -extended back-end is handled by the original back-end. Of all the -export customization in Org, extending is very powerful as it operates -at the parser level. - -For this example, make the @emph{ascii} back-end display the language used -in a source code block. Also make it display only when some attribute -is non-@code{nil}, like the following: - -@example -#+ATTR_ASCII: :language t -@end example - - -Then extend ASCII back-end with a custom ``my-ascii'' back-end. - -@lisp -(defun my-ascii-src-block (src-block contents info) - "Transcode a SRC-BLOCK element from Org to ASCII. -CONTENTS is nil. INFO is a plist used as a communication -channel." - (if (not (org-export-read-attribute :attr_ascii src-block :language)) - (org-export-with-backend 'ascii src-block contents info) - (concat - (format ",--[ %s ]--\n%s`----" - (org-element-property :language src-block) - (replace-regexp-in-string - "^" "| " - (org-element-normalize-string - (org-export-format-code-default src-block info))))))) - -(org-export-define-derived-backend 'my-ascii 'ascii - :translate-alist '((src-block . my-ascii-src-block))) -@end lisp - -The @code{my-ascii-src-block} function looks at the attribute above the -current element. If not true, hands over to @emph{ascii} back-end. If -true, which it is in this example, it creates a box around the code -and leaves room for the inserting a string for language. The last -form creates the new back-end that springs to action only when -translating @code{src-block} type elements. - -To use the newly defined back-end, evaluate the following from an Org -buffer: - -@lisp -(org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*") -@end lisp - -Further steps to consider would be an interactive function, -self-installing an item in the export dispatcher menu, and other -user-friendly improvements. - -@node Export in Foreign Buffers -@section Export in Foreign Buffers - -The export back-ends in Org often include commands to convert selected -regions. A convenient feature of this in-place conversion is that the -exported output replaces the original source. Here are such -functions: - -@table @asis -@item @code{org-ascii-convert-region-to-ascii} -@findex org-ascii-convert-region-to-ascii -Convert the selected region into ASCII@. - -@item @code{org-ascii-convert-region-to-utf8} -@findex org-ascii-convert-region-to-utf8 -Convert the selected region into UTF-8. - -@item @code{org-html-convert-region-to-html} -@findex org-html-convert-region-to-html -Convert the selected region into HTML@. - -@item @code{org-latex-convert-region-to-latex} -@findex org-latex-convert-region-to-latex -Convert the selected region into @LaTeX{}. - -@item @code{org-texinfo-convert-region-to-texinfo} -@findex org-texinfo-convert-region-to-texinfo -Convert the selected region into Texinfo. - -@item @code{org-md-convert-region-to-md} -@findex org-md-convert-region-to-md -Convert the selected region into Markdown. -@end table - -In-place conversions are particularly handy for quick conversion of -tables and lists in foreign buffers. For example, in an HTML buffer, -write a list in Org syntax, select it, and convert it to HTML with -@kbd{M-x org-html-convert-region-to-html}. - -@menu -* Bare HTML:: Exporting HTML without CSS, Javascript, etc. -@end menu - -@node Bare HTML -@subsection Exporting to minimal HTML - -If you want to output a minimal HTML file, with no CSS, no Javascript, -no preamble or postamble, here are the variable you would need to set: - -@vindex org-html-head -@vindex org-html-head-extra -@vindex org-html-head-include-default-style -@vindex org-html-head-include-scripts -@vindex org-html-preamble -@vindex org-html-postamble -@vindex org-html-use-infojs -@lisp -(setq org-html-head "" - org-html-head-extra "" - org-html-head-include-default-style nil - org-html-head-include-scripts nil - org-html-preamble nil - org-html-postamble nil - org-html-use-infojs nil) -@end lisp - -@node Publishing -@chapter Publishing - -@cindex publishing - -Org includes a publishing management system that allows you to -configure automatic HTML conversion of @emph{projects} composed of -interlinked Org files. You can also configure Org to automatically -upload your exported HTML pages and related attachments, such as -images and source code files, to a web server. - -You can also use Org to convert files into PDF, or even combine HTML -and PDF conversion so that files are available in both formats on the -server. - -Publishing has been contributed to Org by David O'Toole. - -@menu -* Configuration:: Defining projects. -* Uploading Files:: How to get files up on the server. -* Sample Configuration:: Example projects. -* Triggering Publication:: Publication commands. -@end menu - -@node Configuration -@section Configuration - -Publishing needs significant configuration to specify files, -destination and many other properties of a project. - -@menu -* Project alist:: The central configuration variable. -* Sources and destinations:: From here to there. -* Selecting files:: What files are part of the project? -* Publishing action:: Setting the function doing the publishing. -* Publishing options:: Tweaking HTML/@LaTeX{} export. -* Publishing links:: Which links keep working after publishing? -* Site map:: Generating a list of all pages. -* Generating an index:: An index that reaches across pages. -@end menu - -@node Project alist -@subsection The variable @code{org-publish-project-alist} - -@cindex projects, for publishing - -@vindex org-publish-project-alist -Publishing is configured almost entirely through setting the value of -one variable, called @code{org-publish-project-alist}. Each element of the -list configures one project, and may be in one of the two following -forms: - -@lisp -("project-name" :property value :property value ...) -@end lisp - -@noindent -i.e., a well-formed property list with alternating keys and values, -or: - -@lisp -("project-name" :components ("project-name" "project-name" ...)) -@end lisp - -In both cases, projects are configured by specifying property values. -A project defines the set of files that are to be published, as well -as the publishing configuration to use when publishing those files. -When a project takes the second form listed above, the individual -members of the @code{:components} property are taken to be sub-projects, -which group together files requiring different publishing options. -When you publish such a ``meta-project'', all the components are also -published, in the sequence given. - -@node Sources and destinations -@subsection Sources and destinations for files - -@cindex directories, for publishing - -Most properties are optional, but some should always be set. In -particular, Org needs to know where to look for source files, and -where to put published files. - -@table @asis -@item @code{:base-directory} -Directory containing publishing source files. - -@item @code{:publishing-directory} -Directory where output files are published. You can directly -publish to a webserver using a file name syntax appropriate for the -Emacs tramp package. Or you can publish to a local directory and -use external tools to upload your website (see @ref{Uploading Files}). - -@item @code{:preparation-function} -Function or list of functions to be called before starting the -publishing process, for example, to run @samp{make} for updating files to -be published. Each preparation function is called with a single -argument, the project property list. - -@item @code{:completion-function} -Function or list of functions called after finishing the publishing -process, for example, to change permissions of the resulting files. -Each completion function is called with a single argument, the -project property list. -@end table - -@node Selecting files -@subsection Selecting files - -@cindex files, selecting for publishing - -By default, all files with extension @samp{.org} in the base directory are -considered part of the project. This can be modified by setting the -following properties - -@table @asis -@item @code{:base-extension} -Extension---without the dot---of source files. This actually is -a regular expression. Set this to the symbol @code{any} if you want to -get all files in @code{:base-directory}, even without extension. - -@item @code{:exclude} -Regular expression to match file names that should not be published, -even though they have been selected on the basis of their extension. - -@item @code{:include} -List of files to be included regardless of @code{:base-extension} and -@code{:exclude}. - -@item @code{:recursive} -Non-@code{nil} means, check base-directory recursively for files to -publish. -@end table - -@node Publishing action -@subsection Publishing action - -@cindex action, for publishing - -Publishing means that a file is copied to the destination directory -and possibly transformed in the process. The default transformation -is to export Org files as HTML files, and this is done by the function -@code{org-publish-org-to-html} which calls the HTML exporter (see @ref{HTML Export}). But you can also publish your content as PDF files using -@code{org-publish-org-to-pdf}, or as ASCII, Texinfo, etc., using the -corresponding functions. - -If you want to publish the Org file as an @samp{.org} file but with -@emph{archived}, @emph{commented}, and @emph{tag-excluded} trees removed, use -@code{org-publish-org-to-org}. This produces @samp{file.org} and put it in the -publishing directory. If you want a htmlized version of this file, -set the parameter @code{:htmlized-source} to @code{t}. It produces -@samp{file.org.html} in the publishing directory@footnote{If the publishing directory is the same as the source -directory, @samp{file.org} is exported as @samp{file.org.org}, so you probably -do not want to do this.}. - -Other files like images only need to be copied to the publishing -destination; for this you can use @code{org-publish-attachment}. For -non-Org files, you always need to specify the publishing function: - -@table @asis -@item @code{:publishing-function} -Function executing the publication of a file. This may also be -a list of functions, which are all called in turn. - -@item @code{:htmlized-source} -Non-@code{nil} means, publish htmlized source. -@end table - -The function must accept three arguments: a property list containing -at least a @code{:publishing-directory} property, the name of the file to -be published, and the path to the publishing directory of the output -file. It should take the specified file, make the necessary -transformation, if any, and place the result into the destination -folder. - -@node Publishing options -@subsection Options for the exporters - -@cindex options, for publishing -@cindex publishing options - -The property list can be used to set many export options for the HTML -and @LaTeX{} exporters. In most cases, these properties correspond to -user variables in Org. The table below lists these properties along -with the variable they belong to. See the documentation string for -the respective variable for details. - -@vindex org-publish-project-alist -When a property is given a value in @code{org-publish-project-alist}, its -setting overrides the value of the corresponding user variable, if -any, during publishing. Options set within a file (see @ref{Export Settings}), however, override everything. - -@anchor{Generic properties} -@subsubheading Generic properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:archived-trees} -@tab @code{org-export-with-archived-trees} -@item @code{:exclude-tags} -@tab @code{org-export-exclude-tags} -@item @code{:headline-levels} -@tab @code{org-export-headline-levels} -@item @code{:language} -@tab @code{org-export-default-language} -@item @code{:preserve-breaks} -@tab @code{org-export-preserve-breaks} -@item @code{:section-numbers} -@tab @code{org-export-with-section-numbers} -@item @code{:select-tags} -@tab @code{org-export-select-tags} -@item @code{:with-author} -@tab @code{org-export-with-author} -@item @code{:with-broken-links} -@tab @code{org-export-with-broken-links} -@item @code{:with-clocks} -@tab @code{org-export-with-clocks} -@item @code{:with-creator} -@tab @code{org-export-with-creator} -@item @code{:with-date} -@tab @code{org-export-with-date} -@item @code{:with-drawers} -@tab @code{org-export-with-drawers} -@item @code{:with-email} -@tab @code{org-export-with-email} -@item @code{:with-emphasize} -@tab @code{org-export-with-emphasize} -@item @code{:with-fixed-width} -@tab @code{org-export-with-fixed-width} -@item @code{:with-footnotes} -@tab @code{org-export-with-footnotes} -@item @code{:with-latex} -@tab @code{org-export-with-latex} -@item @code{:with-planning} -@tab @code{org-export-with-planning} -@item @code{:with-priority} -@tab @code{org-export-with-priority} -@item @code{:with-properties} -@tab @code{org-export-with-properties} -@item @code{:with-special-strings} -@tab @code{org-export-with-special-strings} -@item @code{:with-sub-superscript} -@tab @code{org-export-with-sub-superscripts} -@item @code{:with-tables} -@tab @code{org-export-with-tables} -@item @code{:with-tags} -@tab @code{org-export-with-tags} -@item @code{:with-tasks} -@tab @code{org-export-with-tasks} -@item @code{:with-timestamps} -@tab @code{org-export-with-timestamps} -@item @code{:with-title} -@tab @code{org-export-with-title} -@item @code{:with-toc} -@tab @code{org-export-with-toc} -@item @code{:with-todo-keywords} -@tab @code{org-export-with-todo-keywords} -@end multitable - -@anchor{ASCII specific properties} -@subsubheading ASCII specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:ascii-bullets} -@tab @code{org-ascii-bullets} -@item @code{:ascii-caption-above} -@tab @code{org-ascii-caption-above} -@item @code{:ascii-charset} -@tab @code{org-ascii-charset} -@item @code{:ascii-global-margin} -@tab @code{org-ascii-global-margin} -@item @code{:ascii-format-drawer-function} -@tab @code{org-ascii-format-drawer-function} -@item @code{:ascii-format-inlinetask-function} -@tab @code{org-ascii-format-inlinetask-function} -@item @code{:ascii-headline-spacing} -@tab @code{org-ascii-headline-spacing} -@item @code{:ascii-indented-line-width} -@tab @code{org-ascii-indented-line-width} -@item @code{:ascii-inlinetask-width} -@tab @code{org-ascii-inlinetask-width} -@item @code{:ascii-inner-margin} -@tab @code{org-ascii-inner-margin} -@item @code{:ascii-links-to-notes} -@tab @code{org-ascii-links-to-notes} -@item @code{:ascii-list-margin} -@tab @code{org-ascii-list-margin} -@item @code{:ascii-paragraph-spacing} -@tab @code{org-ascii-paragraph-spacing} -@item @code{:ascii-quote-margin} -@tab @code{org-ascii-quote-margin} -@item @code{:ascii-table-keep-all-vertical-lines} -@tab @code{org-ascii-table-keep-all-vertical-lines} -@item @code{:ascii-table-use-ascii-art} -@tab @code{org-ascii-table-use-ascii-art} -@item @code{:ascii-table-widen-columns} -@tab @code{org-ascii-table-widen-columns} -@item @code{:ascii-text-width} -@tab @code{org-ascii-text-width} -@item @code{:ascii-underline} -@tab @code{org-ascii-underline} -@item @code{:ascii-verbatim-format} -@tab @code{org-ascii-verbatim-format} -@end multitable - -@anchor{Beamer specific properties} -@subsubheading Beamer specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:beamer-theme} -@tab @code{org-beamer-theme} -@item @code{:beamer-column-view-format} -@tab @code{org-beamer-column-view-format} -@item @code{:beamer-environments-extra} -@tab @code{org-beamer-environments-extra} -@item @code{:beamer-frame-default-options} -@tab @code{org-beamer-frame-default-options} -@item @code{:beamer-outline-frame-options} -@tab @code{org-beamer-outline-frame-options} -@item @code{:beamer-outline-frame-title} -@tab @code{org-beamer-outline-frame-title} -@item @code{:beamer-subtitle-format} -@tab @code{org-beamer-subtitle-format} -@end multitable - -@anchor{HTML specific properties} -@subsubheading HTML specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:html-allow-name-attribute-in-anchors} -@tab @code{org-html-allow-name-attribute-in-anchors} -@item @code{:html-checkbox-type} -@tab @code{org-html-checkbox-type} -@item @code{:html-container} -@tab @code{org-html-container-element} -@item @code{:html-divs} -@tab @code{org-html-divs} -@item @code{:html-doctype} -@tab @code{org-html-doctype} -@item @code{:html-extension} -@tab @code{org-html-extension} -@item @code{:html-footnote-format} -@tab @code{org-html-footnote-format} -@item @code{:html-footnote-separator} -@tab @code{org-html-footnote-separator} -@item @code{:html-footnotes-section} -@tab @code{org-html-footnotes-section} -@item @code{:html-format-drawer-function} -@tab @code{org-html-format-drawer-function} -@item @code{:html-format-headline-function} -@tab @code{org-html-format-headline-function} -@item @code{:html-format-inlinetask-function} -@tab @code{org-html-format-inlinetask-function} -@item @code{:html-head-extra} -@tab @code{org-html-head-extra} -@item @code{:html-head-include-default-style} -@tab @code{org-html-head-include-default-style} -@item @code{:html-head-include-scripts} -@tab @code{org-html-head-include-scripts} -@item @code{:html-head} -@tab @code{org-html-head} -@item @code{:html-home/up-format} -@tab @code{org-html-home/up-format} -@item @code{:html-html5-fancy} -@tab @code{org-html-html5-fancy} -@item @code{:html-indent} -@tab @code{org-html-indent} -@item @code{:html-infojs-options} -@tab @code{org-html-infojs-options} -@item @code{:html-infojs-template} -@tab @code{org-html-infojs-template} -@item @code{:html-inline-image-rules} -@tab @code{org-html-inline-image-rules} -@item @code{:html-inline-images} -@tab @code{org-html-inline-images} -@item @code{:html-link-home} -@tab @code{org-html-link-home} -@item @code{:html-link-org-files-as-html} -@tab @code{org-html-link-org-files-as-html} -@item @code{:html-link-up} -@tab @code{org-html-link-up} -@item @code{:html-link-use-abs-url} -@tab @code{org-html-link-use-abs-url} -@item @code{:html-mathjax-options} -@tab @code{org-html-mathjax-options} -@item @code{:html-mathjax-template} -@tab @code{org-html-mathjax-template} -@item @code{:html-equation-reference-format} -@tab @code{org-html-equation-reference-format} -@item @code{:html-metadata-timestamp-format} -@tab @code{org-html-metadata-timestamp-format} -@item @code{:html-postamble-format} -@tab @code{org-html-postamble-format} -@item @code{:html-postamble} -@tab @code{org-html-postamble} -@item @code{:html-preamble-format} -@tab @code{org-html-preamble-format} -@item @code{:html-preamble} -@tab @code{org-html-preamble} -@item @code{:html-self-link-headlines} -@tab @code{org-html-self-link-headlines} -@item @code{:html-table-align-individual-field} -@tab @code{de@{org-html-table-align-individual-fields} -@item @code{:html-table-attributes} -@tab @code{org-html-table-default-attributes} -@item @code{:html-table-caption-above} -@tab @code{org-html-table-caption-above} -@item @code{:html-table-data-tags} -@tab @code{org-html-table-data-tags} -@item @code{:html-table-header-tags} -@tab @code{org-html-table-header-tags} -@item @code{:html-table-row-tags} -@tab @code{org-html-table-row-tags} -@item @code{:html-table-use-header-tags-for-first-column} -@tab @code{org-html-table-use-header-tags-for-first-column} -@item @code{:html-tag-class-prefix} -@tab @code{org-html-tag-class-prefix} -@item @code{:html-text-markup-alist} -@tab @code{org-html-text-markup-alist} -@item @code{:html-todo-kwd-class-prefix} -@tab @code{org-html-todo-kwd-class-prefix} -@item @code{:html-toplevel-hlevel} -@tab @code{org-html-toplevel-hlevel} -@item @code{:html-use-infojs} -@tab @code{org-html-use-infojs} -@item @code{:html-validation-link} -@tab @code{org-html-validation-link} -@item @code{:html-viewport} -@tab @code{org-html-viewport} -@item @code{:html-wrap-src-lines} -@tab @code{org-html-wrap-src-lines} -@item @code{:html-xml-declaration} -@tab @code{org-html-xml-declaration} -@end multitable - -@anchor{@LaTeX{} specific properties} -@subsubheading @LaTeX{} specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:latex-active-timestamp-format} -@tab @code{org-latex-active-timestamp-format} -@item @code{:latex-caption-above} -@tab @code{org-latex-caption-above} -@item @code{:latex-classes} -@tab @code{org-latex-classes} -@item @code{:latex-class} -@tab @code{org-latex-default-class} -@item @code{:latex-compiler} -@tab @code{org-latex-compiler} -@item @code{:latex-default-figure-position} -@tab @code{org-latex-default-figure-position} -@item @code{:latex-default-table-environment} -@tab @code{org-latex-default-table-environment} -@item @code{:latex-default-table-mode} -@tab @code{org-latex-default-table-mode} -@item @code{:latex-diary-timestamp-format} -@tab @code{org-latex-diary-timestamp-format} -@item @code{:latex-footnote-defined-format} -@tab @code{org-latex-footnote-defined-format} -@item @code{:latex-footnote-separator} -@tab @code{org-latex-footnote-separator} -@item @code{:latex-format-drawer-function} -@tab @code{org-latex-format-drawer-function} -@item @code{:latex-format-headline-function} -@tab @code{org-latex-format-headline-function} -@item @code{:latex-format-inlinetask-function} -@tab @code{org-latex-format-inlinetask-function} -@item @code{:latex-hyperref-template} -@tab @code{org-latex-hyperref-template} -@item @code{:latex-image-default-height} -@tab @code{org-latex-image-default-height} -@item @code{:latex-image-default-option} -@tab @code{org-latex-image-default-option} -@item @code{:latex-image-default-width} -@tab @code{org-latex-image-default-width} -@item @code{:latex-images-centered} -@tab @code{org-latex-images-centered} -@item @code{:latex-inactive-timestamp-format} -@tab @code{org-latex-inactive-timestamp-format} -@item @code{:latex-inline-image-rules} -@tab @code{org-latex-inline-image-rules} -@item @code{:latex-link-with-unknown-path-format} -@tab @code{org-latex-link-with-unknown-path-format} -@item @code{:latex-listings-langs} -@tab @code{org-latex-listings-langs} -@item @code{:latex-listings-options} -@tab @code{org-latex-listings-options} -@item @code{:latex-listings} -@tab @code{org-latex-listings} -@item @code{:latex-minted-langs} -@tab @code{org-latex-minted-langs} -@item @code{:latex-minted-options} -@tab @code{org-latex-minted-options} -@item @code{:latex-prefer-user-labels} -@tab @code{org-latex-prefer-user-labels} -@item @code{:latex-subtitle-format} -@tab @code{org-latex-subtitle-format} -@item @code{:latex-subtitle-separate} -@tab @code{org-latex-subtitle-separate} -@item @code{:latex-table-scientific-notation} -@tab @code{org-latex-table-scientific-notation} -@item @code{:latex-tables-booktabs} -@tab @code{org-latex-tables-booktabs} -@item @code{:latex-tables-centered} -@tab @code{org-latex-tables-centered} -@item @code{:latex-text-markup-alist} -@tab @code{org-latex-text-markup-alist} -@item @code{:latex-title-command} -@tab @code{org-latex-title-command} -@item @code{:latex-toc-command} -@tab @code{org-latex-toc-command} -@end multitable - -@anchor{Markdown specific properties} -@subsubheading Markdown specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:md-footnote-format} -@tab @code{org-md-footnote-format} -@item @code{:md-footnotes-section} -@tab @code{org-md-footnotes-section} -@item @code{:md-headline-style} -@tab @code{org-md-headline-style} -@end multitable - -@anchor{ODT specific properties} -@subsubheading ODT specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:odt-content-template-file} -@tab @code{org-odt-content-template-file} -@item @code{:odt-display-outline-level} -@tab @code{org-odt-display-outline-level} -@item @code{:odt-fontify-srcblocks} -@tab @code{org-odt-fontify-srcblocks} -@item @code{:odt-format-drawer-function} -@tab @code{org-odt-format-drawer-function} -@item @code{:odt-format-headline-function} -@tab @code{org-odt-format-headline-function} -@item @code{:odt-format-inlinetask-function} -@tab @code{org-odt-format-inlinetask-function} -@item @code{:odt-inline-formula-rules} -@tab @code{org-odt-inline-formula-rules} -@item @code{:odt-inline-image-rules} -@tab @code{org-odt-inline-image-rules} -@item @code{:odt-pixels-per-inch} -@tab @code{org-odt-pixels-per-inch} -@item @code{:odt-styles-file} -@tab @code{org-odt-styles-file} -@item @code{:odt-table-styles} -@tab @code{org-odt-table-styles} -@item @code{:odt-use-date-fields} -@tab @code{org-odt-use-date-fields} -@end multitable - -@anchor{Texinfo specific properties} -@subsubheading Texinfo specific properties - -@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{:texinfo-active-timestamp-format} -@tab @code{org-texinfo-active-timestamp-format} -@item @code{:texinfo-classes} -@tab @code{org-texinfo-classes} -@item @code{:texinfo-class} -@tab @code{org-texinfo-default-class} -@item @code{:texinfo-table-default-markup} -@tab @code{org-texinfo-table-default-markup} -@item @code{:texinfo-diary-timestamp-format} -@tab @code{org-texinfo-diary-timestamp-format} -@item @code{:texinfo-filename} -@tab @code{org-texinfo-filename} -@item @code{:texinfo-format-drawer-function} -@tab @code{org-texinfo-format-drawer-function} -@item @code{:texinfo-format-headline-function} -@tab @code{org-texinfo-format-headline-function} -@item @code{:texinfo-format-inlinetask-function} -@tab @code{org-texinfo-format-inlinetask-function} -@item @code{:texinfo-inactive-timestamp-format} -@tab @code{org-texinfo-inactive-timestamp-format} -@item @code{:texinfo-link-with-unknown-path-format} -@tab @code{org-texinfo-link-with-unknown-path-format} -@item @code{:texinfo-node-description-column} -@tab @code{org-texinfo-node-description-column} -@item @code{:texinfo-table-scientific-notation} -@tab @code{org-texinfo-table-scientific-notation} -@item @code{:texinfo-tables-verbatim} -@tab @code{org-texinfo-tables-verbatim} -@item @code{:texinfo-text-markup-alist} -@tab @code{org-texinfo-text-markup-alist} -@end multitable - -@node Publishing links -@subsection Publishing links - -@cindex links, publishing - -To create a link from one Org file to another, you would use something -like @samp{[[file:foo.org][The foo]]} or simply @samp{[[file:foo.org]]} (see @ref{External Links}). When -published, this link becomes a link to @samp{foo.html}. You can thus -interlink the pages of your ``Org web'' project and the links will work -as expected when you publish them to HTML@. If you also publish the -Org source file and want to link to it, use an @samp{http} link instead of -a @samp{file:} link, because @samp{file} links are converted to link to the -corresponding @samp{.html} file. - -You may also link to related files, such as images. Provided you are -careful with relative file names, and provided you have also -configured Org to upload the related files, these links will work too. -See @ref{Complex example}, for an example of this -usage. - -Eventually, links between published documents can contain some search -options (see @ref{Search Options}), which will be resolved to -the appropriate location in the linked file. For example, once -published to HTML, the following links all point to a dedicated anchor -in @samp{foo.html}. - -@example -[[file:foo.org::*heading]] -[[file:foo.org::#custom-id]] -[[file:foo.org::target]] -@end example - -@node Site map -@subsection Generating a sitemap - -@cindex sitemap, of published pages - -The following properties may be used to control publishing of -a map of files for a given project. - -@table @asis -@item @code{:auto-sitemap} -When non-@code{nil}, publish a sitemap during -@code{org-publish-current-project} or @code{org-publish-all}. - -@item @code{:sitemap-filename} -Filename for output of sitemap. Defaults to @samp{sitemap.org}, which -becomes @samp{sitemap.html}. - -@item @code{:sitemap-title} -Title of sitemap page. Defaults to name of file. - -@item @code{:sitemap-format-entry} -@findex org-publish-find-date -@findex org-publish-find-property -@findex org-publish-find-title -With this option one can tell how a site-map entry is formatted in -the site-map. It is a function called with three arguments: the -file or directory name relative to base directory of the project, -the site-map style and the current project. It is expected to -return a string. Default value turns file names into links and use -document titles as descriptions. For specific formatting needs, one -can use @code{org-publish-find-date}, @code{org-publish-find-title} and -@code{org-publish-find-property}, to retrieve additional information -about published documents. - -@item @code{:sitemap-function} -Plug-in function to use for generation of the sitemap. It is called -with two arguments: the title of the site-map and a representation -of the files and directories involved in the project as a nested -list, which can further be transformed using @code{org-list-to-generic}, -@code{org-list-to-subtree} and alike. Default value generates a plain -list of links to all files in the project. - -@item @code{:sitemap-sort-folders} -Where folders should appear in the sitemap. Set this to @code{first} -(default) or @code{last} to display folders first or last, respectively. -When set to @code{ignore}, folders are ignored altogether. Any other -value mixes files and folders. This variable has no effect when -site-map style is @code{tree}. - -@item @code{:sitemap-sort-files} -How the files are sorted in the site map. Set this to -@code{alphabetically} (default), @code{chronologically} or -@code{anti-chronologically}. @code{chronologically} sorts the files with -older date first while @code{anti-chronologically} sorts the files with -newer date first. @code{alphabetically} sorts the files alphabetically. -The date of a file is retrieved with @code{org-publish-find-date}. - -@item @code{:sitemap-ignore-case} -Should sorting be case-sensitive? Default @code{nil}. - -@item @code{:sitemap-file-entry-format} -With this option one can tell how a sitemap's entry is formatted in -the sitemap. This is a format string with some escape sequences: -@code{%t} stands for the title of the file, @code{%a} stands for the author of -the file and @code{%d} stands for the date of the file. The date is -retrieved with the @code{org-publish-find-date} function and formatted -with @code{org-publish-sitemap-date-format}. Default @code{%t}. - -@item @code{:sitemap-date-format} -Format string for the @code{format-time-string} function that tells how -a sitemap entry's date is to be formatted. This property bypasses -@code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}. -@end table - -@node Generating an index -@subsection Generating an index - -@cindex index, in a publishing project - -Org mode can generate an index across the files of a publishing project. - -@table @asis -@item @code{:makeindex} -When non-@code{nil}, generate in index in the file @samp{theindex.org} and -publish it as @samp{theindex.html}. -@end table - -The file is created when first publishing a project with the -@code{:makeindex} set. The file only contains a statement @samp{#+INCLUDE: -"theindex.inc"}. You can then build around this include statement by -adding a title, style information, etc. - -@cindex @samp{INDEX}, keyword -Index entries are specified with @samp{INDEX} keyword. An entry that -contains an exclamation mark creates a sub item. - -@example -*** Curriculum Vitae -#+INDEX: CV -#+INDEX: Application!CV -@end example - -@node Uploading Files -@section Uploading Files - -@cindex rsync -@cindex unison - -For those people already utilizing third party sync tools such as -Rsync or Unison, it might be preferable not to use the built-in remote -publishing facilities of Org mode which rely heavily on Tramp. Tramp, -while very useful and powerful, tends not to be so efficient for -multiple file transfer and has been known to cause problems under -heavy usage. - -Specialized synchronization utilities offer several advantages. In -addition to timestamp comparison, they also do content and -permissions/attribute checks. For this reason you might prefer to -publish your web to a local directory---possibly even @emph{in place} with -your Org files---and then use Unison or Rsync to do the -synchronization with the remote host. - -Since Unison, for example, can be configured as to which files to -transfer to a certain remote destination, it can greatly simplify the -project publishing definition. Simply keep all files in the correct -location, process your Org files with @code{org-publish} and let the -synchronization tool do the rest. You do not need, in this scenario, -to include attachments such as JPG, CSS or PNG files in the project -definition since the third-party tool syncs them. - -Publishing to a local directory is also much faster than to a remote -one, so that you can afford more easily to republish entire projects. -If you set @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the -main benefit of re-including any changed external files such as source -example files you might include with @samp{INCLUDE} keyword. The timestamp -mechanism in Org is not smart enough to detect if included files have -been modified. - -@node Sample Configuration -@section Sample Configuration - -Below we provide two example configurations. The first one is -a simple project publishing only a set of Org files. The second -example is more complex, with a multi-component project. - -@menu -* Simple example:: One-component publishing. -* Complex example:: A multi-component publishing example. -@end menu - -@node Simple example -@subsection Example: simple publishing configuration - -This example publishes a set of Org files to the @samp{public_html} -directory on the local machine. - -@lisp -(setq org-publish-project-alist - '(("org" - :base-directory "~/org/" - :publishing-directory "~/public_html" - :section-numbers nil - :table-of-contents nil - :style "<link rel=\"stylesheet\" - href=\"../other/mystyle.css\" - type=\"text/css\"/>"))) -@end lisp - -@node Complex example -@subsection Example: complex publishing configuration - -This more complicated example publishes an entire website, including -Org files converted to HTML, image files, Emacs Lisp source code, and -style sheets. The publishing directory is remote and private files -are excluded. - -To ensure that links are preserved, care should be taken to replicate -your directory structure on the web server, and to use relative file -paths. For example, if your Org files are kept in @samp{~/org/} and your -publishable images in @samp{~/images/}, you would link to an image with - -@example -file:../images/myimage.png -@end example - - -On the web server, the relative path to the image should be the same. -You can accomplish this by setting up an @samp{images/} folder in the right -place on the web server, and publishing images to it. - -@lisp -(setq org-publish-project-alist - '(("orgfiles" - :base-directory "~/org/" - :base-extension "org" - :publishing-directory "/ssh:user@@host:~/html/notebook/" - :publishing-function org-html-publish-to-html - :exclude "PrivatePage.org" ;; regexp - :headline-levels 3 - :section-numbers nil - :with-toc nil - :html-head "<link rel=\"stylesheet\" - href=\"../other/mystyle.css\" type=\"text/css\"/>" - :html-preamble t) - - ("images" - :base-directory "~/images/" - :base-extension "jpg\\|gif\\|png" - :publishing-directory "/ssh:user@@host:~/html/images/" - :publishing-function org-publish-attachment) - - ("other" - :base-directory "~/other/" - :base-extension "css\\|el" - :publishing-directory "/ssh:user@@host:~/html/other/" - :publishing-function org-publish-attachment) - ("website" :components ("orgfiles" "images" "other")))) -@end lisp - -@node Triggering Publication -@section Triggering Publication - -Once properly configured, Org can publish with the following commands: - -@table @asis -@item @kbd{C-c C-e P x} (@code{org-publish}) -@kindex C-c C-e P x -@findex org-publish -Prompt for a specific project and publish all files that belong to -it. - -@item @kbd{C-c C-e P p} (@code{org-publish-current-project}) -@kindex C-c C-e P p -@findex org-publish-current-project -Publish the project containing the current file. - -@item @kbd{C-c C-e P f} (@code{org-publish-current-file}) -@kindex C-c C-e P f -@findex org-publish-current-file -Publish only the current file. - -@item @kbd{C-c C-e P a} (@code{org-publish-all}) -@kindex C-c C-e P a -@findex org-publish-all -Publish every project. -@end table - -@vindex org-publish-use-timestamps-flag -Org uses timestamps to track when a file has changed. The above -functions normally only publish changed files. You can override this -and force publishing of all files by giving a prefix argument to any -of the commands above, or by customizing the variable -@code{org-publish-use-timestamps-flag}. This may be necessary in -particular if files include other files via @samp{SETUPFILE} or @samp{INCLUDE} -keywords. - -@node Working with Source Code -@chapter Working with Source Code - -@cindex source code, working with - -Source code here refers to any plain text collection of computer -instructions, possibly with comments, written using a human-readable -programming language. Org can manage source code in an Org document -when the source code is identified with begin and end markers. -Working with source code begins with identifying source code blocks. -A source code block can be placed almost anywhere in an Org document; -it is not restricted to the preamble or the end of the document. -However, Org cannot manage a source code block if it is placed inside -an Org comment or within a fixed width section. - -Here is an example source code block in the Emacs Lisp language: - -@example -#+BEGIN_SRC emacs-lisp - (defun org-xor (a b) - "Exclusive or." - (if a (not b) b)) -#+END_SRC -@end example - -Source code blocks are one of many Org block types, which also include -``center'', ``comment'', ``dynamic'', ``example'', ``export'', ``quote'', -``special'', and ``verse''. This section pertains to blocks between -@samp{#+BEGIN_SRC} and @samp{#+END_SRC}. - -Details of Org's facilities for working with source code are described -in the following sections. - -@menu -* Features Overview:: Enjoy the versatility of source blocks. -* Structure of Code Blocks:: Code block syntax described. -* Using Header Arguments:: Different ways to set header arguments. -* Environment of a Code Block:: Arguments, sessions, working directory... -* Evaluating Code Blocks:: Place results of evaluation in the Org buffer. -* Results of Evaluation:: Choosing a results type, post-processing... -* Exporting Code Blocks:: Export contents and/or results. -* Extracting Source Code:: Create pure source code files. -* Languages:: List of supported code block languages. -* Editing Source Code:: Language major-mode editing. -* Noweb Reference Syntax:: Literate programming in Org mode. -* Library of Babel:: Use and contribute to a library of useful code blocks. -* Key bindings and Useful Functions:: Work quickly with code blocks. -* Batch Execution:: Call functions from the command line. -@end menu - -@node Features Overview -@section Features Overview - -Org can manage the source code in the block delimited by @samp{#+BEGIN_SRC} -@dots{} @samp{#+END_SRC} in several ways that can simplify housekeeping tasks -essential to modern source code maintenance. Org can edit, format, -extract, export, and publish source code blocks. Org can also compile -and execute a source code block, then capture the results. The Org -mode literature sometimes refers to source code blocks as @emph{live code} -blocks because they can alter the content of the Org document or the -material that it exports. Users can control how live they want each -source code block by tweaking the header arguments (see @ref{Using Header Arguments}) for compiling, execution, extraction, and exporting. - -For editing and formatting a source code block, Org uses an -appropriate Emacs major mode that includes features specifically -designed for source code in that language. - -Org can extract one or more source code blocks and write them to one -or more source files---a process known as @emph{tangling} in literate -programming terminology. - -For exporting and publishing, Org's back-ends can format a source code -block appropriately, often with native syntax highlighting. - -For executing and compiling a source code block, the user can -configure Org to select the appropriate compiler. Org provides -facilities to collect the result of the execution or compiler output, -insert it into the Org document, and/or export it. In addition to -text results, Org can insert links to other data types, including -audio, video, and graphics. Org can also link a compiler error -message to the appropriate line in the source code block. - -An important feature of Org's management of source code blocks is the -ability to pass variables, functions, and results to one another using -a common syntax for source code blocks in any language. Although most -literate programming facilities are restricted to one language or -another, Org's language-agnostic approach lets the literate programmer -match each programming task with the appropriate computer language and -to mix them all together in a single Org document. This -interoperability among languages explains why Org's source code -management facility was named @emph{Org Babel} by its originators, Eric -Schulte and Dan Davison. - -Org mode fulfills the promise of easy verification and maintenance of -publishing reproducible research by keeping text, data, code, -configuration settings of the execution environment, the results of -the execution, and associated narratives, claims, references, and -internal and external links in a single Org document. - -@node Structure of Code Blocks -@section Structure of Code Blocks - -@cindex code block, structure -@cindex source code, block structure -@cindex @samp{NAME} keyword, in source blocks -@cindex @samp{BEGIN_SRC} - -Org offers two ways to structure source code in Org documents: in -a source code block, and directly inline. Both specifications are -shown below. - -A source code block conforms to this structure: - -@example -#+NAME: <name> -#+BEGIN_SRC <language> <switches> <header arguments> - <body> -#+END_SRC -@end example - -Do not be put-off by having to remember the source block syntax. Org -mode offers a command for wrapping existing text in a block (see -@ref{Structure Templates}). Org also works with other completion systems -in Emacs, some of which predate Org and have custom domain-specific -languages for defining templates. Regular use of templates reduces -errors, increases accuracy, and maintains consistency. - -@cindex source code, inline -An inline code block conforms to this structure: - -@example -src_<language>@{<body>@} -@end example - - -@noindent -or - -@example -src_<language>[<header arguments>]@{<body>@} -@end example - - -@table @asis -@item @samp{#+NAME: <name>} -Optional. Names the source block so it can be called, like -a function, from other source blocks or inline code to evaluate or -to capture the results. Code from other blocks, other files, and -from table formulas (see @ref{The Spreadsheet}) can use the name to -reference a source block. This naming serves the same purpose as -naming Org tables. Org mode requires unique names. For duplicate -names, Org mode's behavior is undefined. - -@item @samp{#+BEGIN_SRC} @dots{} @samp{#+END_SRC} -Mandatory. They mark the start and end of a block that Org -requires. The @samp{#+BEGIN_SRC} line takes additional arguments, as -described next. - -@item @samp{<language>} -@cindex language, in code blocks -Mandatory. It is the identifier of the source code language in the -block. See @ref{Languages}, for identifiers of supported languages. - -@item @samp{<switches>} -@cindex switches, in code blocks -Optional. Switches provide finer control of the code execution, -export, and format (see the discussion of switches in @ref{Literal Examples}). - -@item @samp{<header arguments>} -@cindex header arguments, in code blocks -Optional. Heading arguments control many aspects of evaluation, -export and tangling of code blocks (see @ref{Using Header Arguments}). -Using Org's properties feature, header arguments can be selectively -applied to the entire buffer or specific sub-trees of the Org -document. - -@item @samp{<body>} -Source code in the dialect of the specified language identifier. -@end table - -@node Using Header Arguments -@section Using Header Arguments - -Org comes with many header arguments common to all languages. New -header arguments are added for specific languages as they become -available for use in source code blocks. A header argument is -specified with an initial colon followed by the argument's name in -lowercase. - -Since header arguments can be set in several ways, Org prioritizes -them in case of overlaps or conflicts by giving local settings -a higher priority. Header values in function calls, for example, -override header values from global defaults. - -@anchor{System-wide header arguments} -@subheading System-wide header arguments - -@vindex org-babel-default-header-args - -@vindex org-babel-default-header-args -System-wide values of header arguments can be specified by customizing -the @code{org-babel-default-header-args} variable, which defaults to the -following values: - -@example -:session => "none" -:results => "replace" -:exports => "code" -:cache => "no" -:noweb => "no" -@end example - -The example below sets @samp{:noweb} header arguments to @samp{yes}, which makes -Org expand @samp{:noweb} references by default. - -@lisp -(setq org-babel-default-header-args - (cons '(:noweb . "yes") - (assq-delete-all :noweb org-babel-default-header-args))) -@end lisp - -@cindex language specific default header arguments -@cindex default header arguments per language -Each language can have separate default header arguments by -customizing the variable @code{org-babel-default-header-args:<LANG>}, where -@var{<LANG>} is the name of the language. For details, see the -language-specific online documentation at -@uref{https://orgmode.org/worg/org-contrib/babel/}. - -@anchor{Header arguments in Org mode properties} -@subheading Header arguments in Org mode properties - -For header arguments applicable to the buffer, use @samp{PROPERTY} keyword -anywhere in the Org file (see @ref{Property Syntax}). - -The following example makes all the R code blocks execute in the same -session. Setting @samp{:results} to @samp{silent} ignores the results of -executions for all blocks, not just R code blocks; no results inserted -for any block. - -@example -#+PROPERTY: header-args:R :session *R* -#+PROPERTY: header-args :results silent -@end example - -@vindex org-use-property-inheritance -Header arguments set through Org's property drawers (see @ref{Property Syntax}) apply at the sub-tree level on down. Since these property -drawers can appear anywhere in the file hierarchy, Org uses outermost -call or source block to resolve the values. Org ignores -@code{org-use-property-inheritance} setting. - -In this example, @samp{:cache} defaults to @samp{yes} for all code blocks in the -sub-tree. - -@example -* sample header - :PROPERTIES: - :header-args: :cache yes - :END: -@end example - -@kindex C-c C-x p -@findex org-set-property -Properties defined through @code{org-set-property} function, bound to -@kbd{C-c C-x p}, apply to all active languages. They override -properties set in @code{org-babel-default-header-args}. - -@cindex language specific header arguments properties -@cindex header arguments per language -Language-specific header arguments are also read from properties -@samp{header-args:<LANG>} where @var{<LANG>} is the language -identifier. For example, - -@example -* Heading - :PROPERTIES: - :header-args:clojure: :session *clojure-1* - :header-args:R: :session *R* - :END: -** Subheading - :PROPERTIES: - :header-args:clojure: :session *clojure-2* - :END: -@end example - -@noindent -would force separate sessions for Clojure blocks in @samp{Heading} and -@samp{Subheading}, but use the same session for all R blocks. Blocks in -@samp{Subheading} inherit settings from @samp{Heading}. - -@anchor{Code block specific header arguments} -@subheading Code block specific header arguments - -Header arguments are most commonly set at the source code block level, -on the @samp{#+BEGIN_SRC} line. Arguments set at this level take -precedence over those set in the @code{org-babel-default-header-args} -variable, and also those set as header properties. - -In the following example, setting @samp{:results} to @samp{silent} makes it -ignore results of the code execution. Setting @samp{:exports} to @samp{code} -exports only the body of the code block to HTML or @LaTeX{}. - -@example -#+NAME: factorial -#+BEGIN_SRC haskell :results silent :exports code :var n=0 - fac 0 = 1 - fac n = n * fac (n-1) -#+END_SRC -@end example - -The same header arguments in an inline code block: - -@example -src_haskell[:exports both]@{fac 5@} -@end example - - -@cindex @samp{HEADER}, keyword -Code block header arguments can span multiple lines using @samp{#+HEADER:} -on each line. Note that Org currently accepts the plural spelling of -@samp{#+HEADER:} only as a convenience for backward-compatibility. It may -be removed at some point. - -Multi-line header arguments on an unnamed code block: - -@example -#+HEADER: :var data1=1 -#+BEGIN_SRC emacs-lisp :var data2=2 - (message "data1:%S, data2:%S" data1 data2) -#+END_SRC - -#+RESULTS: -: data1:1, data2:2 -@end example - -Multi-line header arguments on a named code block: - -@example -#+NAME: named-block -#+HEADER: :var data=2 -#+BEGIN_SRC emacs-lisp - (message "data:%S" data) -#+END_SRC - -#+RESULTS: named-block - : data:2 -@end example - -@anchor{Header arguments in function calls} -@subheading Header arguments in function calls - -Header arguments in function calls are the most specific and override -all other settings in case of an overlap. They get the highest -priority. Two @samp{#+CALL:} examples are shown below. For the complete -syntax of @samp{CALL} keyword, see @ref{Evaluating Code Blocks}. - -In this example, @samp{:exports results} header argument is applied to the -evaluation of the @samp{#+CALL:} line. - -@example -#+CALL: factorial(n=5) :exports results -@end example - - -In this example, @samp{:session special} header argument is applied to the -evaluation of @samp{factorial} code block. - -@example -#+CALL: factorial[:session special](n=5) -@end example - -@node Environment of a Code Block -@section Environment of a Code Block - - - -@anchor{Passing arguments} -@subheading Passing arguments - -@cindex passing arguments to code blocks -@cindex arguments, in code blocks -@cindex @samp{var}, header argument -Use @samp{var} for passing arguments to source code blocks. The specifics -of variables in code blocks vary by the source language and are -covered in the language-specific documentation. The syntax for @samp{var}, -however, is the same for all languages. This includes declaring -a variable, and assigning a default value. - -The following syntax is used to pass arguments to code blocks using -the @samp{var} header argument. - -@example -:var NAME=ASSIGN -@end example - - -@noindent -@var{NAME} is the name of the variable bound in the code block -body. @var{ASSIGN} is a literal value, such as a string, -a number, a reference to a table, a list, a literal example, another -code block---with or without arguments---or the results of evaluating -a code block. - -Here are examples of passing values by reference: - -@table @asis -@item table -A table named with a @samp{NAME} keyword. - -@example -#+NAME: example-table -| 1 | -| 2 | -| 3 | -| 4 | - -#+NAME: table-length -#+BEGIN_SRC emacs-lisp :var table=example-table - (length table) -#+END_SRC - -#+RESULTS: table-length -: 4 -@end example - -When passing a table, you can treat specially the row, or the -column, containing labels for the columns, or the rows, in the -table. - -@cindex @samp{colnames}, header argument -The @samp{colnames} header argument accepts @samp{yes}, @samp{no}, or @samp{nil} values. -The default value is @samp{nil}: if an input table has column -names---because the second row is a horizontal rule---then Org -removes the column names, processes the table, puts back the column -names, and then writes the table to the results block. Using @samp{yes}, -Org does the same to the first row, even if the initial table does -not contain any horizontal rule. When set to @samp{no}, Org does not -pre-process column names at all. - -@example -#+NAME: less-cols -| a | -|---| -| b | -| c | - -#+BEGIN_SRC python :var tab=less-cols :colnames nil - return [[val + '*' for val in row] for row in tab] -#+END_SRC - -#+RESULTS: -| a | -|----| -| b* | -| c* | -@end example - -@cindex @samp{rownames}, header argument -Similarly, the @samp{rownames} header argument can take two values: @samp{yes} -or @samp{no}. When set to @samp{yes}, Org removes the first column, processes -the table, puts back the first column, and then writes the table to -the results block. The default is @samp{no}, which means Org does not -pre-process the first column. Note that Emacs Lisp code blocks -ignore @samp{rownames} header argument because of the ease of -table-handling in Emacs. - -@example -#+NAME: with-rownames -| one | 1 | 2 | 3 | 4 | 5 | -| two | 6 | 7 | 8 | 9 | 10 | - -#+BEGIN_SRC python :var tab=with-rownames :rownames yes - return [[val + 10 for val in row] for row in tab] -#+END_SRC - -#+RESULTS: -| one | 11 | 12 | 13 | 14 | 15 | -| two | 16 | 17 | 18 | 19 | 20 | -@end example - -@item list -A simple named list. - -@example -#+NAME: example-list -- simple - - not - - nested -- list - -#+BEGIN_SRC emacs-lisp :var x=example-list - (print x) -#+END_SRC - -#+RESULTS: -| simple | list | -@end example - -Note that only the top level list items are passed along. Nested -list items are ignored. - -@item code block without arguments -A code block name, as assigned by @samp{NAME} keyword from the example -above, optionally followed by parentheses. - -@example -#+BEGIN_SRC emacs-lisp :var length=table-length() - (* 2 length) -#+END_SRC - -#+RESULTS: -: 8 -@end example - -@item code block with arguments -A code block name, as assigned by @samp{NAME} keyword, followed by -parentheses and optional arguments passed within the parentheses. - -@example -#+NAME: double -#+BEGIN_SRC emacs-lisp :var input=8 - (* 2 input) -#+END_SRC - -#+RESULTS: double -: 16 - -#+NAME: squared -#+BEGIN_SRC emacs-lisp :var input=double(input=1) - (* input input) -#+END_SRC - -#+RESULTS: squared -: 4 -@end example - -@item literal example -A literal example block named with a @samp{NAME} keyword. - -@example -#+NAME: literal-example -#+BEGIN_EXAMPLE - A literal example - on two lines -#+END_EXAMPLE - -#+NAME: read-literal-example -#+BEGIN_SRC emacs-lisp :var x=literal-example - (concatenate #'string x " for you.") -#+END_SRC - -#+RESULTS: read-literal-example -: A literal example -: on two lines for you. -@end example -@end table - -Indexing variable values enables referencing portions of a variable. -Indexes are 0 based with negative values counting backwards from the -end. If an index is separated by commas then each subsequent section -indexes as the next dimension. Note that this indexing occurs -@emph{before} other table-related header arguments are applied, such as -@samp{hlines}, @samp{colnames} and @samp{rownames}. The following example assigns -the last cell of the first row the table @samp{example-table} to the -variable @samp{data}: - -@example -#+NAME: example-table -| 1 | a | -| 2 | b | -| 3 | c | -| 4 | d | - -#+BEGIN_SRC emacs-lisp :var data=example-table[0,-1] - data -#+END_SRC - -#+RESULTS: -: a -@end example - -Two integers separated by a colon reference a range of variable -values. In that case the entire inclusive range is referenced. For -example the following assigns the middle three rows of @samp{example-table} -to @samp{data}. - -@example -#+NAME: example-table -| 1 | a | -| 2 | b | -| 3 | c | -| 4 | d | -| 5 | 3 | - -#+BEGIN_SRC emacs-lisp :var data=example-table[1:3] - data -#+END_SRC - -#+RESULTS: -| 2 | b | -| 3 | c | -| 4 | d | -@end example - -To pick the entire range, use an empty index, or the single character -@samp{*}. @samp{0:-1} does the same thing. Example below shows how to -reference the first column only. - -@example -#+NAME: example-table -| 1 | a | -| 2 | b | -| 3 | c | -| 4 | d | - -#+BEGIN_SRC emacs-lisp :var data=example-table[,0] - data -#+END_SRC - -#+RESULTS: -| 1 | 2 | 3 | 4 | -@end example - -Index referencing can be used for tables and code blocks. Index -referencing can handle any number of dimensions. Commas delimit -multiple dimensions, as shown below. - -@example -#+NAME: 3D -#+BEGIN_SRC emacs-lisp - '(((1 2 3) (4 5 6) (7 8 9)) - ((10 11 12) (13 14 15) (16 17 18)) - ((19 20 21) (22 23 24) (25 26 27))) -#+END_SRC - -#+BEGIN_SRC emacs-lisp :var data=3D[1,,1] - data -#+END_SRC - -#+RESULTS: -| 11 | 14 | 17 | -@end example - -Note that row names and column names are not removed prior to variable -indexing. You need to take them into account, even when @samp{colnames} or -@samp{rownames} header arguments remove them. - -Emacs lisp code can also set the values for variables. To -differentiate a value from Lisp code, Org interprets any value -starting with @samp{(}, @samp{[}, @samp{'} or @samp{`} as Emacs Lisp code. The result of -evaluating that code is then assigned to the value of that variable. -The following example shows how to reliably query and pass the file -name of the Org mode buffer to a code block using headers. We need -reliability here because the file's name could change once the code in -the block starts executing. - -@example -#+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both - wc -w $filename -#+END_SRC -@end example - -Note that values read from tables and lists are not mistakenly -evaluated as Emacs Lisp code, as illustrated in the following example. - -@example -#+NAME: table -| (a b c) | - -#+HEADER: :var data=table[0,0] -#+BEGIN_SRC perl - $data -#+END_SRC - -#+RESULTS: -: (a b c) -@end example - -@anchor{Using sessions} -@subheading Using sessions - -@cindex using sessions in code blocks -@cindex @samp{session}, header argument -Two code blocks can share the same environment. The @samp{session} header -argument is for running multiple source code blocks under one session. -Org runs code blocks with the same session name in the same -interpreter process. - -@table @asis -@item @samp{none} -Default. Each code block gets a new interpreter process to execute. -The process terminates once the block is evaluated. - -@item @var{STRING} -Any string besides @samp{none} turns that string into the name of that -session. For example, @samp{:session STRING} names it @samp{STRING}. If -@samp{session} has no value, then the session name is derived from the -source language identifier. Subsequent blocks with the same source -code language use the same session. Depending on the language, -state variables, code from other blocks, and the overall interpreted -environment may be shared. Some interpreted languages support -concurrent sessions when subsequent source code language blocks -change session names. -@end table - -Only languages that provide interactive evaluation can have session -support. Not all languages provide this support, such as C and ditaa. -Even languages, such as Python and Haskell, that do support -interactive evaluation impose limitations on allowable language -constructs that can run interactively. Org inherits those limitations -for those code blocks running in a session. - -@anchor{Choosing a working directory} -@subheading Choosing a working directory - -@cindex working directory, in a code block -@cindex @samp{dir}, header argument -@cindex @samp{mkdirp}, header argument -The @samp{dir} header argument specifies the default directory during code -block execution. If it is absent, then the directory associated with -the current buffer is used. In other words, supplying @samp{:dir -DIRECTORY} temporarily has the same effect as changing the current -directory with @kbd{M-x cd @key{RET} DIRECTORY}, and then not setting -@samp{dir}. Under the surface, @samp{dir} simply sets the value of the Emacs -variable @code{default-directory}. Setting @samp{mkdirp} header argument to -a non-@code{nil} value creates the directory, if necessary. - -For example, to save the plot file in the @samp{Work/} folder of the home -directory---notice tilde is expanded: - -@example -#+BEGIN_SRC R :file myplot.png :dir ~/Work - matplot(matrix(rnorm(100), 10), type="l") -#+END_SRC -@end example - -To evaluate the code block on a remote machine, supply a remote -directory name using Tramp syntax. For example: - -@example -#+BEGIN_SRC R :file plot.png :dir /scp:dand@@yakuba.princeton.edu: - plot(1:10, main=system("hostname", intern=TRUE)) -#+END_SRC -@end example - -Org first captures the text results as usual for insertion in the Org -file. Then Org also inserts a link to the remote file, thanks to -Emacs Tramp. Org constructs the remote path to the file name from -@samp{dir} and @code{default-directory}, as illustrated here: - -@example -[[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]] -@end example - - -When @samp{dir} is used with @samp{session}, Org sets the starting directory for -a new session. But Org does not alter the directory of an already -existing session. - -Do not use @samp{dir} with @samp{:exports results} or with @samp{:exports both} to -avoid Org inserting incorrect links to remote files. That is because -Org does not expand @code{default directory} to avoid some underlying -portability issues. - -@anchor{Inserting headers and footers} -@subheading Inserting headers and footers - -@cindex headers, in code blocks -@cindex footers, in code blocks -@cindex @samp{prologue}, header argument -The @samp{prologue} header argument is for appending to the top of the code -block for execution, like a reset instruction. For example, you may -use @samp{:prologue "reset"} in a Gnuplot code block or, for every such -block: - -@lisp -(add-to-list 'org-babel-default-header-args:gnuplot - '((:prologue . "reset"))) - -@end lisp - -@cindex @samp{epilogue}, header argument -Likewise, the value of the @samp{epilogue} header argument is for appending -to the end of the code block for execution. - -@node Evaluating Code Blocks -@section Evaluating Code Blocks - -@cindex code block, evaluating -@cindex source code, evaluating -@cindex @samp{RESULTS}, keyword - -A note about security: With code evaluation comes the risk of harm. -Org safeguards by prompting for user's permission before executing any -code in the source block. To customize this safeguard, or disable it, -see @ref{Code Evaluation Security}. - -@anchor{How to evaluate source code} -@subheading How to evaluate source code - -Org captures the results of the code block evaluation and inserts them -in the Org file, right after the code block. The insertion point is -after a newline and the @samp{RESULTS} keyword. Org creates the @samp{RESULTS} -keyword if one is not already there. - -By default, Org enables only Emacs Lisp code blocks for execution. -See @ref{Languages} to enable other languages. - -@kindex C-c C-c -@kindex C-c C-v e -@findex org-babel-execute-src-block -Org provides many ways to execute code blocks. @kbd{C-c C-c} or -@kbd{C-c C-v e} with the point on a code block@footnote{The option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used -to remove code evaluation from the @kbd{C-c C-c} key binding.} calls the -@code{org-babel-execute-src-block} function, which executes the code in the -block, collects the results, and inserts them in the buffer. - -@cindex @samp{CALL}, keyword -@vindex org-babel-inline-result-wrap -By calling a named code block@footnote{Actually, the constructs @samp{call_<name>()} and @samp{src_<lang>@{@}} -are not evaluated when they appear in a keyword (see @ref{In-buffer Settings}).} from an Org mode buffer or -a table. Org can call the named code blocks from the current Org mode -buffer or from the ``Library of Babel'' (see @ref{Library of Babel}). - -The syntax for @samp{CALL} keyword is: - -@example -#+CALL: <name>(<arguments>) -#+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments> -@end example - -The syntax for inline named code blocks is: - -@example -... call_<name>(<arguments>) ... -... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ... -@end example - -When inline syntax is used, the result is wrapped based on the -variable @code{org-babel-inline-result-wrap}, which by default is set to -@code{"=%s="} to produce verbatim text suitable for markup. - -@table @asis -@item @samp{<name>} -This is the name of the code block (see @ref{Structure of Code Blocks}) -to be evaluated in the current document. If the block is located in -another file, start @samp{<name>} with the file name followed by -a colon. For example, in order to execute a block named @samp{clear-data} -in @samp{file.org}, you can write the following: - -@example -#+CALL: file.org:clear-data() -@end example - -@item @samp{<arguments>} -Org passes arguments to the code block using standard function call -syntax. For example, a @samp{#+CALL:} line that passes @samp{4} to a code -block named @samp{double}, which declares the header argument @samp{:var n=2}, -would be written as: - -@example -#+CALL: double(n=4) -@end example - - -@noindent -Note how this function call syntax is different from the header -argument syntax. - -@item @samp{<inside header arguments>} -Org passes inside header arguments to the named code block using the -header argument syntax. Inside header arguments apply to code block -evaluation. For example, @samp{[:results output]} collects results -printed to stdout during code execution of that block. Note how -this header argument syntax is different from the function call -syntax. - -@item @samp{<end header arguments>} -End header arguments affect the results returned by the code block. -For example, @samp{:results html} wraps the results in a @samp{#+BEGIN_EXPORT - html} block before inserting the results in the Org buffer. -@end table - -@anchor{Limit code block evaluation} -@subheading Limit code block evaluation - -@cindex @samp{eval}, header argument -@cindex control code block evaluation -The @samp{eval} header argument can limit evaluation of specific code -blocks and @samp{CALL} keyword. It is useful for protection against -evaluating untrusted code blocks by prompting for a confirmation. - -@table @asis -@item @samp{never} or @samp{no} -Org never evaluates the source code. - -@item @samp{query} -Org prompts the user for permission to evaluate the source code. - -@item @samp{never-export} or @samp{no-export} -Org does not evaluate the source code when exporting, yet the user -can evaluate it interactively. - -@item @samp{query-export} -Org prompts the user for permission to evaluate the source code -during export. -@end table - -If @samp{eval} header argument is not set, then Org determines whether to -evaluate the source code from the @code{org-confirm-babel-evaluate} -variable (see @ref{Code Evaluation Security}). - -@anchor{Cache results of evaluation} -@subheading Cache results of evaluation - -@cindex @samp{cache}, header argument -@cindex cache results of code evaluation -The @samp{cache} header argument is for caching results of evaluating code -blocks. Caching results can avoid re-evaluating a code block that -have not changed since the previous run. To benefit from the cache -and avoid redundant evaluations, the source block must have a result -already present in the buffer, and neither the header -arguments---including the value of @samp{var} references---nor the text of -the block itself has changed since the result was last computed. This -feature greatly helps avoid long-running calculations. For some edge -cases, however, the cached results may not be reliable. - -The caching feature is best for when code blocks are pure functions, -that is functions that return the same value for the same input -arguments (see @ref{Environment of a Code Block}), and that do not have -side effects, and do not rely on external variables other than the -input arguments. Functions that depend on a timer, file system -objects, and random number generators are clearly unsuitable for -caching. - -A note of warning: when @samp{cache} is used in a session, caching may -cause unexpected results. - -When the caching mechanism tests for any source code changes, it does -not expand noweb style references (see @ref{Noweb Reference Syntax}). - -The @samp{cache} header argument can have one of two values: @samp{yes} or @samp{no}. - -@table @asis -@item @samp{no} -Default. No caching of results; code block evaluated every time. - -@item @samp{yes} -Whether to run the code or return the cached results is determined -by comparing the SHA1 hash value of the combined code block and -arguments passed to it. This hash value is packed on the -@samp{#+RESULTS:} line from previous evaluation. When hash values match, -Org does not evaluate the code block. When hash values mismatch, -Org evaluates the code block, inserts the results, recalculates the -hash value, and updates @samp{#+RESULTS:} line. -@end table - -In this example, both functions are cached. But @samp{caller} runs only if -the result from @samp{random} has changed since the last run. - -@example -#+NAME: random -#+BEGIN_SRC R :cache yes - runif(1) -#+END_SRC - -#+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random -0.4659510825295 - -#+NAME: caller -#+BEGIN_SRC emacs-lisp :var x=random :cache yes - x -#+END_SRC - -#+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller -0.254227238707244 -@end example - -@node Results of Evaluation -@section Results of Evaluation - -@cindex code block, results of evaluation -@cindex source code, results of evaluation - -@cindex @samp{results}, header argument -How Org handles results of a code block execution depends on many -header arguments working together. The primary determinant, however, -is the @samp{results} header argument. It accepts four classes of options. -Each code block can take only one option per class: - -@table @asis -@item Collection -For how the results should be collected from the code block; - -@item Type -For which type of result the code block will return; affects how Org -processes and inserts results in the Org buffer; - -@item Format -For the result; affects how Org processes results; - -@item Handling -For inserting results once they are properly formatted. -@end table - -@anchor{Collection} -@subheading Collection - -Collection options specify the results. Choose one of the options; -they are mutually exclusive. - -@table @asis -@item @samp{value} -Default for most Babel libraries@footnote{Actually, the constructs @samp{call_<name>()} and @samp{src_<lang>@{@}} -are not evaluated when they appear in a keyword (see @ref{In-buffer Settings}).}. Functional mode. Org -gets the value by wrapping the code in a function definition in the -language of the source block. That is why when using @samp{:results - value}, code should execute like a function and return a value. For -languages like Python, an explicit @code{return} statement is mandatory -when using @samp{:results value}. Result is the value returned by the -last statement in the code block. - -When evaluating the code block in a session (see @ref{Environment of a Code Block}), Org passes the code to an interpreter running as an -interactive Emacs inferior process. Org gets the value from the -source code interpreter's last statement output. Org has to use -language-specific methods to obtain the value. For example, from -the variable @code{_} in Ruby, and the value of @code{.Last.value} in R@. - -@item @samp{output} -Scripting mode. Org passes the code to an external process running -the interpreter. Org returns the contents of the standard output -stream as text results. - -When using a session, Org passes the code to the interpreter running -as an interactive Emacs inferior process. Org concatenates any text -output from the interpreter and returns the collection as a result. -@end table - -@anchor{Type} -@subheading Type - -Type tells what result types to expect from the execution of the code -block. Choose one of the options; they are mutually exclusive. The -default behavior is to automatically determine the result type. - -@table @asis -@item @samp{table} -@itemx @samp{vector} -Interpret the results as an Org table. If the result is a single -value, create a table with one row and one column. Usage example: -@samp{:results value table}. - -@cindex @samp{hlines}, header argument -In-between each table row or below the table headings, sometimes -results have horizontal lines, which are also known as ``hlines''. -The @samp{hlines} argument with the default @samp{no} value strips such lines -from the input table. For most code, this is desirable, or else -those @samp{hline} symbols raise unbound variable errors. A @samp{yes} -accepts such lines, as demonstrated in the following example. - -@example -#+NAME: many-cols -| a | b | c | -|---+---+---| -| d | e | f | -|---+---+---| -| g | h | i | - -#+NAME: no-hline -#+BEGIN_SRC python :var tab=many-cols :hlines no - return tab -#+END_SRC - -#+RESULTS: no-hline -| a | b | c | -| d | e | f | -| g | h | i | - -#+NAME: hlines -#+BEGIN_SRC python :var tab=many-cols :hlines yes - return tab -#+END_SRC - -#+RESULTS: hlines -| a | b | c | -|---+---+---| -| d | e | f | -|---+---+---| -| g | h | i | -@end example - -@item @samp{list} -Interpret the results as an Org list. If the result is a single -value, create a list of one element. - -@item @samp{scalar} -@itemx @samp{verbatim} -Interpret literally and insert as quoted text. Do not create -a table. Usage example: @samp{:results value verbatim}. - -@item @samp{file} -Interpret as a filename. Save the results of execution of the code -block to that file, then insert a link to it. You can control both -the filename and the description associated to the link. - -@cindex @samp{file}, header argument -@cindex @samp{output-dir}, header argument -Org first tries to generate the filename from the value of the -@samp{file} header argument and the directory specified using the -@samp{output-dir} header arguments. If @samp{output-dir} is not specified, -Org assumes it is the current directory. - -@example -#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/ - size(2cm); - draw(unitcircle); -#+END_SRC -@end example - -@cindex @samp{file-ext}, header argument -If @samp{file} header argument is missing, Org generates the base name of -the output file from the name of the code block, and its extension -from the @samp{file-ext} header argument. In that case, both the name -and the extension are mandatory. - -@example -#+name: circle -#+BEGIN_SRC asymptote :results value file :file-ext pdf - size(2cm); - draw(unitcircle); -#+END_SRC -@end example - -@cindex @samp{file-desc}, header argument -The @samp{file-desc} header argument defines the description (see -@ref{Link Format}) for the link. If @samp{file-desc} is present but has no value, -the @samp{file} value is used as the link description. When this -argument is not present, the description is omitted. - -@cindex @samp{sep}, header argument -By default, Org assumes that a table written to a file has -TAB-delimited output. You can choose a different separator with -the @samp{sep} header argument. - -@cindex @samp{file-mode}, header argument -The @samp{file-mode} header argument defines the file permissions. To -make it executable, use @samp{:file-mode (identity #o755)}. - -@example -#+BEGIN_SRC shell :results file :file script.sh :file-mode (identity #o755) - echo "#!/bin/bash" - echo "echo Hello World" -#+END_SRC -@end example -@end table - -@anchor{Format} -@subheading Format - -Format pertains to the type of the result returned by the code block. -Choose one of the options; they are mutually exclusive. The default -follows from the type specified above. - -@table @asis -@item @samp{code} -Result enclosed in a code block. Useful for parsing. Usage -example: @samp{:results value code}. - -@item @samp{drawer} -Result wrapped in a @samp{RESULTS} drawer. Useful for containing @samp{raw} -or @samp{org} results for later scripting and automated processing. -Usage example: @samp{:results value drawer}. - -@item @samp{html} -Results enclosed in a @samp{BEGIN_EXPORT html} block. Usage example: -@samp{:results value html}. - -@item @samp{latex} -Results enclosed in a @samp{BEGIN_EXPORT latex} block. Usage example: -@samp{:results value latex}. - -@item @samp{link} -@itemx @samp{graphics} -When used along with @samp{file} type, the result is a link to the file -specified in @samp{:file} header argument. However, unlike plain @samp{file} -type, nothing is written to the disk. The block is used for its -side-effects only, as in the following example: - -@example -#+begin_src shell :results file link :file "download.tar.gz" -wget -c "http://example.com/download.tar.gz" -#+end_src -@end example - -@item @samp{org} -Results enclosed in a @samp{BEGIN_SRC org} block. For comma-escape, -either @kbd{@key{TAB}} in the block, or export the file. Usage -example: @samp{:results value org}. - -@item @samp{pp} -Result converted to pretty-print source code. Enclosed in a code -block. Languages supported: Emacs Lisp, Python, and Ruby. Usage -example: @samp{:results value pp}. - -@item @samp{raw} -Interpreted as raw Org mode. Inserted directly into the buffer. -Aligned if it is a table. Usage example: @samp{:results value raw}. -@end table - -@cindex @samp{wrap}, header argument -The @samp{wrap} header argument unconditionally marks the results block by -appending strings to @samp{#+BEGIN_} and @samp{#+END_}. If no string is -specified, Org wraps the results in a @samp{#+BEGIN_results} -@dots{} @samp{#+END_results} block. It takes precedent over the @samp{results} -value listed above. E.g., - -@example -#+BEGIN_SRC emacs-lisp :results html :wrap EXPORT markdown -"<blink>Welcome back to the 90's</blink>" -#+END_SRC - -#+RESULTS: -#+BEGIN_EXPORT markdown -<blink>Welcome back to the 90's</blink> -#+END_EXPORT -@end example - -@anchor{Handling} -@subheading Handling - -Handling options after collecting the results. - -@table @asis -@item @samp{silent} -Do not insert results in the Org mode buffer, but echo them in the -minibuffer. Usage example: @samp{:results output silent}. - -@item @samp{replace} -Default. Insert results in the Org buffer. Remove previous -results. Usage example: @samp{:results output replace}. - -@item @samp{append} -Append results to the Org buffer. Latest results are at the bottom. -Does not remove previous results. Usage example: @samp{:results output - append}. - -@item @samp{prepend} -Prepend results to the Org buffer. Latest results are at the top. -Does not remove previous results. Usage example: @samp{:results output - prepend}. -@end table - -@anchor{Post-processing} -@subheading Post-processing - -@cindex @samp{post}, header argument -@cindex @samp{*this*}, in @samp{post} header argument -The @samp{post} header argument is for post-processing results from block -evaluation. When @samp{post} has any value, Org binds the results to -@code{*this*} variable for easy passing to @samp{var} header argument -specifications (see @ref{Environment of a Code Block}). That makes results -available to other code blocks, or even for direct Emacs Lisp code -execution. - -The following two examples illustrate @samp{post} header argument in -action. The first one shows how to attach an @samp{ATTR_LATEX} keyword -using @samp{post}. - -@example -#+NAME: attr_wrap -#+BEGIN_SRC sh :var data="" :var width="\\textwidth" :results output - echo "#+ATTR_LATEX: :width $width" - echo "$data" -#+END_SRC - -#+HEADER: :file /tmp/it.png -#+BEGIN_SRC dot :post attr_wrap(width="5cm", data=*this*) :results drawer - digraph@{ - a -> b; - b -> c; - c -> a; - @} -#+end_src - -#+RESULTS: -:RESULTS: -#+ATTR_LATEX :width 5cm -[[file:/tmp/it.png]] -:END: -@end example - -The second example shows use of @samp{colnames} header argument in @samp{post} -to pass data between code blocks. - -@example -#+NAME: round-tbl -#+BEGIN_SRC emacs-lisp :var tbl="" fmt="%.3f" - (mapcar (lambda (row) - (mapcar (lambda (cell) - (if (numberp cell) - (format fmt cell) - cell)) - row)) - tbl) -#+end_src - -#+BEGIN_SRC R :colnames yes :post round-tbl[:colnames yes](*this*) - set.seed(42) - data.frame(foo=rnorm(1)) -#+END_SRC - -#+RESULTS: -| foo | -|-------| -| 1.371 | -@end example - -@node Exporting Code Blocks -@section Exporting Code Blocks - -@cindex code block, exporting -@cindex source code, exporting - -It is possible to export the @emph{code} of code blocks, the @emph{results} of -code block evaluation, @emph{both} the code and the results of code block -evaluation, or @emph{none}. Org defaults to exporting @emph{code} for most -languages. For some languages, such as ditaa, Org defaults to -@emph{results}. To export just the body of code blocks, see @ref{Literal Examples}. To selectively export sub-trees of an Org document, see -@ref{Exporting}. - -@cindex @samp{exports}, header argument -The @samp{exports} header argument is to specify if that part of the Org -file is exported to, say, HTML or @LaTeX{} formats. - -@table @asis -@item @samp{code} -The default. The body of code is included into the exported file. -Example: @samp{:exports code}. - -@item @samp{results} -The results of evaluation of the code is included in the exported -file. Example: @samp{:exports results}. - -@item @samp{both} -Both the code and results of evaluation are included in the exported -file. Example: @samp{:exports both}. - -@item @samp{none} -Neither the code nor the results of evaluation is included in the -exported file. Whether the code is evaluated at all depends on -other options. Example: @samp{:exports none}. -@end table - -@vindex org-export-use-babel -To stop Org from evaluating code blocks to speed exports, use the -header argument @samp{:eval never-export} (see @ref{Evaluating Code Blocks}). -To stop Org from evaluating code blocks for greater security, set the -@code{org-export-use-babel} variable to @code{nil}, but understand that header -arguments will have no effect. - -Turning off evaluation comes in handy when batch processing. For -example, markup languages for wikis, which have a high risk of -untrusted code. Stopping code block evaluation also stops evaluation -of all header arguments of the code block. This may not be desirable -in some circumstances. So during export, to allow evaluation of just -the header arguments but not any code evaluation in the source block, -set @samp{:eval never-export} (see @ref{Evaluating Code Blocks}). - -Org never evaluates code blocks in commented sub-trees when exporting -(see @ref{Comment Lines}). On the other hand, Org does evaluate code -blocks in sub-trees excluded from export (see @ref{Export Settings}). - -@node Extracting Source Code -@section Extracting Source Code - -@cindex tangling -@cindex source code, extracting -@cindex code block, extracting source code - -Extracting source code from code blocks is a basic task in literate -programming. Org has features to make this easy. In literate -programming parlance, documents on creation are @emph{woven} with code and -documentation, and on export, the code is tangled for execution by -a computer. Org facilitates weaving and tangling for producing, -maintaining, sharing, and exporting literate programming documents. -Org provides extensive customization options for extracting source -code. - -When Org tangles code blocks, it expands, merges, and transforms them. -Then Org recomposes them into one or more separate files, as -configured through the options. During this tangling process, Org -expands variables in the source code, and resolves any noweb style -references (see @ref{Noweb Reference Syntax}). - -@anchor{Header arguments} -@subheading Header arguments - -@cindex @samp{tangle}, header argument -The @samp{tangle} header argument specifies if the code block is exported -to source file(s). - -@table @asis -@item @samp{yes} -Export the code block to source file. The file name for the source -file is derived from the name of the Org file, and the file -extension is derived from the source code language identifier. -Example: @samp{:tangle yes}. - -@item @samp{no} -The default. Do not extract the code in a source code file. -Example: @samp{:tangle no}. - -@item @var{FILENAME} -Export the code block to source file whose file name is derived from -any string passed to the @samp{tangle} header argument. Org derives the -file name as being relative to the directory of the Org file's -location. Example: @samp{:tangle FILENAME}. -@end table - -@cindex @samp{mkdirp}, header argument -The @samp{mkdirp} header argument creates parent directories for tangled -files if the directory does not exist. A @samp{yes} value enables -directory creation whereas @samp{no} inhibits it. - -@cindex @samp{comments}, header argument -The @samp{comments} header argument controls inserting comments into -tangled files. These are above and beyond whatever comments may -already exist in the code block. - -@table @asis -@item @samp{no} -The default. Do not insert any extra comments during tangling. - -@item @samp{link} -Wrap the code block in comments. Include links pointing back to the -place in the Org file from where the code was tangled. - -@item @samp{yes} -Kept for backward compatibility; same as @samp{link}. - -@item @samp{org} -Nearest headline text from Org file is inserted as comment. The -exact text that is inserted is picked from the leading context of -the source block. - -@item @samp{both} -Includes both @samp{link} and @samp{org} options. - -@item @samp{noweb} -Includes @samp{link} option, expands noweb references (see @ref{Noweb Reference Syntax}), and wraps them in link comments inside the body -of the code block. -@end table - -@cindex @samp{padline}, header argument -The @samp{padline} header argument controls insertion of newlines to pad -source code in the tangled file. - -@table @asis -@item @samp{yes} -Default. Insert a newline before and after each code block in the -tangled file. - -@item @samp{no} -Do not insert newlines to pad the tangled code blocks. -@end table - -@cindex @samp{shebang}, header argument -The @samp{shebang} header argument can turn results into executable script -files. By setting it to a string value---for example, @samp{:shebang -"#!/bin/bash"}---Org inserts that string as the first line of the -tangled file that the code block is extracted to. Org then turns on -the tangled file's executable permission. - -@cindex @samp{tangle-mode}, header argument -The @samp{tangle-mode} header argument specifies what permissions to set -for tangled files by @code{set-file-modes}. For example, to make -a read-only tangled file, use @samp{:tangle-mode (identity #o444)}. To -make it executable, use @samp{:tangle-mode (identity #o755)}. It also -overrides executable permission granted by @samp{shebang}. When multiple -source code blocks tangle to a single file with different and -conflicting @samp{tangle-mode} header arguments, Org's behavior is -undefined. - -@cindex @samp{no-expand}, header argument -By default Org expands code blocks during tangling. The @samp{no-expand} -header argument turns off such expansions. Note that one side-effect -of expansion by @code{org-babel-expand-src-block} also assigns values (see -@ref{Environment of a Code Block}) to variables. Expansions also replace -noweb references with their targets (see @ref{Noweb Reference Syntax}). -Some of these expansions may cause premature assignment, hence this -option. This option makes a difference only for tangling. It has no -effect when exporting since code blocks for execution have to be -expanded anyway. - -@anchor{Functions} -@subheading Functions - -@table @asis -@item @code{org-babel-tangle} -@findex org-babel-tangle -@kindex C-c C-v t -Tangle the current file. Bound to @kbd{C-c C-v t}. - -With prefix argument only tangle the current code block. - -@item @code{org-babel-tangle-file} -@findex org-babel-tangle-file -@kindex C-c C-v f -Choose a file to tangle. Bound to @kbd{C-c C-v f}. -@end table - -@anchor{Hooks (1)} -@subheading Hooks - -@table @asis -@item @code{org-babel-post-tangle-hook} -@vindex org-babel-post-tangle-hook -This hook is run from within code files tangled by -@code{org-babel-tangle}, making it suitable for post-processing, -compilation, and evaluation of code in the tangled files. -@end table - -@anchor{Jumping between code and Org} -@subheading Jumping between code and Org - -@findex org-babel-tangle-jump-to-org -Debuggers normally link errors and messages back to the source code. -But for tangled files, we want to link back to the Org file, not to -the tangled source file. To make this extra jump, Org uses -@code{org-babel-tangle-jump-to-org} function with two additional source -code block header arguments: - -@enumerate -@item -Set @samp{padline} to true---this is the default setting. -@item -Set @samp{comments} to @samp{link}, which makes Org insert links to the Org -file. -@end enumerate - -@node Languages -@section Languages - -@cindex babel, languages -@cindex source code, languages -@cindex code block, languages - -Code blocks in the following languages are supported. - -@multitable @columnfractions 0.25 0.25 0.25 0.20 -@headitem Language -@tab Identifier -@tab Language -@tab Identifier -@item Asymptote -@tab @samp{asymptote} -@tab Lisp -@tab @samp{lisp} -@item Awk -@tab @samp{awk} -@tab Lua -@tab @samp{lua} -@item C -@tab @samp{C} -@tab MATLAB -@tab @samp{matlab} -@item C++ -@tab @samp{C++}@footnote{C++ language is handled in @samp{ob-C.el}. Even though the -identifier for such source blocks is @samp{C++}, you activate it by loading -the C language.} -@tab Mscgen -@tab @samp{mscgen} -@item Clojure -@tab @samp{clojure} -@tab Objective Caml -@tab @samp{ocaml} -@item CSS -@tab @samp{css} -@tab Octave -@tab @samp{octave} -@item D -@tab @samp{D}@footnote{D language is handled in @samp{ob-C.el}. Even though the -identifier for such source blocks is @samp{D}, you activate it by loading -the C language.} -@tab Org mode -@tab @samp{org} -@item ditaa -@tab @samp{ditaa} -@tab Oz -@tab @samp{oz} -@item Emacs Calc -@tab @samp{calc} -@tab Perl -@tab @samp{perl} -@item Emacs Lisp -@tab @samp{emacs-lisp} -@tab Plantuml -@tab @samp{plantuml} -@item Eshell -@tab @samp{eshell} -@tab Processing.js -@tab @samp{processing} -@item Fortran -@tab @samp{fortran} -@tab Python -@tab @samp{python} -@item Gnuplot -@tab @samp{gnuplot} -@tab R -@tab @samp{R} -@item GNU Screen -@tab @samp{screen} -@tab Ruby -@tab @samp{ruby} -@item Graphviz -@tab @samp{dot} -@tab Sass -@tab @samp{sass} -@item Haskell -@tab @samp{haskell} -@tab Scheme -@tab @samp{scheme} -@item Java -@tab @samp{java} -@tab Sed -@tab @samp{sed} -@item Javascript -@tab @samp{js} -@tab shell -@tab @samp{sh} -@item @LaTeX{} -@tab @samp{latex} -@tab SQL -@tab @samp{sql} -@item Ledger -@tab @samp{ledger} -@tab SQLite -@tab @samp{sqlite} -@item Lilypond -@tab @samp{lilypond} -@tab Vala -@tab @samp{vala} -@end multitable - -Additional documentation for some languages is at -@uref{https://orgmode.org/worg/org-contrib/babel/languages.html}. - -@vindex org-babel-load-languages -By default, only Emacs Lisp is enabled for evaluation. To enable or -disable other languages, customize the @code{org-babel-load-languages} -variable either through the Emacs customization interface, or by -adding code to the init file as shown next. - -In this example, evaluation is disabled for Emacs Lisp, and enabled -for R@. - -@lisp -(org-babel-do-load-languages - 'org-babel-load-languages - '((emacs-lisp . nil) - (R . t))) -@end lisp - -Note that this is not the only way to enable a language. Org also -enables languages when loaded with @code{require} statement. For example, -the following enables execution of Clojure code blocks: - -@lisp -(require 'ob-clojure) -@end lisp - -@node Editing Source Code -@section Editing Source Code - -@cindex code block, editing -@cindex source code, editing - -@kindex C-c ' -Use @kbd{C-c '} to edit the current code block. It opens a new -major mode edit buffer containing the body of the source code block, -ready for any edits. Use @kbd{C-c '} again to close the buffer -and return to the Org buffer. - -@kindex C-x C-s -@vindex org-edit-src-auto-save-idle-delay -@cindex auto-save, in code block editing -@kbd{C-x C-s} saves the buffer and updates the contents of the -Org buffer. Set @code{org-edit-src-auto-save-idle-delay} to save the base -buffer after a certain idle delay time. Set -@code{org-edit-src-turn-on-auto-save} to auto-save this buffer into -a separate file using Auto-save mode. - -While editing the source code in the major mode, the Org Src minor -mode remains active. It provides these customization variables as -described below. For even more variables, look in the customization -group @code{org-edit-structure}. - -@table @asis -@item @code{org-src-lang-modes} -@vindex org-src-lang-modes -If an Emacs major-mode named @code{<LANG>-mode} exists, where -@var{<LANG>} is the language identifier from code block's -header line, then the edit buffer uses that major mode. Use this -variable to arbitrarily map language identifiers to major modes. - -@item @code{org-src-window-setup} -@vindex org-src-window-setup -For specifying Emacs window arrangement when the new edit buffer is -created. - -@item @code{org-src-preserve-indentation} -@cindex indentation, in code blocks -@vindex org-src-preserve-indentation -Default is @code{nil}. Source code is indented. This indentation -applies during export or tangling, and depending on the context, may -alter leading spaces and tabs. When non-@code{nil}, source code is -aligned with the leftmost column. No lines are modified during -export or tangling, which is very useful for white-space sensitive -languages, such as Python. - -@item @code{org-src-ask-before-returning-to-edit-buffer} -@vindex org-src-ask-before-returning-to-edit-buffer -When @code{nil}, Org returns to the edit buffer without further prompts. -The default prompts for a confirmation. -@end table - -@vindex org-src-fontify-natively -@vindex org-src-block-faces -Set @code{org-src-fontify-natively} to non-@code{nil} to turn on native code -fontification in the @emph{Org} buffer. Fontification of code blocks can -give visual separation of text and code on the display page. To -further customize the appearance of @code{org-block} for specific -languages, customize @code{org-src-block-faces}. The following example -shades the background of regular blocks, and colors source blocks only -for Python and Emacs Lisp languages. - -@lisp -(require 'color) -(set-face-attribute 'org-block nil :background - (color-darken-name - (face-attribute 'default :background) 3)) - -(setq org-src-block-faces '(("emacs-lisp" (:background "#EEE2FF")) - ("python" (:background "#E5FFB8")))) -@end lisp - -@node Noweb Reference Syntax -@section Noweb Reference Syntax - -@cindex code block, noweb reference -@cindex syntax, noweb -@cindex source code, noweb reference - -@cindex @samp{noweb-ref}, header argument -Source code blocks can include references to other source code blocks, -using a noweb@footnote{For noweb literate programming details, see -@uref{http://www.cs.tufts.edu/~nr/noweb/}.} style syntax: - -@example -<<CODE-BLOCK-ID>> -@end example - - -@noindent -where @var{CODE-BLOCK-ID} refers to either the @samp{NAME} of a single -source code block, or a collection of one or more source code blocks -sharing the same @samp{noweb-ref} header argument (see @ref{Using Header Arguments}). Org can replace such references with the source code of -the block or blocks being referenced, or, in the case of a single -source code block named with @samp{NAME}, with the results of an evaluation -of that block. - -@cindex @samp{noweb}, header argument -The @samp{noweb} header argument controls expansion of noweb syntax -references. Expansions occur when source code blocks are evaluated, -tangled, or exported. - -@table @asis -@item @samp{no} -Default. No expansion of noweb syntax references in the body of the -code when evaluating, tangling, or exporting. - -@item @samp{yes} -Expansion of noweb syntax references in the body of the code block -when evaluating, tangling, or exporting. - -@item @samp{tangle} -Expansion of noweb syntax references in the body of the code block -when tangling. No expansion when evaluating or exporting. - -@item @samp{no-export} -Expansion of noweb syntax references in the body of the code block -when evaluating or tangling. No expansion when exporting. - -@item @samp{strip-export} -Expansion of noweb syntax references in the body of the code block -when expanding prior to evaluating or tangling. Removes noweb -syntax references when exporting. - -@item @samp{eval} -Expansion of noweb syntax references in the body of the code block -only before evaluating. -@end table - -In the most simple case, the contents of a single source block is -inserted within other blocks. Thus, in following example, - -@example -#+NAME: initialization -#+BEGIN_SRC emacs-lisp - (setq sentence "Never a foot too far, even.") -#+END_SRC - -#+BEGIN_SRC emacs-lisp :noweb yes - <<initialization>> - (reverse sentence) -#+END_SRC -@end example - -@noindent -the second code block is expanded as - -@example -#+BEGIN_SRC emacs-lisp :noweb yes - (setq sentence "Never a foot too far, even.") - (reverse sentence) -#+END_SRC -@end example - -You may also include the contents of multiple blocks sharing a common -@samp{noweb-ref} header argument, which can be set at the file, sub-tree, -or code block level. In the example Org file shown next, the body of -the source code in each block is extracted for concatenation to a pure -code file when tangled. - -@example -#+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh - <<fullest-disk>> -#+END_SRC -* the mount point of the fullest disk - :PROPERTIES: - :header-args: :noweb-ref fullest-disk - :END: - -** query all mounted disks -#+BEGIN_SRC sh - df \ -#+END_SRC - -** strip the header row -#+BEGIN_SRC sh - |sed '1d' \ -#+END_SRC - -** output mount point of fullest disk -#+BEGIN_SRC sh - |awk '@{if (u < +$5) @{u = +$5; m = $6@}@} END @{print m@}' -#+END_SRC -@end example - -@cindex @samp{noweb-sep}, header argument -By default a newline separates each noweb reference concatenation. To -use a different separator, edit the @samp{noweb-sep} header argument. - -Alternatively, Org can include the results of evaluation of a single -code block rather than its body. Evaluation occurs when parentheses, -possibly including arguments, are appended to the code block name, as -shown below. - -@example -<<NAME(optional arguments)>> -@end example - - -Note that in this case, a code block name set by @samp{NAME} keyword is -required; the reference set by @samp{noweb-ref} will not work when -evaluation is desired. - -Here is an example that demonstrates how the exported content changes -when noweb style references are used with parentheses versus without. -Given: - -@example -#+NAME: some-code -#+BEGIN_SRC python :var num=0 :results output :exports none - print(num*10) -#+END_SRC -@end example - -@noindent -this code block: - -@example -#+BEGIN_SRC text :noweb yes - <<some-code>> -#+END_SRC -@end example - -@noindent -expands to: - -@example -print(num*10) -@end example - - -Below, a similar noweb style reference is used, but with parentheses, -while setting a variable @samp{num} to 10: - -@example -#+BEGIN_SRC text :noweb yes - <<some-code(num=10)>> -#+END_SRC -@end example - -@noindent -Note that the expansion now contains the results of the code block -@samp{some-code}, not the code block itself: - -@example -100 -@end example - - -Noweb insertions honor prefix characters that appear before the noweb -syntax reference. This behavior is illustrated in the following -example. Because the @samp{<<example>>} noweb reference appears behind the -SQL comment syntax, each line of the expanded noweb reference is -commented. With: - -@example -#+NAME: example -#+BEGIN_SRC text - this is the - multi-line body of example -#+END_SRC -@end example - -@noindent -this code block: - -@example -#+BEGIN_SRC sql :noweb yes - ---<<example>> -#+END_SRC -@end example - -@noindent -expands to: - -@example -#+BEGIN_SRC sql :noweb yes - ---this is the - ---multi-line body of example -#+END_SRC -@end example - -Since this change does not affect noweb replacement text without -newlines in them, inline noweb references are acceptable. - -This feature can also be used for management of indentation in -exported code snippets. With: - -@example -#+NAME: if-true -#+BEGIN_SRC python :exports none - print('do things when true') -#+end_src - -#+name: if-false -#+begin_src python :exports none - print('do things when false') -#+end_src -@end example - -@noindent -this code block: - -@example -#+begin_src python :noweb yes :results output - if true: - <<if-true>> - else: - <<if-false>> -#+end_src -@end example - -@noindent -expands to: - -@example -if true: - print('do things when true') -else: - print('do things when false') -@end example - -When in doubt about the outcome of a source code block expansion, you -can preview the results with the following command: - -@table @asis -@item @kbd{C-c C-v v} or @kbd{C-c C-v C-v} (@code{org-babel-expand-src-block}) -@findex org-babel-expand-src-block -@kindex C-c C-v v -@kindex C-c C-v C-v -Expand the current source code block according to its header -arguments and pop open the results in a preview buffer. -@end table - -@node Library of Babel -@section Library of Babel - -@cindex babel, library of -@cindex source code, library -@cindex code block, library - -The ``Library of Babel'' is a collection of code blocks. Like -a function library, these code blocks can be called from other Org -files. A collection of useful code blocks is available on @uref{https://orgmode.org/worg/library-of-babel.html, Worg}. For -remote code block evaluation syntax, see @ref{Evaluating Code Blocks}. - -@kindex C-c C-v i -@findex org-babel-lob-ingest -For any user to add code to the library, first save the code in -regular code blocks of an Org file, and then load the Org file with -@code{org-babel-lob-ingest}, which is bound to @kbd{C-c C-v i}. - -@node Key bindings and Useful Functions -@section Key bindings and Useful Functions - -@cindex code block, key bindings - -Many common Org mode key sequences are re-bound depending on -the context. - -Active key bindings in code blocks: - -@kindex C-c C-c -@findex org-babel-execute-src-block -@kindex C-c C-o -@findex org-babel-open-src-block-result -@kindex M-UP -@findex org-babel-load-in-session -@kindex M-DOWN -@findex org-babel-pop-to-session -@multitable @columnfractions 0.2 0.55 -@headitem Key binding -@tab Function -@item @kbd{C-c C-c} -@tab @code{org-babel-execute-src-block} -@item @kbd{C-c C-o} -@tab @code{org-babel-open-src-block-result} -@item @kbd{M-@key{UP}} -@tab @code{org-babel-load-in-session} -@item @kbd{M-@key{DOWN}} -@tab @code{org-babel-pop-to-session} -@end multitable - -Active key bindings in Org mode buffer: - -@kindex C-c C-v p -@kindex C-c C-v C-p -@kindex C-c C-v n -@kindex C-c C-v C-n -@kindex C-c C-v e -@kindex C-c C-v C-e -@kindex C-c C-v o -@kindex C-c C-v C-o -@kindex C-c C-v v -@kindex C-c C-v C-v -@kindex C-c C-v u -@kindex C-c C-v C-u -@kindex C-c C-v g -@kindex C-c C-v C-g -@kindex C-c C-v r -@kindex C-c C-v C-r -@kindex C-c C-v b -@kindex C-c C-v C-b -@kindex C-c C-v s -@kindex C-c C-v C-s -@kindex C-c C-v d -@kindex C-c C-v C-d -@kindex C-c C-v t -@kindex C-c C-v C-t -@kindex C-c C-v f -@kindex C-c C-v C-f -@kindex C-c C-v c -@kindex C-c C-v C-c -@kindex C-c C-v j -@kindex C-c C-v C-j -@kindex C-c C-v l -@kindex C-c C-v C-l -@kindex C-c C-v i -@kindex C-c C-v C-i -@kindex C-c C-v I -@kindex C-c C-v C-I -@kindex C-c C-v z -@kindex C-c C-v C-z -@kindex C-c C-v a -@kindex C-c C-v C-a -@kindex C-c C-v h -@kindex C-c C-v C-h -@kindex C-c C-v x -@kindex C-c C-v C-x -@findex org-babel-previous-src-block -@findex org-babel-next-src-block -@findex org-babel-execute-maybe -@findex org-babel-open-src-block-result -@findex org-babel-expand-src-block -@findex org-babel-goto-src-block-head -@findex org-babel-goto-named-src-block -@findex org-babel-goto-named-result -@findex org-babel-execute-buffer -@findex org-babel-execute-subtree -@findex org-babel-demarcate-block -@findex org-babel-tangle -@findex org-babel-tangle-file -@findex org-babel-check-src-block -@findex org-babel-insert-header-arg -@findex org-babel-load-in-session -@findex org-babel-lob-ingest -@findex org-babel-view-src-block-info -@findex org-babel-switch-to-session-with-code -@findex org-babel-sha1-hash -@findex org-babel-describe-bindings -@findex org-babel-do-key-sequence-in-edit-buffer -@multitable @columnfractions 0.45 0.55 -@headitem Key binding -@tab Function -@item @kbd{C-c C-v p} or @kbd{C-c C-v C-p} -@tab @code{org-babel-previous-src-block} -@item @kbd{C-c C-v n} or @kbd{C-c C-v C-n} -@tab @code{org-babel-next-src-block} -@item @kbd{C-c C-v e} or @kbd{C-c C-v C-e} -@tab @code{org-babel-execute-maybe} -@item @kbd{C-c C-v o} or @kbd{C-c C-v C-o} -@tab @code{org-babel-open-src-block-result} -@item @kbd{C-c C-v v} or @kbd{C-c C-v C-v} -@tab @code{org-babel-expand-src-block} -@item @kbd{C-c C-v u} or @kbd{C-c C-v C-u} -@tab @code{org-babel-goto-src-block-head} -@item @kbd{C-c C-v g} or @kbd{C-c C-v C-g} -@tab @code{org-babel-goto-named-src-block} -@item @kbd{C-c C-v r} or @kbd{C-c C-v C-r} -@tab @code{org-babel-goto-named-result} -@item @kbd{C-c C-v b} or @kbd{C-c C-v C-b} -@tab @code{org-babel-execute-buffer} -@item @kbd{C-c C-v s} or @kbd{C-c C-v C-s} -@tab @code{org-babel-execute-subtree} -@item @kbd{C-c C-v d} or @kbd{C-c C-v C-d} -@tab @code{org-babel-demarcate-block} -@item @kbd{C-c C-v t} or @kbd{C-c C-v C-t} -@tab @code{org-babel-tangle} -@item @kbd{C-c C-v f} or @kbd{C-c C-v C-f} -@tab @code{org-babel-tangle-file} -@item @kbd{C-c C-v c} or @kbd{C-c C-v C-c} -@tab @code{org-babel-check-src-block} -@item @kbd{C-c C-v j} or @kbd{C-c C-v C-j} -@tab @code{org-babel-insert-header-arg} -@item @kbd{C-c C-v l} or @kbd{C-c C-v C-l} -@tab @code{org-babel-load-in-session} -@item @kbd{C-c C-v i} or @kbd{C-c C-v C-i} -@tab @code{org-babel-lob-ingest} -@item @kbd{C-c C-v I} or @kbd{C-c C-v C-I} -@tab @code{org-babel-view-src-block-info} -@item @kbd{C-c C-v z} or @kbd{C-c C-v C-z} -@tab @code{org-babel-switch-to-session-with-code} -@item @kbd{C-c C-v a} or @kbd{C-c C-v C-a} -@tab @code{org-babel-sha1-hash} -@item @kbd{C-c C-v h} or @kbd{C-c C-v C-h} -@tab @code{org-babel-describe-bindings} -@item @kbd{C-c C-v x} or @kbd{C-c C-v C-x} -@tab @code{org-babel-do-key-sequence-in-edit-buffer} -@end multitable - -@node Batch Execution -@section Batch Execution - -@cindex code block, batch execution -@cindex source code, batch execution - -Org mode features, including working with source code facilities can -be invoked from the command line. This enables building shell scripts -for batch processing, running automated system tasks, and expanding -Org mode's usefulness. - -The sample script shows batch processing of multiple files using -@code{org-babel-tangle}. - -@example -#!/bin/sh -# Tangle files with Org mode -# -emacs -Q --batch --eval " - (progn - (require 'ob-tangle) - (dolist (file command-line-args-left) - (with-current-buffer (find-file-noselect file) - (org-babel-tangle)))) - " "$@@" -@end example - -@node Miscellaneous -@chapter Miscellaneous - -@menu -* Completion:: @kbd{M-@key{TAB}} guesses completions. -* Structure Templates:: Quick insertion of structural elements. -* Speed Keys:: Electric commands at the beginning of a headline. -* Clean View:: Getting rid of leading stars in the outline. -* Execute commands in the active region:: Execute commands on multiple items in Org or agenda view. -* Dynamic Headline Numbering:: Display and update outline numbering. -* The Very Busy @kbd{C-c C-c} Key:: When in doubt, press @kbd{C-c C-c}. -* In-buffer Settings:: Overview of keywords. -* Org Syntax:: Formal description of Org's syntax. -* Documentation Access:: Read documentation about current syntax. -* Escape Character:: Prevent Org from interpreting your writing. -* Code Evaluation Security:: Org files evaluate in-line code. -* Interaction:: With other Emacs packages. -* TTY Keys:: Using Org on a tty. -* Protocols:: External access to Emacs and Org. -* Org Crypt:: Encrypting Org files. -* Org Mobile:: Viewing and capture on a mobile device. -@end menu - -@node Completion -@section Completion - -@cindex completion, of @TeX{} symbols -@cindex completion, of TODO keywords -@cindex completion, of dictionary words -@cindex completion, of option keywords -@cindex completion, of tags -@cindex completion, of property keys -@cindex completion, of link abbreviations -@cindex @TeX{} symbol completion -@cindex TODO keywords completion -@cindex dictionary word completion -@cindex option keyword completion -@cindex tag completion -@cindex link abbreviations, completion of - -Org has in-buffer completions. Unlike minibuffer completions, which -are useful for quick command interactions, Org's in-buffer completions -are more suitable for content creation in Org documents. Type one or -more letters and invoke the hot key to complete the text in-place. -Depending on the context and the keys, Org offers different types of -completions. No minibuffer is involved. Such mode-specific hot keys -have become an integral part of Emacs and Org provides several -shortcuts. - -@table @asis -@item @kbd{M-@key{TAB}} -@kindex M-TAB - -Complete word at point. - -@itemize -@item -At the beginning of an empty headline, complete TODO keywords. - -@item -After @samp{\}, complete @TeX{} symbols supported by the exporter. - -@item -After @samp{:} in a headline, complete tags. Org deduces the list of -tags from the @samp{TAGS} in-buffer option (see @ref{Setting Tags}), the -variable @code{org-tag-alist}, or from all tags used in the current -buffer. - -@item -After @samp{:} and not in a headline, complete property keys. The list -of keys is constructed dynamically from all keys used in the -current buffer. - -@item -After @samp{[[}, complete link abbreviations (see @ref{Link Abbreviations}). - -@item -After @samp{[[*}, complete headlines in the current buffer so that they -can be used in search links like: @samp{[[*find this headline]]} - -@item -After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or -file-specific @samp{OPTIONS}. After option keyword is complete, -pressing @kbd{M-@key{TAB}} again inserts example settings for this -keyword. - -@item -After @samp{STARTUP} keyword, complete startup items. - -@item -When point is anywhere else, complete dictionary words using -Ispell. -@end itemize -@end table - -@node Structure Templates -@section Structure Templates - -@cindex template insertion -@cindex insertion, of templates - -With just a few keystrokes, it is possible to insert empty structural -blocks, such as @samp{#+BEGIN_SRC} @dots{} @samp{#+END_SRC}, or to wrap existing -text in such a block. - -@table @asis -@item @kbd{C-c C-,} (@code{org-insert-structure-template}) -@findex org-insert-structure-template -@kindex C-c C-, -Prompt for a type of block structure, and insert the block at point. -If the region is active, it is wrapped in the block. First prompts -the user for keys, which are used to look up a structure type from -the variable below. If the key is @kbd{@key{TAB}}, @kbd{@key{RET}}, -or @kbd{@key{SPC}}, the user is prompted to enter a block type. -@end table - -@vindex org-structure-template-alist -Available structure types are defined in -@code{org-structure-template-alist}, see the docstring for adding or -changing values. - -@cindex Tempo -@cindex template expansion -@cindex insertion, of templates -@vindex org-tempo-keywords-alist -Org Tempo expands snippets to structures defined in -@code{org-structure-template-alist} and @code{org-tempo-keywords-alist}. For -example, @kbd{< s @key{TAB}} creates a code block. Enable it by -customizing @code{org-modules} or add @samp{(require 'org-tempo)} to your Emacs -init file@footnote{For more information, please refer to the commentary section -in @samp{org-tempo.el}.}. - -@multitable @columnfractions 0.1 0.9 -@item @kbd{a} -@tab @samp{#+BEGIN_EXPORT ascii} @dots{} @samp{#+END_EXPORT} -@item @kbd{c} -@tab @samp{#+BEGIN_CENTER} @dots{} @samp{#+END_CENTER} -@item @kbd{C} -@tab @samp{#+BEGIN_COMMENT} @dots{} @samp{#+END_COMMENT} -@item @kbd{e} -@tab @samp{#+BEGIN_EXAMPLE} @dots{} @samp{#+END_EXAMPLE} -@item @kbd{E} -@tab @samp{#+BEGIN_EXPORT} @dots{} @samp{#+END_EXPORT} -@item @kbd{h} -@tab @samp{#+BEGIN_EXPORT html} @dots{} @samp{#+END_EXPORT} -@item @kbd{l} -@tab @samp{#+BEGIN_EXPORT latex} @dots{} @samp{#+END_EXPORT} -@item @kbd{q} -@tab @samp{#+BEGIN_QUOTE} @dots{} @samp{#+END_QUOTE} -@item @kbd{s} -@tab @samp{#+BEGIN_SRC} @dots{} @samp{#+END_SRC} -@item @kbd{v} -@tab @samp{#+BEGIN_VERSE} @dots{} @samp{#+END_VERSE} -@end multitable - -@node Speed Keys -@section Speed Keys - -@cindex speed keys - -Single keystrokes can execute custom commands in an Org file when -point is on a headline. Without the extra burden of a meta or -modifier key, Speed Keys can speed navigation or execute custom -commands. Besides faster navigation, Speed Keys may come in handy on -small mobile devices that do not have full keyboards. Speed Keys may -also work on TTY devices known for their problems when entering Emacs -key chords. - -@vindex org-use-speed-commands -By default, Org has Speed Keys disabled. To activate Speed Keys, set -the variable @code{org-use-speed-commands} to a non-@code{nil} value. To -trigger a Speed Key, point must be at the beginning of an Org -headline, before any of the stars. - -@vindex org-speed-commands-user -@findex org-speed-command-help -Org comes with a pre-defined list of Speed Keys. To add or modify -Speed Keys, customize the variable, @code{org-speed-commands-user}. For -more details, see the variable's docstring. With Speed Keys -activated, @kbd{M-x org-speed-command-help}, or @kbd{?} when -point is at the beginning of an Org headline, shows currently active -Speed Keys, including the user-defined ones. - -@node Clean View -@section A Cleaner Outline View - -@cindex hiding leading stars -@cindex dynamic indentation -@cindex odd-levels-only outlines -@cindex clean outline view - -Org's outline with stars and no indents can look cluttered for short -documents. For @emph{book-like} long documents, the effect is not as -noticeable. Org provides an alternate stars and indentation scheme, -as shown on the right in the following table. It displays only one -star and indents text to line up with the heading: - -@example -* Top level headline | * Top level headline -** Second level | * Second level -*** Third level | * Third level -some text | some text -*** Third level | * Third level -more text | more text -* Another top level headline | * Another top level headline -@end example - -Org can achieve this in two ways, (1) by just displaying the buffer in -this way without changing it, or (2) by actually indenting every line -in the desired amount with hard spaces and hiding leading stars. - -@menu -* Org Indent Mode:: -* Hard indentation:: -@end menu - -@node Org Indent Mode -@subsection Org Indent Mode - -@cindex Indent mode -@findex org-indent-mode -To display the buffer in the indented view, activate Org Indent minor -mode, using @kbd{M-x org-indent-mode}. Text lines that are not -headlines are prefixed with virtual spaces to vertically align with -the headline text@footnote{Org Indent mode also sets @code{wrap-prefix} correctly for -indenting and wrapping long lines of headlines or text. This minor -mode also handles Visual Line mode and directly applied settings -through @code{word-wrap}.}. - -@vindex org-indent-indentation-per-level -To make more horizontal space, the headlines are shifted by two -characters. Configure @code{org-indent-indentation-per-level} variable for -a different number. - -@vindex org-indent-mode-turns-on-hiding-stars -@vindex org-indent-mode-turns-off-org-adapt-indentation -By default, Org Indent mode turns off @code{org-adapt-indentation} and does -hide leading stars by locally setting @code{org-hide-leading-stars} to @code{t}: -only one star on each headline is visible, the rest are masked with -the same font color as the background. If you want to customize this -default behavior, see @code{org-indent-mode-turns-on-hiding-stars} and -@code{org-indent-mode-turns-off-org-adapt-indentation}. - -@vindex org-startup-indented -To globally turn on Org Indent mode for all files, customize the -variable @code{org-startup-indented}. To control it for individual files, -use @samp{STARTUP} keyword as follows: - -@example -#+STARTUP: indent -#+STARTUP: noindent -@end example - -@node Hard indentation -@subsection Hard indentation - -It is possible to use hard spaces to achieve the indentation instead, -if the bare ASCII file should have the indented look also outside -Emacs@footnote{This works, but requires extra effort. Org Indent mode is -more convenient for most applications.}. With Org's support, you have to indent all lines to -line up with the outline headers. You would use these -settings@footnote{@code{org-adapt-indentation} can also be set to @samp{'headline-data}, -in which case only data lines below the headline will be indented.}: - -@lisp -(setq org-adapt-indentation t - org-hide-leading-stars t - org-odd-levels-only t) -@end lisp - -@table @asis -@item @emph{Indentation of text below headlines} (@code{org-adapt-indentation}) -@vindex org-adapt-indentation -The first setting modifies paragraph filling, line wrapping, and -structure editing commands to preserving or adapting the indentation -as appropriate. - -@item @emph{Hiding leading stars} (@code{org-hide-leading-stars}) -@vindex org-hide-leading-stars -@vindex org-hide, face -The second setting makes leading stars invisible by applying the -face @code{org-hide} to them. For per-file preference, use these file -@samp{STARTUP} options: - -@example -#+STARTUP: hidestars -#+STARTUP: showstars -@end example - -@item @emph{Odd levels} (@code{org-odd-levels-only}) -@vindex org-odd-levels-only -The third setting makes Org use only odd levels, 1, 3, 5, @dots{}, in -the outline to create more indentation. On a per-file level, -control this with: - -@example -#+STARTUP: odd -#+STARTUP: oddeven -@end example - -To convert a file between single and double stars layouts, use -@kbd{M-x org-convert-to-odd-levels} and @kbd{M-x org-convert-to-oddeven-levels}. -@end table - -@node Execute commands in the active region -@section Execute commands in the active region - -@vindex org-loop-over-headlines-in-active-region -When in an Org buffer and the region is active, some commands will -apply to all the subtrees in the active region. For example, hitting -@kbd{C-c C-s} when multiple headlines are within the active region will -successively prompt you for a new schedule date and time. To disable -this, set the option @code{org-loop-over-headlines-in-active-region} to -non-@code{t}, activate the region and run the command normally. - -@vindex org-agenda-loop-over-headlines-in-active-region -@code{org-agenda-loop-over-headlines-in-active-region} is the equivalent -option of the agenda buffer, where you can also use @ref{Bulk remote editing selected entries, , bulk editing of -selected entries}. - -Not all commands can loop in the active region and what subtrees or -headlines are considered can be refined: see the docstrings of these -options for more details. - -@node Dynamic Headline Numbering -@section Dynamic Headline Numbering - -@cindex Org Num mode -@cindex number headlines -The Org Num minor mode, toggled with @kbd{M-x org-num-mode}, -displays outline numbering on top of headlines. It also updates it -automatically upon changes to the structure of the document. - -@vindex org-num-max-level -@vindex org-num-skip-tags -@vindex org-num-skip-commented -@vindex org-num-skip-unnumbered -By default, all headlines are numbered. You can limit numbering to -specific headlines according to their level, tags, @samp{COMMENT} keyword, -or @samp{UNNUMBERED} property. Set @code{org-num-max-level}, -@code{org-num-skip-tags}, @code{org-num-skip-commented}, -@code{org-num-skip-unnumbered}, or @code{org-num-skip-footnotes} accordingly. - -@vindex org-num-skip-footnotes -If @code{org-num-skip-footnotes} is non-@code{nil}, footnotes sections (see -@ref{Creating Footnotes}) are not numbered either. - -@vindex org-num-face -@vindex org-num-format-function -You can control how the numbering is displayed by setting -@code{org-num-face} and @code{org-num-format-function}. - -@vindex org-startup-numerated -You can also turn this mode globally for all Org files by setting the -option @code{org-startup-numerated} to @samp{t}, or locally on a file by using -@samp{#+startup: num}. - -@node The Very Busy @kbd{C-c C-c} Key -@section The Very Busy @kbd{C-c C-c} Key - -@kindex C-c C-c -@cindex @kbd{C-c C-c}, overview - -The @kbd{C-c C-c} key in Org serves many purposes depending on -the context. It is probably the most over-worked, multi-purpose key -combination in Org. Its uses are well documented throughout this -manual, but here is a consolidated list for easy reference. - -@itemize -@item -If column view (see @ref{Column View}) is on, exit column view. - -@item -If any highlights shown in the buffer from the creation of a sparse -tree, or from clock display, remove such highlights. - -@item -If point is in one of the special @samp{KEYWORD} lines, scan the buffer -for these lines and update the information. Also reset the Org file -cache used to temporary store the contents of URLs used as values -for keywords like @samp{SETUPFILE}. - -@item -If point is inside a table, realign the table. - -@item -If point is on a @samp{TBLFM} keyword, re-apply the formulas to the -entire table. - -@item -If the current buffer is a capture buffer, close the note and file -it. With a prefix argument, also jump to the target location after -saving the note. - -@item -If point is on a @samp{<<<target>>>}, update radio targets and -corresponding links in this buffer. - -@item -If point is on a property line or at the start or end of a property -drawer, offer property commands. - -@item -If point is at a footnote reference, go to the corresponding -definition, and @emph{vice versa}. - -@item -If point is on a statistics cookie, update it. - -@item -If point is in a plain list item with a checkbox, toggle the status -of the checkbox. - -@item -If point is on a numbered item in a plain list, renumber the ordered -list. - -@item -If point is on the @samp{#+BEGIN} line of a dynamic block, the block is -updated. - -@item -If point is at a timestamp, fix the day name in the timestamp. -@end itemize - -@node In-buffer Settings -@section Summary of In-Buffer Settings - -@cindex in-buffer settings -@cindex special keywords - -In-buffer settings start with @samp{#+}, followed by a keyword, a colon, -and then a word for each setting. Org accepts multiple settings on -the same line. Org also accepts multiple lines for a keyword. This -manual describes these settings throughout. A summary follows here. - -@cindex refresh set-up -@kbd{C-c C-c} activates any changes to the in-buffer settings. -Closing and reopening the Org file in Emacs also activates the -changes. - -@table @asis -@item @samp{#+ARCHIVE: %s_done::} -@cindex @samp{ARCHIVE}, keyword -@vindex org-archive-location -Sets the archive location of the agenda file. The corresponding -variable is @code{org-archive-location}. - -@item @samp{#+CATEGORY} -@cindex @samp{CATEGORY}, keyword -Sets the category of the agenda file, which applies to the entire -document. - -@item @samp{#+COLUMNS: %25ITEM ...} -@cindex @samp{COLUMNS}, property -Set the default format for columns view. This format applies when -columns view is invoked in locations where no @samp{COLUMNS} property -applies. - -@item @samp{#+CONSTANTS: name1=value1 ...} -@cindex @samp{CONSTANTS}, keyword -@vindex org-table-formula-constants -@vindex org-table-formula -Set file-local values for constants that table formulas can use. -This line sets the local variable -@code{org-table-formula-constants-local}. The global version of this -variable is @code{org-table-formula-constants}. - -@item @samp{#+FILETAGS: :tag1:tag2:tag3:} -@cindex @samp{FILETAGS}, keyword -Set tags that all entries in the file inherit from, including the -top-level entries. - -@item @samp{#+LINK: linkword replace} -@cindex @samp{LINK}, keyword -@vindex org-link-abbrev-alist -Each line specifies one abbreviation for one link. Use multiple -@samp{LINK} keywords for more, see @ref{Link Abbreviations}. The -corresponding variable is @code{org-link-abbrev-alist}. - -@item @samp{#+PRIORITIES: highest lowest default} -@cindex @samp{PRIORITIES}, keyword -@vindex org-priority-highest -@vindex org-priority-lowest -@vindex org-priority-default -This line sets the limits and the default for the priorities. All -three must be either letters A--Z or numbers 0--9. The highest -priority must have a lower ASCII number than the lowest priority. - -@item @samp{#+PROPERTY: Property_Name Value} -@cindex @samp{PROPERTY}, keyword -This line sets a default inheritance value for entries in the -current buffer, most useful for specifying the allowed values of -a property. - -@item @samp{#+SETUPFILE: file} -@cindex @samp{SETUPFILE}, keyword -The setup file or a URL pointing to such file is for additional -in-buffer settings. Org loads this file and parses it for any -settings in it only when Org opens the main file. If URL is -specified, the contents are downloaded and stored in a temporary -file cache. @kbd{C-c C-c} on the settings line parses and -loads the file, and also resets the temporary file cache. Org also -parses and loads the document during normal exporting process. Org -parses the contents of this document as if it was included in the -buffer. It can be another Org file. To visit the file---not -a URL---use @kbd{C-c '} while point is on the line with the -file name. - -@item @samp{#+STARTUP:} -@cindex @samp{STARTUP}, keyword -Startup options Org uses when first visiting a file. - -@vindex org-startup-folded -The first set of options deals with the initial visibility of the -outline tree. The corresponding variable for global default -settings is @code{org-startup-folded} with a default value of -@code{showeverything}. - -@multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{overview} -@tab Top-level headlines only. -@item @samp{content} -@tab All headlines. -@item @samp{showall} -@tab No folding on any entry. -@item @samp{showeverything} -@tab Show even drawer contents. -@end multitable - -@vindex org-startup-indented -Dynamic virtual indentation is controlled by the variable -@code{org-startup-indented}@footnote{Note that Org Indent mode also sets the @code{wrap-prefix} -property, such that Visual Line mode (or purely setting @code{word-wrap}) -wraps long lines, including headlines, correctly indented.}. - -@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{indent} -@tab Start with Org Indent mode turned on. -@item @samp{noindent} -@tab Start with Org Indent mode turned off. -@end multitable - -@vindex org-startup-numerated -Dynamic virtual numeration of headlines is controlled by the variable -@code{org-startup-numerated}. - -@multitable {aaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{num} -@tab Start with Org num mode turned on. -@item @samp{nonum} -@tab Start with Org num mode turned off. -@end multitable - -@vindex org-startup-align-all-tables -Aligns tables consistently upon visiting a file. The -corresponding variable is @code{org-startup-align-all-tables} with -@code{nil} as default value. - -@multitable {aaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{align} -@tab Align all tables. -@item @samp{noalign} -@tab Do not align tables on startup. -@end multitable - -@vindex org-startup-shrink-all-tables -Shrink table columns with a width cookie. The corresponding -variable is @code{org-startup-shrink-all-tables} with @code{nil} as -default value. - -@vindex org-startup-with-inline-images -When visiting a file, inline images can be automatically -displayed. The corresponding variable is -@code{org-startup-with-inline-images}, with a default value @code{nil} to -avoid delays when visiting a file. - -@multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{inlineimages} -@tab Show inline images. -@item @samp{noinlineimages} -@tab Do not show inline images on startup. -@end multitable - -@vindex org-log-done -@vindex org-log-note-clock-out -@vindex org-log-repeat -Logging the closing and reopening of TODO items and clock -intervals can be configured using these options (see variables -@code{org-log-done}, @code{org-log-note-clock-out}, and @code{org-log-repeat}). - -@multitable {aaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{logdone} -@tab Record a timestamp when an item is marked as done. -@item @samp{lognotedone} -@tab Record timestamp and a note when DONE@. -@item @samp{nologdone} -@tab Do not record when items are marked as done. -@item @samp{logrepeat} -@tab Record a time when reinstating a repeating item. -@item @samp{lognoterepeat} -@tab Record a note when reinstating a repeating item. -@item @samp{nologrepeat} -@tab Do not record when reinstating repeating item. -@item @samp{lognoteclock-out} -@tab Record a note when clocking out. -@item @samp{nolognoteclock-out} -@tab Do not record a note when clocking out. -@item @samp{logreschedule} -@tab Record a timestamp when scheduling time changes. -@item @samp{lognotereschedule} -@tab Record a note when scheduling time changes. -@item @samp{nologreschedule} -@tab Do not record when a scheduling date changes. -@item @samp{logredeadline} -@tab Record a timestamp when deadline changes. -@item @samp{lognoteredeadline} -@tab Record a note when deadline changes. -@item @samp{nologredeadline} -@tab Do not record when a deadline date changes. -@item @samp{logrefile} -@tab Record a timestamp when refiling. -@item @samp{lognoterefile} -@tab Record a note when refiling. -@item @samp{nologrefile} -@tab Do not record when refiling. -@end multitable - -@vindex org-hide-leading-stars -@vindex org-odd-levels-only -Here are the options for hiding leading stars in outline -headings, and for indenting outlines. The corresponding -variables are @code{org-hide-leading-stars} and -@code{org-odd-levels-only}, both with a default setting @code{nil} -(meaning @samp{showstars} and @samp{oddeven}). - -@multitable {aaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{hidestars} -@tab Make all but one of the stars starting a headline invisible. -@item @samp{showstars} -@tab Show all stars starting a headline. -@item @samp{indent} -@tab Virtual indentation according to outline level. -@item @samp{noindent} -@tab No virtual indentation according to outline level. -@item @samp{odd} -@tab Allow only odd outline levels (1, 3, @dots{}). -@item @samp{oddeven} -@tab Allow all outline levels. -@end multitable - -@vindex org-put-time-stamp-overlays -@vindex org-time-stamp-overlay-formats -To turn on custom format overlays over timestamps (variables -@code{org-put-time-stamp-overlays} and -@code{org-time-stamp-overlay-formats}), use: - -@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{customtime} -@tab Overlay custom time format. -@end multitable - -@vindex constants-unit-system -The following options influence the table spreadsheet (variable -@code{constants-unit-system}). - -@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{constcgs} -@tab @samp{constants.el} should use the c-g-s unit system. -@item @samp{constSI} -@tab @samp{constants.el} should use the SI unit system. -@end multitable - -@vindex org-footnote-define-inline -@vindex org-footnote-auto-label -@vindex org-footnote-auto-adjust -To influence footnote settings, use the following keywords. The -corresponding variables are @code{org-footnote-define-inline}, -@code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}. - -@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{fninline} -@tab Define footnotes inline. -@item @samp{fnnoinline} -@tab Define footnotes in separate section. -@item @samp{fnlocal} -@tab Define footnotes near first reference, but not inline. -@item @samp{fnprompt} -@tab Prompt for footnote labels. -@item @samp{fnauto} -@tab Create @samp{[fn:1]}-like labels automatically (default). -@item @samp{fnconfirm} -@tab Offer automatic label for editing or confirmation. -@item @samp{fnadjust} -@tab Automatically renumber and sort footnotes. -@item @samp{nofnadjust} -@tab Do not renumber and sort automatically. -@end multitable - -@vindex org-hide-block-startup -To hide blocks on startup, use these keywords. The -corresponding variable is @code{org-hide-block-startup}. - -@multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{hideblocks} -@tab Hide all begin/end blocks on startup. -@item @samp{nohideblocks} -@tab Do not hide blocks on startup. -@end multitable - -@vindex org-pretty-entities -The display of entities as UTF-8 characters is governed by the -variable @code{org-pretty-entities} and the keywords - -@multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @samp{entitiespretty} -@tab Show entities as UTF-8 characters where possible. -@item @samp{entitiesplain} -@tab Leave entities plain. -@end multitable - -@item @samp{#+TAGS: TAG1(c1) TAG2(c2)} -@cindex @samp{TAGS}, keyword -@vindex org-tag-alist -These lines (several such lines are allowed) specify the valid tags -in this file, and (potentially) the corresponding @emph{fast tag -selection} keys. The corresponding variable is @code{org-tag-alist}. - -@item @samp{#+TODO:} -@itemx @samp{#+SEQ_TODO:} -@itemx @samp{#+TYP_TODO:} -@cindex @samp{SEQ_TODO}, keyword -@cindex @samp{TODO}, keyword -@cindex @samp{TYP_TODO}, keyword -@vindex org-todo-keywords -These lines set the TODO keywords and their interpretation in the -current file. The corresponding variable is @code{org-todo-keywords}. -@end table - -@node Org Syntax -@section Org Syntax - -A reference document providing a formal description of Org's syntax is -available as @uref{https://orgmode.org/worg/dev/org-syntax.html, a draft on Worg}, written and maintained by Nicolas -Goaziou. It defines Org's core internal concepts such as ``headlines'', -``sections'', ``affiliated keywords'', ``(greater) elements'' and ``objects''. -Each part of an Org document belongs to one of the previous -categories. - -To explore the abstract structure of an Org buffer, run this in -a buffer: - -@example -M-: (org-element-parse-buffer) <RET> -@end example - - -@noindent -It outputs a list containing the buffer's content represented as an -abstract structure. The export engine relies on the information -stored in this list. Most interactive commands---e.g., for structure -editing---also rely on the syntactic meaning of the surrounding -context. - -@cindex syntax checker -@cindex linter -@findex org-lint -You can probe the syntax of your documents with the command - -@example -M-x org-lint <RET> -@end example - - -@noindent -It runs a number of checks to find common mistakes. It then displays -their location in a dedicated buffer, along with a description and -a ``trust level'', since false-positive are possible. From there, you -can operate on the reports with the following keys: - -@multitable @columnfractions 0.22 0.78 -@item @kbd{C-j}, @kbd{@key{TAB}} -@tab Display the offending line -@item @kbd{@key{RET}} -@tab Move point to the offending line -@item @kbd{g} -@tab Check the document again -@item @kbd{h} -@tab Hide all reports from the same checker -@item @kbd{i} -@tab Also remove them from all subsequent checks -@item @kbd{S} -@tab Sort reports by the column at point -@end multitable - -@node Documentation Access -@section Context Dependent Documentation - -@cindex documentation -@cindex Info - -@findex org-info-find-node -@kindex C-c C-x I -@kbd{C-c C-x I} in an Org file tries to open a suitable section -of the Org manual depending on the syntax at point. For example, -using it on a headline displays ``Document Structure'' section. - -@kbd{q} closes the Info window. - -@node Escape Character -@section Escape Character - -@cindex escape character -@cindex zero width space -You may sometimes want to write text that looks like Org syntax, but -should really read as plain text. Org may use a specific escape -character in some situations, i.e., a backslash in macros (see @ref{Macro Replacement}) and links (see @ref{Link Format}), or a comma in source and -example blocks (see @ref{Literal Examples}). In the general case, however, -we suggest to use the zero width space. You can insert one with any -of the following: - -@example -C-x 8 <RET> zero width space <RET> -C-x 8 <RET> 200B <RET> -@end example - - -For example, in order to write @samp{[[1,2]]} as-is in your document, you -may write instead - -@example -[X[1,2]] -@end example - - -where @samp{X} denotes the zero width space character. - -@node Code Evaluation Security -@section Code Evaluation and Security Issues - -Unlike plain text, running code comes with risk. Each source code -block, in terms of risk, is equivalent to an executable file. Org -therefore puts a few confirmation prompts by default. This is to -alert the casual user from accidentally running untrusted code. - -For users who do not run code blocks or write code regularly, Org's -default settings should suffice. However, some users may want to -tweak the prompts for fewer interruptions. To weigh the risks of -automatic execution of code blocks, here are some details about code -evaluation. - -Org evaluates code in the following circumstances: - -@table @asis -@item @emph{Source code blocks} -Org evaluates source code blocks in an Org file during export. Org -also evaluates a source code block with the @kbd{C-c C-c} key -chord. Users exporting or running code blocks must load files only -from trusted sources. Be wary of customizing variables that remove -or alter default security measures. - -@defopt org-confirm-babel-evaluate -When @code{t}, Org prompts the user for confirmation before executing -each code block. When @code{nil}, Org executes code blocks without -prompting the user for confirmation. When this option is set to -a custom function, Org invokes the function with these two -arguments: the source code language and the body of the code block. -The custom function must return either a @code{t} or @code{nil}, which -determines if the user is prompted. Each source code language can -be handled separately through this function argument. -@end defopt - -For example, here is how to execute ditaa code blocks without -prompting: - -@lisp -(defun my-org-confirm-babel-evaluate (lang body) - (not (string= lang "ditaa"))) ;don't ask for ditaa -(setq org-confirm-babel-evaluate #'my-org-confirm-babel-evaluate) -@end lisp - -@item @emph{Following @samp{shell} and @samp{elisp} links} -Org has two link types that can directly evaluate code (see -@ref{External Links}). Because such code is not visible, these links -have a potential risk. Org therefore prompts the user when it -encounters such links. The customization variables are: - -@defopt org-link-shell-confirm-function -Function that prompts the user before executing a shell link. -@end defopt - -@defopt org-link-elisp-confirm-function -Function that prompts the user before executing an Emacs Lisp link. -@end defopt - -@item @emph{Formulas in tables} -Formulas in tables (see @ref{The Spreadsheet}) are code that is evaluated -either by the Calc interpreter, or by the Emacs Lisp interpreter. -@end table - -@node Interaction -@section Interaction with Other Packages - -@cindex packages, interaction with other - -Org's compatibility and the level of interaction with other Emacs -packages are documented here. - -@menu -* Cooperation:: Packages Org cooperates with. -* Conflicts:: Packages that lead to conflicts. -@end menu - -@node Cooperation -@subsection Packages that Org cooperates with - -@table @asis -@item @samp{calc.el} by Dave Gillespie -@cindex @file{calc.el} - -Org uses the Calc package for implementing spreadsheet functionality -in its tables (see @ref{The Spreadsheet}). Org also uses Calc for -embedded calculations. See @ref{Embedded Mode,GNU Emacs Calc Manual,,calc,}. - -@item @samp{constants.el} by Carsten Dominik -@cindex @file{constants.el} -@vindex org-table-formula-constants - -Org can use names for constants in formulas in tables. Org can also -use calculation suffixes for units, such as @samp{M} for @samp{Mega}. For -a standard collection of such constants, install the @samp{constants} -package. Install version 2.0 of this package, available at -@uref{http://www.astro.uva.nl/~dominik/Tools}. Org checks if the function -@code{constants-get} has been autoloaded. Installation instructions are -in the file @samp{constants.el}. - -@item @samp{cdlatex.el} by Carsten Dominik -@cindex @file{cdlatex.el} - -Org mode can make use of the CD@LaTeX{} package to efficiently enter -@LaTeX{} fragments into Org files. See @ref{CD@LaTeX{} mode}. - -@item @samp{imenu.el} by Ake Stenhoff and Lars Lindberg -@cindex @file{imenu.el} - -Imenu creates dynamic menus based on an index of items in a file. -Org mode supports Imenu menus. Enable it with a mode hook as -follows: - -@lisp -(add-hook 'org-mode-hook - (lambda () (imenu-add-to-menubar "Imenu"))) -@end lisp - -@vindex org-imenu-depth -By default the index is two levels deep---you can modify the -depth using the option @code{org-imenu-depth}. - -@item @samp{speedbar.el} by Eric@tie{}M@.@tie{}Ludlam -@cindex @file{speedbar.el} - -Speedbar package creates a special Emacs frame for displaying files -and index items in files. Org mode supports Speedbar; users can -drill into Org files directly from the Speedbar. The @kbd{<} -in the Speedbar frame tweaks the agenda commands to that file or to -a subtree. - -@item @samp{table.el} by Takaaki Ota -@cindex table editor, @file{table.el} -@cindex @file{table.el} - -Complex ASCII tables with automatic line wrapping, column- and -row-spanning, and alignment can be created using the Emacs table -package by Takaaki Ota. Org mode recognizes such tables and exports -them properly. @kbd{C-c '} to edit these tables in a special -buffer, much like Org's code blocks. Because of interference with -other Org mode functionality, Takaaki Ota tables cannot be edited -directly in the Org buffer. - -@table @asis -@item @kbd{C-c '} (@code{org-edit-special}) -@kindex C-c ' -@findex org-edit-special -Edit a @samp{table.el} table. Works when point is in a @samp{table.el} -table. - -@item @kbd{C-c ~} (@code{org-table-create-with-table.el}) -@kindex C-c ~ -@findex org-table-create-with-table.el -Insert a @samp{table.el} table. If there is already a table at point, -this command converts it between the @samp{table.el} format and the Org -mode format. See the documentation string of the command -@code{org-convert-table} for the restrictions under which this is -possible. -@end table -@end table - -@node Conflicts -@subsection Packages that conflict with Org mode - -@cindex shift-selection -@vindex org-support-shift-select -In Emacs, shift-selection combines motions of point with shift key to -enlarge regions. Emacs sets this mode by default. This conflicts -with Org's use of @kbd{S-<cursor>} commands to change timestamps, -TODO keywords, priorities, and item bullet types, etc. Since -@kbd{S-<cursor>} commands outside of specific contexts do not do -anything, Org offers the variable @code{org-support-shift-select} for -customization. Org mode accommodates shift selection by (i) making it -available outside of the special contexts where special commands -apply, and (ii) extending an existing active region even if point -moves across a special context. - -@table @asis -@item @samp{cua.el} by Kim@tie{}F@.@tie{}Storm -@cindex @file{cua.el} -@vindex org-replace-disputed-keys -Org key bindings conflict with @kbd{S-<cursor>} keys used by -CUA mode. For Org to relinquish these bindings to CUA mode, -configure the variable @code{org-replace-disputed-keys}. When set, Org -moves the following key bindings in Org files, and in the agenda -buffer---but not during date selection. - -@multitable @columnfractions 0.4 0.4 -@item @kbd{S-@key{UP}} @result{} @kbd{M-p} -@tab @kbd{S-@key{DOWN}} @result{} @kbd{M-n} -@item @kbd{S-@key{LEFT}} @result{} @kbd{M--} -@tab @kbd{S-@key{RIGHT}} @result{} @kbd{M-+} -@item @kbd{C-S-@key{LEFT}} @result{} @kbd{M-S--} -@tab @kbd{C-S-@key{RIGHT}} @result{} @kbd{M-S-+} -@end multitable - -@vindex org-disputed-keys -Yes, these are unfortunately more difficult to remember. If you -want to have other replacement keys, look at the variable -@code{org-disputed-keys}. - -@item @samp{ecomplete.el} by Lars Magne Ingebrigtsen -@cindex @file{ecomplete.el} -Ecomplete provides ``electric'' address completion in address header -lines in message buffers. Sadly Orgtbl mode cuts Ecomplete's power -supply: no completion happens when Orgtbl mode is enabled in message -buffers while entering text in address header lines. If one wants -to use ecomplete one should @emph{not} follow the advice to automagically -turn on Orgtbl mode in message buffers (see @ref{Orgtbl Mode}), -but instead---after filling in the message headers---turn on Orgtbl -mode manually when needed in the messages body. - -@item @samp{filladapt.el} by Kyle Jones -@cindex @file{filladapt.el} -Org mode tries to do the right thing when filling paragraphs, list -items and other elements. Many users reported problems using both -@samp{filladapt.el} and Org mode, so a safe thing to do is to disable -filladapt like this: - -@lisp -(add-hook 'org-mode-hook 'turn-off-filladapt-mode) -@end lisp - -@item @samp{viper.el} by Michael Kifer -@cindex @file{viper.el} -@kindex C-c / - -Viper uses @kbd{C-c /} and therefore makes this key not access -the corresponding Org mode command @code{org-sparse-tree}. You need to -find another key for this command, or override the key in -@code{viper-vi-global-user-map} with - -@lisp -(define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree) -@end lisp - -@item @samp{windmove.el} by Hovav Shacham -@cindex @file{windmove.el} - -This package also uses the @kbd{S-<cursor>} keys, so everything -written in the paragraph above about CUA mode also applies here. If -you want to make the windmove function active in locations where Org -mode does not have special functionality on @kbd{S-<cursor>}, -add this to your configuration: - -@lisp -;; Make windmove work in Org mode: -(add-hook 'org-shiftup-final-hook 'windmove-up) -(add-hook 'org-shiftleft-final-hook 'windmove-left) -(add-hook 'org-shiftdown-final-hook 'windmove-down) -(add-hook 'org-shiftright-final-hook 'windmove-right) -@end lisp - -@item @samp{yasnippet.el} -@cindex @file{yasnippet.el} -The way Org mode binds the @kbd{@key{TAB}} key (binding to @code{[tab]} -instead of @code{"\t"}) overrules YASnippet's access to this key. The -following code fixed this problem: - -@lisp -(add-hook 'org-mode-hook - (lambda () - (setq-local yas/trigger-key [tab]) - (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand))) -@end lisp - -The latest version of YASnippet does not play well with Org mode. -If the above code does not fix the conflict, start by defining -the following function: - -@lisp -(defun yas/org-very-safe-expand () - (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) -@end lisp - -Then, tell Org mode to use that function: - -@lisp -(add-hook 'org-mode-hook - (lambda () - (make-variable-buffer-local 'yas/trigger-key) - (setq yas/trigger-key [tab]) - (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand) - (define-key yas/keymap [tab] 'yas/next-field))) -@end lisp -@end table - -@node TTY Keys -@section Using Org on a TTY - -@cindex tty key bindings - -Org provides alternative key bindings for TTY and modern mobile -devices that cannot perform movement commands on point and key -bindings with modifier keys. Some of these workarounds may be more -cumbersome than necessary. Users should look into customizing these -further based on their usage needs. For example, the normal -@kbd{S-<cursor>} for editing timestamp might be better with -@kbd{C-c .} chord. - -@multitable @columnfractions 0.2 0.28 0.15 0.21 -@headitem Default -@tab Alternative 1 -@tab Speed key -@tab Alternative 2 -@item @kbd{S-@key{TAB}} -@tab @kbd{C-u @key{TAB}} -@tab @kbd{C} -@tab -@item @kbd{M-@key{LEFT}} -@tab @kbd{C-c C-x l} -@tab @kbd{l} -@tab @kbd{Esc @key{LEFT}} -@item @kbd{M-S-@key{LEFT}} -@tab @kbd{C-c C-x L} -@tab @kbd{L} -@tab -@item @kbd{M-@key{RIGHT}} -@tab @kbd{C-c C-x r} -@tab @kbd{r} -@tab @kbd{Esc @key{RIGHT}} -@item @kbd{M-S-@key{RIGHT}} -@tab @kbd{C-c C-x R} -@tab @kbd{R} -@tab -@item @kbd{M-@key{UP}} -@tab @kbd{C-c C-x u} -@tab -@tab @kbd{Esc @key{UP}} -@item @kbd{M-S-@key{UP}} -@tab @kbd{C-c C-x U} -@tab @kbd{U} -@tab -@item @kbd{M-@key{DOWN}} -@tab @kbd{C-c C-x d} -@tab -@tab @kbd{Esc @key{DOWN}} -@item @kbd{M-S-@key{DOWN}} -@tab @kbd{C-c C-x D} -@tab @kbd{D} -@tab -@item @kbd{S-@key{RET}} -@tab @kbd{C-c C-x c} -@tab -@tab -@item @kbd{M-@key{RET}} -@tab @kbd{C-c C-x m} -@tab -@tab @kbd{Esc @key{RET}} -@item @kbd{M-S-@key{RET}} -@tab @kbd{C-c C-x M} -@tab -@tab -@item @kbd{S-@key{LEFT}} -@tab @kbd{C-c @key{LEFT}} -@tab -@tab -@item @kbd{S-@key{RIGHT}} -@tab @kbd{C-c @key{RIGHT}} -@tab -@tab -@item @kbd{S-@key{UP}} -@tab @kbd{C-c @key{UP}} -@tab -@tab -@item @kbd{S-@key{DOWN}} -@tab @kbd{C-c @key{DOWN}} -@tab -@tab -@item @kbd{C-S-@key{LEFT}} -@tab @kbd{C-c C-x @key{LEFT}} -@tab -@tab -@item @kbd{C-S-@key{RIGHT}} -@tab @kbd{C-c C-x @key{RIGHT}} -@tab -@tab -@end multitable - -@node Protocols -@section Protocols for External Access - -@cindex protocols, for external access - -Org protocol is a tool to trigger custom actions in Emacs from -external applications. Any application that supports calling external -programs with an URL as argument may be used with this functionality. -For example, you can configure bookmarks in your web browser to send a -link to the current page to Org and create a note from it using -capture (see @ref{Capture}). You can also create a bookmark that tells -Emacs to open the local source file of a remote website you are -browsing. - -@cindex Org protocol, set-up -@cindex Installing Org protocol -In order to use Org protocol from an application, you need to register -@samp{org-protocol://} as a valid scheme-handler. External calls are -passed to Emacs through the @samp{emacsclient} command, so you also need to -ensure an Emacs server is running. More precisely, when the -application calls - -@example -emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2 -@end example - - -@noindent -Emacs calls the handler associated to @var{PROTOCOL} with -argument @samp{(:key1 val1 :key2 val2)}. - -@cindex protocol, new protocol -@cindex defining new protocols -Org protocol comes with three predefined protocols, detailed in the -following sections. Configure @code{org-protocol-protocol-alist} to define -your own. - -@menu -* The @code{store-link} protocol:: Store a link, push URL to kill-ring. -* The @code{capture} protocol:: Fill a buffer with external information. -* The @code{open-source} protocol:: Edit published contents. -@end menu - -@node The @code{store-link} protocol -@subsection The @code{store-link} protocol - -@cindex store-link protocol -@cindex protocol, store-link - -Using the @code{store-link} handler, you can copy links, to that they can -be inserted using @kbd{M-x org-insert-link} or yanking. More -precisely, the command - -@example -emacsclient org-protocol://store-link?url=URL&title=TITLE -@end example - - -@noindent -stores the following link: - -@example -[[URL][TITLE]] -@end example - - -In addition, @var{URL} is pushed on the kill-ring for yanking. -You need to encode @var{URL} and @var{TITLE} if they contain -slashes, and probably quote those for the shell. - -To use this feature from a browser, add a bookmark with an arbitrary -name, e.g., @samp{Org: store-link} and enter this as @emph{Location}: - -@example -javascript:location.href='org-protocol://store-link?url='+ - encodeURIComponent(location.href); -@end example - -@node The @code{capture} protocol -@subsection The @code{capture} protocol - -@cindex capture protocol -@cindex protocol, capture - -Activating the ``capture'' handler pops up a @samp{Capture} buffer in Emacs, -using acapture template. - -@example -emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY -@end example - - -To use this feature, add a bookmark with an arbitrary name, e.g., -@samp{Org: capture}, and enter this as @samp{Location}: - -@example -javascript:location.href='org-protocol://capture?template=x'+ - '&url='+encodeURIComponent(window.location.href)+ - '&title='+encodeURIComponent(document.title)+ - '&body='+encodeURIComponent(window.getSelection()); -@end example - -@vindex org-protocol-default-template-key -The capture template to be used can be specified in the bookmark (like -@samp{X} above). If unspecified, the template key is set in the variable -@code{org-protocol-default-template-key}. The following template -placeholders are available: - -@example -%:link The URL -%:description The webpage title -%:annotation Equivalent to [[%:link][%:description]] -%i The selected text -@end example - -@node The @code{open-source} protocol -@subsection The @code{open-source} protocol - -@cindex open-source protocol -@cindex protocol, open-source - -The @code{open-source} handler is designed to help with editing local -sources when reading a document. To that effect, you can use -a bookmark with the following location: - -@example -javascript:location.href='org-protocol://open-source?&url='+ - encodeURIComponent(location.href) -@end example - -@vindex org-protocol-project-alist -The variable @code{org-protocol-project-alist} maps URLs to local file -names, by stripping URL parameters from the end and replacing the -@code{:base-url} with @code{:working-directory} and @code{:online-suffix} with -@code{:working-suffix}. For example, assuming you own a local copy of -@samp{https://orgmode.org/worg/} contents at @samp{/home/user/worg}, you can set -@code{org-protocol-project-alist} to the following - -@lisp -(setq org-protocol-project-alist - '(("Worg" - :base-url "https://orgmode.org/worg/" - :working-directory "/home/user/worg/" - :online-suffix ".html" - :working-suffix ".org"))) -@end lisp - -@noindent -If you are now browsing -@samp{https://orgmode.org/worg/org-contrib/org-protocol.html} and find -a typo or have an idea about how to enhance the documentation, simply -click the bookmark and start editing. - -@cindex rewritten URL in open-source protocol -@cindex protocol, open-source rewritten URL -However, such mapping may not always yield the desired results. -Suppose you maintain an online store located at @samp{http://example.com/}. -The local sources reside in @samp{/home/user/example/}. It is common -practice to serve all products in such a store through one file and -rewrite URLs that do not match an existing file on the server. That -way, a request to @samp{http://example.com/print/posters.html} might be -rewritten on the server to something like -@samp{http://example.com/shop/products.php/posters.html.php}. The -@code{open-source} handler probably cannot find a file named -@samp{/home/user/example/print/posters.html.php} and fails. - -Such an entry in @code{org-protocol-project-alist} may hold an additional -property @code{:rewrites}. This property is a list of cons cells, each of -which maps a regular expression to a path relative to the -@code{:working-directory}. - -Now map the URL to the path @samp{/home/user/example/products.php} by -adding @code{:rewrites} rules like this: - -@lisp -(setq org-protocol-project-alist - '(("example.com" - :base-url "http://example.com/" - :working-directory "/home/user/example/" - :online-suffix ".php" - :working-suffix ".php" - :rewrites (("example.com/print/" . "products.php") - ("example.com/$" . "index.php"))))) -@end lisp - -@noindent -Since @samp{example.com/$} is used as a regular expression, it maps -@samp{http://example.com/}, @samp{https://example.com}, -@samp{http://www.example.com/} and similar to -@samp{/home/user/example/index.php}. - -The @code{:rewrites} rules are searched as a last resort if and only if no -existing file name is matched. - -@cindex protocol, open-source, set-up mapping -@cindex mappings in open-source protocol -@findex org-protocol-create -@findex org-protocol-create-for-org -Two functions can help you filling @code{org-protocol-project-alist} with -valid contents: @code{org-protocol-create} and -@code{org-protocol-create-for-org}. The latter is of use if you're editing -an Org file that is part of a publishing project. - -@node Org Crypt -@section Org Crypt - -Org Crypt encrypts the text of an entry, but not the headline, or -properties. Behind the scene, it uses the Emacs EasyPG library to -encrypt and decrypt files. - -@vindex org-crypt-tag-matcher -Any text below a headline that has a @samp{crypt} tag is automatically -encrypted when the file is saved. To use a different tag, customize -the @code{org-crypt-tag-matcher} setting. - -Here is a suggestion for Org Crypt settings in Emacs init file: - -@lisp -(require 'org-crypt) -(org-crypt-use-before-save-magic) -(setq org-tags-exclude-from-inheritance '("crypt")) - -(setq org-crypt-key nil) -;; GPG key to use for encryption -;; Either the Key ID or set to nil to use symmetric encryption. - -(setq auto-save-default nil) -;; Auto-saving does not cooperate with org-crypt.el: so you need to -;; turn it off if you plan to use org-crypt.el quite often. Otherwise, -;; you'll get an (annoying) message each time you start Org. - -;; To turn it off only locally, you can insert this: -;; -;; # -*- buffer-auto-save-file-name: nil; -*- -@end lisp - -It's possible to use different keys for different headings by -specifying the respective key as property @samp{CRYPTKEY}, e.g.: - -@example -* Totally secret :crypt: - :PROPERTIES: - :CRYPTKEY: 0x0123456789012345678901234567890123456789 - :END: -@end example - -Excluding the @samp{crypt} tag from inheritance prevents already encrypted -text from being encrypted again. - -@node Org Mobile -@section Org Mobile - -@cindex smartphone - -Org Mobile is a protocol for synchronizing Org files between Emacs and -other applications, e.g., on mobile devices. It enables offline-views -and capture support for an Org mode system that is rooted on a ``real'' -computer. The external application can also record changes to -existing entries. - -This appendix describes Org's support for agenda view formats -compatible with Org Mobile. It also describes synchronizing changes, -such as to notes, between the mobile application and the computer. - -To change tags and TODO states in the mobile application, first -customize the variables @code{org-todo-keywords}, @code{org-tag-alist} and -@code{org-tag-persistent-alist}. These should cover all the important tags -and TODO keywords, even if Org files use only some of them. Though -the mobile application is expected to support in-buffer settings, it -is required to understand TODO states @emph{sets} (see @ref{Per-file keywords}) and @emph{mutually exclusive} tags (see @ref{Setting Tags}) only for those set in these variables. - -@menu -* Setting up the staging area:: For the mobile device. -* Pushing to the mobile application:: Uploading Org files and agendas. -* Pulling from the mobile application:: Integrating captured and flagged items. -@end menu - -@node Setting up the staging area -@subsection Setting up the staging area - -@vindex org-mobile-directory -The mobile application needs access to a file directory on -a server@footnote{For a server to host files, consider using a WebDAV server, -such as @uref{https://nextcloud.com, Nextcloud}. Additional help is at this @uref{https://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.} to interact with Emacs. Pass its location through -the @code{org-mobile-directory} variable. If you can mount that directory -locally just set the variable to point to that directory: - -@lisp -(setq org-mobile-directory "~/orgmobile/") -@end lisp - -Alternatively, by using TRAMP (see @ref{Top,TRAMP User Manual,,tramp,}), -@code{org-mobile-directory} may point to a remote directory accessible -through, for example, SSH, SCP, or DAVS: - -@lisp -(setq org-mobile-directory "/davs:user@@remote.host:/org/webdav/") -@end lisp - -@vindex org-mobile-encryption -With a public server, consider encrypting the files. Org also -requires OpenSSL installed on the local computer. To turn on -encryption, set the same password in the mobile application and in -Emacs. Set the password in the variable -@code{org-mobile-use-encryption}@footnote{If Emacs is configured for safe storing of passwords, then -configure the variable @code{org-mobile-encryption-password}; please read -the docstring of that variable.}. Note that even after the mobile -application encrypts the file contents, the file name remains visible -on the file systems of the local computer, the server, and the mobile -device. - -@node Pushing to the mobile application -@subsection Pushing to the mobile application - -@findex org-mobile-push -@vindex org-mobile-files -The command @code{org-mobile-push} copies files listed in -@code{org-mobile-files} into the staging area. Files include agenda files -(as listed in @code{org-agenda-files}). Customize @code{org-mobile-files} to -add other files. File names are staged with paths relative to -@code{org-directory}, so all files should be inside this directory@footnote{Symbolic links in @code{org-directory} need to have the same name -as their targets.}. - -Push creates a special Org file @samp{agendas.org} with custom agenda views -defined by the user@footnote{While creating the agendas, Org mode forces @samp{ID} properties -on all referenced entries, so that these entries can be uniquely -identified if Org Mobile flags them for further action. To avoid -setting properties configure the variable -@code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode then relies -on outline paths, assuming they are unique.}. - -Finally, Org writes the file @samp{index.org}, containing links to other -files. The mobile application reads this file first from the server -to determine what other files to download for agendas. For faster -downloads, it is expected to only read files whose checksums@footnote{Checksums are stored automatically in the file -@samp{checksums.dat}.} -have changed. - -@node Pulling from the mobile application -@subsection Pulling from the mobile application - -@findex org-mobile-pull -The command @code{org-mobile-pull} synchronizes changes with the server. -More specifically, it first pulls the Org files for viewing. It then -appends captured entries and pointers to flagged or changed entries to -the file @samp{mobileorg.org} on the server. Org ultimately integrates its -data in an inbox file format, through the following steps: - -@enumerate -@item -@vindex org-mobile-inbox-for-pull -Org moves all entries found in @samp{mobileorg.org}@footnote{The file will be empty after this operation.} and appends -them to the file pointed to by the variable -@code{org-mobile-inbox-for-pull}. It should reside neither in the -staging area nor on the server. Each captured entry and each -editing event is a top-level entry in the inbox file. - -@item -@cindex @samp{FLAGGED}, tag -After moving the entries, Org processes changes to the shared -files. Some of them are applied directly and without user -interaction. Examples include changes to tags, TODO state, -headline and body text. Entries requiring further action are -tagged as @samp{FLAGGED}. Org marks entries with problems with an error -message in the inbox. They have to be resolved manually. - -@item -Org generates an agenda view for flagged entries for user -intervention to clean up. For notes stored in flagged entries, Org -displays them in the echo area when point is on the corresponding -agenda item. - -@table @asis -@item @kbd{?} -Pressing @kbd{?} displays the entire flagged note in another -window. Org also pushes it to the kill ring. To store flagged -note as a normal note, use @kbd{? z C-y C-c C-c}. Pressing -@kbd{?} twice does these things: first it removes the -@samp{FLAGGED} tag; second, it removes the flagged note from the -property drawer; third, it signals that manual editing of the -flagged entry is now finished. -@end table -@end enumerate - -@kindex ? @r{(Agenda dispatcher)} -From the agenda dispatcher, @kbd{?} returns to the view to finish -processing flagged entries. Note that these entries may not be the -most recent since the mobile application searches files that were last -pulled. To get an updated agenda view with changes since the last -pull, pull again. - -@node Hacking -@appendix Hacking - -@cindex hacking - -This appendix describes some ways a user can extend the functionality -of Org. - -@menu -* Hooks: Hooks (2). How to reach into Org's internals. -* Add-on Packages:: Available extensions. -* Adding Hyperlink Types:: New custom link types. -* Adding Export Back-ends:: How to write new export back-ends. -* Tables in Arbitrary Syntax:: Orgtbl for LaTeX and other programs. -* Dynamic Blocks:: Automatically filled blocks. -* Special Agenda Views:: Customized views. -* Speeding Up Your Agendas:: Tips on how to speed up your agendas. -* Extracting Agenda Information:: Post-processing agenda information. -* Using the Property API:: Writing programs that use entry properties. -* Using the Mapping API:: Mapping over all or selected entries. -@end menu - -@node Hooks (2) -@appendixsec Hooks - -@cindex hooks - -Org has a large number of hook variables for adding functionality. -This appendix illustrates using a few. A complete list of hooks with -documentation is maintained by the Worg project at -@uref{https://orgmode.org/worg/doc.html#hooks}. - -@node Add-on Packages -@appendixsec Add-on Packages - -@cindex add-on packages - -Various authors wrote a large number of add-on packages for Org. - -These packages are not part of Emacs, but they are distributed as -contributed packages with the separate release available at -@uref{https://orgmode.org}. See the @samp{contrib/README} file in the source code -directory for a list of contributed files. Worg page with more -information is at: @uref{https://orgmode.org/worg/org-contrib/}. - -@node Adding Hyperlink Types -@appendixsec Adding Hyperlink Types - -@cindex hyperlinks, adding new types - -Org has many built-in hyperlink types (see @ref{Hyperlinks}), and an -interface for adding new link types. The following example shows the -process of adding Org links to Unix man pages, which look like this - -@example -[[man:printf][The printf manual]] -@end example - - -@noindent -The following @samp{ol-man.el} file implements it - -@lisp -;;; ol-man.el - Support for links to man pages in Org mode -(require 'ol) - -(org-link-set-parameters "man" - :follow #'org-man-open - :export #'org-man-export - :store #'org-man-store-link) - -(defcustom org-man-command 'man - "The Emacs command to be used to display a man page." - :group 'org-link - :type '(choice (const man) (const woman))) - -(defun org-man-open (path _) - "Visit the manpage on PATH. -PATH should be a topic that can be thrown at the man command." - (funcall org-man-command path)) - -(defun org-man-store-link () - "Store a link to a man page." - (when (memq major-mode '(Man-mode woman-mode)) - ;; This is a man page, we do make this link. - (let* ((page (org-man-get-page-name)) - (link (concat "man:" page)) - (description (format "Man page for %s" page))) - (org-link-store-props - :type "man" - :link link - :description description)))) - -(defun org-man-get-page-name () - "Extract the page name from the buffer name." - ;; This works for both `Man-mode' and `woman-mode'. - (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) - (match-string 1 (buffer-name)) - (error "Cannot create link to this man page"))) - -(defun org-man-export (link description format _) - "Export a man page link from Org files." - (let ((path (format "http://man.he.net/?topic=%s§ion=all" link)) - (desc (or description link))) - (pcase format - (`html (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc)) - (`latex (format "\\href@{%s@}@{%s@}" path desc)) - (`texinfo (format "@@uref@{%s,%s@}" path desc)) - (`ascii (format "%s (%s)" desc path)) - (t path)))) - -(provide ol-man) -;;; ol-man.el ends here -@end lisp - -@noindent -To activate links to man pages in Org, enter this in the Emacs init -file: - -@lisp -(require 'ol-man) -@end lisp - -@noindent -A review of @samp{ol-man.el}: - -@enumerate -@item -First, @samp{(require 'ol)} ensures that @samp{ol.el} is loaded. - -@item -@findex org-link-set-parameters -@vindex org-link-parameters -Then @code{org-link-set-parameters} defines a new link type with @samp{man} -prefix and associates functions for following, exporting and -storing such links. See the variable @code{org-link-parameters} for -a complete list of possible associations. - -@item -The rest of the file implements necessary variables and functions. - -For example, @code{org-man-store-link} is responsible for storing a link -when @code{org-store-link} (see @ref{Handling Links}) is called from a buffer -displaying a man page. It first checks if the major mode is -appropriate. If check fails, the function returns @code{nil}, which -means it isn't responsible for creating a link to the current -buffer. Otherwise the function makes a link string by combining -the @samp{man:} prefix with the man topic. It also provides a default -description. The function @code{org-insert-link} can insert it back -into an Org buffer later on. -@end enumerate - -@node Adding Export Back-ends -@appendixsec Adding Export Back-ends - -@cindex Export, writing back-ends - -Org's export engine makes it easy for writing new back-ends. The -framework on which the engine was built makes it easy to derive new -back-ends from existing ones. - -@findex org-export-define-backend -@findex org-export-define-derived-backend -The two main entry points to the export engine are: -@code{org-export-define-backend} and @code{org-export-define-derived-backend}. -To grok these functions, see @samp{ox-latex.el} for an example of defining -a new back-end from scratch, and @samp{ox-beamer.el} for an example of -deriving from an existing engine. - -For creating a new back-end from scratch, first set its name as -a symbol in an alist consisting of elements and export functions. To -make the back-end visible to the export dispatcher, set @code{:menu-entry} -keyword. For export options specific to this back-end, set the -@code{:options-alist}. - -For creating a new back-end from an existing one, set -@code{:translate-alist} to an alist of export functions. This alist -replaces the parent back-end functions. - -For complete documentation, see @uref{https://orgmode.org/worg/dev/org-export-reference.html, the Org Export Reference on Worg}. - -@node Tables in Arbitrary Syntax -@appendixsec Tables in Arbitrary Syntax - -@cindex tables, in other modes -@cindex lists, in other modes -@cindex Orgtbl mode - -Due to Org's success in handling tables with Orgtbl, a frequently -requested feature is the use of Org's table functions in other modes, -e.g., @LaTeX{}. This would be hard to do in a general way without -complicated customization nightmares. Moreover, that would take Org -away from its simplicity roots that Orgtbl has proven. There is, -however, an alternate approach to accomplishing the same. - -This approach involves implementing a custom @emph{translate} function that -operates on a native Org @emph{source table} to produce a table in another -format. This strategy would keep the excellently working Orgtbl -simple and isolate complications, if any, confined to the translate -function. To add more alien table formats, we just add more translate -functions. Also the burden of developing custom translate functions -for new table formats is in the hands of those who know those formats -best. - -@menu -* Radio tables:: Sending and receiving radio tables. -* A @LaTeX{} example:: Step by step, almost a tutorial. -* Translator functions:: Copy and modify. -@end menu - -@node Radio tables -@appendixsubsec Radio tables - -@cindex radio tables - -Radio tables are target locations for translated tables that are not near -their source. Org finds the target location and inserts the translated -table. - -The key to finding the target location is the magic words @samp{BEGIN/END -RECEIVE ORGTBL}. They have to appear as comments in the current mode. -If the mode is C, then: - -@example -/* BEGIN RECEIVE ORGTBL table_name */ -/* END RECEIVE ORGTBL table_name */ -@end example - -At the location of source, Org needs a special line to direct Orgtbl -to translate and to find the target for inserting the translated -table. For example: - -@cindex @samp{ORGTBL}, keyword -@example -#+ORGTBL: SEND table_name translation_function arguments ... -@end example - - -@noindent -@samp{table_name} is the table's reference name, which is also used in the -receiver lines, and the @samp{translation_function} is the Lisp function -that translates. This line, in addition, may also contain alternating -key and value arguments at the end. The translation function gets -these values as a property list. A few standard parameters are -already recognized and acted upon before the translation function is -called: - -@table @asis -@item @samp{:skip N} -Skip the first N lines of the table. Hlines do count; include them -if they are to be skipped. - -@item @samp{:skipcols (n1 n2 ...)} -List of columns to be skipped. First Org automatically discards -columns with calculation marks and then sends the table to the -translator function, which then skips columns as specified in -@samp{skipcols}. -@end table - -To keep the source table intact in the buffer without being disturbed -when the source file is compiled or otherwise being worked on, use one -of these strategies: - -@itemize -@item -Place the table in a block comment. For example, in C mode you -could wrap the table between @samp{/*} and @samp{*/} lines. - -@item -Put the table after an ``end'' statement. For example @code{\bye} in @TeX{} -and @code{\end@{document@}} in @LaTeX{}. - -@item -Comment and un-comment each line of the table during edits. The -@kbd{M-x orgtbl-toggle-comment} command makes toggling easy. -@end itemize - -@node A @LaTeX{} example -@appendixsubsec A @LaTeX{} example of radio tables - -@cindex @LaTeX{}, and Orgtbl mode - -To wrap a source table in @LaTeX{}, use the @samp{comment} environment -provided by @samp{comment.sty}@footnote{@uref{https://www.ctan.org/pkg/comment}}. To activate it, put -@code{\usepackage@{comment@}} in the document header. Orgtbl mode inserts -a radio table skeleton@footnote{By default this works only for @LaTeX{}, HTML, and Texinfo. -Configure the variable @code{orgtbl-radio-table-templates} to install -templates for other modes.} with the command @kbd{M-x orgtbl-insert-radio-table}, which prompts for a table name. For -example, if @samp{salesfigures} is the name, the template inserts: - -@example -% BEGIN RECEIVE ORGTBL salesfigures -% END RECEIVE ORGTBL salesfigures -\begin@{comment@} -#+ORGTBL: SEND salesfigures orgtbl-to-latex -| | | -\end@{comment@} -@end example - -@vindex LaTeX-verbatim-environments -@noindent -The line @samp{#+ORGTBL: SEND} tells Orgtbl mode to use the function -@code{orgtbl-to-latex} to convert the table to @LaTeX{} format, then insert -the table at the target (receive) location named @samp{salesfigures}. Now -the table is ready for data entry. It can even use spreadsheet -features@footnote{If the @samp{TBLFM} keyword contains an odd number of dollar -characters, this may cause problems with Font Lock in @LaTeX{} mode. As -shown in the example you can fix this by adding an extra line inside -the @samp{comment} environment that is used to balance the dollar -expressions. If you are using AUC@TeX{} with the font-latex library, -a much better solution is to add the @samp{comment} environment to the -variable @code{LaTeX-verbatim-environments}.}: - -@example -% BEGIN RECEIVE ORGTBL salesfigures -% END RECEIVE ORGTBL salesfigures -\begin@{comment@} -#+ORGTBL: SEND salesfigures orgtbl-to-latex -| Month | Days | Nr sold | per day | -|-------+------+---------+---------| -| Jan | 23 | 55 | 2.4 | -| Feb | 21 | 16 | 0.8 | -| March | 22 | 278 | 12.6 | -#+TBLFM: $4=$3/$2;%.1f -% $ (optional extra dollar to keep Font Lock happy, see footnote) -\end@{comment@} -@end example - -After editing, @kbd{C-c C-c} inserts the translated table at the -target location, between the two marker lines. - -For hand-made custom tables, note that the translator needs to skip -the first two lines of the source table. Also the command has to -@emph{splice} out the target table without the header and footer. - -@example -\begin@{tabular@}@{lrrr@} -Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ -% BEGIN RECEIVE ORGTBL salesfigures -% END RECEIVE ORGTBL salesfigures -\end@{tabular@} -% -\begin@{comment@} -#+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 -| Month | Days | Nr sold | per day | -|-------+------+---------+---------| -| Jan | 23 | 55 | 2.4 | -| Feb | 21 | 16 | 0.8 | -| March | 22 | 278 | 12.6 | -#+TBLFM: $4=$3/$2;%.1f -\end@{comment@} -@end example - -The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of -Orgtbl mode and uses a @samp{tabular} environment to typeset the table and -marks horizontal lines with @code{\hline}. For additional parameters to -control output, see @ref{Translator functions}: - -@table @asis -@item @samp{:splice BOOLEAN} -When @{@{@{var(BOOLEAN@}@}@} is non-@code{nil}, return only table body lines; -i.e., not wrapped in @samp{tabular} environment. Default is @code{nil}. - -@item @samp{:fmt FMT} -Format string to warp each field. It should contain @samp{%s} for the -original field value. For example, to wrap each field value in -dollar symbol, you could use @samp{:fmt "$%s$"}. Format can also wrap -a property list with column numbers and formats, for example @samp{:fmt - (2 "$%s$" 4 "%s\\%%")}. In place of a string, a function of one -argument can be used; the function must return a formatted string. - -@item @samp{:efmt EFMT} -Format numbers as exponentials. The spec should have @samp{%s} twice for -inserting mantissa and exponent, for example @samp{"%s\\times10^@{%s@}"}. This -may also be a property list with column numbers and formats, for -example @samp{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After -@var{EFMT} has been applied to a value, @var{FMT}---see -above---is also applied. Functions with two arguments can be -supplied instead of strings. By default, no special formatting is -applied. -@end table - -@node Translator functions -@appendixsubsec Translator functions - -@cindex HTML, and Orgtbl mode -@cindex translator function - -@findex orgtbl-to-csv -@findex orgtbl-to-tsv -@findex orgtbl-to-latex -@findex orgtbl-to-html -@findex orgtbl-to-texinfo -@findex orgtbl-to-unicode -@findex orgtbl-to-orgtbl -@findex orgtbl-to-generic -Orgtbl mode has built-in translator functions: @code{orgtbl-to-csv} -(comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values), -@code{orgtbl-to-latex}, @code{orgtbl-to-html}, @code{orgtbl-to-texinfo}, -@code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. They use the generic -translator, @code{orgtbl-to-generic}, which delegates translations to -various export back-ends. - -Properties passed to the function through the @samp{ORGTBL SEND} line take -precedence over properties defined inside the function. For example, -this overrides the default @LaTeX{} line endings, @code{\\}, with @code{\\[2mm]}: - -@example -#+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" -@end example - - -For a new language translator, define a converter function. It can be -a generic function, such as shown in this example. It marks -a beginning and ending of a table with @samp{!BTBL!} and @samp{!ETBL!}; -a beginning and ending of lines with @samp{!BL!} and @samp{!EL!}; and uses a TAB -for a field separator: - -@lisp -(defun orgtbl-to-language (table params) - "Convert the orgtbl-mode TABLE to language." - (orgtbl-to-generic - table - (org-combine-plists - '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t") - params))) -@end lisp - -@noindent -The documentation for the @code{orgtbl-to-generic} function shows -a complete list of parameters, each of which can be passed through to -@code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function using -that generic function. - -For complicated translations the generic translator function could be -replaced by a custom translator function. Such a custom function must -take two arguments and return a single string containing the formatted -table. The first argument is the table whose lines are a list of -fields or the symbol @code{hline}. The second argument is the property -list consisting of parameters specified in the @samp{#+ORGTBL: SEND} line. -Please share your translator functions by posting them to the Org -users mailing list, at @email{emacs-orgmode@@gnu.org}. - -@node Dynamic Blocks -@appendixsec Dynamic Blocks - -@cindex dynamic blocks - -Org supports @emph{dynamic blocks} in Org documents. They are inserted -with begin and end markers like any other code block, but the contents -are updated automatically by a user function. - -@kindex C-c C-x x -@findex org-dynamic-block-insert-dblock -You can insert a dynamic block with @code{org-dynamic-block-insert-dblock}, -which is bound to @kbd{C-c C-x x} by default. For example, -@kbd{C-c C-x x c l o c k t a b l e @key{RET}} inserts a table that -updates the work time (see @ref{Clocking Work Time}). - -Dynamic blocks can have names and function parameters. The syntax is -similar to source code block specifications: - -@example -#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... - ... -#+END: -@end example - -These commands update dynamic blocks: - -@table @asis -@item @kbd{C-c C-x C-u} (@code{org-dblock-update}) -@kindex C-c C-x C-u -@findex org-dblock-update -Update dynamic block at point. - -@item @kbd{C-u C-c C-x C-u} -@kindex C-u C-c C-x C-u -Update all dynamic blocks in the current file. -@end table - -Before updating a dynamic block, Org removes content between the -@samp{BEGIN} and @samp{END} markers. Org then reads the parameters on the -@samp{BEGIN} line for passing to the writer function as a plist. The -previous content of the dynamic block becomes erased from the buffer -and appended to the plist under @code{:content}. - -The syntax for naming a writer function with a dynamic block labeled -@samp{myblock} is: @code{org-dblock-write:myblock}. - -The following is an example of a dynamic block and a block writer function -that updates the time when the function was last run: - -@example -#+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" - ... -#+END: -@end example - -@noindent -The dynamic block's writer function: - -@lisp -(defun org-dblock-write:block-update-time (params) - (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) - (insert "Last block update at: " - (format-time-string fmt)))) -@end lisp - -To keep dynamic blocks up-to-date in an Org file, use the function, -@code{org-update-all-dblocks} in hook, such as @code{before-save-hook}. The -@code{org-update-all-dblocks} function does not run if the file is not in -Org mode. - -@findex org-narrow-to-block -Dynamic blocks, like any other block, can be narrowed with -@code{org-narrow-to-block}. - -@node Special Agenda Views -@appendixsec Special Agenda Views - -@cindex agenda views, user-defined - -@vindex org-agenda-skip-function -@vindex org-agenda-skip-function-global -Org provides a special hook to further limit items in agenda views: -@code{agenda}, @code{agenda*}@footnote{The @code{agenda*} view is the same as @code{agenda} except that it -only considers @emph{appointments}, i.e., scheduled and deadline items that -have a time specification @samp{[h]h:mm} in their time-stamps.}, @code{todo}, @code{alltodo}, @code{tags}, @code{tags-todo}, -@code{tags-tree}. Specify a custom function that tests inclusion of every -matched item in the view. This function can also skip as much as is -needed. - -For a global condition applicable to agenda views, use the -@code{org-agenda-skip-function-global} variable. Org uses a global -condition with @code{org-agenda-skip-function} for custom searching. - -This example defines a function for a custom view showing TODO items -with @samp{waiting} status. Manually this is a multi-step search process, -but with a custom view, this can be automated as follows: - -The custom function searches the subtree for the @samp{waiting} tag and -returns @code{nil} on match. Otherwise it gives the location from where -the search continues. - -@lisp -(defun my-skip-unless-waiting () - "Skip trees that are not waiting" - (let ((subtree-end (save-excursion (org-end-of-subtree t)))) - (if (re-search-forward ":waiting:" subtree-end t) - nil ; tag found, do not skip - subtree-end))) ; tag not found, continue after end of subtree -@end lisp - -To use this custom function in a custom agenda command: - -@lisp -(org-add-agenda-custom-command - '("b" todo "PROJECT" - ((org-agenda-skip-function 'my-skip-unless-waiting) - (org-agenda-overriding-header "Projects waiting for something: ")))) -@end lisp - -@vindex org-agenda-overriding-header -Note that this also binds @code{org-agenda-overriding-header} to a more -meaningful string suitable for the agenda view. - -@vindex org-odd-levels-only -@vindex org-agenda-skip-function -Search for entries with a limit set on levels for the custom search. -This is a general approach to creating custom searches in Org. To -include all levels, use @samp{LEVEL>0}@footnote{Note that, for @code{org-odd-levels-only}, a level number -corresponds to order in the hierarchy, not to the number of stars.}. Then to selectively pick -the matched entries, use @code{org-agenda-skip-function}, which also -accepts Lisp forms, such as @code{org-agenda-skip-entry-if} and -@code{org-agenda-skip-subtree-if}. For example: - -@table @asis -@item @samp{(org-agenda-skip-entry-if 'scheduled)} -Skip current entry if it has been scheduled. - -@item @samp{(org-agenda-skip-entry-if 'notscheduled)} -Skip current entry if it has not been scheduled. - -@item @samp{(org-agenda-skip-entry-if 'deadline)} -Skip current entry if it has a deadline. - -@item @samp{(org-agenda-skip-entry-if 'scheduled 'deadline)} -Skip current entry if it has a deadline, or if it is scheduled. - -@item @samp{(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))} -Skip current entry if the TODO keyword is TODO or WAITING@. - -@item @samp{(org-agenda-skip-entry-if 'todo 'done)} -Skip current entry if the TODO keyword marks a DONE state. - -@item @samp{(org-agenda-skip-entry-if 'timestamp)} -Skip current entry if it has any timestamp, may also be deadline or -scheduled. - -@item @samp{(org-agenda-skip-entry-if 'regexp "regular expression")} -Skip current entry if the regular expression matches in the entry. - -@item @samp{(org-agenda-skip-entry-if 'notregexp "regular expression")} -Skip current entry unless the regular expression matches. - -@item @samp{(org-agenda-skip-subtree-if 'regexp "regular expression")} -Same as above, but check and skip the entire subtree. -@end table - -The following is an example of a search for @samp{waiting} without the -special function: - -@lisp -(org-add-agenda-custom-command - '("b" todo "PROJECT" - ((org-agenda-skip-function '(org-agenda-skip-subtree-if - 'regexp ":waiting:")) - (org-agenda-overriding-header "Projects waiting for something: ")))) -@end lisp - -@node Speeding Up Your Agendas -@appendixsec Speeding Up Your Agendas - -@cindex agenda views, optimization - -Some agenda commands slow down when the Org files grow in size or -number. Here are tips to speed up: - -@itemize -@item -Reduce the number of Org agenda files to avoid slowdowns due to hard drive -accesses. - -@item -Reduce the number of DONE and archived headlines so agenda -operations that skip over these can finish faster. - -@item -Do not dim blocked tasks: -@vindex org-agenda-dim-blocked-tasks - -@lisp -(setq org-agenda-dim-blocked-tasks nil) -@end lisp - -@item -Stop preparing agenda buffers on startup: -@vindex org-startup-folded -@vindex org-agenda-inhibit-startup - -@lisp -(setq org-agenda-inhibit-startup t) -@end lisp - -@item -Disable tag inheritance for agendas: -@vindex org-agenda-show-inherited-tags -@vindex org-agenda-use-tag-inheritance - -@lisp -(setq org-agenda-use-tag-inheritance nil) -@end lisp -@end itemize - -These options can be applied to selected agenda views. For more -details about generation of agenda views, see the docstrings for the -relevant variables, and this @uref{https://orgmode.org/worg/agenda-optimization.html, dedicated Worg page} for agenda -optimization. - -@node Extracting Agenda Information -@appendixsec Extracting Agenda Information - -@cindex agenda, pipe -@cindex scripts, for agenda processing - -Org provides commands to access agendas through Emacs batch mode. -Through this command-line interface, agendas are automated for further -processing or printing. - -@vindex org-agenda-custom-commands -@findex org-batch-agenda -@code{org-batch-agenda} creates an agenda view in ASCII and outputs to -standard output. This command takes one string parameter. When -string consists of a single character, Org uses it as a key to -@code{org-agenda-custom-commands}. These are the same ones available -through the agenda dispatcher (see @ref{Agenda Dispatcher}). - -This example command line directly prints the TODO list to the printer: - -@example -emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr -@end example - - -When the string parameter length is two or more characters, Org -matches it with tags/TODO strings. For example, this example command -line prints items tagged with @samp{shop}, but excludes items tagged with -@samp{NewYork}: - -@example -emacs -batch -l ~/.emacs \ - -eval '(org-batch-agenda "+shop-NewYork")' | lpr -@end example - -@noindent -An example showing on-the-fly parameter modifications: - -@example -emacs -batch -l ~/.emacs \ - -eval '(org-batch-agenda "a" \ - org-agenda-span (quote month) \ - org-agenda-include-diary nil \ - org-agenda-files (quote ("~/org/project.org")))' \ - | lpr -@end example - -@noindent -which produces an agenda for the next 30 days from just the -@samp{~/org/projects.org} file. - -@findex org-batch-agenda-csv -For structured processing of agenda output, use @code{org-batch-agenda-csv} -with the following fields: - -@table @asis -@item category -The category of the item -@item head -The headline, without TODO keyword, TAGS and PRIORITY -@item type -The type of the agenda entry, can be - -@multitable {aaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} -@item @code{todo} -@tab selected in TODO match -@item @code{tagsmatch} -@tab selected in tags match -@item @code{diary} -@tab imported from diary -@item @code{deadline} -@tab a deadline -@item @code{scheduled} -@tab scheduled -@item @code{timestamp} -@tab appointment, selected by timestamp -@item @code{closed} -@tab entry was closed on date -@item @code{upcoming-deadline} -@tab warning about nearing deadline -@item @code{past-scheduled} -@tab forwarded scheduled item -@item @code{block} -@tab entry has date block including date -@end multitable - -@item todo -The TODO keyword, if any -@item tags -All tags including inherited ones, separated by colons -@item date -The relevant date, like @samp{2007-2-14} -@item time -The time, like @samp{15:00-16:50} -@item extra -String with extra planning info -@item priority-l -The priority letter if any was given -@item priority-n -The computed numerical priority -@end table - -If the selection of the agenda item was based on a timestamp, -including those items with @samp{DEADLINE} and @samp{SCHEDULED} keywords, then -Org includes date and time in the output. - -If the selection of the agenda item was based on a timestamp (or -deadline/scheduled), then Org includes date and time in the output. - -Here is an example of a post-processing script in Perl. It takes the -CSV output from Emacs and prints with a checkbox: - -@example -#!/usr/bin/perl - -# define the Emacs command to run -$cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; - -# run it and capture the output -$agenda = qx@{$cmd 2>/dev/null@}; - -# loop over all lines -foreach $line (split(/\n/,$agenda)) @{ - # get the individual values - ($category,$head,$type,$todo,$tags,$date,$time,$extra, - $priority_l,$priority_n) = split(/,/,$line); - # process and print - print "[ ] $head\n"; -@} -@end example - -@node Using the Property API -@appendixsec Using the Property API - -@cindex API, for properties -@cindex properties, API - -Here is a description of the functions that can be used to work with -properties. - -@defun org-entry-properties &optional pom which -Get all properties of the entry at point-or-marker @var{POM}. -This includes the TODO keyword, the tags, time strings for deadline, -scheduled, and clocking, and any additional properties defined in the -entry. The return value is an alist. Keys may occur multiple times -if the property key was used several times. @var{POM} may also -be @code{nil}, in which case the current entry is used. If -@var{WHICH} is @code{nil} or @code{all}, get all properties. If -@var{WHICH} is @code{special} or @code{standard}, only get that subclass. -@end defun - -@vindex org-use-property-inheritance -@findex org-insert-property-drawer -@defun org-entry-get pom property &optional inherit -Get value of @var{PROPERTY} for entry at point-or-marker -@var{POM}. By default, this only looks at properties defined -locally in the entry. If @var{INHERIT} is non-@code{nil} and the -entry does not have the property, then also check higher levels of the -hierarchy. If @var{INHERIT} is the symbol @code{selective}, use -inheritance if and only if the setting of -@code{org-use-property-inheritance} selects @var{PROPERTY} for -inheritance. -@end defun - -@defun org-entry-delete pom property -Delete the property @var{PROPERTY} from entry at point-or-marker -@var{POM}. -@end defun - -@defun org-entry-put pom property value -Set @var{PROPERTY} to @var{VALUES} for entry at -point-or-marker POM@. -@end defun - -@defun org-buffer-property-keys &optional include-specials -Get all property keys in the current buffer. -@end defun - -@defun org-insert-property-drawer -Insert a property drawer for the current entry. Also -@end defun - -@defun org-entry-put-multivalued-property pom property &rest values -Set @var{PROPERTY} at point-or-marker @var{POM} to -@var{VALUES}. @var{VALUES} should be a list of strings. -They are concatenated, with spaces as separators. -@end defun - -@defun org-entry-get-multivalued-property pom property -Treat the value of the property @var{PROPERTY} as -a whitespace-separated list of values and return the values as a list -of strings. -@end defun - -@defun org-entry-add-to-multivalued-property pom property value -Treat the value of the property @var{PROPERTY} as -a whitespace-separated list of values and make sure that -@var{VALUE} is in this list. -@end defun - -@defun org-entry-remove-from-multivalued-property pom property value -Treat the value of the property @var{PROPERTY} as -a whitespace-separated list of values and make sure that -@var{VALUE} is @emph{not} in this list. -@end defun - -@defun org-entry-member-in-multivalued-property pom property value -Treat the value of the property @var{PROPERTY} as -a whitespace-separated list of values and check if @var{VALUE} is -in this list. -@end defun - -@defopt org-property-allowed-value-functions -Hook for functions supplying allowed values for a specific property. -The functions must take a single argument, the name of the property, -and return a flat list of allowed values. If @samp{:ETC} is one of the -values, use the values as completion help, but allow also other values -to be entered. The functions must return @code{nil} if they are not -responsible for this property. -@end defopt - -@node Using the Mapping API -@appendixsec Using the Mapping API - -@cindex API, for mapping -@cindex mapping entries, API - -Org has sophisticated mapping capabilities to find all entries -satisfying certain criteria. Internally, this functionality is used -to produce agenda views, but there is also an API that can be used to -execute arbitrary functions for each or selected entries. The main -entry point for this API is: - -@defun org-map-entries func &optional match scope &rest skip -Call @var{FUNC} at each headline selected by @var{MATCH} in -@var{SCOPE}. - -@var{FUNC} is a function or a Lisp form. With point positioned -at the beginning of the headline, call the function without arguments. -Org returns an alist of return values of calls to the function. - -To avoid preserving point, Org wraps the call to @var{FUNC} in -@code{save-excursion} form. After evaluation, Org moves point to the end -of the line that was just processed. Search continues from that point -forward. This may not always work as expected under some conditions, -such as if the current sub-tree was removed by a previous archiving -operation. In such rare circumstances, Org skips the next entry -entirely when it should not. To stop Org from such skips, make -@var{FUNC} set the variable @code{org-map-continue-from} to a specific -buffer position. - -@var{MATCH} is a tags/property/TODO match. Org iterates only -matched headlines. Org iterates over all headlines when -@var{MATCH} is @code{nil} or @code{t}. - -@var{SCOPE} determines the scope of this command. It can be any -of: - -@table @asis -@item @code{nil} -The current buffer, respecting the restriction, if any. - -@item @code{tree} -The subtree started with the entry at point. - -@item @code{region} -The entries within the active region, if any. - -@item @code{file} -The current buffer, without restriction. - -@item @code{file-with-archives} -The current buffer, and any archives associated with it. - -@item @code{agenda} -All agenda files. - -@item @code{agenda-with-archives} -All agenda files with any archive files associated with them. - -@item list of filenames -If this is a list, all files in the list are scanned. -@end table - -@noindent -The remaining arguments are treated as settings for the scanner's -skipping facilities. Valid arguments are: - -@table @asis -@item @code{archive} -Skip trees with the @samp{ARCHIVE} tag. - -@item @code{comment} -Skip trees with the COMMENT keyword. - -@item function or Lisp form -@vindex org-agenda-skip-function -Used as value for @code{org-agenda-skip-function}, so whenever the -function returns @code{t}, @var{FUNC} is called for that entry and -search continues from the point where the function leaves it. -@end table -@end defun - -The mapping routine can call any arbitrary function, even functions -that change meta data or query the property API (see @ref{Using the Property API}). Here are some handy functions: - -@defun org-todo &optional arg -Change the TODO state of the entry. See the docstring of the -functions for the many possible values for the argument -@var{ARG}. -@end defun - -@defun org-priority &optional action -Change the priority of the entry. See the docstring of this function -for the possible values for @var{ACTION}. -@end defun - -@defun org-toggle-tag tag &optional onoff -Toggle the tag @var{TAG} in the current entry. Setting -@var{ONOFF} to either @code{on} or @code{off} does not toggle tag, but -ensure that it is either on or off. -@end defun - -@defun org-promote -Promote the current entry. -@end defun - -@defun org-demote -Demote the current entry. -@end defun - -This example turns all entries tagged with @samp{TOMORROW} into TODO -entries with keyword @samp{UPCOMING}. Org ignores entries in comment trees -and archive trees. - -@lisp -(org-map-entries '(org-todo "UPCOMING") - "+TOMORROW" 'file 'archive 'comment) -@end lisp - -The following example counts the number of entries with TODO keyword -@samp{WAITING}, in all agenda files. - -@lisp -(length (org-map-entries t "/+WAITING" 'agenda)) -@end lisp - -@node History and Acknowledgments -@appendix History and Acknowledgments - - - -@anchor{From Carsten} -@appendixsec From Carsten - -Org was born in 2003, out of frustration over the user interface of -the Emacs Outline mode. I was trying to organize my notes and -projects, and using Emacs seemed to be the natural way to go. -However, having to remember eleven different commands with two or -three keys per command, only to hide and show parts of the outline -tree, that seemed entirely unacceptable to me. Also, when using -outlines to take notes, I constantly wanted to restructure the tree, -organizing it parallel to my thoughts and plans. @emph{Visibility cycling} -and @emph{structure editing} were originally implemented in the package -@samp{outline-magic.el}, but quickly moved to the more general @samp{org.el}. -As this environment became comfortable for project planning, the next -step was adding @emph{TODO entries}, basic @emph{timestamps}, and @emph{table -support}. These areas highlighted the two main goals that Org still -has today: to be a new, outline-based, plain text mode with innovative -and intuitive editing features, and to incorporate project planning -functionality directly into a notes file. - -Since the first release, literally thousands of emails to me or to the -@email{emacs-orgmode@@gnu.org, mailing list} have provided a constant stream of bug reports, feedback, -new ideas, and sometimes patches and add-on code. Many thanks to -everyone who has helped to improve this package. I am trying to keep -here a list of the people who had significant influence in shaping one -or more aspects of Org. The list may not be complete, if I have -forgotten someone, please accept my apologies and let me know. - -Before I get to this list, a few special mentions are in order: - -@table @asis -@item Bastien Guerry -Bastien has written a large number of extensions to Org (most of -them integrated into the core by now), including the @LaTeX{} exporter -and the plain list parser. His support during the early days was -central to the success of this project. Bastien also invented Worg, -helped establishing the Web presence of Org, and sponsored hosting -costs for the orgmode.org website. Bastien stepped in as maintainer -of Org between 2011 and 2013, at a time when I desperately needed -a break. - -@item Eric Schulte and Dan Davison -Eric and Dan are jointly responsible for the Org Babel system, which -turns Org into a multi-language environment for evaluating code and -doing literate programming and reproducible research. This has -become one of Org's killer features that define what Org is today. - -@item John Wiegley -John has contributed a number of great ideas and patches directly to -Org, including the attachment system (@samp{org-attach.el}), integration -with Apple Mail (@samp{org-mac-message.el}), hierarchical dependencies of -TODO items, habit tracking (@samp{org-habits.el}), and encryption -(@samp{org-crypt.el}). Also, the capture system is really an extended -copy of his great @samp{remember.el}. - -@item Sebastian Rose -Without Sebastian, the HTML/XHTML publishing of Org would be the -pitiful work of an ignorant amateur. Sebastian has pushed this part -of Org onto a much higher level. He also wrote @samp{org-info.js}, -a JavaScript program for displaying webpages derived from Org using -an Info-like or a folding interface with single-key navigation. -@end table - -See below for the full list of contributions! Again, please let me -know what I am missing here! - -@anchor{From Bastien} -@appendixsec From Bastien - -I (Bastien) have been maintaining Org between 2011 and 2013. This -appendix would not be complete without adding a few more -acknowledgments and thanks. - -I am first grateful to Carsten for his trust while handing me over the -maintainership of Org. His unremitting support is what really helped -me getting more confident over time, with both the community and the -code. - -When I took over maintainership, I knew I would have to make Org more -collaborative than ever, as I would have to rely on people that are -more knowledgeable than I am on many parts of the code. Here is -a list of the persons I could rely on, they should really be -considered co-maintainers, either of the code or the community: - -@table @asis -@item Eric Schulte -Eric is maintaining the Babel parts of Org. His reactivity here -kept me away from worrying about possible bugs here and let me focus -on other parts. - -@item Nicolas Goaziou -Nicolas is maintaining the consistency of the deepest parts of Org. -His work on @samp{org-element.el} and @samp{ox.el} has been outstanding, and -it opened the doors for many new ideas and features. He rewrote -many of the old exporters to use the new export engine, and helped -with documenting this major change. More importantly (if that's -possible), he has been more than reliable during all the work done -for Org 8.0, and always very reactive on the mailing list. - -@item Achim Gratz -Achim rewrote the building process of Org, turning some @emph{ad hoc} -tools into a flexible and conceptually clean process. He patiently -coped with the many hiccups that such a change can create for users. - -@item Nick Dokos -The Org mode mailing list would not be such a nice place without -Nick, who patiently helped users so many times. It is impossible to -overestimate such a great help, and the list would not be so active -without him. -@end table - -I received support from so many users that it is clearly impossible to -be fair when shortlisting a few of them, but Org's history would not -be complete if the ones above were not mentioned in this manual. - -@anchor{List of Contributions} -@appendixsec List of Contributions - -@itemize -@item -Russell Adams came up with the idea for drawers. - -@item -Thomas Baumann wrote @samp{ol-bbdb.el} and @samp{ol-mhe.el}. - -@item -Christophe Bataillon created the great unicorn logo that we use on -the Org mode website. - -@item -Alex Bochannek provided a patch for rounding timestamps. - -@item -Jan Böcker wrote @samp{ol-docview.el}. - -@item -Brad Bozarth showed how to pull RSS feed data into Org files. - -@item -Tom Breton wrote @samp{org-choose.el}. - -@item -Charles Cave's suggestion sparked the implementation of templates -for Remember, which are now templates for capture. - -@item -Pavel Chalmoviansky influenced the agenda treatment of items with -specified time. - -@item -Gregory Chernov patched support for Lisp forms into table -calculations and improved XEmacs compatibility, in particular by -porting @samp{nouline.el} to XEmacs. - -@item -Sacha Chua suggested copying some linking code from Planner. - -@item -Baoqiu Cui contributed the DocBook exporter. - -@item -Eddward DeVilla proposed and tested checkbox statistics. He also -came up with the idea of properties, and that there should be an API -for them. - -@item -Nick Dokos tracked down several nasty bugs. - -@item -Kees Dullemond used to edit projects lists directly in HTML and so -inspired some of the early development, including HTML export. He -also asked for a way to narrow wide table columns. - -@item -Thomas@tie{}S@.@tie{}Dye contributed documentation on Worg and helped -integrating the Org Babel documentation into the manual. - -@item -Christian Egli converted the documentation into Texinfo format, -inspired the agenda, patched CSS formatting into the HTML exporter, -and wrote @samp{org-taskjuggler.el}. - -@item -David Emery provided a patch for custom CSS support in exported HTML -agendas. - -@item -Nic Ferrier contributed mailcap and XOXO support. - -@item -Miguel@tie{}A@.@tie{}Figueroa-Villanueva implemented hierarchical checkboxes. - -@item -John Foerch figured out how to make incremental search show context -around a match in a hidden outline tree. - -@item -Raimar Finken wrote @samp{org-git-line.el}. - -@item -Mikael Fornius works as a mailing list moderator. - -@item -Austin Frank works as a mailing list moderator. - -@item -Eric Fraga drove the development of Beamer export with ideas and -testing. - -@item -Barry Gidden did proofreading the manual in preparation for the book -publication through Network Theory Ltd. - -@item -Niels Giesen had the idea to automatically archive DONE trees. - -@item -Nicolas Goaziou rewrote much of the plain list code. - -@item -Kai Grossjohann pointed out key-binding conflicts with other -packages. - -@item -Brian Gough of Network Theory Ltd publishes the Org mode manual as -a book. - -@item -Bernt Hansen has driven much of the support for auto-repeating -tasks, task state change logging, and the clocktable. His clear -explanations have been critical when we started to adopt the Git -version control system. - -@item -Manuel Hermenegildo has contributed various ideas, small fixes and -patches. - -@item -Phil Jackson wrote @samp{ol-irc.el}. - -@item -Scott Jaderholm proposed footnotes, control over whitespace between -folded entries, and column view for properties. - -@item -Matt Jones wrote MobileOrg Android. - -@item -Tokuya Kameshima wrote @samp{org-wl.el} and @samp{org-mew.el}. - -@item -Shidai Liu (``Leo'') asked for embedded @LaTeX{} and tested it. He also -provided frequent feedback and some patches. - -@item -Matt Lundin has proposed last-row references for table formulas and -named invisible anchors. He has also worked a lot on the FAQ@. - -@item -David Maus wrote @samp{org-atom.el}, maintains the issues file for Org, -and is a prolific contributor on the mailing list with competent -replies, small fixes and patches. - -@item -Jason@tie{}F@.@tie{}McBrayer suggested agenda export to CSV format. - -@item -Max Mikhanosha came up with the idea of refiling. - -@item -Dmitri Minaev sent a patch to set priority limits on a per-file -basis. - -@item -Stefan Monnier provided a patch to keep the Emacs Lisp compiler -happy. - -@item -Richard Moreland wrote MobileOrg for the iPhone. - -@item -Rick Moynihan proposed allowing multiple TODO sequences in a file -and being able to quickly restrict the agenda to a subtree. - -@item -Todd Neal provided patches for links to Info files and Elisp forms. - -@item -Greg Newman refreshed the unicorn logo into its current form. - -@item -Tim O'Callaghan suggested in-file links, search options for general -file links, and tags. - -@item -Osamu Okano wrote @samp{orgcard2ref.pl}, a Perl program to create a text -version of the reference card. - -@item -Takeshi Okano translated the manual and David O'Toole's tutorial -into Japanese. - -@item -Oliver Oppitz suggested multi-state TODO items. - -@item -Scott Otterson sparked the introduction of descriptive text for -links, among other things. - -@item -Pete Phillips helped during the development of the TAGS feature, -and provided frequent feedback. - -@item -Martin Pohlack provided the code snippet to bundle character -insertion into bundles of 20 for undo. - -@item -T@.@tie{}V@.@tie{}Raman reported bugs and suggested improvements. - -@item -Matthias Rempe (Oelde) provided ideas, Windows support, and quality -control. - -@item -Paul Rivier provided the basic implementation of named footnotes. -He also acted as mailing list moderator for some time. - -@item -Kevin Rogers contributed code to access VM files on remote hosts. - -@item -Frank Ruell solved the mystery of the @samp{keymapp nil} bug, a conflict -with @samp{allout.el}. - -@item -Jason Riedy generalized the send-receive mechanism for Orgtbl -tables with extensive patches. - -@item -Philip Rooke created the Org reference card, provided lots of -feedback, developed and applied standards to the Org documentation. - -@item -Christian Schlauer proposed angular brackets around links, among -other things. - -@item -Paul Sexton wrote @samp{org-ctags.el}. - -@item -Tom Shannon's @samp{organizer-mode.el} inspired linking to VM/BBDB/Gnus. - -@item -Ilya Shlyakhter proposed the Archive Sibling, line numbering in -literal examples, and remote highlighting for referenced code lines. - -@item -Stathis Sideris wrote the @samp{ditaa.jar} ASCII to PNG converter that is -now packaged into Org's @samp{contrib/} directory. - -@item -Daniel Sinder came up with the idea of internal archiving by locking -subtrees. - -@item -Dale Smith proposed link abbreviations. - -@item -James TD Smith has contributed a large number of patches for -useful tweaks and features. - -@item -Adam Spiers asked for global linking commands, inspired the link -extension system, added support for Mairix, and proposed the mapping -API@. - -@item -Ulf Stegemann created the table to translate special symbols to -HTML, @LaTeX{}, UTF-8, Latin-1 and ASCII@. - -@item -Andy Stewart contributed code to @samp{ol-w3m.el}, to copy -HTML content with links transformation to Org syntax. - -@item -David O'Toole wrote @samp{org-publish.el} and drafted the -manual chapter about publishing. - -@item -Jambunathan@tie{}K@.@tie{}contributed the ODT exporter. - -@item -Sebastien Vauban reported many issues with @LaTeX{} and Beamer export -and enabled source code highlighting in Gnus. - -@item -Stefan Vollmar organized a video-recorded talk at the -Max-Planck-Institute for Neurology. He also inspired the creation -of a concept index for HTML export. - -@item -Jürgen Vollmer contributed code generating the table of contents in -HTML output. - -@item -Samuel Wales has provided important feedback and bug reports. - -@item -Chris Wallace provided a patch implementing the @samp{QUOTE} block. - -@item -David Wainberg suggested archiving, and improvements to the -linking system. - -@item -Carsten Wimmer suggested some changes and helped fix a bug in -linking to Gnus. - -@item -Roland Winkler requested additional key bindings to make Org work on -a TTY@. - -@item -Piotr Zielinski wrote @samp{org-mouse.el}, proposed agenda -blocks and contributed various ideas and code snippets. - -@item -Marco Wahl wrote @samp{ol-eww.el}. -@end itemize - -@node GNU Free Documentation License -@appendix GNU Free Documentation License - -@center Version 1.3, 3 November 2008 - -@display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. -@uref{https://fsf.org/} - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -@end display - -@enumerate 0 -@item -PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document @dfn{free} -in the sense of freedom: to assure everyone the effective freedom -to copy and redistribute it, with or without modifying it, either -commercially or noncommercially. Secondarily, this License -preserves for the author and publisher a way to get credit for -their work, while not being considered responsible for -modifications made by others. - -This License is a kind of ``copyleft'', which means that derivative -works of the document must themselves be free in the same sense. -It complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for -free software, because free software needs free documentation: -a free program should come with manuals providing the same freedoms -that the software does. But this License is not limited to -software manuals; it can be used for any textual work, regardless -of subject matter or whether it is published as a printed book. We -recommend this License principally for works whose purpose is -instruction or reference. - -@item -APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, -that contains a notice placed by the copyright holder saying it can -be distributed under the terms of this License. Such a notice -grants a world-wide, royalty-free license, unlimited in duration, -to use that work under the conditions stated herein. The -``Document'', below, refers to any such manual or work. Any member -of the public is a licensee, and is addressed as ``you''. You accept -the license if you copy, modify or distribute the work in a way -requiring permission under copyright law. - -A ``Modified Version'' of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A ``Secondary Section'' is a named appendix or a front-matter section -of the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall -subject (or to related matters) and contains nothing that could -fall directly within that overall subject. (Thus, if the Document -is in part a textbook of mathematics, a Secondary Section may not -explain any mathematics.) The relationship could be a matter of -historical connection with the subject or with related matters, or -of legal, commercial, philosophical, ethical or political position -regarding them. - -The ``Invariant Sections'' are certain Secondary Sections whose -titles are designated, as being those of Invariant Sections, in the -notice that says that the Document is released under this License. -If a section does not fit the above definition of Secondary then it -is not allowed to be designated as Invariant. The Document may -contain zero Invariant Sections. If the Document does not identify -any Invariant Sections then there are none. - -The ``Cover Texts'' are certain short passages of text that are -listed, as Front-Cover Texts or Back-Cover Texts, in the notice -that says that the Document is released under this License. -A Front-Cover Text may be at most 5 words, and a Back-Cover Text -may be at most 25 words. - -A ``Transparent'' copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed -of pixels) generic paint programs or (for drawings) some widely -available drawing editor, and that is suitable for input to text -formatters or for automatic translation to a variety of formats -suitable for input to text formatters. A copy made in an otherwise -Transparent file format whose markup, or absence of markup, has -been arranged to thwart or discourage subsequent modification by -readers is not Transparent. An image format is not Transparent if -used for any substantial amount of text. A copy that is not -``Transparent'' is called ``Opaque''. - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, @LaTeX{} input format, -SGML or XML using a publicly available DTD, and standard-conforming -simple HTML, PostScript or PDF designed for human modification. -Examples of transparent image formats include PNG, XCF and JPG@. -Opaque formats include proprietary formats that can be read and -edited only by proprietary word processors, SGML or XML for which -the DTD and/or processing tools are not generally available, and -the machine-generated HTML, PostScript or PDF produced by some word -processors for output purposes only. - -The ``Title Page'' means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the -material this License requires to appear in the title page. For -works in formats which do not have any title page as such, ``Title -Page'' means the text near the most prominent appearance of the -work's title, preceding the beginning of the body of the text. - -The ``publisher'' means any person or entity that distributes copies -of the Document to the public. - -A section ``Entitled XYZ'' means a named subunit of the Document -whose title either is precisely XYZ or contains XYZ in parentheses -following text that translates XYZ in another language. (Here XYZ -stands for a specific section name mentioned below, such as -``Acknowledgements'', ``Dedications'', ``Endorsements'', or ``History''.) -To ``Preserve the Title'' of such a section when you modify the -Document means that it remains a section ``Entitled XYZ'' according -to this definition. - -The Document may include Warranty Disclaimers next to the notice -which states that this License applies to the Document. These -Warranty Disclaimers are considered to be included by reference in -this License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and -has no effect on the meaning of this License. - -@item -VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License -applies to the Document are reproduced in all copies, and that you -add no other conditions whatsoever to those of this License. You -may not use technical measures to obstruct or control the reading -or further copying of the copies you make or distribute. However, -you may accept compensation in exchange for copies. If you -distribute a large enough number of copies you must also follow the -conditions in section 3. - -You may also lend copies, under the same conditions stated above, -and you may publicly display copies. - -@item -COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly -have printed covers) of the Document, numbering more than 100, and -the Document's license notice requires Cover Texts, you must -enclose the copies in covers that carry, clearly and legibly, all -these Cover Texts: Front-Cover Texts on the front cover, and -Back-Cover Texts on the back cover. Both covers must also clearly -and legibly identify you as the publisher of these copies. The -front cover must present the full title with all words of the title -equally prominent and visible. You may add other material on the -covers in addition. Copying with changes limited to the covers, as -long as they preserve the title of the Document and satisfy these -conditions, can be treated as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto -adjacent pages. - -If you publish or distribute Opaque copies of the Document -numbering more than 100, you must either include a machine-readable -Transparent copy along with each Opaque copy, or state in or with -each Opaque copy a computer-network location from which the general -network-using public has access to download using public-standard -network protocols a complete Transparent copy of the Document, free -of added material. If you use the latter option, you must take -reasonably prudent steps, when you begin distribution of Opaque -copies in quantity, to ensure that this Transparent copy will -remain thus accessible at the stated location until at least one -year after the last time you distribute an Opaque copy (directly or -through your agents or retailers) of that edition to the public. - -It is requested, but not required, that you contact the authors of -the Document well before redistributing any large number of copies, -to give them a chance to provide you with an updated version of the -Document. - -@item -MODIFICATIONS - -You may copy and distribute a Modified Version of the Document -under the conditions of sections 2 and 3 above, provided that you -release the Modified Version under precisely this License, with the -Modified Version filling the role of the Document, thus licensing -distribution and modification of the Modified Version to whoever -possesses a copy of it. In addition, you must do these things in -the Modified Version: - -@enumerate A -@item -Use in the Title Page (and on the covers, if any) a title -distinct from that of the Document, and from those of previous -versions (which should, if there were any, be listed in the -History section of the Document). You may use the same title as -a previous version if the original publisher of that version -gives permission. - -@item -List on the Title Page, as authors, one or more persons or -entities responsible for authorship of the modifications in the -Modified Version, together with at least five of the principal -authors of the Document (all of its principal authors, if it has -fewer than five), unless they release you from this requirement. - -@item -State on the Title page the name of the publisher of the -Modified Version, as the publisher. - -@item -Preserve all the copyright notices of the Document. - -@item -Add an appropriate copyright notice for your modifications -adjacent to the other copyright notices. - -@item -Include, immediately after the copyright notices, a license -notice giving the public permission to use the Modified Version -under the terms of this License, in the form shown in the -Addendum below. - -@item -Preserve in that license notice the full lists of Invariant -Sections and required Cover Texts given in the Document's -license notice. - -@item -Include an unaltered copy of this License. - -@item -Preserve the section Entitled ``History'', Preserve its Title, and -add to it an item stating at least the title, year, new authors, -and publisher of the Modified Version as given on the Title -Page. If there is no section Entitled ``History'' in the Document, -create one stating the title, year, authors, and publisher of -the Document as given on its Title Page, then add an item -describing the Modified Version as stated in the previous -sentence. - -@item -Preserve the network location, if any, given in the Document -for public access to a Transparent copy of the Document, and -likewise the network locations given in the Document for -previous versions it was based on. These may be placed in the -``History'' section. You may omit a network location for a work -that was published at least four years before the Document -itself, or if the original publisher of the version it refers -to gives permission. - -@item -For any section Entitled ``Acknowledgements'' or ``Dedications'', -Preserve the Title of the section, and preserve in the section -all the substance and tone of each of the contributor -acknowledgements and/or dedications given therein. - -@item -Preserve all the Invariant Sections of the Document, unaltered -in their text and in their titles. Section numbers or the -equivalent are not considered part of the section titles. - -@item -Delete any section Entitled ``Endorsements''. Such a section may -not be included in the Modified Version. - -@item -Do not retitle any existing section to be Entitled -``Endorsements'' or to conflict in title with any Invariant -Section. - -@item -Preserve any Warranty Disclaimers. -@end enumerate - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled ``Endorsements'', provided it contains -nothing but endorsements of your Modified Version by various -parties---for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - -@item -COMBINING DOCUMENTS - -You may combine the Document with other documents released under -this License, under the terms defined in section 4 above for -modified versions, provided that you include in the combination all -of the Invariant Sections of all of the original documents, -unmodified, and list them all as Invariant Sections of your -combined work in its license notice, and that you preserve all -their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name -but different contents, make the title of each such section unique -by adding at the end of it, in parentheses, the name of the -original author or publisher of that section if known, or else -a unique number. Make the same adjustment to the section titles in -the list of Invariant Sections in the license notice of the -combined work. - -In the combination, you must combine any sections Entitled -``History'' in the various original documents, forming one section -Entitled ``History''; likewise combine any sections Entitled -``Acknowledgements'', and any sections Entitled ``Dedications''. You -must delete all sections Entitled ``Endorsements.'' - -@item -COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other -documents released under this License, and replace the individual -copies of this License in the various documents with a single copy -that is included in the collection, provided that you follow the -rules of this License for verbatim copying of each of the documents -in all other respects. - -You may extract a single document from such a collection, and -distribute it individually under this License, provided you insert -a copy of this License into the extracted document, and follow this -License in all other respects regarding verbatim copying of that -document. - -@item -AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other -separate and independent documents or works, in or on a volume of -a storage or distribution medium, is called an ``aggregate'' if the -copyright resulting from the compilation is not used to limit the -legal rights of the compilation's users beyond what the individual -works permit. When the Document is included in an aggregate, this -License does not apply to the other works in the aggregate which -are not themselves derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half -of the entire aggregate, the Document's Cover Texts may be placed -on covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic -form. Otherwise they must appear on printed covers that bracket -the whole aggregate. - -@item -TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of -section 4. Replacing Invariant Sections with translations requires -special permission from their copyright holders, but you may -include translations of some or all Invariant Sections in addition -to the original versions of these Invariant Sections. You may -include a translation of this License, and all the license notices -in the Document, and any Warranty Disclaimers, provided that you -also include the original English version of this License and the -original versions of those notices and disclaimers. In case of -a disagreement between the translation and the original version of -this License or a notice or disclaimer, the original version will -prevail. - -If a section in the Document is Entitled ``Acknowledgements'', -``Dedications'', or ``History'', the requirement (section 4) to -Preserve its Title (section 1) will typically require changing the -actual title. - -@item -TERMINATION - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, -and will automatically terminate your rights under this License. - -However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the -copyright holder fails to notify you of the violation by some -reasonable means prior to 60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from -that copyright holder, and you cure the violation prior to 30 days -after your receipt of the notice. - -Termination of your rights under this section does not terminate -the licenses of parties who have received copies or rights from you -under this License. If your rights have been terminated and not -permanently reinstated, receipt of a copy of some or all of the -same material does not give you any rights to use it. - -@item -FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions of -the GNU Free Documentation License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. See -@uref{https://www.gnu.org/copyleft/}. - -Each version of the License is given a distinguishing version -number. If the Document specifies that a particular numbered -version of this License ``or any later version'' applies to it, you -have the option of following the terms and conditions either of -that specified version or of any later version that has been -published (not as a draft) by the Free Software Foundation. If -the Document does not specify a version number of this License, -you may choose any version ever published (not as a draft) by the -Free Software Foundation. If the Document specifies that a proxy -can decide which future versions of this License can be used, that -proxy's public statement of acceptance of a version permanently -authorizes you to choose that version for the Document. - -@item -RELICENSING - -``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any -World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. -A public wiki that anybody can edit is an example of such -a server. A ``Massive Multiauthor Collaboration'' (or ``MMC'') -contained in the site means any set of copyrightable works thus -published on the MMC site. - -``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, -a not-for-profit corporation with a principal place of business in -San Francisco, California, as well as future copyleft versions of -that license published by that same organization. - -``Incorporate'' means to publish or republish a Document, in whole -or in part, as part of another Document. - -An MMC is ``eligible for relicensing'' if it is licensed under this -License, and if all works that were first published under this -License somewhere other than this MMC, and subsequently -incorporated in whole or in part into the MMC, (1) had no cover -texts or invariant sections, and (2) were thus incorporated prior -to November 1, 2008. - -The operator of an MMC Site may republish an MMC contained in the -site under CC-BY-SA on the same site at any time before August 1, -2009, provided the MMC is eligible for relicensing. -@end enumerate - -@page - -@anchor{ADDENDUM How to use this License for your documents} -@appendixsec ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - -@example -Copyright (C) YEAR YOUR NAME. -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 -or any later version published by the Free Software Foundation; -with no Invariant Sections, no Front-Cover Texts, and no Back-Cover -Texts. A copy of the license is included in the section entitled ``GNU -Free Documentation License''. -@end example - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.''@tie{}line with this: - -@example -with the Invariant Sections being LIST THEIR TITLES, with -the Front-Cover Texts being LIST, and with the Back-Cover Texts -being LIST. -@end example - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, to -permit their use in free software. - -@node Main Index -@chapter Main Index - -@printindex cp - -@node Key Index -@chapter Key Index - -@printindex ky - -@node Command and Function Index -@chapter Command and Function Index - -@printindex fn - -@node Variable Index -@chapter Variable Index - -This is not a complete index of variables and faces, only the ones -that are mentioned in the manual. For a more complete list, use -@kbd{M-x org-customize} and then click yourself through the tree. - -@printindex vr - -@bye diff --git a/doc/misc/pcl-cvs.texi b/doc/misc/pcl-cvs.texi index 0d4f9769115..4ba067fd81f 100644 --- a/doc/misc/pcl-cvs.texi +++ b/doc/misc/pcl-cvs.texi @@ -839,7 +839,7 @@ files. @item f Find the file that the cursor points to (@code{cvs-mode-find-file}). If the cursor points to a directory, run @code{dired} on that directory; -@inforef{Dired, , emacs}. +@pxref{Dired, Emacs Manual, , emacs}. @item o Like @kbd{f}, but use another window diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi index ff8133b2a1f..ae3a3b13e62 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi @@ -124,10 +124,11 @@ server in a network, and servers relay messages from one to the next. Here's a typical example: @cindex redirection to random servers -When you connect to the Freenode network -(@code{http://freenode.net/}), you point your IRC client at the -server @code{chat.freenode.net}. That server will redirect your client -to a random server on the network, such as @code{zelazny.freenode.net}. +When you connect to the Libera.Chat network +(@code{https://libera.chat}), you point your IRC client at the +server @code{irc.libera.chat}. That server will redirect your client +to a random server on the network, such as +@code{zirconium.libera.chat}. @cindex channel name @cindex # starts a channel name @@ -171,15 +172,23 @@ using a different nick. This will prompt you for four things: @table @asis @cindex server, connecting -@cindex Freenode network +@cindex Libera.Chat network @item IRC Server What server do you want to connect to? All the servers in a particular -network are equivalent. Some networks use a round-robin system where a -single server redirects new connections to a random server in the -network. @code{chat.freenode.net} is such a server for the Freenode -network. Freenode provides the network ``for the Free and Open Source -Software communities, for not-for-profit organizations and for related -communities and organizations.'' +network are equivalent. Some networks use a round-robin system where +a single server redirects new connections to a random server in the +network. @code{irc.libera.chat} is such a server for the Libera.Chat +network. Libera.Chat's purpose is ``to provide services such as a +community platform for free open-source software and peer directed +projects on a volunteer basis,'' and was chosen as the official home +of the GNU Project and the Free Software Foundation's IRC channels in +June 2021 in the aftermath of the changes in governance and policies +of the Freenode IRC network. GNU and FSF's announcements about this +are at +@uref{https://lists.gnu.org/archive/html/info-gnu/2021-06/msg00005.html}, +@uref{https://lists.gnu.org/archive/html/info-gnu/2021-06/msg00007.html}, +and +@uref{https://lists.gnu.org/archive/html/info-gnu-emacs/2021-06/msg00000.html}. @cindex port, connecting @cindex 6667, default IRC port @@ -205,13 +214,13 @@ in use, you might for example get assigned the nick @code{alex`}. A space separated list of channels you want to join when connecting. You don't need to join any channels, if you just want to have one-to-one conversations with friends on the same network. If you're new to the -Freenode network, join @code{#emacs}, the channel about all things +Libera.Chat network, join @code{#emacs}, the channel about all things Emacs, or join @code{#rcirc}, the channel about @code{rcirc}. @end table @cindex server buffer When you have answered these questions, @code{rcirc} will create a server -buffer, which will be named something like @file{*chat.freenode.net*}, +buffer, which will be named something like @file{*irc.libera.chat*}, and a channel buffer for each of the channels you wanted to join. @kindex RET @@ -482,7 +491,7 @@ Here's an example of how to set it: @end example By default you will be connected to the @code{rcirc} support channel: -@code{#rcirc} on @code{chat.freenode.net}. +@code{#rcirc} on @code{irc.libera.chat}. @table @code @item :nick @@ -554,8 +563,8 @@ Here is an example to illustrate how you would set it: @example (setq rcirc-authinfo - '(("freenode" nickserv "bob" "p455w0rd") - ("freenode" chanserv "bob" "#bobland" "passwd99") + '(("Libera.Chat" nickserv "bob" "p455w0rd") + ("Libera.Chat" chanserv "bob" "#bobland" "passwd99") ("bitlbee" bitlbee "robert" "sekrit"))) @end example @@ -590,6 +599,12 @@ Use this symbol if you need to identify yourself in the Bitlbee channel as follows: @code{identify secret}. The necessary arguments are the nickname you want to use this for, and the password to use. +@item sasl +@cindex sasl authentication +Use this symbol if you want to use @acronym{SASL} authentication. The +necessary arguments are the nickname you want to use this for, and the +password to use. + @cindex gateway to other IM services @cindex instant messaging, other services @cindex Jabber diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 599252fabf7..88ca4450d59 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -254,73 +254,6 @@ version 20.2. It has also been bundled and pre-installed with XEmacs plug-in package which is available from the @value{XEMACSFTP}. See the XEmacs 21.x documentation on package installation for details. -Users of earlier Emacs distributions (including Emacs 19) or people -craving for new features and bugs can get a copy of the @RefTeX{} -distribution from the maintainer's web page. @xref{Imprint}, for more -information. The following instructions will guide you through the -process of installing such a distribution. - -@subsection Building and Installing - -Note: Currently installation is supported for Emacs only. XEmacs users -might want to refer to the @RefTeX{} package available through the -package system of XEmacs. - -@subsubheading Installation with make - -In order to install RefTeX, unpack the distribution and edit the header -of the Makefile. Basically, you need to change the path specifications -for Emacs Lisp files and info files. Also, enter the name of your Emacs -executable (usually either @samp{emacs} or @samp{xemacs}). - -Then, type - -@example -make -make install -@end example - -to compile and install the code and documentation. - -Per default @RefTeX{} is installed in its own subdirectory which might -not be on your load path. In this case, add it to load path with a -command like the following, replacing the sample directory with the one -where @RefTeX{} is installed in your case. - -@example -(add-to-list 'load-path "/path/to/reftex") -@end example - -Put this command into your init file before other @RefTeX{}-related -settings. - -@subsubheading Installation by Hand - -If you want to get your hands dirty, there is also the possibility to -install by manually copying files. - -@enumerate a -@item -Copy the reftex*.el lisp files to a directory on your load path. Make -sure that no old copy of @RefTeX{} shadows these files. -@item -Byte compile the files. The sequence of compiling should be: -reftex-var.el, reftex.el, and then all the others. -@item -Copy the info file reftex.info to the info directory. -@end enumerate - -@subsection Loading @RefTeX{} - -In order to make the most important functions for entering @RefTeX{} -mode available add the following line to your init file. - -@example -(require 'reftex) -@end example - -@subsection Entering @RefTeX{} Mode - @findex turn-on-reftex @findex reftex-mode @vindex LaTeX-mode-hook @@ -3259,9 +3192,9 @@ with the @kbd{g} key. To get this behavior, use instead @AUCTeX{} is without doubt the best major mode for editing @TeX{} and @LaTeX{} files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). -If @AUCTeX{} is not part of your Emacs distribution, you can get -it@footnote{XEmacs 21.x users may want to install the corresponding -XEmacs package.} by FTP from the @value{AUCTEXSITE}. +You can get it from its home page at @value{AUCTEXSITE}, but since +it is available from GNU ELPA, you can simply install it from @kbd{M-x +list-packages}. @menu * AUCTeX-RefTeX Interface:: How both packages work together @@ -3611,18 +3544,6 @@ after the @samp{@{step+@}}, also when specifying how to get context. @item -@b{Idle timers in XEmacs}@* -@cindex Idle timer restart -@vindex reftex-use-itimer-in-xemacs -In XEmacs, idle timer restart does not work reliably after fast -keystrokes. Therefore @RefTeX{} currently uses the post command -hook to start the timer used for automatic crossref information. When -this bug gets fixed, a real idle timer can be requested with -@lisp -(setq reftex-use-itimer-in-xemacs t) -@end lisp - -@item @b{Viper mode}@* @cindex Viper mode @cindex Key bindings, problems with Viper mode @@ -4688,7 +4609,7 @@ Footer to insert in BibTeX files generated by @end defopt -@node Options - Index Support, Options - Viewing Cross-References, Options - Creating Citations, Options +@node Options - Index Support @section Index Support @cindex Options, Index support @cindex Index support, options diff --git a/doc/misc/remember.texi b/doc/misc/remember.texi index 80065be0a16..91e67a8798b 100644 --- a/doc/misc/remember.texi +++ b/doc/misc/remember.texi @@ -3,11 +3,12 @@ @setfilename ../../info/remember.info @settitle Remember Manual @include docstyle.texi +@include emacsver.texi @syncodeindex fn cp @c %**end of header @copying -This manual is for Remember Mode, version 2.0 +This manual is for Remember Mode, as distributed with Emacs @value{EMACSVER}. Copyright @copyright{} 2001, 2004--2005, 2007--2021 Free Software Foundation, Inc. diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index c37291ac143..70a19484e8a 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi @@ -142,7 +142,7 @@ Move point ``up'' one reference (@code{senator-go-to-up-reference}). The meaning of ``up'' is language-dependent; in C++, for instance, this means moving to the parent of the current tag. -@item C-c, @key{SPC} +@item C-c , @key{SPC} Display a list of possible completions for the symbol at point (@code{semantic-complete-analyze-inline}). This also activates a special set of keybindings for choosing a completion: @key{RET} diff --git a/doc/misc/smtpmail.texi b/doc/misc/smtpmail.texi index dd481d2101e..f5d567533b6 100644 --- a/doc/misc/smtpmail.texi +++ b/doc/misc/smtpmail.texi @@ -264,12 +264,14 @@ file, @pxref{Top,,auth-source, auth, Emacs auth-source Library}. @cindex CRAM-MD5 @cindex PLAIN @cindex LOGIN -The process by which the SMTP library authenticates you to the server -is known as ``Simple Authentication and Security Layer'' (SASL). -There are various SASL mechanisms, and this library supports three of -them: CRAM-MD5, PLAIN, and LOGIN, where the first uses a form of +The process by which the @acronym{SMTP} library authenticates you to +the server is known as ``Simple Authentication and Security Layer'' +(@acronym{SASL}). There are various @acronym{SASL} mechanisms, and +this library supports three of them: @code{cram-md5}, @code{plain}, +@code{login} and @code{xoauth2}, where the first uses a form of encryption to obscure your password, while the other two do not. It -tries each of them, in that order, until one succeeds. You can +tries each of them, in that order, until one succeeds. +(@code{xoauth2} requires using the @file{oauth2.el} library. You can override this by assigning a specific authentication mechanism to a server by including a key @code{smtp-auth} with the value of your preferred mechanism in the appropriate @file{~/.authinfo} entry. @@ -338,6 +340,16 @@ not sent immediately but rather queued in the directory @code{smtpmail-send-queued-mail} (typically when you connect to the internet). +@item smtpmail-store-queue-variables +@vindex smtpmail-store-queue-variables + Normally the queue will be dispatched with the values of the +@acronym{SMTP} variables that are in effect when @kbd{M-x +smtpmail-send-queued-mail} is executed, but if +@code{smtpmail-store-queue-variables} is non-@code{nil}, the values +for @code{smtpmail-smtp-server} (etc.@:) will be stored when the mail is +queued, and then used when actually sending the mail. This can be +useful if you have a complex outgoing mail setup. + @item smtpmail-queue-dir @vindex smtpmail-queue-dir The variable @code{smtpmail-queue-dir} specifies the name of the diff --git a/doc/misc/srecode.texi b/doc/misc/srecode.texi index a0e999b6812..1f7473c151a 100644 --- a/doc/misc/srecode.texi +++ b/doc/misc/srecode.texi @@ -259,7 +259,7 @@ contexts to have the same name. Some standard contexts are @code{file}, @code{declaration}, and @code{classdecl}. A context can be automatically derived as well based on the parsing -state from @i{Semantic}. @inforef{Top, Semantic Manual, semantic}. +state from @i{Semantic}. @xref{Top, Semantic Manual,, semantic}. @section Applications Commands that do a particular user task which involves also writing diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex index dac7ae3d199..a91181b116e 100644 --- a/doc/misc/texinfo.tex +++ b/doc/misc/texinfo.tex @@ -1181,7 +1181,7 @@ where each line of input produces a line of output.} % double any backslashes. Otherwise, a name like "\node" will be % interpreted as a newline (\n), followed by o, d, e. Not good. % -% See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and +% See https://mailman.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and % related messages. The final outcome is that it is up to the TeX user % to double the backslashes and otherwise make the string valid, so % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to @@ -3539,7 +3539,7 @@ $$% % We use the free feym* fonts from the eurosym package by Henrik % Theiling, which support regular, slanted, bold and bold slanted (and % "outlined" (blackboard board, sort of) versions, which we don't need). -% It is available from http://www.ctan.org/tex-archive/fonts/eurosym. +% It is available from https://www.ctan.org/tex-archive/fonts/eurosym. % % Although only regular is the truly official Euro symbol, we ignore % that. The Euro is designed to be slightly taller than the regular diff --git a/doc/misc/todo-mode.texi b/doc/misc/todo-mode.texi index dbd7f3d02f7..b3ea652a7ec 100644 --- a/doc/misc/todo-mode.texi +++ b/doc/misc/todo-mode.texi @@ -122,7 +122,7 @@ Todo Display Features @end detailmenu @end menu -@node Overview, Todo Mode Entry Points, Top, Top +@node Overview @chapter Overview The Todo mode package provides facilities for making and maintaining @@ -146,7 +146,7 @@ most important differences, @ref{Legacy Todo Mode Files}. * Todo Items as Diary Entries:: @end menu -@node Levels of Organization, Todo Items as Diary Entries, , Overview +@node Levels of Organization @section Levels of Organization In Todo mode each todo list is identified with a named category, so you @@ -184,7 +184,7 @@ associating various kinds of metadata with it, e.g., the category it belongs to, its priority, whether it is to be included in the Emacs diary, date and time stamps, whether it is done or still to do. -@node Todo Items as Diary Entries, , Levels of Organization, Overview +@node Todo Items as Diary Entries @section Todo Items as Diary Entries You can have todo items show up in the Emacs Fancy Diary display by @@ -213,7 +213,7 @@ from a Todo mode file, clicking or typing @key{RET} on this item will switch to the buffer visiting that file and properly display the item's category, with point on the item. -@node Todo Mode Entry Points, Key Binding Conventions, Overview, Top +@node Todo Mode Entry Points @chapter Todo Mode Entry Points To initialize your first todo file, invoke the command @code{todo-show}. @@ -275,7 +275,7 @@ that was displayed on quitting current for subsequent Todo mode commands category in Todo mode, in which case the latter become current for Todo mode commands). -@node Key Binding Conventions, Navigation, Todo Mode Entry Points, Top +@node Key Binding Conventions @chapter Key Binding Conventions For Todo mode commands to function properly, it is essential to maintain @@ -301,7 +301,7 @@ those beginning with @kbd{A} apply to archives (a special type of Todo file; @ref{Todo Archive Mode}). Todo commands applying to items, which constitute the majority, are bound to lower case key sequences. -@node Navigation, Editing, Key Binding Conventions, Top +@node Navigation @chapter Navigation The navigation commands are for making another todo file, category, or @@ -389,7 +389,7 @@ or higher than the current one. Navigation to other types of Todo files is discussed in the relevant sections below. -@node Editing, Todo Archives, Navigation, Top +@node Editing @chapter Editing Editing in Todo mode means making structural or textual changes at one @@ -412,7 +412,7 @@ Todo mode with @kbd{q}. * Item Editing:: @end menu -@node File Editing, Category Editing, , Editing +@node File Editing @section File Editing and Todo Edit Mode There are four file-level editing commands: @@ -470,7 +470,7 @@ containing inconsistent information (see the cautionary note in displays a warning to this effect. @end table -@node Category Editing, Item Editing, File Editing, Editing +@node Category Editing @section Category Editing The following commands are available for editing specifically at the @@ -520,7 +520,7 @@ i.e., typing @kbd{C-u C g}, prompts for a file and confines merging to a category in that file. @end table -@node Item Editing, , Category Editing, Editing +@node Item Editing @section Item Editing Todo mode provides commands for adding new items as well as textually @@ -534,7 +534,7 @@ you a lot of flexibility to fine-tune these operations to your needs. * Relocating and Removing Items:: @end menu -@node Inserting New Items, Editing Item Headers and Text, , Item Editing +@node Inserting New Items @subsection Inserting New Items To add a new todo item to a category, type @kbd{i}, which is bound to @@ -761,7 +761,7 @@ calendar after you have entered the item's text, and then you can choose a date from the calendar.) -@node Editing Item Headers and Text, Relocating and Removing Items, Inserting New Items, Item Editing +@node Editing Item Headers and Text @subsection Editing Item Headers and Text To make changes to an existing item's content or header, type @kbd{e}, @@ -945,7 +945,7 @@ really want to toggle the diary-inclusion and calendar-marking status of all items in the category, you can do this by marking all the items and then invoking @kbd{e y} or @kbd{e k}, @pxref{Marked Items}). -@node Relocating and Removing Items, , Editing Item Headers and Text, Item Editing +@node Relocating and Removing Items @subsection Relocating and Removing Items In addition to inserting a new todo item and changing the text or header @@ -960,7 +960,7 @@ removes it from the todo list but does not delete it. * Done Items:: @end menu -@node Reprioritizing Items, Moving and Deleting Items, , Relocating and Removing Items +@node Reprioritizing Items @subsubsection Reprioritizing Items There are three ways to change a todo item's priority: @@ -986,7 +986,7 @@ highest priority without prompting. (Prefix arguments have no effect with @kbd{r} or @kbd{l}.) @end table -@node Moving and Deleting Items, Done Items, Reprioritizing Items, Relocating and Removing Items +@node Moving and Deleting Items @subsubsection Moving and Deleting Items You can move an item to another category, thereby recategorizing it: @@ -1032,7 +1032,7 @@ Todo command to undo a deletion. If you want to be able to use @key{SPC} for confirmation, enable the option @code{todo-y-with-space}. @end quotation -@node Done Items, , Moving and Deleting Items, Relocating and Removing Items +@node Done Items @subsubsection Done Items When the activity or thing that a todo item is about has been done, it @@ -1118,7 +1118,7 @@ item has a comment, you are asked whether to delete it from the restored item. @end table -@node Todo Archives, Marked Items, Editing, Top +@node Todo Archives @chapter Todo Archives When the done items section of a category itself starts to become @@ -1134,7 +1134,7 @@ the extension @samp{.toda} instead of @samp{.todo}. * Todo Archive Mode:: @end menu -@node Creating and Visiting Archives, Todo Archive Mode, , Todo Archives +@node Creating and Visiting Archives @section Creating and Visiting Archives Todo mode provides the following command for archiving items: @@ -1207,7 +1207,7 @@ As with todo files, you can also visit a Todo archive by invoking a standard Emacs file-visiting command; this displays the first (on the initial invocation) or current category of the archive. -@node Todo Archive Mode, , Creating and Visiting Archives, Todo Archives +@node Todo Archive Mode @section Todo Archive Mode When you visit a Todo archive, the buffer is in Todo Archive mode. It @@ -1264,7 +1264,7 @@ The command @kbd{F k} (@pxref{File Editing}) is also available in Todo Archive mode. It deletes the current archive file and prompts you whether to delete the corresponding todo file. -@node Marked Items, Todo Categories Mode, Todo Archives, Top +@node Marked Items @chapter Marked Items For many item editing commands it can make sense and be convenient to @@ -1329,7 +1329,7 @@ todo or marked done items, so if both types of items are marked, invoking these commands has no effect and informs you of your erroneous attempt. -@node Todo Categories Mode, Searching for Items, Marked Items, Top +@node Todo Categories Mode @chapter Todo Categories Mode It can be helpful to have a compact overview of the categories in a @@ -1367,7 +1367,7 @@ to visit another todo file). To do this customize the option * Reordering Categories:: @end menu -@node Table of Item Counts, Reordering Categories, , Todo Categories Mode +@node Table of Item Counts @section Table of Item Counts Above each column of the table is a labeled button you can press by @@ -1428,7 +1428,7 @@ Typing @kbd{q} exits Todo Categories mode, killing the buffer and returning to the current category in the Todo mode or Todo Archive mode buffer from which you had invoked @kbd{F c}. -@node Reordering Categories, , Table of Item Counts, Todo Categories Mode +@node Reordering Categories @section Reordering Categories Todo Categories mode provide commands with which you can change the @@ -1479,7 +1479,7 @@ have to renumber them again. This is one reason why you should exercise caution when using @kbd{F e}. @end quotation -@node Searching for Items, Todo Filtered Items Mode, Todo Categories Mode, Top +@node Searching for Items @chapter Searching for Items It can be useful to be able to locate and examine all todo items that @@ -1506,7 +1506,7 @@ search and remove the highlighting later. These commands are also available in Todo Archive mode. -@node Todo Filtered Items Mode, Todo Display Features, Searching for Items, Top +@node Todo Filtered Items Mode @chapter Todo Filtered Items Mode A more powerful alternative to sequential searching is item filtering, @@ -1520,7 +1520,7 @@ category in a distinct mode, Todo Filtered Items mode. * Files of Filtered Items:: @end menu -@node Filtering Items, Todo Filtered Items Mode Commands, , Todo Filtered Items Mode +@node Filtering Items @section Filtering Items Todo mode provides three ways to filter items: a general filter for @@ -1593,7 +1593,7 @@ this invocation, overriding both @code{todo-top-priorities-overrides} and @code{todo-top-priorities}. @end itemize -@node Todo Filtered Items Mode Commands, Files of Filtered Items, Filtering Items, Todo Filtered Items Mode +@node Todo Filtered Items Mode Commands @section Todo Filtered Items Mode Commands The output of the item filtering commands looks similar to a regular @@ -1650,7 +1650,7 @@ change the relative priorities of items from the same real category, since that would make the filtered list inconsistent with the source todo list. -@node Files of Filtered Items, , Todo Filtered Items Mode Commands, Todo Filtered Items Mode +@node Files of Filtered Items @section Files of Filtered Items Typing @kbd{s} in Todo Filtered Items mode saves the buffer of filtered @@ -1701,7 +1701,7 @@ displaying its first category, as usual. The command @kbd{F k} (@pxref{File Editing}) is also available in Todo Filtered Items mode. It deletes the current filtered items file. -@node Todo Display Features, Printing Todo Buffers, Todo Filtered Items Mode, Top +@node Todo Display Features @chapter Todo Display Features You can change the appearance of Todo mode buffers in a variety of ways. @@ -1712,7 +1712,7 @@ You can change the appearance of Todo mode buffers in a variety of ways. * Other Display Commands and Options:: @end menu -@node Faces, Item Prefix, , Todo Display Features +@node Faces @section Faces Each of the Todo modes uses faces to distinguish various aspects of @@ -1737,7 +1737,7 @@ The @code{todo-faces} customization group contains a complete list of Todo mode faces and brief descriptions of their use. -@node Item Prefix, Other Display Commands and Options, Faces, Todo Display Features +@node Item Prefix @section Item Prefix In the default display of (real or virtual) categories in Todo mode, @@ -1776,7 +1776,7 @@ displayed in a face (@code{todo-top-priority}) different from the face of the prefix of non-top-priority items, so you see at a glance how many items in the category are top priorities. -@node Other Display Commands and Options, , Item Prefix, Todo Display Features +@node Other Display Commands and Options @section Other Display Commands and Options There are two additional toggle commands that affect display in the @@ -1842,7 +1842,7 @@ Categories mode and Todo Filtered Items mode, beyond those mentioned above in the sections on these modes; see the customization groups @code{todo-categories} and @code{todo-filtered} for details. -@node Printing Todo Buffers, Legacy Todo Mode Files, Todo Display Features, Top +@node Printing Todo Buffers @chapter Printing Todo Buffers If you print a Todo buffer using one of the standard Emacs printing @@ -1865,7 +1865,7 @@ By default, Todo uses @code{ps-print-buffer-with-faces} to make the printable version; you can change this by setting the option @code{todo-print-function}. -@node Legacy Todo Mode Files, GNU Free Documentation License, Printing Todo Buffers, Top +@node Legacy Todo Mode Files @chapter Legacy Todo Mode Files Users of the original version of Todo mode will recognize from the @@ -1912,7 +1912,7 @@ it often). (A delicate part of the conversion concerns the customizable format of item date/time headers in the old-style; see the documentation string of @code{todo-legacy-date-time-regexp} for details.) -@node GNU Free Documentation License, , Legacy Todo Mode Files, Top +@node GNU Free Documentation License @appendix GNU Free Documentation License @include doclicense.texi diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index c2e9fe66dfd..bd9bd998dfb 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -126,6 +126,7 @@ Configuring @value{tramp} for use * Inline methods:: Inline methods. * External methods:: External methods. * GVFS-based methods:: @acronym{GVFS}-based external methods. +* FUSE-based methods:: @acronym{FUSE}-based external methods. * Default Method:: Selecting a default method. * Default User:: Selecting a default user. * Default Host:: Selecting a default host. @@ -139,8 +140,10 @@ Configuring @value{tramp} for use Setting own connection related information. * Remote programs:: How @value{tramp} finds and uses programs on the remote host. * Remote shell setup:: Remote shell setup hints. +* FUSE setup:: @acronym{FUSE} setup hints. * Android shell setup:: Android shell setup hints. -* Auto-save and Backup:: Auto-save and Backup. +* Auto-save File Lock and Backup:: + Auto-save, File Lock and Backup. * Keeping files encrypted:: Protect remote files by encryption. * Windows setup hints:: Issues with Cygwin ssh. @@ -223,7 +226,7 @@ presented here to illustrate the steps involved: @kbd{C-x C-f} to initiate find-file, enter part of the @value{tramp} file name, then hit @kbd{@key{TAB}} for completion. If this is the -first time connection to that host, here's what happens: +first time connecting to that host, here's what happens: @itemize @item @@ -250,17 +253,17 @@ message. If @value{tramp} does not receive any messages within a timeout period (a minute, for example), then @value{tramp} responds with an error -message about not finding the remote shell prompt. If any messages -from the remote host, @value{tramp} displays them in the buffer. +message about not finding the remote shell prompt. If there are any +messages from the remote host, @value{tramp} displays them in the +buffer. For any @samp{login failed} message from the remote host, -@value{tramp} aborts the login attempt, and repeats the login steps -again. +@value{tramp} aborts the login attempt, and repeats the login steps. @item -Upon successful login and @value{tramp} recognizes the shell prompt +Upon successful login, if @value{tramp} recognizes the shell prompt from the remote host, @value{tramp} prepares the shell environment by -turning off echoing, setting shell prompt, and other housekeeping +turning off echoing, setting the shell prompt, and other housekeeping chores. @strong{Note} that for the remote shell, @value{tramp} invokes @@ -282,8 +285,8 @@ contents from the remote host. For inline transfers, @value{tramp} sends a command, such as @samp{mimencode -b /path/to/remote/file}, waits until the output has -accumulated in the buffer, decodes that output to produce the file's -contents. +accumulated in the buffer, then decodes that output to produce the +file's contents. For external transfers, @value{tramp} sends a command as follows: @example @@ -335,7 +338,7 @@ versions packaged with Emacs can be retrieved by @end lisp @value{tramp} is also available as @uref{https://elpa.gnu.org, GNU -ELPA} package. Besides the standalone releases, further minor version +ELPA} package. Besides the standalone releases, further minor versions of @value{tramp} will appear on GNU ELPA, until the next @value{tramp} release appears. These minor versions have a four-number string, like ``2.4.5.1''. @@ -345,7 +348,7 @@ Development versions contain new and incomplete features. The development version of @value{tramp} is always the version number of the next release, plus the suffix ``-pre'', like ``2.4.4-pre''. -One way to obtain @value{tramp} from Git server is to visit the +One way to obtain @value{tramp} from the Git server is to visit the Savannah project page at the following URL and then clicking on the Git link in the navigation bar at the top. @@ -363,7 +366,7 @@ $ git clone git://git.savannah.gnu.org/tramp.git @end example @noindent -From behind a firewall: +From behind a proxy: @example @group @@ -411,7 +414,7 @@ $ autoconf @end ifset @ifclear installchapter See the file @file{INSTALL} in that directory for further information -how to install @value{tramp}. +on how to install @value{tramp}. @end ifclear @@ -419,47 +422,47 @@ how to install @value{tramp}. @chapter Short introduction how to use @value{tramp} @cindex quick start guide -@value{tramp} extends the Emacs file name syntax by a remote -component. A remote file name looks always like +@value{tramp} extends the Emacs file name syntax by adding a remote +component. A remote file name always looks like @file{@trampfn{method,user@@host,/path/to/file}}. You can use remote files exactly like ordinary files, that means you -could open a file or directory by @kbd{C-x C-f +can open a file or directory by @kbd{C-x C-f @trampfn{method,user@@host,/path/to/file} @key{RET}}, edit the file, and save it. You can also mix local files and remote files in file operations with two arguments, like @code{copy-file} or -@code{rename-file}. And finally, you can run even processes on a +@code{rename-file}. And finally, you can even run processes on a remote host, when the buffer you call the process from has a remote @code{default-directory}. -@anchor{Quick Start Guide: File name syntax} +@anchor{Quick Start Guide File name syntax} @section File name syntax @cindex file name syntax -Remote file names are prepended by the @code{method}, @code{user} and -@code{host} parts. All of them, and also the local file name part, -are optional, in case of a missing part a default value is assumed. -The default value for an empty local file name part is the remote -user's home directory. The shortest remote file name is -@file{@trampfn{-,,}}, therefore. The @samp{-} notation for the -default method is used for syntactical reasons, @ref{Default Method}. +Remote file names have @code{method}, @code{user} and @code{host} +parts prepended. All of them, and also the local file name part, are +optional, in case of a missing part a default value is assumed. The +default value for an empty local file name part is the remote user's +home directory. The shortest remote file name is thus +@file{@trampfn{-,,}}. The @samp{-} notation for the default method is +used for syntactical reasons, @ref{Default Method}. The @code{method} part describes the connection method used to reach the remote host, see below. The @code{user} part is the user name for accessing the remote host. For the @option{smb} method, this could also require a domain name, in -this case it is written as @code{user%domain}. +which case it is written as @code{user%domain}. -The @code{host} part must be a host name which could be resolved on +The @code{host} part must be a host name which can be resolved on your local host. It could be a short host name, a fully qualified domain name, an IPv4 or IPv6 address, @ref{File name syntax}. Some -connection methods support also a notation of the port to be used, in -this case it is written as @code{host#port}. +connection methods also support a notation for the port to be used, in +which case it is written as @code{host#port}. -@anchor{Quick Start Guide: @option{ssh} and @option{plink} methods} +@anchor{Quick Start Guide ssh and plink methods} @section Using @option{ssh} and @option{plink} @cindex method @option{ssh} @cindex @option{ssh} method @@ -470,36 +473,39 @@ If your local host runs an SSH client, and the remote host runs an SSH server, the simplest remote file name is @file{@trampfn{ssh,user@@host,/path/to/file}}. The remote file name @file{@trampfn{ssh,,}} opens a remote connection to yourself on the -local host, and is taken often for testing @value{tramp}. +local host, and is often used for testing @value{tramp}. -On MS Windows, PuTTY is often used as SSH client. Its @command{plink} +On MS Windows, PuTTY is often used as the SSH client. Its @command{plink} method can be used there to open a connection to a remote host running an @command{ssh} server: @file{@trampfn{plink,user@@host,/path/to/file}}. -@anchor{Quick Start Guide: @option{su}, @option{sudo} and @option{sg} methods} -@section Using @option{su}, @option{sudo} and @option{sg} +@anchor{Quick Start Guide su, sudo, doas and sg methods} +@section Using @option{su}, @option{sudo}, @option{doas} and @option{sg} @cindex method @option{su} @cindex @option{su} method @cindex method @option{sudo} @cindex @option{sudo} method +@cindex method @option{doas} +@cindex @option{doas} method @cindex method @option{sg} @cindex @option{sg} method Sometimes, it is necessary to work on your local host under different -permissions. For this, you could use the @option{su} or @option{sudo} -connection method. Both methods use @samp{root} as default user name -and the return value of @code{(system-name)} as default host name. -Therefore, it is convenient to open a file as +permissions. For this, you can use the @option{su} or @option{sudo} +connection method. On OpenBSD systems, the @option{doas} connection +method offers the same functionality. These methods use @samp{root} +as default user name and the return value of @code{(system-name)} as +default host name. Therefore, it is convenient to open a file as @file{@trampfn{sudo,,/path/to/file}}. -The method @option{sg} stands for ``switch group''; the changed group -must be used here as user name. The default host name is the same. +The method @option{sg} stands for ``switch group''; here the user name +is used as the group to change to. The default host name is the same. -@anchor{Quick Start Guide: @option{ssh}, @option{plink}, @option{su}, @option{sudo} and @option{sg} methods} -@section Combining @option{ssh} or @option{plink} with @option{su} or @option{sudo} +@anchor{Quick Start Guide Combining ssh, plink, su, sudo and doas methods} +@section Combining @option{ssh} or @option{plink} with @option{su}, @option{sudo} or @option{doas} @cindex method @option{ssh} @cindex @option{ssh} method @cindex method @option{plink} @@ -508,18 +514,20 @@ must be used here as user name. The default host name is the same. @cindex @option{su} method @cindex method @option{sudo} @cindex @option{sudo} method +@cindex method @option{doas} +@cindex @option{doas} method -If the @option{su} or @option{sudo} option shall be performed on -another host, it could be comnbined with a leading @option{ssh} or -@option{plink} option. That means, @value{tramp} connects first to -the other host with non-administrative credentials, and changes to -administrative credentials on that host afterwards. In a simple case, -the syntax looks like +If the @option{su}, @option{sudo} or @option{doas} option should be +performed on another host, it can be comnbined with a leading +@option{ssh} or @option{plink} option. That means that @value{tramp} +connects first to the other host with non-administrative credentials, +and changes to administrative credentials on that host afterwards. In +a simple case, the syntax looks like @file{@value{prefix}ssh@value{postfixhop}user@@host|sudo@value{postfixhop}@value{postfix}/path/to/file}. @xref{Ad-hoc multi-hops}. -@anchor{Quick Start Guide: @option{sudoedit} method} +@anchor{Quick Start Guide sudoedit method} @section Using @command{sudoedit} @cindex method @option{sudoedit} @cindex @option{sudoedit} method @@ -527,12 +535,12 @@ the syntax looks like The @option{sudoedit} method is similar to the @option{sudo} method. However, it is a different implementation: it does not keep an open session running in the background. This is for security reasons; on -the backside this method is less performant than the @option{sudo} -method, it is restricted to the @samp{localhost} only, and it does not +the backside this method has worse performance than the @option{sudo} +method, it is restricted to @samp{localhost} only, and it does not support external processes. -@anchor{Quick Start Guide: @option{smb} method} +@anchor{Quick Start Guide smb method} @section Using @command{smbclient} @cindex method @option{smb} @cindex @option{smb} method @@ -546,7 +554,7 @@ of the local file name is the share exported by the remote host, @samp{path} in this example. -@anchor{Quick Start Guide: GVFS-based methods} +@anchor{Quick Start Guide GVFS-based methods} @section Using @acronym{GVFS}-based methods @cindex methods, gvfs @cindex gvfs-based methods @@ -561,16 +569,16 @@ of the local file name is the share exported by the remote host, @cindex method @option{mtp} @cindex @option{mtp} method -On systems, which have installed @acronym{GVFS, the GNOME Virtual File -System}, its offered methods could be used by @value{tramp}. Examples -are @file{@trampfn{sftp,user@@host,/path/to/file}}, +On systems which have @acronym{GVFS, the GNOME Virtual File System} +installed, its offered methods can be used by @value{tramp}. +Examples are @file{@trampfn{sftp,user@@host,/path/to/file}}, @file{@trampfn{afp,user@@host,/path/to/file}} (accessing Apple's AFP file system), @file{@trampfn{dav,user@@host,/path/to/file}}, @file{@trampfn{davs,user@@host,/path/to/file}} (for WebDAV shares) and @file{@trampfn{mtp,device,/path/to/file}} (for media devices). -@anchor{Quick Start Guide: GNOME Online Accounts based methods} +@anchor{Quick Start Guide GNOME Online Accounts based methods} @section Using @acronym{GNOME} Online Accounts based methods @cindex @acronym{GNOME} Online Accounts @cindex method @option{gdrive} @@ -580,17 +588,44 @@ file system), @file{@trampfn{dav,user@@host,/path/to/file}}, @cindex @option{nextcloud} method @cindex nextcloud -@acronym{GVFS}-based methods include also @acronym{GNOME} Online +@acronym{GVFS}-based methods also include @acronym{GNOME} Online Accounts, which support the @option{Files} service. These are the Google Drive file system, and the OwnCloud/NextCloud file system. The -file name syntax is here always +file name syntax here is always @file{@trampfn{gdrive,john.doe@@gmail.com,/path/to/file}} (@samp{john.doe@@gmail.com} stands here for your Google Drive account), or @file{@trampfn{nextcloud,user@@host#8081,/path/to/file}} (@samp{8081} stands for the port number) for OwnCloud/NextCloud files. -@anchor{Quick Start Guide: Android} +@anchor{Quick Start Guide FUSE-based methods} +@section Using @acronym{FUSE}-based methods +@cindex methods, fuse +@cindex fuse-based methods +@cindex method @option{rclone} +@cindex @option{rclone} method +@cindex method @option{sshfs} +@cindex @option{sshfs} method + +@acronym{FUSE, Filesystem in Userspace} allows users to mount a +virtual file system. It is also used by @acronym{GVFS} internally, +but here we discuss methods which do not use the @acronym{GVFS} API. + +A convenient way to access system storages is the @command{rclone} +program. If you have configured a storage in @command{rclone} under a +name @samp{storage} (for example), you can access it via the remote +file name syntax @file{@trampfn{rclone,storage,/path/to/file}}. User +names are not needed. + +On local hosts which have installed the @command{sshfs} client for +mounting a file system based on @command{sftp}, this method can be +used. All remote files are available via the local mount point. +@value{tramp} aids in mounting the file system if it isn't mounted +yet, and it supports the access with the usual file name syntax +@file{@trampfn{sshfs,user@@host,/path/to/file}}. + + +@anchor{Quick Start Guide Android} @section Using Android @cindex method @option{adb} @cindex @option{adb} method @@ -601,18 +636,6 @@ be accessed via the @command{adb} command. No user or host name is needed. The file name syntax is @file{@trampfn{adb,,/path/to/file}}. -@anchor{Quick Start Guide: @option{rclone} method} -@section Using @command{rclone} -@cindex method @option{rclone} -@cindex @option{rclone} method - -A convenient way to access system storages is the @command{rclone} -program. If you have configured a storage in @command{rclone} under a -name @samp{storage} (for example), you could access it via the remote -file name syntax @file{@trampfn{rclone,storage,/path/to/file}}. User -names are not needed. - - @node Configuration @chapter Configuring @value{tramp} @cindex configuration @@ -630,7 +653,7 @@ For changing the connection type and file access method from the defaults to one of several other options, @xref{Connection types}. @strong{Note} that some user options described in these examples are -not auto loaded by Emacs. All examples require @value{tramp} is +not auto loaded by Emacs. All examples require @value{tramp} to be installed and loaded: @lisp @@ -638,7 +661,7 @@ installed and loaded: @end lisp For functions used to configure @value{tramp}, the following clause -might be used in your init file: +may be used in your init file: @lisp (with-eval-after-load 'tramp (tramp-change-syntax 'simplified)) @@ -650,6 +673,7 @@ might be used in your init file: * Inline methods:: Inline methods. * External methods:: External methods. * GVFS-based methods:: @acronym{GVFS}-based external methods. +* FUSE-based methods:: @acronym{FUSE}-based external methods. * Default Method:: Selecting a default method. Here we also try to help those who don't have the foggiest which method @@ -666,8 +690,10 @@ might be used in your init file: Setting own connection related information. * Remote programs:: How @value{tramp} finds and uses programs on the remote host. * Remote shell setup:: Remote shell setup hints. +* FUSE setup:: @acronym{FUSE} setup hints. * Android shell setup:: Android shell setup hints. -* Auto-save and Backup:: Auto-save and Backup. +* Auto-save File Lock and Backup:: + Auto-save, File Lock and Backup. * Keeping files encrypted:: Protect remote files by encryption. * Windows setup hints:: Issues with Cygwin ssh. @end menu @@ -693,13 +719,13 @@ methods. While these methods do see better performance when actually transferring files, the overhead of the cryptographic negotiation at startup may drown out the improvement in file transfer times. -External methods should be configured such a way that they don't -require a password (with @command{ssh-agent}, or such alike). Modern +External methods should be configured in such a way that they don't +require a password (with @command{ssh-agent}, or similar). Modern @command{scp} implementations offer options to reuse existing -@command{ssh} connections, which will be enabled by default if -available. If it isn't possible, you should consider @ref{Password -handling}, otherwise you will be prompted for a password every copy -action. +@command{ssh} connections, which @value{tramp} enables by default if +available. If that is not possible, you should consider @ref{Password +handling}, otherwise you will be prompted for a password for every +copy action. @node Inline methods @@ -727,17 +753,17 @@ usability of one of the commands defined in reliable command it finds. @value{tramp}'s search path can be customized, see @ref{Remote programs}. -In case none of the commands are unavailable, @value{tramp} first -transfers a small Perl program to the remote host, and then tries that -program for encoding and decoding. +In case none of the commands are available, @value{tramp} first +transfers a small Perl program to the remote host, and then tries to +use that program for encoding and decoding. @vindex tramp-inline-compress-start-size @vindex tramp-inline-compress-commands -To increase transfer speeds for large text files, use compression -before encoding. The user option -@code{tramp-inline-compress-start-size} specifies the file size for -such optimization. This feature depends on the availability and -usability of one of the commands defined in +To increase transfer speeds for large text files, @value{tramp} can +use compression before encoding. The user option +@code{tramp-inline-compress-start-size} specifies the file size above +which to use this optimization. This feature depends on the +availability and usability of one of the commands defined in @code{tramp-inline-compress-commands}. @table @asis @@ -747,6 +773,8 @@ usability of one of the commands defined in @command{rsh} is an option for connecting to hosts within local networks since @command{rsh} is not as secure as other methods. +There should be no reason to use it, as @command{ssh} is a both a +complete replacement and ubiquitous. @item @option{ssh} @cindex method @option{ssh} @@ -784,7 +812,7 @@ Similar to @option{su} method, @option{sudo} uses @command{sudo}. @command{sudo} must have sufficient rights to start a shell. For security reasons, a @option{sudo} connection is disabled after a -predefined timeout (5 minutes per default). This can be changed, see +predefined timeout (5 minutes by default). This can be changed, see @ref{Predefined connection information}. @item @option{doas} @@ -1108,7 +1136,6 @@ UNC file name specification does not allow the specification of a different user name for authentication like the @command{smbclient} can. - @item @option{adb} @cindex method @option{adb} @cindex @option{adb} method @@ -1148,45 +1175,6 @@ specified using @file{device#42} host name syntax or @value{tramp} can use the default value as declared in @command{adb} command. Port numbers are not applicable to Android devices connected through USB@. - -@item @option{rclone} -@cindex method @option{rclone} -@cindex @option{rclone} method - -@vindex tramp-rclone-program -The program @command{rclone} allows to access different system -storages in the cloud, see @url{https://rclone.org/} for a list of -supported systems. If the @command{rclone} program isn't found in -your @env{PATH} environment variable, you can tell @value{tramp} its -absolute path via the user option @code{tramp-rclone-program}. - -A system storage must be configured via the @command{rclone config} -command, outside Emacs. If you have configured a storage in -@command{rclone} under a name @samp{storage} (for example), you could -access it via the remote file name - -@example -@trampfn{rclone,storage,/path/to/file} -@end example - -User names are part of the @command{rclone} configuration, and not -needed in the remote file name. If a user name is contained in the -remote file name, it is ignored. - -Internally, @value{tramp} mounts the remote system storage at location -@file{/tmp/tramp.rclone.storage}, with @file{storage} being the name -of the configured system storage. - -Optional flags to the different @option{rclone} operations could be -passed as connection property, @xref{Predefined connection -information}. Supported properties are @t{"mount-args"}, -@t{"copyto-args"} and @t{"moveto-args"}. - -Access via @option{rclone} is slow. If you have an alternative method -for accessing the system storage, you shall prefer this. -@ref{GVFS-based methods} for example, methods @option{gdrive} and -@option{nextcloud}. - @end table @@ -1198,8 +1186,8 @@ for accessing the system storage, you shall prefer this. @acronym{GVFS} is the virtual file system for the @acronym{GNOME} Desktop, @uref{https://en.wikipedia.org/wiki/GVFS}. Remote files on -@acronym{GVFS} are mounted locally through FUSE and @value{tramp} uses -this locally mounted directory internally. +@acronym{GVFS} are mounted locally through @acronym{FUSE} and +@value{tramp} uses this locally mounted directory internally. Emacs uses the D-Bus mechanism to communicate with @acronym{GVFS}@. Emacs must have the message bus system, D-Bus integration active, @@ -1275,7 +1263,7 @@ uses @file{@trampfn{mtp,,}} as the default name. As the name indicates, the method @option{nextcloud} allows you to access OwnCloud or NextCloud hosted files and directories. Like the @option{gdrive} method, your credentials must be populated in your -@command{Online Accounts} application outside Emacs. The method +@command{Online Accounts} application outside Emacs. The method supports port numbers. @item @option{sftp} @@ -1302,7 +1290,7 @@ they are added here for the benefit of @ref{Archive file names}. If you want to use @acronym{GVFS}-based @option{ftp} or @option{smb} methods, you must add them to @code{tramp-gvfs-methods}, and you must -disable the corresponding Tramp package by setting +disable the corresponding @value{tramp} package by setting @code{tramp-ftp-method} or @code{tramp-smb-method} to @code{nil}, respectively: @@ -1315,6 +1303,88 @@ respectively: @end defopt +@node FUSE-based methods +@section @acronym{FUSE}-based external methods +@cindex methods, fuse +@cindex fuse-based methods + +Besides @acronym{GVFS}, there are other virtual file systems using the +@acronym{FUSE} interface. Remote files are mounted locally through +@acronym{FUSE} and @value{tramp} uses this locally mounted directory +internally. When possible, @value{tramp} maps the remote file names +to their respective local file name, and applies the file name +operation on them. For some of the file name operations this is not +possible, @value{tramp} emulates those operations otherwise. + +@table @asis +@item @option{rclone} +@cindex method @option{rclone} +@cindex @option{rclone} method + +@vindex tramp-rclone-program +The program @command{rclone} allows to access different system +storages in the cloud, see @url{https://rclone.org/} for a list of +supported systems. If the @command{rclone} program isn't found in +your @env{PATH} environment variable, you can tell @value{tramp} its +absolute path via the user option @code{tramp-rclone-program}. + +A system storage must be configured via the @command{rclone config} +command, outside Emacs. If you have configured a storage in +@command{rclone} under a name @samp{storage} (for example), you could +access it via the remote file name + +@example +@trampfn{rclone,storage,/path/to/file} +@end example + +User names are part of the @command{rclone} configuration, and not +needed in the remote file name. If a user name is contained in the +remote file name, it is ignored. + +Internally, @value{tramp} mounts the remote system storage at location +@file{/tmp/tramp.rclone.storage}, with @file{storage} being the name +of the configured system storage. + +The mount point and optional flags to the different @option{rclone} +operations could be passed as connection properties, @xref{Setup of +rclone method}. + +Access via @option{rclone} is slow. If you have an alternative method +for accessing the system storage, you should use it. +@ref{GVFS-based methods} for example, methods @option{gdrive} and +@option{nextcloud}. + +@item @option{sshfs} +@cindex method @option{sshfs} +@cindex @option{sshfs} method + +@vindex tramp-sshfs-program +On local hosts which have installed the @command{sshfs} client for +mounting a file system based on @command{sftp}, this method can be +used, see +@url{https://github.com/libfuse/sshfs/blob/master/README.rst/}. If +the @command{sshfs} program isn't found in your @env{PATH} environment +variable, you can tell @value{tramp} its absolute path via the user +option @code{tramp-sshfs-program}. + +All remote files are available via the local mount point. +@value{tramp} aids in mounting the file system if it isn't mounted +yet. The remote file name syntax is + +@example +@trampfn{sshfs,user@@host#port,/path/to/file} +@end example + +User name and port number are optional. This method does not support +password handling, the file system must either be mounted already, or +the connection must be established passwordless via ssh keys. + +The mount point and mount arguments could be passed as connection +properties, @xref{Setup of sshfs method}. + +@end table + + @node Default Method @section Selecting a default method @cindex default method @@ -1908,10 +1978,10 @@ machine melancholia#4711 port davs login daniel%BIZARRE password geheim @end example @vindex auth-source-save-behavior -If there doesn't exist a proper entry, the password is read +If no proper entry exists, the password is read interactively. After successful login (verification of the password), -it is offered to save a corresponding entry for further use by -@code{auth-source} backends which support this. This could be changed +Emacs offers to save a corresponding entry for further use by +@code{auth-source} backends which support this. This can be changed by setting the user option @code{auth-source-save-behavior} to @code{nil}. @vindex auth-source-debug @@ -1927,6 +1997,25 @@ file, you must customize @code{ange-ftp-netrc-filename}: (customize-set-variable 'ange-ftp-netrc-filename "~/.authinfo.gpg") @end lisp +In case you do not want to use an authentication file for +@value{tramp} passwords, use connection-local variables +@ifinfo +(@pxref{Connection Variables, , , emacs}) +@end ifinfo +like this: + +@lisp +@group +(connection-local-set-profile-variables + 'remote-without-auth-sources '((auth-sources . nil))) +@end group + +@group +(connection-local-set-profiles + '(:application tramp) 'remote-without-auth-sources) +@end group +@end lisp + @anchor{Caching passwords} @subsection Caching passwords @@ -2018,10 +2107,10 @@ properties are listed here: @itemize @item @t{"login-program"} -The property @t{"login-program"} keeps the program to be called in -order to connect the remote host. Sometimes, the program might have -another name on your host, or it is located on another path. In this -case, you can overwrite the default value, which is special for every +The property @t{"login-program"} stores the program to be used to +connect to the remote host. Sometimes, the program might have another +name on your host, or it might be located in another path. In this case, +you can overwrite the default value, which is special for every connection method. It is used in all connection methods of @file{tramp-sh.el}. @@ -2033,9 +2122,9 @@ to construct these lists. @item @t{"remote-shell"} -This property tells Tramp which remote shell to apply on the remote -host. It is used in all connection methods of @file{tramp-sh.el}. -The default value is @t{"/bin/sh"}. +This property tells @value{tramp} which remote shell to apply on the +remote host. It is used in all connection methods of +@file{tramp-sh.el}. The default value is @t{"/bin/sh"}. @item @t{"remote-shell-login"} @@ -2074,19 +2163,28 @@ Connections using the @option{smb} method check, whether the remote host supports posix commands. If the remote host runs Samba, it confirms this capability. However, some very old Samba versions have errors in their implementation. In order to suppress the posix -commands for those hosts, the property @t{"posix"} shall be set to +commands for those hosts, the property @t{"posix"} should be set to @code{nil}. The default value of this property is @code{t} (not specified in @code{tramp-methods}). If the remote host runs native MS Windows, -there is no effect of this property. +this property has no effect. + +@item @t{"mount-point"} + +The directory file name an @acronym{FUSE}-based file system is mounted +on. The default value of this property is +@t{"/tmp/tramp.method.user@@host#port"} (not specified in +@code{tramp-methods}). @item @t{"mount-args"}@* @t{"copyto-args"}@* -@t{"moveto-args"} +@t{"moveto-args"}@* +@t{"about-args"} These properties keep optional flags to the different @option{rclone} -operations. Their default value is @code{nil}. +operations. See their default values in @code{tramp-methods} if you +want to change their values. @end itemize @@ -2186,16 +2284,16 @@ be recomputed. To force @value{tramp} to recompute afresh, call @subsection Changing the default remote or local shell @cindex zsh setup -Per default, @value{tramp} uses the command @command{/bin/sh} for +By default, @value{tramp} uses the command @command{/bin/sh} for starting a shell on the remote host. This can be changed by setting -the connection property @t{"remote-shell"}; see @pxref{Predefined +the connection property @t{"remote-shell"}; see @ref{Predefined connection information}. If you want, for example, use @command{/usr/bin/zsh} on a remote host, you might apply @lisp @group (add-to-list 'tramp-connection-properties - (list (regexp-quote "@trampfn{ssh,user@@host,}") + (list (regexp-quote "@trampfn{sshx,user@@host,}") "remote-shell" "/usr/bin/zsh")) @end group @end lisp @@ -2209,10 +2307,12 @@ which support this. This approach has also the advantage, that settings in @code{tramp-sh-extra-args} will be applied. For @command{zsh}, the trouble with the shell prompt due to set zle options will be avoided. +For @command{bash}, loading @file{~/.editrc} or @file{~/.inputrc} is +suppressed. -Similar problems can happen with the local shell Tramp uses to create -a process. Per default, it uses the command @command{/bin/sh} for -this, which could also be a link to another shell. In order to +Similar problems can happen with the local shell @value{tramp} uses to +create a process. By default, it uses the command @command{/bin/sh} +for this, which could also be a link to another shell. In order to overwrite this, you might apply @vindex tramp-encoding-shell @@ -2311,7 +2411,7 @@ prompts, for which @value{tramp} uses @code{tramp-wrong-passwd-regexp}. @value{tramp} uses the user option @code{tramp-terminal-type} to set the remote environment variable @env{TERM} for the shells it runs. -Per default, it is @t{"dumb"}, but this could be changed. A dumb +By default, it is @t{"dumb"}, but this could be changed. A dumb terminal is best suited to run the background sessions of @value{tramp}. However, running interactive remote shells might require a different setting. This could be achieved by tweaking the @@ -2343,10 +2443,16 @@ fi Another possibility is to check the environment variable @env{INSIDE_EMACS}. Like for all subprocesses of Emacs, this is set -to the version of the parent Emacs process, @xref{Interactive Shell, , -, emacs}. @value{tramp} adds its own package version to this string, -which could be used for further tests in an inferior shell. The -string of that environment variable looks always like +to the version of the parent Emacs +@ifinfo +process, @xref{Interactive Shell, , , emacs}. +@end ifinfo +@ifnotinfo +process. +@end ifnotinfo +@value{tramp} adds its own package version to this string, which could +be used for further tests in an inferior shell. The string of that +environment variable looks always like @example @group @@ -2401,7 +2507,6 @@ match the end of the connection buffer. Due to performance reasons, this search starts at the end of the buffer, and it is limited to 256 characters backwards. - @item Conflicting names for users and variables in @file{.profile} When a user name is the same as a variable name in a local file, such @@ -2411,7 +2516,6 @@ variable name to something different from the user name. For example, if the user name is @env{FRUMPLE}, then change the variable name to @env{FRUMPLE_DIR}. - @item Non-Bourne commands in @file{.profile} When the remote host's @file{.profile} is also used for shells other @@ -2436,7 +2540,6 @@ To accommodate using non-Bourne shells on that remote, use other shell-specific config files. For example, bash can use @file{~/.bash_profile} and ignore @file{.profile}. - @item Interactive shell prompt @vindex INSIDE_EMACS@r{, environment variable} @@ -2504,6 +2607,60 @@ where @samp{192.168.0.1} is the remote host IP address @end table +@node FUSE setup +@section @acronym{FUSE} setup hints + +The @acronym{FUSE} file systems are mounted per default at +@file{/tmp/tramp.method.user@@host#port}. The user name and port +number are optional. If the file system is already mounted, it will +be used as it is. If the mount point does not exist yet, +@value{tramp} creates this directory. + +The mount point can be overwritten by the connection property +@t{"mount-point"}, @ref{Predefined connection information}. +Example: + +@lisp +@group +(add-to-list 'tramp-connection-properties + `(,(regexp-quote "@trampfn{sshfs,user@@host,}") + "mount-point" + ,(expand-file-name "sshfs.user@@host" user-emacs-directory))) +@end group +@end lisp + + +@anchor{Setup of rclone method} +@subsection @option{rclone} setup +@cindex rclone setup + +The default arguments of the @command{rclone} operations +@command{mount}, @command{coopyto}, @command{moveto} and +@command{about} are declared in the variable @code{tramp-methods} as +method specific parameters. Usually, they don't need to be overwritten. + +If needed, these parameters can be overwritten as connection +properties @t{"mount-args"}, @t{"copyto-args"}, @t{"moveto-args"} and +@t{"about-args"}, @xref{Predefined connection information}. All of +them are list of strings. + +Be careful changing @t{"--dir-cache-time"}, this could delay +visibility of files. + + +@anchor{Setup of sshfs method} +@subsection @option{sshfs} setup +@cindex sshfs setup + +The method @option{sshfs} declares the mount arguments in the variable +@code{tramp-methods}, passed to the @command{sshfs} command. This is +a list of list of strings, and can be overwritten by the connection +property @t{"mount-args"}, @xref{Predefined connection information}. + +Additionally, it declares also the arguments for running remote +processes, using the @command{ssh} command. These don't need to be +changed. + @node Android shell setup @section Android shell setup hints @cindex android shell setup for ssh @@ -2590,9 +2747,10 @@ Open a remote connection with a more concise command @kbd{C-x C-f @end itemize -@node Auto-save and Backup -@section Auto-save and Backup configuration +@node Auto-save File Lock and Backup +@section Auto-save, File Lock and Backup configuration @cindex auto-save +@cindex file-lock @cindex backup @vindex backup-directory-alist @@ -2687,6 +2845,30 @@ auto-saved files to the same directory as the original file. Alternatively, set the user option @code{tramp-auto-save-directory} to direct all auto saves to that location. +@vindex lock-file-name-transforms +And still more issues to handle. Since @w{Emacs 28}, file locks use a +similar user option as auto-save files, called +@code{lock-file-name-transforms}. By default this user option is +@code{nil}, meaning to keep file locks in the same directory as the +original file. + +If you change @code{lock-file-name-transforms} in order to keep file +locks for remote files somewhere else, you will loose Emacs' feature +to warn you, if a file is changed in parallel from different Emacs +sessions, or via different remote connections. Be careful with such +settings. + +@vindex remote-file-name-inhibit-locks +Setting @code{remote-file-name-inhibit-locks} to non-@code{nil} +prevents the creation of remote lock files at all. + +@vindex tramp-allow-unsafe-temporary-files +Per default, @value{tramp} asks for confirmation if a +@samp{root}-owned remote backup, auto-save or lock file has to be +written to your local temporary directory. If you want to suppress +this confirmation question, set user option +@code{tramp-allow-unsafe-temporary-files} to @code{t}. + @node Keeping files encrypted @section Protect remote files by encryption @@ -3154,12 +3336,12 @@ For ad-hoc definitions to be saved automatically in Ad-hoc proxies can take patterns @code{%h} or @code{%u} like in @code{tramp-default-proxies-alist}. The following file name expands -to user @code{root} on host @code{remotehost}, starting with an -@option{ssh} session on host @code{remotehost}: +to user @samp{root} on host @samp{remotehost}, starting with an +@option{ssh} session on host @samp{remotehost}: @samp{@value{prefix}ssh@value{postfixhop}%h|su@value{postfixhop}remotehost@value{postfix}}. On the other hand, if a trailing hop does not specify a host name, -the host name of the previous hop is reused. Therefore, the following +the host name of the previous hop is reused. Therefore, the following file name is equivalent to the previous example: @samp{@value{prefix}ssh@value{postfixhop}remotehost|su@value{postfixhop}@value{postfix}}. @@ -3189,19 +3371,19 @@ host when the variable @code{default-directory} is remote: @end lisp @vindex process-file-return-signal-string -@code{process-file} shall return either the exit code of the process, -or a string describing the signal, when the process has been -interrupted. Since it cannot be determined reliably whether a remote -process has been interrupted, @code{process-file} returns always the -exit code. When the user option +For a local process, @code{process-file} returns either the exit code +of the process, or a string describing a signal, when the process has +been interrupted. Since it cannot be determined reliably whether a +remote process has been interrupted, @code{process-file} will always +returns the exit code for it. When the user option @code{process-file-return-signal-string} is non-@code{nil}, -@code{process-file} regards all exit codes greater than 128 as an +@code{process-file} treats all exit codes greater than 128 as an indication that the process has been interrupted, and returns a -respective string. +corresponding string. -Remote processes do not apply to @acronym{GVFS} (see @ref{GVFS-based -methods}) because the remote file system is mounted on the local host -and @value{tramp} just accesses by changing the +This remote process handling does not apply to @acronym{GVFS} (see +@ref{GVFS-based methods}) because the remote file system is mounted on +the local host and @value{tramp} accesses it by changing the @code{default-directory}. @value{tramp} starts a remote process when a command is executed in a @@ -3212,7 +3394,7 @@ integrated to work with @value{tramp}: @file{shell.el}, @vindex INSIDE_EMACS@r{, environment variable} @value{tramp} always modifies the @env{INSIDE_EMACS} environment -variable for remote processes. Per default, this environment variable +variable for remote processes. By default, this environment variable shows the Emacs version. @value{tramp} adds its own version string, so it looks like @samp{27.2,tramp:2.4.5.1}. However, other packages might also add their name to this environment variable, like @@ -3267,8 +3449,8 @@ local @file{.emacs} file: @vindex ENV@r{, environment variable} Setting the @env{ENV} environment variable instructs some shells to -read an initialization file. Per default, @value{tramp} has disabled -this. You could overwrite this behavior by evaluating +read an initialization file. By default, @value{tramp} disables +this. You can override this behavior by evaluating @lisp @group @@ -3471,10 +3653,13 @@ uid=0(root) gid=0(root) groups=0(root) @cindex @code{gdb} @cindex @code{perldb} -@file{gud.el} provides a unified interface to symbolic debuggers +@file{gud.el} provides a unified interface to symbolic @ifinfo -(@ref{Debuggers, , , emacs}). +debuggers (@pxref{Debuggers, , , emacs}). @end ifinfo +@ifnotinfo +debuggers. +@end ifnotinfo @value{tramp} can run debug on remote hosts by calling @code{gdb} with a remote file name: @@ -3549,6 +3734,32 @@ To open @command{powershell} as a remote shell, use this: @end lisp +@subsection Remote process connection type +@vindex process-connection-type +@cindex tramp-process-connection-type + +Asynchronous processes differ in the way, whether they use a pseudo +tty, or not. This is controlled by the variable +@code{process-connection-type}, which can be @code{t} or @code{pty} +(use a pseudo tty), or @code{nil} or @code{pipe} (don't use it). +@value{tramp} is based on running shells on the remote host, which +require a pseudo tty. Therefore, it declares the variable +@code{tramp-process-connection-type}, which carries this information +for remote processes. Per default, its value is @code{t}. The name +of the remote pseudo tty is returned by the function +@code{process-tty-name}. + +If a remote process, started by @code{start-file-process}, shouldn't +use a pseudo tty, this is emulated by let-binding this variable to +@code{nil} or @code{pipe}. There is still a pseudo tty for the +started process, but some terminal properties are changed, like +suppressing translation of carriage return characters into newline. + +The function @code{make-process} allows an explicit setting by the +@code{:connection-type} keyword. If this keyword is not used, the +value of @code{tramp-process-connection-type} is applied instead. + + @anchor{Improving performance of asynchronous remote processes} @subsection Improving performance of asynchronous remote processes @cindex Asynchronous remote processes @@ -3635,9 +3846,15 @@ minibuffer. Each connection is of the format Flushing remote connections also cleans the password cache (@pxref{Password handling}), file cache, connection cache -(@pxref{Connection caching}), and recentf cache (@pxref{File -Conveniences, , , emacs}). It also deletes session timers -(@pxref{Predefined connection information}) and connection buffers. +(@pxref{Connection caching}), and recentf +@ifinfo +cache (@pxref{File Conveniences, , , emacs}). +@end ifinfo +@ifnotinfo +cache. +@end ifnotinfo +It also deletes session timers (@pxref{Predefined connection +information}) and connection buffers. If @var{keep-debug} is non-@code{nil}, the debug buffer is kept. A non-@code{nil} @var{keep-password} preserves the password cache. @@ -4064,7 +4281,9 @@ test, @ref{Cleanup remote connections}. Alternatively, and often better for analysis, reproduce the problem in a clean Emacs session started with @command{emacs -Q}. Then, @value{tramp} does not load the persistency file (@pxref{Connection caching}), and it does not use -passwords from @file{auth-source.el} (@pxref{Password handling}). +passwords from @file{auth-source.el} (@pxref{Password handling}). The +latter does not happen for the @option{sudoedit} method, otherwise it +would be unusable. When including @value{tramp}'s messages in the bug report, increase the verbosity level to 6 (@pxref{Traces and Profiles, Traces}) in the @@ -4159,6 +4378,7 @@ Disable excessive traces. Set @code{tramp-verbose} to 3 or lower, default being 3. Increase trace levels temporarily when hunting for bugs. + @item @value{tramp} does not connect to the remote host @@ -4339,9 +4559,9 @@ Note how @samp{%r}, @samp{%h} and @samp{%p} must be encoded as @samp{%%r}, @samp{%%h} and @samp{%%p}. @vindex tramp-use-ssh-controlmaster-options -If the @file{~/.ssh/config} is configured appropriately for the above -behavior, then any changes to @command{ssh} can be suppressed with -this @code{nil} setting: +If the @file{~/.ssh/config} file is configured appropriately for the +above behavior, then any changes to @command{ssh} can be suppressed +with this @code{nil} setting: @lisp (customize-set-variable 'tramp-use-ssh-controlmaster-options nil) @@ -4349,10 +4569,14 @@ this @code{nil} setting: @vindex ProxyCommand@r{, ssh option} @vindex ProxyJump@r{, ssh option} -This shall also be set to @code{nil} if you use the +This should also be set to @code{nil} if you use the @option{ProxyCommand} or @option{ProxyJump} options in your @command{ssh} configuration. +On MS Windows, @code{tramp-use-ssh-controlmaster-options} is set to +@code{nil} by default, because the MS Windows and MSYS2 +implementations of @command{OpenSSH} do not support this option properly. + @item On multi-hop connections, @value{tramp} does not use @command{ssh} @@ -4380,6 +4604,16 @@ supported on your proxy host. @item +Does @value{tramp} support @acronym{SSH} security keys? + +Yes. @command{OpenSSH} has added support for @acronym{FIDO} hardware +devices via special key types @option{*-sk}. @value{tramp} supports +the additional handshaking messages for them. This requires at least +@command{OpenSSH} 8.2, and a @acronym{FIDO} @acronym{U2F} compatible +security key, like yubikey, solokey, or nitrokey. + + +@item @value{tramp} does not connect to Samba or MS Windows hosts running SMB1 connection protocol @@ -4410,6 +4644,7 @@ disable @samp{--color=yes} or @samp{--color=auto} in the remote host's @file{.bashrc} or @file{.profile}. Turn this alias on and off to see if file name completion works. + @item File name completion does not work in directories with large number of files @@ -4542,10 +4777,16 @@ HISTFILE=/dev/null @item Where are remote files trashed to? -Emacs can trash file instead of deleting them, @ref{Misc File Ops, -Trashing , , emacs}. Remote files are always trashed to the local -trash, except remote encrypted files (@pxref{Keeping files -encrypted}), which are deleted anyway. +Emacs can trash file instead of deleting +@ifinfo +them, @ref{Misc File Ops, Trashing , , emacs}. +@end ifinfo +@ifnotinfo +them. +@end ifnotinfo +Remote files are always trashed to the local trash, except remote +encrypted files (@pxref{Keeping files encrypted}), which are deleted +anyway. If Emacs is configured to use the XDG conventions for the trash directory, remote files cannot be restored with the respective tools, @@ -4802,6 +5043,7 @@ In BBDB buffer, access an entry by pressing the key @kbd{F}. Thanks to @value{tramp} users for contributing to these recipes. + @item Why saved multi-hop file names do not work in a new Emacs session? @@ -4894,14 +5136,45 @@ remote files}. @item +How to prevent @value{tramp} from clearing the @code{recentf-list}? + +When @value{tramp} cleans a connection, it removes the respective +remote file name(s) from @code{recentf-list}. This is needed, because +an unresponsive remote host could trigger @code{recentf} to connect +that host again and again. + +If you find the cleanup disturbing, because the file names in +@code{recentf-list} are precious to you, you could add the following +two forms in your @file{~/.emacs} after loading the @code{tramp} and +@code{recentf} packages: + +@lisp +@group +(remove-hook + 'tramp-cleanup-connection-hook + #'tramp-recentf-cleanup) +@end group +@group +(remove-hook + 'tramp-cleanup-all-connections-hook + #'tramp-recentf-cleanup-all) +@end group +@end lisp + + +@item I get a warning @samp{Tramp has been compiled with Emacs a.b, this is Emacs c.d} +@item +I get an error @samp{tramp-file-name-handler: Invalid function: +tramp-compat-with-mutex} @value{tramp} comes with compatibility code for different Emacs -versions. When you see this warning, you don't use the Emacs built-in -version of @value{tramp}. In case you have installed @value{tramp} -from GNU ELPA, you must delete and reinstall it. +versions. When you see such a message (the text might differ), you +don't use the Emacs built-in version of @value{tramp}. In case you +have installed @value{tramp} from GNU ELPA, see the package README +file for instructions how to recompile it. @ifset installchapter -In case you have installed it from its Git repository, @ref{Recompilation}. +@xref{Recompilation}. @end ifset @@ -4913,9 +5186,9 @@ I get an error @samp{Remote file error: Forbidden reentrant call of Tramp} Timers, process filters and sentinels, and other event based functions can run at any time, when a remote file operation is still running. This can cause @value{tramp} to block. When such a situation is -detected, this error is triggered. It shall be fixed in the -respective function (an error report will help), but for the time -being you can suppress this error by the following code in your +detected, this error is triggered. It should be fixed in the +respective function (sending an error report will help), but for the +time being you can suppress this error by the following code in your @file{~/.emacs}: @lisp @@ -5086,7 +5359,7 @@ attributes cache in its process sentinel with this code: @end lisp Since @value{tramp} traverses subdirectories starting with the -root-directory, it is most likely sufficient to make the +root directory, it is most likely sufficient to make the @code{default-directory} of the process buffer as the root directory. @@ -5098,9 +5371,9 @@ sending a string to a process, or waiting for process output. They can run any remote file operation, which would conflict with the already running remote file operation, if the same connection is affected. @value{tramp} detects this situation, and raises the -@code{remote-file-error} error. A timer function shall avoid this -situation. At least, it shall protect itself against this error, by -wrapping the timer function body with +@code{remote-file-error} error. A timer function should avoid this +situation. As a minimum, it should protect itself against this error, by +wrapping the timer function body as follows: @lisp @group @@ -5132,6 +5405,7 @@ The verbosity levels are @*@indent @w{ 8} connection properties @*@indent @w{ 9} test commands @*@indent @w{10} traces (huge) +@*@indent @w{11} call traces (maintainer only) With @code{tramp-verbose} greater than or equal to 4, messages are also written to a @value{tramp} debug buffer. Such debug buffers are @@ -5152,8 +5426,8 @@ Other navigation keys are described in @ref{Outline Visibility, , , emacs}. @end ifinfo -@value{tramp} handles errors internally. But to get a Lisp backtrace, -both the error and the signal have to be set as follows: +@value{tramp} handles errors internally. Hence, to get a Lisp backtrace, +the following settings are required: @lisp @group @@ -5167,34 +5441,21 @@ backtraces are also added to the @value{tramp} debug buffer in case of errors. In very rare cases it could happen, that @value{tramp} blocks Emacs. -Killing Emacs does not allow to inspect the debug buffer. In that -case, you might instruct @value{tramp} to mirror the debug buffer to -file: +Killing Emacs does not allow inspecting the debug buffer. In that +case, you can instruct @value{tramp} to mirror the debug buffer to +a file: @lisp (customize-set-variable 'tramp-debug-to-file t) @end lisp -The debug buffer is written as file in your +The debug buffer is written as a file in your @code{temporary-file-directory}, which is usually @file{/tmp/}. Use this option with care, because it could decrease the performance of @value{tramp} actions. -To enable stepping through @value{tramp} function call traces, they -have to be specifically enabled as shown in this code: - -@lisp -@group -(require 'trace) -(dolist (elt (all-completions "tramp-" obarray 'functionp)) - (trace-function-background (intern elt))) -(untrace-function 'tramp-read-passwd) -@end group -@end lisp - -The buffer @file{*trace-output*} contains the output from the function -call traces. Disable @code{tramp-read-passwd} to stop password -strings from being written to @file{*trace-output*}. +If @code{tramp-verbose} is greater than or equal to 11, @value{tramp} +function call traces are written to the buffer @file{*trace-output*}. @node GNU Free Documentation License diff --git a/doc/misc/trampver.texi b/doc/misc/trampver.texi index 827c4773285..b11ee39f884 100644 --- a/doc/misc/trampver.texi +++ b/doc/misc/trampver.texi @@ -8,7 +8,7 @@ @c In the Tramp GIT, the version numbers are auto-frobbed from @c tramp.el, and the bug report address is auto-frobbed from @c configure.ac. -@set trampver 2.5.1-pre +@set trampver 2.5.2-pre @set trampurl https://www.gnu.org/software/tramp/ @set tramp-bug-report-address tramp-devel@@gnu.org @set emacsver 25.1 diff --git a/doc/misc/wisent.texi b/doc/misc/wisent.texi index dc5b8e4d205..c0bb7b10a46 100644 --- a/doc/misc/wisent.texi +++ b/doc/misc/wisent.texi @@ -1575,7 +1575,7 @@ To use the Wisent parser with @semantic{} you have to define your grammar in @dfn{WY} form, a grammar format very close to the one used by Bison. -Please @inforef{top, Semantic Grammar Framework Manual, grammar-fw} +Please see @ref{top, Semantic Grammar Framework Manual,, grammar-fw}, for more information on @semantic{} grammars. @menu @@ -1962,8 +1962,8 @@ See implementation of the function @code{wisent-skip-token} in @findex semantic-lex The lexical analysis step of @semantic{} is performed by the general -function @code{semantic-lex}. For more information, @inforef{Writing -Lexers, ,semantic-langdev}. +function @code{semantic-lex}. For more information, see @ref{Writing +Lexers, Semantic Language Development,,semantic-langdev}. @code{semantic-lex} produces lexical tokens of the form: diff --git a/doc/misc/woman.texi b/doc/misc/woman.texi index 4470afcad20..33b3a33f0f4 100644 --- a/doc/misc/woman.texi +++ b/doc/misc/woman.texi @@ -105,11 +105,9 @@ Mile End Road, London E1 4NS, UK @chapter Introduction @cindex introduction -This version of WoMan should run with GNU Emacs 20.3 or later on any -platform. It has not been tested, and may not run, with any other -version of Emacs. It was developed primarily on various versions of -Microsoft Windows, but has also been tested on MS-DOS, and various -versions of UNIX and GNU/Linux. +WoMan was developed primarily on various versions of Microsoft +Windows, but has also been tested on MS-DOS, and various versions of +UNIX and GNU/Linux. WoMan is distributed with GNU Emacs. |