From 04023cd9fd93201c49753fa2d5ec3277ebb326f7 Mon Sep 17 00:00:00 2001 From: Andreas Gerler Date: Sun, 26 Apr 2026 20:05:21 +0200 Subject: [PATCH] update org --- elpa/org-9.7.39.signed | 1 - elpa/org-9.7.39/doc/org-version.inc | 3 - elpa/org-9.7.39/ob-ditaa.el | 127 - elpa/org-9.7.39/ob-lua.el | 437 - elpa/org-9.7.39/org-datetree.el | 289 - elpa/org-9.7.39/org-pkg.el | 2 - elpa/org-9.8.3.signed | 1 + elpa/{org-9.7.39 => org-9.8.3}/.dir-locals.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/CONTRIBUTE.org | 5 + elpa/{org-9.7.39 => org-9.8.3}/COPYING | 2 +- elpa/{org-9.7.39 => org-9.8.3}/Makefile | 12 +- elpa/{org-9.7.39 => org-9.8.3}/README-elpa | 0 elpa/{org-9.7.39 => org-9.8.3}/README.org | 0 elpa/{org-9.7.39 => org-9.8.3}/dir | 0 .../doc/.aspell.org.conf | 0 elpa/{org-9.7.39 => org-9.8.3}/doc/.nosearch | 0 .../doc/Documentation_Standards.org | 0 elpa/{org-9.7.39 => org-9.8.3}/doc/Makefile | 0 elpa/{org-9.7.39 => org-9.8.3}/doc/dir | 0 .../doc/doc-setup.org | 9 +- elpa/{org-9.7.39 => org-9.8.3}/doc/fdl.org | 0 .../doc/htmlxref.cnf | 0 .../doc/org-guide.org | 31 +- .../doc/org-manual.org | 1672 +-- elpa/org-9.8.3/doc/org-version.inc | 3 + elpa/{org-9.7.39 => org-9.8.3}/doc/org.texi | 9261 +++++++++-------- .../{org-9.7.39 => org-9.8.3}/doc/orgcard.tex | 4 +- .../doc/orgguide.texi | 947 +- .../doc/pdflayout.sty | 0 .../{org-9.7.39 => org-9.8.3}/doc/texinfo.tex | 0 elpa/{org-9.7.39 => org-9.8.3}/etc/Makefile | 0 elpa/{org-9.7.39 => org-9.8.3}/etc/ORG-NEWS | 934 +- elpa/{org-9.7.39 => org-9.8.3}/etc/csl/README | 0 .../etc/csl/chicago-author-date.csl | 0 .../etc/csl/locales-en-US.xml | 0 .../etc/styles/OrgOdtContentTemplate.xml | 0 .../etc/styles/OrgOdtStyles.xml | 3 - .../etc/styles/README | 2 +- elpa/org-9.8.3/git-hooks/commit-msg | 192 + elpa/org-9.8.3/git-hooks/commit-msg-files.awk | 128 + elpa/org-9.8.3/git-hooks/post-commit | 47 + elpa/org-9.8.3/git-hooks/pre-commit | 83 + elpa/org-9.8.3/git-hooks/pre-push | 88 + elpa/org-9.8.3/git-hooks/prepare-commit-msg | 49 + elpa/{org-9.7.39 => org-9.8.3}/local.mk | 1 + elpa/org-9.8.3/news | 105 + elpa/{org-9.7.39 => org-9.8.3}/ob-C.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ob-R.el | 74 +- elpa/{org-9.7.39 => org-9.8.3}/ob-awk.el | 9 +- elpa/{org-9.7.39 => org-9.8.3}/ob-calc.el | 33 +- elpa/{org-9.7.39 => org-9.8.3}/ob-clojure.el | 15 +- elpa/{org-9.7.39 => org-9.8.3}/ob-comint.el | 130 +- elpa/{org-9.7.39 => org-9.8.3}/ob-core.el | 130 +- elpa/org-9.8.3/ob-csharp.el | 304 + elpa/{org-9.7.39 => org-9.8.3}/ob-css.el | 2 +- elpa/org-9.8.3/ob-ditaa.el | 209 + elpa/{org-9.7.39 => org-9.8.3}/ob-dot.el | 2 +- .../ob-emacs-lisp.el | 9 +- elpa/{org-9.7.39 => org-9.8.3}/ob-eshell.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-eval.el | 16 +- elpa/{org-9.7.39 => org-9.8.3}/ob-exp.el | 22 +- elpa/{org-9.7.39 => org-9.8.3}/ob-forth.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-fortran.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-gnuplot.el | 8 +- elpa/{org-9.7.39 => org-9.8.3}/ob-groovy.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ob-haskell.el | 6 +- elpa/{org-9.7.39 => org-9.8.3}/ob-java.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-js.el | 11 +- elpa/{org-9.7.39 => org-9.8.3}/ob-julia.el | 37 +- elpa/{org-9.7.39 => org-9.8.3}/ob-latex.el | 39 +- elpa/{org-9.7.39 => org-9.8.3}/ob-lilypond.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-lisp.el | 17 +- elpa/{org-9.7.39 => org-9.8.3}/ob-lob.el | 62 +- elpa/org-9.8.3/ob-lua.el | 254 + elpa/{org-9.7.39 => org-9.8.3}/ob-makefile.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-matlab.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-maxima.el | 8 +- elpa/{org-9.7.39 => org-9.8.3}/ob-ocaml.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ob-octave.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-org.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-perl.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-plantuml.el | 2 +- .../ob-processing.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ob-python.el | 33 +- elpa/{org-9.7.39 => org-9.8.3}/ob-ref.el | 6 +- elpa/{org-9.7.39 => org-9.8.3}/ob-ruby.el | 14 +- elpa/{org-9.7.39 => org-9.8.3}/ob-sass.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-scheme.el | 84 +- elpa/{org-9.7.39 => org-9.8.3}/ob-screen.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ob-sed.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ob-shell.el | 82 +- elpa/{org-9.7.39 => org-9.8.3}/ob-sql.el | 102 +- elpa/{org-9.7.39 => org-9.8.3}/ob-sqlite.el | 13 +- elpa/{org-9.7.39 => org-9.8.3}/ob-table.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ob-tangle.el | 49 +- elpa/{org-9.7.39 => org-9.8.3}/ob.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/oc-basic.el | 114 +- elpa/{org-9.7.39 => org-9.8.3}/oc-biblatex.el | 6 +- elpa/{org-9.7.39 => org-9.8.3}/oc-bibtex.el | 35 +- elpa/{org-9.7.39 => org-9.8.3}/oc-csl.el | 99 +- elpa/{org-9.7.39 => org-9.8.3}/oc-natbib.el | 6 +- elpa/{org-9.7.39 => org-9.8.3}/oc.el | 16 +- elpa/{org-9.7.39 => org-9.8.3}/ol-bbdb.el | 12 +- elpa/{org-9.7.39 => org-9.8.3}/ol-bibtex.el | 10 +- elpa/{org-9.7.39 => org-9.8.3}/ol-docview.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ol-doi.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ol-eshell.el | 8 +- elpa/{org-9.7.39 => org-9.8.3}/ol-eww.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ol-gnus.el | 35 +- elpa/{org-9.7.39 => org-9.8.3}/ol-info.el | 38 +- elpa/{org-9.7.39 => org-9.8.3}/ol-irc.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ol-man.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/ol-mhe.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ol-rmail.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ol-w3m.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ol.el | 1055 +- elpa/{org-9.7.39 => org-9.8.3}/org-agenda.el | 476 +- elpa/{org-9.7.39 => org-9.8.3}/org-archive.el | 222 +- .../org-attach-git.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/org-attach.el | 92 +- .../org-autoloads.el | 206 +- elpa/{org-9.7.39 => org-9.8.3}/org-capture.el | 701 +- elpa/{org-9.7.39 => org-9.8.3}/org-clock.el | 116 +- elpa/{org-9.7.39 => org-9.8.3}/org-colview.el | 186 +- elpa/{org-9.7.39 => org-9.8.3}/org-compat.el | 288 +- elpa/{org-9.7.39 => org-9.8.3}/org-crypt.el | 3 +- elpa/{org-9.7.39 => org-9.8.3}/org-ctags.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/org-cycle.el | 60 +- elpa/org-9.8.3/org-datetree.el | 376 + .../{org-9.7.39 => org-9.8.3}/org-duration.el | 2 +- .../org-element-ast.el | 34 +- elpa/{org-9.7.39 => org-9.8.3}/org-element.el | 422 +- .../{org-9.7.39 => org-9.8.3}/org-entities.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/org-faces.el | 69 +- elpa/{org-9.7.39 => org-9.8.3}/org-feed.el | 3 +- .../org-fold-core.el | 71 +- elpa/{org-9.7.39 => org-9.8.3}/org-fold.el | 14 +- .../{org-9.7.39 => org-9.8.3}/org-footnote.el | 28 +- elpa/{org-9.7.39 => org-9.8.3}/org-goto.el | 13 +- elpa/{org-9.7.39 => org-9.8.3}/org-habit.el | 26 +- elpa/{org-9.7.39 => org-9.8.3}/org-id.el | 66 +- elpa/{org-9.7.39 => org-9.8.3}/org-indent.el | 24 +- .../org-inlinetask.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/org-keys.el | 181 +- elpa/{org-9.7.39 => org-9.8.3}/org-lint.el | 101 +- elpa/{org-9.7.39 => org-9.8.3}/org-list.el | 45 +- .../{org-9.7.39 => org-9.8.3}/org-loaddefs.el | 1202 ++- elpa/{org-9.7.39 => org-9.8.3}/org-macro.el | 11 +- elpa/{org-9.7.39 => org-9.8.3}/org-macs.el | 189 +- elpa/{org-9.7.39 => org-9.8.3}/org-mobile.el | 6 +- elpa/{org-9.7.39 => org-9.8.3}/org-mouse.el | 16 +- elpa/{org-9.7.39 => org-9.8.3}/org-num.el | 6 +- .../org-pcomplete.el | 55 +- elpa/{org-9.7.39 => org-9.8.3}/org-persist.el | 248 +- elpa/org-9.8.3/org-pkg.el | 2 + elpa/{org-9.7.39 => org-9.8.3}/org-plot.el | 82 +- .../{org-9.7.39 => org-9.8.3}/org-protocol.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/org-refile.el | 128 +- elpa/{org-9.7.39 => org-9.8.3}/org-src.el | 258 +- elpa/{org-9.7.39 => org-9.8.3}/org-table.el | 551 +- elpa/{org-9.7.39 => org-9.8.3}/org-tempo.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/org-timer.el | 20 +- elpa/{org-9.7.39 => org-9.8.3}/org-version.el | 4 +- elpa/{org-9.7.39 => org-9.8.3}/org.el | 1893 ++-- elpa/{org-9.7.39 => org-9.8.3}/org.info | 4085 ++++---- elpa/{org-9.7.39 => org-9.8.3}/orgguide.info | 302 +- elpa/{org-9.7.39 => org-9.8.3}/ox-ascii.el | 9 +- elpa/{org-9.7.39 => org-9.8.3}/ox-beamer.el | 12 +- elpa/{org-9.7.39 => org-9.8.3}/ox-html.el | 164 +- .../{org-9.7.39 => org-9.8.3}/ox-icalendar.el | 35 +- .../ox-koma-letter.el | 2 +- elpa/{org-9.7.39 => org-9.8.3}/ox-latex.el | 425 +- elpa/{org-9.7.39 => org-9.8.3}/ox-man.el | 58 +- elpa/{org-9.7.39 => org-9.8.3}/ox-md.el | 35 +- elpa/{org-9.7.39 => org-9.8.3}/ox-odt.el | 249 +- elpa/{org-9.7.39 => org-9.8.3}/ox-org.el | 5 +- elpa/{org-9.7.39 => org-9.8.3}/ox-publish.el | 81 +- elpa/{org-9.7.39 => org-9.8.3}/ox-texinfo.el | 234 +- elpa/{org-9.7.39 => org-9.8.3}/ox.el | 200 +- init.el | 2 +- 180 files changed, 18893 insertions(+), 13231 deletions(-) delete mode 100644 elpa/org-9.7.39.signed delete mode 100644 elpa/org-9.7.39/doc/org-version.inc delete mode 100644 elpa/org-9.7.39/ob-ditaa.el delete mode 100644 elpa/org-9.7.39/ob-lua.el delete mode 100644 elpa/org-9.7.39/org-datetree.el delete mode 100644 elpa/org-9.7.39/org-pkg.el create mode 100644 elpa/org-9.8.3.signed rename elpa/{org-9.7.39 => org-9.8.3}/.dir-locals.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/CONTRIBUTE.org (81%) rename elpa/{org-9.7.39 => org-9.8.3}/COPYING (99%) rename elpa/{org-9.7.39 => org-9.8.3}/Makefile (91%) rename elpa/{org-9.7.39 => org-9.8.3}/README-elpa (100%) rename elpa/{org-9.7.39 => org-9.8.3}/README.org (100%) rename elpa/{org-9.7.39 => org-9.8.3}/dir (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/.aspell.org.conf (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/.nosearch (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/Documentation_Standards.org (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/Makefile (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/dir (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/doc-setup.org (88%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/fdl.org (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/htmlxref.cnf (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/org-guide.org (98%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/org-manual.org (94%) create mode 100644 elpa/org-9.8.3/doc/org-version.inc rename elpa/{org-9.7.39 => org-9.8.3}/doc/org.texi (68%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/orgcard.tex (99%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/orgguide.texi (67%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/pdflayout.sty (100%) rename elpa/{org-9.7.39 => org-9.8.3}/doc/texinfo.tex (100%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/Makefile (100%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/ORG-NEWS (89%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/csl/README (100%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/csl/chicago-author-date.csl (100%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/csl/locales-en-US.xml (100%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/styles/OrgOdtContentTemplate.xml (100%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/styles/OrgOdtStyles.xml (99%) rename elpa/{org-9.7.39 => org-9.8.3}/etc/styles/README (95%) create mode 100755 elpa/org-9.8.3/git-hooks/commit-msg create mode 100644 elpa/org-9.8.3/git-hooks/commit-msg-files.awk create mode 100755 elpa/org-9.8.3/git-hooks/post-commit create mode 100755 elpa/org-9.8.3/git-hooks/pre-commit create mode 100755 elpa/org-9.8.3/git-hooks/pre-push create mode 100755 elpa/org-9.8.3/git-hooks/prepare-commit-msg rename elpa/{org-9.7.39 => org-9.8.3}/local.mk (97%) create mode 100644 elpa/org-9.8.3/news rename elpa/{org-9.7.39 => org-9.8.3}/ob-C.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-R.el (90%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-awk.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-calc.el (79%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-clojure.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-comint.el (77%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-core.el (96%) create mode 100644 elpa/org-9.8.3/ob-csharp.el rename elpa/{org-9.7.39 => org-9.8.3}/ob-css.el (96%) create mode 100644 elpa/org-9.8.3/ob-ditaa.el rename elpa/{org-9.7.39 => org-9.8.3}/ob-dot.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-emacs-lisp.el (91%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-eshell.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-eval.el (93%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-exp.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-forth.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-fortran.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-gnuplot.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-groovy.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-haskell.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-java.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-js.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-julia.el (91%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-latex.el (89%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-lilypond.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-lisp.el (93%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-lob.el (80%) create mode 100644 elpa/org-9.8.3/ob-lua.el rename elpa/{org-9.7.39 => org-9.8.3}/ob-makefile.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-matlab.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-maxima.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-ocaml.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-octave.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-org.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-perl.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-plantuml.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-processing.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-python.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-ref.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-ruby.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-sass.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-scheme.el (79%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-screen.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-sed.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-shell.el (83%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-sql.el (80%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-sqlite.el (93%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-table.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ob-tangle.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/ob.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/oc-basic.el (90%) rename elpa/{org-9.7.39 => org-9.8.3}/oc-biblatex.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/oc-bibtex.el (71%) rename elpa/{org-9.7.39 => org-9.8.3}/oc-csl.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/oc-natbib.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/oc.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-bbdb.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-bibtex.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-docview.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-doi.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-eshell.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-eww.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-gnus.el (89%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-info.el (86%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-irc.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-man.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-mhe.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-rmail.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ol-w3m.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ol.el (67%) rename elpa/{org-9.7.39 => org-9.8.3}/org-agenda.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/org-archive.el (80%) rename elpa/{org-9.7.39 => org-9.8.3}/org-attach-git.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/org-attach.el (91%) rename elpa/{org-9.7.39 => org-9.8.3}/org-autoloads.el (87%) rename elpa/{org-9.7.39 => org-9.8.3}/org-capture.el (79%) rename elpa/{org-9.7.39 => org-9.8.3}/org-clock.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/org-colview.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/org-compat.el (86%) rename elpa/{org-9.7.39 => org-9.8.3}/org-crypt.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-ctags.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-cycle.el (96%) create mode 100644 elpa/org-9.8.3/org-datetree.el rename elpa/{org-9.7.39 => org-9.8.3}/org-duration.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-element-ast.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/org-element.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/org-entities.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-faces.el (94%) rename elpa/{org-9.7.39 => org-9.8.3}/org-feed.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-fold-core.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/org-fold.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/org-footnote.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/org-goto.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/org-habit.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/org-id.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/org-indent.el (94%) rename elpa/{org-9.7.39 => org-9.8.3}/org-inlinetask.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-keys.el (86%) rename elpa/{org-9.7.39 => org-9.8.3}/org-lint.el (94%) rename elpa/{org-9.7.39 => org-9.8.3}/org-list.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/org-loaddefs.el (75%) rename elpa/{org-9.7.39 => org-9.8.3}/org-macro.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/org-macs.el (91%) rename elpa/{org-9.7.39 => org-9.8.3}/org-mobile.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-mouse.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/org-num.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/org-pcomplete.el (93%) rename elpa/{org-9.7.39 => org-9.8.3}/org-persist.el (89%) create mode 100644 elpa/org-9.8.3/org-pkg.el rename elpa/{org-9.7.39 => org-9.8.3}/org-plot.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/org-protocol.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-refile.el (90%) rename elpa/{org-9.7.39 => org-9.8.3}/org-src.el (87%) rename elpa/{org-9.7.39 => org-9.8.3}/org-table.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/org-tempo.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/org-timer.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/org-version.el (87%) rename elpa/{org-9.7.39 => org-9.8.3}/org.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/org.info (92%) rename elpa/{org-9.7.39 => org-9.8.3}/orgguide.info (94%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-ascii.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-beamer.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-html.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-icalendar.el (97%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-koma-letter.el (99%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-latex.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-man.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-md.el (95%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-odt.el (94%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-org.el (98%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-publish.el (96%) rename elpa/{org-9.7.39 => org-9.8.3}/ox-texinfo.el (92%) rename elpa/{org-9.7.39 => org-9.8.3}/ox.el (97%) diff --git a/elpa/org-9.7.39.signed b/elpa/org-9.7.39.signed deleted file mode 100644 index 81eb7943..00000000 --- a/elpa/org-9.7.39.signed +++ /dev/null @@ -1 +0,0 @@ -Good signature from 645357D2883A0966 GNU ELPA Signing Agent (2023) (trust undefined) created at 2025-11-30T23:10:01+0100 using EDDSA \ No newline at end of file diff --git a/elpa/org-9.7.39/doc/org-version.inc b/elpa/org-9.7.39/doc/org-version.inc deleted file mode 100644 index 255a7bce..00000000 --- a/elpa/org-9.7.39/doc/org-version.inc +++ /dev/null @@ -1,3 +0,0 @@ -@c automatically generated, do not edit -@set VERSION 9.7.39 (9.7.39-b7bc0ed) -@set DATE 2025-11-30 diff --git a/elpa/org-9.7.39/ob-ditaa.el b/elpa/org-9.7.39/ob-ditaa.el deleted file mode 100644 index 70e42704..00000000 --- a/elpa/org-9.7.39/ob-ditaa.el +++ /dev/null @@ -1,127 +0,0 @@ -;;; ob-ditaa.el --- Babel Functions for ditaa -*- lexical-binding: t; -*- - -;; Copyright (C) 2009-2025 Free Software Foundation, Inc. - -;; Author: Eric Schulte -;; Keywords: literate programming, reproducible research -;; URL: https://orgmode.org - -;; 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 . - -;;; Commentary: - -;; Org-Babel support for evaluating ditaa source code. -;; -;; This differs from most standard languages in that -;; -;; 1) there is no such thing as a "session" in ditaa -;; -;; 2) we are generally only going to return results of type "file" -;; -;; 3) we are adding the "file" and "cmdline" header arguments -;; -;; 4) there are no variables (at least for now) - -;;; Code: - -(require 'org-macs) -(org-assert-version) - -(require 'ob) -(require 'org-compat) - -(defvar org-babel-default-header-args:ditaa - '((:results . "file") - (:exports . "results") - (:java . "-Dfile.encoding=UTF-8")) - "Default arguments for evaluating a ditaa source block.") - -(defcustom org-ditaa-jar-path (expand-file-name - "ditaa.jar" - (file-name-as-directory - (expand-file-name - "scripts" - (file-name-as-directory - (expand-file-name - "../contrib" - (file-name-directory (org-find-library-dir "org"))))))) - "Path to the ditaa jar executable." - :group 'org-babel - :type 'string) - -(defcustom org-babel-ditaa-java-cmd "java" - "Java executable to use when evaluating ditaa blocks." - :group 'org-babel - :type 'string) - -(defcustom org-ditaa-eps-jar-path - (expand-file-name "DitaaEps.jar" (file-name-directory org-ditaa-jar-path)) - "Path to the DitaaEps.jar executable." - :group 'org-babel - :version "24.4" - :package-version '(Org . "8.0") - :type 'string) - -(defcustom org-ditaa-jar-option "-jar" - "Option for the ditaa jar file. -Do not leave leading or trailing spaces in this string." - :group 'org-babel - :version "24.1" - :type 'string) - -(defun org-babel-execute:ditaa (body params) - "Execute BODY of Ditaa code with org-babel according to PARAMS. -This function is called by `org-babel-execute-src-block'." - (let* ((out-file (or (cdr (assq :file params)) - (error - "Ditaa code block requires :file header argument"))) - (cmdline (cdr (assq :cmdline params))) - (java (cdr (assq :java params))) - (in-file (org-babel-temp-file "ditaa-")) - (eps (cdr (assq :eps params))) - (eps-file (when eps - (org-babel-process-file-name (concat in-file ".eps")))) - (pdf-cmd (when (and (or (string= (file-name-extension out-file) "pdf") - (cdr (assq :pdf params)))) - (concat - "epstopdf" - " " eps-file - " -o=" (org-babel-process-file-name out-file)))) - (cmd (concat org-babel-ditaa-java-cmd - " " java " " org-ditaa-jar-option " " - (shell-quote-argument - (expand-file-name - (if eps org-ditaa-eps-jar-path org-ditaa-jar-path))) - " " cmdline - " " (org-babel-process-file-name in-file) - " " (if pdf-cmd - eps-file - (org-babel-process-file-name out-file))))) - (unless (file-exists-p org-ditaa-jar-path) - (error "Could not find ditaa.jar at %s" org-ditaa-jar-path)) - (with-temp-file in-file (insert body)) - (unless noninteractive (message cmd)) - (shell-command cmd) - (when pdf-cmd (unless noninteractive (message pdf-cmd)) (shell-command pdf-cmd)) - nil)) ;; signal that output has already been written to file - -(defun org-babel-prep-session:ditaa (_session _params) - "Return an error because ditaa does not support sessions." - (error "Ditaa does not support sessions")) - -(provide 'ob-ditaa) - -;;; ob-ditaa.el ends here diff --git a/elpa/org-9.7.39/ob-lua.el b/elpa/org-9.7.39/ob-lua.el deleted file mode 100644 index 65804050..00000000 --- a/elpa/org-9.7.39/ob-lua.el +++ /dev/null @@ -1,437 +0,0 @@ -;;; ob-lua.el --- Org Babel functions for Lua evaluation -*- lexical-binding: t; -*- - -;; Copyright (C) 2014, 2016-2025 Free Software Foundation, Inc. - -;; Authors: Dieter Schoen -;; Keywords: literate programming, reproducible research -;; URL: https://orgmode.org - -;; 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 . - -;;; Commentary: - -;; Org-Babel support for evaluating Lua source code. - -;; Requirements: -;; for session support, lua-mode is needed. -;; -;; lua-mode is not part of GNU Emacs/orgmode, but can be obtained -;; from NonGNU ELPA (see `M-x list-packages'). -;; -;; The source repository is here: -;; https://github.com/immerrr/lua-mode - -;; However, sessions are not yet working. - -;;; Code: - -(require 'org-macs) -(org-assert-version) - -(require 'ob) -(require 'org-macs) -(require 'cl-lib) - -(declare-function lua-shell "ext:lua-mode" (&optional argprompt)) -(declare-function lua-toggle-shells "ext:lua-mode" (arg)) -(declare-function run-lua "ext:lua" (cmd &optional dedicated show)) - -(defvar org-babel-tangle-lang-exts) -(add-to-list 'org-babel-tangle-lang-exts '("lua" . "lua")) - -(defvar org-babel-default-header-args:lua '()) - -(defcustom org-babel-lua-command "lua" - "Name of the command for executing Lua code." - :version "26.1" - :package-version '(Org . "8.3") - :group 'org-babel - :type 'string) - -(defcustom org-babel-lua-mode 'lua-mode - "Preferred lua mode for use in running lua interactively. -This will typically be `lua-mode'." - :group 'org-babel - :version "26.1" - :package-version '(Org . "8.3") - :type 'symbol) - -(defcustom org-babel-lua-hline-to "None" - "Replace hlines in incoming tables with this when translating to Lua." - :group 'org-babel - :version "26.1" - :package-version '(Org . "8.3") - :type 'string) - -(defcustom org-babel-lua-None-to 'hline - "Replace `None' in Lua tables with this before returning." - :group 'org-babel - :version "26.1" - :package-version '(Org . "8.3") - :type 'symbol) - -(defcustom org-babel-lua-multiple-values-separator ", " - "Separate multiple values with this string." - :group 'org-babel - :package-version '(Org . "9.7") - :type 'string) - -(defun org-babel-execute:lua (body params) - "Execute Lua BODY according to PARAMS. -This function is called by `org-babel-execute-src-block'." - (let* ((session (org-babel-lua-initiate-session - (cdr (assq :session params)))) - (result-params (cdr (assq :result-params params))) - (result-type (cdr (assq :result-type params))) - (return-val (when (and (eq result-type 'value) (not session)) - (cdr (assq :return params)))) - (preamble (cdr (assq :preamble params))) - (full-body - (org-babel-expand-body:generic - (concat body (if return-val (format "\nreturn %s" return-val) "")) - params (org-babel-variable-assignments:lua params))) - (result (org-babel-lua-evaluate - session full-body result-type result-params preamble))) - (org-babel-reassemble-table - result - (org-babel-pick-name (cdr (assq :colname-names params)) - (cdr (assq :colnames params))) - (org-babel-pick-name (cdr (assq :rowname-names params)) - (cdr (assq :rownames params)))))) - -(defun org-babel-prep-session:lua (session params) - "Prepare SESSION according to the header arguments in PARAMS. -VARS contains resolved variable references." - (let* ((session (org-babel-lua-initiate-session session)) - (var-lines - (org-babel-variable-assignments:lua params))) - (org-babel-comint-in-buffer session - (mapc (lambda (var) - (end-of-line 1) (insert var) (comint-send-input) - (org-babel-comint-wait-for-output session)) - var-lines)) - session)) - -(defun org-babel-load-session:lua (session body params) - "Load BODY into SESSION." - (save-window-excursion - (let ((buffer (org-babel-prep-session:lua session params))) - (with-current-buffer buffer - (goto-char (process-mark (get-buffer-process (current-buffer)))) - (insert (org-babel-chomp body))) - buffer))) - -;; helper functions - -(defun org-babel-variable-assignments:lua (params) - "Return a list of Lua statements assigning the block's variables. -The variable definitions are defining in PARAMS." - (mapcar - (lambda (pair) - (format "%s=%s" - (car pair) - (org-babel-lua-var-to-lua (cdr pair)))) - (org-babel--get-vars params))) - -(defun org-babel-lua-var-to-lua (var) - "Convert an Emacs Lisp value to a Lua variable. -Convert an Emacs Lisp value, VAR, into a string of Lua source code -specifying a variable of the same value." - (if (listp var) - (if (and (= 1 (length var)) (not (listp (car var)))) - (org-babel-lua-var-to-lua (car var)) - (if (and - (= 2 (length var)) - (not (listp (car var)))) - (concat - (substring-no-properties (car var)) - "=" - (org-babel-lua-var-to-lua (cdr var))) - (concat "{" (mapconcat #'org-babel-lua-var-to-lua var ", ") "}"))) - (if (eq var 'hline) - org-babel-lua-hline-to - (format - (if (and (stringp var) (string-match "[\n\r]" var)) "[=[%s]=]" "%S") - (if (stringp var) (substring-no-properties var) var))))) - -(defun org-babel-lua-table-or-string (results) - "Convert RESULTS into an appropriate elisp value. -If the results look like a list or tuple, then convert them into an -Emacs-lisp table, otherwise return the results as a string." - (let ((res (org-babel-script-escape results))) - (if (listp res) - (mapcar (lambda (el) (if (eq el 'None) - org-babel-lua-None-to el)) - res) - res))) - -(defvar org-babel-lua-buffers '((:default . "*Lua*"))) - -(defun org-babel-lua-session-buffer (session) - "Return the buffer associated with SESSION." - (cdr (assoc session org-babel-lua-buffers))) - -(defun org-babel-lua-with-earmuffs (session) - "Return buffer name for SESSION, as *SESSION*." - (let ((name (if (stringp session) session (format "%s" session)))) - (if (and (string= "*" (substring name 0 1)) - (string= "*" (substring name (- (length name) 1)))) - name - (format "*%s*" name)))) - -(defun org-babel-session-buffer:lua (session &optional _) - "Return session buffer name for SESSION." - (or (org-babel-lua-session-buffer session) - (org-babel-lua-with-earmuffs session))) - -(defun org-babel-lua-without-earmuffs (session) -"Remove stars around *SESSION*, leaving SESSION." - (let ((name (if (stringp session) session (format "%s" session)))) - (if (and (string= "*" (substring name 0 1)) - (string= "*" (substring name (- (length name) 1)))) - (substring name 1 (- (length name) 1)) - name))) - -(defvar lua-default-interpreter) -(defvar lua-which-bufname) -(defvar lua-shell-buffer-name) -(defun org-babel-lua-initiate-session-by-key (&optional session) - "Initiate a Lua session. -If there is not a current inferior-process-buffer in SESSION -then create. Return the initialized session." - ;; (require org-babel-lua-mode) - (save-window-excursion - (let* ((session (if session (intern session) :default)) - (lua-buffer (org-babel-lua-session-buffer session)) - ;; (cmd (if (member system-type '(cygwin windows-nt ms-dos)) - ;; (concat org-babel-lua-command " -i") - ;; org-babel-lua-command)) - ) - (cond - ((and (eq 'lua-mode org-babel-lua-mode) - (fboundp 'lua-start-process)) ; lua-mode.el - ;; Make sure that lua-which-bufname is initialized, as otherwise - ;; it will be overwritten the first time a Lua buffer is - ;; created. - ;;(lua-toggle-shells lua-default-interpreter) - ;; `lua-shell' creates a buffer whose name is the value of - ;; `lua-which-bufname' with '*'s at the beginning and end - (let* ((bufname (if (and lua-buffer (buffer-live-p lua-buffer)) - (replace-regexp-in-string ;; zap surrounding * - "^\\*\\([^*]+\\)\\*$" "\\1" (buffer-name lua-buffer)) - (concat "Lua-" (symbol-name session)))) - (lua-which-bufname bufname)) - (lua-start-process) - (setq lua-buffer (org-babel-lua-with-earmuffs bufname)))) - (t - (error "No function available for running an inferior Lua"))) - (setq org-babel-lua-buffers - (cons (cons session lua-buffer) - (assq-delete-all session org-babel-lua-buffers))) - session))) - -(defun org-babel-lua-initiate-session (&optional session _params) - "Create a session named SESSION according to PARAMS." - (unless (string= session "none") - (error "Sessions currently not supported, work in progress") - (org-babel-lua-session-buffer - (org-babel-lua-initiate-session-by-key session)))) - -(defvar org-babel-lua-eoe-indicator "--eoe" - "A string to indicate that evaluation has completed.") - -(defvar org-babel-lua-wrapper-method - " -function main() -%s -end - -function dump(it, indent) - if indent == nil then - indent = '' - end - if type(it) == 'table' and %s then - local count = 0 - for _ in pairs(it) do - count = count + 1 - end - local result = '' - if #indent ~= 0 then - result = result .. '\\n' - end - for key, value in pairs(it) do - result = result - .. indent - .. dump(key) - .. ' = ' - .. dump(value, indent .. ' ') - count = count - 1 - if count ~= 0 then - result = result .. '\\n' - end - end - return result - else - return tostring(it) - end -end - -function combine(...) - local result = {} - for index = 1, select('#', ...) do - result[index] = dump(select(index, ...)) - end - return table.concat(result, '%s') -end - -output = io.open('%s', 'w') -output:write(combine(main())) -output:close()") - -(defun org-babel-lua-evaluate - (session body &optional result-type result-params preamble) - "Evaluate BODY in SESSION as Lua code. -RESULT-TYPE and RESULT-PARAMS are passed to -`org-babel-lua-evaluate-session' or -`org-babel-lua-evaluate-external-process'. -PREAMBLE is passed to `org-babel-lua-evaluate-external-process'." - (if session - (org-babel-lua-evaluate-session - session body result-type result-params) - (org-babel-lua-evaluate-external-process - body result-type result-params preamble))) - -(defun org-babel-lua-evaluate-external-process - (body &optional result-type result-params preamble) - "Evaluate BODY in external Lua process. -If RESULT-TYPE equals `output' then return standard output as a -string. If RESULT-TYPE equals `value' then return the value of the -last statement in BODY, as Emacs Lisp. -RESULT-PARAMS list all the :result header arg parameters. -PREAMBLE string is appended to BODY." - (let ((raw - (pcase result-type - (`output (org-babel-eval org-babel-lua-command - (concat preamble (and preamble "\n") - body))) - (`value (let ((tmp-file (org-babel-temp-file "lua-"))) - (org-babel-eval - org-babel-lua-command - (concat - preamble (and preamble "\n") - (format - org-babel-lua-wrapper-method - (mapconcat - (lambda (line) (format "\t%s" line)) - (split-string - (org-remove-indentation - (org-trim body)) - "[\r\n]") - "\n") - (if (member "pp" result-params) - "true" "false") - org-babel-lua-multiple-values-separator - (org-babel-process-file-name tmp-file 'noquote)))) - (org-babel-eval-read-file tmp-file)))))) - (org-babel-result-cond result-params - raw - (org-babel-lua-table-or-string (org-trim raw))))) - -(defun org-babel-lua-evaluate-session - (session body &optional result-type result-params) - "Pass BODY to the Lua process in SESSION. -If RESULT-TYPE equals `output' then return standard output as a -string. If RESULT-TYPE equals `value' then return the value of the -last statement in BODY, as Emacs Lisp." - (let* ((send-wait (lambda () (comint-send-input nil t) (sleep-for 0.005))) - (dump-last-value - (lambda - (tmp-file pp) - (mapc - (lambda (statement) (insert statement) (funcall send-wait)) - (if pp - (list - "-- table to string -function t2s(t, indent) - if indent == nil then - indent = \"\" - end - if type(t) == \"table\" then - ts = \"\" - for k,v in pairs(t) do - if type(v) == \"table\" then - ts = ts .. indent .. t2s(k,indent .. \" \") .. \" = \\n\" .. - t2s(v, indent .. \" \") - else - ts = ts .. indent .. t2s(k,indent .. \" \") .. \" = \" .. - t2s(v, indent .. \" \") .. \"\\n\" - end - end - return ts - else - return tostring(t) - end -end -" - (concat "fd:write(_)) -fd:close()" - (org-babel-process-file-name tmp-file 'noquote))) - (list (format "fd=io.open(\"%s\", \"w\") -fd:write( _ ) -fd:close()" - (org-babel-process-file-name tmp-file - 'noquote))))))) - (input-body (lambda (body) - (mapc (lambda (line) (insert line) (funcall send-wait)) - (split-string body "[\r\n]")) - (funcall send-wait))) - (results - (pcase result-type - (`output - (mapconcat - #'org-trim - (butlast - (org-babel-comint-with-output - (session org-babel-lua-eoe-indicator t body) - (funcall input-body body) - (funcall send-wait) (funcall send-wait) - (insert org-babel-lua-eoe-indicator) - (funcall send-wait)) - 2) "\n")) - (`value - (let ((tmp-file (org-babel-temp-file "lua-"))) - (org-babel-comint-with-output - (session org-babel-lua-eoe-indicator nil body) - (let ((comint-process-echoes nil)) - (funcall input-body body) - (funcall dump-last-value tmp-file - (member "pp" result-params)) - (funcall send-wait) (funcall send-wait) - (insert org-babel-lua-eoe-indicator) - (funcall send-wait))) - (org-babel-eval-read-file tmp-file)))))) - (unless (string= (substring org-babel-lua-eoe-indicator 1 -1) results) - (org-babel-result-cond result-params - results - (org-babel-lua-table-or-string results))))) - -(defun org-babel-lua-read-string (string) - "Strip single quotes from around Lua STRING." - (org-unbracket-string "'" "'" string)) - -(provide 'ob-lua) - -;;; ob-lua.el ends here diff --git a/elpa/org-9.7.39/org-datetree.el b/elpa/org-9.7.39/org-datetree.el deleted file mode 100644 index 9a48ee66..00000000 --- a/elpa/org-9.7.39/org-datetree.el +++ /dev/null @@ -1,289 +0,0 @@ -;;; org-datetree.el --- Create date entries in a tree -*- lexical-binding: t; -*- - -;; Copyright (C) 2009-2025 Free Software Foundation, Inc. - -;; Author: Carsten Dominik -;; Keywords: outlines, hypermedia, calendar, text -;; URL: https://orgmode.org -;; -;; 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 . -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; -;;; Commentary: - -;; This file contains code to create entries in a tree where the top-level -;; nodes represent years, the level 2 nodes represent the months, and the -;; level 1 entries days. - -;;; Code: - -(require 'org-macs) -(org-assert-version) - -(require 'org) - -(defvar org-datetree-base-level 1 - "The level at which years should be placed in the date tree. -This is normally one, but if the buffer has an entry with a -DATE_TREE (or WEEK_TREE for ISO week entries) property (any -value), the date tree will become a subtree under that entry, so -the base level will be properly adjusted.") - -(defcustom org-datetree-add-timestamp nil - "When non-nil, add a time stamp matching date of entry. -Added time stamp is active unless value is `inactive'." - :group 'org-capture - :version "24.3" - :type '(choice - (const :tag "Do not add a time stamp" nil) - (const :tag "Add an inactive time stamp" inactive) - (const :tag "Add an active time stamp" active))) - -;;;###autoload -(defun org-datetree-find-date-create (d &optional keep-restriction) - "Find or create a day entry for date D. -If KEEP-RESTRICTION is non-nil, do not widen the buffer. -When it is nil, the buffer will be widened to make sure an existing date -tree can be found. If it is the symbol `subtree-at-point', then the tree -will be built under the headline at point." - (org-datetree--find-create-group d 'day keep-restriction)) - -;;;###autoload -(defun org-datetree-find-month-create (d &optional keep-restriction) - "Find or create a month entry for date D. -Compared to `org-datetree-find-date-create' this function creates -entries grouped by month instead of days. -If KEEP-RESTRICTION is non-nil, do not widen the buffer. -When it is nil, the buffer will be widened to make sure an existing date -tree can be found. If it is the symbol `subtree-at-point', then the tree -will be built under the headline at point." - (org-datetree--find-create-group d 'month keep-restriction)) - -(defun org-datetree--find-create-group - (d time-grouping &optional keep-restriction) - "Find or create an entry for date D. -If time-period is day, group entries by day. -If time-period is month, then group entries by month." - (setq-local org-datetree-base-level 1) - (save-restriction - (if (eq keep-restriction 'subtree-at-point) - (progn - (unless (org-at-heading-p) (error "Not at heading")) - (widen) - (org-narrow-to-subtree) - (setq-local org-datetree-base-level - (org-get-valid-level (org-current-level) 1))) - (unless keep-restriction (widen)) - ;; Support the old way of tree placement, using a property - (let ((prop (org-find-property "DATE_TREE"))) - (when prop - (goto-char prop) - (setq-local org-datetree-base-level - (org-get-valid-level (org-current-level) 1)) - (org-narrow-to-subtree)))) - (goto-char (point-min)) - (let ((year (calendar-extract-year d)) - (month (calendar-extract-month d)) - (day (calendar-extract-day d))) - (org-datetree--find-create - "\\([12][0-9]\\{3\\}\\)" - year nil nil nil t) - (org-datetree--find-create - "%d-\\([01][0-9]\\) \\w+" - year month nil nil t) - (when (eq time-grouping 'day) - (org-datetree--find-create - "%d-%02d-\\([0123][0-9]\\) \\w+" - year month day nil t))))) - -;;;###autoload -(defun org-datetree-find-iso-week-create (d &optional keep-restriction) - "Find or create an ISO week entry for date D. -Compared to `org-datetree-find-date-create' this function creates -entries ordered by week instead of months. -When it is nil, the buffer will be widened to make sure an existing date -tree can be found. If it is the symbol `subtree-at-point', then the tree -will be built under the headline at point." - (setq-local org-datetree-base-level 1) - (save-restriction - (if (eq keep-restriction 'subtree-at-point) - (progn - (unless (org-at-heading-p) (error "Not at heading")) - (widen) - (org-narrow-to-subtree) - (setq-local org-datetree-base-level - (org-get-valid-level (org-current-level) 1))) - (unless keep-restriction (widen)) - ;; Support the old way of tree placement, using a property - (let ((prop (org-find-property "WEEK_TREE"))) - (when prop - (goto-char prop) - (setq-local org-datetree-base-level - (org-get-valid-level (org-current-level) 1)) - (org-narrow-to-subtree)))) - (goto-char (point-min)) - (require 'cal-iso) - (let* ((year (calendar-extract-year d)) - (month (calendar-extract-month d)) - (day (calendar-extract-day d)) - (time (org-encode-time 0 0 0 day month year)) - (iso-date (calendar-iso-from-absolute - (calendar-absolute-from-gregorian d))) - (weekyear (nth 2 iso-date)) - (week (nth 0 iso-date))) - ;; ISO 8601 week format is %G-W%V(-%u) - (org-datetree--find-create - "\\([12][0-9]\\{3\\}\\)" - weekyear nil nil (format-time-string "%G" time) t) - (org-datetree--find-create - "%d-W\\([0-5][0-9]\\)" - weekyear week nil (format-time-string "%G-W%V" time) t) - ;; For the actual day we use the regular date instead of ISO week. - (org-datetree--find-create - "%d-%02d-\\([0123][0-9]\\) \\w+" year month day nil t)))) - -(defun org-datetree--find-create - (regex-template year &optional month day insert match-title) - "Find the datetree matched by REGEX-TEMPLATE for YEAR, MONTH, or DAY. -REGEX-TEMPLATE is passed to `format' with YEAR, MONTH, and DAY as -arguments. - -If MATCH-TITLE is non-nil, REGEX-TEMPLATE is matched against -heading title and the exact regexp matched against heading line is: - - (format org-complex-heading-regexp-format - (format regex-template year month day)) - -If MATCH-TITLE is nil, the regexp matched against heading line is -REGEX-TEMPLATE: - - (format regex-template year month day) - -Match group 1 in REGEX-TEMPLATE is compared against the specified date -component. If INSERT is non-nil and there is no match then it is -inserted into the buffer." - (when (or month day) - (org-narrow-to-subtree)) - ;; ensure that the first match group in REGEX-TEMPLATE - ;; is the first inside `org-complex-heading-regexp-format' - (when (and match-title - (not (string-match-p "\\\\(\\?1:" regex-template)) - (string-match "\\\\(" regex-template)) - (setq regex-template (replace-match "\\(?1:" nil t regex-template))) - (let ((re (if match-title - (format org-complex-heading-regexp-format - (format regex-template year month day)) - (format regex-template year month day))) - match) - (goto-char (point-min)) - (while (and (setq match (re-search-forward re nil t)) - (goto-char (match-beginning 1)) - (< (string-to-number (match-string 1)) (or day month year)))) - (cond - ((not match) - (goto-char (point-max)) - (unless (bolp) (insert "\n")) - (org-datetree-insert-line year month day insert)) - ((= (string-to-number (match-string 1)) (or day month year)) - (forward-line 0)) - (t - (forward-line 0) - (org-datetree-insert-line year month day insert))))) - -(defun org-datetree-insert-line (year &optional month day text) - (delete-region (save-excursion (skip-chars-backward " \t\n") (point)) (point)) - (when (org--blank-before-heading-p) (insert "\n")) - (insert "\n" (make-string org-datetree-base-level ?*) " \n") - (backward-char) - (when month (org-do-demote)) - (when day (org-do-demote)) - (if text - (insert text) - (insert (format "%d" year)) - (when month - (insert - (if day - (format-time-string "-%m-%d %A" (org-encode-time 0 0 0 day month year)) - (format-time-string "-%m %B" (org-encode-time 0 0 0 1 month year)))))) - (when (and day org-datetree-add-timestamp) - (save-excursion - (insert "\n") - (org-indent-line) - (org-insert-timestamp - (org-encode-time 0 0 0 day month year) - nil - (eq org-datetree-add-timestamp 'inactive)))) - (forward-line 0)) - -(defun org-datetree-file-entry-under (txt d) - "Insert a node TXT into the date tree under date D." - (org-datetree-find-date-create d) - (let ((level (org-get-valid-level (funcall outline-level) 1))) - (org-end-of-subtree t t) - (org-back-over-empty-lines) - (org-paste-subtree level txt))) - -(defun org-datetree-cleanup () - "Make sure all entries in the current tree are under the correct date. -It may be useful to restrict the buffer to the applicable portion -before running this command, even though the command tries to be smart." - (interactive) - (goto-char (point-min)) - (let ((dre (concat "\\<" org-deadline-string "\\>[ \t]*\\'")) - (sre (concat "\\<" org-scheduled-string "\\>[ \t]*\\'"))) - (while (re-search-forward org-ts-regexp nil t) - (catch 'next - (let ((tmp (buffer-substring - (max (line-beginning-position) - (- (match-beginning 0) org-ds-keyword-length)) - (match-beginning 0)))) - (when (or (string-suffix-p "-" tmp) - (string-match dre tmp) - (string-match sre tmp)) - (throw 'next nil)) - (let* ((dct (decode-time (org-time-string-to-time (match-string 0)))) - (date (list (nth 4 dct) (nth 3 dct) (nth 5 dct))) - (year (nth 2 date)) - (month (car date)) - (day (nth 1 date)) - (pos (point)) - (hdl-pos (progn (org-back-to-heading t) (point)))) - (unless (org-up-heading-safe) - ;; No parent, we are not in a date tree. - (goto-char pos) - (throw 'next nil)) - (unless (looking-at "\\*+[ \t]+[0-9]+-[0-1][0-9]-[0-3][0-9]") - ;; Parent looks wrong, we are not in a date tree. - (goto-char pos) - (throw 'next nil)) - (when (looking-at (format "\\*+[ \t]+%d-%02d-%02d" year month day)) - ;; At correct date already, do nothing. - (goto-char pos) - (throw 'next nil)) - ;; OK, we need to refile this entry. - (goto-char hdl-pos) - (org-cut-subtree) - (save-excursion - (save-restriction - (org-datetree-file-entry-under (current-kill 0) date))))))))) - -(provide 'org-datetree) - -;; Local variables: -;; generated-autoload-file: "org-loaddefs.el" -;; End: - -;;; org-datetree.el ends here diff --git a/elpa/org-9.7.39/org-pkg.el b/elpa/org-9.7.39/org-pkg.el deleted file mode 100644 index 95ba91db..00000000 --- a/elpa/org-9.7.39/org-pkg.el +++ /dev/null @@ -1,2 +0,0 @@ -;; Generated package description from org.el -*- no-byte-compile: t -*- -(define-package "org" "9.7.39" "Outline-based notes management and organizer" '((emacs "26.1")) :commit "b7bc0ede67f3e2a477f4d6ad0c46a6d80bca5aea" :authors '(("Carsten Dominik" . "carsten.dominik@gmail.com")) :maintainer '("Ihor Radchenko" . "yantar92@posteo.net") :keywords '("outlines" "hypermedia" "calendar" "text") :url "https://orgmode.org") diff --git a/elpa/org-9.8.3.signed b/elpa/org-9.8.3.signed new file mode 100644 index 00000000..574eeaed --- /dev/null +++ b/elpa/org-9.8.3.signed @@ -0,0 +1 @@ +Good signature from 645357D2883A0966 GNU ELPA Signing Agent (2023) (trust undefined) created at 2026-04-18T23:10:02+0200 using EDDSA \ No newline at end of file diff --git a/elpa/org-9.7.39/.dir-locals.el b/elpa/org-9.8.3/.dir-locals.el similarity index 92% rename from elpa/org-9.7.39/.dir-locals.el rename to elpa/org-9.8.3/.dir-locals.el index 83e51000..9cd2938b 100644 --- a/elpa/org-9.7.39/.dir-locals.el +++ b/elpa/org-9.8.3/.dir-locals.el @@ -11,7 +11,7 @@ (org-mode (indent-tabs-mode) (org-adapt-indentation) - (org-edit-src-content-indentation . 0) + (org-src-content-indentation . 0) (org-footnote-auto-adjust . t) (org-footnote-auto-label . t) (org-footnote-define-inline . nil) diff --git a/elpa/org-9.7.39/CONTRIBUTE.org b/elpa/org-9.8.3/CONTRIBUTE.org similarity index 81% rename from elpa/org-9.7.39/CONTRIBUTE.org rename to elpa/org-9.8.3/CONTRIBUTE.org index 8f94e875..93afb08e 100644 --- a/elpa/org-9.7.39/CONTRIBUTE.org +++ b/elpa/org-9.8.3/CONTRIBUTE.org @@ -16,6 +16,11 @@ You can contribute with bug reports and patches. See these [[https://orgmode.org/worg/org-contribute.html#org069b83a][directions]]. +** Git Hooks + +We provide several git hook scripts to facilitate validation of commit +messages and structure. See [[https://orgmode.org/worg/org-contribute.html#git-hooks][these directions]] for how to set them up. + * As an Org maintainer We encourage you to volunteer to maintain one of the Org files. diff --git a/elpa/org-9.7.39/COPYING b/elpa/org-9.8.3/COPYING similarity index 99% rename from elpa/org-9.7.39/COPYING rename to elpa/org-9.8.3/COPYING index e6000869..f288702d 100644 --- a/elpa/org-9.7.39/COPYING +++ b/elpa/org-9.8.3/COPYING @@ -671,4 +671,4 @@ into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read -. +. diff --git a/elpa/org-9.7.39/Makefile b/elpa/org-9.8.3/Makefile similarity index 91% rename from elpa/org-9.7.39/Makefile rename to elpa/org-9.8.3/Makefile index c570d9cf..111d62d4 100644 --- a/elpa/org-9.7.39/Makefile +++ b/elpa/org-9.8.3/Makefile @@ -19,7 +19,7 @@ _ORGCM_ := dirall single native source slint1 slint2 install clean cleanauto cleanall cleanelc clean-install # do not clean here, done in toplevel make -all compile compile-dirty:: | autoloads +all compile compile-dirty:: autoloads ifeq ($(filter-out $(_ORGCM_),$(ORGCM)),) $(MAKE) compile-$(ORGCM) else @@ -27,11 +27,11 @@ else endif compile-dirall: dirall -compile-single: $(LISPC) | single -compile-native: $(LISPN) | native -compile-source: | source dirall -compile-slint1: | dirall slint1 -compile-slint2: | source dirall slint1 +compile-single: single $(LISPC) +compile-native: native $(LISPN) +compile-source: source dirall +compile-slint1: dirall slint1 +compile-slint2: source dirall slint1 # internal dirall: diff --git a/elpa/org-9.7.39/README-elpa b/elpa/org-9.8.3/README-elpa similarity index 100% rename from elpa/org-9.7.39/README-elpa rename to elpa/org-9.8.3/README-elpa diff --git a/elpa/org-9.7.39/README.org b/elpa/org-9.8.3/README.org similarity index 100% rename from elpa/org-9.7.39/README.org rename to elpa/org-9.8.3/README.org diff --git a/elpa/org-9.7.39/dir b/elpa/org-9.8.3/dir similarity index 100% rename from elpa/org-9.7.39/dir rename to elpa/org-9.8.3/dir diff --git a/elpa/org-9.7.39/doc/.aspell.org.conf b/elpa/org-9.8.3/doc/.aspell.org.conf similarity index 100% rename from elpa/org-9.7.39/doc/.aspell.org.conf rename to elpa/org-9.8.3/doc/.aspell.org.conf diff --git a/elpa/org-9.7.39/doc/.nosearch b/elpa/org-9.8.3/doc/.nosearch similarity index 100% rename from elpa/org-9.7.39/doc/.nosearch rename to elpa/org-9.8.3/doc/.nosearch diff --git a/elpa/org-9.7.39/doc/Documentation_Standards.org b/elpa/org-9.8.3/doc/Documentation_Standards.org similarity index 100% rename from elpa/org-9.7.39/doc/Documentation_Standards.org rename to elpa/org-9.8.3/doc/Documentation_Standards.org diff --git a/elpa/org-9.7.39/doc/Makefile b/elpa/org-9.8.3/doc/Makefile similarity index 100% rename from elpa/org-9.7.39/doc/Makefile rename to elpa/org-9.8.3/doc/Makefile diff --git a/elpa/org-9.7.39/doc/dir b/elpa/org-9.8.3/doc/dir similarity index 100% rename from elpa/org-9.7.39/doc/dir rename to elpa/org-9.8.3/doc/dir diff --git a/elpa/org-9.7.39/doc/doc-setup.org b/elpa/org-9.8.3/doc/doc-setup.org similarity index 88% rename from elpa/org-9.7.39/doc/doc-setup.org rename to elpa/org-9.8.3/doc/doc-setup.org index 19215953..ff3c557d 100644 --- a/elpa/org-9.7.39/doc/doc-setup.org +++ b/elpa/org-9.8.3/doc/doc-setup.org @@ -1,6 +1,6 @@ # SETUPFILE for Org manual -# Copyright (C) 2021-2025 Free Software Foundation, Inc. +# Copyright (C) 2021-2026 Free Software Foundation, Inc. # # This file is part of GNU Emacs. # @@ -29,9 +29,9 @@ # 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} +#+texinfo_header: @set MAINTAINER Ihor Radchenko +#+texinfo_header: @set MAINTAINEREMAIL @email{yantar92@posteo.net} +#+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:yantar92@posteo.net,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 @@ -50,4 +50,3 @@ # The "kbd" macro turns KBD into @kbd{KBD}. Additionally, it # encloses case-sensitive special keys (SPC, RET...) within @key{...}. #+macro: kbd (eval (org-texinfo-kbd-macro $1)) - diff --git a/elpa/org-9.7.39/doc/fdl.org b/elpa/org-9.8.3/doc/fdl.org similarity index 100% rename from elpa/org-9.7.39/doc/fdl.org rename to elpa/org-9.8.3/doc/fdl.org diff --git a/elpa/org-9.7.39/doc/htmlxref.cnf b/elpa/org-9.8.3/doc/htmlxref.cnf similarity index 100% rename from elpa/org-9.7.39/doc/htmlxref.cnf rename to elpa/org-9.8.3/doc/htmlxref.cnf diff --git a/elpa/org-9.7.39/doc/org-guide.org b/elpa/org-9.8.3/doc/org-guide.org similarity index 98% rename from elpa/org-9.7.39/doc/org-guide.org rename to elpa/org-9.8.3/doc/org-guide.org index 20562352..3a1bf59a 100644 --- a/elpa/org-9.7.39/doc/org-guide.org +++ b/elpa/org-9.8.3/doc/org-guide.org @@ -10,7 +10,7 @@ :copying: t :END: -Copyright \copy 2004--2025 Free Software Foundation, Inc. +Copyright \copy 2004--2026 Free Software Foundation, Inc. #+begin_quote Permission is granted to copy, distribute and/or modify this document @@ -34,7 +34,7 @@ modify this GNU manual." Org is a mode for keeping notes, maintaining TODO lists, and doing project planning with a fast and effective plain-text system. It is also an authoring and publishing system, and it supports working with -source code for literal programming and reproducible research. +source code for literate programming and reproducible research. This document is a much compressed derivative of the [[info:org][comprehensive Org mode manual]]. It contains all basic features and commands, along with @@ -99,7 +99,7 @@ reports, see the [[info:org][main manual]]. :END: Org is an outliner. Outlines allow a document to be organized in -a hierarchical structure, which, least for me, is the best +a hierarchical structure, which, at 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 @@ -117,13 +117,13 @@ Org start on the left margin[fn:1] with one or more stars followed by a space. For example: #+begin_example -,* Top level headline +,* First (top) level headline ,** Second level ,*** Third level some text ,*** Third level more text -,* Another top level headline +,* Another first (top) level headline #+end_example Note that a headline named after ~org-footnote-section~, which @@ -162,7 +162,7 @@ visibility in the buffer. : ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. : '--------------------------------------' -- {{{kbd(C-u C-u C-u TAB)}}} (~org-show-all~) :: +- {{{kbd(C-u C-u C-u TAB)}}} (~org-fold-show-all~) :: Show all, including drawers. @@ -553,7 +553,7 @@ the colon. Here are some examples: 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. Here are a few -examples,, together with an explanation: +examples, together with an explanation: | =file:~/code/main.c::255= | Find line 255 | | =file:~/xx.org::My Target= | Find =<>= | @@ -727,7 +727,7 @@ command ~org-todo~ with a prefix argument. #+attr_texinfo: :sep , - {{{kbd(C-u C-c C-t)}}} (~org-todo~) :: - Prompt for a note and record a the time of the TODO state change. + Prompt for a note and record the time of the TODO state change. Org mode can also automatically record a timestamp and optionally a note when you mark a TODO item as DONE, or even each time you change @@ -886,9 +886,10 @@ mode has extensive support for tags. 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. +=@=, =#=, 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. ** Tag inheritance :PROPERTIES: @@ -982,9 +983,9 @@ or, if tags in the group should be mutually exclusive: : #+TAGS: { Context : @Home @Work } -When you search for a group tag, it return matches for all members in +When you search for a group tag, it returns 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 +tag displays or hides headlines tagged with at least one of the members of the group or any of its subgroups. If you want to ignore group tags temporarily, toggle group tags @@ -2149,7 +2150,7 @@ additional information. These lines may be put anywhere in the file: : #+TITLE: I'm in the Mood for Org -Most proeminent export options include: +Most prominent export options include: | =TITLE= | the title to be shown | | =AUTHOR= | the author (default taken from ~user-full-name~) | @@ -2657,7 +2658,7 @@ behavior of {{{kbd(C-a)}}} and {{{kbd(C-e)}}} in headlines. [fn:2] If you do not want the line to be split, customize the variable ~org-M-RET-may-split-line~. -[fn:3] See also the variable ~org-show-context-detail~ to decide how +[fn:3] See also the variable ~org-fold-show-context-detail~ to decide how much context is shown around each match. [fn:4] The corresponding in-buffer setting is =#+STARTUP: logdone=. diff --git a/elpa/org-9.7.39/doc/org-manual.org b/elpa/org-9.8.3/doc/org-manual.org similarity index 94% rename from elpa/org-9.7.39/doc/org-manual.org rename to elpa/org-9.8.3/doc/org-manual.org index e55f1216..79cd30e8 100644 --- a/elpa/org-9.7.39/doc/org-manual.org +++ b/elpa/org-9.8.3/doc/org-manual.org @@ -19,7 +19,7 @@ :END: #+cindex: summary -Org Mode is an authoring tool and a TODO lists manager for GNU Emacs. +Org mode is an authoring tool and a TODO list manager for GNU Emacs. It relies on a lightweight plain-text markup language used in files with the =.org= extension. @@ -28,27 +28,27 @@ understand, and change them with any text editor. As an authoring tool, Org helps you write structured documents and provides exporting facilities. Org files can also be used for literate -programming and reproducible research. As a TODO lists manager, Org +programming and reproducible research. As a TODO list manager, Org helps you organize your tasks in a flexible way, from daily needs to -detailed project-planning, allowing logging, multiple views on your +detailed project planning, allowing logging, multiple views of your tasks, exporting your agendas, etc. Org mode 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. +possible to keep the content of large files well-structured. +Visibility cycling and structure editing help you 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 +Org develops organizational tasks around note 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 +and task management make use of metadata, which is part of an outline +node. Based on this data, specific entries can be extracted via +queries to 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 +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. @@ -57,10 +57,10 @@ 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. +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 +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 @@ -79,7 +79,8 @@ of Org, as well as additional information, frequently asked questions #+cindex: print edition An earlier version (7.3) of this manual was available as a paperback -book from the Network Theory Ltd. publishing company, closed in 2009. +book from the Network Theory Ltd. publishing company, which closed +in 2009. ** Installation :PROPERTIES: @@ -87,13 +88,13 @@ book from the Network Theory Ltd. publishing company, closed in 2009. :END: #+cindex: installation -Org is included in distributions of GNU Emacs, you probably do not +Org is included in distributions of GNU Emacs, so you probably do not need to install it. Most users will simply activate Org and begin exploring its features. -If, for one reason or another, you want to install Org on top of this +If, for one reason or another, you want to install Org on top of the pre-packaged version, you can use the Emacs package system or clone -Org's git repository. We *strongly recommend* sticking to a single +Org's Git repository. We *strongly recommend* sticking to a single installation method. When installing Org on top of the pre-packaged version, please note @@ -116,11 +117,22 @@ 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. +visited, i.e., where no Org built-in functions have been loaded. +Otherwise, autoloaded Org functions will mess up the installation. #+end_quote -*** Using Org's git repository +To avoid interference with the built-in Org mode, you can use the +command line (you need Emacs 30 or later): + +#+begin_src sh +emacs -Q -batch -eval "(progn (require 'package) (package-initialize) (package-refresh-contents) (package-upgrade 'org))" +#+end_src + +This approach has the advantage of isolating the upgrade process from +a running Emacs session, ensuring that version conflicts cannot +arise. + +*** Using Org's Git repository :PROPERTIES: :UNNUMBERED: notoc :END: @@ -129,7 +141,9 @@ You can clone Org's repository and install Org like this: #+begin_example $ cd ~/src/ -$ git clone https://git.savannah.gnu.org/git/emacs/org-mode.git +$ git clone https://https.git.savannah.nongnu.org/git/org-mode.git +$ # alternatively, you can use mirror +$ # git clone https://git.sr.ht/~bzg/org-mode $ cd org-mode/ $ make autoloads #+end_example @@ -145,7 +159,7 @@ Make sure you set the load path correctly in your Emacs init file: #+end_src You can also compile with =make=, generate the documentation with -=make doc=, create a local configuration with =make config= and +=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. @@ -157,14 +171,15 @@ Org Build System page on [[https://orgmode.org/worg/dev/org-build-system.html][W :UNNUMBERED: notoc :END: -Org's repository used to contain =contrib/= directory for add-ons +Org's repository used to contain the =contrib/= directory for add-ons contributed by others. As of Org 9.5, the directory has been moved to the dedicated org-contrib [[https://git.sr.ht/~bzg/org-contrib][repository]], which you can install separately as a [[https://elpa.nongnu.org/nongnu/org-contrib.html][package]] from NonGNU ELPA. -There are enough valuable packages maintained outside of the Org repository. -Worg has a list of [[https://orgmode.org/worg/org-contrib/index.html][org-contrib and external packages]], certainly it is not -exhaustive. +There are many valuable packages maintained outside the Org +repository. Worg has a list of +[[https://orgmode.org/worg/org-contrib/index.html][org-contrib and +external packages]]; it is certainly not exhaustive. ** Activation :PROPERTIES: @@ -177,8 +192,8 @@ exhaustive. #+cindex: key bindings, global Org mode buffers need Font Lock to be turned on: this is the default -in Emacs[fn:: If you do not use Font Lock globally turn it on in Org -buffer with =(add-hook 'org-mode-hook #'turn-on-font-lock)=.]. +in Emacs[fn:: If you do not use Font Lock globally, turn it on in an +Org buffer with =(add-hook 'org-mode-hook #'turn-on-font-lock)=.]. There are compatibility issues between Org mode and some other Elisp packages (see [[*Packages that conflict with Org mode]]). Please take the @@ -191,7 +206,7 @@ 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, +[[info:elisp::Key Binding Conventions]]). Here are suggested bindings; please modify the keys to your own liking in your [[info:emacs#Init File][personal init file]]. #+begin_src emacs-lisp @@ -237,13 +252,13 @@ 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:: Please +be passed to the list after a moderator approves it[fn:: 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 [[https://www.gnu.org/philosophy/kind-communication.html][GNU Kind Communications Guidelines]] when sending messages on this mailing -list. Please allow up to one month for the response and followup if +list. Please allow up to one month for a response and follow up if no response is received on the bug report. #+findex: org-version @@ -254,27 +269,27 @@ 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 +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 #+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 +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 +Emacs with minimal customizations and to 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 +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. @@ -291,17 +306,17 @@ shown below. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp")) #+end_src -If you are using Org mode version from Git repository, you can start -minimal session using make. +If you are using the Org mode version from the Git repository, you can +start a minimal session using =make=. : # Bare Emacs : make repro : # or pass extra arguments : make repro REPRO_ARGS="-l /path/to/minimal/config.el /tmp/bug.org" -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: +If an error occurs, a "backtrace" can be very useful---see below for +instructions 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? @@ -314,7 +329,7 @@ information about: #+cindex: laggy #+cindex: not responsive If you experience degraded performance, you can record a "profile" and -share it on the Org mailing list. See below for the instructions how +share it on the Org mailing list. See below for instructions on how to record a useful profile. Thank you for helping to improve this program. @@ -359,14 +374,14 @@ error occurred. Here is how to produce a useful backtrace: :END: #+cindex: profiler -Sometimes, Org is becoming slow for no apparent reason. Such slowdown +Sometimes, Org becomes slow for no apparent reason. Such slowdown is often caused by interaction between third-party packages and Org mode. However, identifying the root cause is not always straightforward. Emacs is able to record performance statistics, which can then be used -to find out which functions are taking most of the time to execute. -To record the statistics, one can use so-called profiler. To use the -Emacs profiler, we recommend the following steps: +to find out which functions are taking the most time to execute. To +record the statistics, one can use a profiler. To use the Emacs +profiler, we recommend the following steps: 1. Make sure that no profiler is currently active: @@ -384,31 +399,31 @@ Emacs profiler, we recommend the following steps: This command will display a summary of the commands and functions that have been executed between ~profiler-start~ and - ~profiler-report~ invocations, with command taking most of the time - displayed on top. + ~profiler-report~ invocations, with the command taking the most + time displayed on top. - == key can be used to fold and unfold lines in the profiler + The == key can be used to fold and unfold lines in the profiler buffer. The child items revealed upon unfolding are the functions and commands called by the unfolded parent. - The root causes are often buried deep inside sub-children items in + The root causes are often buried deep inside child items in the profiler. You can press =B= (~profiler-report-render-reversed-calltree~) - to quickly reveal the actual function/command that takes most of - the time to run. + to quickly reveal the actual function/command that takes the most + time to run. Pressing =C= ~profiler-report-render-calltree~ will recover the original view. 5. If you need further help, you can share the statistics data. - Just save the data by issuing + To save the data, issue : M-x profiler-report-write-profile : /path/to/profile-file-to-be-saved - Then, you can attached the saved file to your email to the Org - mailing list, alongside with details about what you did to trigger - the slowdown. + Then, you can attach the saved file to your email to the Org + mailing list, along with details about what you did to trigger the + slowdown. Note that the saved statistics will only contain the function names and how long their execution takes. No private data will be @@ -425,7 +440,7 @@ Emacs profiler, we recommend the following steps: :UNNUMBERED: notoc :END: -Org uses various syntactical elements: TODO keywords, tags, property +Org uses various syntactic elements: TODO keywords, tags, property names, keywords, blocks, etc. In this manual we use the following conventions: @@ -457,9 +472,9 @@ conventions: :END: The manual lists both the keys and the corresponding commands for -accessing a functionality. Org mode often uses the same key for +accessing 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 +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 @@ -474,13 +489,13 @@ call ~org-table-move-column-right~. #+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 +a hierarchical structure, which, at 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. +the show and hide functionality into a single command, ~org-cycle~, +which is bound to the {{{kbd(TAB)}}} key. ** Headlines :PROPERTIES: @@ -497,13 +512,13 @@ start on the left margin[fn:1] with one or more stars followed by a space. For example: #+begin_example -,* Top level headline +,* First (top) level headline ,** Second level ,*** Third level some text ,*** Third level more text -,* Another top level headline +,* Another first (top) level headline #+end_example #+vindex: org-footnote-section @@ -511,8 +526,8 @@ 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 an Org Indent minor mode. See [[*A Cleaner +that has whitespace followed by a single star as headline markers. +This can be achieved using the Org Indent minor mode. See [[*A Cleaner Outline View]] for more information. Headlines are not numbered. However, you may want to dynamically @@ -547,7 +562,7 @@ subtree, in order to structure the collapsed view. See the variable 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. +{{{kbd(S-TAB)}}}, to change the visibility in the buffer. #+attr_texinfo: :sep , - {{{kbd(TAB)}}} (~org-cycle~) :: @@ -602,11 +617,12 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and Switch back to the startup visibility of the buffer (see [[*Initial visibility]]). -- {{{kbd(C-u C-u C-u TAB)}}} (~org-show-all~) :: +- {{{kbd(C-u C-u C-u TAB)}}} (~org-fold-show-all~) :: #+cindex: show all, command #+kindex: C-u C-u C-u TAB #+findex: org-show-all + #+findex: org-fold-show-all Show all, including drawers. - {{{kbd(C-c C-r)}}} (~org-reveal~) :: @@ -615,7 +631,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and #+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 + 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 @@ -629,11 +645,12 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and #+findex: org-show-branches Expose all the headings of the subtree, but not their bodies. -- {{{kbd(C-c TAB)}}} (~org-show-children~) :: +- {{{kbd(C-c TAB)}}} (~org-fold-show-children~) :: #+cindex: show children, command #+kindex: C-c TAB #+findex: org-show-children + #+findex: org-fold-show-children Expose all direct children of the subtree. With a numeric prefix argument {{{var(N)}}}, expose all children down to level {{{var(N)}}}. @@ -644,7 +661,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and #+findex: org-tree-to-indirect-buffer Show the current subtree in an indirect buffer[fn:2]. 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 + 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. @@ -702,14 +719,14 @@ for this property are =folded=, =children=, =content=, and =all=. #+vindex: org-fold-catch-invisible-edits #+vindex: org-fold-catch-invisible-edits-commands 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. +and be confused about what has been edited and how to undo the mistake. By default, Org prevents such edits for a limited set of user commands. Users can control which commands are affected by customizing ~org-fold-catch-invisible-edits-commands~. The strategy used to decide if a given edit is dangerous is controlled by ~org-fold-catch-invisible-edits~. See the docstring of this option -on the available strategies. Set the option to ~nil~ to disable +for the available strategies. Set the option to ~nil~ to disable catching invisible edits completely. ** Motion @@ -768,7 +785,7 @@ The following commands jump to other headlines in the buffer. | {{{kbd(/)}}} | Do a Sparse-tree search | #+texinfo: @noindent - The following keys work if you turn off ~org-goto-auto-isearch~ + 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. | @@ -802,7 +819,7 @@ The following commands jump to other headlines in the buffer. #+kindex: M-RET #+findex: org-meta-return #+vindex: org-M-RET-may-split-line - Insert a new heading, item or row. + 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 @@ -864,8 +881,7 @@ The following commands jump to other headlines in the buffer. #+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 + To select a region of headlines, it is best to set mark at the beginning of the first headline, and point at the line just after the last headline to change. @@ -897,14 +913,14 @@ The following commands jump to other headlines in the buffer. #+kindex: C-c @@ #+findex: org-mark-subtree - Mark the subtree at point. Hitting repeatedly marks subsequent + Mark the subtree at point. Hitting it 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. + Kill subtree, i.e., remove it from the 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~) :: @@ -948,7 +964,7 @@ The following commands jump to other headlines in the buffer. #+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 + whether 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~. @@ -965,7 +981,7 @@ The following commands jump to other headlines in the buffer. #+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 + 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, @@ -1017,17 +1033,17 @@ keys have different functionality. #+cindex: folding, sparse trees #+cindex: occur, command +#+vindex: org-fold-show-context-detail #+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:: See -also the variable ~org-show-context-detail~ to decide how much context +also the variable ~org-fold-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: +Org mode contains several commands creating such trees, all of which can be accessed through a dispatcher: - {{{kbd(C-c /)}}} (~org-sparse-tree~) :: @@ -1045,7 +1061,7 @@ commands can be accessed through a dispatcher: Prompts for a regexp (see [[*Regular Expressions]]) 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 + the 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 @@ -1070,7 +1086,7 @@ commands can be accessed through a dispatcher: 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 +For frequently used sparse trees for 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]]). @@ -1092,7 +1108,7 @@ tags, or properties and are discussed later in this manual. #+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 +~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. @@ -1129,18 +1145,18 @@ Org knows ordered lists, unordered lists, and description lists. - /Description/ list items are unordered list items, and contain the separator =::= to distinguish the description /term/ from the - description. + description text. 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. +numbers in the list. An item ends before the next line that has an +indentation less than or equal to 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: +with an indentation less than or equal to that of the top-level items. +It also ends before two blank lines. In that case, all items are +closed. Here is an example: #+begin_example ,* Lord of the Rings @@ -1171,7 +1187,7 @@ indented to signal that they belong to a particular item. 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 +of indentation between items and their sub-items, customize ~org-list-indent-offset~. #+vindex: org-list-automatic-rules @@ -1211,7 +1227,7 @@ to disable them individually. in the middle of an item, that item is /split/ in two, and the second part becomes the new item[fn:: If you do not want the item to be split, customize the variable ~org-M-RET-may-split-line~.]. If - this command is executed /before item's body/, the new item is + this command is executed /before the item's body/, the new item is created /before/ the current one. - {{{kbd(M-S-RET)}}} :: @@ -1236,7 +1252,7 @@ to disable them individually. #+kindex: M-UP #+kindex: M-DOWN - Move the item including subitems up/down[fn:: See + Move the item including sub-items up/down[fn:: See ~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. @@ -1252,7 +1268,7 @@ to disable them individually. #+kindex: M-S-LEFT #+kindex: M-S-RIGHT - Decrease/increase the indentation of the item, including subitems. + Decrease/increase the indentation of the item, including sub-items. 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 @@ -1290,23 +1306,22 @@ to disable them individually. #+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 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. + Checkboxes (see [[*Checkboxes]]) become =TODO= or =DONE= keywords when unchecked or checked, respectively. - {{{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 + This command also cycles bullet styles when point is on the bullet + or anywhere in an item line, with details depending on ~org-support-shift-select~. - {{{kbd(C-c ^)}}} :: @@ -1324,7 +1339,7 @@ to disable them individually. #+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/. +you do not normally want to see it. For this, Org mode has /drawers/. They can contain anything but a headline and another drawer. Drawers look like this: @@ -1352,14 +1367,14 @@ Completion over drawer keywords is also possible using {{{kbd(M-TAB)}}}[fn:6]. Visibility cycling (see [[*Visibility Cycling]]) on the headline hides and -shows the entry, but keep the drawer collapsed to a single line. In +shows the entry, but keeps 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 +a =LOGBOOK= drawer. If you want to store a quick note there, +similarly to state changes, use - {{{kbd(C-c C-z)}}} :: @@ -1373,7 +1388,7 @@ a similar way to state changes, use #+vindex: org-hide-block-startup #+cindex: blocks, folding -Org mode uses =#+BEGIN= ... =#+END= blocks for various purposes from +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= @@ -1423,7 +1438,7 @@ header lines. A table might look like this: #+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)}}}, {{{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 @@ -1443,7 +1458,7 @@ fields. Even faster would be to type =|Name|Phone|Age= followed by 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 +inserting and deleting avoid 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 @@ -1514,14 +1529,14 @@ you, configure the option ~org-table-auto-blank-field~. #+kindex: M-a #+findex: org-table-beginning-of-field - Move to beginning of the current table field, or on to the previous + Move to beginning of the current table field, or onto 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. + Move to end of the current table field, or onto the next field. *** Column and row editing :PROPERTIES: @@ -1550,7 +1565,7 @@ you, configure the option ~org-table-auto-blank-field~. #+kindex: M-S-RIGHT #+findex: org-table-insert-column - Insert a new column at point position. Move the recent column and + Insert a new column at point position. Move the current column and all cells to the right of this column to the right. - {{{kbd(M-UP)}}} (~org-table-move-row-up~) :: @@ -1695,12 +1710,12 @@ you, configure the option ~org-table-auto-blank-field~. #+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 + When the current field is empty, copy from the first non-empty field above. + When it is not empty, copy the current field down to the 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 + time stamp field values, as well as fields prefixed or suffixed with a whole number, can be incremented during copy. Also, a ~0~ prefix argument temporarily disables the increment. @@ -1728,11 +1743,11 @@ you, configure the option ~org-table-auto-blank-field~. - {{{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 + 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. @@ -1784,7 +1799,7 @@ 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 +Editing a field may modify the 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 @@ -1851,7 +1866,7 @@ with the following tools: 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. +a tooltip 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. @@ -1878,8 +1893,7 @@ automatically upon exporting the document. #+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 +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 @@ -1989,12 +2003,12 @@ 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. +references to 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 @@ -2083,7 +2097,7 @@ and ~org-table-current-column~. Examples: 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:: The computation time scales as O(N^2) because table -{{{var(FOO)}}} is parsed for each field to be copied.] for large +{{{var(FOO)}}} is parsed for each field to be copied.] for a large number of rows. **** Named references @@ -2145,7 +2159,7 @@ valid in the referenced table. 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 +=B3= is not supported because it cannot be distinguished from a plain table name or ID. *** Formula syntax for Calc @@ -2229,23 +2243,21 @@ variable ~org-calc-default-modes~. 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:9]. 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 | +You may also provide a ~format~ specifier (similar to ~printf~)[fn:9] +to reformat the Calc result after it has been passed back to Org +instead of letting Calc handle the formatting. 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= | Fahrenheit to Celsius conversion | +| =$c/$1/$cm= | Herz to centimeter conversion, using =constants.el= | +| =tan($1);Dp3s1= | Compute in degrees, precision 3, display SCI 1 | +| =sin($1);Dp3%.1e= | Same, but use ~format~ 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 @@ -2258,7 +2270,7 @@ Operations]]). For example - =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 + 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. @@ -2266,7 +2278,7 @@ Operations]]). For example 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~ + return =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. @@ -2280,7 +2292,7 @@ Operations]]). For example - =vmean($1..$7); EN= :: - To complete the example before: Mean value of a range with empty + To complete the previous example: 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. @@ -2302,8 +2314,8 @@ A formula is evaluated as a Lisp form when it starts with a single-quote followed by an opening parenthesis. Cell table references are interpolated into the Lisp form before execution. The evaluation should return either a string or a number. Evaluation -modes and a ~printf~ format used to render the returned values can be -specified after a semicolon. +modes and a ~format~ string (similar to ~printf~)[fn:9] used to render +the returned values can be specified after a semicolon. By default, references are interpolated as literal Lisp strings: the field content is replaced in the Lisp form stripped of leading and @@ -2342,7 +2354,7 @@ example: #+texinfo: @noindent extracts the part of the string in column 1 between the character -positions specified in the integers in column 2 and 3 and it is easier +positions specified in the integers in column 2 and 3, and it is easier to read than the equivalent: : '(substring $1 (string-to-number $2) (string-to-number $3)) @@ -2353,7 +2365,7 @@ interpret everything past =;= as format specifier: : '(concat $1 ";") #+texinfo: @noindent -You can put an extra tailing =;= to indicate that all the earlier +You can put an extra trailing =;= to indicate that all the earlier instances of =;= belong to the formula itself: : '(concat $1 ";"); @@ -2470,7 +2482,7 @@ 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 +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 @@ -2485,7 +2497,7 @@ 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 +like =$4=$1+$2=. The left-hand side of a column formula cannot 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 @@ -2539,7 +2551,7 @@ Org has three predefined Emacs Lisp functions for lookups in tables. #+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 + corresponding values. This function cannot 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. @@ -2773,7 +2785,7 @@ becomes the string =#ERROR=. If you want 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. +Detailed information is displayed. *** Updating the table :PROPERTIES: @@ -3056,16 +3068,16 @@ For more information and examples see the [[https://orgmode.org/worg/org-tutoria - =min= :: Provides a minimum axis value that may be used by a plot type. - Implicitly assumes the =y= axis is being referred to. Can - explicitly provide a value for a either the =x= or =y= axis with - =xmin= and =ymin=. + Implicitly assumes the =y= axis is being referred to. You can + explicitly provide a value for the =x= or =y= axis with =xmin= and + =ymin=. - =max= :: Provides a maximum axis value that may be used by a plot type. - Implicitly assumes the =y= axis is being referred to. Can - explicitly provide a value for a either the =x= or =y= axis with - =xmax= and =ymax=. + Implicitly assumes the =y= axis is being referred to. You can + explicitly provide a value for the =x= or =y= axis with =xmax= and + =ymax=. - =ticks= :: @@ -3120,7 +3132,7 @@ 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 +is the value filling all the {{{var(WIDTH)}}}. Source values outside this range are displayed as =too small= or =too large=. {{{var(WIDTH)}}} is the number of characters of the bar plot. It @@ -3146,7 +3158,7 @@ links to other files, Usenet articles, emails, and much more. #+cindex: angle bracket links #+cindex: plain links Org recognizes plain URIs, possibly wrapped within angle -brackets[fn:10], and activate them as clickable links. +brackets[fn:10], and activates them as clickable links. #+cindex: bracket links The general link format, however, looks like this: @@ -3162,8 +3174,7 @@ or alternatively #+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: +specifically, only the following characters must be escaped: 1. all =[= and =]= characters, 2. every =\= character preceding either =]= or =[=, @@ -3197,7 +3208,7 @@ 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, customize ~org-link-descriptive~, or use -=literallinks= [[*Summary of In-Buffer Settings][startup option]]. +the =literallinks= [[*Summary of In-Buffer Settings][startup option]]. ** Internal Links :PROPERTIES: @@ -3264,7 +3275,7 @@ 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=. +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 @@ -3321,8 +3332,8 @@ Here is the full set of built-in link types: File links. File name may be remote, absolute, or relative. - As a special case, "file" prefix may be omitted if the file name - is complete, e.g., it starts with =./=, or =/=. + As a special case, the "file" prefix may be omitted if the file name + is complete, e.g., it starts with =./= or =/=. - =attachment= :: @@ -3384,6 +3395,15 @@ Here is the full set of built-in link types: Execute a shell command upon activation. +- =shortdoc= :: + + Link to short documentation summary for an Emacs Lisp function group. + [fn::You can run =M-x shortdoc-display-group= to list all known + documentation groups.] + + For more information, see [[info:emacs#Name Help][Name Help]] + and [[info:elisp#Documentation Groups][Documentation Groups]]. + For =file:= and =id:= links, you can additionally specify a line number, or a text search string, separated by =::=. In Org files, you @@ -3425,7 +3445,9 @@ options: | irc | =irc:/irc.com/#emacs/bob= | | help | =help:org-store-link= | | info | =info:org#External links= | -| shell | =shell:ls *.org= | +| shortdoc | =shortdoc:text-properties= | +| | =shortdoc:text-properties::#get-pos-property= | +| shell | =shell:ls *.org= (synchronous), =shell:inkscape&= (asynchronous) | | elisp | =elisp:(find-file "Elisp.org")= (Elisp form to evaluate) | | | =elisp:org-agenda= (interactive Elisp command) | @@ -3479,7 +3501,7 @@ 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 +org-store-link)}}}. Because of its importance, we suggest binding 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 @@ -3489,7 +3511,7 @@ current buffer: For Org files, if there is a =<>= at point, the link points to the target. If there is a named block (using =#+name:=) at - point, the link points to that name. Otherwise it points to the + point, the link points to that name. Otherwise, it points to the current headline, which is also the description. #+vindex: org-id-link-to-org-use-id @@ -3498,7 +3520,7 @@ current buffer: 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:: The Org Id library must first be + =ID= property for the link[fn:: 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.]. So using this command in Org buffers potentially creates @@ -3557,7 +3579,7 @@ current buffer: #+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 + current conversation. Otherwise, store an =irc= style link to the user/channel/server under the point. - /Other files/ :: @@ -3624,9 +3646,9 @@ generally, act on links. 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 + file is in the current directory or in a subdirectory 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 + 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. @@ -3642,14 +3664,14 @@ generally, act on links. #+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. + ~browse-url-at-point~), runs VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for + the corresponding links, and executes 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 + links with Emacs and selects 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 @@ -3657,8 +3679,8 @@ generally, act on links. 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 + If point is on a headline, but not on a link, Org offers all links + in the headline and entry text. If you want to set up the frame configuration for following links, customize ~org-link-frame-setup~. - {{{kbd(RET)}}} :: @@ -3672,7 +3694,7 @@ generally, act on links. #+kindex: mouse-2 #+kindex: mouse-1 - On links, {{{kbd(mouse-1)}}} and {{{kbd(mouse-2)}}} opens the link + On links, {{{kbd(mouse-1)}}} and {{{kbd(mouse-2)}}} open the link just as {{{kbd(C-c C-o)}}} does. - {{{kbd(mouse-3)}}} :: @@ -3709,7 +3731,7 @@ generally, act on links. #+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 + Move forward/backward to the next/previous 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)}}}. @@ -3741,7 +3763,7 @@ You might want to bind them to globally available keys. See #+cindex: link abbreviations #+cindex: abbreviation, links -Long URL can be cumbersome to type, and often many similar links are +Long URLs 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 @@ -3767,10 +3789,10 @@ replacement text. Here is an example: 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 +=%(my-function)= passes the tag to a custom Lisp function, and replaces it by the resulting string. -If the replacement text do not contain any specifier, it is simply +If the replacement text does 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 @@ -3851,7 +3873,7 @@ link, together with explanations for each: Search for a link 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 + an HTML reference to the corresponding named anchor in the linked file. - =*My Target= :: @@ -3959,7 +3981,7 @@ The most important commands to work with TODO entries are: 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 + 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~. @@ -3970,7 +3992,7 @@ The most important commands to work with TODO entries are: #+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 + entire buffer, but shows all TODO items---with a 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 @@ -3987,7 +4009,7 @@ The most important commands to work with TODO entries are: 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. + list]] for more information. - {{{kbd(S-M-RET)}}} (~org-insert-todo-heading~) :: @@ -4049,8 +4071,8 @@ 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. +Changing a TODO state can be logged with a timestamp; see [[*Tracking +TODO state changes]] for more information. *** TODO keywords as types :PROPERTIES: @@ -4077,9 +4099,9 @@ Using TODO types, it would be set up like this: #+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 +different types. So the normal workflow 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:: This is +adapting the working of the command {{{kbd(C-c C-t)}}}[fn:: 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 @@ -4117,7 +4139,7 @@ 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 +=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: @@ -4131,7 +4153,7 @@ correct sequence. In addition to typing a keyword or using completion 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 + binding conflicts with shift-selection (see [[*Packages that conflict with Org mode]]). - {{{kbd(S-RIGHT)}}}, {{{kbd(S-LEFT)}}} :: @@ -4339,7 +4361,7 @@ 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. + Prompt for a note and record 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]]. @@ -4370,7 +4392,7 @@ 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 +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:: The corresponding in-buffer setting is: =#+STARTUP: lognotedone=.] @@ -4395,9 +4417,9 @@ entry with a =Closing Note= heading. 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:: See -the variable ~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 +inserted after the headline as an itemized list, the newest first[fn:: +See the variable ~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 [[*Drawers]]). Customize the variable ~org-log-into-drawer~ to get this behavior---the recommended drawer for this is called =LOGBOOK=[fn:: Note that the =LOGBOOK= drawer is unfolded when @@ -4426,9 +4448,9 @@ and that a note is recorded when switching to =WAIT= or 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 +=WAIT= to =DONE=, because =DONE= is configured to record only a +timestamp. 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 @@ -4490,7 +4512,7 @@ A habit has the following properties: 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. + 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 @@ -4519,7 +4541,7 @@ actual habit with some history: - 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 +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 @@ -4592,7 +4614,7 @@ right after the TODO keyword, like this: #+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 +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~, @@ -4604,9 +4626,9 @@ You can also use numeric values for priorities, such as 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. +must all be a non-negative integer between 0 and 64, inclusive. -Priorities can be attached to any outline node; they do not need to be +Priorities can be attached to any heading; they do not need to be TODO items. #+attr_texinfo: :sep ; @@ -4631,7 +4653,7 @@ TODO items. Increase/decrease the priority of the current headline[fn:: See also the option ~org-priority-start-cycle-with-default~.]. Note that these keys are also used to modify timestamps (see [[*Creating - Timestamps]]). See also [[*Packages that conflict with Org mode]], + Timestamps]]). See also [[*Packages that conflict with Org mode]] for a discussion of the interaction with shift-selection. #+vindex: org-priority-highest @@ -4639,8 +4661,10 @@ TODO items. #+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 +~org-priority-default~. Valid priority values are single uppercase +Latin alphabetical characters A-Z, and non-negative integers in between 0 +and 64, inclusive. 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 @@ -4680,7 +4704,7 @@ updated each time the TODO status of a child changes, or when pressing #+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 +meaning of the statistics cookie becomes ambiguous. Set the property =COOKIE_DATA= to either =checkbox= or =todo= to resolve this issue. #+vindex: org-hierarchical-todo-statistics @@ -4710,7 +4734,7 @@ all children are done, you can use the following setup: #+end_src Another possibility is the use of checkboxes to identify (a hierarchy -of) a large number of subtasks (see [[*Checkboxes]]). +of) subtasks (see [[*Checkboxes]]). ** Checkboxes :PROPERTIES: @@ -4722,7 +4746,7 @@ of) a large number of subtasks (see [[*Checkboxes]]). Every item in a plain list[fn:16] (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 +Checkboxes are not included in 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. @@ -4744,9 +4768,9 @@ Here is an example of a checkbox list. #+cindex: @samp{COOKIE_DATA}, property #+vindex: org-checkbox-hierarchical-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 +indicating how many of the 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 +idea of 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 @@ -4765,7 +4789,7 @@ 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 +If the current heading 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. @@ -4893,12 +4917,12 @@ 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]]). +=@=, =#=, 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: @@ -4982,13 +5006,13 @@ also a special command for inserting tags: #+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 +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:: 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~.]. 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 +~org-tag-alist~. Finally, you can set the default tags for a given file using the =TAGS= keyword, like #+begin_example @@ -5011,7 +5035,7 @@ by adding a =STARTUP= keyword to that file: : #+STARTUP: noptag -By default Org mode uses the standard minibuffer completion facilities +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 @@ -5166,9 +5190,9 @@ 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 +When you search for a group tag, it returns 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 +tag displays or hides 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. @@ -5178,7 +5202,7 @@ 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 +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: @@ -5287,12 +5311,12 @@ related information into special lists. only TODO items. 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]]. +Boolean logic, such as =+boss+urgent-project1= to find entries with +tags =boss= and =urgent=, but not =project1= or =Kathy|Sally= to find +entries tagged with either =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: @@ -5301,7 +5325,7 @@ with many examples, see [[*Matching tags and properties]]. #+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 +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, @@ -5380,16 +5404,17 @@ Properties can also be defined using lines like: #+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=. +having the values =foo= and =bar=. #+begin_example -,#+PROPERTY: var foo=1 -,#+PROPERTY: var+ bar=2 +,#+PROPERTY: var foo +,#+PROPERTY: var+ bar #+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. +Using the appended =+=, it is also possible to add to the values of +inherited properties. The following results in the =Genres= property +having the values =Classic=, =Baroque=, and =Keyboard music= under the +=Goldberg Variations= subtree. #+begin_example ,* CD collection @@ -5405,10 +5430,13 @@ Baroque= under the =Goldberg Variations= subtree. :Publisher: Deutsche Grammophon :NDisks: 1 :Genres+: Baroque + :Genres+: Keyboard music :END: #+end_example -Note that a property can only have one entry per drawer. +Note that a property can only have multiple entries per drawer when +used with the appended =+=. When a property has multiple entries +without =+=, the result is undefined. #+vindex: org-global-properties Property values set with the global variable ~org-global-properties~ @@ -5629,7 +5657,7 @@ least for the special applications for which they are used: :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. +view/. In column view, each heading 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 @@ -5704,7 +5732,7 @@ optional. The individual parts have the following meaning: - {{{var(PROPERTY)}}} :: The property that should be edited in this column. Special - properties representing meta data are allowed here as well (see + properties representing metadata are allowed here as well (see [[*Special Properties]]). - {{{var(TITLE)}}} :: @@ -5714,10 +5742,22 @@ optional. The individual parts have the following meaning: - {{{var(SUMMARY-TYPE)}}} :: - The summary type. If specified, the column values for parent nodes - are computed from the children[fn:: If more than one summary type - applies to the same property, the parent values are computed - according to the first of them.]. + The summary type. If specified, the column values for parent + headings are computed from the direct children. If there is any + existing property defined for the parent nodes, it is not used in + the calculations. + + When there is an existing property in parent heading, Org does not + only overlay the computed value in the column view, but also + overwrites the property value in parent's property drawer[fn:: If + more than column definition is requested for the same property, only + the first definition will trigger writing to the property drawer. + For example, =%EFFORT{mean} %EFFORT(Sum){:}= will write the mean + value of =EFFORT= property; not the sum. If the first column + definition does not have summary type (=%EFFORT %EFFORT{mean}=), + nothing will be written to the property drawer]. + + Summary type is ignored for special properties. Supported summary types are: @@ -5768,7 +5808,7 @@ constraints.]. #+begin_example :COLUMNS: %25ITEM %9Approved(Approved?){X} %Owner %11Status \ - %10Time_Estimate{:} %CLOCKSUM %CLOCKSUM_T + %10Time_Estimate{:} :Owner_ALL: Tammy Mark Karl Lisa Don :Status_ALL: "In progress" "Not started yet" "Finished" "" :Approved_ALL: "[ ]" "[X]" @@ -5786,9 +5826,55 @@ 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. +children have been checked. + +The =CLOCKSUM= and =CLOCKSUM_T= column properties are special, they +list the sums of =CLOCK:= intervals in the subtree, either for all +clocks (=CLOCKSUM=) or just for today (=CLOCKSUM_T=). Unlike =:= +summary type that ignores property values in parent headings, all the +=CLOCK:= intervals are summed up, including =CLOCK:= lines within +parent headings. + +***** Summaries in deeply nested hierarchy + +When computing summaries of deeply nested headings, the summaries are +computed recursively, from the deepest level to the shallowest. Here +is an example: + +#+begin_example +,#+BEGIN: columnview :indent t :format "%ITEM %EFFORT{:mean}" :id global +| ITEM | EFFORT | +|--------------------+---------| +| Top level | 3h 0min | +| \_ Intermediate 1 | 1h 0min | +| \_ Leaf 1 | 1h | +| \_ Leaf 2 | 1h | +| \_ Leaf 3 | 1h | +| \_ Intermediate 2 | 5h | +,#+END: + +,* Top level +,** Intermediate 1 +:PROPERTIES: +:EFFORT: *unused*, will be set to 1h 0min (mean of the leaf nodes) +:END: +,***** Leaf 1 +:PROPERTIES: +:EFFORT: 1h +:END: +,*** Leaf 2 +:PROPERTIES: +:EFFORT: 1h +:END: +,*** Leaf 3 +:PROPERTIES: +:EFFORT: 1h +:END: +,** Intermediate 2 +:PROPERTIES: +:EFFORT: 5h +:END: +#+end_example *** Using column view :PROPERTIES: @@ -5886,7 +5972,7 @@ either for all clocks or just for today. #+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 + found in the hierarchy, the modified values are stored there. If no list is found, the new value is stored in the first entry that is part of the current column view. @@ -6066,7 +6152,7 @@ The following commands insert or update the dynamic block: 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 +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. @@ -6234,11 +6320,10 @@ format. #+kindex: C-u C-c . #+vindex: org-time-stamp-rounding-minutes - #+vindex: org-timestamp-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-timestamp-rounding-minutes~. + ~org-time-stamp-rounding-minutes~. #+kindex: C-u C-u C-c . With two prefix arguments, insert an active timestamp with the @@ -6356,7 +6441,7 @@ various inputs are interpreted, the items filled in by Org mode are in | =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/ +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, @@ -6377,14 +6462,14 @@ the abbreviation of day name, the date is the Nth such day, e.g.: #+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 +you want to use unabbreviated 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 +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 +outside 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 @@ -6490,7 +6575,7 @@ following consequences: 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 +- 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. @@ -6526,7 +6611,7 @@ immediately after the task they refer to. 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 + warning is deactivated if the task gets scheduled, and you set ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~. - =SCHEDULED= :: @@ -6578,7 +6663,7 @@ repeater. However, the use of diary expression entries like #+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 +late warnings. However, it shows the item on each day when the expression entry matches. *** Inserting deadlines or schedules @@ -6597,7 +6682,7 @@ schedule an item:[fn:24] #+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 + 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:: Note the corresponding =STARTUP= options @@ -6721,14 +6806,14 @@ 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 + Marking this as 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 + Marking this as 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 @@ -6736,11 +6821,11 @@ special repeaters =++= and =.+=. For example: ,** 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. + Marking this as DONE shifts the date to one month after today. ,** TODO Wash my hands DEADLINE: <2019-04-05 08:00 Fri .+1h> - Marking this DONE shifts the date to exactly one hour from now. + Marking this as DONE shifts the date to exactly one hour from now. #+end_example #+vindex: org-agenda-skip-scheduled-repeats-after-deadline @@ -6822,8 +6907,8 @@ about what to do with it. #+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 + shown is all time ever clocked in 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:: To add an effort estimate "on the fly", hook a function doing this to ~org-clock-in-prepare-hook~.]. If the task is a repeating one (see @@ -6832,7 +6917,7 @@ about what to do with it. =LAST_REPEAT= property.]. 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 + to show all time clocked on this task today---see also the variable ~org-extend-today-until~, ~all~ to include all time, or ~auto~ which is the default[fn:: See also the variable ~org-clock-mode-line-total~.]. Clicking with {{{kbd(mouse-1)}}} @@ -6923,7 +7008,7 @@ about what to do with it. #+kindex: C-c C-x C-j #+findex: or-clock-goto - Jump to the headline of the currently clocked in task. With + 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. @@ -6944,7 +7029,7 @@ 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. +can have a global key binding and do not modify the window disposition. *** The clock table :PROPERTIES: @@ -7119,7 +7204,7 @@ using the =:formatter= parameter. 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. + shortened during export. - =:indent= :: @@ -7270,7 +7355,7 @@ choices to correct the discrepancy: #+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 + task. If you keep all the minutes, this is the same as just clocking out of the current task. - {{{kbd(s)}}} :: @@ -7345,7 +7430,7 @@ arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with #+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 +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. @@ -7549,8 +7634,8 @@ special command: 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. + the target heading as a sub-item. Depending on + ~org-reverse-note-order~, it is either the first or last sub-item. By default, all level 1 headlines in the current buffer are considered to be targets, but you can have more complex definitions @@ -7614,7 +7699,7 @@ special command: value of ~org-reverse-note-order~ applies to the current buffer. So if ~org-refile~ would append the entry as the last entry under the target header, ~org-refile-reverse~ will prepend it as the first - entry, and vice-versa. + entry, and vice versa. ** Archiving :PROPERTIES: @@ -7643,7 +7728,7 @@ global searches like the construction of agenda views fast. #+cindex: external archiving The most common archiving action is to move a project tree to another -file, the archive file. +file, called the archive file. - {{{kbd(C-c C-x C-s)}}} or short {{{kbd(C-c $)}}} (~org-archive-subtree~) :: @@ -7693,7 +7778,7 @@ 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 +came, its outline path, the archiving time etc. Configure the variable ~org-archive-save-context-info~ to adjust the amount of information added. @@ -7719,8 +7804,8 @@ its location in the outline tree, but behaves in the following way: 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-c C-TAB)}}}, or by setting the option - ~org-cycle-open-archived-trees~. Also normal outline commands, like - ~org-show-all~, open archived subtrees. + ~org-cycle-open-archived-trees~. Also, normal outline commands, like + ~org-fold-show-all~, open archived subtrees. - #+vindex: org-sparse-tree-open-archived-trees @@ -7833,11 +7918,10 @@ You may also define a global key for capturing new material (see #+findex: org-capture 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. + (see [[*Capture templates]]), it offers these templates for + selection. It inserts the template into the target file and + switches 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~) :: @@ -7958,7 +8042,7 @@ Now lets look at the elements of a template definition. Each entry in - keys :: - The keys that selects the template, as a string, characters only, + The keys that select 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 @@ -8014,15 +8098,15 @@ Now lets look at the elements of a template definition. Each entry in 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 + body of this node. Most target specifications contain a + ==. If it 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")= :: + - =(file )= :: Text will be placed at the beginning or end of that file. @@ -8030,19 +8114,31 @@ Now lets look at the elements of a template definition. Each entry in Filing as child of this entry, or in the body of the entry. - - =(file+headline "filename" "node headline")= :: + - =(file+headline "node headline")= :: + + - =(file+headline function-returning-string)= :: + + - =(file+headline symbol-containing-string)= :: Fast configuration if the target heading is unique in the file. - - =(file+olp "filename" "Level 1 heading" "Level 2" ...)= :: + - =(file+olp "Level 1 heading" "Level 2" ...)= :: + + - =(file+olp function-returning-list-of-strings)= :: + + - =(file+olp symbol-containing-list-of-strings)= :: For non-unique headings, the full path is safer. - - =(file+regexp "filename" "regexp to find location")= :: + - =(file+regexp "regexp to find location")= :: Use a regular expression to position point. - - =(file+olp+datetree "filename" [ "Level 1 heading" ...])= :: + - =(file+olp+datetree [ "Level 1 heading" ...])= :: + + - =(file+olp+datetree function-returning-list-of-strings)= :: + + - =(file+olp+datetree symbol-containing-list-of-strings)= :: This target[fn:30] creates a heading in a date tree[fn:31] for today's date. If the optional outline path is given, the tree @@ -8050,7 +8146,7 @@ Now lets look at the elements of a template definition. Each entry in level. Check out the ~:time-prompt~ and ~:tree-type~ properties below for additional options. - - =(file+function "filename" function-finding-location)= :: + - =(file+function function-finding-location)= :: A function to find the right location in the file. @@ -8070,7 +8166,7 @@ Now lets look at the elements of a template definition. Each entry in - template :: The template for creating the capture item. If you leave this - empty, an appropriate default template will be used. Otherwise 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:: When the file name is not absolute, @@ -8144,10 +8240,20 @@ Now lets look at the elements of a template definition. Each entry in - ~: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. + Default is to group entries by day. 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. Use any subset of ~(year quarter + month week day)~ to group by the specified levels. In case + ~month~ and ~week~ are both specified, weeks are assigned to the + month containing Thursday, to be consistent with the ISO year-week + rule. In case ~quarter~ and ~week~ but not ~month~ are specified, + quarters are 13-week periods; otherwise they are 3-month periods. + + #+findex: org-datetree-find-create-hierarchy + ~:tree-type~ can also be a function, in which it should take the + date as an argument and generate a list of pairs for + ~org-datetree-find-create-hierarchy~. - ~:unnarrowed~ :: @@ -8209,12 +8315,13 @@ given here: - =%(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 + Evaluate Elisp expression ~(EXP)~ and replace it with the result. + The ~(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. + Examples: =%(org-id-new)=, =%(eval default-directory)= - =%= :: @@ -8274,7 +8381,7 @@ given here: - =%n= :: - User name (taken from ~user-full-name~). + Username (taken from ~user-full-name~). - =%f= :: @@ -8298,7 +8405,7 @@ given here: - =%^t= :: - Like =%t=, but prompt for date. Similarly =%^T=, =%^u=, =%^U=. You + Like =%t=, but prompt for date. Similarly, =%^T=, =%^u=, =%^U=. You may define a prompt like =%^{Birthday}t=. - =%^C= :: @@ -8329,17 +8436,22 @@ given here: - =%\N= :: - Insert the text entered at the {{{var(N)}}}th =%^{PROMPT}=, where - {{{var(N)}}} is a number, starting from 1. + Insert the text entered at the {{{var(N)}}}th =%^{PROMPT}= (but not + =%^{PROMPT}X=), where {{{var(N)}}} is a number, starting from 1. + +- =%\*N= :: + + Same as =%\N=, but include all the prompts. - =%?= :: After completing the template, position point here. #+vindex: org-store-link-props +#+vindex: org-link-store-props For specific link types, the following keywords are defined[fn:: If you define your own link types (see [[*Adding Hyperlink Types]]), any -property you store with ~org-store-link-props~ can be accessed in +property you store with ~org-link-store-props~ can be accessed in capture templates in a similar way.]: #+vindex: org-link-from-user-regexp @@ -8393,24 +8505,25 @@ See the docstring of the variable for more information. :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. +It is often useful to associate reference material with a heading or +subtree. 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. +directory belonging to heading/subtree. Org uses directories named +either by the =ID= property of a heading 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 +By default, Org attach uses =ID= properties when adding attachments to +headings. 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:: If you move entries or Org files from one directory to another, you may want to @@ -8428,7 +8541,7 @@ The following commands deal with attachments: #+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 + these keys, a list of commands is displayed, and you must press an additional key to select a command: - {{{kbd(a)}}} (~org-attach-attach~) :: @@ -8524,7 +8637,7 @@ The following commands deal with attachments: 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. + heading. *** Attachment options :PROPERTIES: @@ -8547,13 +8660,13 @@ mentioning. - ~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: + By default folders attached to a heading 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 ... @@ -8637,8 +8750,8 @@ default settings. :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! +This makes it easy to refer to the material added to heading/subtree. +Especially if it was attached using the unique =ID= of the heading! #+begin_example ,* TODO Some task @@ -8655,7 +8768,7 @@ See [[*External Links]] for more information about these links. :DESCRIPTION: Everything safely stored away :END: -If the directory attached to an outline node is a Git repository, Org +If the directory attached to a heading is a Git repository, Org can be configured to automatically commit changes to that repository when it sees them. @@ -8979,7 +9092,7 @@ commands: #+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 + 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 @@ -9623,7 +9736,7 @@ 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 +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 @@ -9674,10 +9787,12 @@ done depends on the type of view. 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 urgency, which is composed - of the base priority (see [[*Priorities]]; 2000 for priority =A=, 1000 - for =B=, and 0 for =C=), plus additional increments for overdue - scheduled or deadline items. + Within each category, items are sorted by urgency, which is derived + from the priority (see [[*Priorities]]), plus additional increments + for overdue scheduled or deadline items. The lowest priority is + scored as 0, the next as 1000, and continues in steps of 1000 until + reaching the highest priority, e.g., =C=, =B=, =A= are scored as 0, + 1000, and 2000, respectively. - For the TODO list, items remain in the order of categories, but within each category, sorting takes place according to urgency. The @@ -9773,6 +9888,7 @@ filter elements are accumulated. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) #+end_src + #+vindex: org-agenda-sort-noeffort-is-high #+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 @@ -9781,7 +9897,7 @@ filter elements are accumulated. 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 + the value of ~org-agenda-sort-noeffort-is-high~. To clear the filter, press {{{kbd(_)}}} twice (once to call the command again, and once at the first prompt). @@ -10061,7 +10177,7 @@ the other commands, point needs to be in the desired line. 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 + 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. @@ -10201,11 +10317,11 @@ the other commands, point needs to be in the desired line. #+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. + the Org heading 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~) :: @@ -10295,9 +10411,9 @@ the other commands, point needs to be in the desired line. #+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. + original Org file. A prefix argument 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~) :: @@ -10849,7 +10965,7 @@ as they operate on the current buffer only. 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 +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~. @@ -10872,7 +10988,7 @@ Here are two examples: 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 +and also all lines tagged with =garden=. Finally, the command {{{kbd(o)}}} provides a similar view for office tasks. *** Setting options for custom commands @@ -10896,7 +11012,7 @@ at the right spot in ~org-agenda-custom-commands~. For example: ((org-agenda-sorting-strategy '(priority-down)) (org-agenda-prefix-format " Mixed: "))) ("U" tags-tree "+boss-urgent" - ((org-show-context-detail 'minimal))) + ((org-fold-show-context-detail 'minimal))) ("N" search "" ((org-agenda-files '("~org/notes.org")) (org-agenda-text-search-extra-files nil))))) @@ -11148,7 +11264,7 @@ environment. This causes the following issues: 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 + 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. @@ -11377,7 +11493,7 @@ 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:: You can turn this on by default by setting -the variable ~org-pretty-entities~, or on a per-file base with the +the variable ~org-pretty-entities~, or on a per-file basis with the =STARTUP= option =entitiespretty=.]: - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) :: @@ -11404,7 +11520,7 @@ converted into dashes, and =...= becomes a compact set of dots. #+cindex: @TeX{} interpretation #+cindex: @LaTeX{} interpretation -Plain ASCII is normally sufficient for almost all note taking. +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:37] is widely used to typeset scientific documents. Org mode supports embedding LaTeX code @@ -11441,7 +11557,7 @@ snippets are identified as LaTeX source code: between, and if the closing =$= is followed by whitespace or punctuation (but not a dash). - Sometimes, it may necessary to have a literal dollar symbol even + Sometimes, it may be necessary to have a literal dollar symbol even when it is recognized as LaTeX math delimiter. Org provides =\dollar= and =\USD= entities (see [[*Special Symbols]]) that are rendered as =$= for such scenarios. Also, see [[*Escape Character]]. @@ -11523,13 +11639,14 @@ 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) -from [[https://elpa.nongnu.org/][NonGNU ELPA]] 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 +=cdlatex.el= and =texmathp.el= (the latter comes also with AUCTeX). +The =cdlatex= package can be installed from +[[https://elpa.nongnu.org/nongnu/cdlatex.html][NonGNU ELPA]] with the +[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html][Emacs +packaging system]]. 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) @@ -11676,7 +11793,7 @@ labels, and use them as targets for special hyperlinks like =[[(name)]]=---i.e., the reference name enclosed in single parentheses. In HTML, hovering the mouse over such a link remote-highlights the corresponding code line[fn:: This requires some -Javascript which is /not/ automatically included in the HTML output: +JavaScript which is /not/ automatically included in the HTML output: you have to customize the variable =org-html-head-include-scripts= to ~t~ to have it included (it is ~nil~ by default).], which is kind of cool. @@ -11685,7 +11802,7 @@ source code[fn:: 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.]. 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. +the code listing. Otherwise, links use the labels with no parentheses. Here is an example: #+begin_example -l "(dumb-reference:%s)" @@ -11742,7 +11859,77 @@ 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 +** Images and link previews +:PROPERTIES: +:DESCRIPTION: Preview links in the buffer +:END: + +Org mode can display previews of hyperlinks (see [[*Hyperlinks]]) +inside Org buffers. By default, only image links[fn::Image links are +=file:= and =attachment:= links to existing image files; Emacs can +only display the linked images listed in ~image-types~ variable] can +be previewed inline, where the images are displayed in place of the +link path. + +You can customize the previews as described in [[*Adding Hyperlink +preview]]. Link previews do not have to display images -- any kind of +display decoration (see [[info:elisp#Overlay Properties]]) can be +used. + +You can preview the supported link types in the whole buffer, in the +current section, active region or at point with the following commands: + +- {{{kbd(C-c C-x C-v)}}} (~org-link-preview~) :: + + #+kindex: C-c C-x C-v + #+findex: org-link-preview + Create inline previews for external links in the active region, if + any; the link at point, if there is such; or in the current section + otherwise. With a prefix argument, clear link previews at point or + in the current entry. With a double prefix argument, preview all + links in the buffer. With triple prefix argument, hide previews for + all links in the buffer. + + By default, only links without descriptions are previewed. You + can force displaying previews for all supported links (including + links with descriptions) using a numeric argument of ~1~. This + will toggle all previews in the active region, the link at point + or the current section. A numeric prefix argument of ~11~ will + toggle previews in the whole buffer instead. + + #+vindex: org-startup-with-link-previews + Org mode can display link previews automatically when opening + buffers. Either customize ~org-startup-with-link-previews~ or use + the =#+STARTUP: linkpreviews= keyword to enable previews for that + specific buffer when opening it. =#+STARTUP: nolinkpreviews= will + disable previews on startup in the buffer. + +- {{{kbd(C-c C-x C-M-v)}}} (~org-link-preview-refresh~) :: + + #+kindex: C-c C-x C-M-v + #+findex: org-link-preview-refresh + Assure inline display of external link previews in the whole buffer + and refresh them. + +- {{{kbd(M-x org-link-preview-region)}}} :: + + #+findex: org-link-preview-region + Create inline previews for external links in the active region, or + the buffer. With a prefix argument, also preview links with a text + description part. + +- {{{kbd(M-x org-link-preview-clear)}}} :: + + #+findex: org-link-preview-clear + Clear external link previews in the active region, or the buffer. + +#+vindex: org-cycle-inline-images-display +Link previews can also be displayed when cycling the folding state. +When the custom option ~org-cycle-link-previews-display~ is set, +supported link types under the subtree (including images) will be +displayed automatically. + +*** Images :PROPERTIES: :DESCRIPTION: Display an image. :END: @@ -11767,95 +11954,76 @@ make sure that the link is on a line by itself and precede it with [[./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:: The variable - ~org-startup-with-inline-images~ can be set within a buffer with the - =STARTUP= options =inlineimages= and =noinlineimages=.]. - - - #+vindex: org-image-actual-width - #+vindex: org-image-max-width - #+cindex: @samp{ORG-IMAGE-ACTUAL-WIDTH}, property - By default, Org mode displays inline images according to their - actual width, but no wider than ~fill-column~ characters. - - You can customize the displayed image width using - ~org-image-actual-width~ variable (globally) or - =ORG-IMAGE-ACTUAL-WIDTH= property (subtree-level)[fn:: The width can - be customized in Emacs >= 24.1, built with imagemagick support.]. - Their value can be the following: - - (default) Non-~nil~, use the actual width of images when inlining - them. If the actual width is too wide, limit it according to - ~org-image-max-width~. - - When set to a number, use imagemagick (when available) to set the - image's width to this value. - - When set to a number in a list, try to get the width from any - =#+ATTR.*= keyword if it matches a width specification like: - #+begin_example - ,#+ATTR_HTML: :width 300px - #+end_example - and fall back on that number if none is found. - - When set to ~nil~, try to get the width from an =#+ATTR.*= keyword - and fall back on the original width or ~org-image-max-width~ if - none is found. - - ~org-image-max-width~ limits the maximum displayed image width, but - only when the image width is not set explicitly. Possible maximum - width can be set to: - - (default) ~fill-column~, limit width to ~fill-column~ number of - characters. - - ~window~, limit width to current window width. - - integer number, limit width to that specified number of pixels. - - ~nil~, do not limit the width. - - #+vindex: org-image-align - Org mode can left-align, center or right-align the display of inline - images. This setting is controlled (globally) by ~org-image-align~. - Only standalone images are affected, corresponding to links with no - surrounding text in their paragraph except for whitespace. Its - value can be the following: - - (default) The symbol ~left~, which inserts the image where the - link appears in the buffer. - - The symbol ~center~, which will preview links centered in the - Emacs window. - - The symbol ~right~, which will preview links right-aligned in the - Emacs window. - - Inline image alignment can be specified for each link using the - =#+ATTR.*= keyword if it matches an alignment specification like: - #+begin_example - ,#+ATTR_HTML: :align center - #+end_example - Org will use the alignment specification from any =#+ATTR.*= - keyword, such as =#+ATTR_HTML= or =#+ATTR_LATEX=, but =#+ATTR_ORG= - (if present) will override the others. For instance, this link +When link previews are displayed as images, the image size and +alignment can be further customized. + +#+vindex: org-image-actual-width +#+vindex: org-image-max-width +#+cindex: @samp{ORG-IMAGE-ACTUAL-WIDTH}, property +By default, Org mode displays inline images according to their +actual width, but no wider than ~fill-column~ characters. + +You can customize the displayed image width using +~org-image-actual-width~ variable (globally) or +=ORG-IMAGE-ACTUAL-WIDTH= property (subtree-level)[fn:: The width can +be customized in Emacs >= 24.1, built with ImageMagick support.]. +Their value can be the following: +- (default) Non-~nil~, use the actual width of images when inlining + them. If the actual width is too wide, limit it according to + ~org-image-max-width~. +- When set to a number, use ImageMagick (when available) to set the + image's width to this value. +- When set to a number in a list, try to get the width from any + =#+ATTR.*= keyword if it matches a width specification like: #+begin_example - ,#+ATTR_HTML: :align right - ,#+ATTR_ORG: :align center - [[/path/to/image/file.png]] + ,#+ATTR_HTML: :width 300px #+end_example - will be displayed centered in Emacs but exported right-aligned to - HTML. - - When =#+ATTR_ORG= is not set, inline image alignment is also read - from the =:center= attribute supported by some export backends (like - HTML, LaTeX and Beamer.) + and fall back on that number if none is found. +- When set to ~nil~, try to get the width from an =#+ATTR.*= keyword + and fall back on the original width or ~org-image-max-width~ if + none is found. + +~org-image-max-width~ limits the maximum displayed image width, but +only when the image width is not set explicitly. Possible maximum +width can be set to: +- (default) ~fill-column~, limit width to ~fill-column~ number of + characters. +- ~window~, limit width to current window width. +- integer number, limit width to that specified number of pixels. +- ~nil~, do not limit the width. + +#+vindex: org-image-align +Org mode can left-align, center or right-align the display of inline +images. This setting is controlled (globally) by ~org-image-align~. +Only standalone images are affected, corresponding to links with no +surrounding text in their paragraph except for whitespace. Its +value can be the following: +- (default) The symbol ~left~, which inserts the image where the + link appears in the buffer. +- The symbol ~center~, which will preview links centered in the + Emacs window. +- The symbol ~right~, which will preview links right-aligned in the + Emacs window. + +Inline image alignment can be specified for each link using the +=#+ATTR.*= keyword if it matches an alignment specification like: +#+begin_example +,#+ATTR_HTML: :align center +#+end_example +Org will use the alignment specification from any =#+ATTR.*= +keyword, such as =#+ATTR_HTML= or =#+ATTR_LATEX=, but =#+ATTR_ORG= +(if present) will override the others. For instance, this link +#+begin_example +,#+ATTR_HTML: :align right +,#+ATTR_ORG: :align center +[[/path/to/image/file.png]] +#+end_example +will be displayed centered in Emacs but exported right-aligned to +HTML. -#+vindex: org-cycle-inline-images-display -Inline images can also be displayed when cycling the folding state. -When custom option ~org-cycle-inline-images-display~ is set, the -visible inline images under subtree will be displayed automatically. +When =#+ATTR_ORG= is not set, inline image alignment is also read from +the =:center= attribute supported by some export backends (like HTML, +LaTeX and Beamer.) ** Captions :PROPERTIES: @@ -12098,7 +12266,7 @@ further alter what is exported, and how. #+kindex: C-c C-e C-f Toggle force-publishing export. Publish functions normally only - publish changed files (see [[**Triggering Publication]]). Forced + publish changed files (see [[*Triggering Publication]]). Forced publishing causes files to be published even if their timestamps do not indicate the file has been changed. @@ -12179,7 +12347,7 @@ global variables, include: #+cindex: @samp{DATE}, keyword #+vindex: org-export-date-timestamp-format A date or a timestamp[fn:: The variable - ~org-export-date-timestamp-format~ defines how this timestamp are + ~org-export-date-timestamp-format~ defines how this timestamp is exported.]. - =EMAIL= :: @@ -12363,9 +12531,10 @@ following arguments. - ~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 backends, they become list items. + Set the last headline level for export as a headline + (~org-export-headline-levels~). For descendants of that level, + headlines are treated differently. In most backends, they become + list items. - ~inline~ :: @@ -12484,7 +12653,7 @@ 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= +on a per-file basis, using the following =toc= item in =OPTIONS= keyword: #+begin_example @@ -12579,7 +12748,7 @@ example, to include your =.emacs= file, you could use: #+texinfo: @noindent There are three positional arguments after the include keyword, they are: 1. The file name, this is the sole mandatory argument. Org neither - checks for correctness or validates the content in any way. + checks for correctness nor validates the content in any way. 2. The block name to wrap the file content in. When this is =example=, =export=, or =src= the content is escaped by ~org-escape-code-in-string~. Arbitrary block names may be given, @@ -12589,7 +12758,7 @@ There are three positional arguments after the include keyword, they are: #+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 +Org assumes it to 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 @@ -12646,9 +12815,11 @@ The following command allows navigating to the included document: #+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: +#+vindex: org-export-replace-macros +Macros replace text snippets during export[fn::The macro replacement +can be disabled by setting ~org-export-replace-macros~ to nil (default +is t).]. Macros are defined globally in ~org-export-global-macros~, +or document-wise with the following syntax: : #+MACRO: name replacement text; $1, $2 are arguments @@ -12713,7 +12884,7 @@ Org comes with following pre-defined macros: 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. + Otherwise, Org reads the file attributes. - ={{{input-file}}}= :: @@ -12765,16 +12936,17 @@ exported. #+cindex: @samp{BEGIN_COMMENT} #+cindex: comment block -Likewise, regions surrounded by =#+BEGIN_COMMENT= ... =#+END_COMMENT= -are not exported. +Likewise, comment blocks =#+BEGIN_COMMENT= ... =#+END_COMMENT= are not +exported. [fn::Just like in [[*Literal Examples]], you need to escape +leading =*= with =,= to avoid interpreting them as headings.] #+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:: For a less drastic behavior, consider using a -select tag (see [[*Export Settings]]) instead.]. The command below -helps changing the comment status of a headline. +is executed or tangled[fn:: For less restrictive export limitations, +consider using a select tag (see [[*Export Settings]]) instead.]. The +command below helps to change the comment status of a headline. - {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: #+kindex: C-c ; @@ -12924,6 +13096,10 @@ high-quality interactive slides for presentations. Beamer is a LaTeX document class for creating presentations in PDF, HTML, and other popular display formats. +We strongly recommend familiarizing yourself with Beamer terminology +before reading the rest of this chapter. See + and references therein. + *** Beamer export commands :PROPERTIES: :DESCRIPTION: For creating Beamer documents. @@ -13066,6 +13242,11 @@ should in principle be exportable as a Beamer presentation. frames. It is also useful for properly closing a =column= environment. + #+cindex: @samp{BEAMER_SUBTITLE}, property + If =BEAMER_SUBTITLE= is set, Org exports its value as the subtitle + for the headline's frame. This property has no effect on headlines + which are not exported as frames. + #+cindex: @samp{BEAMER_ACT}, property #+cindex: @samp{BEAMER_OPT}, property When =BEAMER_ACT= is set for a headline, Org export translates that @@ -13182,6 +13363,7 @@ Here is an example of an Org document ready for Beamer export. ,#+AUTHOR: Carsten Dominik ,#+OPTIONS: H:2 toc:t num:t ,#+LATEX_CLASS: beamer +,#+STARTUP: beamer ,#+LATEX_CLASS_OPTIONS: [presentation] ,#+BEAMER_THEME: Madrid ,#+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) @@ -13252,7 +13434,7 @@ settings described in [[*Export Settings]]. #+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 + it as an HTML meta tag in the HTML file. For long descriptions, use multiple =DESCRIPTION= lines. The exporter takes care of wrapping the lines properly. @@ -13447,11 +13629,11 @@ name, and date. *** Exporting to minimal HTML :PROPERTIES: -:DESCRIPTION: Exporting HTML without CSS, Javascript, etc. +: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, +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 @@ -13477,7 +13659,7 @@ no preamble or postamble, here are the variable you would need to set: :END: The HTML export backend transforms =<= and =>= to =<= and =>=. -To include raw HTML code in the Org file so the HTML export backend +To include raw HTML code in the Org file, so the HTML export backend can insert that HTML code in the output, use this inline syntax: =@@html:...@@=. For example: @@ -13506,9 +13688,17 @@ Headlines are exported to =

=, =

=, etc. Each headline gets the 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 == tags. These tags have -a =href= attribute making the headlines link to themselves. +Headlines can contain a link to themselves. To enable it, you can: + +- Set the variable ~org-html-self-link-headlines~ to a non-~nil~ value +- In an Org file, use ~html-self-link-headlines~ option + : #+OPTIONS: html-self-link-headlines:t + + +#+texinfo: @noindent +When enabled, the text of the headlines is wrapped in == tags. +These tags have a =href= attribute making the headlines link to +themselves. *** Links in HTML export :PROPERTIES: @@ -13565,6 +13755,11 @@ following lines before the table in the Org file: ,#+ATTR_HTML: :border 2 :rules all :frame border #+end_example +Note that table attributes are deprecated in HTML5 in favor of CSS. +When the doctype is set to HTML5 (see [[*HTML doctypes]]), Org ignores +~org-html-table-default-attributes~. =#+ATTR_HTML:= is still +respected, but not recommended. + The HTML export backend preserves column groupings in Org tables (see [[*Column Groups]]) when exporting to HTML. @@ -13623,11 +13818,13 @@ backend by default in-lines that image. For example: =the image=. For more details, see the variable ~org-html-inline-images~. +#+vindex: org-html-inline-image-rules On the other hand, if the description part of the Org link is itself -another link, such as =file:= or =https:= URL pointing to an image, the -HTML export backend in-lines this image and links to the main image. -This Org syntax enables the backend to link low-resolution thumbnail -to the high-resolution version of the image, as shown in this example: +another link, such as =file:= or =https:= URL pointing to an image +(the exact rule is defined in ~org-html-inline-image-rules~), the HTML +export backend in-lines this image and links to the main image. This +Org syntax enables the backend to link low-resolution thumbnail to the +high-resolution version of the image, as shown in this example: : [[file:highres.jpg][file:thumb.jpg]] @@ -13656,15 +13853,15 @@ as-is. #+cindex: dvisvgm #+cindex: ImageMagick -#+vindex: org-html-mathjax-options~ +#+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 [[https://www.mathjax.org][MathJax]], which should work out of the box with Org[fn:: By default, Org loads MathJax from [[https://www.jsdelivr.com/][jsDelivr]], as recommended in [[https://docs.mathjax.org/en/latest/web/start.html][Getting Started -with MathJax Components]].][fn:47]. Some MathJax display options can -be configured via ~org-html-mathjax-options~, or in the buffer. For +with MathJax Components]].][fn:47]. Some MathJax options can be +configured via ~org-html-mathjax-options~, or in the buffer. For example, with the following settings, #+begin_example @@ -13673,11 +13870,17 @@ example, with the following settings, #+texinfo: @noindent equation labels are displayed on the left margin and equations are -five em from the left margin. +five ems from the left margin. + +To use a local copy of MathJax, use =path= option: + +#+begin_example +,#+HTML_MATHJAX: path:the/path/to/mathjax.js +#+end_example #+vindex: org-html-mathjax-template See the docstring of ~org-html-mathjax-options~ for all supported -variables. The MathJax template can be configure via +variables. The MathJax template can be configured via ~org-html-mathjax-template~. If you prefer, you can also request that LaTeX fragments are processed @@ -13812,7 +14015,7 @@ 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 +Never change the ~org-html-style-default~ constant. Instead, use other simpler ways of customizing as described above. *** JavaScript supported display of web pages @@ -13878,7 +14081,7 @@ options described below: - =ftoc:= :: Does the CSS of the page specify a fixed position for the "toc"? If - yes, the toc is displayed as a section. + yes, the TOC is displayed as a section. - =ltoc:= :: @@ -13968,7 +14171,7 @@ from https://mirrors.ctan.org/info/latex-doc-ptr/latex-doc-ptr.pdf] any buffer. #+vindex: org-latex-compiler -#+vindex: org-latex-bibtex-compiler +#+vindex: org-latex-bib-compiler #+vindex: org-latex-default-packages-alist #+cindex: pdflatex #+cindex: xelatex @@ -13981,7 +14184,7 @@ LaTeX export backend 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 +compilers. Also see ~org-latex-bib-compiler~ to set the bibliography compiler[fn:48]. *** LaTeX specific export settings @@ -14012,7 +14215,7 @@ general options (see [[*Export Settings]]). #+vindex: org-export-default-language Language code of the primary document language. When =LANGUAGE= - keyword is not not specified use the value of + keyword is not specified use the value of ~org-export-default-language~ (by default - =en=, American English) The list of language codes supported by Org is stored in the @@ -14066,6 +14269,11 @@ general options (see [[*Export Settings]]). hyperref settings. See ~org-latex-classes~ for adjusting the structure and order of the LaTeX headers. +- =LATEX_CLASS_PRE= :: + + #+cindex: @samp{LATEX_CLASS_PRE}, keyword + Arbitrary lines to prepend before the LaTeX preamble. + - =KEYWORDS= :: #+cindex: @samp{KEYWORDS}, keyword @@ -14085,7 +14293,7 @@ general options (see [[*Export Settings]]). #+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 + non-~nil~, it is typed outside 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. @@ -14157,6 +14365,16 @@ A sample Org file with the above headers: some more text #+end_example +#+cindex: @samp{LATEX_CLASS_PRE}, keyword +The LaTeX export backend prepends values from =LATEX_CLASS_PRE= +keywords before the LaTeX preamble. Use this option when you want to +set the values passed to packages included in the document class. For +example, to use extended names for the ~xcolor~ package, use + +#+begin_example +,#+LATEX_CLASS_PRE: \PassOptionsToPackage{dvipsnames}{xcolor} +#+end_example + #+cindex: @samp{LANGUAGE}, keyword #+vindex: org-export-default-language LaTeX packages =babel= or =polyglossia= can also be loaded in a @@ -14205,6 +14423,18 @@ This would produce in LaTeX (with the actual =polyglossia= syntax): \setotherlanguage{french} #+end_example +#+vindex: org-latex-use-sans +The LaTeX backend normally exports using the Roman font family +specified in the document class or by the user in the +=LATEX_HEADER=. Setting the option ~org-latex-use-sans~ to =t= will +force the LaTeX compiler to use the Sans font as default. You can also +include it in the document options with: + +#+begin_example +#+OPTIONS: latex-use-sans:t +#+end_example + + *** Quoting LaTeX code :PROPERTIES: :DESCRIPTION: Incorporating literal @LaTeX{} code. @@ -14213,7 +14443,7 @@ This would produce in LaTeX (with the actual =polyglossia= syntax): When the available LaTeX export customizations are not sufficient to fine-tune the desired output, it is possible to 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. +code in the Org file, and they all use different quoting syntax. #+cindex: inline, in @LaTeX{} export Inserting in-line quoted with @ symbols: @@ -14338,7 +14568,7 @@ include: =: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 +LaTeX table attributes help to format tables for a wide range of situations, such as matrix product or spanning multiple pages: #+begin_example @@ -14374,7 +14604,7 @@ Set the caption with the LaTeX command The LaTeX export backend 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 +the PDF, they are no longer links, but actual images embedded on the page. The LaTeX export backend uses =\includegraphics= macro to insert the image. But for TikZ (https://sourceforge.net/projects/pgf/) images, the backend uses an ~\input~ macro wrapped within @@ -14740,6 +14970,42 @@ some text in German... \end{foreigndisplayquote} #+end_example +*** Controlling the way the table of contents is generated +#+cindex: LaTeX ToC export + +When exporting your document to LaTeX, only numbered sections will be +included. This is closer to LaTeX and different to how other exporters +work (see [[*Table of Contents]]). If you need an unnumbered section +to appear in the table of contents, use the property =UNNUMBERED= and +set it to =toc=: + +#+begin_example +:PROPERTIES: +:UNNUMBERED: toc +:END: +#+end_example + +#+cindex: LaTeX ToC export a la ~org~ +#+cindex: @samp{org-latex-toc-include-unnumbered} +If you want the LaTeX exporter to behave like other exporters, +customise the variable ~org-latex-toc-include-unnumbered~ and +set it to ~t~: + +#+begin_example +(setq org-latex-toc-include-unnumbered t) +#+end_example + +or add this setting in the local variables. + +In this case, unnumbered sections will be included in the table of +contents, unless you set the =UNNUMBERED= property to =notoc=: + +#+begin_example +:PROPERTIES: +:UNNUMBERED: notoc +:END: +#+end_example + ** Markdown Export :PROPERTIES: :DESCRIPTION: Exporting to Markdown. @@ -14755,7 +15021,7 @@ Since "md" backend is built on top of the HTML backend (see [[*HTML Export]]), it converts every Org construct not defined in Markdown syntax, such as tables, to HTML. -Do note that the original markdown syntax has differences with other +Do note that the original Markdown syntax has differences with other commonly used Markdown flavors. See https://en.wikipedia.org/wiki/Markdown for more details. @@ -14931,7 +15197,7 @@ way to extend (see [[*ODT export commands]]). :UNNUMBERED: notoc :END: -The Org export backend is made to be inter-operable with a wide range +The Org export backend is made to be interoperable 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 @@ -15448,7 +15714,7 @@ factory styles used by the exporter. - =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 + 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 @@ -16155,7 +16421,7 @@ This option controls how exactly @code{do-something} does its thing. #+end_example #+texinfo: @noindent -Command in parenthesis, as done above, is optional. +Command in parentheses, as done above, is optional. *** Tables in Texinfo export :PROPERTIES: @@ -16369,6 +16635,12 @@ certain built-in types (see ~icalendar-export-sexp-enumerate-all~), are exported up to ~icalendar-export-sexp-enumeration-days~ into future.]. +#+vindex: org-agenda-default-appointment-duration +If a timestamp contains a time, but doesn't have an explicit end time +(i.e. time range), then by default the exported event will have a +duration of 2 hours, but this can be overridden with +~org-agenda-default-appointment-duration~. + #+vindex: org-icalendar-include-todo The iCalendar export backend can also incorporate TODO entries based on the configuration of the ~org-icalendar-include-todo~ variable. @@ -16473,7 +16745,7 @@ 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 +- =CONFIDENTIAL= :: Only a limited group of clients gets access to the event. - =PRIVATE= :: The entry can be retrieved only by its owner. The server should treat unknown class properties the same as @@ -16523,6 +16795,7 @@ for usage and configuration details. #+vindex: org-export-before-processing-hook #+vindex: org-export-before-processing-functions #+vindex: org-export-before-parsing-hook +#+vindex: org-export-before-parsing-functions The export process executes two hooks before the actual exporting begins. The first hook, ~org-export-before-processing-functions~, runs before any expansions of macros, Babel code, and include keywords @@ -16635,7 +16908,7 @@ debugging. :END: #+findex: org-export-as -Org mode export is a multi-step process that works on a temporary copy +Org mode export is a multistep process that works on a temporary copy of the buffer. The export process consists of 4 major steps: 1. Process the temporary copy, making necessary changes to the buffer @@ -16666,7 +16939,8 @@ export keywords, does not contribute to the export output.]: 3. Remove commented subtrees in the whole buffer (see [[*Comment Lines]]); -4. Replace macros in the whole buffer (see [[*Macro Replacement]]); +4. Replace macros in the whole buffer (see [[*Macro Replacement]]), + unless ~org-export-replace-macros~ is nil; 5. When ~org-export-use-babel~ is non-nil (default), process code blocks: @@ -16721,7 +16995,7 @@ Parse the temporary buffer, creating AST: - Clocks, drawers, fixed-width environments, footnotes, LaTeX environments and fragments, node properties, planning lines, - property drawers, statistics cookies, timestamps, etc according + property drawers, statistics cookies, timestamps, etc. according to =#+OPTIONS= keyword (see [[*Export Settings]]); - Table rows containing width and alignment markers, unless the @@ -16788,7 +17062,7 @@ Post-process the exported text: :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 +elements to introduce a new or revised translation. That is how the HTML export backend was extended to handle Markdown format. The extensions work seamlessly so any aspect of filtering not done by the extended backend is handled by the original backend. Of all the @@ -16969,7 +17243,7 @@ where to put published files. - ~:publishing-directory~ :: Directory where output files are published. You can directly - publish to a webserver using a file name syntax appropriate for the + publish to a web server 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]]). @@ -17052,7 +17326,7 @@ non-Org files, you always need to specify the publishing function: - ~:htmlized-source~ :: - Non-~nil~ means, publish htmlized source. + Non-~nil~ means, publish an htmlized version of the source. The function must accept three arguments: a property list containing at least a ~:publishing-directory~ property, the name of the file to @@ -17358,7 +17632,7 @@ 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. +one, so that you can more easily afford 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 @@ -17508,7 +17782,7 @@ resources. For example, consider the following Org mode snippet : Org mode is used by various communities [cite:teaching: @orgteaching; : and TeX: @orgtex]. [cite/author/caps:@orgtex] uses Org mode to simplify : writing scientific publications, while [cite/author/caps:@orgteaching] -: experiment with Org babel to improve teaching. +: experiments with Org babel to improve teaching. : : #+print_bibliography: @@ -17655,8 +17929,8 @@ Org currently includes the following export processors: large number of publishers' styles). It only supports LaTeX's =\cite= and =\nocite= commands. - - natbib :: as with the bibtex processor, but using the LaTeX - package =natbib=, allowing more stylistic variants that LaTeX's + - natbib :: as with the =bibtex= processor, but using the LaTeX + package =natbib=, allowing more stylistic variants than LaTeX's =\cite= command. - biblatex :: this backend allows the use of data and formats @@ -17884,7 +18158,7 @@ A source code block conforms to this structure: ,#+END_SRC #+end_example -Do not be put-off by having to remember the source block syntax. Org +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 @@ -17903,7 +18177,7 @@ or - =#+NAME: = :: - Optional. Names the source block so it can be called, like + 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 @@ -17925,7 +18199,8 @@ or block. See [[*Languages]], for identifiers of supported languages. When == identifier is omitted, the block also cannot - have == and =
=. + have == and =
=. Otherwise, the first + switch/argument will be treated as ==. Language identifier is also used to fontify code blocks in Org buffers, when ~org-src-fontify-natively~ is set to non-~nil~. See @@ -18018,7 +18293,7 @@ Org expand =:noweb= references by default. (assq-delete-all :noweb org-babel-default-header-args))) #+end_src -#+cindex: language specific default header arguments +#+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:~, where @@ -18067,7 +18342,7 @@ 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: language-specific header arguments properties #+cindex: header arguments per language Language-specific header arguments are also read from properties =header-args:= where {{{var()}}} is the language @@ -18545,11 +18820,12 @@ variable ~default-directory~. Setting =mkdirp= header argument to a non-~nil~ value creates the directory, if necessary. Setting =dir= to the symbol ~attach~ or the string ~"'attach"~ will -set =dir= to the directory returned by ~(org-attach-dir)~, set =:mkdir -yes=, and insert any file paths, as when using =:results file=, which -are under the node's attachment directory using =attachment:= links -instead of the usual =file:= links. Any returned path outside of the -attachment directory will use =file:= links as per usual. +set =dir= to the directory returned by ~(org-attach-dir)~, set +=:mkdirp yes=, and insert any file paths, as when using =:results +file=, which are under the node's attachment directory using +=attachment:= links instead of the usual =file:= links. Any returned +path outside the attachment directory will use =file:= links as per +usual. For example, to save the plot file in the =Work/= folder of the home directory---notice tilde is expanded: @@ -18617,9 +18893,9 @@ to the end of the code block for execution. #+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]]. +Org provides safeguards by prompting for the user's permission before +executing any code. To customize this safeguard, or disable it, see +[[*Code Evaluation and Security Issues]]. *** How to evaluate source code :PROPERTIES: @@ -19054,7 +19330,7 @@ follows from the type specified above. When used along with =file= type, the result is a link to the file specified in =:file= header argument. However, unlike plain =file= type, code block output is not written to the disk. The block is - expected to generate the file by its side-effects only, as in the + expected to generate the file by its side effects only, as in the following example: #+begin_example @@ -19084,10 +19360,10 @@ follows from the type specified above. #+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., +appending strings to =#+BEGIN_= and =#+END_=, except if the value is +=nil= or =no=. 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 @@ -19229,7 +19505,7 @@ blocks, see [[*Literal Examples]]. To selectively export subtrees of an Org document, see [[*Exporting]]. #+cindex: @samp{exports}, header argument -The =exports= header argument is to specify if that part of the Org +The =exports= header argument specifies whether that part of the Org file is exported to, say, HTML or LaTeX formats. - =code= :: @@ -19239,7 +19515,7 @@ file is exported to, say, HTML or LaTeX formats. - =results= :: - The results of evaluation of the code is included in the exported + The results of evaluation of the code are included in the exported file. Example: =:exports results=. - =both= :: @@ -19249,17 +19525,17 @@ file is exported to, say, HTML or LaTeX formats. - =none= :: - Neither the code nor the results of evaluation is included in the + Neither the code nor the results of evaluation are included in the exported file. Whether the code is evaluated at all depends on other options. Example: =:exports none=. -If a source block is named using =NAME= keyword, the same name will be +If a source block is named using the =NAME= keyword, the same name will be assigned to the results of evaluation. This way, fuzzy links pointing to the named source blocks exported using =:exports results= will remain valid and point to the results of evaluation. Results of evaluation of a named block can also be explicitly named -using a separate =NAME= keyword. The name value set via =NAME= +using a separate =NAME= keyword. The name value set via the =NAME= keyword will be preferred over the parent source block. : #+NAME: code name @@ -19275,23 +19551,31 @@ keyword will be preferred over the parent source block. : Another [[results name][link]] will point to the results. Explicit setting of the result name may be necessary when a named code -block is exported using =:exports both=. Links to such block may -arbitrarily point either to the code block or to its results when -results do not have a distinct name. +block is exported using =:exports both=. Links to such a block may +point arbitrarily either to the code block or to its results when +the results do not have a distinct name. Note that all the links pointing to a source block exported using -=:exports none= will be broken. This will make export process fail, +=:exports none= will be broken. This will cause the export process to fail, unless broken links are allowed during export (see [[*Export Settings]]). #+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. +You can prevent Org from evaluating code blocks for speed or security +reasons: + +- To speed up export, use the header argument =:eval never-export= + (see [[*Evaluating Code Blocks]]). +- For greater security, set the ~org-export-use-babel~ variable to + ~nil~, but understand that header arguments will have no effect in + this case. + +If results of evaluation are not marked for export (=:exports code= or +=:exports none=), Org will not evaluate them, even for =:eval yes=. +The only exception is when a code block uses =:session= - such blocks +are evaluated according to their =:eval= header argument. Turning off evaluation comes in handy when batch processing. For -example, markup languages for wikis, which have a high risk of +example, markup languages for wikis 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 @@ -19353,6 +19637,10 @@ to source file(s). file name as being relative to the directory of the Org file's location. Example: =:tangle FILENAME=. +#+cindex: comment trees +Additionally, code blocks inside commented subtrees (see [[*Comment +Lines]]) are never exported. + #+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 @@ -19372,6 +19660,14 @@ already exist in the code block. Wrap the code block in comments. Include links pointing back to the place in the Org file from where the code was tangled. + #+findex: org-store-link + #+vindex: org-id-link-to-org-use-id + Do note that Org will use ~org-store-link~ ([[*Handling Links]]) to + store link to code block. Such link may not be unique if the parent + heading title is a duplicate of earlier heading or changes after + tangling. We recommend setting ~org-id-link-to-org-use-id~ to t to + make sure that the link points to the correct heading. + - =yes= :: Kept for backward compatibility; same as =link=. @@ -19434,7 +19730,7 @@ multiple source code blocks tangle to a single file with conflicting #+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 +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]]). @@ -19517,7 +19813,7 @@ code block header arguments: #+cindex: code block, languages Code blocks in dozens of languages are supported. See Worg website -for [[https://orgmode.org/worg/org-contrib/babel/languages/index.html][language specific documentation]]. +for [[https://orgmode.org/worg/org-contrib/babel/languages/index.html][language-specific documentation]]. #+vindex: org-babel-load-languages By default, only Emacs Lisp is enabled for evaluation. To enable or @@ -19573,14 +19869,13 @@ group ~org-edit-structure~. - ~org-src-lang-modes~ :: #+vindex: org-src-lang-modes - If an Emacs major-mode named ~-mode~ exists, where + If an Emacs major mode named ~-mode~ exists, where {{{var()}}} is the language identifier from code block's - header line, then the edit buffer uses that major mode. Use this + header line, then the edit buffer uses that major mode. If the + major mode does not exist, or the language identifier is omitted, + then the edit buffer falls back to Fundamental mode. Use this variable to arbitrarily map language identifiers to major modes. - When language identifier is omitted in the src block, Org mode's - behavior is undefined. - - ~org-src-window-setup~ :: #+vindex: org-src-window-setup @@ -20234,11 +20529,11 @@ including the user-defined ones. #+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: +Org's outline, with its stars and lack of indents, can look cluttered +in 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 @@ -20401,7 +20696,7 @@ option ~org-startup-numerated~ to =t=, or locally on a file by using #+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 +the context. It is probably the most over-worked, multipurpose key combination in Org. Its uses are well documented throughout this manual, but here is a consolidated list for easy reference. @@ -20412,7 +20707,7 @@ manual, but here is a consolidated list for easy reference. - 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 + cache used to temporarily store the contents of URLs used as values for keywords like =SETUPFILE=. - If point is inside a table, realign the table. @@ -20517,7 +20812,7 @@ changes. #+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 + three must be either letters A--Z or numbers 0--64. The highest priority must have a lower ASCII number than the lowest priority. - =#+PROPERTY: Property_Name Value= :: @@ -20813,7 +21108,7 @@ 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 +we suggest using the zero width space. You can insert one with any of the following: : C-x 8 zero width space @@ -21007,10 +21302,10 @@ 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-)}}} commands to change timestamps, TODO keywords, priorities, and item bullet types, etc. Since -{{{kbd(S-)}}} commands outside of specific contexts do not do +{{{kbd(S-)}}} commands outside 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 +available outside the special contexts where special commands apply, and (ii) extending an existing active region even if point moves across a special context. @@ -21093,7 +21388,7 @@ moves across a special context. #+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: + following code fixes this problem: #+begin_src emacs-lisp (add-hook 'org-mode-hook @@ -21243,7 +21538,7 @@ The latter form is compatible with older Org versions from 9.0 to 9.4. #+cindex: protocol, capture Activating the "capture" handler pops up a =Capture= buffer in Emacs, -using acapture template. +using a capture template. : emacsclient "org-protocol://capture?template=X&url=URL&title=TITLE&body=BODY" @@ -21357,8 +21652,7 @@ adding ~:rewrites~ rules like this: #+texinfo: @noindent Since =example.com/$= is used as a regular expression, it maps -=https://example.com/=, =https://example.com=, -=https://www.example.com/= and similar to +=https://example.com/=, =https://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 @@ -21589,13 +21883,15 @@ value as ~org-attach-method~ (~cp~ by default).] #+cindex: pasting files, images from clipboard Starting from Emacs 29, Org mode supports ~yank-media~ command to yank -images from the clipboard and files from a file manager. +images from the clipboard, files from a file manager and tables copied +from LibreOffice Calc documents. #+vindex: org-yank-image-save-method When yanking images from clipboard, Org saves the image on disk and -inserts the image link to Org buffer. Images are either saved as -attachments to heading (default) or to a globally defined directory. -The save location is controlled by ~org-yank-image-save-method~. +inserts the image link to Org buffer. Images can be saved as +attachments to heading (default), to a globally defined directory, or +to a directory returned by a function call. The save location is +controlled by ~org-yank-image-save-method~. #+vindex: org-yank-image-file-name-function The yanked images are saved under automatically generated name. You @@ -21607,6 +21903,52 @@ of ~org-yank-dnd-method~. Image files pasted this way also respect the value of ~org-yank-image-save-method~ when the action to perform is =attach=. +Tables copied from LibreOffice Calc documents are yanked as Org +tables. + +** Repeating commands +:PROPERTIES: +:DESCRIPTION: Repeating navigation commands +:END: + +#+cindex: repeat-mode, org-mode +#+cindex: repeating navigation commands +When ~repeat-mode~ is turned on, headline motion commands, link and +block navigation commands by only pressing a single key. For example, +instead of typing {{{kbd(C-c C-n)}}} repeatedly, you can just type +{{{kbd(C-c C-n n n n p u ...)}}} to move to different headlines. When +a key not in the map is pressed, it exits ~repeat-mode~ and the +command corresponding to the key is executed (see the +[[info:emacs#Repeating][Emacs user manual]] for more details). + +By default, the following commands are made repeatable in separate +keymaps. + +~org-navigation-repeat-map~: + +| Command | Key binding | Repeat key | +|-----------------------------------+--------------------+--------------| +| ~org-next-visible-heading~ | {{{kbd(C-c C-n)}}} | {{{kbd(n)}}} | +| ~org-previous-visible-heading~ | {{{kbd(C-c C-p)}}} | {{{kbd(p)}}} | +| ~org-forward-heading-same-level~ | {{{kbd(C-c C-f)}}} | {{{kbd(f)}}} | +| ~org-backward-heading-same-level~ | {{{kbd(C-c C-b)}}} | {{{kbd(b)}}} | +| ~org-up-heading~ | {{{kbd(C-c C-u)}}} | {{{kbd(u)}}} | + + +~org-block-navigation-repeat-map~: + +| Command | Key binding | Repeat key | +|----------------------+--------------------+--------------| +| ~org-next-block~ | {{{kbd(C-c M-f)}}} | {{{kbd(f)}}} | +| ~org-previous-block~ | {{{kbd(C-c M-b)}}} | {{{kbd(b)}}} | + +~org-link-navigation-repeat-map~: + +| Command | Key binding | Repeat key | +|---------------------+------------------------+--------------| +| ~org-next-link~ | {{{kbd(C-c C-x C-n)}}} | {{{kbd(n)}}} | +| ~org-previous-link~ | {{{kbd(C-c C-x C-p)}}} | {{{kbd(p)}}} | + * Hacking :PROPERTIES: :DESCRIPTION: How to hack your way around. @@ -21623,7 +21965,7 @@ of Org. :END: #+cindex: hooks -Org has a large number of hook variables for adding functionality. A +Org has numerous hook variables for adding functionality. A complete list of hooks with documentation is maintained by the Worg project at https://orgmode.org/worg/doc.html#hooks. @@ -21633,7 +21975,7 @@ project at https://orgmode.org/worg/doc.html#hooks. :END: #+cindex: add-on packages -Various authors wrote a large number of add-on packages for Org. Some +Various authors wrote many add-on packages for Org. Some of these packages used to be part of the =org-mode= repository but are now hosted in a separate =org-contrib= repository [[https://git.sr.ht/~bzg/org-contrib][here]]. A Worg page with more @@ -21734,15 +22076,76 @@ A review of =ol-man.el=: 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 is passed an argument ~interactive?~ - which this function does not use, but other store functions use to + which this function does not use, but other store functions used to behave differently when a link is stored interactively by the user. 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 + 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 Hyperlink preview +:PROPERTIES: +:DESCRIPTION: Preview behavior for new hyperlink types. +:END: +#+cindex: hyperlinks, adding preview behavior + +By default, Org supports previewing external links for links of type +=file= and =attachment= that point to image files. (See [[*Images]].) + +Support for previewing other link types inline can be added to Org in +the following way: + +1. Add a =:preview= link parameter to the link type using + ~org-link-set-parameters~. As an example, here we add previews for + the =docview= link type. + + #+begin_src emacs-lisp +(org-link-set-parameters + "docview" :preview #'org-link-docview-preview) + #+end_src + +2. The value of the =:preview= parameter must be a function that + accepts three arguments: + - an overlay placed from the start to the end of the link, + - the link path, as a string, and + - the syntax node for the link. + It must return a non-nil value to indicate preview success. A + value of =nil= implies that the preview failed, and the overlay + placed on the link will be removed. + + In our example, we use the =convert= program (part of the + =imagemagick= suite of tools) to create the thumbnail that is + displayed inline. + + #+begin_src emacs-lisp +(defun org-link-docview-preview (ov path _elem) + "Preview file at PATH in overlay OV. + +_ELEM is the syntax node of the link element." + (when (executable-find "convert") + (let* ((path (expand-file-name (substitute-in-file-name path))) + (output-file (expand-file-name (concat "org-docview-preview-" + (substring (sha1 path) 0 10) + ".png") + temporary-file-directory))) + ;; Create or find preview for path + (when (or (file-readable-p output-file) + (= 0 (call-process + "convert" + nil (get-buffer-create "*Org Docview Preview Output*") nil + "-thumbnail" "x320" "-colorspace" "rgb" + "-background" "white" "-alpha" "remove" "-strip" + (concat path "[0]") output-file))) + ;; If preview image is available, display it via the overlay + (overlay-put ov 'display (create-image output-file)))))) + #+end_src + +3. Now previews of docview links for supported document types (PDF, + djvu) are generated (along with image file previews) when calling + ~org-link-preview~. + ** Adding Export Backends :PROPERTIES: :DESCRIPTION: How to write new export backends. @@ -21854,7 +22257,7 @@ of these strategies: - 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 +- Comment and uncomment each line of the table during edits. The {{{kbd(M-x orgtbl-toggle-comment)}}} command makes toggling easy. *** A LaTeX example of radio tables @@ -21908,7 +22311,7 @@ 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 +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 @@ -22115,11 +22518,11 @@ For a global condition applicable to agenda views, use the 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, +with =waiting= status. Manually this is a multistep 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 +returns ~nil~ on match. Otherwise, it gives the location from where the search continues. #+begin_src emacs-lisp @@ -22561,7 +22964,7 @@ skipping facilities. Valid arguments are: #+end_defun The mapping routine can call any arbitrary function, even functions -that change meta data or query the property API (see [[*Using the +that change metadata or query the property API (see [[*Using the Property API]]). Here are some handy functions: #+attr_texinfo: :options org-todo &optional arg @@ -22650,11 +23053,11 @@ 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 + Bastien has written numerous 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 + helped to establish 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. @@ -22691,42 +23094,32 @@ know what I am missing here! :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: +I started maintaining Org in January 2011 and officially stepped down +in December 2024, when Ihor Radchenko agreed to become the new Org +maintainer. I was active for the first few years, then my involvement +slowly decreased thanks to the help of new core contributors whom I'd +like to thank. - 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. + Eric has been 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. + Nicolas was 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. + it opened the doors for many new ideas and features. He rewrote old + exporters and helped with documenting this change. More importantly + (if that's possible), he has been more than reliable during all the + work done for Org 8.0. - 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. + scripts into a stable process. He patiently coped with the many + hiccups that such a change can create for users. - Nick Dokos :: @@ -22735,10 +23128,31 @@ considered co-maintainers, either of the code or the community: overestimate such a great help, and the list would not be so active without him. +- Kyle Meyer :: + + Kyle is maintaining [[https://list.orgmode.org][list.orgmode.org]] + and takes care of backporting upstream GNU Emacs changes into Org's + repository. He also helped tremendously on the mailing list and in + private, patiently answering questions, competently providing advice + and solutions. + +- Ihor Radchenko :: + + Ihor became Org maintainer in December 2024, and I'm very grateful + to him for agreeing to take on this role. His responsiveness on the + mailing list, his determination to improve Org as a core format and + an ecosystem of tools, his clarity about strategic changes that need + to be made make him an asset for the Org community. + 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. +Of course, I'm also grateful 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. + ** List of Contributions :PROPERTIES: :UNNUMBERED: notoc @@ -22787,7 +23201,7 @@ be complete if the ones above were not mentioned in this manual. 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. + to integrate 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, @@ -22812,7 +23226,7 @@ be complete if the ones above were not mentioned in this manual. - Eric Fraga drove the development of Beamer export with ideas and testing. -- Barry Gidden did proofreading the manual in preparation for the book +- Barry Gidden proofread the manual in preparation for the book publication through Network Theory Ltd. - Niels Giesen had the idea to automatically archive DONE trees. @@ -22854,7 +23268,7 @@ be complete if the ones above were not mentioned in this manual. - Jason\nbsp{}F.\nbsp{}McBrayer suggested agenda export to CSV format. -- Kyle Meyer helped setting up the [[https://public-inbox.org/][public-inbox]] archive of the [[https://orgmode.org/list/][Org +- Kyle Meyer helped to set up the [[https://public-inbox.org/][public-inbox]] archive of the [[https://orgmode.org/list/][Org mailing list]] and has been fixing many bugs. - Max Mikhanosha came up with the idea of refiling. @@ -22927,14 +23341,15 @@ be complete if the ones above were not mentioned in this manual. literal examples, and remote highlighting for referenced code lines. - Stathis Sideris wrote the =ditaa.jar= ASCII to PNG converter that is - now packaged into the [[https://git.sr.ht/~bzg/org-contrib][org-contrib]] repository. + available as a package in some operating systems or can be + downloaded from [[https://github.com/stathissideris/ditaa]]. - 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 +- James TD Smith has contributed numerous patches for useful tweaks and features. - Adam Spiers asked for global linking commands, inspired the link @@ -23023,7 +23438,7 @@ that are mentioned in the manual. For a more complete list, use This manual is for Org version {{{version}}}. -Copyright \copy 2004--2025 Free Software Foundation, Inc. +Copyright \copy 2004--2026 Free Software Foundation, Inc. #+begin_quote Permission is granted to copy, distribute and/or modify this document @@ -23090,11 +23505,10 @@ 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:9] 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:9] ~format~ is similar to ~printf~ in ~C~ and other languages, but +can handle arbitrary-precision integers and other Elisp objects. +Consult [[info:elisp#Formatting Strings]] and the docstring of +~format~ for details. [fn:10] Plain URIs are recognized only for a well-defined set of schemes. See [[*External Links]]. Unlike URI syntax, they cannot contain @@ -23129,7 +23543,7 @@ 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:16] With the exception of description lists. But you can allow it +[fn:16] Except for description lists. But you can allow it by modifying ~org-list-automatic-rules~ accordingly. [fn:17] For both =TIMESTAMP= and =TIMESTAMP_IA=: the word "first" @@ -23264,7 +23678,7 @@ variable ~org-preview-latex-default-process~ accordingly. 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]] LaTeX package, [[https://www.ctan.org/pkg/minted][minted]] LaTeX package, or by using -[[https://elpa.gnu.org/packages/engrave-faces.html][engrave-faces]] . Refer to ~org-latex-src-block-backend~ for details. +[[https://elpa.gnu.org/packages/engrave-faces.html][engrave-faces]]. Refer to ~org-latex-src-block-backend~ for details. [fn:41] Source code in code blocks may also be evaluated either interactively or on export. See [[*Working with Source Code]] for more @@ -23275,8 +23689,10 @@ Beamer---, the =org-latex-package-alist= variable needs further configuration. See [[LaTeX specific export settings]]. [fn:43] At the moment, some export backends do not obey this -specification. For example, LaTeX export excludes every unnumbered -headline from the table of contents. +specification. For example, LaTeX export excludes by default +every unnumbered headline from the table of contents, unless you set +the custom variable =org-latex-toc-include-unnumbered= to =t= or add +=:UNNUMBERED: toc= to the section's properties. [fn:44] Note that ~org-link-search-must-match-exact-headline~ is locally bound to non-~nil~. Therefore, ~org-link-search~ only matches diff --git a/elpa/org-9.8.3/doc/org-version.inc b/elpa/org-9.8.3/doc/org-version.inc new file mode 100644 index 00000000..10593e09 --- /dev/null +++ b/elpa/org-9.8.3/doc/org-version.inc @@ -0,0 +1,3 @@ +@c automatically generated, do not edit +@set VERSION 9.8.3 (9.8.3-5d7116) +@set DATE 2026-04-18 diff --git a/elpa/org-9.7.39/doc/org.texi b/elpa/org-9.8.3/doc/org.texi similarity index 68% rename from elpa/org-9.7.39/doc/org.texi rename to elpa/org-9.8.3/doc/org.texi index 55dffb8e..c25876d0 100644 --- a/elpa/org-9.7.39/doc/org.texi +++ b/elpa/org-9.8.3/doc/org.texi @@ -7,21 +7,21 @@ @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} +@set MAINTAINER Ihor Radchenko +@set MAINTAINEREMAIL @email{yantar92@posteo.net} +@set MAINTAINERCONTACT @uref{mailto:yantar92@posteo.net,contact the maintainer} @c %**end of header @copying -This manual is for Org version 9.7. +This manual is for Org version 9.8. -Copyright @copyright{} 2004--2025 Free Software Foundation, Inc. +Copyright @copyright{} 2004--2026 Free Software Foundation@comma{} 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 +Permission is granted to copy@comma{} distribute and/or modify this document +under the terms of the GNU Free Documentation License@comma{} 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,'' +Invariant Sections@comma{} with the Front-Cover Texts being ``A GNU Manual@comma{}'' 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.'' @@ -39,7 +39,7 @@ modify this GNU manual.'' @finalout @titlepage @title The Org Manual -@subtitle Release 9.7 +@subtitle Release 9.8 @author The Org Mode Developers @page @vskip 0pt plus 1filll @@ -296,7 +296,7 @@ Markup for Rich Contents * 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. +* Images and link previews:: Preview links in the buffer * Captions:: Describe tables, images... * Horizontal Rules:: Make a line. * Creating Footnotes:: Edit and read footnotes. @@ -307,6 +307,10 @@ Embedded @LaTeX{} * Previewing @LaTeX{} fragments:: What will this snippet look like? * CD@LaTeX{} mode:: Speed up entering of formulas. +Images and link previews + +* Images:: Display an image. + Exporting * The Export Dispatcher:: The main interface. @@ -343,7 +347,7 @@ 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. -* Bare HTML:: Exporting HTML without CSS, Javascript, etc. +* Bare HTML:: Exporting HTML without CSS, JavaScript, etc. * Quoting HTML tags:: Using direct HTML in Org files. * Headlines in HTML export:: Formatting headlines. * Links in HTML export:: Inserting and formatting links. @@ -369,6 +373,7 @@ HTML Export * Horizontal rules in @LaTeX{} export:: Attributes specific to horizontal rules. * Verse blocks in @LaTeX{} export:: Attributes specific to special blocks. * Quote blocks in @LaTeX{} export:: Attributes specific to quote blocks. +* Controlling the way the table of contents is generated:: OpenDocument Text Export @@ -479,6 +484,7 @@ Miscellaneous * Org Crypt:: Encrypting Org files. * Org Mobile:: Viewing and capture on a mobile device. * Drag and Drop & @code{yank-media}:: Dropping and pasting files and images +* Repeating commands:: Repeating navigation commands Clean View @@ -507,6 +513,7 @@ Hacking * Hooks:: How to reach into Org's internals. * Add-on Packages:: Available extensions. * Adding Hyperlink Types:: New custom link types. +* Adding Hyperlink preview:: Preview behavior for new hyperlink types. * Adding Export Backends:: How to write new export backends. * Tables in Arbitrary Syntax:: Orgtbl for LaTeX and other programs. * Dynamic Blocks:: Automatically filled blocks. @@ -543,83 +550,84 @@ Tables in Arbitrary Syntax @cindex summary -Org Mode is an authoring tool and a TODO lists manager for GNU Emacs. +Org mode is an authoring tool and a TODO list manager for GNU Emacs. It relies on a lightweight plain-text markup language used in files with the @samp{.org} extension. -Authoring Org files is best supported by Emacs, but you can view, -understand, and change them with any text editor. +Authoring Org files is best supported by Emacs@comma{} but you can view@comma{} +understand@comma{} and change them with any text editor. -As an authoring tool, Org helps you write structured documents and +As an authoring tool@comma{} Org helps you write structured documents and provides exporting facilities. Org files can also be used for literate -programming and reproducible research. As a TODO lists manager, Org -helps you organize your tasks in a flexible way, from daily needs to -detailed project-planning, allowing logging, multiple views on your -tasks, exporting your agendas, etc. - -Org mode 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. +programming and reproducible research. As a TODO list manager@comma{} Org +helps you organize your tasks in a flexible way@comma{} from daily needs to +detailed project planning@comma{} allowing logging@comma{} multiple views of your +tasks@comma{} exporting your agendas@comma{} etc. + +Org mode is implemented on top of Outline mode@comma{} which makes it +possible to keep the content of large files well-structured. +Visibility cycling and structure editing help you 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. +URL-like links connect to websites@comma{} emails@comma{} Usenet messages@comma{} BBDB +entries@comma{} and any files related to the projects. -Org develops organizational tasks around notes files that contain +Org develops organizational tasks around note 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 +and task management make use of metadata@comma{} which is part of an outline +node. Based on this data@comma{} specific entries can be extracted via +queries to 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. +project planning schemes@comma{} 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 +Org files can serve as a single-source authoring system with export to +many different formats such as HTML@comma{} @LaTeX{}@comma{} Open Document@comma{} and +Markdown. New export backends can be derived from existing ones@comma{} or defined from scratch. -Org files can include source code blocks, which makes Org uniquely +Org files can include source code blocks@comma{} 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. +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 keeps simple things simple. When first fired up@comma{} it should feel +like a straightforward@comma{} easy-to-use outliner. Complexity is not +imposed@comma{} 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 +personal---fraction of Org's capabilities@comma{} and know that there is more whenever they need it. -All of this is achieved with strictly plain text files, the most +All of this is achieved with strictly plain text files@comma{} 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 +one of the most widely ported programs@comma{} 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 +of Org@comma{} as well as additional information@comma{} frequently asked questions +(FAQ)@comma{} links to tutorials@comma{} etc. This page is located at @uref{https://orgmode.org}. @cindex print edition An earlier version (7.3) of this manual was available as a paperback -book from the Network Theory Ltd. publishing company, closed in 2009. +book from the Network Theory Ltd. publishing company@comma{} which closed +in 2009. @node Installation @section Installation @cindex installation -Org is included in distributions of GNU Emacs, you probably do not +Org is included in distributions of GNU Emacs@comma{} so you probably do not need to install it. Most users will simply activate Org and begin exploring its features. -If, for one reason or another, you want to install Org on top of this -pre-packaged version, you can use the Emacs package system or clone -Org's git repository. We @strong{strongly recommend} sticking to a single +If@comma{} for one reason or another@comma{} you want to install Org on top of the +pre-packaged version@comma{} you can use the Emacs package system or clone +Org's Git repository. We @strong{strongly recommend} sticking to a single installation method. -When installing Org on top of the pre-packaged version, please note +When installing Org on top of the pre-packaged version@comma{} please note that Org stable versions are meant to be fully compatible with the last three stable versions of Emacs but not with older Emacsen. @@ -631,29 +639,42 @@ with the latest stable versions of these third-party packages. @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'', +install Elisp libraries. You can install Org from the ``package menu''@comma{} 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. +visited@comma{} i.e.@comma{} where no Org built-in functions have been loaded. +Otherwise@comma{} autoloaded Org functions will mess up the installation. @end quotation -@anchor{Using Org's git repository} -@subheading Using Org's git repository +To avoid interference with the built-in Org mode@comma{} you can use the +command line (you need Emacs 30 or later): + +@example +emacs -Q -batch -eval "(progn (require 'package) (package-initialize) (package-refresh-contents) (package-upgrade 'org))" +@end example + +This approach has the advantage of isolating the upgrade process from +a running Emacs session@comma{} ensuring that version conflicts cannot +arise. + +@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://git.savannah.gnu.org/git/emacs/org-mode.git +$ git clone https://https.git.savannah.nongnu.org/git/org-mode.git +$ # alternatively@comma{} you can use mirror +$ # git clone https://git.sr.ht/~bzg/org-mode $ cd org-mode/ $ make autoloads @end example -Note that in this case, @samp{make autoloads} is mandatory: it defines +Note that in this case@comma{} @samp{make autoloads} is mandatory: it defines Org's version in @samp{org-version.el} and Org's autoloads in @samp{org-loaddefs.el}. @@ -663,25 +684,26 @@ Make sure you set the load path correctly in your Emacs init file: (add-to-list 'load-path "~/src/org-mode/lisp") @end lisp -You can also compile with @samp{make}, generate the documentation with -@samp{make doc}, create a local configuration with @samp{make config} and +You can also compile with @samp{make}@comma{} generate the documentation with +@samp{make doc}@comma{} create a local configuration with @samp{make config}@comma{} 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 +For more detailed explanations on Org's build system@comma{} please check the Org Build System page on @uref{https://orgmode.org/worg/dev/org-build-system.html, Worg}. @anchor{Installing Org's contributed packages} @subheading Installing Org's contributed packages -Org's repository used to contain @samp{contrib/} directory for add-ons -contributed by others. As of Org 9.5, the directory has been moved to -the dedicated org-contrib @uref{https://git.sr.ht/~bzg/org-contrib, repository}, which you can install +Org's repository used to contain the @samp{contrib/} directory for add-ons +contributed by others. As of Org 9.5@comma{} the directory has been moved to +the dedicated org-contrib @uref{https://git.sr.ht/~bzg/org-contrib, repository}@comma{} which you can install separately as a @uref{https://elpa.nongnu.org/nongnu/org-contrib.html, package} from NonGNU ELPA@. -There are enough valuable packages maintained outside of the Org repository. -Worg has a list of @uref{https://orgmode.org/worg/org-contrib/index.html, org-contrib and external packages}, certainly it is not -exhaustive. +There are many valuable packages maintained outside the Org +repository. Worg has a list of +@uref{https://orgmode.org/worg/org-contrib/index.html, org-contrib and +external packages}; it is certainly not exhaustive. @node Activation @section Activation @@ -693,8 +715,8 @@ exhaustive. @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)}.}. +in Emacs@footnote{ If you do not use Font Lock globally@comma{} turn it on in an +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 @@ -703,11 +725,11 @@ 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}, +For a better experience@comma{} the three Org commands @code{org-store-link}@comma{} @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, +Emacs@comma{} not just in Org buffers. To that effect@comma{} you need to bind them +to globally available keys@comma{} like the ones reserved for users (see +@ref{Key Binding Conventions,,,elisp,}). Here are suggested bindings; please modify the keys to your own liking in your @ref{Init File,personal init file,,emacs,}. @lisp @@ -718,23 +740,22 @@ please modify the keys to your own liking in your @ref{Init File,personal init f @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 +Org mode in a file that does not have the extension @samp{.org}@comma{} 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 +make use of this@comma{} you need to have Transient Mark mode turned on@comma{} +which is the default. If you do not like it@comma{} you can create an active +region by using the mouse to select a region@comma{} or pressing @kbd{C-@key{SPC}} twice before moving point. @node Feedback @@ -750,54 +771,52 @@ region by using the mouse to select a region, or pressing @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 +If you find problems with Org@comma{} or if you have questions@comma{} remarks@comma{} or +ideas about it@comma{} please send an email to the Org mailing list @email{mailto: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 +page}. If you are not a member of the mailing list@comma{} your mail will +be passed to the list after a moderator approves 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. Please allow up to one month for the response and followup if +list. Please allow up to one month for a response and follow up if no response is received on the bug report. @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 +For bug reports@comma{} please first try to reproduce the bug with the latest +version of Org available---if you are running an outdated version@comma{} 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 +persists@comma{} prepare a report and provide as much information as +possible@comma{} including the version information of Emacs (@kbd{M-x emacs-version}) and Org (@kbd{M-x org-version})@comma{} 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 @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 +only need to add your description. If you are not sending the email +from within Emacs@comma{} 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 +Org mode setup. Before reporting a bug@comma{} it is very helpful to start +Emacs with minimal customizations and to 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 +However@comma{} if you are using Org mode as distributed with Emacs@comma{} 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. @@ -814,8 +833,8 @@ shown below. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp")) @end lisp -If you are using Org mode version from Git repository, you can start -minimal session using make. +If you are using the Org mode version from the Git repository@comma{} you can +start a minimal session using @samp{make}. @example # Bare Emacs @@ -824,10 +843,9 @@ make repro make repro REPRO_ARGS="-l /path/to/minimal/config.el /tmp/bug.org" @end example - -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: +If an error occurs@comma{} a ``backtrace'' can be very useful---see below for +instructions on how to create one. Often a small example file helps@comma{} +along with clear information about: @enumerate @item @@ -844,8 +862,8 @@ What happened instead? @cindex slowdown @cindex laggy @cindex not responsive -If you experience degraded performance, you can record a ``profile'' and -share it on the Org mailing list. See below for the instructions how +If you experience degraded performance@comma{} you can record a ``profile'' and +share it on the Org mailing list. See below for instructions on how to record a useful profile. Thank you for helping to improve this program. @@ -855,8 +873,8 @@ Thank you for helping to improve this program. @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 +understand@comma{} you may have hit a bug. The best way to report this is by +providing@comma{} in addition to what was mentioned above@comma{} 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: @@ -864,33 +882,31 @@ error occurred. Here is how to produce a useful backtrace: @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 +uncompiled code. To do this@comma{} use @example C-u M-x org-reload @end example - @noindent -or, from the menu: Org @arrow{} Refresh/Reload @arrow{} Reload Org uncompiled. +or@comma{} from the menu: Org @arrow{} Refresh/Reload @arrow{} Reload Org uncompiled. @item -Then, activate the debugger: +Then@comma{} activate the debugger: @example M-x toggle-debug-on-error @end example - @noindent -or, from the menu: Options @arrow{} Enter Debugger on Error. +or@comma{} 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 +When you hit the error@comma{} 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 @@ -898,14 +914,14 @@ screen. Save this buffer to a file---for example using @kbd{C-x C-w}---and atta @subheading How to profile Org performance @cindex profiler -Sometimes, Org is becoming slow for no apparent reason. Such slowdown +Sometimes@comma{} Org becomes slow for no apparent reason. Such slowdown is often caused by interaction between third-party packages and Org -mode. However, identifying the root cause is not always straightforward. +mode. However@comma{} identifying the root cause is not always straightforward. -Emacs is able to record performance statistics, which can then be used -to find out which functions are taking most of the time to execute. -To record the statistics, one can use so-called profiler. To use the -Emacs profiler, we recommend the following steps: +Emacs is able to record performance statistics@comma{} which can then be used +to find out which functions are taking the most time to execute. To +record the statistics@comma{} one can use a profiler. To use the Emacs +profiler@comma{} we recommend the following steps: @enumerate @item @@ -923,7 +939,7 @@ M-x profiler-start cpu @end example @item -Use Emacs as usual, performing the actions that are deemed slow. +Use Emacs as usual@comma{} performing the actions that are deemed slow. @item Display and examine the recorded performance statistics: @@ -932,38 +948,36 @@ Display and examine the recorded performance statistics: M-x profiler-report @end example - This command will display a summary of the commands and functions that have been executed between @code{profiler-start} and -@code{profiler-report} invocations, with command taking most of the time -displayed on top. +@code{profiler-report} invocations@comma{} with the command taking the most +time displayed on top. -@samp{} key can be used to fold and unfold lines in the profiler +The @samp{} key can be used to fold and unfold lines in the profiler buffer. The child items revealed upon unfolding are the functions and commands called by the unfolded parent. -The root causes are often buried deep inside sub-children items in +The root causes are often buried deep inside child items in the profiler. You can press @samp{B} (@code{profiler-report-render-reversed-calltree}) -to quickly reveal the actual function/command that takes most of -the time to run. +to quickly reveal the actual function/command that takes the most +time to run. Pressing @samp{C} @code{profiler-report-render-calltree} will recover the original view. @item -If you need further help, you can share the statistics data. +If you need further help@comma{} you can share the statistics data. -Just save the data by issuing +To save the data@comma{} issue @example M-x profiler-report-write-profile /path/to/profile-file-to-be-saved @end example - -Then, you can attached the saved file to your email to the Org -mailing list, alongside with details about what you did to trigger -the slowdown. +Then@comma{} you can attach the saved file to your email to the Org +mailing list@comma{} along with details about what you did to trigger the +slowdown. Note that the saved statistics will only contain the function names and how long their execution takes. No private data will be @@ -974,46 +988,42 @@ recorded. @section Typesetting Conventions Used in this Manual @anchor{TODO keywords tags properties etc} -@subheading TODO keywords, tags, properties, etc. +@subheading TODO keywords@comma{} tags@comma{} properties@comma{} etc. -Org uses various syntactical elements: TODO keywords, tags, property -names, keywords, blocks, etc. In this manual we use the following +Org uses various syntactic elements: TODO keywords@comma{} tags@comma{} property +names@comma{} keywords@comma{} blocks@comma{} 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 +@item @samp{TODO}@comma{} @samp{WAITING} +TODO keywords are written with all capitals@comma{} even if they are user-defined. -@item @samp{boss} -@itemx @samp{ARCHIVE} +@item @samp{boss}@comma{} @samp{ARCHIVE} Tags are case-sensitive. User-defined tags are usually written in lowercase; built-in tags with special meaning are written as they -should appear in the document, usually with all capitals. +should appear in the document@comma{} usually with all capitals. -@item @samp{Release} -@itemx @samp{PRIORITY} +@item @samp{Release}@comma{} @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} +@item @samp{TITLE}@comma{} @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. +readability@comma{} 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 +accessing functionality. Org mode often uses the same key for +different functions@comma{} depending on context. The command that is bound +to such keys has a generic name@comma{} like @code{org-metaright}. In the manual@comma{} +we will@comma{} wherever possible@comma{} give the function that is internally +called by the generic command. For example@comma{} in the chapter on +document structure@comma{} @kbd{M-@key{RIGHT}} will be listed to call +@code{org-do-demote}@comma{} while in the chapter on tables@comma{} it will be listed to call @code{org-table-move-column-right}. @node Document Structure @@ -1022,13 +1032,13 @@ call @code{org-table-move-column-right}. @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 +a hierarchical structure@comma{} which@comma{} at least for me@comma{} 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 +is achieved by folding@comma{} i.e.@comma{} 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. +the show and hide functionality into a single command@comma{} @code{org-cycle}@comma{} +which is bound to the @kbd{@key{TAB}} key. @menu * Headlines:: How to typeset Org tree headlines. @@ -1051,21 +1061,21 @@ the entire show and hide functionalities into a single command, @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}, +start on the left margin@footnote{See the variables @code{org-special-ctrl-a/e}@comma{} @code{org-special-ctrl-k}@comma{} 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 +@kbd{C-a}@comma{} @kbd{C-e}@comma{} 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 +* First (top) level headline ** Second level *** Third level some text *** Third level more text -* Another top level headline +* Another first (top) level headline @end example @vindex org-footnote-section @@ -1073,17 +1083,17 @@ 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 an Org Indent minor mode. See @ref{Clean View} for more information. +that has whitespace followed by a single star as headline markers. +This can be achieved using the 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}. +Headlines are not numbered. However@comma{} you may want to dynamically +number some@comma{} or all@comma{} 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 +is hidden when the subtree is folded. However@comma{} if you leave at least +two empty lines@comma{} one empty line remains visible after folding the +subtree@comma{} in order to structure the collapsed view. See the variable @code{org-cycle-separator-lines} to modify this behavior. @node Visibility Cycling @@ -1111,8 +1121,8 @@ subtree, in order to structure the collapsed view. See the variable @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. +Org uses just two commands@comma{} bound to @kbd{@key{TAB}} and +@kbd{S-@key{TAB}}@comma{} to change the visibility in the buffer. @table @asis @item @kbd{@key{TAB}} (@code{org-cycle}) @@ -1121,16 +1131,15 @@ Org uses just two commands, bound to @kbd{@key{TAB}} and @emph{Subtree cycling}: Rotate current subtree among the states @example -,-> FOLDED -> CHILDREN -> SUBTREE --. +@comma{}-> FOLDED -> CHILDREN -> SUBTREE --. '-----------------------------------' @end example @vindex org-cycle-emulate-tab -Point must be on a headline for this to work@footnote{ See, however, the +Point must be on a headline for this to work@footnote{ See@comma{} however@comma{} the option @code{org-cycle-emulate-tab}.}. -@item @kbd{S-@key{TAB}} (@code{org-global-cycle}) -@itemx @kbd{C-u @key{TAB}} +@item @kbd{S-@key{TAB}} (@code{org-global-cycle})@comma{} @kbd{C-u @key{TAB}} @cindex global visibility states @cindex global cycling @cindex overview, global visibility state @@ -1142,20 +1151,20 @@ option @code{org-cycle-emulate-tab}.}. @emph{Global cycling}: Rotate the entire buffer among the states @example -,-> OVERVIEW -> CONTENTS -> SHOW ALL --. +@comma{}-> 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}@comma{} view contents only up to headlines of level @var{N}. -Note that inside tables (see @ref{Tables}), @kbd{S-@key{TAB}} jumps to the +Note that inside tables (see @ref{Tables})@comma{} @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 +the very beginning of the buffer@comma{} but not on a headline@comma{} 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-cycle-set-startup-visibility}) @@ -1164,47 +1173,49 @@ the very beginning of the buffer, but not on a headline, and @findex org-cycle-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{org-show-all}) +@item @kbd{C-u C-u C-u @key{TAB}} (@code{org-fold-show-all}) @cindex show all, command @kindex C-u C-u C-u TAB @findex org-show-all -Show all, including drawers. +@findex org-fold-show-all +Show all@comma{} 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 +Reveal context around point@comma{} showing the current entry@comma{} the +following heading@comma{} 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 +@ref{Sparse Trees}) or an agenda command (see @ref{Agenda Commands}). With a prefix argument@comma{} show@comma{} on each level@comma{} all sibling +headings. With a double prefix argument@comma{} also show the entire subtree of the parent. @item @kbd{C-c C-k} (@code{org-show-branches}) @cindex show branches, command @kindex C-c C-k @findex org-show-branches -Expose all the headings of the subtree, but not their bodies. +Expose all the headings of the subtree@comma{} but not their bodies. -@item @kbd{C-c @key{TAB}} (@code{org-show-children}) +@item @kbd{C-c @key{TAB}} (@code{org-fold-show-children}) @cindex show children, command @kindex C-c TAB @findex org-show-children +@findex org-fold-show-children Expose all direct children of the subtree. With a numeric prefix -argument @var{N}, expose all children down to level +argument @var{N}@comma{} 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 +Show the current subtree in an indirect buffer@footnote{The indirect buffer contains the entire buffer@comma{} 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 +original buffer@comma{} but without affecting visibility in that buffer. For +more information about indirect buffers@comma{} see @ref{Indirect Buffers,GNU Emacs Manual,,emacs,}.}. With +a numeric prefix argument @var{N}@comma{} go up to level @var{N} +and then take that tree. If @var{N} is negative@comma{} then go up +that many levels. With a @kbd{C-u} prefix@comma{} do not remove the previously used indirect buffer. @item @kbd{C-c C-x v} (@code{org-copy-visible}) @@ -1217,12 +1228,12 @@ Copy the @emph{visible} text in the region into the kill ring. @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 +When Emacs first visits an Org file@comma{} the global state is set to +@code{showeverything}@comma{} i.e.@comma{} all file content is visible@footnote{ When +@code{org-agenda-inhibit-startup} is non-@code{nil}@comma{} 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 +variable @code{org-startup-folded}@comma{} or on a per-file basis by adding one of the following lines anywhere in the buffer: @cindex @samp{STARTUP}, keyword @@ -1238,14 +1249,14 @@ the following lines anywhere in the buffer: @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}. +Furthermore@comma{} 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}@comma{} @samp{children}@comma{} @samp{content}@comma{} and @samp{all}. @table @asis @item @kbd{C-u C-u @key{TAB}} (@code{org-cycle-set-startup-visibility}) @kindex C-u C-u TAB @findex org-cycle-set-startup-visibility -Switch back to the startup visibility of the buffer, i.e., whatever +Switch back to the startup visibility of the buffer@comma{} i.e.@comma{} whatever is requested by startup options and @samp{VISIBILITY} properties in individual entries. @end table @@ -1258,14 +1269,14 @@ individual entries. @vindex org-fold-catch-invisible-edits @vindex org-fold-catch-invisible-edits-commands 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. -By default, Org prevents such edits for a limited set of user +and be confused about what has been edited and how to undo the mistake. +By default@comma{} Org prevents such edits for a limited set of user commands. Users can control which commands are affected by customizing @code{org-fold-catch-invisible-edits-commands}. The strategy used to decide if a given edit is dangerous is controlled by @code{org-fold-catch-invisible-edits}. See the docstring of this option -on the available strategies. Set the option to @code{nil} to disable +for the available strategies. Set the option to @code{nil} to disable catching invisible edits completely. @node Motion @@ -1308,7 +1319,7 @@ Backward to higher level heading. @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, +visibility. Shows the document structure in a temporary buffer@comma{} where you can use the following keys to find your destination: @multitable @columnfractions 0.3 0.7 @@ -1323,7 +1334,7 @@ where you can use the following keys to find your destination: @end multitable @noindent -The following keys work if you turn off @code{org-goto-auto-isearch} +The following keys work if you turn off @code{org-goto-auto-isearch}. @multitable @columnfractions 0.3 0.7 @item @kbd{n} / @kbd{p} @@ -1362,21 +1373,21 @@ See also the variable @code{org-goto-interface}. @kindex M-RET @findex org-meta-return @vindex org-M-RET-may-split-line -Insert a new heading, item or row. +Insert a new heading@comma{} item@comma{} 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 +If the command is used at the @emph{beginning} of a line@comma{} and if there is +a heading or a plain list item (see @ref{Plain Lists}) at point@comma{} 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. +beginning of a regular line of text@comma{} turn that line into a heading. -When this command is used in the middle of a line, the line is split +When this command is used in the middle of a line@comma{} 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 +do not want the line to be split@comma{} 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, +inserts a new heading at the end of the current subtree@comma{} thus +preserving its contents. With a double @kbd{C-u C-u} prefix@comma{} the new heading is created at the end of the parent subtree instead. @item @kbd{C-@key{RET}} (@code{org-insert-heading-respect-content}) @@ -1395,20 +1406,19 @@ the variable @code{org-treat-insert-todo-heading-as-state-change}. @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 +@kbd{C-@key{RET}}@comma{} 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 +In a new entry with no text yet@comma{} 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 +@kbd{@key{TAB}} makes it a parent@comma{} and so on@comma{} all the way to top +level. Yet another @kbd{@key{TAB}}@comma{} 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}) +@item @kbd{M-@key{LEFT}} (@code{org-do-promote})@comma{} @kbd{M-@key{RIGHT}} (@code{org-do-demote}) @kindex M-LEFT @findex org-do-promote @kindex M-RIGHT @@ -1418,11 +1428,10 @@ 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 +When there is an active region---i.e.@comma{} 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 +To select a region of headlines@comma{} it is best to set mark at the beginning of the first +headline@comma{} and point at the line just after the last headline to change. @item @kbd{M-S-@key{LEFT}} (@code{org-promote-subtree}) @@ -1438,29 +1447,29 @@ 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. +Move subtree up@comma{} i.e.@comma{} 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. +Move subtree down@comma{} i.e.@comma{} 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 +Mark the subtree at point. Hitting it 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. +Kill subtree@comma{} i.e.@comma{} remove it from the buffer but save in kill ring. +With a numeric prefix argument N@comma{} 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 +Copy subtree to kill ring. With a numeric prefix argument N@comma{} copy the N sequential subtrees. @item @kbd{C-c C-x C-y} (@code{org-paste-subtree}) @@ -1468,10 +1477,10 @@ the N sequential subtrees. @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, +The yank level can also be specified with a numeric prefix argument@comma{} or by yanking after a headline marker like @samp{****}. With -@kbd{C-u} prefix, force inserting as a sibling. With -@kbd{C-u C-u} prefix argument, force inserting as a child. +@kbd{C-u} prefix@comma{} force inserting as a sibling. With +@kbd{C-u C-u} prefix argument@comma{} force inserting as a child. @item @kbd{C-y} (@code{org-yank}) @kindex C-y @@ -1479,23 +1488,23 @@ or by yanking after a headline marker like @samp{****}. With @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 +@code{org-yank-folded-subtrees}@comma{} Org's internal @code{yank} command pastes +subtrees folded and in a clever way@comma{} using the same command as +@kbd{C-c C-x C-y}. With the default settings@comma{} no level +adjustment takes place@comma{} 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. +this command forces a normal @code{yank} to be executed@comma{} 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@comma{} it yanks previous kill +items plainly@comma{} 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 +prompted for the number of copies to make@comma{} and you can also specify +whether any timestamps in the entry should be shifted. This can be +useful@comma{} for example@comma{} to create a number of tasks related to a series +of lectures to prepare. For more details@comma{} see the docstring of the command @code{org-clone-subtree-with-time-shift}. @item @kbd{C-c C-w} (@code{org-refile}) @@ -1506,16 +1515,16 @@ 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 +Sort same-level entries. When there is an active region@comma{} all +entries in the region are sorted. Otherwise@comma{} 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 +method@comma{} which can be alphabetically@comma{} numerically@comma{} by time---first +timestamp with active preferred@comma{} creation time@comma{} scheduled time@comma{} +deadline time---by priority@comma{} 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. +a @kbd{C-u} prefix@comma{} sorting is case-sensitive. @item @kbd{C-x n s} (@code{org-narrow-to-subtree}) @kindex C-x n s @@ -1537,14 +1546,14 @@ Widen buffer to remove narrowing. @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, +a normal line by removing the stars. If there is an active region@comma{} 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 +the region was an item@comma{} turn only the item lines into headlines. +Finally@comma{} if the first line is a headline@comma{} 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 +Note that when point is inside a table (see @ref{Tables})@comma{} the Meta-Cursor keys have different functionality. @node Sparse Trees @@ -1555,17 +1564,17 @@ keys have different functionality. @cindex folding, sparse trees @cindex occur, command +@vindex org-fold-show-context-detail @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 +trees} for selected information in an outline tree@comma{} so that the entire +document is folded as much as possible@comma{} 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 +also the variable @code{org-fold-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: +Org mode contains several commands creating such trees@comma{} all of which can be accessed through a dispatcher: @table @asis @item @kbd{C-c /} (@code{org-sparse-tree}) @@ -1580,15 +1589,15 @@ command. @findex org-occur @vindex org-remove-highlights-with-change Prompts for a regexp (see @ref{Regular Expressions}) 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 +sparse tree with all matches. If the match is in a headline@comma{} the +headline is made visible. If the match is in the body of an entry@comma{} +the headline and body are made visible. In order to provide minimal +context@comma{} also the full hierarchy of headlines above the match is +shown@comma{} 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 +changed by an editing command@comma{} 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 +@kbd{C-u} prefix argument@comma{} previous highlights are kept@comma{} so several calls to this command can be stacked. @item @kbd{M-g n} or @kbd{M-g M-n} (@code{next-error}) @@ -1605,7 +1614,7 @@ 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 +For frequently used sparse trees for specific search strings@comma{} 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}). @@ -1620,14 +1629,14 @@ For example: 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. +The other sparse tree commands select headings based on TODO keywords@comma{} +tags@comma{} 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 +To print a sparse tree@comma{} you can use the Emacs command +@code{ps-print-buffer-with-faces}@comma{} 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. @@ -1640,20 +1649,20 @@ file. @cindex lists, ordered @cindex ordered lists -Within an entry of the outline tree, hand-formatted lists can provide +Within an entry of the outline tree@comma{} 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 +checkboxes (see @ref{Checkboxes}). Org supports editing such lists@comma{} and every exporter (see @ref{Exporting}) can parse and format them. -Org knows ordered lists, unordered lists, and description lists. +Org knows ordered lists@comma{} unordered lists@comma{} 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 +@emph{Unordered} list items start with @samp{-}@comma{} @samp{+}@comma{} or @samp{*}@footnote{When using @samp{*} as a bullet@comma{} lines must be indented so that they +are not interpreted as headlines. Also@comma{} when you are hiding leading +stars to get a clean outline view@comma{} 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 +though @samp{*} is supported@comma{} it may be better to not use it for plain list items.} as bullets. @item @@ -1661,33 +1670,33 @@ items.} as bullets. @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 +configuring @code{org-plain-list-ordered-item-terminator}.}@comma{} such as @samp{1.} +or @samp{1)}@footnote{You can also get @samp{a.}@comma{} @samp{A.}@comma{} @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, +text@comma{} those are limited to one character only. Beyond that limit@comma{} 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 +value---e.g.@comma{} 20---start the text of the item with @samp{[@@20]}@footnote{If there's a checkbox in the item@comma{} the cookie must be put +@emph{before} the checkbox. If you have activated alphabetical lists@comma{} 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 +@emph{Description} list items are unordered list items@comma{} and contain the separator @samp{::} to distinguish the description @emph{term} from the -description. +description text. @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.}, +first line. In particular@comma{} if an ordered list reaches number @samp{10.}@comma{} 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. +numbers in the list. An item ends before the next line that has an +indentation less than or equal to 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: +A list ends whenever every item has ended@comma{} which means before any line +with an indentation less than or equal to that of the top-level items. +It also ends before two blank lines. In that case@comma{} all items are +closed. Here is an example: @example * Lord of the Rings @@ -1700,32 +1709,32 @@ My favorite scenes are (in this order) - on DVD only He makes a really funny face when it happens. 8. [@@8] -But in the end, no individual scenes matter but the film as a whole. +But in the end@comma{} 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 +- Sean Astin :: He plays Sam@comma{} 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 +deal with them correctly@comma{} 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 +lists@comma{} 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 +used for the current list-level---improves readability@comma{} customize the variable @code{org-list-demote-modify-bullet}. To get a greater difference -of indentation between items and theirs sub-items, customize +of indentation between items and their sub-items@comma{} 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} +of these actions get in your way@comma{} configure @code{org-list-automatic-rules} to disable them individually. @table @asis @@ -1735,13 +1744,13 @@ to disable them individually. @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 +only if point is on a plain list item. For more details@comma{} 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 +to @code{integrate}@comma{} 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, +the bullet/number. Items are always subordinate to real headlines@comma{} however; the hierarchies remain completely separated. In a new item -with no text yet, the first @kbd{@key{TAB}} demotes the item to +with no text yet@comma{} 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. @@ -1751,109 +1760,103 @@ to its initial position. @findex org-insert-item @findex org-meta-return @vindex org-M-RET-may-split-line -Insert new item at current level. With a prefix argument, force a +Insert new item at current level. With a prefix argument@comma{} 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 +in the middle of an item@comma{} that item is @emph{split} in two@comma{} 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 +be split@comma{} customize the variable @code{org-M-RET-may-split-line}.}. If +this command is executed @emph{before the item's body}@comma{} 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}} +@item @kbd{S-@key{UP}}@comma{} @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 +Jump to the previous/next item in the current list@comma{} 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 +items that way@comma{} you may customize @code{org-list-use-circular-motion}.}. +If not@comma{} 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}} +@item @kbd{M-@key{UP}}@comma{} @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 +Move the item including sub-items up/down@footnote{ See +@code{org-list-use-circular-motion} for a cyclic behavior.}@comma{} i.e.@comma{} swap with previous/next item of same indentation. If the list is -ordered, renumbering is automatic. +ordered@comma{} renumbering is automatic. -@item @kbd{M-@key{LEFT}} -@itemx @kbd{M-@key{RIGHT}} +@item @kbd{M-@key{LEFT}}@comma{} @kbd{M-@key{RIGHT}} @kindex M-LEFT @kindex M-RIGHT -Decrease/increase the indentation of an item, leaving children +Decrease/increase the indentation of an item@comma{} leaving children alone. -@item @kbd{M-S-@key{LEFT}} -@itemx @kbd{M-S-@key{RIGHT}} +@item @kbd{M-S-@key{LEFT}}@comma{} @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 +Decrease/increase the indentation of the item@comma{} including sub-items. +Initially@comma{} the item tree is selected based on current indentation. +When these commands are executed several times in direct succession@comma{} +the initially selected region is used@comma{} even if the new indentation +would imply a different hierarchy. To use the new hierarchy@comma{} break the command chain by moving point. -As a special case, using this command on the very first item of +As a special case@comma{} 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 +If there is a checkbox (see @ref{Checkboxes}) in the item line@comma{} toggle +the state of the checkbox. In any case@comma{} 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 +bullets (@samp{-}@comma{} @samp{+}@comma{} @samp{*}@comma{} @samp{1.}@comma{} @samp{1)}) or a subset of them@comma{} depending +on @code{org-plain-list-ordered-item-terminator}@comma{} the type of list@comma{} and +its indentation. With a numeric prefix argument N@comma{} 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 +this@comma{} all lines are converted to list items. With a prefix +argument@comma{} the selected text is changed into a single item. If the +first line already was a list item@comma{} any item marker is removed from +the list. Finally@comma{} even without an active region@comma{} 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 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. +Checkboxes (see @ref{Checkboxes}) become @samp{TODO} or @samp{DONE} keywords when unchecked or checked@comma{} respectively. -@item @kbd{S-@key{LEFT}} -@itemx @kbd{S-@key{RIGHT}} +@item @kbd{S-@key{LEFT}}@comma{} @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 +This command also cycles bullet styles when point is on the bullet +or anywhere in an item line@comma{} with 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. +Sort the plain list. Prompt for the sorting method: numerically@comma{} +alphabetically@comma{} by time@comma{} or by custom function. @end table @node Drawers @@ -1862,8 +1865,8 @@ alphabetically, by time, or by custom function. @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}. +Sometimes you want to keep information associated with an entry@comma{} but +you do not normally want to see it. For this@comma{} Org mode has @emph{drawers}. They can contain anything but a headline and another drawer. Drawers look like this: @@ -1879,10 +1882,10 @@ After the drawer. @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 non-interactive function -@code{org-insert-property-drawer}, which creates a @samp{PROPERTIES} drawer +@code{org-insert-drawer}@comma{} which is bound to @kbd{C-c C-x d}. With an +active region@comma{} this command puts the region inside the drawer. With a +prefix argument@comma{} this command calls non-interactive function +@code{org-insert-property-drawer}@comma{} 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. @@ -1892,13 +1895,13 @@ Completion over drawer keywords is also possible using 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 +shows the entry@comma{} but keeps the drawer collapsed to a single line. In +order to look inside the drawer@comma{} 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 +a @samp{LOGBOOK} drawer. If you want to store a quick note there@comma{} +similarly to state changes@comma{} use @table @asis @item @kbd{C-c C-z} @@ -1912,7 +1915,7 @@ Add a time-stamped note to the @samp{LOGBOOK} drawer. @vindex org-hide-block-startup @cindex blocks, folding -Org mode uses @samp{#+BEGIN} @dots{} @samp{#+END} blocks for various purposes from +Org mode uses @samp{#+BEGIN} @dots{} @samp{#+END} blocks for various purposes@comma{} 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} @@ -1956,8 +1959,8 @@ Calculator Manual,,calc,}). 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 +table field@comma{} use @samp{\vert} or@comma{} inside a word @samp{abc\vert@{@}def}.}. +Moreover@comma{} 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: @@ -1969,13 +1972,13 @@ header lines. A table might look like this: @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}}@comma{} @kbd{@key{RET}}@comma{} 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 +re-align to span the whole table width. So@comma{} to create the above +table@comma{} you would only type @example |Name|Phone|Age| @@ -1987,13 +1990,13 @@ 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{@key{DEL}}, -@kbd{Backspace}, and all character keys in a special way, so that -inserting and deleting avoids shifting other fields. Also, when +When typing text into a field@comma{} Org treats @kbd{@key{DEL}}@comma{} +@kbd{Backspace}@comma{} and all character keys in a special way@comma{} so that +inserting and deleting avoid shifting other fields. Also@comma{} 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 +@kbd{@key{TAB}}@comma{} @kbd{S-@key{TAB}} or @kbd{@key{RET}}@comma{} the field is automatically made blank. If this behavior is too unpredictable for -you, configure the option @code{org-table-auto-blank-field}. +you@comma{} configure the option @code{org-table-auto-blank-field}. @anchor{Creation and conversion} @subheading Creation and conversion @@ -2003,18 +2006,18 @@ you, configure the option @code{org-table-auto-blank-field}. @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 +one @kbd{@key{TAB}} character@comma{} the function assumes that the material +is tab separated. If every line contains a comma@comma{} comma-separated +values (CSV) are assumed. If not@comma{} 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 +separator: @kbd{C-u} forces CSV@comma{} @kbd{C-u C-u} forces +@kbd{@key{TAB}}@comma{} @kbd{C-u C-u C-u} prompts for a regular +expression to match the separator@comma{} and a numeric argument +N indicates that at least N consecutive spaces@comma{} 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}}. +If there is no active region@comma{} this command creates an empty Org +table. But it is easier just to start typing@comma{} 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} @@ -2029,7 +2032,7 @@ 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 +Re-align the table@comma{} move to the next field. Creates a new row if necessary. @item @kbd{M-x org-table-blank-field} @@ -2039,25 +2042,25 @@ Blank the current table field or active region. @item @kbd{S-@key{TAB}} (@code{org-table-previous-field}) @kindex S-TAB @findex org-table-previous-field -Re-align, move to previous field. +Re-align@comma{} 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. +necessary. At the beginning or end of a line@comma{} @kbd{@key{RET}} still +inserts a new line@comma{} 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 +Move to beginning of the current table field@comma{} or onto 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. +Move to end of the current table field@comma{} or onto the next field. @end table @anchor{Column and row editing} @@ -2082,7 +2085,7 @@ 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 +Insert a new column at point position. Move the current column and all cells to the right of this column to the right. @item @kbd{M-@key{UP}} (@code{org-table-move-row-up}) @@ -2123,35 +2126,35 @@ 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 +Insert a new row above the current row. With a prefix argument@comma{} 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, +Insert a horizontal line below current row. With a prefix argument@comma{} 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 +Insert a horizontal line below current row@comma{} 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 +the column to be used for sorting@comma{} and the range of lines is the +range between the nearest horizontal separator lines@comma{} or the entire +table. If point is before the first column@comma{} you are prompted for +the sorting column. If there is an active region@comma{} the mark +specifies the first line and the sorting column@comma{} 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 +prompts for the sorting type@comma{} alphabetically@comma{} numerically@comma{} 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. +a prefix argument@comma{} alphabetic sorting is case-sensitive. @end table @anchor{Regions} @@ -2163,13 +2166,13 @@ a prefix argument, alphabetic sorting is case-sensitive. @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 +no active region@comma{} 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 +Copy a rectangular region from a table to a special clipboard@comma{} 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}) @@ -2177,19 +2180,19 @@ blank all fields in the rectangle. So this is the ``cut'' operation. @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 +the rectangle does not fit into the present table@comma{} 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 +line below. If there is an active region@comma{} and both point and mark +are in the same column@comma{} 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. +region@comma{} but you specify a prefix argument@comma{} the current field is made +blank@comma{} and the content is appended to the field above. @end table @anchor{Calculations} @@ -2202,7 +2205,7 @@ blank, and the content is appended to the field above. @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 +Sum the numbers in the current column@comma{} 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}. @@ -2210,13 +2213,13 @@ be inserted with @kbd{C-y}. @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 +When the current field is empty@comma{} copy from the first non-empty field above. +When it is not empty@comma{} copy the current field down to the 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 +Depending on the variable @code{org-table-copy-increment}@comma{} integer and +time stamp field values@comma{} as well as fields prefixed or suffixed with +a whole number@comma{} can be incremented during copy. Also@comma{} a @code{0} prefix argument temporarily disables the increment. This key is also used by shift-selection and related modes (see @@ -2232,41 +2235,41 @@ This key is also used by shift-selection and related modes (see @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 +When called with a @kbd{C-u} prefix@comma{} just make the full field +visible@comma{} so that it can be edited in place. When called with two +@kbd{C-u} prefixes@comma{} 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 +automatically when point leaves the table@comma{} 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 +Import a file as a table. The table should be TAB- or +whitespace-separated. Use@comma{} for example@comma{} to import a spreadsheet +table or data from a database@comma{} 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@comma{} 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 +buffer@comma{} 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 +Export the table@comma{} by default as a TAB-separated file. Use for data +exchange with@comma{} for example@comma{} 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. +the same as the format used by Orgtbl radio tables@comma{} see @ref{Translator functions}@comma{} for a detailed description. @item @kbd{M-x org-table-header-line-mode} @findex org-table-header-line-mode @@ -2292,11 +2295,11 @@ 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 +Editing a field may modify the alignment of the table. Moving +a contiguous row or column---i.e.@comma{} 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: +this behavior@comma{} set @code{org-table-automatic-realign} to @code{nil}. In any +case@comma{} you can always align manually a table: @table @asis @item @kbd{C-c C-c} (@code{org-table-align}) @@ -2315,10 +2318,10 @@ a per-file basis with: #+STARTUP: noalign @end example -Sometimes a single field or a few fields need to carry more text, +Sometimes a single field or a few fields need to carry more text@comma{} 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. +several columns or display them with a fixed width@comma{} regardless of +content@comma{} as shown in the following example. @example |---+---------------------+--------| |---+-------…+…| @@ -2329,7 +2332,7 @@ content, as shown in the following example. |---+---------------------+--------| |---+-------…+…| @end example -To set the width of a column, one field anywhere in the column may +To set the width of a column@comma{} one field anywhere in the column may contain just the string @samp{} where @var{N} specifies the width as a number of characters. You control displayed width of columns with the following tools: @@ -2340,11 +2343,11 @@ with the following tools: @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 +If a width cookie specifies a width W for the column@comma{} shrinking it +displays the first W visible characters only. Otherwise@comma{} the column is shrunk to a single character. -When called before the first column or after the last one, ask for +When called before the first column or after the last one@comma{} ask for a list of column ranges to operate on. @item @kbd{C-u C-c @key{TAB}} (@code{org-table-shrink}) @@ -2358,10 +2361,10 @@ Shrink all columns with a column width. Expand the others. 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 +To see the full text of a shrunk field@comma{} hold the mouse over it: +a tooltip window then shows the full contents of the field. +Alternatively@comma{} @kbd{C-h .} (@code{display-local-help}) reveals them@comma{} +too. For convenience@comma{} any change near the shrunk part of a column expands it. @vindex org-startup-shrink-all-tables @@ -2373,10 +2376,9 @@ also set this option on a per-file basis with: #+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{}, @samp{} or @samp{} in a similar fashion. You may also combine +columns to the right and of string-rich columns to the left@comma{} you can +use @samp{}@comma{} @samp{} or @samp{} in a similar fashion. You may also combine alignment and field width like this: @samp{}. Lines which only contain these formatting cookies are removed @@ -2387,15 +2389,14 @@ automatically upon exporting the document. @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 +When Org exports tables@comma{} it does so by default without vertical lines +because that is visually more satisfying in general. Occasionally@comma{} however@comma{} vertical lines can be useful to structure a table into groups +of columns@comma{} much like horizontal lines can do for groups of rows. In +order to specify column groups@comma{} 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 +@samp{<} to indicate that this column should start a group@comma{} @samp{>} to indicate +the end of a column@comma{} or @samp{<>} (no space between @samp{<} and @samp{>}) to make +a column a group of its own. Upon export@comma{} boundaries between column groups are marked with vertical lines. Here is an example: @example @@ -2425,20 +2426,20 @@ every vertical line you would like to have: @cindex minor mode for tables @findex orgtbl-mode -If you like the intuitive way the Org table editor works, you might +If you like the intuitive way the Org table editor works@comma{} 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 +mode with @kbd{M-x orgtbl-mode}. To turn it on by default@comma{} for +example in Message mode@comma{} 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 +Furthermore@comma{} with some special setup@comma{} it is possible to maintain +tables in arbitrary syntax with Orgtbl mode. For example@comma{} it is possible to construct @LaTeX{} tables with the underlying ease and power -of Orgtbl mode, including spreadsheet capabilities. For details, see +of Orgtbl mode@comma{} including spreadsheet capabilities. For details@comma{} see @ref{Tables in Arbitrary Syntax}. @node The Spreadsheet @@ -2450,13 +2451,13 @@ of Orgtbl mode, including spreadsheet capabilities. For details, see 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, +to derive fields from other fields. While fully featured@comma{} Org's +implementation is not identical to other spreadsheets. For example@comma{} 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 +to each relevant field. There is also a formula debugger@comma{} and a formula editor with features for highlighting fields in the table -corresponding to the references at point in the formula, moving these +corresponding to the references at point in the formula@comma{} moving these references by arrow keys. @menu @@ -2477,11 +2478,11 @@ references by arrow keys. @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. +To compute fields in the table from other fields@comma{} formulas must +reference other fields or ranges. In Org@comma{} fields can be referenced by +name@comma{} by absolute coordinates@comma{} and by relative coordinates. To find +out what the coordinates of a field are@comma{} press @kbd{C-c ?} in +that field@comma{} or press @kbd{C-c @}} to toggle the display of a grid. @anchor{Field references} @subsubheading Field references @@ -2489,10 +2490,10 @@ that field, or press @kbd{C-c @}} to toggle the display of a grid. @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 +in any other spreadsheet@comma{} you may reference fields with +a letter/number combination like @samp{B3}@comma{} meaning the second field in the +third row. However@comma{} Org prefers to use another@comma{} more general +representation that looks like this:@footnote{Org understands references typed by the user as @samp{B4}@comma{} 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}.} @@ -2501,32 +2502,31 @@ customize this behavior using the variable @@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 +Column specifications can be absolute like @samp{$1}@comma{} @samp{$2}@comma{} @dots{}@comma{} @samp{$N}@comma{} or +relative to the current column@comma{} i.e.@comma{} the column of the field which is +being computed@comma{} like @samp{$+1} or @samp{$-2}. @samp{$<} and @samp{$>} are immutable +references to the first and last column@comma{} respectively@comma{} 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 +separator lines@comma{} or ``hlines''. Like with columns@comma{} you can use absolute +row numbers @samp{@@1}@comma{} @samp{@@2}@comma{} @dots{}@comma{} @samp{@@N}@comma{} 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 +references to the first and last row in the table@comma{} respectively. You +may also specify the row relative to one of the hlines: @samp{@@I} refers to +the first hline@comma{} @samp{@@II} to the second@comma{} etc. @samp{@@-I} refers to the first +such line above the current line@comma{} @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@comma{} respectively@comma{} i.e.@comma{} +to the row/column for the field being computed. Also@comma{} if you omit +either the column or the row part of the reference@comma{} 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 +different fields@comma{} 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. @@ -2535,17 +2535,17 @@ Here are a few examples: @multitable @columnfractions 0.2 0.8 @item @samp{@@2$3} -@tab 2nd row, 3rd column (same as @samp{C2}) +@tab 2nd row@comma{} 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 +@tab current column@comma{} row 2 @item @samp{@@-1$-3} -@tab field one row up, three columns to the left +@tab field one row up@comma{} three columns to the left @item @samp{@@-I$2} -@tab field just under hline above current row, column 2 +@tab field just under hline above current row@comma{} column 2 @item @samp{@@>$5} -@tab field in the last row, in column 5 +@tab field in the last row@comma{} in column 5 @end multitable @anchor{Range references} @@ -2555,32 +2555,32 @@ Here are a few examples: @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 +the range. If both fields are in the current row@comma{} you may simply use +@samp{$2..$7}@comma{} but if at least one field is in a different row@comma{} you need to +use the general @samp{@@ROW$COLUMN} format at least for the first field@comma{} +i.e.@comma{} 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}) +@tab range@comma{} using column names (see @ref{Advanced features}) @item @samp{$<<<..$>>} -@tab start in third column, continue to the last but one +@tab start in third column@comma{} 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 +@tab 3 fields in the row above@comma{} starting from 2 columns on the left @item @samp{@@I..II} -@tab between first and second hline, short for @samp{@@I..@@II} +@tab between first and second hline@comma{} 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 +vector functions. Empty fields in ranges are normally suppressed@comma{} 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}. +with the mode switches @samp{E}@comma{} @samp{N} and examples@comma{} see @ref{Formula syntax for Calc}. @anchor{Field coordinates in formulas} @subsubheading Field coordinates in formulas @@ -2598,23 +2598,23 @@ 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{if(@@# % 2@comma{} $#@comma{} string(""))} +Insert column number on odd rows@comma{} set field to empty on even rows. -@item @samp{$2 = '(identity remote(FOO, @@@@#$1))} +@item @samp{$2 = '(identity remote(FOO@comma{} @@@@#$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$$#)} +@item @samp{@@3 = 2 * remote(FOO@comma{} @@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 +For the second and third examples@comma{} 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 +@var{FOO} is parsed for each field to be copied.} for a large number of rows. @anchor{Named references} @@ -2627,30 +2627,29 @@ number of rows. @cindex @samp{CONSTANTS}, keyword @vindex org-table-formula-constants -@samp{$name} is interpreted as the name of a column, parameter or constant. +@samp{$name} is interpreted as the name of a column@comma{} parameter or constant. Constants are defined globally through the variable -@code{org-table-formula-constants}, and locally---for the file---through +@code{org-table-formula-constants}@comma{} 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 +Also@comma{} 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 +@samp{$PROP_Xyz}@comma{} 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 +package@comma{} it will also be used to resolve constants@comma{} including natural +constants like @samp{$h} for Planck's constant@comma{} 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 +two different unit systems@comma{} @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 +special table lines. These are described below@comma{} see @ref{Advanced features}. All names must start with a letter@comma{} and further consist of letters and numbers. @anchor{Remote references} @@ -2661,28 +2660,27 @@ of letters and numbers. @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 +You may also reference constants@comma{} fields and ranges from a different +table@comma{} either in the current file or even in a different file. The syntax is @example -remote(NAME,REF) +remote(NAME@comma{}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 +an entry@comma{} even in a different file@comma{} 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}, +range reference as described above for example @samp{@@3$3} or @samp{$somename}@comma{} valid in the referenced table. @cindex table indirection -When @var{NAME} has the format @samp{@@ROW$COLUMN}, it is substituted +When @var{NAME} has the format @samp{@@ROW$COLUMN}@comma{} 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 +example @samp{remote($1@comma{} @@@@>$2)} @result{} @samp{remote(year_2013@comma{} @@@@>$1)}. The format +@samp{B3} is not supported because it cannot be distinguished from a plain table name or ID@. @node Formula syntax for Calc @@ -2693,9 +2691,9 @@ table name or ID@. 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 +lower precedence than @samp{*}@comma{} 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 +Your Lisp Programs,,calc,})@comma{} variable substitution takes place according to the rules described above. @cindex vectors, in table calculations @@ -2707,9 +2705,9 @@ like @code{vmean} and @code{vsum}. @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 +execution. By default@comma{} Org uses the standard Calc modes (precision +12@comma{} angular units degrees@comma{} fraction and symbolic modes off). The +display format@comma{} however@comma{} 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}. @@ -2717,26 +2715,26 @@ variable @code{org-calc-default-modes}. @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 +@item @samp{n3}@comma{} @samp{s3}@comma{} @samp{e2}@comma{} @samp{f4} +Normal@comma{} scientific@comma{} 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} +@item @samp{D}@comma{} @samp{R} Degree and radian angle modes of Calc. -@item @samp{F}, @samp{S} +@item @samp{F}@comma{} @samp{S} Fraction and symbolic modes of Calc. @item @samp{u} Units simplification mode of Calc. Calc is also a symbolic -calculator and is capable of working with values having a unit, +calculator and is capable of working with values having a unit@comma{} represented with numerals followed by a unit string in Org table cells. This mode instructs Calc to simplify the units in the computed expression before returning the result. -@item @samp{T}, @samp{t}, @samp{U} -Duration computations in Calc or Lisp, @ref{Durations and time values}. +@item @samp{T}@comma{} @samp{t}@comma{} @samp{U} +Duration computations in Calc or Lisp@comma{} @ref{Durations and time values}. @item @samp{E} If and how to consider empty fields. Without @samp{E} empty fields in @@ -2749,72 +2747,69 @@ 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 +Interpret all fields as numbers@comma{} 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. +Literal@comma{} 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} +You may also provide a @code{format} specifier (similar to @code{printf})@footnote{@code{format} is similar to @code{printf} in @code{C} and other languages@comma{} but +can handle arbitrary-precision integers and other Elisp objects. +Consult @ref{Formatting Strings,,,elisp,} and the docstring of +@code{format} for details.} +to reformat the Calc result after it has been passed back to Org +instead of letting Calc handle the formatting. A few examples: + +@multitable {aaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{$1+$2} @tab Sum of first and second field @item @samp{$1+$2;%.2f} -@tab Same, format result to two decimals +@tab Same@comma{} 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 +@tab Fahrenheit to Celsius conversion @item @samp{$c/$1/$cm} -@tab Hz @arrow{} cm conversion, using @samp{constants.el} +@tab Herz to centimeter conversion@comma{} using @samp{constants.el} @item @samp{tan($1);Dp3s1} -@tab Compute in degrees, precision 3, display SCI 1 +@tab Compute in degrees@comma{} precision 3@comma{} display SCI 1 @item @samp{sin($1);Dp3%.1e} -@tab Same, but use @code{printf} specifier for display +@tab Same@comma{} but use @code{format} specifier for display @item @samp{vmean($2..$7)} -@tab Compute column range mean, using vector function +@tab Compute column range mean@comma{} 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 +@tab Same@comma{} but treat empty fields as 0 +@item @samp{taylor($3@comma{}x=7@comma{}2)} +@tab Taylor series of $3@comma{} at x=7@comma{} 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 +@item @samp{if($1 < 20@comma{} teen@comma{} string(""))} +@samp{"teen"} if age @samp{$1} is less than 20@comma{} 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} +@item @samp{if("$1" =​= "nan" || "$2" =​= "nan"@comma{} string("")@comma{} $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 +is empty@comma{} 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} +@item @samp{if(typeof(vmean($1..$7)) =​= 12@comma{} string("")@comma{} 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} +return @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))} +@item @samp{if("$1..$7" =​= "[]"@comma{} string("")@comma{} 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 @@ -2822,7 +2817,7 @@ 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 +To complete the previous example: 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 @@ -2836,17 +2831,20 @@ You can add your own Calc functions defined in Emacs Lisp with @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 +useful for string manipulation and control structures@comma{} if Calc's functionality is not enough. A formula is evaluated as a Lisp form when it starts with a single-quote followed by an opening parenthesis. Cell table references are interpolated into the Lisp form before execution. The evaluation should return either a string or a number. Evaluation -modes and a @code{printf} format used to render the returned values can be -specified after a semicolon. +modes and a @code{format} string (similar to @code{printf})@footnote{@code{format} is similar to @code{printf} in @code{C} and other languages@comma{} but +can handle arbitrary-precision integers and other Elisp objects. +Consult @ref{Formatting Strings,,,elisp,} and the docstring of +@code{format} for details.} used to render +the returned values can be specified after a semicolon. -By default, references are interpolated as literal Lisp strings: the +By default@comma{} references are interpolated as literal Lisp strings: the field content is replaced in the Lisp form stripped of leading and trailing white space and surrounded in double-quotes. For example: @@ -2854,37 +2852,34 @@ trailing white space and surrounded in double-quotes. For example: '(concat $1 $2) @end example - @noindent concatenates the content of columns 1 and column 2. -When the @samp{N} flag is used, all referenced elements are parsed as -numbers and interpolated as Lisp numbers, without quotes. Fields that +When the @samp{N} flag is used@comma{} all referenced elements are parsed as +numbers and interpolated as Lisp numbers@comma{} without quotes. Fields that cannot be parsed as numbers are interpolated as zeros. For example: @example '(+ $1 $2);N @end example - @noindent -adds columns 1 and 2, equivalent to Calc's @samp{$1+$2}. Ranges are -inserted as space-separated fields, so they can be embedded in list or +adds columns 1 and 2@comma{} equivalent to Calc's @samp{$1+$2}. Ranges are +inserted as space-separated fields@comma{} so they can be embedded in list or vector syntax. For example: @example '(apply '+ '($1..$4));N @end example - @noindent -computes the sum of columns 1 to 4, like Calc's @samp{vsum($1..$4)}. +computes the sum of columns 1 to 4@comma{} like Calc's @samp{vsum($1..$4)}. -When the @samp{L} flag is used, all fields are interpolated literally: the +When the @samp{L} flag is used@comma{} all fields are interpolated literally: the cell content is replaced in the Lisp form stripped of leading and trailing white space and without quotes. If a reference is intended -to be interpreted as a string by the Lisp form, the reference operator -itself should be enclosed in double-quotes, like @samp{"$3"}. The @samp{L} flag +to be interpreted as a string by the Lisp form@comma{} the reference operator +itself should be enclosed in double-quotes@comma{} like @samp{"$3"}. The @samp{L} flag is useful when strings and numbers are used in the same Lisp form. For example: @@ -2892,27 +2887,24 @@ example: '(substring "$1" $2 $3);L @end example - @noindent extracts the part of the string in column 1 between the character -positions specified in the integers in column 2 and 3 and it is easier +positions specified in the integers in column 2 and 3@comma{} and it is easier to read than the equivalent: @example '(substring $1 (string-to-number $2) (string-to-number $3)) @end example - -When the formula itself contains @samp{;} symbol, Org mode may incorrectly +When the formula itself contains @samp{;} symbol@comma{} Org mode may incorrectly interpret everything past @samp{;} as format specifier: @example '(concat $1 ";") @end example - @noindent -You can put an extra tailing @samp{;} to indicate that all the earlier +You can put an extra trailing @samp{;} to indicate that all the earlier instances of @samp{;} belong to the formula itself: @example @@ -2926,7 +2918,7 @@ instances of @samp{;} belong to the formula itself: @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, +If you want to compute time values use the @samp{T}@comma{} @samp{t}@comma{} or @samp{U} flag@comma{} either in Calc formulas or Elisp formulas: @example @@ -2938,19 +2930,19 @@ either in Calc formulas or Elisp formulas: #+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 +Input duration values must be of the form @samp{HH:MM[:SS]}@comma{} where seconds +are optional. With the @samp{T} flag@comma{} computed durations are displayed as +@samp{HH:MM:SS} (see the first formula above). With the @samp{U} flag@comma{} 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 +With the @samp{t} flag@comma{} computed durations are displayed according to the +value of the option @code{org-table-duration-custom-format}@comma{} 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 +Negative duration values can be manipulated as well@comma{} and integers are considered as seconds in addition and subtraction. @node Field and range formulas @@ -2961,26 +2953,26 @@ considered as seconds in addition and subtraction. @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 +To assign a formula to a particular field@comma{} type it directly into the +field@comma{} preceded by @samp{:=}@comma{} 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. +still in the field@comma{} the formula is stored as the formula for this +field@comma{} evaluated@comma{} 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}. +third data line in the table@comma{} 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 +commands@comma{} @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 +avoid this from happening@comma{} in particular in range references@comma{} anchor +ranges at the table borders (using @samp{@@<}@comma{} @samp{@@>}@comma{} @samp{$<}@comma{} @samp{$>})@comma{} 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 +Instead of typing an equation into the field@comma{} you may also use the following command @table @asis @@ -2988,32 +2980,32 @@ following command @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. +for a formula with default taken from the @samp{TBLFM} keyword@comma{} +applies it to the current field@comma{} 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 +no keyboard shortcut to enter such range formulas. To add them@comma{} 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}. +Column formula@comma{} valid for the entire column. This is so common that +Org treats these formulas in a special way@comma{} see @ref{Column formulas}. @item @samp{@@3=} -Row formula, applies to all fields in the specified row. @samp{@@>=} +Row formula@comma{} 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. +Range formula@comma{} 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}. +Named field@comma{} see @ref{Advanced features}. @end table @node Column formulas @@ -3022,30 +3014,30 @@ Named field, see @ref{Advanced features}. @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 +When you assign a formula to a simple column reference like @samp{$3=}@comma{} the +same formula is used in all fields of that column@comma{} with the following very convenient exceptions: (i) If the table contains horizontal -separator hlines with rows above and below, everything before the +separator hlines with rows above and below@comma{} 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 +modified by column formulas. Therefore@comma{} a header is mandatory when you +use column formulas and want to add hlines to group rows@comma{} 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 +To assign a formula to a column@comma{} type it directly into any field in +the column@comma{} preceded by an equal sign@comma{} 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 +still in the field@comma{} the formula is stored as the formula for the +current column@comma{} evaluated and the current field replaced with the +result. If the field contains only @samp{=}@comma{} the previously stored formula +for this column is used. For each column@comma{} Org only remembers the most +recently used formula. In the @samp{TBLFM} keyword@comma{} column formulas look +like @samp{$4=$1+$2}. The left-hand side of a column formula cannot be +the name of column@comma{} it must be the numeric column reference or @samp{$>}. + +Instead of typing an equation into the field@comma{} you may also use the following command: @table @asis @@ -3054,9 +3046,9 @@ following command: @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 +a formula@comma{} with default taken from the @samp{TBLFM} keyword@comma{} applies it +to the current field and stores it. With a numeric prefix argument@comma{} +e.g.@comma{} @kbd{C-5 C-c =}@comma{} the command applies it to that many consecutive fields in the current column. @end table @@ -3080,35 +3072,35 @@ 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}, +corresponding parameters are in the call to @code{org-lookup-first}@comma{} where @var{VAL} precedes @var{S-LIST}. If -@var{R-LIST} is @code{nil}, the matching element @var{S} of +@var{R-LIST} is @code{nil}@comma{} 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} +Similar to @code{org-lookup-first} above@comma{} 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 +Similar to @code{org-lookup-first}@comma{} but searches for @emph{all} elements for +which @var{PREDICATE} is non-@code{nil}@comma{} and returns @emph{all} +corresponding values. This function cannot be used by itself in +a formula@comma{} because it returns a list of values. However@comma{} 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} +If the ranges used in these functions contain empty fields@comma{} 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 +which can@comma{} for example@comma{} 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 +These three functions can be used to implement associative arrays@comma{} +count matching cells@comma{} rank results@comma{} group data@comma{} etc. For practical examples see @uref{https://orgmode.org/worg/org-tutorials/org-lookups.html, this tutorial on Worg}. @node Editing and debugging formulas @@ -3120,10 +3112,10 @@ examples see @uref{https://orgmode.org/worg/org-tutorials/org-lookups.html, this @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 +of a table. When offering a formula for editing@comma{} 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}. +@samp{$4})@comma{} 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}) @@ -3131,26 +3123,26 @@ you prefer to only work with the internal format (like @samp{@@3$2} or @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}. +minibuffer. See @ref{Column formulas}@comma{} 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 +Re-insert the active formula (either a field formula@comma{} or a column +formula) into the current field@comma{} 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) +While editing a formula in a table field@comma{} 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 +Toggle the display of row and column numbers for a table@comma{} using overlays. These are updated each time the table is aligned; you can force it with @kbd{C-c C-c}. @@ -3162,12 +3154,12 @@ 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 +Edit all formulas for the current table in a special buffer@comma{} 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: +an active formula@comma{} point in the formula editor marks it. While +inside the special buffer@comma{} Org automatically highlights any field or +range reference at point position. You may edit@comma{} remove and add +formulas@comma{} and use the following commands: @table @asis @item @kbd{C-c C-c} or @kbd{C-x C-s} (@code{org-table-fedit-finish}) @@ -3175,7 +3167,7 @@ formulas, and use the following commands: @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 +@kbd{C-u} prefix@comma{} also apply the new formulas to the entire table. @item @kbd{C-c C-q} (@code{org-table-fedit-abort}) @@ -3193,17 +3185,17 @@ Toggle all references in the formula editor between standard (like @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 +containing a Lisp formula@comma{} 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 +again. In the open formula@comma{} @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. +Complete Lisp symbols@comma{} just like in Emacs Lisp mode. -@item @kbd{S-@key{UP}}, @kbd{S-@key{DOWN}}, @kbd{S-@key{LEFT}}, @kbd{S-@key{RIGHT}} +@item @kbd{S-@key{UP}}@comma{} @kbd{S-@key{DOWN}}@comma{} @kbd{S-@key{LEFT}}@comma{} @kbd{S-@key{RIGHT}} @kindex S-UP @kindex S-DOWN @kindex S-LEFT @@ -3212,8 +3204,8 @@ Complete Lisp symbols, just like in Emacs Lisp mode. @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 +Shift the reference at point. For example@comma{} if the reference is +@samp{B3} and you press @kbd{S-@key{RIGHT}}@comma{} 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}) @@ -3244,10 +3236,10 @@ Turn the coordinate grid in the table on and off. @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. +the field@comma{} because that is stored in a different line---the @samp{TBLFM} +keyword line. During the next recalculation@comma{} the field will be filled +again. To remove a formula from a field@comma{} you have to give an empty +reply when prompted for the formula@comma{} 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 @@ -3264,7 +3256,7 @@ recalculation commands in the table. @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 +keywords right after the table@comma{} and then press @kbd{C-c C-c} on the formula to apply. Here is an example: @example @@ -3289,7 +3281,7 @@ Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields: @end example @noindent -If you recalculate this table, with @kbd{C-u C-c *}, for example, +If you recalculate this table@comma{} with @kbd{C-u C-c *}@comma{} for example@comma{} you get the following result from applying only the first @samp{TBLFM} keyword. @@ -3308,12 +3300,12 @@ keyword. @cindex formula debugging @cindex debugging, of table formulas -When the evaluation of a formula leads to an error, the field content +When the evaluation of a formula leads to an error@comma{} the field content becomes the string @samp{#ERROR}. If you want 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, +during variable substitution and calculation in order to find a bug@comma{} +turn on formula debugging in the Tbl menu and repeat the calculation@comma{} for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a field. -Detailed information are displayed. +Detailed information is displayed. @node Updating the table @subsection Updating the table @@ -3321,11 +3313,11 @@ Detailed information are displayed. @cindex recomputing table fields @cindex updating, table -Recalculation of a table is normally not automatic, but needs to be +Recalculation of a table is normally not automatic@comma{} but needs to be triggered by a command. To make recalculation at least -semi-automatic, see @ref{Advanced features}. +semi-automatic@comma{} see @ref{Advanced features}. -In order to recalculate a line of a table or the entire table, use the +In order to recalculate a line of a table or the entire table@comma{} use the following commands: @table @asis @@ -3333,14 +3325,14 @@ following commands: @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 +formulas from left to right@comma{} 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 +Recompute the entire table@comma{} line by line. Any lines before the +first hline are left alone@comma{} 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}) @@ -3357,25 +3349,25 @@ 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 +Iterate all tables in the current buffer@comma{} 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 +If you want the recalculation of fields to happen automatically@comma{} 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 +characters.} to fields and columns@comma{} 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 +Rotate the calculation mark in first column through the states @samp{#}@comma{} +@samp{*}@comma{} @samp{!}@comma{} @samp{$}. When there is an active region@comma{} change all marks in the region. @end table @@ -3401,9 +3393,9 @@ and makes use of these features: @end example @quotation Important -Please note that for these special tables, recalculating the table +Please note that for these special tables@comma{} 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 +@samp{*}@comma{} 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 @@ -3413,34 +3405,34 @@ The marking characters have the following meaning: @table @asis @item @samp{!} -The fields in this line define names for the columns, so that you +The fields in this line define names for the columns@comma{} 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 +a definition@comma{} any formula in the table may use @samp{$m1} to refer to the +value @samp{10}. Also@comma{} if you assign a formula to a names field@comma{} it is stored as @samp{$name = ...}. @item @samp{_} -Similar to @samp{^}, but defines names for the fields in the row @emph{below}. +Similar to @samp{^}@comma{} 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 +example@comma{} if a field in a @samp{$} row contains @samp{max=50}@comma{} 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 +exactly like constants@comma{} 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 +Also@comma{} 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 +Selects this line for global recalculation with @kbd{C-u C-c *}@comma{} but not for automatic recalculation. Use this when automatic recalculation slows down editing too much. @item @samp{/} @@ -3448,8 +3440,8 @@ Do not export this line. Useful for lines that contain the narrowing @samp{} 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 +Finally@comma{} just to whet your appetite for what can be done with the +fantastic Calc package@comma{} here is a table that computes the Taylor series of degree n at location x for a couple of functions. @example @@ -3463,7 +3455,7 @@ series of degree n at location x for a couple of functions. | # | 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 +#+TBLFM: $5=taylor($2@comma{}$4@comma{}$3);n3 @end example @node Org Plot @@ -3472,7 +3464,7 @@ series of degree n at location x for a couple of functions. @cindex graph, in tables @cindex plot tables using Gnuplot -Org Plot can produce graphs of information stored in Org tables, +Org Plot can produce graphs of information stored in Org tables@comma{} either graphically or in ASCII art. @anchor{Graphical plots using Gnuplot} @@ -3480,8 +3472,8 @@ either graphically or in ASCII art. @cindex @samp{PLOT}, keyword Org Plot can produce 2D and 3D graphs of information stored in Org -tables using @uref{https://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, +tables using @uref{https://www.gnuplot.info/, Gnuplot} and @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html, Gnuplot mode}. To see this in action@comma{} ensure +that you have both Gnuplot and Gnuplot mode installed on your system@comma{} then call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot} on the following table. @@ -3496,8 +3488,8 @@ following table. | Morelia | 257.56 | 17.67 | @end example -Org Plot supports a range of plot types, and provides the ability to add more. -For example, a radar plot can be generated like so: +Org Plot supports a range of plot types@comma{} and provides the ability to add more. +For example@comma{} a radar plot can be generated like so: @example #+PLOT: title:"An evaluation of plaintext document formats" transpose:yes type:radar min:0 max:4 | Format | Fine-grained-control | Initial Effort | Syntax simplicity | Editor Support | Integrations | Ease-of-referencing | Versatility | @@ -3510,7 +3502,7 @@ For example, a radar plot can be generated like so: @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 +labels. Further control over the labels@comma{} type@comma{} content@comma{} 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}. @@ -3533,26 +3525,26 @@ Specify which column of the table to use as the @samp{x} axis as a time value. @item @samp{deps} -Specify the columns to graph as a Lisp style list, surrounded by +Specify the columns to graph as a Lisp style list@comma{} 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{transpose} -When @samp{y}, @samp{yes}, or @samp{t} attempt to transpose the table data before +When @samp{y}@comma{} @samp{yes}@comma{} or @samp{t} attempt to transpose the table data before plotting. Also recognizes the shorthand option @samp{trans}. @item @samp{type} -Specify the type of the plot, by default one of @samp{2d}, @samp{3d}, @samp{radar}, or @samp{grid}. +Specify the type of the plot@comma{} by default one of @samp{2d}@comma{} @samp{3d}@comma{} @samp{radar}@comma{} or @samp{grid}. Available types can be customized with @code{org-plot/preset-plot-types}. @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 +plotted@comma{} e.g.@comma{} @samp{lines}@comma{} @samp{points}@comma{} @samp{boxes}@comma{} @samp{impulses}. Defaults to @samp{lines}. @item @samp{file} -If you want to plot to a file, specify +If you want to plot to a file@comma{} specify @samp{"path/to/desired/output-file"}. @item @samp{labels} @@ -3563,23 +3555,23 @@ headers if they exist. 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 +When plotting @samp{3d} or @samp{grid} types@comma{} set this to @samp{t} to graph a flat mapping rather than a @samp{3d} slope. @item @samp{min} Provides a minimum axis value that may be used by a plot type. -Implicitly assumes the @samp{y} axis is being referred to. Can -explicitly provide a value for a either the @samp{x} or @samp{y} axis with -@samp{xmin} and @samp{ymin}. +Implicitly assumes the @samp{y} axis is being referred to. You can +explicitly provide a value for the @samp{x} or @samp{y} axis with @samp{xmin} and +@samp{ymin}. @item @samp{max} Provides a maximum axis value that may be used by a plot type. -Implicitly assumes the @samp{y} axis is being referred to. Can -explicitly provide a value for a either the @samp{x} or @samp{y} axis with -@samp{xmax} and @samp{ymax}. +Implicitly assumes the @samp{y} axis is being referred to. You can +explicitly provide a value for the @samp{x} or @samp{y} axis with @samp{xmax} and +@samp{ymax}. @item @samp{ticks} -Provides a desired number of axis ticks to display, that may be used +Provides a desired number of axis ticks to display@comma{} that may be used by a plot type. If none is given a plot type that requires ticks will use @code{org--plot/sensible-tick-num} to try to determine a good value. @@ -3589,21 +3581,21 @@ 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 +If you want total control@comma{} 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 +Before plotting@comma{} 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. +Note: even if you set this option@comma{} you may still want to specify the +plot type@comma{} 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 +While point is on a column@comma{} 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 *}. +the source column changes@comma{} the bar plot may be updated by refreshing +the table@comma{} for example typing @kbd{C-u C-c *}. @example | Sede | Max cites | | @@ -3625,7 +3617,7 @@ 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 +is the value filling all the @var{WIDTH}. Source 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 @@ -3637,8 +3629,8 @@ defaults to @samp{12}. @cindex hyperlinks -Like HTML, Org provides support for links inside a file, external -links to other files, Usenet articles, emails, and much more. +Like HTML@comma{} Org provides support for links inside a file@comma{} external +links to other files@comma{} Usenet articles@comma{} emails@comma{} and much more. @menu * Link Format:: How links in Org are formatted. @@ -3660,20 +3652,19 @@ links to other files, Usenet articles, emails, and much more. @cindex angle bracket links @cindex plain links -Org recognizes plain URIs, possibly wrapped within angle +Org recognizes plain URIs@comma{} 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. +schemes. See @ref{External Links}. Unlike URI syntax@comma{} they cannot contain +parenthesis or white spaces@comma{} either. URIs within angle brackets have +no such limitation.}@comma{} and activates them as clickable links. @cindex bracket links -The general link format, however, looks like this: +The general link format@comma{} however@comma{} looks like this: @example [[LINK][DESCRIPTION]] @end example - @noindent or alternatively @@ -3681,19 +3672,17 @@ or alternatively [[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: +Some @samp{\}@comma{} @samp{[} and @samp{]} characters in the @var{LINK} part need to +be ``escaped''@comma{} i.e.@comma{} preceded by another @samp{\} character. More +specifically@comma{} only the following characters must be escaped: @enumerate @item -all @samp{[} and @samp{]} characters, +all @samp{[} and @samp{]} characters@comma{} @item -every @samp{\} character preceding either @samp{]} or @samp{[}, +every @samp{\} character preceding either @samp{]} or @samp{[}@comma{} @item every @samp{\} character at the end of the link. @end enumerate @@ -3701,32 +3690,32 @@ every @samp{\} character at the end of the link. @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 +when inserting directly@comma{} or yanking@comma{} a URI within square brackets. +When in doubt@comma{} you may use the function @code{org-link-escape}@comma{} which turns a link string into its escaped form. -Once a link in the buffer is complete, with all brackets present, Org +Once a link in the buffer is complete@comma{} with all brackets present@comma{} 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 +Links are highlighted in the @code{org-link} face@comma{} which@comma{} by default@comma{} 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 +the @var{LINK} part@comma{} if there is no description@comma{} 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 +@var{LINK} part@comma{} 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 +displayed text and press @kbd{@key{BS}}@comma{} you remove +the---invisible---bracket at that location@footnote{ More accurately@comma{} 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, customize @code{org-link-descriptive}, or use -@samp{literallinks} @ref{In-buffer Settings, , startup option}. +the internal structure of all links@comma{} use the menu: Org @arrow{} +Hyperlinks @arrow{} Literal links@comma{} customize @code{org-link-descriptive}@comma{} or use +the @samp{literallinks} @ref{In-buffer Settings, , startup option}. @node Internal Links @section Internal Links @@ -3734,31 +3723,31 @@ Hyperlinks @arrow{} Literal links, customize @code{org-link-descriptive}, or use @cindex internal links @cindex links, internal -A link that does not look like a URL---i.e., does not start with +A link that does not look like a URL---i.e.@comma{} 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 +can follow it with @kbd{C-c C-o} when point is on the link@comma{} 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]]} +a document. Most notably@comma{} 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 +@samp{my-custom-id}. Also@comma{} 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@comma{} 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 +When the link does not belong to any of the cases above@comma{} Org looks for +a @emph{dedicated target}: the same string in double angular brackets@comma{} like @samp{<>}. @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 +If no dedicated target exists@comma{} the link tries to match the exact name +of an element within the buffer. Naming is done@comma{} unsurprisingly@comma{} with +the @samp{NAME} keyword@comma{} which has to be put in the line before the element +it refers to@comma{} as in the following example @example #+NAME: My Target @@ -3768,19 +3757,19 @@ it refers to, as in the following example @end example @vindex org-link-search-must-match-exact-headline -Ultimately, if none of the above succeeds, Org searches for a headline +Ultimately@comma{} if none of the above succeeds@comma{} 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 +tags@comma{} or initiates a plain text search@comma{} 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 +Note that you must make sure custom IDs@comma{} dedicated targets@comma{} and names are unique throughout the document. Org provides a linter to assist -you in the process, if needed. See @ref{Org Syntax}. +you in the process@comma{} if needed. See @ref{Org Syntax}. -During export, internal links are used to mark objects and assign them +During export@comma{} 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, +them. In particular@comma{} links without a description appear as the number +assigned to the marked object@footnote{ When targeting a @samp{NAME} keyword@comma{} the @samp{CAPTION} keyword is mandatory in order to get proper numbering (see @ref{Captions}).}. In the following excerpt from an Org buffer @@ -3794,8 +3783,8 @@ Here we refer to item [[target]]. 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}. +In non-Org files@comma{} the search looks for the words in the link text. In +the above example@comma{} 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 @@ -3810,13 +3799,13 @@ recorded earlier. @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 +normal text into a link. So without explicitly creating a link@comma{} the text connects to the target radioing its position. Radio targets are -enclosed by triple angular brackets. For example, a target @samp{<<>>} 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 +update the target list during editing@comma{} press @kbd{C-c C-c} with point on or at a target. @node External Links @@ -3838,7 +3827,7 @@ point on or at a target. @cindex URL links @cindex Usenet links -Org supports links to files, websites, Usenet and email messages, BBDB +Org supports links to files@comma{} websites@comma{} Usenet and email messages@comma{} 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 @@ -3848,10 +3837,10 @@ 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. +File links. File name may be remote@comma{} absolute@comma{} or relative. -As a special case, ``file'' prefix may be omitted if the file name -is complete, e.g., it starts with @samp{./}, or @samp{/}. +As a special case@comma{} the ``file'' prefix may be omitted if the file name +is complete@comma{} e.g.@comma{} it starts with @samp{./} or @samp{/}. @item @samp{attachment} Same as file links but for files and folders attached to the current @@ -3860,32 +3849,32 @@ exactly as file links but for files relative to the attachment directory. @item @samp{bbdb} -Link to a BBDB record, with possible regexp completion. +Link to a BBDB record@comma{} 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. +Link to an electronic resource@comma{} through its handle. @item @samp{elisp} Execute an Elisp command upon activation. -@item @samp{gnus}, @samp{rmail}, @samp{mhe} +@item @samp{gnus}@comma{} @samp{rmail}@comma{} @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} +@item @samp{http}@comma{} @samp{https} Web links. @item @samp{id} -Link to a specific headline by its ID property, in an Org file. +Link to a specific headline by its ID property@comma{} in an Org file. @item @samp{info} -Link to an Info manual, or to a specific node. +Link to an Info manual@comma{} or to a specific node. @item @samp{irc} Link to an IRC channel. @@ -3898,14 +3887,22 @@ Usenet links. @item @samp{shell} Execute a shell command upon activation. + +@item @samp{shortdoc} +Link to short documentation summary for an Emacs Lisp function group. +@footnote{You can run @samp{M-x shortdoc-display-group} to list all known +documentation groups.} + +For more information@comma{} see @ref{Name Help,Name Help,,emacs,} +and @ref{Documentation Groups,Documentation Groups,,elisp,}. @end table -For @samp{file:} and @samp{id:} links, you can additionally specify a line -number, or a text search string, separated by @samp{::}. In Org files, you -may link to a headline name, a custom ID, or a code reference instead. +For @samp{file:} and @samp{id:} links@comma{} you can additionally specify a line +number@comma{} or a text search string@comma{} separated by @samp{::}. In Org files@comma{} you +may link to a headline name@comma{} a custom ID@comma{} or a code reference instead. -The following table illustrates the link types above, along with their +The following table illustrates the link types above@comma{} along with their options: @multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @@ -3936,10 +3933,10 @@ options: @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.} +@code{nil}@comma{} then a fuzzy text search is done. If it is @code{t}@comma{} then only the +exact headline is matched@comma{} ignoring spaces and statistic cookies. If +the value is @code{query-to-create}@comma{} then an exact headline is searched; if +it is not found@comma{} then the user is queried to create it.} @item @tab @samp{file:projects.org::*task title} (headline search) @item @@ -3978,8 +3975,12 @@ it is not found, then the user is queried to create it.} @tab @samp{help:org-store-link} @item info @tab @samp{info:org#External links} +@item shortdoc +@tab @samp{shortdoc:text-properties} +@item +@tab @samp{shortdoc:text-properties::#get-pos-property} @item shell -@tab @samp{shell:ls *.org} +@tab @samp{shell:ls *.org} (synchronous)@comma{} @samp{shell:inkscape&} (asynchronous) @item elisp @tab @samp{elisp:(find-file "Elisp.org")} (Elisp form to evaluate) @item @@ -3988,9 +3989,9 @@ it is not found, then the user is queried to create it.} @cindex VM links @cindex Wanderlust links -On top of these built-in link types, additional ones are available +On top of these built-in link types@comma{} additional ones are available through the @samp{org-contrib} repository (see @ref{Installation}). For -example, these links to VM or Wanderlust messages are available when +example@comma{} these links to VM or Wanderlust messages are available when you load the corresponding libraries from the @samp{org-contrib} repository: @@ -4011,19 +4012,18 @@ repository: @tab Wanderlust message link @end multitable -For information on customizing Org to add new link types, see @ref{Adding Hyperlink Types}. +For information on customizing Org to add new link types@comma{} 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: +descriptive text to be displayed instead of the URL (see @ref{Link Format})@comma{} 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 +If the description is a file name or URL that points to an image@comma{} 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 +there is no description at all and the link points to an image@comma{} that image is inlined into the exported HTML file. @cindex square brackets, around links @@ -4031,20 +4031,20 @@ image is inlined into the exported HTML file. @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. +@samp{bbdb:R.*Stallman})@comma{} or if you need to remove ambiguities about the +end of the link@comma{} 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. +Org provides methods to create a link in the correct syntax@comma{} to insert +it into an Org file@comma{} 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 +The main function is @code{org-store-link}@comma{} called with @kbd{M-x org-store-link}. Because of its importance@comma{} we suggest binding 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 @@ -4052,39 +4052,39 @@ current buffer: @table @asis @item @emph{Org mode buffers} -For Org files, if there is a @samp{<>} at point, the link points +For Org files@comma{} if there is a @samp{<>} at point@comma{} the link points to the target. If there is a named block (using @samp{#+name:}) at -point, the link points to that name. Otherwise it points to the -current headline, which is also the description. +point@comma{} the link points to that name. Otherwise@comma{} it points to the +current headline@comma{} which is also the description. @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 +If the headline has a @samp{CUSTOM_ID} property@comma{} store a link to this +custom ID@. In addition or alternatively@comma{} depending on the value of +@code{org-id-link-to-org-use-id}@comma{} create and/or use a globally unique +@samp{ID} property for the link@footnote{ The @code{org-id} library must first be +loaded@comma{} either through @code{org-customize}@comma{} by enabling @code{id} in +@code{org-modules}@comma{} 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 +two links: a human-readable link from the custom ID@comma{} and one that is globally unique and works even if the entry is moved from file to file. The @samp{ID} property can be either a UUID (default) or a -timestamp, depending on @code{org-id-method}. Later, when inserting the -link, you need to decide which one to use. +timestamp@comma{} depending on @code{org-id-method}. Later@comma{} when inserting the +link@comma{} you need to decide which one to use. @vindex org-id-link-consider-parent-id @vindex org-id-link-use-context @vindex org-link-context-for-files -When @code{org-id-link-consider-parent-id} is @code{t}@footnote{ Also, +When @code{org-id-link-consider-parent-id} is @code{t}@footnote{ Also@comma{} @code{org-link-context-for-files} and @code{org-id-link-use-context} should be -both enabled (which they are, by default).}, parent @samp{ID} properties -are considered. This allows linking to specific targets, named -blocks, or headlines (which may not have a globally unique @samp{ID} +both enabled (which they are@comma{} by default).}@comma{} parent @samp{ID} properties +are considered. This allows linking to specific targets@comma{} named +blocks@comma{} or headlines (which may not have a globally unique @samp{ID} themselves) within the context of a parent headline or file which does. -For example, given this org file: +For example@comma{} given this org file: @example * Parent @@ -4096,19 +4096,19 @@ For example, given this org file: @end example Storing a link with point at ``Child 1'' will produce a link -@samp{}, which precisely links to the ``Child 1'' +@samp{}@comma{} which precisely links to the ``Child 1'' headline even though it does not have its own ID@. -@item @emph{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus} +@item @emph{Email/News clients: VM@comma{} Rmail@comma{} Wanderlust@comma{} MH-E@comma{} 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 +to the current article@comma{} or@comma{} in some Gnus buffers@comma{} to the group. The description is constructed according to the variable -@code{org-link-email-description-format}. By default, it refers to the +@code{org-link-email-description-format}. By default@comma{} it refers to the addressee and the subject. @item @emph{Web browsers: W3M and EWW} -Here the link is the current URL, with the page title as the +Here the link is the current URL@comma{} with the page title as the description. @item @emph{Contacts: BBDB} @@ -4116,15 +4116,15 @@ 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}, +For IRC links@comma{} if the variable @code{org-irc-link-to-logs} is non-@code{nil}@comma{} 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 +current conversation. Otherwise@comma{} 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 +For any other file@comma{} the link points to the file@comma{} with a search string (see @ref{Search Options}) pointing to the contents -of the current line. If there is an active region, the selected +of the current line. If there is an active region@comma{} 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}). @@ -4132,12 +4132,12 @@ 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 +When point is in an agenda view@comma{} 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. +From an Org buffer@comma{} the following commands create@comma{} navigate or@comma{} more +generally@comma{} act on links. @table @asis @item @kbd{C-c C-l} (@code{org-insert-link}) @@ -4148,34 +4148,34 @@ generally, act on 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 +a link. Links in Org are plain text@comma{} and you can type or paste them +straight into the buffer. By using this command@comma{} the links are +automatically enclosed in double brackets@comma{} 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, +the buffer. You can just type a link@comma{} using text for an internal +link@comma{} or one of the link type prefixes mentioned in the examples +above. The link is inserted into the buffer@comma{} along with +a descriptive text@footnote{After insertion of a stored link@comma{} the link will be removed +from the list of stored links. To keep it in the list for later use@comma{} +use a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}@comma{} or +configure the option @code{org-link-keep-stored-after-insertion}.}. If some text was selected at this time@comma{} 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}). +history for this prompt@comma{} so you can access them with @kbd{@key{UP}} +and @kbd{@key{DOWN}} (or @kbd{M-p}@comma{} @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 +prefixes like @samp{http} or @samp{ftp}@comma{} including the prefixes defined through link abbreviations (see @ref{Link Abbreviations}). If you -press @kbd{@key{RET}} after inserting only the prefix, Org offers +press @kbd{@key{RET}} after inserting only the prefix@comma{} 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. +in @code{org-link-parameters}.}. For example@comma{} if you type @kbd{f i l e @key{RET}}---alternative access: @kbd{C-u C-c C-l}@comma{} see +below---Org offers file name completion@comma{} and after @kbd{b b d b @key{RET}} you can complete contact names. @end table @item @kbd{C-u C-c C-l} @@ -4183,18 +4183,18 @@ below---Org offers file name completion, and after @kbd{b b d b @key{RET}} you c @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 +argument@comma{} 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 +relative to the directory of the current Org file@comma{} if the linked +file is in the current directory or in a subdirectory of it@comma{} 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 +Otherwise@comma{} an absolute path is used@comma{} 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 +When point is on an existing link@comma{} @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}) @@ -4202,48 +4202,48 @@ edit the link and description parts of the link. @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 +@code{browse-url-at-point})@comma{} runs VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for +the corresponding links@comma{} and executes the command in a shell link. +When point is on an internal link@comma{} this command runs the +corresponding search. When point is on the tags part of a headline@comma{} +it creates the corresponding tags view (see @ref{Matching tags and properties}). If point is on a timestamp@comma{} it compiles the agenda for +that date. Furthermore@comma{} it visits text and remote files in @samp{file} +links with Emacs and selects 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 +default application and visit the file with Emacs@comma{} use +a @kbd{C-u} prefix. If you want to avoid opening in Emacs@comma{} 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}. +If point is on a headline@comma{} but not on a link@comma{} Org offers all links +in the headline and entry text. If you want to set up the frame +configuration for following links@comma{} 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 +When @code{org-return-follows-link} is set@comma{} @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 +On links@comma{} @kbd{mouse-1} and @kbd{mouse-2} open 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 +Like @kbd{mouse-2}@comma{} but force file links to be opened with +Emacs@comma{} 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 +Push the current position onto the Org mark ring@comma{} to be able to return easily. Commands following an internal link do this automatically. @@ -4252,19 +4252,18 @@ automatically. @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 +commands following internal links@comma{} 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}) +@item @kbd{C-c C-x C-n} (@code{org-next-link})@comma{} @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 +Move forward/backward to the next/previous link in the buffer. At the limit +of the buffer@comma{} the search fails once@comma{} 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}. @@ -4280,8 +4279,8 @@ this also to @kbd{M-n} and @kbd{M-p}. @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: +You can insert and follow links that have Org syntax not only in Org@comma{} +but in any Emacs buffer. For this@comma{} 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 @@ -4293,7 +4292,7 @@ You might want to bind them to globally available keys. See @cindex link abbreviations @cindex abbreviation, links -Long URL can be cumbersome to type, and often many similar links are +Long URLs can be cumbersome to type@comma{} and often many similar links are needed in a document. For this you can use link abbreviations. An abbreviated link looks like this @@ -4301,11 +4300,10 @@ abbreviated link looks like this [[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{_}. +where the tag is optional. The @emph{linkword} must be a word@comma{} starting +with a letter@comma{} followed by letters@comma{} numbers@comma{} @samp{-}@comma{} 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: @@ -4319,27 +4317,27 @@ replacement text. Here is an example: ("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 +If the replacement text contains the string @samp{%s}@comma{} 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 +example above@comma{} where we need to encode the URL parameter). Using +@samp{%(my-function)} passes the tag to a custom Lisp function@comma{} and replaces it by the resulting string. -If the replacement text do not contain any specifier, it is simply +If the replacement text does not contain any specifier@comma{} 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 +Instead of a string@comma{} 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]]}, +With the above setting@comma{} you could link to a specific bug with +@samp{[[bugzilla:129]]}@comma{} search the web for @samp{OrgMode} with @samp{[[duckduckgo:OrgMode]]}@comma{} show the map location of the Free Software Foundation @samp{[[omap:31 -Milk Street, Boston]]} or of Carsten's 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]]}. +Milk Street@comma{} Boston]]} or of Carsten's office @samp{[[omap:Science Park 904@comma{} +Amsterdam@comma{} The Netherlands]]} and find out what the Org author is doing +besides Emacs hacking with @samp{[[ads:Dominik@comma{}C]]}. -If you need special abbreviations just for a single Org buffer, you +If you need special abbreviations just for a single Org buffer@comma{} you can define them in the file with @cindex @samp{LINK}, keyword @@ -4353,9 +4351,9 @@ The abbreviations containing spaces must be quoted. 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 +implements special (e.g.@comma{} 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 +arguments@comma{} and should return the full link with a prefix. You can set the link completion function like this: @lisp @@ -4374,9 +4372,9 @@ the link completion function like this: 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 +compatibility@comma{} line numbers can also follow a single colon.}. For +example@comma{} when the command @code{org-store-link} creates a link (see +@ref{Handling Links}) to a file@comma{} 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}. @@ -4384,7 +4382,7 @@ Note that all search options apply for Attachment and ID 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: +link@comma{} together with explanations for each: @example [[file:~/code/main.c::255]] @@ -4400,26 +4398,26 @@ link, together with explanations for each: Jump to line 255. @item @samp{My Target} -Search for a link target @samp{<>}, 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 +Search for a link target @samp{<>}@comma{} or do a text search for +@samp{my target}@comma{} similar to the search in internal links@comma{} see @ref{Internal Links}. In HTML export (see @ref{HTML Export})@comma{} such a file link becomes +an HTML reference to the corresponding named anchor in the linked file. @item @samp{*My Target} -In an Org file, restrict search to headlines. +In an Org file@comma{} 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} (see @ref{Regular Expressions}). This uses the Emacs command @code{occur} to list all -matches in a separate window. If the target file is in Org mode, +matches in a separate window. If the target file is in Org mode@comma{} @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]]} +As a degenerate case@comma{} a file link with an empty file name can be used +to search the current file. For example@comma{} @samp{[[file:::find me]]} does +a search for @samp{find me} in the current file@comma{} just as @samp{[[find me]]} would. @node Custom Searches @@ -4430,20 +4428,20 @@ would. 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 +cases. For example@comma{} Bib@TeX{} database files have many entries like +@code{year="1993"} which would not result in good search strings@comma{} 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 +If you come across such a problem@comma{} you can write custom functions to +set the right search string for a particular file type@comma{} and to do the +search for the string in the file. Using @code{add-hook}@comma{} 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 +Bib@TeX{} database files@comma{} and you can use the corresponding code as an implementation example. See the file @samp{ol-bibtex.el}. @node TODO Items @@ -4452,14 +4450,14 @@ implementation example. See the file @samp{ol-bibtex.el}. @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 +course@comma{} you can make a document that contains only long lists of TODO +items@comma{} but this is not required.}. Instead@comma{} TODO items are an +integral part of the notes file@comma{} because TODO items usually come up +while taking notes! With Org mode@comma{} simply mark any entry in a tree as +being a TODO item. In this way@comma{} information is not duplicated@comma{} and the entire context from which the TODO item emerged is always present. -Of course, this technique for managing TODO items scatters them +Of course@comma{} 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. @@ -4476,14 +4474,13 @@ have to do. @node TODO Basics @section Basic TODO Functionality -Any headline becomes a TODO item when it starts with the word @samp{TODO}, +Any headline becomes a TODO item when it starts with the word @samp{TODO}@comma{} for example: @example *** TODO Write letter to Sam Fortune @end example - The most important commands to work with TODO entries are: @table @asis @@ -4493,11 +4490,11 @@ The most important commands to work with TODO entries are: Rotate the TODO state of the current item among @example -,-> (unmarked) -> TODO -> DONE --. +@comma{}-> (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 +If TODO keywords have fast access keys (see @ref{Fast access to TODO states})@comma{} 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}. @@ -4508,9 +4505,9 @@ buffer with the @kbd{t} command key (see @ref{Agenda Commands}). @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. +Select the following/preceding TODO state@comma{} 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 +@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}. @@ -4520,22 +4517,22 @@ shift-selection. See also the variable @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 +entire buffer@comma{} but shows all TODO items---with a not-DONE state---and +the headings hierarchy above them. With a prefix argument@comma{} or by +using @kbd{C-c / T}@comma{} search for a specific TODO@. You are +prompted for the keyword@comma{} 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 +keywords. With a numeric prefix argument N@comma{} 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. +arguments@comma{} find all TODO states@comma{} 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 +buffer. The new buffer is in Org Agenda mode@comma{} 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. +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 @@ -4553,10 +4550,10 @@ of the option @code{org-todo-state-tags-triggers} for details. @cindex extended TODO keywords @vindex org-todo-keywords -By default, marked TODO entries have one of only two states: TODO and +By default@comma{} 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 +setup@comma{} the TODO keyword system can work differently in different files. Note that @emph{tags} are another way to classify headlines in general and @@ -4578,8 +4575,8 @@ TODO items in particular (see @ref{Tags}). @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 +You can use TODO keywords to indicate different@comma{} possibly @emph{sequential} +states in the process of working on an item@comma{} for example@footnote{ Changing the variable @code{org-todo-keywords} only becomes effective after restarting Org mode in a buffer.}: @@ -4590,19 +4587,19 @@ restarting Org mode in a buffer.}: 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 +you do not provide the separator bar@comma{} 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 +With this setup@comma{} the command @kbd{C-c C-t} cycles an entry from +@samp{TODO} to @samp{FEEDBACK}@comma{} then to @samp{VERIFY}@comma{} 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 +If you define many keywords@comma{} 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. +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 @@ -4612,34 +4609,34 @@ Changing a TODO state can be logged with a timestamp, see @ref{Tracking TODO sta @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 +@emph{types} of action items. For example@comma{} you might want to indicate that +items are for ``work'' or ``home''. Or@comma{} when you work with several people +on a single project@comma{} you might want to assign action items directly to +persons@comma{} 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 +@ref{Tags})@comma{} so the TODO implementation is kept just for backward compatibility. -Using TODO types, it would be set up like this: +Using TODO types@comma{} 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 +In this case@comma{} different keywords do not indicate states@comma{} but rather +different types. So the normal workflow would be to assign a task to +a person@comma{} and later to mark it DONE@. Org mode supports this style by +adapting the working 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, +used several times in succession@comma{} it still cycles through all names@comma{} 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 +again@comma{} 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 +using a numeric prefix to @kbd{C-c / t}. For example@comma{} to see all +things Lucy has to do@comma{} you would use @kbd{C-3 C-c / t}. To +collect Lucy's items from all agenda files into a single buffer@comma{} you would use the numeric prefix argument as well when creating the global TODO list: @kbd{C-3 M-x org-agenda t}. @@ -4649,9 +4646,9 @@ TODO list: @kbd{C-3 M-x org-agenda t}. @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 +parallel. For example@comma{} you may want to have the basic TODO/DONE@comma{} but +also a workflow for bug fixing@comma{} and a separate state indicating that +an item has been canceled---so it is not DONE@comma{} but also does not require action. Your setup would then look like this: @lisp @@ -4661,45 +4658,42 @@ require action. Your setup would then look like this: (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 +The keywords should all be different@comma{} this helps Org mode keep track +of which subsequence should be used for a given entry. In this setup@comma{} +@kbd{C-c C-t} only operates within a sub-sequence@comma{} so it switches +from @samp{DONE} to (nothing) to @samp{TODO}@comma{} and from @samp{FIXED} to (nothing) to +@samp{REPORT}. Therefore@comma{} 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: +(see @ref{Completion})@comma{} 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}} +@item @kbd{C-u C-u C-c C-t}@comma{} @kbd{C-S-@key{RIGHT}}@comma{} @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 +above example@comma{} @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}@comma{} 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}). +binding conflicts with shift-selection (see @ref{Conflicts}). -@item @kbd{S-@key{RIGHT}} -@itemx @kbd{S-@key{LEFT}} +@item @kbd{S-@key{RIGHT}}@comma{} @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 +from all sub-sequences@comma{} 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}. +a discussion of the interaction with shift-selection@comma{} 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 +state instead of cycling through the states@comma{} 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 +selection character after each keyword@comma{} in parentheses@footnote{ All +characters are allowed except @samp{@@}@comma{} @samp{^} and @samp{!}@comma{} which have a special meaning here.}. For example: @lisp @@ -4709,7 +4703,7 @@ meaning here.}. For example: (sequence "|" "CANCELED(c)"))) @end lisp -If you then press @kbd{C-c C-t} followed by the selection key, +If you then press @kbd{C-c C-t} followed by the selection key@comma{} the entry is switched to this state. @kbd{@key{SPC}} can be used to remove any TODO keyword from an entry. @@ -4723,25 +4717,23 @@ remove any TODO keyword from an entry. @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 +in different files. For file-local settings@comma{} 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 +file only. For example@comma{} to set one of the two examples discussed +above@comma{} you need one of the following lines@comma{} 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 +interpretation@comma{} but it means the same as @samp{#+TODO}@comma{} or @example #+TYP_TODO: Fred Sara Lucy Mike | DONE @end example - A setup for using several sets in parallel would be: @example @@ -4752,14 +4744,14 @@ A setup for using several sets in parallel would be: @cindex completion, of option keywords @kindex M-TAB -To make sure you are using the correct keyword, type @samp{#+} into the +To make sure you are using the correct keyword@comma{} 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, +keyword if no bar is there---must always mean that the item is DONE@comma{} 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 +lines@comma{} 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 @@ -4774,9 +4766,9 @@ the current buffer.}. @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 +keywords indicating that an item still has to be acted upon@comma{} 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 +are using more than two different states@comma{} 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: @@ -4788,8 +4780,8 @@ special faces for some of them. This can be done using the variable @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 +@emph{should} work@comma{} this does not always seem to be the case. If +necessary@comma{} 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. @@ -4803,14 +4795,14 @@ a background color. @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 +define TODO dependencies. Usually@comma{} a parent TODO task should not be +marked as done until all TODO subtasks@comma{} or children tasks@comma{} are marked +as done. Sometimes there is a logical sequence to (sub)tasks@comma{} 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 +@code{org-enforce-todo-dependencies}@comma{} 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 +Furthermore@comma{} if an entry has a property @samp{ORDERED}@comma{} each of its TODO children is blocked until all earlier siblings are marked as done. Here is an example: @@ -4824,8 +4816,8 @@ Here is an example: :ORDERED: t :END: ** TODO a -** TODO b, needs to wait for (a) -** TODO c, needs to wait for (a) and (b) +** TODO b@comma{} needs to wait for (a) +** TODO c@comma{} needs to wait for (a) and (b) @end example @cindex TODO dependencies, @samp{NOBLOCKING} @@ -4847,18 +4839,18 @@ property (see @ref{Properties and Columns}): @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 +entry@comma{} not inherited from entries above like a tag (see @ref{Tags}). +However@comma{} if you would like to @emph{track} the value of this property +with a tag for better visibility@comma{} 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. +Change TODO state@comma{} 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 +If you set the variable @code{org-agenda-dim-blocked-tasks}@comma{} 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}). @@ -4866,11 +4858,11 @@ in a dimmed font or even made invisible in agenda views (see @ref{Agenda Views}) @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 +@code{org-enforce-todo-checkbox-dependencies}@comma{} 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 +If you need more complex dependency structures@comma{} for example +dependencies between entries in different trees or files@comma{} check out the module @samp{org-depend.el} in the @samp{org-contrib} repository. @node Progress Logging @@ -4879,23 +4871,23 @@ the module @samp{org-depend.el} in the @samp{org-contrib} repository. @cindex progress logging @cindex logging, of progress -To record a timestamp and a note when changing a TODO state, call the +To record a timestamp and a note when changing a TODO state@comma{} 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}. +Prompt for a note and record the time of the TODO state change. +The note is inserted as a list item below the headline@comma{} but can also +be placed into a drawer@comma{} 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 +If you want to be more systematic@comma{} Org mode can automatically record a +timestamp and optionally a note when you mark a TODO item as DONE@comma{} 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 +highly configurable@comma{} 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}. +clock working time for a task@comma{} see @ref{Clocking Work Time}. @menu * Closing items:: When was this entry marked as done? @@ -4917,12 +4909,12 @@ corresponding in-buffer setting is: @samp{#+STARTUP: logdone}.} @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 +of the DONE states@comma{} 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 +through further state cycling@comma{} 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}}@comma{} for example)@comma{} that line is also removed@comma{} 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 +note along with the timestamp@comma{} use@footnote{ The corresponding in-buffer setting is: @samp{#+STARTUP: lognotedone}.} @lisp @@ -4930,7 +4922,7 @@ setting is: @samp{#+STARTUP: lognotedone}.} @end lisp @noindent -You are then prompted for a note, and that note is stored below the +You are then prompted for a note@comma{} and that note is stored below the entry with a @samp{Closing Note} heading. @node Tracking TODO state changes @@ -4943,10 +4935,10 @@ entry with a @samp{Closing Note} heading. @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 +record just a timestamp@comma{} or a time-stamped note. These records are +inserted after the headline as an itemized list@comma{} the newest first@footnote{ +See the variable @code{org-log-states-order-reversed}.}. When taking a lot +of notes@comma{} 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 @@ -4955,11 +4947,11 @@ pressing @kbd{@key{SPC}} in the agenda to show an entry---use 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 +Since it is normally too much to record a note for every state@comma{} 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 +example@comma{} with the setting @lisp (setq org-todo-keywords @@ -4967,20 +4959,20 @@ example, with the setting @end lisp @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}, +You not only define global TODO keywords and fast access keys@comma{} but +also request that a time is recorded when the entry is set to @samp{DONE}@comma{} 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 +are using both @code{org-log-done} and state change logging. However@comma{} it +never prompts for two notes: if you have configured both@comma{} 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 +entering the state@comma{} a timestamp should be recorded when @emph{leaving} the +@samp{WAIT} state@comma{} 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 +@samp{WAIT} to @samp{DONE}@comma{} because @samp{DONE} is configured to record only a +timestamp. But when switching from @samp{WAIT} back to @samp{TODO}@comma{} 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 @@ -4990,16 +4982,15 @@ to a buffer: #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) @end example - 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. +@samp{@@}@comma{} just type @kbd{C-c C-c} to enter a blank note when prompted. @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 +a single item@comma{} 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 +keywords like @samp{lognotedone} or @samp{logrepeat}@comma{} as well as adding state specific settings like @samp{TODO(!)}. For example: @example @@ -5007,7 +4998,7 @@ specific settings like @samp{TODO(!)}. For example: :PROPERTIES: :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) :END: -* TODO Only log when switching to WAIT, and when repeating +* TODO Only log when switching to WAIT@comma{} and when repeating :PROPERTIES: :LOGGING: WAIT(@@) logrepeat :END: @@ -5024,39 +5015,39 @@ specific settings like @samp{TODO(!)}. For example: @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{habit} +TODO@comma{} called ``habits.'' To use habits@comma{} you have to enable the @code{habit} 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 +The habit is a TODO item@comma{} 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 +The TODO has a scheduled date@comma{} usually with a @samp{.+} style repeat interval. A @samp{++} style may be appropriate for habits with time -constraints, e.g., must be done on specific days of week (@samp{++1w}), -or a @samp{+} style for an unusual habit that can have a backlog, e.g., +constraints@comma{} e.g.@comma{} must be done on specific days of week (@samp{++1w})@comma{} +or a @samp{+} style for an unusual habit that can have a backlog@comma{} e.g.@comma{} weekly reports. See @ref{Repeated tasks} for more details about repeat intervals. @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. +using the syntax @samp{.+2d/3d}@comma{} which says that you want to do the task +at least every three days@comma{} but@comma{} at most@comma{} 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, +State logging for the DONE state is enabled (see @ref{Tracking TODO state changes})@comma{} in order for historical data to be represented in +the consistency graph. If it is not enabled it is not an error@comma{} 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 +To give you an idea of what the above rules look like in action@comma{} here's an actual habit with some history: @example @@ -5078,17 +5069,17 @@ actual habit with some history: - 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 +What this habit says is: I want to shave@comma{} at most@comma{} 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 +4 days. If today is the 15th@comma{} then the habit first appears in the +agenda (see @ref{Agenda Views}) on Oct 17@comma{} after the minimum of 2 days has +elapsed@comma{} and will appear overdue on Oct 19@comma{} 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 +with a consistency graph@comma{} 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 task was done over the past three weeks@comma{} with colors for each day. The colors used are: @table @asis @@ -5102,8 +5093,8 @@ If the task was going to be overdue the next day. 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 +In addition to coloring each day@comma{} the day is also marked with an +asterisk if the task was actually done that day@comma{} 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 @@ -5113,12 +5104,12 @@ the way habits are displayed in the agenda. @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 +This overwrites any text in that column@comma{} 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 +The amount of history@comma{} in days before today@comma{} to appear in consistency graphs. @item @code{org-habit-following-days} @@ -5127,15 +5118,15 @@ 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 +If non-@code{nil}@comma{} 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 +Lastly@comma{} 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 +again to bring them back. They are also subject to tag filtering@comma{} if +you have habits which should only be done in certain contexts@comma{} for example. @node Priorities @@ -5144,48 +5135,46 @@ example. @cindex priorities @cindex priority cookie -If you use Org mode extensively, you may end up with enough TODO items +If you use Org mode extensively@comma{} 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: +right after the TODO keyword@comma{} 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}. +By default@comma{} Org mode supports three priorities: @samp{A}@comma{} @samp{B}@comma{} 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 +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}, +agenda@comma{} they have no inherent meaning to Org mode. The cookies are +displayed with the face defined by the variable @code{org-priority-faces}@comma{} which can be customized. -You can also use numeric values for priorities, such as +You can also use numeric values for priorities@comma{} such as @example *** TODO [#1] Write letter to Sam Fortune @end example +When using numeric priorities@comma{} you need to set @code{org-priority-highest}@comma{} +@code{org-priority-lowest} and @code{org-priority-default} to integers@comma{} which +must all be a non-negative integer between 0 and 64@comma{} inclusive. -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 +Priorities can be attached to any heading; they do not need to be TODO items. @table @asis -@item @kbd{C-c ,} (@code{org-priority}) +@item @kbd{C-c @comma{}} (@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 +a priority character @samp{A}@comma{} @samp{B} or @samp{C}. When you press @kbd{@key{SPC}} +instead@comma{} the priority cookie@comma{} if one is set@comma{} is removed from the headline. The priorities can also be changed ``remotely'' from the -agenda buffer with the @kbd{,} command (see @ref{Agenda Commands}). +agenda buffer with the @kbd{@comma{}} command (see @ref{Agenda Commands}). @item @kbd{S-@key{UP}} (@code{org-priority-up}) @itemx @kbd{S-@key{DOWN}} (@code{org-priority-down}) @@ -5196,7 +5185,7 @@ agenda buffer with the @kbd{,} command (see @ref{Agenda Commands}). @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}, +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 @@ -5204,9 +5193,11 @@ for a discussion of the interaction with shift-selection. @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 +variables @code{org-priority-highest}@comma{} @code{org-priority-lowest}@comma{} and +@code{org-priority-default}. Valid priority values are single uppercase +Latin alphabetical characters A-Z@comma{} and non-negative integers in between 0 +and 64@comma{} inclusive. For an individual buffer@comma{} you may set these values +(highest@comma{} lowest@comma{} default) like this (please make sure that the highest priority is earlier in the alphabet than the lowest priority): @cindex @samp{PRIORITIES}, keyword @@ -5214,8 +5205,7 @@ highest priority is earlier in the alphabet than the lowest priority): #+PRIORITIES: A C B @end example - -Or, using numeric values: +Or@comma{} using numeric values: @example #+PRIORITIES: 1 10 5 @@ -5228,14 +5218,14 @@ Or, using numeric values: @cindex statistics, for TODO items @vindex org-agenda-todo-list-sublevels -It is often advisable to break down large tasks into smaller, +It is often advisable to break down large tasks into smaller@comma{} 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 +below a TODO item@comma{} with detailed subtasks on the tree@footnote{ To keep +subtasks out of the global TODO list@comma{} 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 +fraction of subtasks that have already been marked as done@comma{} 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 +updated each time the TODO status of a child changes@comma{} or when pressing @kbd{C-c C-c} on the cookie. For example: @example @@ -5248,14 +5238,14 @@ updated each time the TODO status of a child changes, or when pressing @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 +If a heading has both checkboxes and TODO children below it@comma{} the +meaning of the statistics cookie becomes 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, +in the subtree (not just direct children)@comma{} configure the variable +@code{org-hierarchical-todo-statistics}. To do this for a single subtree@comma{} include the word @samp{recursive} into the value of the @samp{COOKIE_DATA} property. @@ -5267,11 +5257,11 @@ property. @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: +all children are done@comma{} 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." + "Switch entry to DONE when all subentries are done@comma{} to TODO otherwise." (let (org-log-done org-todo-log-states) ; turn off logging (org-todo (if (= n-not-done 0) "DONE" "TODO")))) @@ -5279,7 +5269,7 @@ all children are done, you can use the following setup: @end lisp Another possibility is the use of checkboxes to identify (a hierarchy -of) a large number of subtasks (see @ref{Checkboxes}). +of) subtasks (see @ref{Checkboxes}). @node Checkboxes @section Checkboxes @@ -5287,11 +5277,11 @@ of) a large number of subtasks (see @ref{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 +Every item in a plain list@footnote{Except for 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 +similar to TODO items (see @ref{TODO Items})@comma{} but is more lightweight. +Checkboxes are not included in the global TODO list@comma{} so they are often great to split a task into a number of simple steps. Or you can use them in a shopping list. @@ -5313,29 +5303,29 @@ Here is an example of a checkbox list. @cindex @samp{COOKIE_DATA}, property @vindex org-checkbox-hierarchical-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 +indicating how many of the checkboxes present in this entry have been checked +off@comma{} and the total number of checkboxes present. This can give you an +idea of how many checkboxes remain@comma{} 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-checkbox-hierarchical-statistics} -if you want such cookies to count all checkboxes below the cookie, not +if you want such cookies to count all checkboxes below the cookie@comma{} 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 +an @samp{n out of m} result@comma{} 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. +example@comma{} this would be @samp{[50%]} and @samp{[33%]}@comma{} respectively). In a +headline@comma{} a cookie can count either checkboxes below the heading or +TODO states of children@comma{} 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 +If the current heading has an @samp{ORDERED} property@comma{} checkboxes must +be checked off in sequence@comma{} and an error is thrown if you try to check off a box while there are unchecked boxes above it. A checkbox can be in one of the three states: @@ -5348,26 +5338,26 @@ partially checked @samp{[-]} checked @samp{[X]} @end enumerate -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 +Checkboxes work hierarchically@comma{} so if a checkbox item has children +that are checkboxes@comma{} toggling one of the children checkboxes makes the +parent checkbox reflect if none@comma{} some@comma{} or all of the children are checked. -If all child checkboxes are not checked, the parent checkbox is also not checked. +If all child checkboxes are not checked@comma{} the parent checkbox is also not checked. @example - [ ] call people - [ ] Peter - [ ] Sarah @end example -If some but not all child checkboxes are checked, the parent checkbox is partially checked. +If some but not all child checkboxes are checked@comma{} the parent checkbox is partially checked. @example - [-] call people - [X] Peter - [ ] Sarah @end example -If all child checkboxes are checked, the parent checkbox is also checked. +If all child checkboxes are checked@comma{} the parent checkbox is also checked. @example - [X] call people - [X] Peter @@ -5381,31 +5371,31 @@ The following commands work with checkboxes: @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 +at point. With a single prefix argument@comma{} 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 +list.}. With a double prefix argument@comma{} set it to @samp{[-]}@comma{} 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 +at point. With double prefix argument@comma{} set it to @samp{[-]}@comma{} which is considered to be an intermediate state. @itemize @item -If there is an active region, toggle the first checkbox in the +If there is an active region@comma{} 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 +first. With a prefix argument@comma{} add or remove the checkbox for all items in the region. @item -If point is in a headline, toggle checkboxes in the region between +If point is in a headline@comma{} 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. +If there is no active region@comma{} just toggle the checkbox at point. @end itemize @item @kbd{C-c C-x C-r} (@code{org-toggle-radio-button}) @@ -5413,10 +5403,10 @@ If there is no active region, just toggle the checkbox at point. @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 +a radio button: when the checkbox is turned on@comma{} 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{[-]}. +argument@comma{} toggle the presence of the checkbox. With a double prefix +argument@comma{} 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 @@ -5433,23 +5423,23 @@ already in a plain list item (see @ref{Plain Lists}). @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 +Toggle the @samp{ORDERED} property of the entry@comma{} 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 +behavior because this should be local to the current entry@comma{} not +inherited like a tag. However@comma{} if you would like to @emph{track} the +value of this property with a tag for better visibility@comma{} 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. +called with a @kbd{C-u} prefix@comma{} 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. +hand@comma{} use this command to get things back into sync. @end table @node Tags @@ -5466,13 +5456,13 @@ 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}). +the headline. Tags are normal words containing letters@comma{} numbers@comma{} @samp{_}@comma{} +@samp{@@}@comma{} @samp{#}@comma{} and @samp{%}. Tags must be preceded and followed by a single +colon@comma{} e.g.@comma{} @samp{:work:}. Several tags can be specified@comma{} 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}@comma{} 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. @@ -5489,8 +5479,8 @@ may specify special faces for specific tags using the variable @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 +a heading has a certain tag@comma{} all subheadings inherit the tag as well. +For example@comma{} in the list @example * Meeting with the French group :work: @@ -5499,12 +5489,12 @@ For example, in the list @end example @noindent -the final heading has the tags @samp{work}, @samp{boss}, @samp{notes}, and @samp{action} +the final heading has the tags @samp{work}@comma{} @samp{boss}@comma{} @samp{notes}@comma{} 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 +these in-buffer settings@comma{} pressing @kbd{C-c C-c} activates any changes in the line.} @cindex @samp{FILETAGS}, keyword @@ -5512,21 +5502,20 @@ changes in the line.} #+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, +To limit tag inheritance to specific tags@comma{} or to turn it off entirely@comma{} use the variables @code{org-use-tag-inheritance} and @code{org-tags-exclude-from-inheritance}. @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 +a tag@comma{} either in the @code{tags} or @code{tags-todo} agenda types. In other +agenda types@comma{} @code{org-use-tag-inheritance} has no effect. Still@comma{} you may +want to have your tags correctly set in the agenda@comma{} so that tag +filtering works fine@comma{} 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 +includes all agenda types@comma{} but setting this to @code{nil} can really speed up agenda generation. @node Setting Tags @@ -5537,7 +5526,7 @@ up agenda generation. @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 +After a colon@comma{} @kbd{M-@key{TAB}} offers completion on tags. There is also a special command for inserting tags: @table @asis @@ -5547,29 +5536,29 @@ also a special command for inserting tags: @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 +completion or a special single-key interface for setting tags@comma{} see +below. After pressing @kbd{@key{RET}}@comma{} 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, +prefix@comma{} all tags in the current buffer are aligned to that column@comma{} just to make things look nice. Tags are automatically realigned -after promotion, demotion, and TODO state changes (see @ref{TODO Basics}). +after promotion@comma{} demotion@comma{} 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}. +When point is in a headline@comma{} 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 +Org supports tag insertion based on a @emph{list of tags}. By default@comma{} this +list is constructed dynamically@comma{} 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 +agenda files (see @ref{Agenda Views})@comma{} 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 +@code{org-tag-alist}. Finally@comma{} you can set the default tags for a given +file using the @samp{TAGS} keyword@comma{} like @example #+TAGS: @@work @@home @@tennisclub @@ -5577,18 +5566,17 @@ file using the @samp{TAGS} keyword, like @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: +variable @code{org-tag-alist}@comma{} but would like to use a dynamic tag list in +a specific file@comma{} 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 +every file@comma{} in addition to those defined on a per-file basis by @samp{TAGS} +keyword@comma{} 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: @@ -5596,14 +5584,13 @@ by adding a @samp{STARTUP} keyword to that file: #+STARTUP: noptag @end example - -By default Org mode uses the standard minibuffer completion facilities -for entering tags. However, it also implements another, quicker, tag +By default@comma{} Org mode uses the standard minibuffer completion facilities +for entering tags. However@comma{} it also implements another@comma{} quicker@comma{} 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 +@code{org-tag-alist} in your Emacs init file. For example@comma{} you may find the need to tag many items in different files with @samp{@@home}. In this case you can set something like: @@ -5611,23 +5598,21 @@ case you can set something like: (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 +If the tag is only relevant to the file you are working on@comma{} 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 +you want to start a new line after a specific tag@comma{} 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: @@ -5637,23 +5622,22 @@ or write them in two lines: @end example You can also group together tags that are mutually exclusive by using -braces, as in: +braces@comma{} 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} +you indicate that at most one of @samp{@@work}@comma{} @samp{@@home}@comma{} 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} +@code{org-tags-alist}@comma{} you must use the dummy tags @code{:startgroup} and +@code{:endgroup} instead of the braces. Similarly@comma{} you can use @code{:newline} to indicate a line break. The previous example would be set globally by the following configuration: @@ -5665,8 +5649,8 @@ by the following configuration: ("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 +If at least one tag has a selection key then pressing @kbd{C-c C-c} automatically presents you with a special interface@comma{} listing +inherited tags@comma{} the tags of the current headline@comma{} and a list of all valid tags with corresponding keys@footnote{ Keys are automatically assigned to tags that have no configured keys.}. @@ -5674,12 +5658,12 @@ 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: +In this interface@comma{} 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 +Enter a tag in the minibuffer@comma{} even if the tag is not in the predefined list. You can complete on all tags present in the buffer and globally pre-defined tags from @code{org-tag-alist} and @code{org-tag-persistent-alist}. You can also add several tags: just @@ -5699,7 +5683,7 @@ Abort without installing changes. @item @kbd{q} @kindex q -If @kbd{q} is not assigned to a tag, it aborts like +If @kbd{q} is not assigned to a tag@comma{} it aborts like @kbd{C-g}. @item @kbd{!} @@ -5710,13 +5694,13 @@ 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 +using expert mode@comma{} 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: +With the above setup@comma{} you could clear the current tags and set +@samp{@@home}@comma{} @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 @@ -5724,14 +5708,14 @@ 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 +modify your list of tags@comma{} 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} +change. If you then occasionally need more keys@comma{} 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 +@kbd{C-c C-c}). If you set the variable to the value @code{expert}@comma{} +the special window is not even shown for single-key tag selection@comma{} it comes up only when you press an extra @kbd{C-c}. @vindex org-fast-tag-selection-maximum-tags @@ -5754,9 +5738,9 @@ 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 +When you search for a group tag@comma{} it returns matches for all members in +the group and its subgroups. In an agenda view@comma{} filtering by a group +tag displays or hides 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. @@ -5768,9 +5752,8 @@ mandatory so that Org can parse this line correctly: #+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 +In this example@comma{} @samp{GTD} is the group tag@comma{} and it is related to two other +tags: @samp{Control}@comma{} @samp{Persp}. Defining @samp{Control} and @samp{Persp} as group tags creates a hierarchy of tags: @example @@ -5807,7 +5790,7 @@ That can conceptually be seen as a hierarchy of tags: @end itemize @end itemize -You can use the @code{:startgrouptag}, @code{:grouptags} and @code{:endgrouptag} +You can use the @code{:startgrouptag}@comma{} @code{:grouptags} and @code{:endgrouptag} keyword directly when setting @code{org-tag-alist} directly: @lisp @@ -5833,13 +5816,12 @@ curly brackets. #+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 +Furthermore@comma{} the members of a group tag can also be regular +expressions@comma{} creating the possibility of a more dynamic and rule-based tag structure (see @ref{Regular Expressions}). The regular expressions in the group must be specified within curly brackets. Here is an expanded example: @@ -5852,17 +5834,17 @@ expanded example: @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., +regular expression matches for @samp{P@@.+}@comma{} and similarly for tag searches +on @samp{Vision}@comma{} @samp{Goal} and @samp{AOF}. For example@comma{} this would work well for +a project tagged with a common project-identifier@comma{} e.g.@comma{} @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 +If you want to ignore group tags temporarily@comma{} toggle group tags +support with @code{org-toggle-tags-groups}@comma{} bound to @kbd{C-c C-x q}. +If you want to disable tag groups completely@comma{} set @code{org-group-tags} to @code{nil}. @node Tag Searches @@ -5871,7 +5853,7 @@ If you want to disable tag groups completely, set @code{org-group-tags} to @cindex tag searches @cindex searching for tags -Once a system of tags has been set up, it can be used to collect +Once a system of tags has been set up@comma{} it can be used to collect related information into special lists. @table @asis @@ -5880,7 +5862,7 @@ related information into special lists. @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 +With a @kbd{C-u} prefix argument@comma{} ignore headlines that are not a TODO line. @item @kbd{M-x org-agenda m} (@code{org-tags-view}) @@ -5891,17 +5873,17 @@ Create a global list of tag matches from all agenda files. See @item @kbd{M-x org-agenda M} (@code{org-tags-view}) @kindex M @r{(Agenda dispatcher)} -Create a global list of tag matches from all agenda files, but check +Create a global list of tag matches from all agenda files@comma{} but check only TODO items. @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}. +Boolean logic@comma{} such as @samp{+boss+urgent-project1} to find entries with +tags @samp{boss} and @samp{urgent}@comma{} but not @samp{project1} or @samp{Kathy|Sally} to find +entries tagged with either @samp{Kathy} or @samp{Sally}. The full syntax of the +search string is rich and allows also matching against TODO keywords@comma{} +entry levels and properties. For a complete description with many +examples@comma{} see @ref{Matching tags and properties}. @node Properties and Columns @chapter Properties and Columns @@ -5909,19 +5891,19 @@ with many examples, see @ref{Matching tags and properties}. @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. +can be set@comma{} so they are associated with a single entry@comma{} with every +entry in a tree@comma{} 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 +There are two main applications for properties in Org mode. First@comma{} +properties are like tags@comma{} 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 +software. Instead of using tags like @samp{release_1}@comma{} @samp{release_2}@comma{} you +can use a property@comma{} say @samp{Release}@comma{} that in different subtrees has +different values@comma{} such as @samp{1.0} or @samp{2.0}. Second@comma{} 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. +buffer. Imagine keeping track of your music CDs@comma{} where properties +could be things such as the album@comma{} artist@comma{} date of release@comma{} number of +tracks@comma{} and so on. Properties can be conveniently edited and viewed in column view (see @ref{Column View}). @@ -5942,9 +5924,9 @@ Properties can be conveniently edited and viewed in column view (see 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 +drawer (see @ref{Drawers}) with the name @samp{PROPERTIES}@comma{} which has to be +located right below a headline@comma{} and its planning line (see @ref{Deadlines and Scheduling}) when applicable. Each property is specified on +a single line@comma{} with the key---surrounded by colons---first@comma{} and the value after it. Keys are case-insensitive. Here is an example: @example @@ -5960,16 +5942,16 @@ value after it. Keys are case-insensitive. Here is an example: :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 -subtree defined by the entry, see @ref{Property Inheritance}. +Depending on the value of @code{org-use-property-inheritance}@comma{} a property +set this way is associated either with a single entry@comma{} or with the +subtree defined by the entry@comma{} 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 +setting a property @samp{Xyz_ALL}. This special property is @emph{inherited}@comma{} +so if you set it in a level 1 entry@comma{} it applies to the entire tree. +When allowed values are defined@comma{} 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 +with the CD collection@comma{} we can pre-define publishers and the number of disks in a box like this: @example @@ -5993,20 +5975,20 @@ Properties can also be defined using lines like: #+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{+} +If you want to add to the value of an existing property@comma{} append a @samp{+} to the property name. The following results in the property @samp{var} -having the value @samp{foo=1 bar=2}. +having the values @samp{foo} and @samp{bar}. @example -#+PROPERTY: var foo=1 -#+PROPERTY: var+ bar=2 +#+PROPERTY: var foo +#+PROPERTY: var+ bar @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. +Using the appended @samp{+}@comma{} it is also possible to add to the values of +inherited properties. The following results in the @samp{Genres} property +having the values @samp{Classic}@comma{} @samp{Baroque}@comma{} and @samp{Keyboard music} under the +@samp{Goldberg Variations} subtree. @example * CD collection @@ -6022,10 +6004,13 @@ Baroque} under the @samp{Goldberg Variations} subtree. :Publisher: Deutsche Grammophon :NDisks: 1 :Genres+: Baroque + :Genres+: Keyboard music :END: @end example -Note that a property can only have one entry per drawer. +Note that a property can only have multiple entries per drawer when +used with the appended @samp{+}. When a property has multiple entries +without @samp{+}@comma{} the result is undefined. @vindex org-global-properties Property values set with the global variable @code{org-global-properties} @@ -6037,26 +6022,26 @@ The following commands help to work with properties: @item @kbd{M-@key{TAB}} (@code{pcomplete}) @kindex M-TAB @findex pcomplete -After an initial colon in a line, complete property keys. All keys +After an initial colon in a line@comma{} 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. +necessary@comma{} 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 +inserted early in the entry@comma{} 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. +With point in a property drawer@comma{} this executes property commands. @item @kbd{C-c C-c s} (@code{org-set-property}) @kindex C-c C-c s @@ -6064,8 +6049,7 @@ With point in a property drawer, this executes property commands. 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-value}) -@itemx @kbd{S-@key{LEFT}} (@code{org-property-previous-allowed-value}) +@item @kbd{S-@key{RIGHT}} (@code{org-property-next-allowed-value})@comma{} @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. @@ -6078,12 +6062,12 @@ 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. +Globally remove a property@comma{} 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 +Compute the property at point@comma{} using the operator and scope from the nearest column format definition. @end table @@ -6093,9 +6077,9 @@ nearest column format definition. @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 +features@comma{} like the TODO state or the priority of an entry@comma{} 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 +include these states in a column view (see @ref{Column View})@comma{} or to use them in queries. The following property names are special and should not be used as keys in the properties drawer: @@ -6115,7 +6099,7 @@ not be used as keys in the properties drawer: @cindex @samp{TODO}, special property @multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{ALLTAGS} -@tab All tags, including inherited ones. +@tab All tags@comma{} including inherited ones. @item @samp{BLOCKED} @tab @code{t} if task is currently blocked by children or siblings. @item @samp{CATEGORY} @@ -6139,14 +6123,14 @@ not be used as keys in the properties drawer: @item @samp{ITEM} @tab The headline of the entry. @item @samp{PRIORITY} -@tab The priority of the entry, a string with a single letter. +@tab The priority of the entry@comma{} 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 active keyword-less timestamp in the entry.@footnote{For both @samp{TIMESTAMP} and @samp{TIMESTAMP_IA}: the word ``first'' -refers to the first occurrence in the entry, not the earliest in time; +refers to the first occurrence in the entry@comma{} not the earliest in time; the prefix @samp{CLOCK:} at the beginning of a clock entry is considered a keyword in this context; and timestamps inside property drawers are ignored.} @@ -6163,7 +6147,7 @@ ignored.} @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}). +properties@comma{} 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}) @@ -6171,7 +6155,7 @@ properties, the same commands are used as for tag searches (see @ref{Tag Searche @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 @kbd{C-u} prefix argument@comma{} ignore headlines that are not a TODO line. @item @kbd{M-x org-agenda m} (@code{org-tags-view}) @@ -6181,7 +6165,7 @@ 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)} -Create a global list of tag matches from all agenda files, but check +Create a global list of tag matches from all agenda files@comma{} but check only TODO items. @end table @@ -6194,9 +6178,9 @@ single property: @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 +prompts for the name of a property@comma{} 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 +given value. If you enclose the value in curly braces@comma{} it is interpreted as a regular expression and matched against the property values (see @ref{Regular Expressions}). @end table @@ -6209,19 +6193,19 @@ values (see @ref{Regular Expressions}). @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, +model of properties: if the parent in a tree has a certain property@comma{} 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 +on by default@comma{} because it can slow down property searches +significantly and is often not needed. However@comma{} if you find +inheritance useful@comma{} 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 +properties inherited from the parent@comma{} to a list of properties that +should be inherited@comma{} or to a regular expression that matches inherited +properties. If a property has the value @code{nil}@comma{} this is interpreted as +an explicit un-define of the property@comma{} 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 +Org mode has a few properties for which inheritance is hard-coded@comma{} at least for the special applications for which they are used: @table @asis @@ -6230,17 +6214,17 @@ least for the special applications for which they are used: 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 +a column view table@comma{} 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 +For agenda view@comma{} 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 +For archiving@comma{} the @samp{ARCHIVE} property may define the archive location for the entire subtree (see @ref{Moving subtrees}). @item @code{LOGGING} @@ -6253,18 +6237,18 @@ a subtree (see @ref{Tracking TODO state changes}). @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. +view}. In column view@comma{} each heading 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 +a table row@comma{} you can still change the visibility of the outline tree. +For example@comma{} you get a compact table by switching to ``contents'' +view---@kbd{S-@key{TAB}} @kbd{S-@key{TAB}}@comma{} or simply @kbd{c} +while column view is active---but you can still open@comma{} read@comma{} and edit +the entry below each headline. Or@comma{} 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 +@ref{Agenda Views}) where queries have collected selected items@comma{} possibly from a number of files. @menu @@ -6290,8 +6274,8 @@ done by defining a column format line. @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: +To specify a format that only applies to a specific tree@comma{} add +a @samp{COLUMNS} property to the top node of that tree@comma{} for example: @example ** Top node for columns view @@ -6301,7 +6285,7 @@ a @samp{COLUMNS} property to the top node of that tree, for example: @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, +will apply to the entire file. As an addition to property drawers@comma{} keywords can also be defined for an entire file using a line like: @cindex @samp{COLUMNS}, keyword @@ -6309,12 +6293,11 @@ keywords can also be defined for an entire file using a line like: #+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 +If a @samp{COLUMNS} property is present in an entry@comma{} it defines columns for +the entry itself@comma{} 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 +document@comma{} you can define columns on level 1 that are general enough +for all sublevels@comma{} and more specific columns further down@comma{} when you edit a deeper part of the tree. @node Column attributes @@ -6327,30 +6310,41 @@ definition looks like this: %[WIDTH]PROPERTY[(TITLE)][@{SUMMARY-TYPE@}] @end example - @noindent -Except for the percent sign and the property name, all items are +Except for the percent sign and the property name@comma{} 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. +omitted@comma{} 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 +properties representing metadata are allowed here as well (see @ref{Special Properties}). @item @var{TITLE} -The header text for the column. If omitted, the property name is +The header text for the column. If omitted@comma{} 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.}. +The summary type. If specified@comma{} the column values for parent +headings are computed from the direct children. If there is any +existing property defined for the parent nodes@comma{} it is not used in +the calculations. + +When there is an existing property in parent heading@comma{} Org does not +only overlay the computed value in the column view@comma{} but also +overwrites the property value in parent's property drawer@footnote{ If +more than column definition is requested for the same property@comma{} only +the first definition will trigger writing to the property drawer. +For example@comma{} @samp{%EFFORT@{mean@} %EFFORT(Sum)@{:@}} will write the mean +value of @samp{EFFORT} property; not the sum. If the first column +definition does not have summary type (@samp{%EFFORT %EFFORT@{mean@}})@comma{} +nothing will be written to the property drawer}. + +Summary type is ignored for special properties. Supported summary types are: @@ -6358,9 +6352,9 @@ Supported summary types are: @item @samp{+} @tab Sum numbers in this column. @item @samp{+;%.1f} -@tab Like @samp{+}, but format result with @samp{%.1f}. +@tab Like @samp{+}@comma{} but format result with @samp{%.1f}. @item @samp{$} -@tab Currency, short for @samp{+;%.2f}. +@tab Currency@comma{} short for @samp{+;%.2f}. @item @samp{min} @tab Smallest number in column. @item @samp{max} @@ -6368,13 +6362,13 @@ Supported summary types are: @item @samp{mean} @tab Arithmetic mean of numbers. @item @samp{X} -@tab Checkbox status, @samp{[X]} if all children are @samp{[X]}. +@tab Checkbox status@comma{} @samp{[X]} if all children are @samp{[X]}. @item @samp{X/} -@tab Checkbox status, @samp{[n/m]}. +@tab Checkbox status@comma{} @samp{[n/m]}. @item @samp{X%} -@tab Checkbox status, @samp{[n%]}. +@tab Checkbox status@comma{} @samp{[n%]}. @item @samp{:} -@tab Sum times, HH:MM, plain numbers are minutes. +@tab Sum times@comma{} HH:MM@comma{} plain numbers are minutes. @item @samp{:min} @tab Smallest time value in column. @item @samp{:max} @@ -6382,9 +6376,9 @@ Supported summary types are: @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). +@tab Minimum age@footnote{An age can be defined as a duration@comma{} using units defined in +@code{org-duration-units}@comma{} e.g.@comma{} @samp{3d 1h}. If any value in the column is as +such@comma{} 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} @@ -6399,51 +6393,101 @@ You can also define custom summary types by setting @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 +combining estimates@comma{} expressed as low-high ranges. For example@comma{} +instead of estimating a particular task will take 5 days@comma{} 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 +work is required@comma{} or 1--10 days if you do not really know what needs +to be done. Both ranges average at 5.5 days@comma{} 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 +When combining a set of such estimates@comma{} simply adding the lows and +highs produces an unrealistically wide result. Instead@comma{} @samp{est+} adds +the statistical mean and variance of the subtasks@comma{} generating a final +estimate from the sum. For example@comma{} suppose you had ten tasks@comma{} 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 +produces an estimate of 5 to 20 days@comma{} 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 +contrast@comma{} @samp{est+} estimates the full job more realistically@comma{} at 10--15 days. -Here is an example for a complete columns definition, along with +Here is an example for a complete columns definition@comma{} 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 + %10Time_Estimate@{:@} :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 +The first column@comma{} @samp{%25ITEM}@comma{} means the first 25 characters of the item +itself@comma{} i.e.@comma{} 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 +create columns @samp{Owner} with a list of names as allowed values@comma{} for +@samp{Status} with four different possible values@comma{} and for a checkbox field +@samp{Approved}. When no width is given after the @samp{%} character@comma{} 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. +(@samp{Approved?}@comma{} with a question mark). Summaries are created for the +@samp{Time_Estimate} column by adding time duration expressions like HH:MM@comma{} +and for the @samp{Approved} column@comma{} by providing an @samp{[X]} status if all +children have been checked. + +The @samp{CLOCKSUM} and @samp{CLOCKSUM_T} column properties are special@comma{} they +list the sums of @samp{CLOCK:} intervals in the subtree@comma{} either for all +clocks (@samp{CLOCKSUM}) or just for today (@samp{CLOCKSUM_T}). Unlike @samp{:} +summary type that ignores property values in parent headings@comma{} all the +@samp{CLOCK:} intervals are summed up@comma{} including @samp{CLOCK:} lines within +parent headings. + +@enumerate +@item +@anchor{Summaries in deeply nested hierarchy}Summaries in deeply nested hierarchy + + +When computing summaries of deeply nested headings@comma{} the summaries are +computed recursively@comma{} from the deepest level to the shallowest. Here +is an example: + +@example +#+BEGIN: columnview :indent t :format "%ITEM %EFFORT@{:mean@}" :id global +| ITEM | EFFORT | +|--------------------+---------| +| Top level | 3h 0min | +| \_ Intermediate 1 | 1h 0min | +| \_ Leaf 1 | 1h | +| \_ Leaf 2 | 1h | +| \_ Leaf 3 | 1h | +| \_ Intermediate 2 | 5h | +#+END: + +* Top level +** Intermediate 1 +:PROPERTIES: +:EFFORT: *unused*@comma{} will be set to 1h 0min (mean of the leaf nodes) +:END: +***** Leaf 1 +:PROPERTIES: +:EFFORT: 1h +:END: +*** Leaf 2 +:PROPERTIES: +:EFFORT: 1h +:END: +*** Leaf 3 +:PROPERTIES: +:EFFORT: 1h +:END: +** Intermediate 2 +:PROPERTIES: +:EFFORT: 5h +:END: +@end example +@end enumerate @node Using column view @subsection Using column view @@ -6457,21 +6501,21 @@ either for all clocks or just for today. @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 +file@comma{} column view is turned on for the entire file@comma{} using the +@samp{#+COLUMNS} definition. If point is somewhere inside the outline@comma{} +this command searches the hierarchy@comma{} up from point@comma{} for a @samp{COLUMNS} +property that defines a format. When one is found@comma{} 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 +contains the @samp{COLUMNS} property. If no such property is found@comma{} 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 +@code{org-columns-default-format}@comma{} 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 +Recreate the column view@comma{} 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}) @@ -6485,12 +6529,12 @@ Exit column view. @subsubheading Editing values @table @asis -@item @kbd{@key{LEFT}}, @kbd{@key{RIGHT}}, @kbd{@key{UP}}, @kbd{@key{DOWN}} +@item @kbd{@key{LEFT}}@comma{} @kbd{@key{RIGHT}}@comma{} @kbd{@key{UP}}@comma{} @kbd{@key{DOWN}} Move through the column view from field to field. -@item @kbd{1..9,0} +@item @kbd{1..9@comma{}0} @kindex 1..9,0 -Directly select the Nth allowed value, @kbd{0} selects the +Directly select the Nth allowed value@comma{} @kbd{0} selects the 10th value. @item @kbd{n} or @kbd{S-@key{RIGHT}} (@code{org-columns-next-allowed-value}) @@ -6501,21 +6545,21 @@ Directly select the Nth allowed value, @kbd{0} selects the @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, +Switch to the next/previous allowed value of the field. For this@comma{} 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 +Edit the property at point. For the special properties@comma{} this invokes the same interface that you normally use to change that -property. For example, the tag completion or fast selection +property. For example@comma{} 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 +When there is a checkbox at point@comma{} toggle it. Else exit column view. @item @kbd{v} (@code{org-columns-show-value}) @@ -6528,8 +6572,8 @@ of the column is smaller than that of the value. @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 +found in the hierarchy@comma{} the modified values are stored there. If no +list is found@comma{} the new value is stored in the first entry that is part of the current column view. @end table @@ -6548,7 +6592,7 @@ 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. +Insert a new column@comma{} to the left of the current column. @item @kbd{S-M-@key{LEFT}} (@code{org-columns-delete}) @kindex S-M-LEFT @@ -6579,8 +6623,8 @@ Move the current row down. @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, +Since column view is just an overlay over a buffer@comma{} it cannot be +exported or printed directly. If you want to capture a column view@comma{} use a @samp{columnview} dynamic block (see @ref{Dynamic Blocks}). The frame of this block looks like this: @@ -6597,16 +6641,16 @@ 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 +is often localized to a certain (sub)tree@comma{} 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: +whose view to capture@comma{} 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. +Make a global view@comma{} including all headings in the file. @item @samp{file:FILENAME} Run column view at the top of the @var{FILENAME} file. @@ -6620,7 +6664,7 @@ the kill-ring. @end table @item @samp{:match} -When set to a string, use this as a tags/property match filter to +When set to a string@comma{} 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 @@ -6628,17 +6672,17 @@ parameter. @table @asis @item @samp{:hlines} -When @code{t}, insert an hline after every line. When a number N, insert +When @code{t}@comma{} insert an hline after every line. When a number N@comma{} insert an hline before each headline with level @code{<= N}. @item @samp{:vlines} -When non-@code{nil}, force column groups to get vertical lines. +When non-@code{nil}@comma{} force column groups to get vertical lines. @item @samp{:maxlevel} -When set to a number, do not capture entries below this level. +When set to a number@comma{} 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 +When non-@code{nil}@comma{} skip rows where the only non-empty specifier of the column view is @samp{ITEM}. @item @samp{:exclude-tags} @@ -6646,10 +6690,10 @@ 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. +When non-@code{nil}@comma{} indent each @samp{ITEM} field according to its level. @item @samp{:link} -When non-@code{nil}, link the @samp{ITEM} headlines in the table to their +When non-@code{nil}@comma{} link the @samp{ITEM} headlines in the table to their origins. @item @samp{:format} @@ -6686,21 +6730,21 @@ 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 +you have several clock table blocks@comma{} 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 +You can add formulas to the column view table@comma{} 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 +block. If there is a @samp{TBLFM} keyword after the table@comma{} 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 package -in @samp{org-contrib}@footnote{ Contributed packages are not part of Emacs, but +is provided by Eric Schulte's @samp{org-collector.el}@comma{} which is a package +in @samp{org-contrib}@footnote{ Contributed packages are not part of Emacs@comma{} 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 +properties from entries in a certain scope@comma{} and arbitrary Lisp expressions to process these values before inserting them into a table or a dynamic block. @@ -6712,15 +6756,15 @@ or a dynamic block. @cindex timestamp @cindex date stamp -To assist project planning, TODO items can be labeled with a date +To assist project planning@comma{} 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 +something was created or last changed. However@comma{} in Org mode this term is used in a much wider sense. -Timestamps can be used to plan appointments, schedule tasks, set -deadlines, track time, and more. The following sections describe +Timestamps can be used to plan appointments@comma{} schedule tasks@comma{} set +deadlines@comma{} track time@comma{} and more. The following sections describe the timestamp format and tooling that Org mode provides for common use cases dealing with time and time intervals. @@ -6743,10 +6787,10 @@ use cases dealing with time and time intervals. @cindex scheduling A timestamp is a specification of a date---possibly with a time or -time range---in a special format, either @samp{<2003-09-16 Tue>} or +time range---in a special format@comma{} 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 +date/time format. To use an alternative format@comma{} see @ref{Custom time format}. The day name is optional when you type the date yourself. +However@comma{} any date inserted or modified by Org adds that day name@comma{} 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 @@ -6758,7 +6802,7 @@ the agenda (see @ref{Weekly/daily agenda}). We distinguish: @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 +In the agenda display@comma{} the headline of an entry associated with a plain timestamp is shown exactly on that date. There can be multiple timestamps in an item. @@ -6774,9 +6818,9 @@ multiple timestamps in an item. @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 hours (h), days (d), weeks (w), months (m), +A timestamp may contain a @emph{repeater interval}@comma{} indicating that it +applies not only on the given date@comma{} but again and again after +a certain interval of N hours (h)@comma{} days (d)@comma{} weeks (w)@comma{} months (m)@comma{} or years (y). The following shows up in the agenda every Wednesday: @example @@ -6793,21 +6837,21 @@ or years (y). The following shows up in the agenda every Wednesday: @findex org-cyclic @findex org-block -For more complex date specifications, Org mode supports using the +For more complex date specifications@comma{} Org mode supports using the special expression diary entries implemented in the -@ref{Special Diary Entries,Emacs Calendar package,,emacs,}@footnote{When working with the standard diary expression functions, you +@ref{Special Diary Entries,Emacs Calendar package,,emacs,}@footnote{When working with the standard diary expression functions@comma{} 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 1, 2005, the call might look like +depends evilly on the variable @code{calendar-date-style}. For example@comma{} to +specify a date December 1@comma{} 2005@comma{} 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 +2005 12 1)}@comma{} depending on the settings. This has been the source of much confusion. Org mode users can resort to special versions of -these functions, namely @code{org-date}, @code{org-anniversary}, @code{org-cyclic}, and +these functions@comma{} namely @code{org-date}@comma{} @code{org-anniversary}@comma{} @code{org-cyclic}@comma{} and @code{org-block}. 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 +functions@comma{} but with stable ISO order of arguments (year@comma{} month@comma{} day) +wherever applicable@comma{} independent of the value of @code{calendar-date-style}.}. -For example, with optional time: +For example@comma{} with optional time: @example * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month @@ -6828,8 +6872,8 @@ Time range is a timestamp having two time units connected by @samp{-} @cindex time range @cindex timerange @cindex date range -Two timestamps connected by @samp{--} denote a range. In the agenda, the -headline is shown on the first and last day of the range, and on any +Two timestamps connected by @samp{--} denote a range. In the agenda@comma{} the +headline is shown on the first and last day of the range@comma{} and on any dates that are displayed and fall in the range. The first example specifies just the dates of the range while the second example specifies a time range for each date. @@ -6844,7 +6888,7 @@ specifies a time range for each date. @item Inactive timestamp @cindex timestamp, inactive @cindex inactive timestamp -Just like a plain timestamp, but with square brackets instead of +Just like a plain timestamp@comma{} 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. @@ -6857,7 +6901,7 @@ do @emph{not} trigger an entry to show up in the agenda. @node Creating Timestamps @section Creating Timestamps -For Org mode to recognize timestamps, they need to be in the specific +For Org mode to recognize timestamps@comma{} they need to be in the specific format. All commands listed below produce timestamps in the correct format. @@ -6867,20 +6911,19 @@ format. @findex org-time-stamp @findex org-timestamp Prompt for a date and insert a corresponding timestamp. When point -is at an existing timestamp in the buffer, the command is used to +is at an existing timestamp in the buffer@comma{} 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. +command is used twice in succession@comma{} a time range is inserted. @kindex C-u C-c . @vindex org-time-stamp-rounding-minutes -@vindex org-timestamp-rounding-minutes -When called with a prefix argument, use the alternative format which +When called with a prefix argument@comma{} 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-timestamp-rounding-minutes}. +@code{org-time-stamp-rounding-minutes}. @kindex C-u C-u C-c . -With two prefix arguments, insert an active timestamp with the +With two prefix arguments@comma{} insert an active timestamp with the current time without prompting. @item @kbd{C-c !} (@code{org-timestamp-inactive}) @@ -6889,12 +6932,12 @@ current time without prompting. @kindex C-u C-u C-c ! @findex org-time-stamp-inactive @findex org-timestamp-inactive -Like @kbd{C-c .}, but insert an inactive timestamp that does +Like @kbd{C-c .}@comma{} 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. +Normalize timestamp@comma{} insert or fix day name if missing or wrong. @item @kbd{C-c <} (@code{org-date-from-calendar}) @kindex C-c < @@ -6905,7 +6948,7 @@ Insert a timestamp corresponding to point date in the 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 +a timestamp in the current line@comma{} go to the corresponding date instead. @item @kbd{C-c C-o} (@code{org-open-at-point}) @@ -6914,8 +6957,7 @@ instead. 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}) +@item @kbd{S-@key{LEFT}} (@code{org-timestamp-down-day})@comma{} @kbd{S-@key{RIGHT}} (@code{org-timestamp-up-day}) @kindex S-LEFT @kindex S-RIGHT @findex org-timestamp-down-day @@ -6923,17 +6965,16 @@ point (see @ref{Weekly/daily agenda}). 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}) +@item @kbd{S-@key{UP}} (@code{org-timestamp-up})@comma{} @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 +On the beginning or enclosing bracket of a timestamp@comma{} change its +type. Within a timestamp@comma{} change the item under point. Point can +be on a year@comma{} month@comma{} day@comma{} hour or minute. When the timestamp +contains a time range like @samp{15:30-16:30}@comma{} modifying the first time +also shifts the second@comma{} shifting the time block with constant +length. To change the length@comma{} modify the second time. Note that if +point is in a headline and not at a timestamp@comma{} 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}). @@ -6942,7 +6983,7 @@ also conflict with shift-selection and related modes (see @ref{Conflicts}). @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 +end. With a prefix argument@comma{} insert result after the time range (in a table: into the following column). @end table @@ -6958,25 +6999,25 @@ a table: into the following column). @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 +When Org mode prompts for a date/time@comma{} the default is shown in default +date/time format@comma{} 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 +formats. Generally@comma{} 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 +time}. The default is usually the current date and time@comma{} but when +modifying an existing timestamp@comma{} or when entering the second stamp of +a range@comma{} it is taken from the stamp in the buffer. When filling in +information@comma{} 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 +day/month is @emph{before} today@comma{} 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)}. +future@comma{} 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 +For example@comma{} let's assume that today is @strong{June 13@comma{} 2006}. Here is how +various inputs are interpreted@comma{} the items filled in by Org mode are in @strong{bold}. @multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @@ -7010,14 +7051,14 @@ various inputs are interpreted, the items filled in by Org mode are in @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{h}, -@samp{d}, @samp{w}, @samp{m} or @samp{y}---to indicate a change in hours, days, weeks, -months, or years. With @samp{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.: +Furthermore@comma{} you can specify a relative date by giving@comma{} as the @emph{first} +thing in the input: a plus/minus sign@comma{} a number and a letter---@samp{h}@comma{} +@samp{d}@comma{} @samp{w}@comma{} @samp{m} or @samp{y}---to indicate a change in hours@comma{} days@comma{} weeks@comma{} +months@comma{} or years. With @samp{h} the date is relative to the current time@comma{} +with the other letters and a single plus or minus@comma{} the date is +relative to today at 00:00. With a double plus or minus@comma{} it is +relative to the default date. If instead of a single letter@comma{} you use +the abbreviation of day name@comma{} the date is the Nth such day@comma{} e.g.: @multitable {aaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{+0} @@ -7041,20 +7082,20 @@ the abbreviation of day name, the date is the Nth such day, e.g.: @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 +you want to use unabbreviated names and/or other languages@comma{} 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 +default@comma{} 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 +outside this range@comma{} 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.: +separator in the latter case@comma{} e.g.: @multitable {aaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaa} @item @samp{11am-1:15pm} @@ -7069,11 +7110,11 @@ separator in the latter case, e.g.: @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 +Parallel to the minibuffer prompt@comma{} a calendar is popped up@footnote{ If you +do not need/want the calendar@comma{} 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 +prompt@comma{} either by clicking on a date in the calendar@comma{} or by pressing +@kbd{@key{RET}}@comma{} the date selected in the calendar is combined with the information entered at the prompt. You can control the calendar fully from the minibuffer: @@ -7118,17 +7159,17 @@ from the minibuffer: @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, +today's date@comma{} but if you are inserting an hour specification for your +timestamp@comma{} @kbd{.} will then insert a dot after the hour. By contrast@comma{} @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 +The actions of the date/time prompt may seem complex@comma{} but I assure you +they will grow on you@comma{} 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, +understand what is going on@comma{} the current interpretation of your input +is displayed live in the minibuffer@footnote{ If you find this distracting@comma{} turn off the display with @code{org-read-date-display-live}.}. @node Custom time format @@ -7143,7 +7184,7 @@ turn off the display with @code{org-read-date-display-live}.}. @vindex org-timestamp-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 +another representation of date and time to keep you happy@comma{} you can get it by customizing the variables @code{org-display-custom-times} and @code{org-timestamp-custom-formats}. @@ -7155,37 +7196,37 @@ it by customizing the variables @code{org-display-custom-times} and 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 +Org mode needs the default format for scanning@comma{} so the custom +date/time format does not @emph{replace} the default format. Instead@comma{} 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 +You cannot place point onto a timestamp anymore@comma{} 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 +beginning of the stamp@comma{} @kbd{S-@key{UP}} and @kbd{S-@key{DOWN}} change +the stamp by one day@comma{} just like @kbd{S-@key{LEFT}} +@kbd{S-@key{RIGHT}}. At the end of the stamp@comma{} 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. +If the timestamp contains a range of clock times or a repeater@comma{} +these are not overlaid@comma{} but remain in the buffer as they were. @item -When you delete a timestamp character-by-character, it only +When you delete a timestamp character-by-character@comma{} 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. +If the custom timestamp format is longer than the default@comma{} and you +are using dates in tables@comma{} table alignment will be messed up. If +the custom format is shorter@comma{} things do work as expected. @end itemize @node Deadlines and Scheduling @@ -7198,14 +7239,14 @@ 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 +Meaning: the task---most likely a TODO item@comma{} 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 +On the deadline date@comma{} the task is listed in the agenda. In +addition@comma{} the agenda for @emph{today} carries a warning about the +approaching or missed deadline@comma{} starting @code{org-deadline-warning-days} +before the due date@comma{} and continuing until the entry is marked as done. An example: @example @@ -7218,7 +7259,7 @@ done. An example: 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 +warning is deactivated if the task gets scheduled@comma{} and you set @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}. @item @samp{SCHEDULED} @@ -7228,10 +7269,10 @@ 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, +as done. If you do not like this@comma{} set the variable +@code{org-agenda-skip-scheduled-if-done}.}. In addition@comma{} 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., +compilation for @emph{today}@comma{} until the entry is marked as done@comma{} i.e.@comma{} the task is automatically forwarded until completed. @example @@ -7241,22 +7282,22 @@ the task is automatically forwarded until completed. @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 +If you want to @emph{delay} the display of this task in the agenda@comma{} 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 +a repeater@comma{} 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 +the task@comma{} 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 +for a meeting is just a simple appointment@comma{} you should mark this +entry with a simple plain timestamp@comma{} 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 +users. In Org mode@comma{} @emph{scheduling} means setting a date when you want to start working on an action item. @end quotation @@ -7265,17 +7306,16 @@ to start working on an action item. 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 +repeater. However@comma{} 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 +late warnings. However@comma{} it shows the item on each day when the expression entry matches. @menu @@ -7298,11 +7338,11 @@ the headline.} @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 +timestamp. When called with a prefix argument@comma{} also remove any existing deadline from the entry. Depending on the variable -@code{org-log-redeadline}, take a note when changing an existing +@code{org-log-redeadline}@comma{} take a note when changing an existing deadline@footnote{ Note the corresponding @samp{STARTUP} options -@samp{logredeadline}, @samp{lognoteredeadline}, and @samp{nologredeadline}.}. +@samp{logredeadline}@comma{} @samp{lognoteredeadline}@comma{} and @samp{nologredeadline}.}. @item @kbd{C-c C-s} (@code{org-schedule}) @kindex C-c C-s @@ -7310,21 +7350,21 @@ deadline@footnote{ Note the corresponding @samp{STARTUP} options @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 +@samp{CLOSED} timestamp. When called with a prefix argument@comma{} also remove the scheduling date from the entry. Depending on the variable -@code{org-log-reschedule}, take a note when changing an existing +@code{org-log-reschedule}@comma{} take a note when changing an existing scheduling time@footnote{ Note the corresponding @samp{STARTUP} options -@samp{logreschedule}, @samp{lognotereschedule}, and @samp{nologreschedule}.}. +@samp{logreschedule}@comma{} @samp{lognotereschedule}@comma{} 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 +Create a sparse tree with all deadlines that are either past-due@comma{} 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. +@kbd{C-u} prefix@comma{} show all deadlines in the file. With +a numeric prefix@comma{} check that many days. For example@comma{} @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 @@ -7338,8 +7378,8 @@ 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 +by indicating a relative time e.g.@comma{} @samp{+1d} sets the date to the next +day after today@comma{} and @samp{--1w} sets the date to the previous week before any current timestamp. @node Repeated tasks @@ -7349,8 +7389,8 @@ any current timestamp. @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 +organize such tasks using a so-called repeater in a @samp{DEADLINE}@comma{} +@samp{SCHEDULED}@comma{} or plain timestamps@footnote{Org does not repeat inactive timestamps@comma{} however. See @ref{Timestamps}.}. In the following example: @example @@ -7361,32 +7401,31 @@ organize such tasks using a so-called repeater in a @samp{DEADLINE}, @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} +starting from that time. You can use yearly@comma{} monthly@comma{} weekly@comma{} daily +and hourly repeat cookies by using the @samp{y}@comma{} @samp{m}@comma{} @samp{w}@comma{} @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 +a deadline entry@comma{} 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 +are over-due@comma{} 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 +@samp{SCHEDULED} with the TODO keyword @samp{DONE}@comma{} it no longer produces +entries in the agenda. The problem with this is@comma{} however@comma{} 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 +to mark such an entry as done@comma{} using @kbd{C-c C-t}@comma{} it shifts the +base date of the repeating timestamp by the repeater interval@comma{} and +immediately sets the entry state back to TODO@footnote{ In fact@comma{} the target +state is taken from@comma{} in this sequence@comma{} the @samp{REPEAT_TO_STATE} property@comma{} +the variable @code{org-todo-repeat-to-state} if it is a string@comma{} the +previous TODO state if @code{org-todo-repeat-to-state} is @code{t}@comma{} or the first +state of the TODO state sequence.}. In the example above@comma{} setting the state to @samp{DONE} would actually switch the date like this: @example @@ -7394,70 +7433,70 @@ state to @samp{DONE} would actually switch the date like this: DEADLINE: <2005-11-01 Tue +1m> @end example -When task contains multiple timestamps with repeater interval, all +When task contains multiple timestamps with repeater interval@comma{} all these timestamps are shifted. -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}. +To mark a task with a repeater as DONE@comma{} use @kbd{C-- 1 C-c C-t}@comma{} +i.e.@comma{} @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 +A timestamp@footnote{You can change this using the option @code{org-log-repeat}@comma{} or the +@samp{STARTUP} options @samp{logrepeat}@comma{} @samp{lognoterepeat}@comma{} and @samp{nologrepeat}. +With @samp{lognoterepeat}@comma{} you will also be prompted for a note.} is added under the deadline@comma{} 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 +As a consequence of shifting the base date@comma{} this entry is no longer +visible in the agenda when checking past dates@comma{} 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 +With the @samp{+1m} cookie@comma{} the date shift is always exactly one month. So +if you have not paid the rent for three months@comma{} marking this entry +DONE still keeps it as an overdue deadline. Depending on the task@comma{} +this may not be the best way to handle it. For example@comma{} if you forgot +to call your father for 3 weeks@comma{} it does not make sense to call him +3 times in a single day to make up for it. Finally@comma{} there are tasks@comma{} +like changing batteries@comma{} which should always repeat a certain time +@emph{after} the last time you did it. For these tasks@comma{} 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 + Marking this as DONE shifts the date by at least one week@comma{} 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 + However@comma{} it stays on a Sunday@comma{} 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 + Marking this as DONE shifts the date by at least one day@comma{} 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 + Since there is a time in the timestamp@comma{} 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. + Marking this as DONE shifts the date to one month after today. ** TODO Wash my hands DEADLINE: <2019-04-05 08:00 Fri .+1h> - Marking this DONE shifts the date to exactly one hour from now. + Marking this as DONE shifts the date to exactly one hour from now. @end example @vindex org-agenda-skip-scheduled-repeats-after-deadline 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, +task. If the repeater is set for the scheduling information only@comma{} you +probably want the repeater to be ignored after the deadline. If so@comma{} set the variable @code{org-agenda-skip-scheduled-repeats-after-deadline} to -@code{t}. However, any scheduling information without a repeater is no -longer relevant once the task is done, and thus, removed upon +@code{t}. However@comma{} any scheduling information without a repeater is no +longer relevant once the task is done@comma{} and thus@comma{} removed upon repeating the task. If you want both scheduling and deadline -information to repeat after the same interval, set the same repeater +information to repeat after the same interval@comma{} 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 +a task subtree@comma{} 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}. @@ -7468,17 +7507,17 @@ a task subtree, with dates shifted in each copy. The command @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 +a project. When you start working on an item@comma{} you can start the +clock. When you stop working on that task@comma{} or when you mark the task +done@comma{} 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 +recently clocked@comma{} so that you can jump quickly between a number of tasks absorbing your time. -To save the clock history across Emacs sessions, use: +To save the clock history across Emacs sessions@comma{} use: @lisp (setq org-clock-persist 'history) @@ -7486,9 +7525,9 @@ To save the clock history across Emacs sessions, use: @end lisp @vindex org-clock-persist -When you clock into a new task after resuming Emacs, the incomplete +When you clock into a new task after resuming Emacs@comma{} 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 +worked on this task while outside Emacs@comma{} 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. @@ -7510,35 +7549,35 @@ about what to do with it. @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 +clocking of this item@comma{} 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 +called with a @kbd{C-u} prefix argument@comma{} 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 +prefixes@comma{} 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 +@kbd{d} when selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes@comma{} 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 +While the clock is running@comma{} Org shows the current clocking time in +the mode line@comma{} along with the title of the task. The clock time +shown is all time ever clocked in for this task and its children. +If the task has an effort estimate (see @ref{Effort Estimates})@comma{} 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 +an effort estimate ``on the fly''@comma{} 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 +@ref{Repeated tasks})@comma{} 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 +values @samp{current} to show only the current clocking instance@comma{} @samp{today} +to show all time clocked on this task today---see also the variable +@code{org-extend-today-until}@comma{} @code{all} to include all time@comma{} 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. @@ -7560,8 +7599,8 @@ timestamp@footnote{ The corresponding in-buffer setting is: @samp{#+STARTUP: @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 +argument@comma{} select the task from the clock history. With two +@kbd{C-u} prefixes@comma{} 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}) @@ -7575,32 +7614,30 @@ Update the effort estimate for the current clock task. @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-} keys, the update is +change them with @kbd{S-} keys@comma{} 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}) +@item @kbd{C-S-@key{UP}} (@code{org-clock-timestamps-up})@comma{} @kbd{C-S-@key{DOWN}} (@code{org-clock-timestamps-down}) @kindex C-S-UP @findex org-clock-timestamps-up @findex org-shiftcontrolup @kindex C-S-DOWN @findex org-clock-timestamps-down @findex org-shiftcontroldown -On CLOCK log lines, increase/decrease both timestamps so that the +On CLOCK log lines@comma{} 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}) +@item @kbd{S-M-@key{UP}} (@code{org-timestamp-up})@comma{} @kbd{S-M-@key{DOWN}} (@code{org-timestamp-down}) @kindex S-M-UP @findex org-timestamp-up @findex org-shiftmetaup @kindex S-M-DOWN @findex org-timestamp-down @findex org-shiftmetadown -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 +On @samp{CLOCK} log lines@comma{} increase/decrease the timestamp at point and +the one of the previous@comma{} or the next@comma{} clock timestamp by the same +duration. For example@comma{} if you hit @kbd{S-M-@key{UP}} to increase +a clocked-out timestamp by five minutes@comma{} then the clocked-in timestamp of the next clock is increased by five minutes. Only @samp{CLOCK} logs created during current Emacs session are @@ -7616,13 +7653,13 @@ clock if it is running in this same item. @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. +mistake@comma{} 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 +Jump to the headline of the currently clocked-in task. With +a @kbd{C-u} prefix argument@comma{} select the target task from a list of recently clocked tasks. @item @kbd{C-c C-x C-d} (@code{org-clock-display}) @@ -7630,9 +7667,9 @@ of recently clocked tasks. @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 +puts overlays at the end of each headline@comma{} showing the total time +recorded under that heading@comma{} including the time of any subheadings. +You can use visibility cycling to study the tree@comma{} 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 @@ -7641,7 +7678,7 @@ The @kbd{l} key may be used in the agenda (see @ref{Weekly/daily agenda}) to sho 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. +can have a global key binding and do not modify the window disposition. @node The clock table @subsection The clock table @@ -7650,14 +7687,14 @@ can have a global keybinding and do not modify the window disposition. @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 +information. Such a report is called a @emph{clock table}@comma{} 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, +Insert or update a clock table. When called with a prefix argument@comma{} jump to the first clock table in the current document and update it. The clock table includes archived trees. @@ -7677,14 +7714,13 @@ line of the dynamic block. 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}) +@item @kbd{S-@key{LEFT}}@comma{} @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. +@samp{:block} is @samp{today}@comma{} it is shifted to @samp{today-1}@comma{} etc. @end table Here is an example of the frame for a clock table as it is inserted @@ -7697,7 +7733,7 @@ into the buffer by @code{org-clock-report}: @end example @vindex org-clocktable-defaults -The @samp{#+BEGIN} line contains options to define the scope, structure, +The @samp{#+BEGIN} line contains options to define the scope@comma{} structure@comma{} and formatting of the report. Defaults for all these options can be configured in the variable @code{org-clocktable-defaults}. @@ -7720,7 +7756,7 @@ The scope to consider. This can be any of the following: @item @samp{subtree} @tab the subtree where the clocktable is located @item @samp{treeN} -@tab the surrounding level N tree, for example @samp{tree3} +@tab the surrounding level N tree@comma{} for example @samp{tree3} @item @samp{tree} @tab the surrounding level 1 tree @item @samp{agenda} @@ -7732,12 +7768,12 @@ The scope to consider. This can be any of the following: @item @samp{file-with-archives} @tab current file and its archives @item @samp{agenda-with-archives} -@tab all agenda files, including archives +@tab all agenda files@comma{} 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 +absolutely@comma{} or relative to the current time and may be any of these formats: @multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaa} @@ -7751,22 +7787,22 @@ formats: @tab 2nd quarter in 2007 @item @samp{2007} @tab the year 2007 -@item @samp{today}, @samp{yesterday}, @samp{today-N} +@item @samp{today}@comma{} @samp{yesterday}@comma{} @samp{today-N} @tab a relative day -@item @samp{thisweek}, @samp{lastweek}, @samp{thisweek-N} +@item @samp{thisweek}@comma{} @samp{lastweek}@comma{} @samp{thisweek-N} @tab a relative week -@item @samp{thismonth}, @samp{lastmonth}, @samp{thismonth-N} +@item @samp{thismonth}@comma{} @samp{lastmonth}@comma{} @samp{thismonth-N} @tab a relative month -@item @samp{thisyear}, @samp{lastyear}, @samp{thisyear-N} +@item @samp{thisyear}@comma{} @samp{lastyear}@comma{} @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.} +@item @samp{untilnow}@footnote{When using @code{:step}@comma{} @code{untilnow} starts from the beginning of +2003@comma{} 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 +When this option is not set@comma{} Org falls back to the value in +@code{org-clock-display-default-range}@comma{} which defaults to the current year. Use @kbd{S-@key{LEFT}} or @kbd{S-@key{RIGHT}} to shift the time @@ -7787,15 +7823,15 @@ The starting day of the week. The default is 1 for Monday. 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}, @samp{quarter}, or @samp{year} to split the -table into chunks. To use this, either @samp{:block}, or @samp{:tstart} and +Set to @samp{day}@comma{} @samp{week}@comma{} @samp{semimonth}@comma{} @samp{month}@comma{} @samp{quarter}@comma{} or @samp{year} to split the +table into chunks. To use this@comma{} either @samp{:block}@comma{} or @samp{:tstart} and @samp{:tend} are required. @item @samp{:stepskip0} -When non-@code{nil}, do not show steps that have zero time. +When non-@code{nil}@comma{} 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 +When non-@code{nil}@comma{} do not show table sections from files which did not contribute. @item @samp{:match} @@ -7806,12 +7842,12 @@ A tags match to select entries that should contribute. See @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 +@code{org-clocktable-write-default}@comma{} 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. +When non-@code{nil}@comma{} emphasize level one and level two items. @item @samp{:lang} Language@footnote{ Language terms can be set through the variable @@ -7823,8 +7859,8 @@ 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. +table. If you write it like @samp{50!}@comma{} then the headline is also +shortened during export. @item @samp{:indent} Indent each headline field according to its level. @@ -7838,13 +7874,13 @@ 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. +@samp{:maxlevel}@comma{} 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., +A cons cell containing the column to sort and a sorting type. E.g.@comma{} @samp{:sort (1 . ?a)} sorts the first column alphabetically. @item @samp{:compact} @@ -7852,33 +7888,33 @@ 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. +A timestamp for the entry@comma{} when available. Look for @samp{SCHEDULED}@comma{} +@samp{DEADLINE}@comma{} @samp{TIMESTAMP} and @samp{TIMESTAMP_IA} special properties (see +@ref{Special Properties})@comma{} in this order. @item @samp{:tags} -When this flag is non-@code{nil}, show the headline's tags. +When this flag is non-@code{nil}@comma{} 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 +When this flag is non-@code{nil}@comma{} 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 +a special case@comma{} @samp{:formula %} adds a column with % time. If you do +not specify a formula here@comma{} 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: +To get a clock summary of the current level 1 tree@comma{} for the current +day@comma{} you could write: @example #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t @@ -7930,80 +7966,80 @@ last week would be @cindex resolve idle time @cindex idle, resolve, dangling -If you clock in on a work item, and then walk away from your +If you clock in on a work item@comma{} 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. +current clock@comma{} 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's idle time. For X11, you can install a -utility program @samp{x11idle.c}, available in the @samp{org-contrib/} -repository, 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 +By customizing the variable @code{org-clock-idle-time} to some integer@comma{} +such as 10 or 15@comma{} Emacs can alert you when you get back to your +computer after being idle for that many minutes@footnote{On computers using macOS@comma{} idleness is based on actual user +idleness@comma{} not just Emacs's idle time. For X11@comma{} you can install a +utility program @samp{x11idle.c}@comma{} available in the @samp{org-contrib/} +repository@comma{} or install the xprintidle package and set it to the +variable @code{org-clock-x11idle-program-name} if you are running Debian@comma{} +to get the same general treatment of idleness. On other systems@comma{} idle +time refers to Emacs idle time only.}@comma{} 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 +for you when you get back@comma{} indicating how much idle time has passed +constantly updated with the current amount@comma{} 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 +To keep some or all of the minutes and stay clocked in@comma{} press @kbd{k}. Org asks how many of the minutes to keep. Press -@kbd{@key{RET}} to keep them all, effectively changing nothing, or +@kbd{@key{RET}} to keep them all@comma{} effectively changing nothing@comma{} 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 +If you use the shift key and press @kbd{K}@comma{} 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 +task. If you keep all the minutes@comma{} 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 +To keep none of the minutes@comma{} use @kbd{s} to subtract all the +away time from the clock@comma{} 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 +away time@comma{} use the shift key and press @kbd{S}. Remember that +using shift always leave you clocked out@comma{} 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 +To cancel the clock altogether@comma{} use @kbd{C}. Note that if +instead of canceling you subtract the away time@comma{} and the resulting +clock amount is less than a minute@comma{} 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 +What if you subtracted those away minutes from the current clock@comma{} 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 +subtracted time ``on the books''@comma{} so to speak@comma{} 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 +Say you were clocked in and hacking away@comma{} 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 +button! You suddenly lose all your buffers@comma{} but thanks to auto-save +you still have your recent Org mode changes@comma{} including your last clock in. -If you restart Emacs and clock into any task, Org will notice that you +If you restart Emacs and clock into any task@comma{} 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 +unaccounted-for period@comma{} 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. @@ -8018,12 +8054,12 @@ dangling clocks at any time using @kbd{M-x org-resolve-clocks @key{RET}} (or @kb @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 +previous task. To enable this systematically@comma{} set +@code{org-clock-continuously} to non-@code{nil}. Each time you clock in@comma{} Org retrieves the clock-out time of the last clocked entry for this -session, and start the new clock from there. +session@comma{} and start the new clock from there. -If you only want this from time to time, use three universal prefix +If you only want this from time to time@comma{} use three universal prefix arguments with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}. @@ -8033,13 +8069,13 @@ arguments with @code{org-clock-in} and two @kbd{C-u C-u} with @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 +When you often forget to clock out before being idle@comma{} and you don't +want to manually set the clocking time to take into account@comma{} 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. +of seconds@comma{} the clock will be clocked out automatically. Use @samp{M-x org-clock-toggle-auto-clockout RET} to temporarily turn this on or off. @@ -8051,15 +8087,15 @@ on or off. @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 +If you want to plan your work in a very detailed way@comma{} or if you need +to produce offers with quotations of the estimated work effort@comma{} 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 +clocking your work@comma{} you may later want to compare the planned effort +with the actual working time@comma{} 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 +formats are supported@comma{} such as @samp{3:12}@comma{} @samp{1:23:45}@comma{} or @samp{1d3h5min}; see the file @samp{org-duration.el} for more detailed information about the format. @@ -8070,7 +8106,7 @@ You can set the effort for an entry with the following commands: @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 +argument@comma{} set it to the next allowed value---see below. This command is also accessible from the agenda with the @kbd{e} key. @@ -8082,7 +8118,7 @@ Modify the effort estimate of the item currently being clocked. 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 +values for effort estimates@comma{} 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: @@ -8094,30 +8130,30 @@ time. For a specific buffer you can use: @noindent @vindex org-global-properties @vindex org-columns-default-format -or, even better, you can set up these values globally by customizing +or@comma{} even better@comma{} 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. +setup also in the agenda@comma{} 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 +column mode@comma{} 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 +the hierarchy. In the column next to it@comma{} 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 +If you switch to column view in the daily/weekly agenda@comma{} 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 +@ref{Agenda Column View}).}@comma{} 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 +day that is committed@comma{} 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, +triggered with the @kbd{/} key in the agenda (see @ref{Agenda Commands}). If you have these estimates defined consistently@comma{} two or three key presses narrow down the list to stuff that fits into an available time slot. @@ -8128,7 +8164,7 @@ an available time slot. @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, +counts up@comma{} which can be useful when taking notes during@comma{} for example@comma{} a meeting or a video viewing. There is also a countdown timer. The relative and countdown are started with separate commands. @@ -8137,12 +8173,12 @@ The relative and countdown are started with separate commands. @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 +Start or reset the relative timer. By default@comma{} the timer is set +to 0. When called with a @kbd{C-u} prefix@comma{} prompt the user for a starting offset. The prompt will default to a timer string at -point (if any), providing a convenient way to restart taking notes +point (if any)@comma{} 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 +argument @kbd{C-u C-u}@comma{} 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. @@ -8156,7 +8192,7 @@ 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 +Once started@comma{} relative and countdown timers are controlled with the same commands. @table @asis @@ -8164,29 +8200,29 @@ same commands. @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. +this@comma{} 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. +a prefix argument@comma{} 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 +Once the timer list is started@comma{} 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}) +@item @kbd{C-c C-x @comma{}} (@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. +Pause the timer@comma{} 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 +Stop the timer. After this@comma{} you can only start a new timer@comma{} not continue the old one. This command also removes the timer from the mode line. @end table @@ -8198,8 +8234,8 @@ mode line. @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 +Once information is in the system@comma{} it may need to be moved around. +Org provides Refile@comma{} Copy and Archive commands for this. Refile and Copy helps with moving and copying outlines. Archiving helps to keep the system compact and fast. @@ -8214,10 +8250,10 @@ the system compact and fast. @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 +When reviewing the captured data@comma{} you may want to refile or to copy +some of the entries into a different list@comma{} for example into a project. +Cutting@comma{} finding the right location@comma{} and then pasting the note is +cumbersome. To simplify this process@comma{} you can use the following special command: @table @asis @@ -8233,20 +8269,20 @@ special command: 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. +the target heading as a sub-item. Depending on +@code{org-reverse-note-order}@comma{} it is either the first or last sub-item. -By default, all level 1 headlines in the current buffer are -considered to be targets, but you can have more complex definitions +By default@comma{} all level 1 headlines in the current buffer are +considered to be targets@comma{} 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 +file-path-like completion along the outline path@comma{} 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 +to create new nodes as new parents for refiling on the fly@comma{} 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 +options @samp{logrefile}@comma{} @samp{lognoterefile}@comma{} and @samp{nologrefile}.} is set@comma{} a timestamp or a note is recorded whenever an entry is refiled. @item @kbd{C-u C-c C-w} @@ -8266,7 +8302,7 @@ Refile as the child of the item currently being clocked. @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 +make this the default behavior@comma{} 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}) @@ -8276,22 +8312,22 @@ duplicated @samp{ID} properties. @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. +possible targets@comma{} 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 +Copying works like refiling@comma{} except that the original note is not deleted. @item @kbd{C-c C-M-w} (@code{org-refile-reverse}) @kindex C-c C-M-w @findex org-refile-reverse -Works like refiling, except that it temporarily toggles how the +Works like refiling@comma{} except that it temporarily toggles how the value of @code{org-reverse-note-order} applies to the current buffer. So if @code{org-refile} would append the entry as the last entry under the -target header, @code{org-refile-reverse} will prepend it as the first -entry, and vice-versa. +target header@comma{} @code{org-refile-reverse} will prepend it as the first +entry@comma{} and vice versa. @end table @node Archiving @@ -8299,7 +8335,7 @@ entry, and vice-versa. @cindex archiving -When a project represented by a (sub)tree is finished, you may want to +When a project represented by a (sub)tree is finished@comma{} 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. @@ -8324,7 +8360,7 @@ variable @code{org-archive-default-command}. @cindex external archiving The most common archiving action is to move a project tree to another -file, the archive file. +file@comma{} called the archive file. @table @asis @item @kbd{C-c C-x C-s} or short @kbd{C-c $} (@code{org-archive-subtree}) @@ -8338,28 +8374,28 @@ 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 +to the archive. To do this@comma{} check each subtree for open TODO +entries. If none is found@comma{} 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. +is invoked@comma{} 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. +As above@comma{} 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. +a timestamp@comma{} 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@comma{} 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. +items under@comma{} 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 +heading@comma{} see the documentation string of the variable @code{org-archive-location}. -There is also an in-buffer option for setting this variable, for +There is also an in-buffer option for setting this variable@comma{} for example: @cindex @samp{ARCHIVE}, keyword @@ -8367,21 +8403,20 @@ 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 +entry or a (sub)tree@comma{} 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 +When a subtree is moved@comma{} 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 +came@comma{} its outline path@comma{} 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 +When @code{org-archive-subtree-save-file-p} is non-@code{nil}@comma{} save the target archive buffer. @node Internal archiving @@ -8389,38 +8424,38 @@ archive buffer. @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} +without moving them to a different file@comma{} 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: +its location in the outline tree@comma{} 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-c C-@key{TAB}}, or by setting the option -@code{org-cycle-open-archived-trees}. Also normal outline commands, like -@code{org-show-all}, open archived subtrees. +subtrees with @kbd{C-c C-@key{TAB}}@comma{} or by setting the option +@code{org-cycle-open-archived-trees}. Also@comma{} normal outline commands@comma{} like +@code{org-fold-show-all}@comma{} 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 +During sparse tree construction (see @ref{Sparse Trees})@comma{} matches in +archived subtrees are not exposed@comma{} 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 +During agenda view construction (see @ref{Agenda Views})@comma{} the content of archived trees is ignored unless you configure the option -@code{org-agenda-skip-archived-trees}, in which case these trees are +@code{org-agenda-skip-archived-trees}@comma{} 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 +Archived trees are not exported (see @ref{Exporting})@comma{} only the headline is. Configure the details using the variable @code{org-export-with-archived-trees}. @@ -8437,16 +8472,16 @@ The following commands help manage the @samp{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 +set@comma{} the headline changes to a shadowed face@comma{} 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 +archived. To do this@comma{} check each subtree for open TODO entries. If +none is found@comma{} 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. +invoked@comma{} check the level 1 trees. @item @kbd{C-c C-@key{TAB}} (@code{org-cycle-force-archived}) @kindex C-c C-TAB @@ -8458,7 +8493,7 @@ Cycle a tree even if it is tagged with @samp{ARCHIVE}. 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 +of its original context@comma{} including inherited tags and approximate position in the outline. @end table @@ -8472,12 +8507,12 @@ position in the outline. @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 +capture new ideas and tasks@comma{} 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 +Finally@comma{} 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}. +material@comma{} see @ref{Protocols}. @menu * Capture:: Capturing new stuff. @@ -8520,19 +8555,18 @@ You may also define a global key for capturing new material (see @item @kbd{M-x org-capture} (@code{org-capture}) @findex org-capture 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. +(see @ref{Capture templates})@comma{} it offers these templates for +selection. It inserts the template into the target file and +switches 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, +Once you have finished entering information into the capture buffer@comma{} @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 +the capture process@comma{} so that you can resume your work without +further distraction. When called with a prefix argument@comma{} finalize and then jump to the captured item. @item @kbd{C-c C-w} (@code{org-capture-refile}) @@ -8542,7 +8576,7 @@ 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 +a tree with a parent and children@comma{} first move point back to the parent. Any prefix argument given to this command is passed on to the @code{org-refile} command. @@ -8553,12 +8587,12 @@ 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 +You can also call @code{org-capture} in a special way from the agenda@comma{} +using the @kbd{k c} key combination. With this access@comma{} any timestamps inserted by the selected capture template defaults to the -date at point in the agenda, rather than to the current date. +date at point in the agenda@comma{} rather than to the current date. -To find the locations of the last stored capture, use @code{org-capture} +To find the locations of the last stored capture@comma{} use @code{org-capture} with prefix commands: @table @asis @@ -8572,10 +8606,10 @@ Visit the last stored capture item in its buffer. @vindex org-bookmark-names-plist @vindex org-capture-last-stored -You can also jump to the bookmark @code{org-capture-last-stored}, which is +You can also jump to the bookmark @code{org-capture-last-stored}@comma{} which is automatically created unless you customize @code{org-bookmark-names-plist}. -To insert the capture at point in an Org buffer, call @code{org-capture} +To insert the capture at point in an Org buffer@comma{} call @code{org-capture} with a @kbd{C-0} prefix argument. @node Capture templates @@ -8583,7 +8617,7 @@ with a @kbd{C-0} prefix argument. @cindex templates, for Capture -You can use templates for different types of capture items, and for +You can use templates for different types of capture items@comma{} and for different target locations. The easiest way to create such templates is through the customize interface. @@ -8594,10 +8628,10 @@ is through the customize interface. Customize the variable @code{org-capture-templates}. @end table -Before we give the formal description of template definitions, let's +Before we give the formal description of template definitions@comma{} 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 +general TODO entries@comma{} and you want to put these entries under the +heading @samp{Tasks} in your file @samp{~/org/gtd.org}. Also@comma{} a date tree in the file @samp{journal.org} should capture journal entries. A possible configuration would look like: @@ -8609,7 +8643,7 @@ configuration would look like: "* %?\nEntered on %U\n %i\n %a"))) @end lisp -If you then press @kbd{t} from the capture menu, Org will prepare +If you then press @kbd{t} from the capture menu@comma{} Org will prepare the template for you like this: @example @@ -8618,14 +8652,14 @@ the template for you like this: @end example @noindent -During expansion of the template, @samp{%a} has been replaced by a link to +During expansion of the template@comma{} @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 +extremely useful for deriving tasks from emails@comma{} for example. You +fill in the task definition@comma{} 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 +going through the interactive template selection@comma{} you can create your key binding like this: @lisp @@ -8647,34 +8681,34 @@ Now lets look at the elements of a template definition. Each entry in @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, +The keys that select the template@comma{} as a string@comma{} characters only@comma{} +for example @samp{"a"}@comma{} for a template to be selected with a single key@comma{} +or @samp{"bt"} for selection with two keys. When using several keys@comma{} keys using the same prefix key must be sequential in the list and -preceded by a 2-element entry explaining the prefix key, for +preceded by a 2-element entry explaining the prefix key@comma{} 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 +If you do not define a template for the @kbd{C} key@comma{} this key opens the Customize buffer for this complex variable. @item description -A short string describing the template, shown during selection. +A short string describing the template@comma{} shown during selection. @item type -The type of entry, a symbol. Valid values are: +The type of entry@comma{} a symbol. Valid values are: @table @asis @item @code{entry} -An Org mode node, with a headline. Will be filed as the child of +An Org mode node@comma{} 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 +A plain list item@comma{} placed in the first plain list at the target location. Again the target file should be an Org file. @item @code{checkitem} @@ -8695,39 +8729,57 @@ Text to be inserted as it is. @vindex org-directory @cindex date tree Specification of where the captured item should be placed. In Org -files, targets usually define a node. Entries will become children +files@comma{} 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 +body of this node. Most target specifications contain a +@samp{}. If it is the empty string@comma{} 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}. +specified for a target@comma{} it is taken as relative to @code{org-directory}. Valid values are: @table @asis -@item @samp{(file "path/to/file")} +@item @samp{(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. +Filing as child of this entry@comma{} or in the body of the entry. + +@item @samp{(file+headline "node headline")} + + +@item @samp{(file+headline function-returning-string)} + -@item @samp{(file+headline "filename" "node headline")} +@item @samp{(file+headline symbol-containing-string)} 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+olp "Level 1 heading" "Level 2" ...)} + + +@item @samp{(file+olp function-returning-list-of-strings)} + + +@item @samp{(file+olp symbol-containing-list-of-strings)} +For non-unique headings@comma{} the full path is safer. -@item @samp{(file+regexp "filename" "regexp to find location")} +@item @samp{(file+regexp "regexp to find location")} Use a regular expression to position point. -@item @samp{(file+olp+datetree "filename" [ "Level 1 heading" ...])} +@item @samp{(file+olp+datetree [ "Level 1 heading" ...])} + + +@item @samp{(file+olp+datetree function-returning-list-of-strings)} + + +@item @samp{(file+olp+datetree symbol-containing-list-of-strings)} 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} +capture. Now@comma{} Org automatically translates these to use +@code{file+olp+datetree}@comma{} 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@comma{} months or ISO weeks as sublevels and then dates on the lowest level. @example * 2022 @@ -8735,14 +8787,14 @@ level. *** 2022-10-07 Friday *** 2022-10-08 Saturday @end example -TODO state, priority, tags, statistics cookies, and COMMENT keywords +TODO state@comma{} priority@comma{} tags@comma{} statistics cookies@comma{} and COMMENT keywords 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 +today's date. If the optional outline path is given@comma{} the tree +will be built under the node it is pointing to@comma{} 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)} +@item @samp{(file+function function-finding-location)} A function to find the right location in the file. @item @samp{(clock)} @@ -8758,11 +8810,11 @@ file and moves point to the right location. @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 +empty@comma{} an appropriate default template will be used. Otherwise@comma{} this +is a string with escape codes@comma{} 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, +template string from a file@footnote{ When the file name is not absolute@comma{} +Org assumes it is relative to @code{org-directory}.}@comma{} or dynamically@comma{} from a function using either syntax: @example @@ -8777,20 +8829,20 @@ 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{}). +location (last child@comma{} last table line@comma{} last list item@comma{} @dots{}). Setting this property changes that. @item @code{:immediate-finish} -When set, do not offer to edit the information, just file it away +When set@comma{} do not offer to edit the information@comma{} 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. +When set@comma{} 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. Default 0@comma{} 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 @@ -8809,27 +8861,37 @@ Start the clock in this item. Keep the clock running when filing the captured entry. @item @code{:clock-resume} -If starting the capture interrupted a clock, restart that clock +If starting the capture interrupted a clock@comma{} 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}, +precedence over @code{:clock-resume}. When setting both to non-@code{nil}@comma{} 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, +filling the template. Without this property@comma{} capture uses the +current date and time. Even if this property has not been set@comma{} 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. +Default is to group entries by day. Use @code{week} to make a week +tree instead of the month-day tree@comma{} i.e.@comma{} place the headings for +each day under a heading with the current ISO week. Use @code{month} +to group entries by month only. Use any subset of @code{(year quarter + month week day)} to group by the specified levels. In case +@code{month} and @code{week} are both specified@comma{} weeks are assigned to the +month containing Thursday@comma{} to be consistent with the ISO year-week +rule. In case @code{quarter} and @code{week} but not @code{month} are specified@comma{} +quarters are 13-week periods; otherwise they are 3-month periods. + +@findex org-datetree-find-create-hierarchy +@code{:tree-type} can also be a function@comma{} in which it should take the +date as an argument and generate a list of pairs for +@code{org-datetree-find-create-hierarchy}. @item @code{:unnarrowed} -Do not narrow the target buffer, simply show the full buffer. +Do not narrow the target buffer@comma{} simply show the full buffer. Default is to narrow it so that you only see the new material. @item @code{:table-line-pos} @@ -8839,7 +8901,7 @@ 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, +If the target file was not yet visited when capture was invoked@comma{} kill the buffer again after capture is completed. @item @code{:no-save} @@ -8872,8 +8934,8 @@ A nullary function or list of nullary functions run before @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 +In the template itself@comma{} special ``%-escapes''@footnote{ If you need one of +these sequences literally@comma{} escape the @samp{%} with a backslash.} allow dynamic insertion of content. The templates are expanded in the order given here: @@ -8882,43 +8944,44 @@ given here: 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 +Evaluate Elisp expression @code{(EXP)} and replace it with the result. +The @code{(EXP)} form must return a string. Only placeholders +pre-existing within the template@comma{} or introduced with @samp{%[file]}@comma{} are +expanded this way. Since this happens after expanding +non-interactive ``%-escapes''@comma{} those can be used to fill the expression. +Examples: @samp{%(org-id-new)}@comma{} @samp{%(eval default-directory)} @item @samp{%} The result of format-time-string on the @var{FORMAT} specification. @item @samp{%t} -Timestamp, date only. +Timestamp@comma{} date only. @item @samp{%T} -Timestamp, with date and time. +Timestamp@comma{} with date and time. -@item @samp{%u}, @samp{%U} -Like @samp{%t}, @samp{%T} above, but inactive timestamps. +@item @samp{%u}@comma{} @samp{%U} +Like @samp{%t}@comma{} @samp{%T} above@comma{} 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 +Initial content@comma{} the region when capture is called while the region +is active. If there is text before @samp{%i} on the same line@comma{} such as +indentation@comma{} and @samp{%i} is not inside a @samp{%(exp)} form@comma{} that prefix is added before every line in the inserted text. @item @samp{%a} -Annotation, normally the link created with @code{org-store-link}. +Annotation@comma{} normally the link created with @code{org-store-link}. @item @samp{%A} -Like @samp{%a}, but prompt for the description part. +Like @samp{%a}@comma{} but prompt for the description part. @item @samp{%l} -Like @samp{%a}, but only insert the literal link. +Like @samp{%a}@comma{} but only insert the literal link. @item @samp{%L} -Like @samp{%l}, but without brackets (the link content itself). +Like @samp{%l}@comma{} but without brackets (the link content itself). @item @samp{%c} Current kill ring head. @@ -8933,7 +8996,7 @@ Title of the currently clocked task. Link to the currently clocked task. @item @samp{%n} -User name (taken from @code{user-full-name}). +Username (taken from @code{user-full-name}). @item @samp{%f} File visited by current buffer when org-capture was called. @@ -8942,30 +9005,30 @@ File visited by current buffer when org-capture was called. Full path of the file or directory visited by current buffer. @item @samp{%:keyword} -Specific information for certain link types, see below. +Specific information for certain link types@comma{} see below. @item @samp{%^g} -Prompt for tags, with completion on tags in target file. +Prompt for tags@comma{} with completion on tags in target file. @item @samp{%^G} -Prompt for tags, with completion all tags in all agenda files. +Prompt for tags@comma{} 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 +Like @samp{%t}@comma{} but prompt for date. Similarly@comma{} @samp{%^T}@comma{} @samp{%^u}@comma{} @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. +Like @samp{%^C}@comma{} but insert as link. @item @samp{%^@{PROP@}p} Prompt the user for a value for property @var{PROP}. You may specify a default value with @samp{%^@{PROP|default@}}. -@item @samp{%^@{PROMPT@}X}, X is one of g,G,t,T,u,U,C,L -Prompt the user as in @samp{%^X}, but use the custom prompt string. You +@item @samp{%^@{PROMPT@}X}@comma{} X is one of g@comma{}G@comma{}t@comma{}T@comma{}u@comma{}U@comma{}C@comma{}L +Prompt the user as in @samp{%^X}@comma{} but use the custom prompt string. You may specify a default value and completions with @samp{%^@{PROMPT|default|completion1|completion2|completion3...@}X}. @@ -8976,17 +9039,21 @@ may specify a default value and a completion table with 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. +Insert the text entered at the @var{N}th @samp{%^@{PROMPT@}} (but not +@samp{%^@{PROMPT@}X})@comma{} where @var{N} is a number@comma{} starting from 1. + +@item @samp{%\*N} +Same as @samp{%\N}@comma{} but include all the prompts. @item @samp{%?} -After completing the template, position point here. +After completing the template@comma{} 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 +@vindex org-link-store-props +For specific link types@comma{} the following keywords are defined@footnote{ If +you define your own link types (see @ref{Adding Hyperlink Types})@comma{} any +property you store with @code{org-link-store-props} can be accessed in capture templates in a similar way.}: @vindex org-link-from-user-regexp @@ -8994,15 +9061,15 @@ capture templates in a similar way.}: @headitem Link type @tab Available keywords @item bbdb -@tab @samp{%:name}, @samp{%:company} +@tab @samp{%:name}@comma{} @samp{%:company} @item irc -@tab @samp{%:server}, @samp{%:port}, @samp{%:nick} -@item mh, rmail -@tab @samp{%:type}, @samp{%:subject}, @samp{%:message-id} +@tab @samp{%:server}@comma{} @samp{%:port}@comma{} @samp{%:nick} +@item mh@comma{} rmail +@tab @samp{%:type}@comma{} @samp{%:subject}@comma{} @samp{%:message-id} @item -@tab @samp{%:from}, @samp{%:fromname}, @samp{%:fromaddress} +@tab @samp{%:from}@comma{} @samp{%:fromname}@comma{} @samp{%:fromaddress} @item -@tab @samp{%:to}, @samp{%:toname}, @samp{%:toaddress} +@tab @samp{%:to}@comma{} @samp{%:toname}@comma{} @samp{%:toaddress} @item @tab @samp{%:date} (message date header field) @item @@ -9010,18 +9077,18 @@ capture templates in a similar way.}: @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 +@tab @samp{%:fromto} (either ``to NAME'' or ``from NAME'')@footnote{This is always the other@comma{} 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{%:group}@comma{} for messages also all email fields +@item w3@comma{} w3m @tab @samp{%:url} @item info -@tab @samp{%:file}, @samp{%:node} +@tab @samp{%:file}@comma{} @samp{%:node} @item calendar @tab @samp{%:date} @item org-protocol -@tab @samp{%:link}, @samp{%:description}, @samp{%:annotation} +@tab @samp{%:link}@comma{} @samp{%:description}@comma{} @samp{%:annotation} @end multitable @node Templates in contexts @@ -9029,8 +9096,8 @@ capture templates in a similar way.}: @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 +a specific context@comma{} you can customize +@code{org-capture-templates-contexts}. Let's say@comma{} for example@comma{} that you have a capture template ``p'' for storing Gnus emails containing patches. Then you would configure this option like this: @@ -9040,7 +9107,7 @@ patches. Then you would configure this option like this: @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: +another template. In that case@comma{} add this command key like this: @lisp (setq org-capture-templates-contexts @@ -9054,15 +9121,16 @@ See the docstring of the variable for more information. @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. +It is often useful to associate reference material with a heading or +subtree. 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@comma{} or even +remote@comma{} computer@comma{} 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. +Another method is @emph{attachments}@comma{} which are files located in a +directory belonging to heading/subtree. Org uses directories named +either by the @samp{ID} property of a heading or by a @samp{DIR} property. @menu * Attachment defaults and dispatcher:: How to access attachment commands @@ -9075,18 +9143,18 @@ named by a unique ID of each entry, or by a @samp{DIR} property. @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 +By default@comma{} Org attach uses @samp{ID} properties when adding attachments to +headings. This makes working with attachments fully automated. There +is no decision needed for folder-name or location. @samp{ID}-based +directories are by default located in the @samp{data/} directory@comma{} 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 +entries or Org files from one directory to another@comma{} 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}. +For more control over the setup@comma{} see @ref{Attachment options}. The following commands deal with attachments: @@ -9095,7 +9163,7 @@ The following commands deal with attachments: @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 +these keys@comma{} a list of commands is displayed@comma{} and you must press an additional key to select a command: @table @asis @@ -9104,7 +9172,7 @@ additional key to select a command: @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 +The file is copied@comma{} moved@comma{} or linked@comma{} depending on @code{org-attach-method}. Note that hard links are not supported on all systems. @@ -9129,22 +9197,22 @@ 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 +Synchronize the current task with its attachment directory@comma{} 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 +Open current task's attachment. If there is more than one@comma{} prompt for a file name first. Opening follows the rules set by -@code{org-file-apps}. For more details, see the information on +@code{org-file-apps}. For more details@comma{} 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. +Also open the attachment@comma{} but force opening the file in Emacs. @item @kbd{f} (@code{org-attach-reveal}) @kindex C-c C-a f @@ -9154,7 +9222,7 @@ 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. +Also open the directory@comma{} but force using Dired in Emacs. @item @kbd{d} (@code{org-attach-delete-one}) @kindex C-c C-a d @@ -9177,9 +9245,9 @@ property. @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 +folder@comma{} if an @samp{ID} property is set@comma{} delete the content@comma{} or to leave the attachment directory as is but no longer attached to the -outline node. +heading. @end table @end table @@ -9198,18 +9266,18 @@ 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. +(@code{org-attach-set-directory})@comma{} 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: +By default folders attached to a heading 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 ... @@ -9224,27 +9292,27 @@ Some text @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 +@samp{image 1.jpg}@comma{} 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 +is inherited from a parent node in the outline@comma{} 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, +customizing @code{org-attach-method}. Options are Copy@comma{} Move/Rename@comma{} 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}. +but can also be set to @code{dir}@comma{} @code{ask} or @code{nil}. @item @code{org-attach-archive-delete} @vindex org-attach-archive-delete @@ -9258,20 +9326,20 @@ 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 +When @samp{ID} is used for attachments@comma{} 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 +tried when resolving existing ID's into paths@comma{} 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 +@code{org-attach-store-link-p}@comma{} the link is stored to either the original +location as a file link@comma{} the attachment location as an attachment link or to the attachment location as a file link. @item @code{org-attach-commands} @@ -9291,8 +9359,8 @@ default settings. @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! +This makes it easy to refer to the material added to heading/subtree. +Especially if it was attached using the unique @samp{ID} of the heading! @example * TODO Some task @@ -9307,11 +9375,11 @@ 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 +If the directory attached to a heading is a Git repository@comma{} 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 +To make Org mode take care of versioning of attachments for you@comma{} add the following to your Emacs config: @lisp @@ -9325,9 +9393,9 @@ the following to your Emacs config: @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) +use this feature@comma{} 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, +get the attachments. In the Dired window@comma{} with point on a file@comma{} @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 @@ -9366,7 +9434,7 @@ 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 +feeds@comma{} configure the variable @code{org-feed-alist}. The docstring of this variable has detailed information. With the following @lisp @@ -9379,7 +9447,7 @@ variable has detailed information. With the following @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: +Entries}@comma{} whenever the following command is used: @table @asis @item @kbd{C-c C-x g} (@code{org-feed-update-all}) @@ -9392,11 +9460,11 @@ upon them. 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 +Under the same headline@comma{} Org creates a drawer @samp{FEEDSTATUS} in which it +stores information about the status of items in the feed@comma{} to avoid adding the same item several times. -For more information, including how to read atom feeds, see +For more information@comma{} including how to read atom feeds@comma{} see @samp{org-feed.el} and the docstring of @code{org-feed-alist}. @node Agenda Views @@ -9404,10 +9472,10 @@ For more information, including how to read atom feeds, see @cindex agenda views -Due to the way Org works, TODO items, time-stamped items, and tagged +Due to the way Org works@comma{} TODO items@comma{} time-stamped items@comma{} 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, +files. To get an overview of open action items@comma{} or of events that are +important for a particular date@comma{} this information must be collected@comma{} sorted and displayed in an organized way. Org can select items based on various criteria and display them in @@ -9416,22 +9484,22 @@ 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, +specific dates@comma{} @item -a @emph{TODO list} that covers all unfinished action items, +a @emph{TODO list} that covers all unfinished action items@comma{} @item -a @emph{match view}, showings headlines based on the tags, properties, -and TODO state associated with them, +a @emph{match view}@comma{} showings headlines based on the tags@comma{} properties@comma{} +and TODO state associated with them@comma{} @item a @emph{text search view} that shows all entries from multiple files that -contain specified keywords, +contain specified keywords@comma{} @item a @emph{stuck projects view} showing projects that currently do not move -along, and +along@comma{} and @item @emph{custom views} that are special searches and combinations of @@ -9439,15 +9507,15 @@ 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 +This buffer is read-only@comma{} but provides commands to visit the +corresponding locations in the original Org files@comma{} 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 +By default@comma{} 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}. @@ -9477,17 +9545,17 @@ the window configuration is restored when the agenda exits: @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 +files}@comma{} the files listed in the variable @code{org-agenda-files}@footnote{ If +the value of that variable is not a list@comma{} but a single file name@comma{} 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 +directory is part of this list@comma{} 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 +Thus@comma{} even if you only work with a single Org file@comma{} that file should +be put into the list@footnote{ When using the dispatcher@comma{} 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 +the current file@comma{} and ignores @code{org-agenda-files} until the next +dispatcher command.}. You can customize @code{org-agenda-files}@comma{} but the easiest way to maintain it is through the following commands @table @asis @@ -9496,8 +9564,8 @@ easiest way to maintain it is through the following commands @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 +the front of the list. If it was already in the list@comma{} it is moved +to the front. With a prefix argument@comma{} file is added/moved to the end. @item @kbd{C-c ]} (@code{org-remove-file}) @@ -9506,12 +9574,12 @@ end. Remove current file from the list of agenda files. @item @kbd{C-'} -@itemx @kbd{C-,} (@code{org-cycle-agenda-files}) +@itemx @kbd{C-@comma{}} (@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. +Cycle through agenda file list@comma{} visiting one file after the other. @item @kbd{M-x org-switchb} @findex org-switchb @@ -9524,23 +9592,23 @@ 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 +this list@comma{} or on just one file in the list@comma{} or even on only a subtree +in a file@comma{} then this can be done in different ways. For a single +agenda command@comma{} 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: +scope for an extended period@comma{} 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, +a restriction at point@comma{} remove it. When called with a universal +prefix argument or with point before the first headline in a file@comma{} set the agenda scope to the entire file. This restriction remains -in effect until removed with @kbd{C-c C-x >}, or by typing +in effect until removed with @kbd{C-c C-x >}@comma{} or by typing either @kbd{<} or @kbd{>} in the agenda dispatcher. If -there is a window displaying an agenda view, the new restriction +there is a window displaying an agenda view@comma{} the new restriction takes effect immediately. @item @kbd{C-c C-x >} (@code{org-agenda-remove-restriction-lock}) @@ -9549,7 +9617,7 @@ takes effect immediately. Remove the restriction created by @kbd{C-c C-x <}. @end table -When working with Speedbar, you can use the following commands in the +When working with Speedbar@comma{} you can use the following commands in the Speedbar frame: @table @asis @@ -9557,8 +9625,8 @@ Speedbar frame: @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 +restricted there@comma{} remove the restriction. If there is a window +displaying an agenda view@comma{} the new restriction takes effect immediately. @item @kbd{>} (@code{org-agenda-remove-restriction-lock}) @@ -9572,7 +9640,7 @@ Remove the restriction. @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}). +The views are created through a dispatcher@comma{} accessible with @kbd{M-x org-agenda}@comma{} or@comma{} better@comma{} 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: @@ -9581,12 +9649,10 @@ commands: @item @kbd{a} Create the calendar-like agenda (see @ref{Weekly/daily agenda}). -@item @kbd{t} -@itemx @kbd{T} +@item @kbd{t}@comma{} @kbd{T} Create a list of all TODO items (see @ref{Global TODO list}). -@item @kbd{m} -@itemx @kbd{M} +@item @kbd{m}@comma{} @kbd{M} Create a list of headlines matching a given expression (see @ref{Matching tags and properties}). @@ -9602,7 +9668,7 @@ the entry. 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, the default +to specify the number of context lines for each match@comma{} the default is 1. @item @kbd{#} @@ -9614,37 +9680,37 @@ 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 +compatibility@comma{} 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 +narrowed part of the buffer. After pressing @kbd{<}@comma{} 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. -After pressing @kbd{< <}, you still need to press the character +If there is an active region@comma{} restrict the following agenda command +to the region. Otherwise@comma{} restrict it to the current subtree. +After pressing @kbd{< <}@comma{} 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 +Toggle sticky agenda views. By default@comma{} Org maintains only a single +agenda buffer and rebuilds it each time you change the view@comma{} to make +sure everything is always up-to-date. If you switch between views +often and the build time bothers you@comma{} 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 +@code{org-agenda-sticky}). With sticky agendas@comma{} the dispatcher only +switches to the selected view@comma{} 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 +dispatcher@comma{} 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 +blocks together@comma{} for example the weekly agenda@comma{} the global TODO list and a number of special tags matches. See @ref{Custom Agenda Views}. @node Built-in Agenda Views @@ -9668,7 +9734,7 @@ In this section we describe the built-in views. @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. +a paper agenda@comma{} showing all the tasks for the current week or day. @table @asis @item @kbd{M-x org-agenda a} (@code{org-agenda-list}) @@ -9677,9 +9743,9 @@ a paper agenda, showing all the tasks for the current week or day. @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 +argument@footnote{For backward compatibility@comma{} 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 +This feature is deprecated@comma{} use the dedicated TODO list@comma{} 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 @@ -9689,8 +9755,8 @@ set the number of days to be displayed. @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 +days you want to see by default in the agenda@comma{} or to a span name@comma{} such +a @code{day}@comma{} @code{week}@comma{} @code{month} or @code{year}. For weekly agendas@comma{} 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 @@ -9698,7 +9764,7 @@ ten days from today in the future. @code{org-agenda-start-on-weekday} takes precedence over @code{org-agenda-start-day} in weekly and bi-weekly agendas. -Remote editing from the agenda buffer means, for example, that you can +Remote editing from the agenda buffer means@comma{} for example@comma{} 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}. @@ -9711,38 +9777,38 @@ The commands available in the Agenda buffer are listed in @ref{Agenda Commands}. 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 +anniversaries@comma{} lunar phases@comma{} sunrise/set@comma{} recurrent appointments +(weekly@comma{} monthly) and more. In this way@comma{} 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 +agenda@comma{} 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 +After that@comma{} everything happens automatically. All diary entries +including holidays@comma{} anniversaries@comma{} etc.@comma{} are included in the agenda +buffer created by Org mode. @kbd{@key{SPC}}@comma{} @kbd{@key{TAB}}@comma{} 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 +buffer@comma{} as well as the commands @kbd{S}@comma{} @kbd{M}@comma{} and +@kbd{C} to display Sunrise/Sunset times@comma{} show lunar phases and to +convert to other calendars@comma{} 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 +If you are using the diary only for expression entries and holidays@comma{} +it is faster to not use the above setting@comma{} 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 +expression entries@comma{} 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 +entries must start at the left margin@comma{} no whitespace is allowed before +them@comma{} 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 +@code{diary-anniversary}@comma{} but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} @example @@ -9768,7 +9834,7 @@ and therefore independent of the value of @code{calendar-date-style}.} @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 +contacts@comma{} 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: @@ -9782,29 +9848,29 @@ add the following to one of your agenda files: @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 +Basically@comma{} 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}@comma{} +followed by a space and the class of the anniversary (@samp{birthday}@comma{} +@samp{wedding}@comma{} or a format string). If you omit the class@comma{} it defaults to +@samp{birthday}. Here are a few examples@comma{} 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 +2008-04-14 %s released version 6.01 of Org mode@comma{} %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 +After a change to BBDB@comma{} or for the first agenda display during an +Emacs session@comma{} the agenda display suffers a short delay as Org updates +its hash with anniversaries. However@comma{} from then on things will be +very fast@comma{} 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: +forewarning@comma{} you can use the following instead: @example * Anniversaries @@ -9815,7 +9881,7 @@ forewarning, you can use the following instead: @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 +and the two days prior. The argument is optional: if omitted@comma{} it defaults to 7. @anchor{Appointment reminders} @@ -9828,7 +9894,7 @@ defaults to 7. @cindex APPT_WARNTIME, keyword Org can interact with Emacs appointments notification facility. To -add the appointments of your agenda files, use the command +add the appointments of your agenda files@comma{} 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 @@ -9850,9 +9916,9 @@ collected into a single place. @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, +agenda files (see @ref{Agenda Views}) into a single buffer. By default@comma{} this lists items with a state that is not a DONE state. The buffer -is in Agenda mode, so there are commands to examine and manipulate +is in Agenda mode@comma{} 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}) @@ -9860,18 +9926,18 @@ the TODO entries directly from that buffer (see @ref{Agenda Commands}). @findex org-todo-list @cindex TODO keyword matching @vindex org-todo-keywords -Like the above, but allows selection of a specific TODO keyword. +Like the above@comma{} 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 +@kbd{t}. You are prompted for a keyword@comma{} 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 +OR operator. With a numeric prefix@comma{} the Nth keyword in @code{org-todo-keywords} is selected. @kindex r -The @kbd{r} key in the agenda buffer regenerates it, and you +The @kbd{r} key in the agenda buffer regenerates it@comma{} 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 +TODO keyword@comma{} for example @kbd{3 r}. If you often need +a search for a specific keyword@comma{} define a custom command for it (see @ref{Agenda Dispatcher}). Matching specific TODO keywords can also be done as part of a tags @@ -9896,9 +9962,9 @@ it more compact: 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, +exclude some or all scheduled items from the global TODO list@comma{} @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 +a deadline set@comma{} @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. @@ -9919,8 +9985,8 @@ variable @code{org-agenda-todo-list-sublevels} to get this behavior. @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 +If headlines in the agenda files are marked with @emph{tags} (see @ref{Tags})@comma{} +or have properties (see @ref{Properties and Columns})@comma{} 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}. @@ -9930,19 +9996,19 @@ sparse trees with @kbd{C-c / m}. @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 prompts for a selection criterion@comma{} which is a boolean logic +expression with tags@comma{} like @samp{+work+urgent-withboss} or @samp{work|home} +(see @ref{Tags}). If you often need a specific search@comma{} 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-agenda-tags-todo-honor-ignore-options -Like @kbd{m}, but only select headlines that are also TODO -items. To exclude scheduled/deadline items, see the variable +Like @kbd{m}@comma{} but only select headlines that are also TODO +items. To exclude scheduled/deadline items@comma{} 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}. +keywords together with a tags match is also possible@comma{} see @ref{Tag Searches}. @end table The commands available in the tags list are described in @ref{Agenda Commands}. @@ -9950,52 +10016,52 @@ 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 +implemented. Each element in the search is either a tag@comma{} a regular +expression matching tags@comma{} or an expression like @samp{PROPERTY OPERATOR +VALUE} with a comparison operator@comma{} accessing a property value. Each +element may be preceded by @samp{-} to select against it@comma{} 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 +optional when @samp{+} or @samp{-} is present. Here are some examples@comma{} using only tags. @table @asis @item @samp{+work-boss} -Select headlines tagged @samp{work}, but discard those also tagged +Select headlines tagged @samp{work}@comma{} 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 +Like before@comma{} 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 (see @ref{Regular Expressions}). For example, +Instead of a tag@comma{} you may also specify a regular expression enclosed +in curly braces (see @ref{Regular Expressions}). For example@comma{} @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 +E.g.@comma{} if @samp{work} is a group tag for the group @samp{:work:lab:conf:}@comma{} 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\)@}}). +the tags in the group (i.e.@comma{} @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 +same time as matching tags. The properties may be real properties@comma{} or +special properties that represent other metadata (see @ref{Special Properties}). For example@comma{} the property @samp{TODO} represents the TODO +keyword of the entry. Or@comma{} 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 +TODO keyword @samp{DONE}. In buffers with @code{org-odd-levels-only} set@comma{} +@samp{LEVEL} does not count the number of stars@comma{} but @samp{LEVEL=2} corresponds to 3 stars etc. Here are more examples: @@ -10009,7 +10075,7 @@ Select @samp{work}-tagged TODO lines with the specific TODO keyword Waiting tasks both at work and at home. @end table -When matching properties, a number of different operators can be used +When matching properties@comma{} a number of different operators can be used to test the value of a property. Here is a complex example: @example @@ -10023,61 +10089,61 @@ 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{<>}. As a synonym for the equality operator @samp{=}, there is also +If the comparison value is a plain number@comma{} a numerical comparison is +done@comma{} and the allowed operators are @samp{<}@comma{} @samp{=}@comma{} @samp{>}@comma{} @samp{<=}@comma{} @samp{>=}@comma{} and +@samp{<>}. As a synonym for the equality operator @samp{=}@comma{} there is also @samp{==}; @samp{!=} and @samp{/=} are synonyms of the inequality operator @samp{<>}. @item -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@comma{} a string +comparison is done@comma{} 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 +brackets (like @samp{DEADLINE<​="<2008-12-24 18:30>"})@comma{} both values are +assumed to be date/time specifications in the standard Org way@comma{} and the comparison is done accordingly. Valid values also include -@samp{""} for now (including time), @samp{""}, and @samp{""} -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. +@samp{""} for now (including time)@comma{} @samp{""}@comma{} and @samp{""} +for these days at 0:00 hours@comma{} i.e.@comma{} without a time specification. +You can also use strings like @samp{"<+5d>"} or @samp{"<-2m>"} with units @samp{d}@comma{} +@samp{w}@comma{} @samp{m}@comma{} and @samp{y} for day@comma{} week@comma{} month@comma{} and year@comma{} 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. +If the comparison value is enclosed in curly braces@comma{} a regexp match +is performed@comma{} with @samp{=} meaning that the regexp matches the property +value@comma{} and @samp{<>} meaning that it does not match. @item -All operators may be optionally followed by an asterisk @samp{*}, like in -@samp{<*}, @samp{!=*}, etc. Such @emph{starred operators} work like their regular, +All operators may be optionally followed by an asterisk @samp{*}@comma{} like in +@samp{<*}@comma{} @samp{!=*}@comma{} etc. Such @emph{starred operators} work like their regular@comma{} unstarred counterparts except that they match only headlines where the tested property is actually present. This is most useful for -search terms that logically exclude results, like the inequality +search terms that logically exclude results@comma{} like the inequality operator. @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. +not @samp{boss}@comma{} which also have a priority value @samp{A}@comma{} a @samp{Coffee} property +with the value @samp{unlimited}@comma{} an @samp{EFFORT} property that is numerically +smaller than 2@comma{} a @samp{With} property that is matched by the regular +expression @samp{Sarah\|Denny}@comma{} and that are scheduled on or after October +11@comma{} 2008. -Note that the test on the @samp{EFFORT} property uses operator @samp{<*}, so +Note that the test on the @samp{EFFORT} property uses operator @samp{<*}@comma{} so that the search result will include only entries that actually have an @samp{EFFORT} property defined and with numerical value smaller than 2. -With the regular @samp{<} operator, the search would handle entries without +With the regular @samp{<} operator@comma{} the search would handle entries without an @samp{EFFORT} property as having a zero effort and would include them in the result as well. You can use all characters valid in property names when matching -properties. However, you have to quote some characters in property -names with backslashes when using them in search strings, namely all +properties. However@comma{} you have to quote some characters in property +names with backslashes when using them in search strings@comma{} namely all characters different from alphanumerics and underscores@footnote{ If you -quote alphanumeric characters or underscores with a backslash, that -backslash is ignored.}. For example, to search for all entries having -a property @samp{boss-prio}, @samp{boss:prio}, or @samp{boss\prio}, respectively, -with value @samp{C}, use search strings +quote alphanumeric characters or underscores with a backslash@comma{} that +backslash is ignored.}. For example@comma{} to search for all entries having +a property @samp{boss-prio}@comma{} @samp{boss:prio}@comma{} or @samp{boss\prio}@comma{} respectively@comma{} +with value @samp{C}@comma{} use search strings @example boss\-prio="C" @@ -10086,19 +10152,19 @@ boss\\prio="C" @end example 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. +a search@comma{} but beware that this can slow down searches considerably. +See @ref{Property Inheritance}@comma{} 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 +For backward compatibility@comma{} and also for typing speed@comma{} there is also +a different way to test TODO states in a search. For this@comma{} 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 +for tags@comma{} but should be applied with care: for example@comma{} a positive selection on several TODO keywords cannot meaningfully be combined -with boolean AND@. However, @emph{negative selection} combined with AND can +with boolean AND@. However@comma{} @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 +have any TODO keyword (resulting in a speed-up)@comma{} use @kbd{M-x org-agenda M}@comma{} 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: @@ -10132,18 +10198,18 @@ 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 +For example@comma{} the search string @samp{computer equipment} matches entries +that contain @samp{computer equipment} as a substring@comma{} 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 +Search view can also search for specific keywords in the entry@comma{} 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]}, +keywords @samp{computer} and @samp{wifi}@comma{} but not the keyword @samp{ethernet}@comma{} and +which are also not matched by the regular expression @samp{8\.11[bg]}@comma{} 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 +necessary to turn on boolean search@comma{} other @samp{+} characters are +optional. For more details@comma{} see the docstring of the command @code{org-search-view}. You can incrementally and conveniently adjust a boolean search from @@ -10161,7 +10227,7 @@ the agenda search view with the following keys @end multitable @vindex org-agenda-text-search-extra-files -Note that in addition to the agenda files, this command also searches +Note that in addition to the agenda files@comma{} this command also searches the files listed in @code{org-agenda-text-search-extra-files}. @node Stuck projects @@ -10170,10 +10236,10 @@ the files listed in @code{org-agenda-text-search-extra-files}. @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 +work@comma{} 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 +no defined next actions@comma{} so it never shows up in the TODO lists Org +mode produces. During the review@comma{} you need to identify such projects and define next actions for them. @table @asis @@ -10191,20 +10257,20 @@ 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 +headlines@comma{} 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 +Let's assume that you@comma{} in your own way of using Org mode@comma{} identify +projects with a tag @samp{:PROJECT:}@comma{} 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 +projects@comma{} 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 +NEXT tag. Finally@comma{} if the project contains the special word @samp{IGNORE} +anywhere@comma{} 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 +@ref{Tag Searches}) @samp{+PROJECT/-MAYBE-DONE}@comma{} and then check for @samp{TODO}@comma{} +@samp{NEXT}@comma{} @samp{@@shop}@comma{} and @samp{IGNORE} in the subtree to identify projects that are not stuck. The correct customization for this is: @lisp @@ -10213,7 +10279,7 @@ are not stuck. The correct customization for this is: "\\")) @end lisp -Note that if a project is identified as non-stuck, the subtree of this +Note that if a project is identified as non-stuck@comma{} the subtree of this entry is searched for stuck projects. @node Presentation and Sorting @@ -10223,7 +10289,7 @@ entry is searched for stuck projects. @vindex org-agenda-prefix-format @vindex org-agenda-tags-column -Before displaying items in an agenda view, Org mode visually prepares +Before displaying items in an agenda view@comma{} 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 @@ -10246,18 +10312,17 @@ version of the outline headline associated with the item. @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 +default@comma{} the category is simply derived from the file name@comma{} but you +can also specify it with a special line in the buffer@comma{} 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 +a (sub)tree@comma{} give the entry a @samp{CATEGORY} property with the special category you want to apply as the value. @vindex org-agenda-category-icon-alist @@ -10272,13 +10337,12 @@ customizing the @code{org-agenda-category-icon-alist} variable. 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 +agenda@comma{} for example @example <2005-05-10 Tue 19:00> @end example - @noindent Time ranges can be specified with two timestamps: @@ -10286,18 +10350,17 @@ Time ranges can be specified with two timestamps: <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, +In the headline of the entry itself@comma{} a time(range)---like @samp{12:45} or a +@samp{8:30-1pm}---may also appear as plain text@footnote{ You can@comma{} however@comma{} 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}), +If the agenda integrates the Emacs diary (see @ref{Weekly/daily agenda})@comma{} 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 +For agenda display@comma{} 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 @@ -10308,8 +10371,8 @@ the previous paragraphs would end up in the agenda like this: @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 +If the agenda is in single-day mode@comma{} or for the display of today@comma{} the +timed entries are embedded in a time grid@comma{} like @example 8:00...... ------------------ @@ -10328,7 +10391,7 @@ timed entries are embedded in a time grid, like @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-use-time-grid}@comma{} and can be configured with @code{org-agenda-time-grid}. @node Sorting of agenda items @@ -10337,37 +10400,39 @@ The time grid can be turned on and off with the variable @cindex sorting, of agenda items @cindex priorities, of agenda items -Before being inserted into a view, the items are sorted. How this is +Before being inserted into a view@comma{} 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 +For the daily/weekly agenda@comma{} 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 urgency, which is composed -of the base priority (see @ref{Priorities}; 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 urgency. The -urgency used for sorting derives from the priority cookie, with +of the list@comma{} as a @emph{schedule} for the day. After that@comma{} items remain +grouped in categories@comma{} in the sequence given by @code{org-agenda-files}. +Within each category@comma{} items are sorted by urgency@comma{} which is derived +from the priority (see @ref{Priorities})@comma{} plus additional increments +for overdue scheduled or deadline items. The lowest priority is +scored as 0@comma{} the next as 1000@comma{} and continues in steps of 1000 until +reaching the highest priority@comma{} e.g.@comma{} @samp{C}@comma{} @samp{B}@comma{} @samp{A} are scored as 0@comma{} +1000@comma{} and 2000@comma{} respectively. + +@item +For the TODO list@comma{} items remain in the order of categories@comma{} but +within each category@comma{} sorting takes place according to urgency. The +urgency used for sorting derives from the priority cookie@comma{} 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 +For tags matches@comma{} items are not sorted at all@comma{} 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 +@code{org-agenda-sorting-strategy}@comma{} and may also include criteria based on the estimated effort of an entry (see @ref{Effort Estimates}). @node Filtering/limiting agenda items @@ -10381,18 +10446,18 @@ Agenda built-in or custom commands are statically defined. Agenda filters and limits allow flexibly narrowing down the list of agenda entries. -@emph{Filters} only change the visibility of items, are very fast and are +@emph{Filters} only change the visibility of items@comma{} 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} +the variables @code{org-agenda-tag-filter-preset}@comma{} +@code{org-agenda-category-filter-preset}@comma{} @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 +property of the entire agenda view---in a block agenda@comma{} you should +only set this in the global options section@comma{} 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 +the other hand take effect before the agenda buffer is populated@comma{} so they are mostly useful when defined as local variables within custom agenda commands. @@ -10407,12 +10472,12 @@ agenda commands. @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 +The general filtering command is @code{org-agenda-filter}@comma{} bound to +@kbd{/}. Before we introduce it@comma{} 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@comma{} so it removes lines selected by the filter. A double prefix +adds the new filter condition to the one(s) already in place@comma{} so filter elements are accumulated. @table @asis @@ -10421,76 +10486,76 @@ filter elements are accumulated. 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 +tag@comma{} 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, +filter@comma{} press @kbd{\} twice (once to call the command again@comma{} 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 +Filter by category of the line at point@comma{} and show only entries with +this category. When called with a prefix argument@comma{} hide all entries +with the category at point. To clear the filter@comma{} 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{=}. +the filter@comma{} 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 +Filter the agenda view with respect to effort estimates@comma{} so select tasks that take the right amount of time. You first need to set up -a list of efforts globally, for example +a list of efforts globally@comma{} 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-agenda-sort-noeffort-is-high @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 +You can then filter for an effort by first typing an operator@comma{} one +of @kbd{<}@comma{} @kbd{>} and @kbd{=}@comma{} 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 +values@comma{} where @kbd{0} means the 10th value. The filter then +restricts to entries with effort smaller-or-equal@comma{} equal@comma{} 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, +operator@comma{} entries without a defined effort are treated according to +the value of @code{org-agenda-sort-noeffort-is-high}. To clear the +filter@comma{} press @kbd{_} twice (once to call the command again@comma{} 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{^}. +the filter@comma{} 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, +described above. At the prompt@comma{} specify different filter elements +in a single string@comma{} with full completion support. For example@comma{} @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 +minutes@comma{} and deselects entries with tag @samp{John} or matching the regexp @samp{plot} (see @ref{Regular Expressions}). 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 +between categories and tags. Otherwise@comma{} tags take priority. If you +reply to the prompt with the empty string@comma{} all filtering is removed. +If a filter is specified@comma{} it replaces all current filters. But if +you call the command with a double prefix argument@comma{} or if you add an +additional @samp{+} (e.g.@comma{} @samp{++work}) to the front of the string@comma{} the new filter elements are added to the active ones. A single prefix argument applies the entire filter in a negative sense. @@ -10503,16 +10568,16 @@ Remove all filters in the current agenda view. @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 +a user-defined function@comma{} 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 +entries with that tag@comma{} @samp{"+tag"} if only entries with this tag should +be kept@comma{} or @samp{nil} if that tag is irrelevant. For example@comma{} let's say +you use a @samp{Net} tag to identify tasks which need network access@comma{} an +@samp{Errand} tag for errands in town@comma{} 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: +the Internet@comma{} and outside of business hours@comma{} with something like this: @lisp (defun my-auto-exclude-fn (tag) @@ -10528,7 +10593,7 @@ the Internet, and outside of business hours, with something like this: @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 /}, +argument to @code{org-agenda-filter}@comma{} i.e.@tie{}press @kbd{C-u C-u C-u /}@comma{} or by pressing @kbd{@key{RET}} in @code{org-agenda-filter-by-tag}. @anchor{Setting limits for the agenda} @@ -10536,7 +10601,7 @@ or by pressing @kbd{@key{RET}} in @code{org-agenda-filter-by-tag}. @cindex limits, in agenda -Here is a list of options that you can set, either globally, or +Here is a list of options that you can set@comma{} either globally@comma{} or locally in your custom agenda views (see @ref{Custom Agenda Views}). @table @asis @@ -10557,13 +10622,13 @@ Limit the number of entries with TODO keywords. 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)} +When set to a positive integer@comma{} each option excludes entries from +other categories: for example@comma{} @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 +property@comma{} 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 +command. For example@comma{} this custom command displays the next five entries with a @samp{NEXT} TODO keyword. @lisp @@ -10572,11 +10637,11 @@ entries with a @samp{NEXT} TODO keyword. ((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 +Once you mark one of these five entry as DONE@comma{} rebuilding the agenda +will again the next five entries again@comma{} including the first entry that was excluded so far. -You can also dynamically set temporary limits, which are lost when +You can also dynamically set temporary limits@comma{} which are lost when rebuilding the agenda: @table @asis @@ -10592,13 +10657,13 @@ This prompts for the type of limit to apply and its value. 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, +buffer itself@comma{} but commands are provided to show and jump to the +original entry location@comma{} and to edit the Org files ``remotely'' from the +agenda buffer. In this way@comma{} all information is stored only once@comma{} 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. +the other commands@comma{} point needs to be in the desired line. @anchor{Motion (1)} @subheading Motion @@ -10628,7 +10693,7 @@ Previous line (same as @kbd{@key{UP}} and @kbd{C-p}). @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. +With a prefix argument@comma{} make sure that drawers stay folded. @item @kbd{L} (@code{org-agenda-recenter}) @findex org-agenda-recenter @@ -10649,8 +10714,8 @@ Go to the original location of the item and delete other windows. @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 +Toggle Follow mode. In Follow mode@comma{} as you move point through the +agenda buffer@comma{} 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}. @@ -10659,9 +10724,9 @@ agenda buffers can be set with the variable @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. With a numeric prefix argument N@comma{} go up to level N and then +take that tree. If N is negative@comma{} go up that many levels. With +a @kbd{C-u} prefix@comma{} do not remove the previously used indirect buffer. @item @kbd{C-c C-o} (@code{org-agenda-open-link}) @@ -10669,7 +10734,7 @@ buffer. @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. +link@comma{} follow it without a selection prompt. @end table @anchor{Change display} @@ -10692,44 +10757,44 @@ Delete other windows. @kindex v d @kindex d @findex org-agenda-day-view -Switch to day view. When switching to day view, this setting +Switch to day view. When switching to day view@comma{} 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 +the year. For example@comma{} @kbd{32 d} jumps to February 1st. When +setting day view@comma{} a year may be encoded in the prefix argument as +well. For example@comma{} @kbd{200712 d} jumps to January 12@comma{} 2007. +If such a year specification has only one or two digits@comma{} 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 +Switch to week view. When switching week view@comma{} 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 +setting week view@comma{} a year may be encoded in the prefix argument as +well. For example@comma{} @kbd{200712 w} jumps to week 12 in 2007. +If such a year specification has only one or two digits@comma{} 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 +Switch to month view. Because month views are slow to create@comma{} 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 +day of the month. When setting month view@comma{} a year may be encoded in +the prefix argument as well. For example@comma{} @kbd{200712 m} jumps +to December 2007. If such a year specification has only one or two +digits@comma{} 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 +Switch to year view. Because year views are slow to create@comma{} 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. @@ -10744,8 +10809,8 @@ Reset the current view to @code{org-agenda-span}. @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. +For example@comma{} if the display covers a week@comma{} switch to the following +week. With a prefix argument@comma{} repeat that many times. @item @kbd{b} (@code{org-agenda-earlier}) @kindex b @@ -10779,14 +10844,14 @@ Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. @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 +Toggle Logbook mode. In Logbook mode@comma{} 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 +shown in the agenda@comma{} 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, +called with a @kbd{C-u} prefix argument@comma{} show all possible +logbook entries@comma{} including state changes. When called with two +prefix arguments @kbd{C-u C-u}@comma{} show only logging information@comma{} 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}) @@ -10800,11 +10865,11 @@ weekly/daily agenda. @kindex v a @findex org-agenda-archives-mode @vindex org-agenda-start-with-archives-mode -Toggle Archives mode. In Archives mode, trees that are archived +Toggle Archives mode. In Archives mode@comma{} trees that are archived (see @ref{Internal archiving}) are also scanned when producing the -agenda. To exit archives mode, press @kbd{v a} again. The +agenda. To exit archives mode@comma{} press @kbd{v a} again. The initial setting for this mode in new agenda buffers can set with the -variable @code{org-agenda-start-with-archives-mode}, which can be set +variable @code{org-agenda-start-with-archives-mode}@comma{} which can be set with the same values as @code{org-agenda-archives-mode}. @item @kbd{v A} @@ -10817,27 +10882,27 @@ Toggle Archives mode. Include all archive files as well. @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 +Toggle Clockreport mode. In Clockreport mode@comma{} 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}), +prefix argument when toggling this mode (i.e.@comma{} @kbd{C-u R})@comma{} 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 variables +here@comma{} effort filtering is ignored.}. See also the variables @code{org-clock-report-include-clocking-task} and @code{org-agenda-clock-report-header}. @item @kbd{v c} @kindex v c @vindex org-agenda-clock-consistency-checks -Show overlapping clock entries, clocking gaps, and other clocking +Show overlapping clock entries@comma{} clocking gaps@comma{} 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 +return to normal agenda display@comma{} press @kbd{l} to exit Logbook mode. @item @kbd{v E} or short @kbd{E} (@code{org-agenda-entry-text-mode}) @@ -10846,12 +10911,12 @@ mode. @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. +Toggle entry text mode. In entry text mode@comma{} a number of lines from +the Org heading 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 @@ -10860,14 +10925,13 @@ the prefix value. 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} +@item @kbd{r} (@code{org-agenda-redo})@comma{} @kbd{g} @kindex r @kindex g @findex org-agenda-redo -Recreate the agenda buffer, for example to reflect the changes after +Recreate the agenda buffer@comma{} 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, +@kbd{S-@key{RIGHT}}. When the buffer is the global TODO list@comma{} a prefix argument is interpreted to create a selective list for a specific TODO keyword. @@ -10875,7 +10939,7 @@ a specific TODO keyword. @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 +Save all Org buffers in the current Emacs session@comma{} and also the locations of IDs. @item @kbd{C-c C-x C-c} (@code{org-agenda-columns}) @@ -10883,24 +10947,24 @@ locations of IDs. @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 +column view format is taken from the entry at point@comma{} or@comma{} if there is +no entry at point@comma{} 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 +(taken from a property@comma{} from a @samp{COLUMNS} keyword@comma{} 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 +Remove the restriction lock on the agenda@comma{} 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. +argument@comma{} drag backward by that many lines. Moving agenda lines does not persist after an agenda refresh and does not modify the contributing Org files. @@ -10909,7 +10973,7 @@ does not modify the contributing Org files. @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. +argument@comma{} drag forward by that many lines. @end table @anchor{Remote editing} @@ -10932,17 +10996,17 @@ 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. +Change the TODO state of the item@comma{} both in the agenda and in the +original Org file. A prefix argument is passed through to the +@code{org-todo} command@comma{} 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} +@item @kbd{C-S-@key{LEFT}}@comma{} @code{org-agenda-todo-previousset} @kindex C-S-LEFT Switch to the previous set of TODO keywords. @@ -10952,7 +11016,7 @@ Switch to the previous set of TODO keywords. @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 +remotely is longer than one line@comma{} 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}) @@ -10967,7 +11031,7 @@ Refile the entry at point. @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. +When using the @kbd{a} key@comma{} confirmation is required. @item @kbd{C-c C-x a} (@code{org-agenda-toggle-archive-tag}) @kindex C-c C-x a @@ -10986,7 +11050,7 @@ sibling}. @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 +means the entry is moved to the configured archive location@comma{} most likely a different file. @item @kbd{T} (@code{org-agenda-show-tags}) @@ -10994,20 +11058,20 @@ likely a different file. @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 +you have turned off @code{org-agenda-show-inherited-tags}@comma{} 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. +the agenda@comma{} change a tag for all headings in the region. -@item @kbd{,} (@code{org-agenda-priority}) +@item @kbd{@comma{}} (@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 +priority character. If you reply with @kbd{@key{SPC}}@comma{} the priority cookie is removed from the entry. @item @kbd{+} or @kbd{S-@key{UP}} (@code{org-agenda-priority-up}) @@ -11015,7 +11079,7 @@ cookie is removed from the entry. @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 +in the original buffer@comma{} 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}) @@ -11035,9 +11099,9 @@ Set the effort property for the current item. @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 +Add a note to the entry. This note is recorded@comma{} 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. +@code{org-log-into-drawer}@comma{} this may be inside a drawer. @item @kbd{C-c C-a} (@code{org-attach}) @kindex C-c C-a @@ -11047,27 +11111,27 @@ 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 +Schedule this item. With a prefix argument@comma{} 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 +Set a deadline for this item. With a prefix argument@comma{} 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 +into the future. If the date is in the past@comma{} the first call to this +command moves it to today. With a numeric prefix argument@comma{} change +it by that many days. For example@comma{} @kbd{3 6 5 S-@key{RIGHT}} changes +it by a year. With a @kbd{C-u} prefix@comma{} change the time by one +hour. If you immediately repeat the command@comma{} 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 +@kbd{C-u C-u} prefix@comma{} do the same for changing minutes. The +stamp is changed in the original Org file@comma{} but the change is not directly reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer. @@ -11081,13 +11145,13 @@ into the past. @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{>} has been chosen@comma{} 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, +Start the clock on the current item. If a clock is running already@comma{} it is stopped first. @item @kbd{O} (@code{org-agenda-clock-out}) @@ -11110,7 +11174,7 @@ Jump to the running clock in another window. @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 +Like @code{org-capture}@comma{} 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 @@ -11127,8 +11191,8 @@ this the default behavior of @code{org-capture}. @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. +region in the agenda@comma{} mark the entries in the region. With numeric +prefix argument@comma{} mark that many successive entries. @item @kbd{*} (@code{org-agenda-bulk-mark-all}) @kindex * @@ -11174,9 +11238,9 @@ Mark entries matching a regular expression for bulk action. 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{d} commands@comma{} to bulk-remove these special timestamps. By +default@comma{} marks are removed after the bulk. If you want them to +persist@comma{} set @code{org-agenda-bulk-persistent-marks} to @code{t} or hit @kbd{p} at the prompt. @table @asis @@ -11192,7 +11256,7 @@ 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 +changes the state of all selected entries@comma{} bypassing blocking and suppressing logging notes---but not timestamps. @item @kbd{+} @@ -11203,8 +11267,8 @@ 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}. +dates by a fixed number of days@comma{} use something starting with +double plus at the prompt@comma{} for example @samp{++8d} or @samp{++2w}. @item @kbd{d} Set deadline to a specific date. @@ -11216,14 +11280,14 @@ 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 +With a prefix argument (@kbd{C-u B S})@comma{} 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} +entries. For example@comma{} the function below sets the @samp{CATEGORY} property of the entries to @samp{web}. @lisp @@ -11252,7 +11316,7 @@ 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 +When in the calendar@comma{} compute and show the Org agenda for the date at point. @item @kbd{i} (@code{org-agenda-diary-entry}) @@ -11260,23 +11324,23 @@ at point. @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 +Insert a new entry into the diary@comma{} 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 +@code{org-agenda-include-diary} is set.}@comma{} 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. +another window@comma{} 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, +If you configure @code{org-agenda-diary-file} to point to an Org file@comma{} 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, +entry with a @samp{DATE_TREE} property@comma{} or else with years as top-level +entries. Emacs prompts you for the entry text---if you specify it@comma{} 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 +without typing text@comma{} 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}) @@ -11289,7 +11353,7 @@ date. @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 +set with calendar variables@comma{} see the documentation for the Emacs calendar. @item @kbd{C} (@code{org-agenda-convert-date}) @@ -11312,14 +11376,14 @@ Show holidays for three months around point date. @kindex q @findex org-agenda-quit -Quit agenda, remove the agenda buffer. +Quit agenda@comma{} 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 +Exit agenda@comma{} 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 @@ -11331,9 +11395,9 @@ user to visit Org files are not removed. @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 +frequently used TODO and tags searches@comma{} and to create special composite agenda buffers. Custom agenda commands are accessible -through the dispatcher (see @ref{Agenda Dispatcher}), just like the +through the dispatcher (see @ref{Agenda Dispatcher})@comma{} just like the default commands. @menu @@ -11346,8 +11410,8 @@ default commands. @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 +shortcuts for frequently used searches@comma{} either creating an agenda +buffer@comma{} or a sparse tree (the latter covering of course only the current buffer). @kindex C @r{(Agenda dispatcher)} @@ -11362,7 +11426,7 @@ current buffer). @cindex occur-tree @cindex tags-tree Custom commands are configured in the variable -@code{org-agenda-custom-commands}. You can customize this variable, for +@code{org-agenda-custom-commands}. You can customize this variable@comma{} 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: @@ -11385,23 +11449,23 @@ views: 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 +this is just a single character@comma{} but if you have many similar +commands@comma{} 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 +is the search type@comma{} 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 timestamp, a scheduled or +information attached to them@comma{} like a timestamp@comma{} 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 +as the same search@comma{} but only for entries with an hour specification like @samp{[h]h:mm}---think of them as appointments. @item @kbd{w} @@ -11409,7 +11473,7 @@ 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 +as the same search@comma{} but only in the current buffer and displaying the results as a sparse tree. @item @kbd{u} @@ -11417,21 +11481,21 @@ 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 +The same search@comma{} 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 +as the same search@comma{} 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 +to create a sparse tree (again@comma{} 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. +an additional key (@kbd{l}@comma{} @kbd{p} or @kbd{k}) to +select a name (Lisa@comma{} Peter@comma{} or Kim) as additional tag to match. @end table Note that @code{*-tree} agenda views need to be called from an Org buffer @@ -11444,12 +11508,12 @@ as they operate on the current buffer only. @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 results of @emph{several} commands@comma{} 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 +daily or weekly agenda (as created with @kbd{a})@comma{} @code{alltodo} for +the global TODO list (as constructed with @kbd{t})@comma{} @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}. +matching commands discussed above: @code{todo}@comma{} @code{tags}@comma{} and @code{tags-todo}. Here are two examples: @@ -11468,8 +11532,8 @@ Here are two examples: @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 +agenda for the current week@comma{} all TODO items that carry the tag @samp{home}@comma{} +and also all lines tagged with @samp{garden}. Finally@comma{} the command @kbd{o} provides a similar view for office tasks. @node Setting options @@ -11480,8 +11544,8 @@ and also all lines tagged with @samp{garden}. Finally the command @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. +commands@comma{} including the custom commands. However@comma{} if you want to +change some settings just for a single custom view@comma{} 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: @@ -11491,7 +11555,7 @@ at the right spot in @code{org-agenda-custom-commands}. For example: ((org-agenda-sorting-strategy '(priority-down)) (org-agenda-prefix-format " Mixed: "))) ("U" tags-tree "+boss-urgent" - ((org-show-context-detail 'minimal))) + ((org-fold-show-context-detail 'minimal))) ("N" search "" ((org-agenda-files '("~org/notes.org")) (org-agenda-text-search-extra-files nil))))) @@ -11499,21 +11563,21 @@ at the right spot in @code{org-agenda-custom-commands}. For example: @noindent Now the @kbd{w} command sorts the collected entries only by -priority, and the prefix format is modified to just say @samp{Mixed:} +priority@comma{} 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 +@kbd{U} now turns out ultra-compact@comma{} because neither the headline +hierarchy above the match@comma{} 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} +For command sets creating a block agenda@comma{} @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 just a single command in the set@comma{} 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 +command entries. Going back to the block agenda example (see @ref{Block agenda})@comma{} let's change the sorting strategy for the @kbd{h} +commands to @code{priority-down}@comma{} but let's sort the results for @samp{garden} +tags query in the opposite order@comma{} @code{priority-up}. This would look like this: @lisp @@ -11530,16 +11594,16 @@ this: (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 +As you see@comma{} the values and parentheses setting is a little complex. +When in doubt@comma{} 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 +in this interface@comma{} the @emph{values} are just Lisp expressions. So if the +value is a string@comma{} 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 +a specific context@comma{} 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 @@ -11551,7 +11615,7 @@ this: @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 +another command key @kbd{r}. In that case@comma{} add this command key like this: @lisp @@ -11566,16 +11630,16 @@ See the docstring of the variable for more information. @cindex agenda views, exporting -If you are away from your computer, it can be very useful to have a +If you are away from your computer@comma{} 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 +export custom agenda views as plain text@comma{} HTML@footnote{ For HTML you need to install Hrvoje NikÅ¡ić's @samp{htmlize.el} as an Emacs package from @uref{https://elpa.nongnu.org/, NonGNU ELPA} 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 +@uref{https://github.com/hniksic/emacs-htmlize, Hrvoje NikÅ¡ić's repository}.}@comma{} +Postscript@comma{} PDF@footnote{To create PDF output@comma{} 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: +postscript file.}@comma{} and iCalendar files. If you +want to do this only occasionally@comma{} use the following command: @table @asis @item @kbd{C-x C-w} (@code{org-agenda-write}) @@ -11588,16 +11652,16 @@ want to do this only occasionally, use the following command: Write the agenda view to a file. @end table -If you need to export certain agenda views frequently, you can +If you need to export certain agenda views frequently@comma{} 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 +or the global TODO list as well@comma{} 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 +global TODO list@comma{} 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. +directory@comma{} or absolute. @lisp (setq org-agenda-custom-commands @@ -11618,17 +11682,17 @@ directory, or absolute. @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}, +is @samp{.html}@comma{} 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}@comma{} @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 +the extension is @samp{.ics}@comma{} iCalendar export is run export over all files +that were used to construct the agenda@comma{} 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 +Instead@comma{} there is a special command to produce @emph{all} specified files in one step: @table @asis @@ -11655,14 +11719,14 @@ set options for the export commands. For example: @noindent @vindex org-agenda-exporter-settings -This command sets two options for the Postscript exporter, to make it +This command sets two options for the Postscript exporter@comma{} 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, +modify the agenda prefix to omit category and scheduling information@comma{} 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 +tags to make the lines compact@comma{} 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., +@code{org-agenda-exporter-settings} also apply@comma{} e.g.@comma{} @lisp (setq org-agenda-exporter-settings @@ -11682,8 +11746,8 @@ 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.} +or@comma{} if you need to modify some parameters@footnote{ Quoting depends on the +system you use@comma{} please check the FAQ for examples.} @example emacs -eval '(org-batch-store-agenda-views \ @@ -11696,10 +11760,10 @@ emacs -eval '(org-batch-store-agenda-views \ @noindent which creates the agenda views restricted to the file -@samp{~/org/project.org}, without diary entries and with a 30-day extent. +@samp{~/org/project.org}@comma{} 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 +processing by other programs. See @ref{Extracting Agenda Information}@comma{} for more information. @node Agenda Column View @@ -11710,7 +11774,7 @@ more information. 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 +can be quite useful to use column view also from the agenda@comma{} where entries are collected by certain criteria. @table @asis @@ -11721,7 +11785,7 @@ entries are collected by certain criteria. Turn on column view in the agenda. @end table -To understand how to use this properly, it is important to realize +To understand how to use this properly@comma{} it is important to realize that the entries in the agenda are no longer in their proper outline environment. This causes the following issues: @@ -11730,36 +11794,36 @@ environment. This causes the following issues: @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 +the entries in the agenda are collected from different files@comma{} and +different files may have different columns formats@comma{} this is a non-trivial problem. Org first checks if -@code{org-overriding-columns-format} is currently set, and if so, takes +@code{org-overriding-columns-format} is currently set@comma{} and if so@comma{} 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 +no such binding exists@comma{} it checks@comma{} in sequence@comma{} +@code{org-columns-default-format-for-agenda}@comma{} 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 +If any of the columns has a summary type defined (see @ref{Column attributes})@comma{} 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 +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; +agenda. In the daily/weekly agenda@comma{} 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 +and its @emph{child}). In these cases@comma{} 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, +When the column view in the agenda shows the @samp{CLOCKSUM} property@comma{} that is always the entire clocked time for this item. So even in -the daily/weekly agenda, the clocksum listed in column view may +the daily/weekly agenda@comma{} 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 @@ -11769,11 +11833,11 @@ 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, +When the column view in the agenda shows the @samp{CLOCKSUM_T} property@comma{} that is always today's clocked time for this item. So even in the -weekly agenda, the clocksum listed in column view only originates +weekly agenda@comma{} 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 +today@comma{} with the time already spent---via @samp{CLOCKSUM}---and with the planned total effort for it. @end enumerate @@ -11781,12 +11845,12 @@ the planned total effort for it. @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 +plain-text notes. However@comma{} it also provides a lightweight yet robust +markup language for rich text formatting and more. For instance@comma{} 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 +@ref{Exporting})@comma{} you can author beautiful documents in Org---like the fine manual you are currently reading. @menu @@ -11796,7 +11860,7 @@ manual you are currently reading. * 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. +* Images and link previews:: Preview links in the buffer * Captions:: Describe tables, images... * Horizontal Rules:: Make a line. * Creating Footnotes:: Edit and read footnotes. @@ -11807,12 +11871,12 @@ manual you are currently reading. @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 +enforce a line break within a paragraph@comma{} 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 +To preserve the line breaks@comma{} indentation and blank lines in a region@comma{} +but otherwise use normal formatting@comma{} you can use this construct@comma{} which can also be used to format poetry. @cindex @samp{BEGIN_VERSE} @@ -11827,7 +11891,7 @@ can also be used to format poetry. #+END_VERSE @end example -When quoting a passage from another document, it is customary to +When quoting a passage from another document@comma{} 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: @@ -11835,18 +11899,18 @@ right margin. You can include quotations in Org documents like this: @cindex quote blocks @example #+BEGIN_QUOTE -Everything should be made as simple as possible, +Everything should be made as simple as possible@comma{} but not any simpler ---Albert Einstein #+END_QUOTE @end example -If you would like to center some text, do it like this: +If you would like to center some text@comma{} do it like this: @cindex @samp{BEGIN_CENTER} @cindex center blocks @example #+BEGIN_CENTER -Everything should be made as simple as possible, \\ +Everything should be made as simple as possible@comma{} \\ but not any simpler #+END_CENTER @end example @@ -11861,8 +11925,8 @@ but not any simpler @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 +You can make words @samp{*bold*}@comma{} @samp{/italic/}@comma{} @samp{_underlined_}@comma{} @samp{=verbatim=} +and @samp{~code~}@comma{} and@comma{} if you must@comma{} @samp{+strike-through+}. Text in the code and verbatim string is not processed for Org specific syntax; it is exported verbatim. Org provides a single command as entry point for inserting the marker character. @@ -11872,28 +11936,28 @@ inserting the marker character. @kindex C-c C-x C-f @findex org-emphasize Prompt for a marker character and insert or change an emphasis. If -there is an active region, change that region to a new emphasis. If -there is no region, just insert the marker characters and position +there is an active region@comma{} change that region to a new emphasis. If +there is no region@comma{} just insert the marker characters and position the cursor between them. @end table @vindex org-fontify-emphasized-text -To turn off fontification for marked up text, you can set +To turn off fontification for marked up text@comma{} you can set @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of -the fontified markup syntax, you can customize +the fontified markup syntax@comma{} you can customize @code{org-emphasis-alist}@footnote{ The markup will still be recognized. Just not highlighted visually in Emacs.}. @vindex org-hide-emphasis-markers -To hide the emphasis markup characters in your buffers, set +To hide the emphasis markup characters in your buffers@comma{} set @code{org-hide-emphasis-markers} to @code{t}. -Sometimes, when marked text also contains the marker character itself, -the result may be unsettling. For example, +Sometimes@comma{} when marked text also contains the marker character itself@comma{} +the result may be unsettling. For example@comma{} @example -/One may expect this whole sentence to be italicized, but the -following ~user/?variable~ contains =/= character, which effectively +/One may expect this whole sentence to be italicized@comma{} but the +following ~user/?variable~ contains =/= character@comma{} which effectively stops emphasis there./ @end example @@ -11907,29 +11971,29 @@ See @ref{Escape Character} for more details. @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 +the readability of ASCII text@comma{} it is not necessary@comma{} but OK@comma{} 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 the sun is R_sun = 6.96 x 10^8 m. On the other hand@comma{} the radius of Alpha Centauri is R_@{Alpha Centauri@} = 1.28 x R_@{sun@}. @end example @vindex org-use-sub-superscripts @vindex org-export-with-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 +context@comma{} Org's convention to always interpret these as subscripts can get in your way. Configure the variable @code{org-use-sub-superscripts} and/or @code{org-export-with-sub-superscripts} to change this convention. -For example, when setting these variables to @code{@{@}}, @samp{a_b} is not +For example@comma{} when setting these variables to @code{@{@}}@comma{} @samp{a_b} is not displayed/exported@footnote{The underlying markup still remains a sub/superscript. Only the visual display and export behavior -changes.} as a subscript, but @samp{a_@{b@}} is. +changes.} as a subscript@comma{} but @samp{a_@{b@}} is. You can set both @code{org-use-sub-superscripts} @code{org-export-with-sub-superscripts} in a file using the export option -@samp{^:} (see @ref{Export Settings}). For example, +@samp{^:} (see @ref{Export Settings, , Export Settings}). For example@comma{} @samp{#+OPTIONS: ^:@{@}} sets the two options to @code{@{@}} and limits super- and subscripts to the curly bracket notation. @@ -11957,34 +12021,34 @@ option @code{org-use-sub-superscripts}. @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 +entities---like @samp{\alpha} to indicate the Greek letter@comma{} or @samp{\to} to indicate +an arrow. Completion for these symbols is available@comma{} just type @samp{\} +and maybe a few letters@comma{} and press @kbd{M-@key{TAB}} to see possible +completions. If you need such a symbol inside a word@comma{} terminate it with a pair of curly brackets. For example @example -Pro tip: Given a circle \Gamma of diameter d, the length of its +Pro tip: Given a circle \Gamma of diameter d@comma{} 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 +A large number of entities is provided@comma{} 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 +During export@comma{} these symbols are transformed into the native format of the exporter backend. Strings like @samp{\alpha} are exported as @samp{α} in -the HTML output, and as @samp{\(\alpha\)} in the @LaTeX{} output. Similarly, @samp{\nbsp} +the HTML output@comma{} and as @samp{\(\alpha\)} in the @LaTeX{} output. Similarly@comma{} @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 +If you would like to see entities displayed as UTF-8 characters@comma{} 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 +the variable @code{org-pretty-entities}@comma{} or on a per-file basis with the @samp{STARTUP} option @samp{entitiespretty}.}: @table @asis @@ -11993,18 +12057,18 @@ the variable @code{org-pretty-entities}, or on a per-file base with the @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 +change the buffer content which remains plain ASCII@comma{} 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 +In addition to regular entities defined above@comma{} 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. +combinations: @samp{\-} is treated as a shy hyphen@comma{} @samp{--} and @samp{---} are +converted into dashes@comma{} and @samp{...} becomes a compact set of dots. @node Embedded @LaTeX{} @section Embedded @LaTeX{} @@ -12012,14 +12076,14 @@ converted into dashes, and @samp{...} becomes a compact set of dots. @cindex @TeX{} interpretation @cindex @LaTeX{} interpretation -Plain ASCII is normally sufficient for almost all note taking. -Exceptions include scientific notes, which often require mathematical +Plain ASCII is normally sufficient for almost all note-taking. +Exceptions include scientific notes@comma{} 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 +from @TeX{}@comma{} 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 +into its files@comma{} because many academics are used to writing and reading +@LaTeX{} source code@comma{} and because it can be readily processed to produce pretty output for a number of export backends. @menu @@ -12034,9 +12098,9 @@ pretty output for a number of export backends. @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 backends. When exporting to @LaTeX{}, -the code is left as it is. When exporting to HTML, Org can use either +Org mode can contain @LaTeX{} math fragments@comma{} and it supports ways to +process these for several export backends. When exporting to @LaTeX{}@comma{} +the code is left as it is. When exporting to HTML@comma{} Org can use either @uref{https://www.mathjax.org, MathJax} (see @ref{Math formatting in HTML export}) or transcode the math into images (see @ref{Previewing @LaTeX{} fragments}). @@ -12045,44 +12109,44 @@ 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 +Environments of any kind@footnote{When MathJax is used@comma{} only the environments recognized by +MathJax are processed. When dvipng@comma{} dvisvgm@comma{} or ImageMagick suite is +used to create images@comma{} any @LaTeX{} environment is handled.}. The only requirement is that the +@samp{\begin} statement appears on a new line@comma{} preceded by only whitespace. @item Text within the usual @LaTeX{} math delimiters. Prefer @samp{\(...\)} for inline fragments. The @samp{$...$} alternative has some restrictions and may be a source of confusion. 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 +specifications@comma{} single @samp{$} characters are only recognized as math +delimiters if the enclosed text contains at most two line breaks@comma{} is directly attached to the @samp{$} characters with no whitespace in -between, and if the closing @samp{$} is followed by whitespace or +between@comma{} and if the closing @samp{$} is followed by whitespace or punctuation (but not a dash). -Sometimes, it may necessary to have a literal dollar symbol even +Sometimes@comma{} it may be necessary to have a literal dollar symbol even when it is recognized as @LaTeX{} math delimiter. Org provides @samp{\dollar} and @samp{\USD} entities (see @ref{Special Symbols}) that are rendered as @samp{$} for -such scenarios. Also, see @ref{Escape Character}. +such scenarios. Also@comma{} see @ref{Escape Character}. @end itemize @noindent For example: @example -\begin@{equation@} % arbitrary environments, -x=\sqrt@{b@} % even tables, figures, etc +\begin@{equation@} % arbitrary environments@comma{} +x=\sqrt@{b@} % even tables@comma{} figures@comma{} etc \end@{equation@} -If $a^2=b$ and \( b=2 \), then the solution must be +If $a^2=b$ and \( b=2 \)@comma{} 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{} backends. +MathJax for HTML@comma{} and no processing for ASCII and @LaTeX{} backends. You can also set this variable on a per-file basis using one of these lines: @@ -12092,7 +12156,7 @@ lines: @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 +@tab Verbatim export@comma{} for jsMath or so @end multitable @node Previewing @LaTeX{} fragments @@ -12101,20 +12165,20 @@ lines: @cindex @LaTeX{} fragments, preview @vindex org-preview-latex-default-process -If you have a working @LaTeX{} installation and @samp{dvipng}, @samp{dvisvgm} or +If you have a working @LaTeX{} installation and @samp{dvipng}@comma{} @samp{dvisvgm} or @samp{convert} installed@footnote{These are respectively available at -@uref{https://sourceforge.net/projects/dvipng/}, @uref{http://dvisvgm.bplaced.net/} +@uref{https://sourceforge.net/projects/dvipng/}@comma{} @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 +variable @code{org-preview-latex-default-process} accordingly.}@comma{} @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 +while exporting to HTML (see @ref{@LaTeX{} fragments})@comma{} 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}) +In particular@comma{} the @code{:scale} (and for HTML export@comma{} @code{:html-scale}) property of the former can be used to adjust the size of the preview images. @@ -12124,12 +12188,12 @@ images. @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 +it over the source code. If there is no fragment at point@comma{} process all fragments in the current entry---between two headlines. -When called with a single prefix argument, clear all images in the +When called with a single prefix argument@comma{} 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 +fragments in the buffer@comma{} while three of them clear all the images in that buffer. @end table @@ -12140,8 +12204,7 @@ You can turn on the previewing of all @LaTeX{} fragments in a file with #+STARTUP: latexpreview @end example - -To disable it, simply use +To disable it@comma{} simply use @example #+STARTUP: nolatexpreview @@ -12154,21 +12217,21 @@ To disable it, simply use 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 +environments and math templates. Inside Org mode@comma{} 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{}) -from @uref{https://elpa.nongnu.org/, NonGNU ELPA} 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 +@samp{cdlatex.el} and @samp{texmathp.el} (the latter comes also with AUC@TeX{}). +The @samp{cdlatex} package can be installed from +@uref{https://elpa.nongnu.org/nongnu/cdlatex.html, NonGNU ELPA} with the +@uref{https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html, Emacs +packaging system}. Do not use CD@LaTeX{} mode itself under Org mode@comma{} +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}@comma{} 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 +When this mode is enabled@comma{} the following features are present (for more details see the documentation of CD@LaTeX{} mode): @table @asis @@ -12182,42 +12245,41 @@ Insert an environment template. 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}} +such a fragment@comma{} see the documentation of the function +@code{org-inside-LaTeX-fragment-p}.}. For example@comma{} @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 +Even outside fragments@comma{} @kbd{@key{TAB}} expands environment +abbreviations at the beginning of a line. For example@comma{} if you write +@samp{equ} at the beginning of a line and press @kbd{@key{TAB}}@comma{} this abbreviation is expanded to an @samp{equation} environment. To get -a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. +a list of all abbreviations@comma{} type @kbd{M-x cdlatex-command-help}. -@item @kbd{^} -@itemx @kbd{_} +@item @kbd{^}@comma{} @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 +@kbd{@key{TAB}} to move out of the braces@comma{} and if the braces surround +only a single character or macro@comma{} 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, +Pressing the backquote followed by a character inserts math macros@comma{} also outside @LaTeX{} fragments. If you wait more than 1.5 seconds -after the backquote, a help window pops up. +after the backquote@comma{} a help window pops up. @item @kbd{'} @kindex ' Pressing the single-quote followed by another character modifies the @LaTeX{} 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. +more than 1.5 seconds after the single-quote@comma{} a help window pops up. Character modification works only inside @LaTeX{} fragments; outside the quote is normal. @end table @@ -12229,7 +12291,7 @@ the quote is normal. @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 +markup. Such examples are typeset in monospace@comma{} so this is well suited for source code and similar examples. @cindex @samp{BEGIN_EXAMPLE} @@ -12241,19 +12303,19 @@ suited for source code and similar examples. @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 +There is one limitation@comma{} however. You must insert a comma right +before lines starting with either @samp{*}@comma{} @samp{@comma{}*}@comma{} @samp{#+} or @samp{@comma{}#+}@comma{} 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 +@comma{}* I am no real headline #+END_EXAMPLE @end example -For simplicity when using small examples, you can also start the +For simplicity when using small examples@comma{} you can also start the example lines with a colon followed by a space. There may also be additional whitespace before the colon: @@ -12264,17 +12326,17 @@ Here is an example @cindex formatting source code, markup rules @vindex org-latex-src-block-backend -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 +If the example is source code from a programming language@comma{} or any +other text that can be marked up by Font Lock in Emacs@comma{} 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). +version 1.34 of the @samp{htmlize.el} package@comma{} which you need to install). Fontified code chunks in @LaTeX{} can be achieved using either the -@uref{https://www.ctan.org/pkg/listings, listings} @LaTeX{} package, @uref{https://www.ctan.org/pkg/minted, minted} @LaTeX{} package, or by using -@uref{https://elpa.gnu.org/packages/engrave-faces.html, engrave-faces} . Refer to @code{org-latex-src-block-backend} for details.}. This -is done with the code block, where you also need to specify the name +@uref{https://www.ctan.org/pkg/listings, listings} @LaTeX{} package@comma{} @uref{https://www.ctan.org/pkg/minted, minted} @LaTeX{} package@comma{} or by using +@uref{https://elpa.gnu.org/packages/engrave-faces.html, engrave-faces}. Refer to @code{org-latex-src-block-backend} for details.}. This +is done with the code block@comma{} 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.}, +information on evaluating code blocks.}@comma{} see @ref{Structure Templates} for shortcuts to easily insert code blocks. @cindex @samp{BEGIN_SRC} @@ -12287,11 +12349,11 @@ see @ref{Structure Templates} for shortcuts to easily insert code blocks. #+END_SRC @end example -Both in @samp{example} and in @samp{src} snippets, you can add a @samp{-n} switch to -the @samp{#+BEGIN} line@footnote{In the @samp{src} snippets, switches must be placed -right after the language name and before the @ref{Structure of Code Blocks, , header arguments}}, to get the lines of the example numbered. +Both in @samp{example} and in @samp{src} snippets@comma{} you can add a @samp{-n} switch to +the @samp{#+BEGIN} line@footnote{In the @samp{src} snippets@comma{} switches must be placed +right after the language name and before the @ref{Structure of Code Blocks, , header arguments}}@comma{} 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 +line number of the block. If you use a @samp{+n} switch@comma{} 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 @@ -12309,21 +12371,21 @@ the starting line number. #+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 -parentheses. In HTML, hovering the mouse over such a link +In literal examples@comma{} Org interprets strings like @samp{(ref:name)} as +labels@comma{} and use them as targets for special hyperlinks like +@samp{[[(name)]]}---i.e.@comma{} the reference name enclosed in single +parentheses. In HTML@comma{} hovering the mouse over such a link remote-highlights the corresponding code line@footnote{ This requires some -Javascript which is @emph{not} automatically included in the HTML output: +JavaScript which is @emph{not} automatically included in the HTML output: you have to customize the variable @samp{org-html-head-include-scripts} to -@code{t} to have it included (it is @code{nil} by default).}, which is kind of cool. +@code{t} to have it included (it is @code{nil} by default).}@comma{} 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 +source code while using line numbers for the links@comma{} 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. +switch@comma{} links to these references are labeled by the line numbers from +the code listing. Otherwise@comma{} links use the labels with no parentheses. Here is an example: @example @@ -12337,28 +12399,27 @@ jumps to point-min. @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}. +with the surrounding text@comma{} and in particular with plain list structure +(see @ref{Plain Lists}). By default@comma{} Org only retains the relative +indentation between lines@comma{} e.g.@comma{} when exporting the contents of the +block. However@comma{} you can use the @samp{-i} switch to also preserve the +global indentation@comma{} 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 +If the syntax for the label format conflicts with the language syntax@comma{} +use a @samp{-l} switch to change the format@comma{} 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, +Because the @samp{#+BEGIN} @dots{} @samp{#+END} patterns need to be added so often@comma{} a shortcut is provided (see @ref{Structure Templates}). @table @asis @@ -12380,27 +12441,95 @@ creates a new fixed-width region. 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 +buffer@comma{} 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}. +@samp{(label)}@comma{} for retrieval with @kbd{C-c C-l}. + +@node Images and link previews +@section Images and link previews + +Org mode can display previews of hyperlinks (see @ref{Hyperlinks}) +inside Org buffers. By default@comma{} only image links@footnote{Image links are +@samp{file:} and @samp{attachment:} links to existing image files; Emacs can +only display the linked images listed in @code{image-types} variable} can +be previewed inline@comma{} where the images are displayed in place of the +link path. + +You can customize the previews as described in @ref{Adding Hyperlink preview}. Link previews do not have to display images -- any kind of +display decoration (see @ref{Overlay Properties,,,elisp,}) can be +used. + +You can preview the supported link types in the whole buffer@comma{} in the +current section@comma{} active region or at point with the following commands: + +@table @asis +@item @kbd{C-c C-x C-v} (@code{org-link-preview}) +@kindex C-c C-x C-v +@findex org-link-preview +Create inline previews for external links in the active region@comma{} if +any; the link at point@comma{} if there is such; or in the current section +otherwise. With a prefix argument@comma{} clear link previews at point or +in the current entry. With a double prefix argument@comma{} preview all +links in the buffer. With triple prefix argument@comma{} hide previews for +all links in the buffer. + +By default@comma{} only links without descriptions are previewed. You +can force displaying previews for all supported links (including +links with descriptions) using a numeric argument of @code{1}. This +will toggle all previews in the active region@comma{} the link at point +or the current section. A numeric prefix argument of @code{11} will +toggle previews in the whole buffer instead. + +@vindex org-startup-with-link-previews +Org mode can display link previews automatically when opening +buffers. Either customize @code{org-startup-with-link-previews} or use +the @samp{#+STARTUP: linkpreviews} keyword to enable previews for that +specific buffer when opening it. @samp{#+STARTUP: nolinkpreviews} will +disable previews on startup in the buffer. + +@item @kbd{C-c C-x C-M-v} (@code{org-link-preview-refresh}) +@kindex C-c C-x C-M-v +@findex org-link-preview-refresh +Assure inline display of external link previews in the whole buffer +and refresh them. + +@item @kbd{M-x org-link-preview-region} +@findex org-link-preview-region +Create inline previews for external links in the active region@comma{} or +the buffer. With a prefix argument@comma{} also preview links with a text +description part. + +@item @kbd{M-x org-link-preview-clear} +@findex org-link-preview-clear +Clear external link previews in the active region@comma{} or the buffer. +@end table + +@vindex org-cycle-inline-images-display +Link previews can also be displayed when cycling the folding state. +When the custom option @code{org-cycle-link-previews-display} is set@comma{} +supported link types under the subtree (including images) will be +displayed automatically. + +@menu +* Images:: Display an image. +@end menu @node Images -@section Images +@subsection 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 +@code{image-file-name-regexps}.} that does not have a description part@comma{} 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}), +maybe a label for internal cross-references (see @ref{Internal Links})@comma{} make sure that the link is on a line by itself and precede it with @samp{CAPTION} and @samp{NAME} keywords as follows: @@ -12410,86 +12539,71 @@ make sure that the link is on a line by itself and precede it with [[./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 - +When link previews are displayed as images@comma{} the image size and +alignment can be further customized. @vindex org-image-actual-width @vindex org-image-max-width @cindex @samp{ORG-IMAGE-ACTUAL-WIDTH}, property -By default, Org mode displays inline images according to their -actual width, but no wider than @code{fill-column} characters. +By default@comma{} Org mode displays inline images according to their +actual width@comma{} but no wider than @code{fill-column} characters. You can customize the displayed image width using @code{org-image-actual-width} variable (globally) or @samp{ORG-IMAGE-ACTUAL-WIDTH} property (subtree-level)@footnote{ The width can -be customized in Emacs >= 24.1, built with imagemagick support.}. +be customized in Emacs >= 24.1@comma{} built with ImageMagick support.}. Their value can be the following: @itemize @item -(default) Non-@code{nil}, use the actual width of images when inlining -them. If the actual width is too wide, limit it according to +(default) Non-@code{nil}@comma{} use the actual width of images when inlining +them. If the actual width is too wide@comma{} limit it according to @code{org-image-max-width}. @item -When set to a number, use imagemagick (when available) to set the +When set to a number@comma{} use ImageMagick (when available) to set the image's width to this value. @item -When set to a number in a list, try to get the width from any +When set to a number in a list@comma{} try to get the width from any @samp{#+ATTR.*} keyword if it matches a width specification like: @example #+ATTR_HTML: :width 300px @end example and fall back on that number if none is found. @item -When set to @code{nil}, try to get the width from an @samp{#+ATTR.*} keyword +When set to @code{nil}@comma{} try to get the width from an @samp{#+ATTR.*} keyword and fall back on the original width or @code{org-image-max-width} if none is found. @end itemize -@code{org-image-max-width} limits the maximum displayed image width, but +@code{org-image-max-width} limits the maximum displayed image width@comma{} but only when the image width is not set explicitly. Possible maximum width can be set to: @itemize @item -(default) @code{fill-column}, limit width to @code{fill-column} number of +(default) @code{fill-column}@comma{} limit width to @code{fill-column} number of characters. @item -@code{window}, limit width to current window width. +@code{window}@comma{} limit width to current window width. @item -integer number, limit width to that specified number of pixels. +integer number@comma{} limit width to that specified number of pixels. @item -@code{nil}, do not limit the width. +@code{nil}@comma{} do not limit the width. @end itemize @vindex org-image-align -Org mode can left-align, center or right-align the display of inline +Org mode can left-align@comma{} center or right-align the display of inline images. This setting is controlled (globally) by @code{org-image-align}. -Only standalone images are affected, corresponding to links with no +Only standalone images are affected@comma{} corresponding to links with no surrounding text in their paragraph except for whitespace. Its value can be the following: @itemize @item -(default) The symbol @code{left}, which inserts the image where the +(default) The symbol @code{left}@comma{} which inserts the image where the link appears in the buffer. @item -The symbol @code{center}, which will preview links centered in the +The symbol @code{center}@comma{} which will preview links centered in the Emacs window. @item -The symbol @code{right}, which will preview links right-aligned in the +The symbol @code{right}@comma{} which will preview links right-aligned in the Emacs window. @end itemize @@ -12499,8 +12613,8 @@ Inline image alignment can be specified for each link using the #+ATTR_HTML: :align center @end example Org will use the alignment specification from any @samp{#+ATTR.*} -keyword, such as @samp{#+ATTR_HTML} or @samp{#+ATTR_LATEX}, but @samp{#+ATTR_ORG} -(if present) will override the others. For instance, this link +keyword@comma{} such as @samp{#+ATTR_HTML} or @samp{#+ATTR_LATEX}@comma{} but @samp{#+ATTR_ORG} +(if present) will override the others. For instance@comma{} this link @example #+ATTR_HTML: :align right #+ATTR_ORG: :align center @@ -12509,14 +12623,9 @@ keyword, such as @samp{#+ATTR_HTML} or @samp{#+ATTR_LATEX}, but @samp{#+ATTR_ORG will be displayed centered in Emacs but exported right-aligned to HTML@. -When @samp{#+ATTR_ORG} is not set, inline image alignment is also read -from the @samp{:center} attribute supported by some export backends (like -HTML, @LaTeX{} and Beamer.) - -@vindex org-cycle-inline-images-display -Inline images can also be displayed when cycling the folding state. -When custom option @code{org-cycle-inline-images-display} is set, the -visible inline images under subtree will be displayed automatically. +When @samp{#+ATTR_ORG} is not set@comma{} inline image alignment is also read from +the @samp{:center} attribute supported by some export backends (like HTML@comma{} +@LaTeX{} and Beamer.) @node Captions @section Captions @@ -12533,23 +12642,22 @@ a @samp{CAPTION} keyword immediately before it: |-----+-----| @end example -Optionally, the caption can take the form: +Optionally@comma{} 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 backend, those may or may not be handled. +structures@comma{} the same caption mechanism can apply to many +others---e.g.@comma{} @LaTeX{} equations@comma{} source code blocks. Depending on the +export backend@comma{} 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 +A line consisting of only dashes@comma{} and at least 5 of them@comma{} is exported as a horizontal line. @node Creating Footnotes @@ -12558,9 +12666,9 @@ as a horizontal line. @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 +column 0@comma{} no indentation allowed. It ends at the next footnote +definition@comma{} headline@comma{} or after two consecutive empty lines. The +footnote reference is simply the marker in square brackets@comma{} inside text. Markers always start with @samp{fn:}. For example: @example @@ -12574,21 +12682,21 @@ 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. +A named footnote reference@comma{} where @var{NAME} is a unique +label word@comma{} or@comma{} for simplicity of automatic creation@comma{} 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, +An inline definition of a footnote@comma{} which also specifies a name for +the note. Since Org allows multiple references to the same note@comma{} 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 +Footnote labels can be created automatically@comma{} 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. @@ -12600,19 +12708,19 @@ The following command handles footnotes: 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. +When point is on a footnote reference@comma{} jump to the definition. When +it is at a definition@comma{} jump to the---first---reference. @vindex org-footnote-define-inline @vindex org-footnote-section -Otherwise, create a new footnote. Depending on the variable +Otherwise@comma{} 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, +setting is: @samp{#+STARTUP: fninline} or @samp{#+STARTUP: nofninline}.}@comma{} the +definition is placed right into the text as part of the reference@comma{} 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 +When this command is called with a prefix argument@comma{} a menu of additional options is offered: @multitable @columnfractions 0.1 0.9 @@ -12621,24 +12729,24 @@ additional options is offered: @item @kbd{r} @tab Renumber the simple @samp{fn:N} footnotes. @item @kbd{S} -@tab Short for first @kbd{r}, then @kbd{s} action. +@tab Short for first @kbd{r}@comma{} 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. +@tab Delete the footnote at point@comma{} 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 +@samp{#+STARTUP: nofnadjust}.}@comma{} 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 +If point is on a footnote reference@comma{} jump to the definition. If it +is at the definition@comma{} jump back to the reference. When called at +a footnote location with a prefix argument@comma{} offer the same menu as @kbd{C-c C-x f}. @item @kbd{C-c C-o} or @kbd{mouse-1/2} @@ -12646,7 +12754,7 @@ a footnote location with a prefix argument, offer the same menu as @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. +reference@comma{} and you can use the usual commands to follow these links. @end table @node Exporting @@ -12654,8 +12762,8 @@ reference, and you can use the usual commands to follow these links. @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 +At some point you might want to print your notes@comma{} publish them on the +web@comma{} 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. @@ -12689,17 +12797,17 @@ backends: @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} backend. More libraries +packaging system. For easy discovery@comma{} these packages have a common +naming scheme: @code{ox-NAME}@comma{} where @var{NAME} is a format. For +example@comma{} @code{ox-koma-letter} for @emph{koma-letter} backend. More libraries can be found in the @samp{org-contrib} repository (see @ref{Installation}). @vindex org-export-backends -Org only loads backends for the following formats by default: ASCII, -HTML, iCalendar, @LaTeX{}, and ODT@. Additional backends can be loaded +Org only loads backends for the following formats by default: ASCII@comma{} +HTML@comma{} iCalendar@comma{} @LaTeX{}@comma{} and ODT@. Additional backends 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 backend, add this to your Emacs config: +variable@comma{} or by requiring libraries in the Emacs init file. For +example@comma{} to load the Markdown backend@comma{} add this to your Emacs config: @lisp (require 'ox-md) @@ -12739,8 +12847,8 @@ 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{?}. +a non-@code{nil} value@comma{} Org prompts in the minibuffer. To switch back to +the hierarchical menu@comma{} press @kbd{?}. @table @asis @item @kbd{C-c C-e} (@code{org-export-dispatch}) @@ -12749,14 +12857,14 @@ the hierarchical menu, press @kbd{?}. Invokes the export dispatcher interface. The options show default settings. The @kbd{C-u} prefix argument preserves options from -the previous export, including any subtree selections. +the previous export@comma{} including any subtree selections. @end table Org exports the entire buffer by default. If the Org buffer has an -active region, then Org exports just that region. +active region@comma{} then Org exports just that region. -Within the dispatcher interface, the following key combinations can -further alter what is exported, and how. +Within the dispatcher interface@comma{} the following key combinations can +further alter what is exported@comma{} and how. @table @asis @item @kbd{C-a} @@ -12764,13 +12872,13 @@ further alter what is exported, and how. 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 +complete the exporting process in the background@comma{} 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 +To view this stack@comma{} call the export dispatcher with a double @kbd{C-u} prefix argument. If already in the export dispatcher -menu, @kbd{&} displays the stack. +menu@comma{} @kbd{&} displays the stack. @vindex org-export-in-background You can make asynchronous export the default by setting @@ -12788,35 +12896,35 @@ in the export. Affects only those backend formats that have sections like @samp{...} in HTML@. @vindex org-export-body-only -To make body-only export the default, customize the variable +To make body-only export the default@comma{} customize the variable @code{org-export-body-only}. @item @kbd{C-f} @kindex C-c C-e C-f Toggle force-publishing export. Publish functions normally only -publish changed files (see [BROKEN LINK: **Triggering Publication]). Forced +publish changed files (see @ref{Triggering Publication}). Forced publishing causes files to be published even if their timestamps do not indicate the file has been changed. @vindex org-export-force-publishing -To make forced publishing the default, customize the variable +To make forced publishing the default@comma{} customize the variable @code{org-export-force-publishing}. (This is similar to -@code{org-publish-use-timestamps-flag}, but only affects the export +@code{org-publish-use-timestamps-flag}@comma{} but only affects the export dispatcher.) @item @kbd{C-s} @kindex C-c C-e C-s -Toggle subtree export. When turned on, Org exports only the +Toggle subtree export. When turned on@comma{} Org exports only the subtree starting from point position at the time the export dispatcher was invoked. Org uses the top heading of this subtree -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 +as the document's title. If point is not on a heading@comma{} Org uses the +nearest enclosing header. If point is in the document preamble@comma{} Org signals an error and aborts export. @vindex org-export-initial-scope -To make subtree export the default, customize the variable +To make subtree export the default@comma{} customize the variable @code{org-export-initial-scope}. @item @kbd{C-v} @@ -12827,7 +12935,7 @@ certain parts of an Org document by adjusting the visibility of particular headings. See also @ref{Sparse Trees}. @vindex org-export-visible-only -To make visible-only export the default, customize the variable +To make visible-only export the default@comma{} customize the variable @code{org-export-visible-only}. @end table @@ -12846,17 +12954,17 @@ 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 +In-buffer settings may appear anywhere in the file@comma{} either directly or indirectly through a file included using @samp{#+SETUPFILE: filename or URL} syntax. Option keyword sets tailored to a particular backend 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 +@kbd{#}. To insert keywords individually@comma{} 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 backend, and their equivalent -global variables, include: +The export keywords available for every backend@comma{} and their equivalent +global variables@comma{} include: @table @asis @item @samp{AUTHOR} @@ -12874,7 +12982,7 @@ Entity responsible for output generation @cindex @samp{DATE}, keyword @vindex org-export-date-timestamp-format A date or a timestamp@footnote{ The variable -@code{org-export-date-timestamp-format} defines how this timestamp are +@code{org-export-date-timestamp-format} defines how this timestamp is exported.}. @item @samp{EMAIL} @@ -12886,28 +12994,28 @@ The email address (@code{user-mail-address}). @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 +(@code{org-export-default-language}). With @samp{#+LANGUAGE: fr}@comma{} for +example@comma{} Org translates @samp{Table of contents} to the French @samp{Table des matières}@footnote{For export to @LaTeX{} format---or @LaTeX{}-related formats such as -Beamer---, the @samp{org-latex-package-alist} variable needs further +Beamer---@comma{} the @samp{org-latex-package-alist} variable needs further configuration. See @ref{@LaTeX{} specific export settings}.}. @item @samp{SELECT_TAGS} @cindex @samp{SELECT_TAGS}, keyword @vindex org-export-select-tags -List of tags that will, if present, be selected for export. The +List of tags that will@comma{} if present@comma{} be selected for export. The default value is @code{org-export-select-tags} @samp{("export")}. When a tree -is tagged with @samp{export}, Org selects that tree and its subtrees for -export, ignoring all the other sections that do not possess the +is tagged with @samp{export}@comma{} Org selects that tree and its subtrees for +export@comma{} ignoring all the other sections that do not possess the @samp{export} tag. -When selectively exporting files with @samp{export} tags set, Org does +When selectively exporting files with @samp{export} tags set@comma{} Org does not export any text that appears before the first headline. Note that a file without the @samp{export} tags will export all its sections. -To select non-default tags for export, customize +To select non-default tags for export@comma{} customize @code{org-export-select-tags} (globally) or add @samp{#+SELECT_TAGS: tag1 tag2} to the document. @@ -12916,40 +13024,40 @@ To select non-default tags for export, customize @vindex org-export-exclude-tags List of tags that will be excluded from export. The default value is @code{org-export-exclude-tags} @samp{("noexport")}. When a tree is tagged -with @samp{noexport}, Org excludes that tree and its subtrees from +with @samp{noexport}@comma{} Org excludes that tree and its subtrees from export. Entries tagged with @samp{noexport} are unconditionally excluded from the -export, even if they have an @samp{export} tag. Even if a subtree is not -exported, Org executes any code blocks contained there. +export@comma{} even if they have an @samp{export} tag. Even if a subtree is not +exported@comma{} Org executes any code blocks contained there. -To select non-default tags for the exclusion, customize +To select non-default tags for the exclusion@comma{} customize @code{org-export-exclude-tags} (globally) or add @samp{#+EXCLUDE_TAGS: tag1 tag2} to the document. @item @samp{TITLE} @cindex @samp{TITLE}, keyword @cindex document title -Org displays this title. For long titles, use multiple @samp{#+TITLE} +Org displays this title. For long titles@comma{} 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 +The name of the output file to be generated. Otherwise@comma{} Org generates the file name based on the buffer name and the extension based on the backend format. @end table The @samp{OPTIONS} keyword is a compact form. To configure multiple -options, use several @samp{OPTIONS} lines. @samp{OPTIONS} recognizes the +options@comma{} 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 +the language used@comma{} when activated@comma{} Org treats pairs of double quotes +as primary quotes@comma{} pairs of single quotes as secondary quotes@comma{} and single quote marks as apostrophes. @item @code{*} @@ -12978,12 +13086,12 @@ Toggles whether to preserve line 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 +@samp{^:@{@}}@comma{} @samp{a_@{b@}} is interpreted@comma{} 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}, +Configure how archived trees are exported. When set to @code{headline}@comma{} the export process skips the contents and processes only the headlines (@code{org-export-with-archived-trees}). @@ -13000,7 +13108,7 @@ Toggle expansion of environment variables in file paths @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 +internal link. When set to @code{mark}@comma{} Org clearly marks the problem link in the output (@code{org-export-with-broken-links}). @item @code{c} @@ -13014,7 +13122,7 @@ Toggle inclusion of creator information in the exported file @item @code{d} @vindex org-export-with-drawers -Toggles inclusion of drawers, or list of drawers to include, or list +Toggles inclusion of drawers@comma{} or list of drawers to include@comma{} or list of drawers to exclude (@code{org-export-with-drawers}). @item @code{date} @@ -13037,9 +13145,10 @@ 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 backends, they become list items. +Set the last headline level for export as a headline +(@code{org-export-headline-levels}). For descendants of that level@comma{} +headlines are treated differently. In most backends@comma{} they become +list items. @item @code{inline} @vindex org-export-with-inlinetasks @@ -13049,18 +13158,18 @@ Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}). @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 +set to number N@comma{} 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 +of heading and subheadings entirely. Moreover@comma{} when the value is +@samp{notoc} the headline@comma{} and all its children@comma{} 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}. +headline and contain any combination of these cookies: @samp{SCHEDULED}@comma{} +@samp{DEADLINE}@comma{} or @samp{CLOSED}. @item @code{pri} @vindex org-export-with-priority @@ -13069,7 +13178,7 @@ Toggle inclusion of priority cookies @item @code{prop} @vindex org-export-with-properties -Toggle inclusion of property drawers, or list the properties to +Toggle inclusion of property drawers@comma{} or list the properties to include (@code{org-export-with-properties}). @item @code{stat} @@ -13079,7 +13188,7 @@ Toggle inclusion of statistics cookies @item @code{tags} @vindex org-export-with-tags -Toggle inclusion of tags, may also be @code{not-in-toc} +Toggle inclusion of tags@comma{} may also be @code{not-in-toc} (@code{org-export-with-tags}). @item @code{tasks} @@ -13105,7 +13214,7 @@ 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 +Toggle inclusion of the table of contents@comma{} or set the level limit (@code{org-export-with-toc}). @item @code{todo} @@ -13118,15 +13227,15 @@ Toggle inclusion of TODO keywords into exported text Toggle inclusion of tables (@code{org-export-with-tables}). @end table -When exporting subtrees, special node properties can override the +When exporting subtrees@comma{} 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 -subtree. Except for @samp{SETUPFILE}, all other keywords listed above +example@comma{} @samp{DATE} becomes@comma{} @samp{EXPORT_DATE} when used for a specific +subtree. Except for @samp{SETUPFILE}@comma{} 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 +If @code{org-export-allow-bind-keywords} is non-@code{nil}@comma{} 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. @@ -13142,9 +13251,9 @@ in-buffer settings that cannot be changed using keywords. @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 +you need to use a different depth@comma{} or turn it off entirely@comma{} 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} +on a per-file basis@comma{} using the following @samp{toc} item in @samp{OPTIONS} keyword: @example @@ -13155,14 +13264,16 @@ keyword: @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 backends 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} +contents@footnote{At the moment@comma{} some export backends do not obey this +specification. For example@comma{} @LaTeX{} export excludes by default +every unnumbered headline from the table of contents@comma{} unless you set +the custom variable @samp{org-latex-toc-include-unnumbered} to @samp{t} or add +@samp{:UNNUMBERED: toc} to the section's properties.}. If you need to exclude an unnumbered headline@comma{} +along with all its children@comma{} set the @samp{UNNUMBERED} property to @samp{notoc} value. @example -* Subtree not numbered, not in table of contents either +* Subtree not numbered@comma{} not in table of contents either :PROPERTIES: :UNNUMBERED: notoc :END: @@ -13170,7 +13281,7 @@ value. @cindex @samp{TOC}, keyword Org normally inserts the table of contents in front of the exported -document. To move the table of contents to a different location, +document. To move the table of contents to a different location@comma{} 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). @@ -13182,18 +13293,18 @@ location(s). @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 +Org document@comma{} 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. +inserts a local table of contents@comma{} 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 +Note that for this feature to work properly in @LaTeX{} export@comma{} the Org file requires the inclusion of the titletoc package. Because of -compatibility issues, titletoc has to be loaded @emph{before} hyperref. +compatibility issues@comma{} 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 @@ -13210,9 +13321,9 @@ children of the specified target. #+TOC: headlines 1 :target #TargetSection @end example -The @samp{:target} attribute is supported in HTML, Markdown, ODT, and ASCII export. +The @samp{:target} attribute is supported in HTML@comma{} Markdown@comma{} ODT@comma{} and ASCII export. -Use the @samp{TOC} keyword to generate list of tables---respectively, all +Use the @samp{TOC} keyword to generate list of tables---respectively@comma{} all listings---with captions. @example @@ -13222,7 +13333,7 @@ listings---with captions. @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 +But with @samp{ALT_TITLE} property@comma{} a different entry can be specified for the table of contents. @node Include Files @@ -13232,48 +13343,46 @@ the table of contents. @cindex export, include files @cindex @samp{INCLUDE}, keyword -@ref{Summary of the export process, , During export}, you can include the content of another file. For -example, to include your @samp{.emacs} file, you could use: +@ref{Summary of the export process, , During export}@comma{} you can include the content of another file. For +example@comma{} to include your @samp{.emacs} file@comma{} you could use: @example #+INCLUDE: "~/.emacs" src emacs-lisp @end example - @noindent -There are three positional arguments after the include keyword, they are: +There are three positional arguments after the include keyword@comma{} they are: @enumerate @item -The file name, this is the sole mandatory argument. Org neither -checks for correctness or validates the content in any way. +The file name@comma{} this is the sole mandatory argument. Org neither +checks for correctness nor validates the content in any way. @item The block name to wrap the file content in. When this is -@samp{example}, @samp{export}, or @samp{src} the content is escaped by -@code{org-escape-code-in-string}. Arbitrary block names may be given, -however block names starting with @samp{:} must be quoted, i.e. @samp{":name"}. +@samp{example}@comma{} @samp{export}@comma{} or @samp{src} the content is escaped by +@code{org-escape-code-in-string}. Arbitrary block names may be given@comma{} +however block names starting with @samp{:} must be quoted@comma{} i.e. @samp{":name"}. @item The source code language to use for formatting the contents. This is relevant to both @samp{export} and @samp{src} block types. @end enumerate @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 +If an included file is not specified as having any markup language@comma{} +Org assumes it to 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 +file belong to the same structure---headline@comma{} item---containing the +@samp{INCLUDE} keyword. In particular@comma{} 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 +providing an additional keyword parameter@comma{} @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 +example@comma{} 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 @@ -13282,39 +13391,37 @@ 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 +@tab Include lines 5 to 10@comma{} 10 excluded @item @samp{#+INCLUDE: "~/.emacs" :lines "-10"} -@tab Include lines 1 to 10, 10 excluded +@tab Include lines 1 to 10@comma{} 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 +locally bound to non-@code{nil}. Therefore@comma{} @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, +Therefore@comma{} @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 +To extract only the contents of the matched object@comma{} 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 +or property drawers. For example@comma{} to include the body of the heading +with the custom ID @samp{theory}@comma{} you can use @example #+INCLUDE: "./paper.org::#theory" :only-contents t @end example - The following command allows navigating to the included document: @table @asis @@ -13332,52 +13439,51 @@ Visit the included file at point. @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: +@vindex org-export-replace-macros +Macros replace text snippets during export@footnote{The macro replacement +can be disabled by setting @code{org-export-replace-macros} to nil (default +is t).}. Macros are defined globally in @code{org-export-global-macros}@comma{} +or document-wise with the following syntax: @example -#+MACRO: name replacement text; $1, $2 are arguments +#+MACRO: name replacement text; $1@comma{} $2 are arguments @end example - @noindent -which can be referenced using @samp{@{@{@{name(arg1, arg2)@}@}@}}@footnote{Since commas separate the arguments, commas within arguments +which can be referenced using @samp{@{@{@{name(arg1@comma{} arg2)@}@}@}}@footnote{Since commas separate the arguments@comma{} 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)@}@}@} +#+MACRO: poem Rose is $1@comma{} violet's $2. Life's ordered: Org assists you. +@{@{@{poem(red@comma{}blue)@}@}@} @end example @noindent becomes @example -Rose is red, violet's blue. Life's ordered: Org assists you. +Rose is red@comma{} violet's blue. Life's ordered: Org assists you. @end example - -As a special case, Org parses any replacement text starting with +As a special case@comma{} 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 +Within such templates@comma{} arguments become strings. Thus@comma{} 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 backend specific export options. +paragraphs@comma{} headlines@comma{} verse blocks@comma{} tables cells and lists. Org also +recognizes macro references in keywords@comma{} such as @samp{CAPTION}@comma{} @samp{TITLE}@comma{} +@samp{AUTHOR}@comma{} @samp{DATE}@comma{} and for some backend specific export options. Org comes with following pre-defined macros: @@ -13391,9 +13497,9 @@ Org comes with following pre-defined macros: @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 +keywords throughout the buffer@comma{} separated with white space. +@samp{title}@comma{} @samp{author} and @samp{email} macros are shortcuts for@comma{} +respectively@comma{} @samp{@{@{@{keyword(TITLE)@}@}@}}@comma{} @samp{@{@{@{keyword(AUTHOR)@}@}@}} and @samp{@{@{@{keyword(EMAIL)@}@}@}}. @item @samp{@{@{@{date@}@}@}} @@ -13405,46 +13511,46 @@ 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)@}@}@}} +@itemx @samp{@{@{@{modification-time(FORMAT@comma{} 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 +@code{modification-time} macro is non-@code{nil}@comma{} Org uses @samp{vc.el} to retrieve the document's modification time from the version control system. -Otherwise Org reads the file attributes. +Otherwise@comma{} 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)@}@}@}} +@itemx @samp{@{@{@{property(PROPERTY-NAME@comma{} 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. +the current entry. If @var{SEARCH-OPTION} (see @ref{Search Options}) refers to a remote entry@comma{} use it instead. @item @samp{@{@{@{n@}@}@}} @itemx @samp{@{@{@{n(NAME)@}@}@}} -@itemx @samp{@{@{@{n(NAME, ACTION)@}@}@}} +@itemx @samp{@{@{@{n(NAME@comma{} 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 +values. If @var{ACTION} is @samp{-}@comma{} previous value of the counter +is held@comma{} i.e.@comma{} the specified counter is not incremented. If the +value is a number@comma{} the specified counter is set to that value. If +it is any other non-empty string@comma{} 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. +Moreover@comma{} inline source blocks (see @ref{Structure of Code Blocks}) use the +special @samp{results} macro to mark their output. As such@comma{} you are +advised against re-defining it@comma{} unless you know what you are doing. @vindex org-hide-macro-markers The surrounding brackets can be made invisible by setting @@ -13459,21 +13565,22 @@ Org expands macros at the very beginning of the export process. @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 +@samp{#} and a whitespace are treated as comments and@comma{} as such@comma{} are not exported. @cindex @samp{BEGIN_COMMENT} @cindex comment block -Likewise, regions surrounded by @samp{#+BEGIN_COMMENT} @dots{} @samp{#+END_COMMENT} -are not exported. +Likewise@comma{} comment blocks @samp{#+BEGIN_COMMENT} @dots{} @samp{#+END_COMMENT} are not +exported. @footnote{Just like in @ref{Literal Examples}@comma{} you need to escape +leading @samp{*} with @samp{@comma{}} to avoid interpreting them as headings.} @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. +Finally@comma{} a @samp{COMMENT} keyword at the beginning of an entry@comma{} but after +any other keyword or priority cookie@comma{} comments out the entire subtree. +In this case@comma{} the subtree is not exported and no code block within it +is executed or tangled@footnote{ For less restrictive export limitations@comma{} +consider using a select tag (see @ref{Export Settings}) instead.}. The +command below helps to change the comment status of a headline. @table @asis @item @kbd{C-c ;} (@code{org-toggle-comment}) @@ -13498,7 +13605,7 @@ 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 +On export@comma{} Org fills and justifies text according to the text width set in @code{org-ascii-text-width}. @vindex org-ascii-links-to-notes @@ -13510,22 +13617,18 @@ See the variable @code{org-ascii-links-to-notes} for details. @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} +@item @kbd{C-c C-e t a} (@code{org-ascii-export-to-ascii})@comma{} @kbd{C-c C-e t l}@comma{} @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 +Export as an ASCII file with a @samp{.txt} extension. For @samp{myfile.org}@comma{} +Org exports to @samp{myfile.txt}@comma{} overwriting without warning. For +@samp{myfile.txt}@comma{} 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} +@item @kbd{C-c C-e t A} (@code{org-ascii-export-to-ascii})@comma{} @kbd{C-c C-e t L}@comma{} @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 @@ -13544,9 +13647,9 @@ output. Setting this keyword works similar to the general options @table @asis @item @samp{SUBTITLE} @cindex @samp{SUBTITLE}, keyword -The document subtitle. For long subtitles, use multiple +The document subtitle. For long subtitles@comma{} use multiple @samp{#+SUBTITLE} lines in the Org file. Org prints them on one -continuous line, wrapping into multiple lines if necessary. +continuous line@comma{} wrapping into multiple lines if necessary. @end table @anchor{Header and sectioning structure} @@ -13554,13 +13657,13 @@ continuous line, wrapping into multiple lines if necessary. 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}. +cut-off point where levels become lists@comma{} see @ref{Export Settings}. @anchor{Quoting ASCII text} @subheading Quoting ASCII text -To insert text within the Org file by the ASCII backend, use one the -following constructs, inline, keyword, or export block: +To insert text within the Org file by the ASCII backend@comma{} use one the +following constructs@comma{} inline@comma{} keyword@comma{} or export block: @cindex @samp{ASCII}, keyword @cindex @samp{BEGIN_EXPORT ascii} @@ -13580,7 +13683,7 @@ Org exports text in this block only when using ASCII backend. @cindex @samp{ATTR_ASCII}, keyword @cindex horizontal rules, in ASCII export -ASCII backend recognizes only one attribute, @samp{:width}, which +ASCII backend recognizes only one attribute@comma{} @samp{:width}@comma{} which specifies the width of a horizontal rule in number of characters. The keyword and syntax for specifying widths is: @@ -13596,7 +13699,7 @@ keyword and syntax for specifying widths is: @cindex @samp{BEGIN_JUSTIFYLEFT} @cindex @samp{BEGIN_JUSTIFYRIGHT} -Besides @samp{#+BEGIN_CENTER} blocks (see @ref{Paragraphs}), ASCII backend has +Besides @samp{#+BEGIN_CENTER} blocks (see @ref{Paragraphs})@comma{} ASCII backend has these two left and right justification blocks: @example @@ -13616,9 +13719,13 @@ It's just a jump to the left... 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 +document class for creating presentations in PDF@comma{} HTML@comma{} and other popular display formats. +We strongly recommend familiarizing yourself with Beamer terminology +before reading the rest of this chapter. See +@uref{https://en.wikipedia.org/wiki/Beamer_(LaTeX)} and references therein. + @menu * Beamer export commands:: For creating Beamer documents. * Beamer specific export settings:: For customizing Beamer export. @@ -13636,8 +13743,8 @@ popular display formats. @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. +Export as @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org}@comma{} Org +exports to @samp{myfile.tex}@comma{} overwriting without warning. @item @kbd{C-c C-e l B} (@code{org-beamer-export-as-latex}) @kindex C-c C-e l B @@ -13654,7 +13761,7 @@ 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 +Export as @LaTeX{} file@comma{} convert it to PDF format@comma{} and then open the PDF file. @end table @@ -13690,13 +13797,13 @@ The Beamer outer theme. @item @samp{BEAMER_HEADER} @cindex @samp{BEAMER_HEADER}, keyword -Arbitrary lines inserted in the preamble, just before the @samp{hyperref} +Arbitrary lines inserted in the preamble@comma{} 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 +The document description. For long descriptions@comma{} use multiple +@samp{DESCRIPTION} keywords. By default@comma{} @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. @@ -13704,14 +13811,14 @@ 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} +multiple @samp{KEYWORDS} lines if necessary. By default@comma{} @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 +Document's subtitle. For typesetting@comma{} 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 @@ -13721,7 +13828,7 @@ part of front matter. @node Frames and Blocks in Beamer @subsection Frames and Blocks in Beamer -Org transforms heading levels into Beamer's sectioning elements, +Org transforms heading levels into Beamer's sectioning elements@comma{} frames and blocks. Any Org tree with a not-too-deep-level nesting should in principle be exportable as a Beamer presentation. @@ -13737,65 +13844,70 @@ 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 +the Org tree. In Beamer terminology@comma{} 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 +is set@footnote{If @samp{BEAMER_ENV} is set@comma{} 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-default}. To add more values@comma{} 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} +If @samp{BEAMER_ENV} is set to @samp{appendix}@comma{} Org exports the entry as an +appendix. When set to @samp{note}@comma{} Org exports the entry as a note +within the frame or between frames@comma{} depending on the entry's heading +level. When set to @samp{noteNH}@comma{} Org exports the entry as a note +without its title. When set to @samp{againframe}@comma{} Org exports the entry +with @samp{\againframe} command@comma{} 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 +When @samp{ignoreheading} is set@comma{} 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. +@cindex @samp{BEAMER_SUBTITLE}, property +If @samp{BEAMER_SUBTITLE} is set@comma{} Org exports its value as the subtitle +for the headline's frame. This property has no effect on headlines +which are not exported as frames. + @cindex @samp{BEAMER_ACT}, property @cindex @samp{BEAMER_OPT}, property -When @samp{BEAMER_ACT} is set for a headline, Org export translates that +When @samp{BEAMER_ACT} is set for a headline@comma{} Org export translates that headline as an overlay or action specification. When enclosed in -square brackets, Org export makes the overlay specification +square brackets@comma{} 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 backend 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} +To create a column on the Beamer slide@comma{} 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 +the Org entry has no specific environment defined@comma{} Beamer export +ignores the heading. If the Org entry has a defined environment@comma{} +Beamer export uses the heading as title. Behind the scenes@comma{} 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. +needs@comma{} use the @samp{BEAMER_ENV} property. @end itemize @node Beamer specific syntax @subsection Beamer specific syntax Since Org's Beamer export backend is an extension of the @LaTeX{} -backend, it recognizes other @LaTeX{} specific syntax---for example, -@samp{#+LATEX:} or @samp{#+ATTR_LATEX:}. See @ref{@LaTeX{} Export}, for details. +backend@comma{} it recognizes other @LaTeX{} specific syntax---for example@comma{} +@samp{#+LATEX:} or @samp{#+ATTR_LATEX:}. See @ref{@LaTeX{} Export}@comma{} 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 @@ -13805,7 +13917,6 @@ wrap the table of contents generated with @samp{TOC} keyword (see @ref{Table of #+TOC: headlines [currentsection] @end example - Insert Beamer-specific code using the following constructs: @cindex @samp{BEAMER}, keyword @@ -13820,8 +13931,8 @@ Insert Beamer-specific code using the following constructs: 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}, +Inline constructs@comma{} such as the last one above@comma{} are useful for adding +overlay specifications to objects with @code{bold}@comma{} @code{item}@comma{} @code{link}@comma{} @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: @@ -13830,19 +13941,18 @@ shown in this 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 +local Beamer environment@comma{} @samp{:overlay} for specifying Beamer overlays in +angular or square brackets@comma{} and @samp{:options} for inserting optional arguments. @example #+ATTR_BEAMER: :environment nonindentlist -- item 1, not indented -- item 2, not indented -- item 3, not indented +- item 1@comma{} not indented +- item 2@comma{} not indented +- item 3@comma{} not indented @end example @example @@ -13853,7 +13963,7 @@ arguments. @example #+ATTR_BEAMER: :options [Lagrange] -Let $G$ be a finite group, and let $H$ be +Let $G$ be a finite group@comma{} and let $H$ be a subgroup of $G$. Then the order of $H$ divides the order of $G$. @end example @@ -13867,14 +13977,13 @@ documents. #+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. +normal environments@comma{} and for selecting the @samp{BEAMER_COL} property. @end table @node A Beamer example @@ -13887,6 +13996,7 @@ Here is an example of an Org document ready for Beamer export. #+AUTHOR: Carsten Dominik #+OPTIONS: H:2 toc:t num:t #+LATEX_CLASS: beamer +#+STARTUP: beamer #+LATEX_CLASS_OPTIONS: [presentation] #+BEAMER_THEME: Madrid #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) @@ -13929,7 +14039,7 @@ compatible with XHTML 1.0 strict standard. * HTML specific export settings:: Settings for HTML export. * HTML doctypes:: Exporting various (X)HTML flavors. * HTML preamble and postamble:: Inserting preamble and postamble. -* Bare HTML:: Exporting HTML without CSS, Javascript, etc. +* Bare HTML:: Exporting HTML without CSS, JavaScript, etc. * Quoting HTML tags:: Using direct HTML in Org files. * Headlines in HTML export:: Formatting headlines. * Links in HTML export:: Inserting and formatting links. @@ -13950,8 +14060,8 @@ compatible with XHTML 1.0 strict standard. @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. +Export as HTML file with a @samp{.html} extension. For @samp{myfile.org}@comma{} Org +exports to @samp{myfile.html}@comma{} 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 @@ -13963,29 +14073,29 @@ Exports to a temporary buffer. Does not create a file. @node HTML specific export settings @subsection HTML specific export settings -HTML export has a number of keywords, similar to the general options +HTML export has a number of keywords@comma{} 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 +This is the document's description@comma{} which the HTML exporter inserts +it as an HTML meta tag in the HTML file. For long descriptions@comma{} use multiple @samp{DESCRIPTION} lines. The exporter takes care of wrapping the lines properly. -The exporter includes a number of other meta tags, which can be customized +The exporter includes a number of other meta tags@comma{} which can be customized by modifying @code{org-html-meta-tags}. @item @samp{HTML_DOCTYPE} @cindex @samp{HTML_DOCTYPE}, keyword @vindex org-html-doctype -Specify the document type, for example: HTML5 (@code{org-html-doctype}). +Specify the document type@comma{} 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 +Specify the HTML container@comma{} such as @samp{div}@comma{} for wrapping sections and elements (@code{org-html-container-element}). @item @samp{HTML_LINK_HOME} @@ -14002,7 +14112,7 @@ The URL for the up link of exported HTML pages (@code{org-html-link-up}). @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. +to typeset @LaTeX{} math in HTML documents. See @ref{Math formatting in HTML export}@comma{} for an example. @item @samp{HTML_HEAD} @cindex @samp{HTML_HEAD}, keyword @@ -14019,7 +14129,7 @@ More arbitrary lines for appending to the HTML document's head @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 +these keywords as HTML meta tags. For long keywords@comma{} use multiple @samp{KEYWORDS} lines. @item @samp{LATEX_HEADER} @@ -14044,7 +14154,7 @@ 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 +Depending on the variant@comma{} the HTML exporter adjusts the syntax of HTML conversion accordingly. Org includes the following ready-made variants: @@ -14076,7 +14186,7 @@ See the variable @code{org-html-doctype-alist} for details. The default is @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 +introduced with the HTML5 standard. To enable them@comma{} set @code{org-html-html5-fancy} to non-@code{nil}. Or use an @samp{OPTIONS} line in the file to set @samp{html5-fancy}. @@ -14122,13 +14232,13 @@ exports to: @end example @vindex org-html-html5-elements -When special blocks do not have a corresponding HTML5 element, the +When special blocks do not have a corresponding HTML5 element@comma{} the HTML exporter reverts to standard translation (see -@code{org-html-html5-elements}). For example, @samp{#+BEGIN_lederhosen} exports +@code{org-html-html5-elements}). For example@comma{} @samp{#+BEGIN_lederhosen} exports to @code{
}. Special blocks cannot have headlines. For the HTML exporter to wrap -the headline and its contents in @code{
} or @code{
} tags, set +the headline and its contents in @code{
} or @code{
} tags@comma{} set the @samp{HTML_CONTAINER} property for the headline. @node HTML preamble and postamble @@ -14143,27 +14253,27 @@ the @samp{HTML_CONTAINER} property for the headline. @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 +default value for @code{org-html-preamble} is @code{t}@comma{} 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 set to a function, the HTML exporter expects the function +string. If set to a function@comma{} 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 above also applies to @code{org-html-postamble} and -@code{org-html-postamble-format}. In addition, @code{org-html-postamble} can be -set to @code{auto} (its default value), which makes the HTML exporter build -a postamble from looking up author's name, email address, creator's -name, and date. +@code{org-html-postamble-format}. In addition@comma{} @code{org-html-postamble} can be +set to @code{auto} (its default value)@comma{} which makes the HTML exporter build +a postamble from looking up author's name@comma{} email address@comma{} creator's +name@comma{} and date. @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: +If you want to output a minimal HTML file@comma{} with no CSS@comma{} no JavaScript@comma{} +no preamble or postamble@comma{} here are the variable you would need to set: @vindex org-html-head @vindex org-html-head-extra @@ -14186,18 +14296,17 @@ no preamble or postamble, here are the variable you would need to set: @subsection Quoting HTML tags The HTML export backend transforms @samp{<} and @samp{>} to @samp{<} and @samp{>}. -To include raw HTML code in the Org file so the HTML export backend -can insert that HTML code in the output, use this inline syntax: +To include raw HTML code in the Org file@comma{} so the HTML export backend +can insert that HTML code in the output@comma{} use this inline syntax: @samp{@@@@html:...@@@@}. For example: @example @@@@html:@@@@bold text@@@@html:@@@@ @end example - @cindex @samp{HTML}, keyword @cindex @samp{BEGIN_EXPORT html} -For larger raw HTML code blocks, use these HTML export code blocks: +For larger raw HTML code blocks@comma{} use these HTML export code blocks: @example #+HTML: Literal HTML code for export @@ -14212,14 +14321,28 @@ For larger raw HTML code blocks, use these HTML export code blocks: @cindex headlines, in HTML export -Headlines are exported to @samp{

}, @samp{

}, etc. Each headline gets the -@samp{id} attribute from @samp{CUSTOM_ID} property, or a unique generated value, +Headlines are exported to @samp{

}@comma{} @samp{

}@comma{} etc. Each headline gets the +@samp{id} attribute from @samp{CUSTOM_ID} property@comma{} or a unique generated value@comma{} 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{} tags. These tags have -a @samp{href} attribute making the headlines link to themselves. +Headlines can contain a link to themselves. To enable it@comma{} you can: + +@itemize +@item +Set the variable @code{org-html-self-link-headlines} to a non-@code{nil} value +@item +In an Org file@comma{} use @code{html-self-link-headlines} option +@example +#+OPTIONS: html-self-link-headlines:t +@end example +@end itemize + + +@noindent +When enabled@comma{} the text of the headlines is wrapped in @samp{} tags. +These tags have a @samp{href} attribute making the headlines link to +themselves. @node Links in HTML export @subsection Links in HTML export @@ -14231,22 +14354,22 @@ a @samp{href} attribute making the headlines link to themselves. The HTML export backend transforms Org's internal links (see @ref{Internal Links}) to equivalent HTML links in the output. The backend similarly handles Org's automatic links created by radio targets (see -@ref{Radio Targets}) similarly. For Org links to external files, the +@ref{Radio Targets}) similarly. For Org links to external files@comma{} the backend transforms the links to @emph{relative} paths. @vindex org-html-link-org-files-as-html -For Org links to other @samp{.org} files, the backend automatically +For Org links to other @samp{.org} files@comma{} the backend 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 backend substitutes the ID-based links in +location@comma{} then the converted links should work without any further +manual intervention. However@comma{} to disable this automatic path +translation@comma{} set @code{org-html-link-org-files-as-html} to @code{nil}. When +disabled@comma{} the HTML export backend substitutes the ID-based links in the HTML output. For more about linking files when publishing to -a directory, see @ref{Publishing links}. +a directory@comma{} see @ref{Publishing links}. Org files can also have special directives to the HTML export -backend. For example, by using @samp{#+ATTR_HTML} lines to specify new +backend. For example@comma{} by using @samp{#+ATTR_HTML} lines to specify new format attributes to @code{} or @code{} tags. This example shows changing the link's title and style: @@ -14263,8 +14386,8 @@ changing the link's title and style: @vindex org-export-html-table-tag The HTML export backend 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 +exporting Org tables to HTML@. By default@comma{} the exporter does not draw +frames and cell borders. To change for this for a table@comma{} use the following lines before the table in the Org file: @cindex @samp{CAPTION}, keyword @@ -14274,6 +14397,11 @@ following lines before the table in the Org file: #+ATTR_HTML: :border 2 :rules all :frame border @end example +Note that table attributes are deprecated in HTML5 in favor of CSS@. +When the doctype is set to HTML5 (see @ref{HTML doctypes})@comma{} Org ignores +@code{org-html-table-default-attributes}. @samp{#+ATTR_HTML:} is still +respected@comma{} but not recommended. + The HTML export backend preserves column groupings in Org tables (see @ref{Column Groups}) when exporting to HTML@. @@ -14320,25 +14448,26 @@ The HTML export backend 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 +When the link in the Org file has no description@comma{} the HTML export backend 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 +@samp{[[file:myimg.jpg]]} is in-lined@comma{} while @samp{[[file:myimg.jpg][the image]]} links to the text@comma{} +@samp{the image}. For more details@comma{} 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{https:} URL pointing to an image, the -HTML export backend in-lines this image and links to the main image. -This Org syntax enables the backend to link low-resolution thumbnail -to the high-resolution version of the image, as shown in this example: +@vindex org-html-inline-image-rules +On the other hand@comma{} if the description part of the Org link is itself +another link@comma{} such as @samp{file:} or @samp{https:} URL pointing to an image +(the exact rule is defined in @code{org-html-inline-image-rules})@comma{} the HTML +export backend in-lines this image and links to the main image. This +Org syntax enables the backend to link low-resolution thumbnail to the +high-resolution version of the image@comma{} 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} +To change attributes of in-lined images@comma{} use @samp{#+ATTR_HTML} lines in +the Org file. This example shows realignment to right@comma{} and adds @code{alt} and @code{title} attributes in support of text viewers and modern web accessibility standards. @@ -14361,18 +14490,18 @@ as-is. @cindex dvisvgm @cindex ImageMagick -@vindex org-html-mathjax-options~ +@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{https://www.mathjax.org, MathJax}, which should work out of the box -with Org@footnote{ By default, Org loads MathJax from -@uref{https://www.jsdelivr.com/, jsDelivr}, as recommended in +@uref{https://www.mathjax.org, MathJax}@comma{} which should work out of the box +with Org@footnote{ By default@comma{} Org loads MathJax from +@uref{https://www.jsdelivr.com/, jsDelivr}@comma{} as recommended in @uref{https://docs.mathjax.org/en/latest/web/start.html, Getting Started with MathJax Components}.}@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{https://docs.mathjax.org/en/latest/input/tex/html.html#tex-and-latex-in-html-documents, MathJax @TeX{} and @LaTeX{} in HTML documents}.}. Some MathJax display options can -be configured via @code{org-html-mathjax-options}, or in the buffer. For -example, with the following settings, +document@comma{} and that signs such as @samp{<}@comma{} @samp{>}@comma{} or @samp{&} have special +meanings. See @uref{https://docs.mathjax.org/en/latest/input/tex/html.html#tex-and-latex-in-html-documents, MathJax @TeX{} and @LaTeX{} in HTML documents}.}. Some MathJax options can be +configured via @code{org-html-mathjax-options}@comma{} or in the buffer. For +example@comma{} with the following settings@comma{} @example #+HTML_MATHJAX: align: left indent: 5em tagside: left @@ -14380,17 +14509,23 @@ example, with the following settings, @noindent equation labels are displayed on the left margin and equations are -five em from the left margin. +five ems from the left margin. + +To use a local copy of MathJax@comma{} use @samp{path} option: + +@example +#+HTML_MATHJAX: path:the/path/to/mathjax.js +@end example @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 +variables. The MathJax template can be configured via @code{org-html-mathjax-template}. -If you prefer, you can also request that @LaTeX{} fragments are processed +If you prefer@comma{} 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 +the availability of MathJax@comma{} this was the default method for Org +files. This method requires that the dvipng program@comma{} dvisvgm or ImageMagick suite is available on your system. You can still get this processing with @@ -14398,12 +14533,10 @@ processing with #+OPTIONS: tex:dvipng @end example - @example #+OPTIONS: tex:dvisvgm @end example - @noindent or @@ -14415,7 +14548,7 @@ or @subsection Text areas in HTML export @cindex text areas, in HTML -Before Org mode's Babel, one popular approach to publishing code in +Before Org mode's Babel@comma{} 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. @@ -14425,7 +14558,7 @@ The HTML export backend can create such text areas. It requires an 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 backend creates a text area 80 characters +By default@comma{} the HTML export backend 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. @@ -14449,39 +14582,39 @@ line. @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 +classes on TODO keywords and tags lead to conflicts@comma{} 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. +specifications may change these@comma{} in addition to any of the standard +classes like for headlines@comma{} tables@comma{} etc. @multitable {aaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @code{p.author} -@tab author information, including email +@tab author information@comma{} including email @item @code{p.date} @tab publishing date @item @code{p.creator} -@tab creator info, about org mode version +@tab creator info@comma{} 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 +@tab TODO keywords@comma{} all not-done states @item @code{.done} -@tab the DONE keywords, all states that count as done +@tab the DONE keywords@comma{} 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} +@tab keyword associated with a timestamp@comma{} 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 ``_'' +@tab each tag uses itself as a class@comma{} ``@@'' replaced by ``_'' @item @code{.target} @tab target for links @item @code{.linenr} @@ -14493,7 +14626,7 @@ classes like for headlines, tables, etc. @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 +@tab section number in headlines@comma{} different for each level @item @code{.figure-number} @tab label like ``Figure 1:'' @item @code{.table-number} @@ -14511,7 +14644,7 @@ classes like for headlines, tables, etc. @item @code{div.footnotes} @tab footnote section headline @item @code{p.footnote} -@tab footnote definition paragraph, containing a footnote +@tab footnote definition paragraph@comma{} containing a footnote @item @code{.footref} @tab a footnote reference number (always a ) @item @code{.footnum} @@ -14525,7 +14658,7 @@ classes like for headlines, tables, etc. @vindex org-html-head-extra @cindex @samp{HTML_INCLUDE_STYLE}, keyword The HTML export backend includes a compact default style in each -exported HTML file. To override the default style with another style, +exported HTML file. To override the default style with another style@comma{} use these keywords in the Org file. They will replace the global defaults the HTML exporter uses. @@ -14537,8 +14670,8 @@ defaults the HTML exporter uses. @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 +To just turn off the default style@comma{} customize +@code{org-html-head-include-default-style} variable@comma{} or use this option line in the Org file. @cindex @samp{html-style}, @samp{OPTIONS} item @@ -14546,21 +14679,20 @@ line in the Org file. #+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{} blocks +For longer style definitions@comma{} either use several @samp{HTML_HEAD} and +@samp{HTML_HEAD_EXTRA} keywords@comma{} or use @code{} 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 subtree, use the @samp{HTML_CONTAINER_CLASS} +In order to add styles to a subtree@comma{} 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 +styles for a particular headline@comma{} 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 +Never change the @code{org-html-style-default} constant. Instead@comma{} use other simpler ways of customizing as described above. @node JavaScript support @@ -14569,31 +14701,30 @@ simpler ways of customizing as described above. 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. +navigation can be done with the @kbd{n} and @kbd{p} keys@comma{} and some other +keys as well@comma{} press @kbd{?} for an overview of the available keys. The +second one has a @emph{folding} view@comma{} 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 +script is hosted on @uref{https://orgmode.org}@comma{} but for reliability@comma{} prefer installing it on your own web server. -To use this program, just add this line to the Org file: +To use this program@comma{} 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 +script. For setting options@comma{} 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 +@uref{https://orgmode.org/org-info.js}@comma{} but you might want to have a local copy and use a path like @samp{../scripts/org-info.js}. @item @samp{view:} @@ -14603,23 +14734,23 @@ Initial view when the website is first shown. Possible values are: @item @samp{info} @tab Info-like interface with one section per page @item @samp{overview} -@tab Folding interface, initially showing only top-level +@tab Folding interface@comma{} initially showing only top-level @item @samp{content} -@tab Folding interface, starting with all headlines visible +@tab Folding interface@comma{} starting with all headlines visible @item @samp{showall} -@tab Folding interface, all headlines and text visible +@tab Folding interface@comma{} 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 +@code{org-export-headline-levels}@comma{} i.e.@comma{} the @samp{H} switch in @samp{OPTIONS}. If +this is smaller than in @code{org-export-headline-levels}@comma{} 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}. +@samp{nil}@comma{} 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 @@ -14627,7 +14758,7 @@ 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. +yes@comma{} the TOC is displayed as a section. @item @samp{ltoc:} Should there be short contents (children) in each section? Make @@ -14638,7 +14769,7 @@ 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), +Should view-toggle buttons be everywhere? When @samp{nil} (the default)@comma{} only one such button is present. @end table @@ -14646,7 +14777,7 @@ only one such button is present. @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}. +to your pages@comma{} configure the variable @code{org-export-html-use-infojs}. @node @LaTeX{} Export @section @LaTeX{} Export @@ -14654,27 +14785,27 @@ to your pages, configure the variable @code{org-export-html-use-infojs}. @cindex @LaTeX{} export @cindex PDF export -The @LaTeX{} export backend 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 +The @LaTeX{} export backend can handle complex documents@comma{} incorporate +standard or custom @LaTeX{} document classes@comma{} generate documents using +alternate @LaTeX{} engines@comma{} and produce fully linked PDF files with +indexes@comma{} bibliographies@comma{} and tables of contents@comma{} 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 +While the details are covered in-depth in this section@comma{} here are some +quick references to variables for the impatient: for engines@comma{} see +@code{org-latex-compiler}; for build sequences@comma{} see +@code{org-latex-pdf-process}; for packages@comma{} see @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}. An important note about the @LaTeX{} export backend: 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. +on blank lines to tell apart syntactical elements@comma{} such as paragraphs. The following sections expect users to be familiar with common @LaTeX{} terminology. You may refer to @uref{https://tug.org/begin.html} to get familiar with @LaTeX{} basics. Users with @LaTeX{} installed may also run @samp{texdoc latex} from terminal to open @LaTeX{} introduction @footnote{ The -command will open a PDF file, which is also available for download +command will open a PDF file@comma{} which is also available for download from @uref{https://mirrors.ctan.org/info/latex-doc-ptr/latex-doc-ptr.pdf}} @menu @@ -14691,6 +14822,7 @@ from @uref{https://mirrors.ctan.org/info/latex-doc-ptr/latex-doc-ptr.pdf}} * Horizontal rules in @LaTeX{} export:: Attributes specific to horizontal rules. * Verse blocks in @LaTeX{} export:: Attributes specific to special blocks. * Quote blocks in @LaTeX{} export:: Attributes specific to quote blocks. +* Controlling the way the table of contents is generated:: @end menu @node @LaTeX{}/PDF export commands @@ -14700,8 +14832,8 @@ from @uref{https://mirrors.ctan.org/info/latex-doc-ptr/latex-doc-ptr.pdf}} @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. +Export to a @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org}@comma{} +Org exports to @samp{myfile.tex}@comma{} overwriting without warning. @item @kbd{C-c C-e l L} (@code{org-latex-export-as-latex}) @kindex C-c C-e l L @@ -14715,7 +14847,7 @@ 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 +Export as @LaTeX{} file and convert it to PDF@comma{} then open the PDF using the default viewer. @item @kbd{M-x org-export-region-as-latex} @@ -14725,23 +14857,23 @@ any buffer. @end table @vindex org-latex-compiler -@vindex org-latex-bibtex-compiler +@vindex org-latex-bib-compiler @vindex org-latex-default-packages-alist @cindex pdflatex @cindex xelatex @cindex lualatex @cindex @samp{LATEX_COMPILER}, keyword The @LaTeX{} export backend 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 +@samp{pdflatex}@comma{} @samp{xelatex}@comma{} and @samp{lualatex}. These engines compile @LaTeX{} +files with different compilers@comma{} packages@comma{} and output options. The @LaTeX{} export backend 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 +compilers. Also see @code{org-latex-bib-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.}. +for different files. However@comma{} ``smart'' @LaTeX{} compilation systems@comma{} such +as latexmk@comma{} can select the correct bibliography compiler.}. @node @LaTeX{} specific export settings @subsection @LaTeX{} specific export settings @@ -14755,8 +14887,8 @@ general options (see @ref{Export Settings}). @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 +The document's description. The description along with author name@comma{} +keywords@comma{} 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 @@ -14769,16 +14901,16 @@ multiple @samp{DESCRIPTION} keywords for long descriptions. @vindex org-export-default-language Language code of the primary document language. When @samp{LANGUAGE} -keyword is not not specified use the value of -@code{org-export-default-language} (by default - @samp{en}, American English) +keyword is not specified use the value of +@code{org-export-default-language} (by default - @samp{en}@comma{} American English) The list of language codes supported by Org is stored in the variable @code{org-latex-language-alist}. -In order to be effective, the @samp{babel} or @samp{polyglossia} +In order to be effective@comma{} 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 +by modifying the @code{org-latex-packages-alist} variable@comma{} e.g.@comma{} with the following snippet (note that @samp{polyglossia} does not work with pdf@LaTeX{}): @@ -14793,8 +14925,8 @@ pdf@LaTeX{}): @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 +This is @LaTeX{} document class@comma{} such as @emph{article}@comma{} @emph{report}@comma{} @emph{book}@comma{} +and so on@comma{} which contain predefined preamble and headline level mapping that the @LaTeX{} export backend needs. The backend 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 @@ -14808,24 +14940,27 @@ 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 +The compiler@comma{} such as @samp{pdflatex}@comma{} @samp{xelatex}@comma{} @samp{lualatex}@comma{} for producing the PDF@. See @code{org-latex-compiler}. -@item @samp{LATEX_HEADER} -@itemx @samp{LATEX_HEADER_EXTRA} +@item @samp{LATEX_HEADER}@comma{} @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 +Arbitrary lines to add to the document's preamble@comma{} before the hyperref settings. See @code{org-latex-classes} for adjusting the structure and order of the @LaTeX{} headers. +@item @samp{LATEX_CLASS_PRE} +@cindex @samp{LATEX_CLASS_PRE}, keyword +Arbitrary lines to prepend before the @LaTeX{} preamble. + @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 +name@comma{} keywords@comma{} 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 @@ -14837,7 +14972,7 @@ multiple @samp{KEYWORDS} lines if necessary. @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 +non-@code{nil}@comma{} it is typed outside 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. @@ -14857,18 +14992,18 @@ The following sections have further details. The @LaTeX{} export backend 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}). +and lists@comma{} (see @ref{Export Settings}). -By default, the @LaTeX{} export backend uses the @emph{article} class. +By default@comma{} the @LaTeX{} export backend 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 +To change the default class globally@comma{} edit @code{org-latex-default-class}. +To change the default class locally in an Org file@comma{} add option lines @samp{#+LATEX_CLASS: myclass}. To change the default class for just a part -of the Org file, set a subtree property, @samp{EXPORT_LATEX_CLASS}. The +of the Org file@comma{} set a subtree property@comma{} @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 @@ -14882,14 +15017,13 @@ custom sectioning or custom classes. The @LaTeX{} export backend 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{} +them@comma{} including enclosing them in square brackets@comma{} follow @LaTeX{} conventions. @example -#+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn] +#+LATEX_CLASS_OPTIONS: [a4paper@comma{}11pt@comma{}twoside@comma{}twocolumn] @end example - @cindex @samp{LATEX_HEADER}, keyword @cindex @samp{LATEX_HEADER_EXTRA}, keyword The @LaTeX{} export backend appends values from @samp{LATEX_HEADER} and @@ -14911,44 +15045,54 @@ A sample Org file with the above headers: some more text @end example +@cindex @samp{LATEX_CLASS_PRE}, keyword +The @LaTeX{} export backend prepends values from @samp{LATEX_CLASS_PRE} +keywords before the @LaTeX{} preamble. Use this option when you want to +set the values passed to packages included in the document class. For +example@comma{} to use extended names for the @code{xcolor} package@comma{} use + +@example +#+LATEX_CLASS_PRE: \PassOptionsToPackage@{dvipsnames@}@{xcolor@} +@end example + @cindex @samp{LANGUAGE}, keyword @vindex org-export-default-language @LaTeX{} packages @samp{babel} or @samp{polyglossia} can also be loaded in a document. The ``AUTO'' string will be replaced in both cases by the -appropriate value for the @samp{LANGUAGE} keyword, if present in the -document, or by the value of @code{org-export-default-language}. Let's see +appropriate value for the @samp{LANGUAGE} keyword@comma{} if present in the +document@comma{} or by the value of @code{org-export-default-language}. Let's see some examples in one or another case. @samp{Babel} accepts the classic syntax and (in addition) the new syntax with the @samp{\babelprovide} command to load the languages using the new @samp{INI} files procedure. Keep in mind that there are a number of -languages that are only served in babel using @samp{INI} files, so they -cannot be declared using the classic syntax, but only using the +languages that are only served in babel using @samp{INI} files@comma{} so they +cannot be declared using the classic syntax@comma{} but only using the @samp{\babelprovide} command (see @uref{https://mirrors.ctan.org/macros/latex/required/babel/base/babel.pdf}). Valid usage examples could be: @example -#+LATEX_HEADER: \usepackage[french,italian,AUTO]@{babel@} +#+LATEX_HEADER: \usepackage[french@comma{}italian@comma{}AUTO]@{babel@} @end example where ``AUTO'' is the main language. But it can also be loaded using the @samp{\babelprovide} command: @example -#+LATEX_HEADER: \usepackage[french,italian]@{babel@} -#+LATEX_HEADER: \babelprovide[import, main]@{AUTO@} +#+LATEX_HEADER: \usepackage[french@comma{}italian]@{babel@} +#+LATEX_HEADER: \babelprovide[import@comma{} main]@{AUTO@} @end example -@samp{Polyglossia}, for this procedure to be effective, must be loaded +@samp{Polyglossia}@comma{} for this procedure to be effective@comma{} must be loaded using the same @samp{babel} classic syntax (but note that @emph{this is not} -the actual polyglossia syntax). For example, suppose a document -declares Polytonic Greek as the primary language, and French as the -secondary language. In this case, it would be expressed as: +the actual polyglossia syntax). For example@comma{} suppose a document +declares Polytonic Greek as the primary language@comma{} and French as the +secondary language. In this case@comma{} it would be expressed as: @example #+LANGUAGE: el-polyton -#+LATEX_HEADER: \usepackage[french,AUTO]@{polyglossia@} +#+LATEX_HEADER: \usepackage[french@comma{}AUTO]@{polyglossia@} @end example This would produce in @LaTeX{} (with the actual @samp{polyglossia} syntax): @@ -14959,13 +15103,24 @@ This would produce in @LaTeX{} (with the actual @samp{polyglossia} syntax): \setotherlanguage@{french@} @end example +@vindex org-latex-use-sans +The @LaTeX{} backend normally exports using the Roman font family +specified in the document class or by the user in the +@samp{LATEX_HEADER}. Setting the option @code{org-latex-use-sans} to @samp{t} will +force the @LaTeX{} compiler to use the Sans font as default. You can also +include it in the document options with: + +@example +#+OPTIONS: latex-use-sans:t +@end example + @node Quoting @LaTeX{} code @subsection Quoting @LaTeX{} code When the available @LaTeX{} export customizations are not sufficient to -fine-tune the desired output, it is possible to insert any arbitrary +fine-tune the desired output@comma{} it is possible to 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. +code in the Org file@comma{} and they all use different quoting syntax. @cindex inline, in @LaTeX{} export Inserting in-line quoted with @@ symbols: @@ -14974,7 +15129,6 @@ Inserting in-line quoted with @@ symbols: 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: @@ -14982,9 +15136,8 @@ Inserting as one or more keyword lines in the Org file: #+LATEX: any arbitrary LaTeX code @end example - @cindex @samp{BEGIN_EXPORT latex} -Inserting as an export block in the Org file, where the backend +Inserting as an export block in the Org file@comma{} where the backend exports any code between begin and end markers: @example @@ -15000,7 +15153,7 @@ exports any code between begin and end markers: The @LaTeX{} export backend 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 +and a caption (see @ref{Captions})@comma{} the other valid @LaTeX{} attributes include: @table @asis @@ -15008,10 +15161,10 @@ include: @vindex org-latex-default-table-mode The @LaTeX{} export backend wraps the table differently depending on the mode for accurate rendering of math symbols. Mode is either -@samp{table}, @samp{math}, @samp{inline-math}, @samp{verbatim} or @samp{tabbing}. +@samp{table}@comma{} @samp{math}@comma{} @samp{inline-math}@comma{} @samp{verbatim} or @samp{tabbing}. -For @samp{math} or @samp{inline-math} mode, @LaTeX{} export backend wraps the -table in a math environment, but every cell in it is exported as-is. +For @samp{math} or @samp{inline-math} mode@comma{} @LaTeX{} export backend wraps the +table in a math environment@comma{} but every cell in it is exported as-is. For @samp{tabbing} the @LaTeX{} tabbing environment is used and the correct tabbing delimiters @samp{\>} are used. The @LaTeX{} export backend determines the default mode from @@ -15022,57 +15175,52 @@ contiguous tables in the same mode into a single environment. @vindex org-latex-default-table-environment Set the default @LaTeX{} table environment for the @LaTeX{} export backend 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 +environments are provided by these packages: tabularx@comma{} longtable@comma{} +array@comma{} tabu@comma{} and bmatrix. For packages@comma{} such as tabularx and tabu@comma{} +or any newer replacements@comma{} include them in the @code{org-latex-packages-alist} variable so the @LaTeX{} export backend 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, +variable for configuring these packages for @LaTeX{} snippet previews@comma{} 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 +@ref{Captions}). For custom captions@comma{} use @samp{:caption} attribute@comma{} which accepts raw @LaTeX{} code. @samp{:caption} value overrides @samp{CAPTION} value. -@item @samp{:float} -@itemx @samp{:placement} +@item @samp{:float}@comma{} @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{t} (for a default @samp{table} environment), @samp{sideways} (for a -@samp{sidewaystable} environment), @samp{multicolumn} (to span the table +options: @samp{t} (for a default @samp{table} environment)@comma{} @samp{sideways} (for a +@samp{sidewaystable} environment)@comma{} @samp{multicolumn} (to span the table across multiple columns of a page in a @samp{table*} environment) and -@samp{nil}. In addition to these three values, @samp{:float} can pass through -any arbitrary value, for example a user-defined float type with the +@samp{nil}. In addition to these three values@comma{} @samp{:float} can pass through +any arbitrary value@comma{} for example a user-defined float type with the @samp{float} @LaTeX{} package. @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 backend ignores @samp{:placement} attributes. +tables@comma{} the @LaTeX{} export backend ignores @samp{:placement} attributes. -@item @samp{:align} -@itemx @samp{:font} -@itemx @samp{:width} +@item @samp{:align}@comma{} @samp{:font}@comma{} @samp{:width} The @LaTeX{} export backend uses these attributes for regular tables -to set their alignments, fonts, and widths. +to set their alignments@comma{} fonts@comma{} and widths. @item @samp{:options} The @samp{:options} attribute allows adding an optional argument with -a list of various table options (between brackets in @LaTeX{} export), -since certain tabular environments, such as longtblr of the -tabularray @LaTeX{} package, provides this structure. For example: -@samp{:options remark@{Note@}=@{note@},remark@{Source@}=@{source@}}. +a list of various table options (between brackets in @LaTeX{} export)@comma{} +since certain tabular environments@comma{} such as longtblr of the +tabularray @LaTeX{} package@comma{} provides this structure. For example: +@samp{:options remark@{Note@}=@{note@}@comma{}remark@{Source@}=@{source@}}. @item @samp{:spread} -When @samp{:spread} is non-@code{nil}, the @LaTeX{} export backend spreads or +When @samp{:spread} is non-@code{nil}@comma{} the @LaTeX{} export backend 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} +@item @samp{:booktabs}@comma{} @samp{:center}@comma{} @samp{:rmlines} @vindex org-latex-tables-booktabs @vindex org-latex-tables-centered All three commands are toggles. @samp{:booktabs} brings in modern @@ -15082,20 +15230,18 @@ 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} +@item @samp{:math-prefix}@comma{} @samp{:math-suffix}@comma{} @samp{:math-arguments} The @LaTeX{} export backend inserts @samp{:math-prefix} string value in a math environment before the table. The @LaTeX{} export backend inserts @samp{:math-suffix} string value in a math environment after the table. The @LaTeX{} export backend 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}. +than one argument@comma{} 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: +@LaTeX{} table attributes help to format tables for a wide range of +situations@comma{} such as matrix product or spanning multiple pages: @example #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l @@ -15127,15 +15273,15 @@ Set the caption with the @LaTeX{} command @cindex @samp{ATTR_LATEX}, keyword The @LaTeX{} export backend 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 +not have descriptions@comma{} such as these links @samp{[[file:img.jpg]]} or +@samp{[[./img.jpg]]}@comma{} as direct image insertions in the final PDF output. In +the PDF@comma{} they are no longer links@comma{} but actual images embedded on the page. The @LaTeX{} export backend uses @samp{\includegraphics} macro to insert the image. But for TikZ (@uref{https://sourceforge.net/projects/pgf/}) -images, the backend uses an @code{\input} macro wrapped within +images@comma{} the backend uses an @code{\input} macro wrapped within a @code{tikzpicture} environment. -For specifying image @samp{:width}, @samp{:height}, @samp{:scale} and other @samp{:options}, +For specifying image @samp{:width}@comma{} @samp{:height}@comma{} @samp{:scale} and other @samp{:options}@comma{} use this syntax: @example @@ -15145,7 +15291,7 @@ use this syntax: A @samp{:scale} attribute overrides both @samp{:width} and @samp{:height} attributes. -For custom commands for captions, use the @samp{:caption} attribute. It +For custom commands for captions@comma{} use the @samp{:caption} attribute. It overrides the default @samp{#+CAPTION} value: @example @@ -15153,9 +15299,9 @@ overrides the default @samp{#+CAPTION} value: [[./img/sed-hr4049.pdf]] @end example -When captions follow the method as described in @ref{Captions}, the @LaTeX{} +When captions follow the method as described in @ref{Captions}@comma{} the @LaTeX{} export backend wraps the picture in a floating @samp{figure} environment. -To float an image without specifying a caption, set the @samp{:float} +To float an image without specifying a caption@comma{} set the @samp{:float} attribute to one of the following: @table @asis @@ -15171,14 +15317,14 @@ 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 +For a new page with the image sideways@comma{} rotated ninety degrees@comma{} in a @samp{sidewaysfigure} environment; overrides @samp{:placement} setting. @item @samp{nil} To avoid a @samp{:float} even if using a caption. @item Any arbitrary value -For example, a user-defined float type with the @samp{float} @LaTeX{} +For example@comma{} a user-defined float type with the @samp{float} @LaTeX{} package. @end table @@ -15195,7 +15341,7 @@ placement. @cindex center image in LaTeX export @cindex image, centering in LaTeX export The @LaTeX{} export backend centers all images by default. Setting -@samp{:center} to @samp{nil} disables centering. To disable centering globally, +@samp{:center} to @samp{nil} disables centering. To disable centering globally@comma{} set @code{org-latex-images-centered} to @samp{nil}. Set the @samp{:comment-include} attribute to non-@code{nil} value for the @LaTeX{} @@ -15208,20 +15354,20 @@ export backend to comment out the @samp{\includegraphics} macro. @cindex @samp{ATTR_LATEX}, keyword The @LaTeX{} export backend accepts the @samp{environment} and @samp{options} attributes for plain lists. Both attributes work together for -customizing lists, as shown in the examples: +customizing lists@comma{} 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@}] +#+ATTR_LATEX: :options [label=@{@}@comma{} itemjoin=@{@comma{}@}@comma{} itemjoin*=@{@comma{} 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 +Since @LaTeX{} supports only four levels of nesting for lists@comma{} use an +external package@comma{} such as @samp{enumitem} in @LaTeX{}@comma{} for levels deeper than four: @example @@ -15243,10 +15389,10 @@ four: @vindex org-latex-src-block-backend @LaTeX{} export backend provides multiple ways to render src blocks in -@LaTeX{}, according to the value of @code{org-latex-src-block-backend}. The -default value @samp{verbatim} renders the src code verbatim, without any -extra styling. Alternative values allow more colorful styling, but -require additional @LaTeX{} (@samp{listings}, @samp{minted}), system (@samp{minted}), or +@LaTeX{}@comma{} according to the value of @code{org-latex-src-block-backend}. The +default value @samp{verbatim} renders the src code verbatim@comma{} without any +extra styling. Alternative values allow more colorful styling@comma{} but +require additional @LaTeX{} (@samp{listings}@comma{} @samp{minted})@comma{} system (@samp{minted})@comma{} or Emacs (@samp{engraved}) packages. See the @code{org-latex-src-block-backend} docstring for more details. @@ -15278,12 +15424,12 @@ blocks that may not fit on a page. @vindex org-latex-engraved-options The @LaTeX{} export backend 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 Engraved or Minted. Minted +example below@comma{} the @samp{:options} are set for Engraved or Minted. Minted is a source code highlighting @LaTeX{} package with many configurable options@footnote{ Minted uses an external Python package for code -highlighting, which requires the flag @samp{-shell-escape} to be added to +highlighting@comma{} which requires the flag @samp{-shell-escape} to be added to @code{org-latex-pdf-process}.}. Both Minted and Engraved are built on -@uref{https://www.ctan.org/pkg/fvextra, fvextra}, and so support many of +@uref{https://www.ctan.org/pkg/fvextra, fvextra}@comma{} and so support many of the same options. @example @@ -15295,8 +15441,8 @@ the same options. @end example To apply similar configuration options for all source blocks in a -file, use the @code{org-latex-listings-options}, -@code{org-latex-engraved-options}, and @code{org-latex-minted-options} +file@comma{} use the @code{org-latex-listings-options}@comma{} +@code{org-latex-engraved-options}@comma{} and @code{org-latex-minted-options} variables. @node Example blocks in @LaTeX{} export @@ -15308,9 +15454,9 @@ variables. The @LaTeX{} export backend 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 +environment globally@comma{} 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 +another environment for each block@comma{} use the @samp{:environment} parameter to specify a custom environment. @example @@ -15328,9 +15474,9 @@ to specify a custom environment. @cindex proof, in @LaTeX{} export @cindex @samp{ATTR_LATEX}, keyword -For other special blocks in the Org file, the @LaTeX{} export backend +For other special blocks in the Org file@comma{} the @LaTeX{} export backend makes a special environment of the same name. The backend also takes -@samp{:options}, if any, and appends as-is to that environment's opening +@samp{:options}@comma{} if any@comma{} and appends as-is to that environment's opening string. For example: @example @@ -15341,7 +15487,7 @@ string. For example: #+ATTR_LATEX: :options [Proof of important theorem] #+BEGIN_proof ... - Therefore, any even number greater than 2 is the sum of two primes. + Therefore@comma{} any even number greater than 2 is the sum of two primes. #+END_proof @end example @@ -15355,12 +15501,12 @@ exports to \begin@{proof@}[Proof of important theorem] ... - Therefore, any even number greater than 2 is the sum of two primes. + Therefore@comma{} 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 +If you need to insert a specific caption command@comma{} use @samp{:caption} +attribute. It overrides standard @samp{CAPTION} value@comma{} if any. For example: @example @@ -15391,18 +15537,18 @@ The @LaTeX{} export backend converts horizontal rules by the specified @cindex @samp{ATTR_LATEX}, keyword The @LaTeX{} export backend accepts five attributes for verse blocks: -@samp{:lines}, @samp{:center}, @samp{:versewidth}, @samp{:latexcode} and @samp{:literal}. The -three first require the external @LaTeX{} package @samp{verse.sty}, which is +@samp{:lines}@comma{} @samp{:center}@comma{} @samp{:versewidth}@comma{} @samp{:latexcode} and @samp{:literal}. The +three first require the external @LaTeX{} package @samp{verse.sty}@comma{} which is an extension of the standard @LaTeX{} environment. @table @asis @item @samp{:lines} To add marginal verse numbering. Its value is an -integer, the sequence in which the verses should be numbered. +integer@comma{} the sequence in which the verses should be numbered. @item @samp{:center} With value @samp{t} all the verses on the page are optically -centered (a typographic convention for poetry), taking as a -reference the longest verse, which must be indicated by the +centered (a typographic convention for poetry)@comma{} taking as a +reference the longest verse@comma{} which must be indicated by the attribute @samp{:versewidth}. @item @samp{:versewidth} Its value is a literal text string with the longest @@ -15411,14 +15557,14 @@ verse. It accepts any arbitrary @LaTeX{} code that can be included within a @LaTeX{} @samp{verse} environment. @item @samp{:literal} -With value t, all blank lines are preserved and -exported as @samp{\vspace*@{\baselineskip@}}, including the blank lines +With value t@comma{} all blank lines are preserved and +exported as @samp{\vspace*@{\baselineskip@}}@comma{} including the blank lines before or after contents. Note that without the @samp{:literal} -attribute, one or more blank lines between stanzas are exported as a -single blank line, and any blank lines before or after the content -are removed, which is more consistent with the syntax of the @LaTeX{} -`verse' environment, and the one provided by the @samp{verse} package. -If the @samp{verse} package is loaded, the vertical spacing between all +attribute@comma{} one or more blank lines between stanzas are exported as a +single blank line@comma{} and any blank lines before or after the content +are removed@comma{} which is more consistent with the syntax of the @LaTeX{} +`verse' environment@comma{} and the one provided by the @samp{verse} package. +If the @samp{verse} package is loaded@comma{} the vertical spacing between all stanzas can be controlled by the global length @samp{\stanzaskip} (see @uref{https://www.ctan.org/pkg/verse}). @end table @@ -15427,22 +15573,22 @@ A complete example with Shakespeare's first sonnet: @example #+ATTR_LATEX: :center t :latexcode \color@{red@} :lines 5 -#+ATTR_LATEX: :versewidth Feed’st thy light’s flame with self-substantial fuel, +#+ATTR_LATEX: :versewidth Feed’st thy light’s flame with self-substantial fuel@comma{} #+BEGIN_VERSE -From fairest creatures we desire increase, -That thereby beauty’s rose might never die, +From fairest creatures we desire increase@comma{} +That thereby beauty’s rose might never die@comma{} But as the riper should by time decease His tender heir might bear his memory -But thou, contracted to thine own bright eyes, -Feed’st thy light’s flame with self-substantial fuel, -Making a famine where abundance lies, -Thyself thy foe, to thy sweet self too cruel. -Thou that art now the world’s fresh ornament, -And only herald to the gaudy spring, -Within thine own bud buriest thy content, -And, tender churl, mak’st waste in niggardly. -Pity the world, or else this glutton be, -To eat the world’s due, by the grave and thee. +But thou@comma{} contracted to thine own bright eyes@comma{} +Feed’st thy light’s flame with self-substantial fuel@comma{} +Making a famine where abundance lies@comma{} +Thyself thy foe@comma{} to thy sweet self too cruel. +Thou that art now the world’s fresh ornament@comma{} +And only herald to the gaudy spring@comma{} +Within thine own bud buriest thy content@comma{} +And@comma{} tender churl@comma{} mak’st waste in niggardly. +Pity the world@comma{} or else this glutton be@comma{} +To eat the world’s due@comma{} by the grave and thee. #+END_VERSE @end example @@ -15454,9 +15600,9 @@ To eat the world’s due, by the grave and thee. @cindex org-latex-default-quote-environment The @LaTeX{} export backend accepts two attributes for quote blocks: -@samp{:environment}, for an arbitrary quoting environment (the default +@samp{:environment}@comma{} for an arbitrary quoting environment (the default value is that of @code{org-latex-default-quote-environment}: @code{"quote"}) and -@samp{:options}. For example, to choose the environment @samp{quotation}, +@samp{:options}. For example@comma{} to choose the environment @samp{quotation}@comma{} included as an alternative to @samp{quote} in standard @LaTeX{} classes: @example @@ -15466,8 +15612,8 @@ some text... #+END_QUOTE @end example -To choose the @samp{foreigndisplayquote} environment, included in the @LaTeX{} -package @samp{csquotes}, with the @samp{german} option, use this syntax: +To choose the @samp{foreigndisplayquote} environment@comma{} included in the @LaTeX{} +package @samp{csquotes}@comma{} with the @samp{german} option@comma{} use this syntax: @example #+LATEX_HEADER:\usepackage[autostyle=true]@{csquotes@} @@ -15486,20 +15632,58 @@ some text in German... \end@{foreigndisplayquote@} @end example +@node Controlling the way the table of contents is generated +@subsection Controlling the way the table of contents is generated + +@cindex LaTeX ToC export + +When exporting your document to @LaTeX{}@comma{} only numbered sections will be +included. This is closer to @LaTeX{} and different to how other exporters +work (see @ref{Table of Contents}). If you need an unnumbered section +to appear in the table of contents@comma{} use the property @samp{UNNUMBERED} and +set it to @samp{toc}: + +@example +:PROPERTIES: +:UNNUMBERED: toc +:END: +@end example + +@cindex LaTeX ToC export a la ~org~ +@cindex @samp{org-latex-toc-include-unnumbered} +If you want the @LaTeX{} exporter to behave like other exporters@comma{} +customise the variable @code{org-latex-toc-include-unnumbered} and +set it to @code{t}: + +@example +(setq org-latex-toc-include-unnumbered t) +@end example + +or add this setting in the local variables. + +In this case@comma{} unnumbered sections will be included in the table of +contents@comma{} unless you set the @samp{UNNUMBERED} property to @samp{notoc}: + +@example +:PROPERTIES: +:UNNUMBERED: notoc +:END: +@end example + @node Markdown Export @section Markdown Export @cindex Markdown export -The Markdown export backend, ``md'', converts an Org file to Markdown -format, as defined at @uref{https://daringfireball.net/projects/markdown/}. -This is the original Markdown specification, developed by John Gruber +The Markdown export backend@comma{} ``md''@comma{} converts an Org file to Markdown +format@comma{} as defined at @uref{https://daringfireball.net/projects/markdown/}. +This is the original Markdown specification@comma{} developed by John Gruber and Aaron Swartz. -Since ``md'' backend is built on top of the HTML backend (see @ref{HTML Export}), it converts every Org construct not defined in Markdown -syntax, such as tables, to HTML@. +Since ``md'' backend is built on top of the HTML backend (see @ref{HTML Export})@comma{} it converts every Org construct not defined in Markdown +syntax@comma{} such as tables@comma{} to HTML@. -Do note that the original markdown syntax has differences with other +Do note that the original Markdown syntax has differences with other commonly used Markdown flavors. See @uref{https://en.wikipedia.org/wiki/Markdown} for more details. @@ -15510,8 +15694,8 @@ commonly used Markdown flavors. See @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. +Export to a text file with Markdown syntax. For @samp{myfile.org}@comma{} Org +exports to @samp{myfile.md}@comma{} overwritten without warning. @item @kbd{C-c C-e m M} (@code{org-md-export-as-markdown}) @kindex C-c C-c m M @@ -15520,19 +15704,19 @@ 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. +Export as a text file with Markdown syntax@comma{} 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 +Based on @code{org-md-headline-style}@comma{} Markdown export can generate headlines of both @emph{atx} and @emph{setext} types. @emph{setext} limits headline levels to two whereas @emph{atx} limits headline levels to six. @emph{mixed} -exports headline levels one and two in @emph{setext}-style, and headline +exports headline levels one and two in @emph{setext}-style@comma{} and headline levels three through six as @emph{atx}-style headlines. Beyond these -limits, the export backend converts headlines to lists. To set a +limits@comma{} the export backend converts headlines to lists. To set a limit to a level before the absolute limit (see @ref{Export Settings}). @node OpenDocument Text Export @@ -15572,7 +15756,7 @@ and are compatible with LibreOffice 3.4. The ODT export backend 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. +executable. Without it@comma{} export cannot finish. @node ODT export commands @subsection ODT export commands @@ -15586,16 +15770,16 @@ 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 +If @code{org-odt-preferred-output-format} is specified@comma{} the ODT export backend automatically converts the exported file to that format. -For @samp{myfile.org}, Org exports to @samp{myfile.odt}, overwriting without +For @samp{myfile.org}@comma{} Org exports to @samp{myfile.odt}@comma{} overwriting without warning. The ODT export backend exports a region only if a region was active. -If the selected region is a single tree, the ODT export backend -makes the tree head the document title. Incidentally, @kbd{C-c @@} selects the current subtree. If the tree head entry has, or -inherits, an @samp{EXPORT_FILE_NAME} property, the ODT export backend +If the selected region is a single tree@comma{} the ODT export backend +makes the tree head the document title. Incidentally@comma{} @kbd{C-c @@} selects the current subtree. If the tree head entry has@comma{} or +inherits@comma{} an @samp{EXPORT_FILE_NAME} property@comma{} the ODT export backend uses that for file name. @item @kbd{C-c C-e o O} @@ -15603,7 +15787,7 @@ uses that for file name. 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 +If @code{org-export-odt-preferred-output-format} is specified@comma{} open the converted file instead. See @ref{Automatically exporting to other formats}. @end table @@ -15617,14 +15801,14 @@ 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 backend -inserts as document metadata. For long descriptions, use multiple -lines, prefixed with @samp{DESCRIPTION}. +This is the document's description@comma{} which the ODT export backend +inserts as document metadata. For long descriptions@comma{} use multiple +lines@comma{} prefixed with @samp{DESCRIPTION}. @item @samp{KEYWORDS} @cindex @samp{KEYWORDS}, keyword The keywords for the document. The ODT export backend inserts the -description along with author name, keywords, and related file +description along with author name@comma{} keywords@comma{} and related file metadata as metadata in the output file. Use multiple @samp{KEYWORDS} if necessary. @@ -15644,23 +15828,23 @@ The document subtitle. The ODT export backend 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 +works with popular converters to produce formats such as @samp{doc}@comma{} or +convert a document from one format@comma{} say @samp{csv}@comma{} to another format@comma{} say @samp{xls}. @cindex @file{unoconv} @vindex org-odt-convert-process -Customize @code{org-odt-convert-process} variable to point to @samp{unoconv}, +Customize @code{org-odt-convert-process} variable to point to @samp{unoconv}@comma{} which is the ODT's preferred converter. Working installations of -LibreOffice would already have @samp{unoconv} installed. Alternatively, +LibreOffice would already have @samp{unoconv} installed. Alternatively@comma{} 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 +If ODT format is just an intermediate step to get to other formats@comma{} +such as @samp{doc}@comma{} @samp{docx}@comma{} @samp{rtf}@comma{} or @samp{pdf}@comma{} etc.@comma{} then extend the ODT export backend 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}). @@ -15668,9 +15852,9 @@ way to extend (see @ref{ODT export commands}). @anchor{Converting between document formats} @subsubheading Converting between document formats -The Org export backend 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. +The Org export backend is made to be interoperable with a wide range +of text document format converters. Newer generation converters@comma{} such +as LibreOffice and Pandoc@comma{} can handle hundreds of formats at once. Org provides a consistent interaction with whatever converter is installed. Here are some generic commands: @@ -15678,7 +15862,7 @@ installed. Here are some generic commands: @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. +a prefix argument@comma{} opens the newly produced file. @end table @node Applying custom styles @@ -15689,7 +15873,7 @@ a prefix argument, opens the newly produced file. The ODT export backend 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 +customize these built-in style sheets@comma{} either edit the style sheets directly or generate them using an application such as LibreOffice. The example here shows creating a style using LibreOffice. @@ -15698,7 +15882,7 @@ The example here shows creating a style using LibreOffice. @enumerate @item -Create a sample @samp{example.org} file with settings as shown below, +Create a sample @samp{example.org} file with settings as shown below@comma{} and export it to ODT format. @example @@ -15707,25 +15891,24 @@ and export it to ODT format. @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 +to locate the target styles@comma{} which typically have the ``Org'' prefix. +Open one@comma{} modify@comma{} 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 +newly created file. For additional configuration options@comma{} 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 +To apply an ODT style to a particular file@comma{} 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 @@ -15750,11 +15933,11 @@ fewer problems. 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, +A link with no description and pointing to a regular@comma{} un-itemized@comma{} 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 +A @samp{\ref@{label@}}-style reference to an image@comma{} table etc.@comma{} is replaced with a cross-reference and sequence number of the labeled entity. See @ref{Labels and captions in ODT export}. @@ -15768,14 +15951,14 @@ 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 backend exports a table with top and +By default@comma{} the ODT export backend 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 backend honors any table alignments and relative widths for columns (see @ref{Column Width and Alignment}). Note that the ODT export backend interprets column widths as weighted -ratios, the default weight being 1. +ratios@comma{} the default weight being 1. @cindex @samp{ATTR_ODT}, keyword Specifying @samp{:rel-width} property on an @samp{ATTR_ODT} line controls the @@ -15794,13 +15977,13 @@ width of the table. For example: | Sum | 16 | 123 | 2560 | 2699 | @end example -On export, the above table takes 50% of text width area. The exporter +On export@comma{} 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 +left-aligned and rest of the columns@comma{} 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 +For even more customization@comma{} 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 @@ -15813,7 +15996,7 @@ them with a table using the @samp{ATTR_ODT} keyword. See @ref{Customizing table @subsubheading Embedding images The ODT export backend processes image links in Org files that do not -have descriptions, such as these links @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, +have descriptions@comma{} such as these links @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}@comma{} as direct image insertions in the final output. Either of these examples works: @@ -15821,7 +16004,6 @@ examples works: [[file:img.png]] @end example - @example [[./img.png]] @end example @@ -15829,10 +16011,10 @@ examples works: @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 +For clickable images@comma{} provide a link whose description is another link +to an image file. For example@comma{} to embed an image @samp{org-mode-unicorn.png} which when clicked jumps to @uref{https://orgmode.org} -website, do the following +website@comma{} do the following @example [[https://orgmode.org][./org-mode-unicorn.png]] @@ -15851,19 +16033,19 @@ attribute. The ODT export backend starts with establishing the size of the image in the final document. The dimensions of this size are measured in centimeters. The backend then queries the image file for its -dimensions measured in pixels. For this measurement, the backend +dimensions measured in pixels. For this measurement@comma{} the backend 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 backend 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 +@code{display-pixels-per-inch}@comma{} 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: +To embed @samp{img.png} as a 10 cm x 10 cm image@comma{} do the following: @example #+ATTR_ODT: :width 10 :height 10 @@ -15871,7 +16053,7 @@ To embed @samp{img.png} as a 10 cm x 10 cm image, do the following: @end example @item Scale the image -To embed @samp{img.png} at half its size, do the following: +To embed @samp{img.png} at half its size@comma{} do the following: @example #+ATTR_ODT: :scale 0.5 @@ -15880,7 +16062,7 @@ To embed @samp{img.png} at half its size, do the following: @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: +original height:width ratio@comma{} do the following: @example #+ATTR_ODT: :width 10 @@ -15889,7 +16071,7 @@ original height:width ratio, do the following: @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: +original height:width ratio@comma{} do the following: @example #+ATTR_ODT: :height 10 @@ -15901,7 +16083,7 @@ original height:width ratio, do the following: @subsubheading Anchoring of images @cindex @samp{ATTR_ODT}, keyword -The ODT export backend can anchor images to @samp{as-char}, @samp{paragraph}, +The ODT export backend can anchor images to @samp{as-char}@comma{} @samp{paragraph}@comma{} or @samp{page}. Set the preferred anchor using the @samp{:anchor} property of the @samp{ATTR_ODT} line. @@ -15938,8 +16120,7 @@ a per-file basis. #+OPTIONS: tex:t @end example - -With this option, @LaTeX{} fragments are first converted into MathML +With this option@comma{} @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. @@ -15952,7 +16133,7 @@ variables @code{org-latex-to-mathml-convert-command} and If you prefer to use MathToWeb@footnote{ See @uref{https://mathtoweb.sourceforge.io/, MathToWeb}.} -as your converter, you can configure the above variables as shown +as your converter@comma{} you can configure the above variables as shown below. @lisp @@ -15963,8 +16144,8 @@ below. @end lisp @noindent -or, to use @LaTeX{}​ML@footnote{ See @uref{https://dlmf.nist.gov/LaTeXML/}.} -instead, +or@comma{} to use @LaTeX{}​ML@footnote{ See @uref{https://dlmf.nist.gov/LaTeXML/}.} +instead@comma{} @lisp (setq org-latex-to-mathml-convert-command @@ -15972,7 +16153,7 @@ instead, @end lisp To quickly verify the reliability of the @LaTeX{}-to-MathML -converter, use the following commands: +converter@comma{} use the following commands: @table @asis @item @kbd{M-x org-export-as-odf} @@ -15996,12 +16177,10 @@ a per-file basis. #+OPTIONS: tex:dvipng @end example - @example #+OPTIONS: tex:dvisvgm @end example - @noindent or @@ -16009,17 +16188,16 @@ or #+OPTIONS: tex:imagemagick @end example - -Under this option, @LaTeX{} fragments are processed into PNG or SVG +Under this option@comma{} @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 +document. This method requires dvipng program@comma{} 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, +When embedding @LaTeX{} math snippets in ODT documents is not reliable@comma{} 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: @@ -16028,7 +16206,6 @@ shown below: [[./equation.mml]] @end example - @noindent or @@ -16040,7 +16217,7 @@ or @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 +types. Inline images@comma{} tables@comma{} @LaTeX{} fragments@comma{} 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 @@ -16052,17 +16229,16 @@ applied to these objects. [[./img/a.png]] @end example -When rendered, it may show as follows in the exported document: +When rendered@comma{} 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'', +To modify the category component of the caption@comma{} customize the option +@code{org-odt-category-map-alist}. For example@comma{} to tag embedded images +with the string ``Illustration'' instead of the default string ``Figure''@comma{} use the following setting: @lisp @@ -16070,7 +16246,7 @@ use the following setting: '(("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p))) @end lisp -With the above modification, the previous example changes to: +With the above modification@comma{} the previous example changes to: @example Illustration 2: Bell curve @@ -16079,18 +16255,18 @@ Illustration 2: Bell curve @node Literal examples in ODT export @subsection Literal examples in ODT export -The ODT export backend supports literal examples (see @ref{Literal Examples}) with full fontification. Internally, the ODT export +The ODT export backend supports literal examples (see @ref{Literal Examples}) with full fontification. Internally@comma{} the ODT export backend 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 +For custom fontification styles@comma{} 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 +To turn off fontification of literal examples@comma{} customize the @code{org-odt-fontify-srcblocks} option. @node Advanced topics in ODT export @@ -16163,7 +16339,7 @@ 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{} @dots{} @samp{} elements of this file. -Apart from serving as a template file for the final @samp{content.xml}, +Apart from serving as a template file for the final @samp{content.xml}@comma{} the file serves the following purposes: @enumerate @@ -16173,7 +16349,7 @@ referenced by the exporter; @item It contains @samp{} @dots{} @samp{} -elements that control numbering of tables, images, equations, and +elements that control numbering of tables@comma{} images@comma{} equations@comma{} and similar entities. @end enumerate @end table @@ -16185,8 +16361,8 @@ factory styles used by the exporter. @table @asis @item @code{org-odt-styles-file} -The ODT export backend uses the file pointed to by this variable, -such as @samp{styles.xml}, for the final output. It can take one of the +The ODT export backend uses the file pointed to by this variable@comma{} +such as @samp{styles.xml}@comma{} for the final output. It can take one of the following values: @table @asis @@ -16199,7 +16375,7 @@ 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 +or Template file. Additionally@comma{} extract the specified member files and embed those within the final ODT document. Use this option if the @samp{styles.xml} file references additional @@ -16223,14 +16399,14 @@ 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@comma{} to highlight a region of text do the following: @example @@@@odt:This is highlighted text@@@@. But this is regular text. @end example -@strong{Hint:} To see the above example in action, edit the @samp{styles.xml} +@strong{Hint:} To see the above example in action@comma{} edit the @samp{styles.xml} (see @ref{x-orgodtstyles-xml, , Factory styles}) and add a custom @emph{Highlight} style as shown below: @@ -16243,13 +16419,13 @@ below: @item Embedding a one-line OpenDocument XML @cindex @samp{ODT}, keyword The ODT export backend can read one-liner options with @samp{#+ODT:} in -the Org file. For example, to force a page break: +the Org file. For example@comma{} to force a page break: @example #+ODT: @end example -@strong{Hint:} To see the above example in action, edit your +@strong{Hint:} To see the above example in action@comma{} edit your @samp{styles.xml} (see @ref{x-orgodtstyles-xml, , Factory styles}) and add a custom @samp{PageBreak} style as shown below. @@ -16265,7 +16441,7 @@ The ODT export backend 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 +For example@comma{} to create a one-off paragraph that uses bold text@comma{} do the following: @example @@ -16285,7 +16461,7 @@ the following: 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}. +tables@comma{} see @ref{Tables in ODT export}. This feature closely mimics the way table templates are defined in the OpenDocument-v1.2 specification@footnote{ @@ -16293,7 +16469,7 @@ OpenDocument-v1.2 specification@footnote{ Specification}}. @vindex org-odt-table-styles -For quick preview of this feature, install the settings below and export the +For quick preview of this feature@comma{} install the settings below and export the table that follows: @lisp @@ -16320,7 +16496,7 @@ styles @samp{TableWithHeaderRowAndColumn} and 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. +templates@comma{} define new styles there. To use this feature proceed as follows: @@ -16357,7 +16533,7 @@ 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 +a table template with the name @samp{Custom}@comma{} the needed style names are listed in the following table. @multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @@ -16393,31 +16569,31 @@ listed in the following table. @tab @samp{CustomOddColumnTableParagraph} @end multitable -To create a table template with the name @samp{Custom}, define the above +To create a table template with the name @samp{Custom}@comma{} define the above styles in the @samp{} @dots{} @samp{} 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 +Define a table style@footnote{ See the attributes @samp{table:template-name}@comma{} +@samp{table:use-first-row-styles}@comma{} @samp{table:use-last-row-styles}@comma{} +@samp{table:use-first-column-styles}@comma{} @samp{table:use-last-column-styles}@comma{} +@samp{table:use-banding-rows-styles}@comma{} and @samp{table:use-banding-column-styles} of the @samp{} 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 +To define a table style@comma{} 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), +the name of the table template created in step (1)@comma{} @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 +For example@comma{} 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 @@ -16437,7 +16613,7 @@ styles in that template. @item Associate a table with the table style. -To do this, specify the table style created in step (2) as part of +To do this@comma{} specify the table style created in step (2) as part of the @samp{ATTR_ODT} line as shown below. @example @@ -16452,7 +16628,7 @@ the @samp{ATTR_ODT} line as shown below. @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 +To verify if such a file is corrupt@comma{} 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 @@ -16479,12 +16655,12 @@ in current buffer. The exporter evaluates Babel code (see @ref{Evaluating Code @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. +Export as an Org file with a @samp{.org} extension. For @samp{myfile.org}@comma{} +Org exports to @samp{myfile.org.org}@comma{} 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. +Export to an Org file@comma{} then open it. @end table @node Texinfo Export @@ -16515,15 +16691,15 @@ Export to an Org file, then open it. @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. +Export as a Texinfo file with @samp{.texi} extension. For @samp{myfile.org}@comma{} +Org exports to @samp{myfile.texi}@comma{} 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 +file. To generate other formats@comma{} such as DocBook@comma{} customize the @code{org-texinfo-info-process} variable. @end table @@ -16550,7 +16726,7 @@ 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 +The default document class (@code{org-texinfo-default-class})@comma{} which must be a member of @code{org-texinfo-classes}. @item @samp{TEXINFO_HEADER} @@ -16574,7 +16750,7 @@ the Texinfo file. The full form of the Texinfo entry is @code{* DIRNAME: NODE.} where @code{NODE} is usually just @code{(FILENAME)}. Normally this option only provides the -@code{DIRNAME} part, but if you need more control, it can also be the full +@code{DIRNAME} part@comma{} but if you need more control@comma{} it can also be the full entry (recognized by the presence of parentheses or a leading ~* ~). @item @samp{TEXINFO_DIR_DESC} @@ -16591,27 +16767,26 @@ The printed title of the document. @subsection Texinfo file header @cindex @samp{TEXINFO_FILENAME}, keyword -After creating the header for a Texinfo file, the Texinfo backend +After creating the header for a Texinfo file@comma{} the Texinfo backend automatically generates a name and destination path for the Info file. -To override this default with a more sensible path and name, specify +To override this default with a more sensible path and name@comma{} 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 +Along with the output's file name@comma{} 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: +keywords for each additional command in the header@comma{} 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 +Instead of repeatedly installing the same set of commands@comma{} define +a class in @code{org-texinfo-classes} once@comma{} and then activate it in the document by setting the @samp{TEXINFO_CLASS} keyword to that class. @node Texinfo title and copyright page @@ -16620,18 +16795,18 @@ document by setting the @samp{TEXINFO_CLASS} keyword to that class. @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 +regular title with something different for the printed version@comma{} 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} +If one @samp{AUTHOR} line is not sufficient@comma{} 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@{@} +#+TEXINFO_PRINTED_TITLE: This Long Title@@@@inlinefmt@{tex@comma{}@@*@} Is Broken in @@TeX@{@} @end example @cindex @samp{COPYING}, property @@ -16648,9 +16823,9 @@ Copyright information is printed on the back of the title page. :COPYING: t :END: - This is a short example of a complete Texinfo file, version 1.0. + This is a short example of a complete Texinfo file@comma{} version 1.0. - Copyright \copy 2016 Free Software Foundation, Inc. + Copyright \copy 2016 Free Software Foundation@comma{} Inc. @end example @node Info directory file @@ -16664,8 +16839,8 @@ Copyright information is printed on the back of the title page. @cindex @samp{TEXINFO_DIR_NAME}, 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_NAME}, +Info file. This Info file's metadata has variables for category@comma{} +title@comma{} and description: @samp{TEXINFO_DIR_CATEGORY}@comma{} @samp{TEXINFO_DIR_NAME}@comma{} and @samp{TEXINFO_DIR_DESC} keywords that establish where in the Info hierarchy the file fits. @@ -16688,14 +16863,14 @@ 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 +other Texinfo structuring commands@comma{} 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, +@samp{TEXINFO_CLASS} keyword. When no new class is defined and activated@comma{} the Texinfo export backend 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 +command@comma{} or is below a certain threshold (see @ref{Export Settings})@comma{} then the Texinfo export backend makes it into a list item. @cindex @samp{APPENDIX}, property @@ -16707,7 +16882,7 @@ Org headline level or the @samp{TEXINFO_CLASS} keyword. @cindex @samp{DESCRIPTION}, property The Texinfo export backend 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 +a shorter menu entry@comma{} 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: @@ -16720,10 +16895,10 @@ the default menu entry: @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 +The text before the first headline belongs to the @emph{Top} node@comma{} i.e.@comma{} +the node in which a reader enters an Info manual. As such@comma{} it is expected not to appear in printed output generated from the @samp{.texi} -file. See @ref{The Top Node,,,texinfo,}, for more information. +file. See @ref{The Top Node,,,texinfo,}@comma{} for more information. @node Indices @subsection Indices @@ -16741,22 +16916,21 @@ file. See @ref{The Top Node,,,texinfo,}, for more information. @cindex @samp{VINDEX}, keyword @cindex variable index, in Texinfo export The Texinfo export backend 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 +in the Org file: @samp{CINDEX}@comma{} @samp{FINDEX}@comma{} @samp{KINDEX}@comma{} @samp{PINDEX}@comma{} @samp{TINDEX} and +@samp{VINDEX}. Write their value as verbatim Texinfo code; in particular@comma{} +@samp{@{}@comma{} @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 backend to generate an index entry for a headline, set the +For the backend to generate an index entry for a headline@comma{} 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 backend -exports the headline as an unnumbered chapter or section command, and +exports the headline as an unnumbered chapter or section command@comma{} and then inserts the index after its contents. @example @@ -16781,8 +16955,8 @@ Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU. This paragraph is preceded by... #+BEGIN_EXPORT texinfo - @@auindex Johnson, Mark - @@auindex Lakoff, George + @@auindex Johnson@comma{} Mark + @@auindex Lakoff@comma{} George #+END_EXPORT @end example @@ -16797,7 +16971,7 @@ the Org file using the default command @samp{@@itemize}. 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: +specific number@comma{} or switch to a lettered list@comma{} as illustrated here: @example #+ATTR_TEXINFO: :enum A @@ -16810,21 +16984,21 @@ specific number, or switch to a lettered list, as illustrated here: @cindex two-column tables, in Texinfo export @cindex table-type, Texinfo attribute The Texinfo export backend 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, +the Org file using the default command @samp{@@table}@comma{} which results in +a table with two columns. To change this behavior@comma{} set @samp{:table-type} +attribute to either @samp{ftable} or @samp{vtable} value. For more information@comma{} see @ref{Two-column Tables,,,texinfo,}. @vindex org-texinfo-table-default-markup @cindex indic, Texinfo attribute The Texinfo export backend 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 +To override the default highlight command@comma{} 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 +Org syntax is limited to one entry per list item. Nevertheless@comma{} the Texinfo export backend 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. @@ -16832,8 +17006,8 @@ 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. +#+ATTR_TEXINFO: :table-type vtable :sep @comma{} :indic asis +- foo@comma{} bar :: This is the common text for variables foo and bar. @end example @noindent @@ -16847,10 +17021,10 @@ This is the common text for variables foo and bar. @@end table @end example -The @samp{:compact} attribute is an alternative to the @samp{:sep} attribute, +The @samp{:compact} attribute is an alternative to the @samp{:sep} attribute@comma{} which allows writing each entry on its own line. If this attribute is non-@code{nil} and an item in a description list has no body but is -followed by another item, then the second item is transcoded to +followed by another item@comma{} then the second item is transcoded to @samp{@@itemx}. This example is transcoded to the same output as above. @example @@ -16861,12 +17035,12 @@ followed by another item, then the second item is transcoded to @end example Support for this compact syntax can also be enabled for all lists in -a file using the @samp{compact-itemx} export option, or globally using the +a file using the @samp{compact-itemx} export option@comma{} or globally using the variable @code{org-texinfo-compact-itemx}. The Texinfo export backend also supports two approaches to writing Texinfo definition commands (see @ref{Definition Commands,,,texinfo,}). -One of them uses description lists and is described below, the other +One of them uses description lists and is described below@comma{} the other relies on special blocks (see @ref{Special blocks in Texinfo export}). Items in a description list in an Org file that begin with @samp{Function:} @@ -16890,17 +17064,17 @@ becomes @@end defun @end example -The recognized prefixes are @samp{Command:}, @samp{Function:}, @samp{Macro:}, -@samp{Special Form:}, @samp{Variable:} and @samp{User Option:}. These are the same +The recognized prefixes are @samp{Command:}@comma{} @samp{Function:}@comma{} @samp{Macro:}@comma{} +@samp{Special Form:}@comma{} @samp{Variable:} and @samp{User Option:}. These are the same prefixes that appear in the Info file for the respective definition commands. For example a @samp{Function:} item in the Org file is converted -to a @samp{@@defun} command in the Texinfo file, which in turn is converted +to a @samp{@@defun} command in the Texinfo file@comma{} which in turn is converted to a definition prefixed with @samp{-- Function:} in the Info file. As a special case the prefix @samp{Key:} is also recognized. No Texinfo definition command exists for key bindings and the output in Info files also lacks the @samp{Key:} prefix. Even so this special case is -supported because it provides a convenient shorthand, as illustrated +supported because it provides a convenient shorthand@comma{} as illustrated here: @example @@ -16928,15 +17102,15 @@ This option controls how exactly @@code@{do-something@} does its thing. @end example @noindent -Command in parenthesis, as done above, is optional. +Command in parentheses@comma{} as done above@comma{} is optional. @node Tables in Texinfo export @subsection Tables in Texinfo export @cindex @samp{ATTR_TEXINFO}, keyword -When exporting tables, the Texinfo export backend uses the widest +When exporting tables@comma{} the Texinfo export backend 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 +fractions of line length@comma{} use the @samp{:columns} attribute. See example below. @example @@ -16948,11 +17122,11 @@ below. @subsection Images in Texinfo export @cindex @samp{ATTR_TEXINFO}, keyword -Insert a file link to the image in the Org file, and the Texinfo +Insert a file link to the image in the Org file@comma{} and the Texinfo export backend 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: +supported image extensions and no descriptions. To scale the image@comma{} +use @samp{:width} and @samp{:height} attributes. For alternate text@comma{} use @samp{:alt} +and specify the text using Texinfo code@comma{} as shown in the example: @example #+ATTR_TEXINFO: :width 1in :alt Alternate @@i@{text@} @@ -16974,14 +17148,14 @@ 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. +To specify the author of the quotation@comma{} 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 +The Lady of the Lake@comma{} her arm clad in the purest shimmering samite@comma{} +held aloft Excalibur from the bosom of the water@comma{} signifying by divine +providence that I@comma{} Arthur@comma{} was to carry Excalibur. That is why I am your king. #+END_QUOTE @end example @@ -16991,11 +17165,11 @@ your king. Org does not provide any markup for key bindings that corresponds to Texinfo's @code{@@kbd} and @code{@@key} commands. One way to deal with this is to -fall back to code syntax. @samp{~C-x SPC~}, for example, is transcoded to +fall back to code syntax. @samp{~C-x SPC~}@comma{} for example@comma{} is transcoded to @code{@@code@{C-x SPC@}}. A better approach is to define and use an Org macro named @code{kbd}. To -make that easier the function @code{org-texinfo-kbd-macro} is provided, +make that easier the function @code{org-texinfo-kbd-macro} is provided@comma{} which is intended to be used like this: @example @@ -17015,14 +17189,14 @@ Type @@kbd@{C-c @@key@{SPC@}@}. @subsection Special blocks in Texinfo export The Texinfo export backend supports two approaches to writing Texinfo -definition commands. One of them is described here, the other in +definition commands. One of them is described here@comma{} the other in @ref{Plain lists in Texinfo export}. @cindex @samp{ATTR_TEXINFO}, keyword The Texinfo export backend 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: +the command@comma{} as shown in this example: @example #+ATTR_TEXINFO: :options org-org-export-to-org ... @@ -17049,7 +17223,7 @@ Texinfo code. @example #+TITLE: GNU Sample @{@{@{version@}@}@} -#+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@} +#+SUBTITLE: for version @{@{@{version@}@}@}@comma{} @{@{@{updated@}@}@} #+AUTHOR: A.U. Thor #+EMAIL: bug-sample@@gnu.org @@ -17068,7 +17242,7 @@ Texinfo code. #+TEXINFO_PRINTED_TITLE: GNU Sample -This manual is for GNU Sample (version @{@{@{version@}@}@}, +This manual is for GNU Sample (version @{@{@{version@}@}@}@comma{} @{@{@{updated@}@}@}). * Copying @@ -17076,16 +17250,16 @@ This manual is for GNU Sample (version @{@{@{version@}@}@}, :COPYING: t :END: - This manual is for GNU Sample (version @{@{@{version@}@}@}, - @{@{@{updated@}@}@}), which is an example in the Texinfo documentation. + This manual is for GNU Sample (version @{@{@{version@}@}@}@comma{} + @{@{@{updated@}@}@})@comma{} which is an example in the Texinfo documentation. - Copyright \copy 2016 Free Software Foundation, Inc. + Copyright \copy 2016 Free Software Foundation@comma{} Inc. #+BEGIN_QUOTE - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation License, + Permission is granted to copy@comma{} distribute and/or modify this + document under the terms of the GNU Free Documentation License@comma{} Version 1.3 or any later version published by the Free Software - Foundation; with no Invariant Sections, with no Front-Cover Texts, + Foundation; with no Invariant Sections@comma{} with no Front-Cover Texts@comma{} and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". #+END_QUOTE @@ -17095,8 +17269,8 @@ This manual is for GNU Sample (version @{@{@{version@}@}@}, #+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 + This is a sample manual. There is no sample program to invoke@comma{} but + if there were@comma{} you could see its basic usage and command line options here. * GNU Free Documentation License @@ -17123,17 +17297,23 @@ export backend takes calendar data from Org files and exports to the standard iCalendar format. @vindex icalendar-export-sexp-enumeration-days -By default, iCalendar export only includes headings that contain -active timestamps or diary sexps@footnote{ Diary sexp events, except -certain built-in types (see @code{icalendar-export-sexp-enumerate-all}), +By default@comma{} iCalendar export only includes headings that contain +active timestamps or diary sexps@footnote{ Diary sexp events@comma{} except +certain built-in types (see @code{icalendar-export-sexp-enumerate-all})@comma{} are exported up to @code{icalendar-export-sexp-enumeration-days} into future.}. +@vindex org-agenda-default-appointment-duration +If a timestamp contains a time@comma{} but doesn't have an explicit end time +(i.e. time range)@comma{} then by default the exported event will have a +duration of 2 hours@comma{} but this can be overridden with +@code{org-agenda-default-appointment-duration}. + @vindex org-icalendar-include-todo The iCalendar export backend can also incorporate TODO entries based on the configuration of the @code{org-icalendar-include-todo} variable. -The backend exports plain timestamps as @samp{VEVENT}, TODO items as -@samp{VTODO}, and also create events from deadlines that are in non-TODO +The backend exports plain timestamps as @samp{VEVENT}@comma{} TODO items as +@samp{VTODO}@comma{} and also create events from deadlines that are in non-TODO items. @vindex org-icalendar-use-deadline @@ -17141,16 +17321,16 @@ items. @vindex org-icalendar-todo-unscheduled-start The backend 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}, -@code{org-icalendar-use-scheduled}, and +Consult the @code{org-icalendar-use-deadline}@comma{} +@code{org-icalendar-use-scheduled}@comma{} and @code{org-icalendar-todo-unscheduled-start} variables for more details. @vindex org-icalendar-categories @vindex org-icalendar-alarm-time -For tags on the headline, the iCalendar export backend makes them +For tags on the headline@comma{} the iCalendar export backend 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} +states@comma{} configure the variable @code{org-icalendar-categories}. To assign +clock alarms based on time@comma{} configure the @code{org-icalendar-alarm-time} variable. @vindex org-icalendar-store-UID @@ -17163,10 +17343,10 @@ property of the entry for reusing 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 +entries---timestamp@comma{} deadline@comma{} scheduled item@comma{} or TODO item---Org adds +prefixes to the UID@comma{} 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 +remains unique@comma{} yet enable synchronization programs trace the connections. @table @asis @@ -17174,7 +17354,7 @@ connections. @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}. +in the same directory@comma{} 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 @@ -17196,14 +17376,14 @@ Create a combined iCalendar file from Org files in @cindex @samp{LOCATION}, property @cindex @samp{TIMEZONE}, property @cindex @samp{CLASS}, property -The iCalendar export backend includes @samp{SUMMARY}, @samp{DESCRIPTION}, -@samp{LOCATION}, @samp{TIMEZONE} and @samp{CLASS} properties from the Org entries -when exporting. To force the backend to inherit the @samp{LOCATION}, -@samp{TIMEZONE} and @samp{CLASS} properties, configure the +The iCalendar export backend includes @samp{SUMMARY}@comma{} @samp{DESCRIPTION}@comma{} +@samp{LOCATION}@comma{} @samp{TIMEZONE} and @samp{CLASS} properties from the Org entries +when exporting. To force the backend to inherit the @samp{LOCATION}@comma{} +@samp{TIMEZONE} and @samp{CLASS} properties@comma{} configure the @code{org-use-property-inheritance} variable. -@samp{SUMMARY}, @samp{LOCATION}, and @samp{DESCRIPTION} properties can define -multi-line summary, location, or description using @samp{+} +@samp{SUMMARY}@comma{} @samp{LOCATION}@comma{} and @samp{DESCRIPTION} properties can define +multi-line summary@comma{} location@comma{} or description using @samp{+} syntax (see @ref{Property Syntax}): @example @@ -17216,29 +17396,28 @@ syntax (see @ref{Property Syntax}): <2024-01-08 Mon 14:20-15:00> @end example - @vindex org-icalendar-include-body -When Org entries do not have @samp{SUMMARY}, @samp{DESCRIPTION}, @samp{LOCATION} and -@samp{CLASS} properties, the iCalendar export backend derives the summary -from the headline, and derives the description from the body of the +When Org entries do not have @samp{SUMMARY}@comma{} @samp{DESCRIPTION}@comma{} @samp{LOCATION} and +@samp{CLASS} properties@comma{} the iCalendar export backend derives the summary +from the headline@comma{} 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, +The @samp{TIMEZONE} property can be used to specify a per-entry time zone@comma{} 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 +should be specified as per the IANA time zone database format@comma{} e.g.@comma{} +@samp{Asia/Almaty}. Alternately@comma{} the property value can be @samp{UTC}@comma{} 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 +class or access restrictions@comma{} 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 +Only a limited group of clients gets access to the event. @item @samp{PRIVATE} The entry can be retrieved only by its owner. @@ -17250,7 +17429,7 @@ The server should treat unknown class properties the same as @vindex org-icalendar-ttl The exported iCalendar file can advise clients how often to check for updates. This duration can be set globally with the -@code{org-icalendar-ttl} variable, or on a per-document basis with the +@code{org-icalendar-ttl} variable@comma{} or on a per-document basis with the @samp{ICAL-TTL} keyword. This option should be set using the iCalendar notation for time durations; consult the docstring of @code{org-icalendar-ttl} for more details. @@ -17270,11 +17449,11 @@ Other export backends included with Org are: @samp{ox-man.el}: Export to a man page. @end itemize -To activate such backends, either customize @code{org-export-backends} or -load directly with @samp{(require 'ox-man)}. On successful load, the +To activate such backends@comma{} either customize @code{org-export-backends} or +load directly with @samp{(require 'ox-man)}. On successful load@comma{} the backend 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}, +Follow the comment section of such files@comma{} for example@comma{} @samp{ox-man.el}@comma{} for usage and configuration details. @node Advanced Export Configuration @@ -17286,27 +17465,28 @@ for usage and configuration details. @vindex org-export-before-processing-hook @vindex org-export-before-processing-functions @vindex org-export-before-parsing-hook +@vindex org-export-before-parsing-functions The export process executes two hooks before the actual exporting -begins. The first hook, @code{org-export-before-processing-functions}, -runs before any expansions of macros, Babel code, and include keywords -in the buffer. The second hook, -@code{org-export-before-parsing-functions}, runs before the buffer is +begins. The first hook@comma{} @code{org-export-before-processing-functions}@comma{} +runs before any expansions of macros@comma{} Babel code@comma{} and include keywords +in the buffer. The second hook@comma{} +@code{org-export-before-parsing-functions}@comma{} runs before the buffer is parsed. Functions added to these hooks are called with a single argument: the -export backend actually used, as a symbol. You may use them for -heavy duty structural modifications of the document. For example, you +export backend actually used@comma{} as a symbol. You may use them for +heavy duty structural modifications of the document. For example@comma{} 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 backend being used, as a symbol." +BACKEND is the export backend being used@comma{} as a symbol." (org-map-entries (lambda () (delete-region (point) (line-beginning-position 2)) ;; We need to tell `org-map-entries' to not skip over heading at - ;; point. Otherwise, it would continue from _next_ heading. See + ;; point. Otherwise@comma{} it would continue from _next_ heading. See ;; the docstring of `org-map-entries' for details. (setq org-map-continue-from (point))))) @@ -17323,9 +17503,9 @@ 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 +types of objects@comma{} plain text@comma{} parse trees@comma{} export options@comma{} and final output formats. The filters are named after the element type or -object type: @code{org-export-filter-TYPE-functions}, where @var{TYPE} +object type: @code{org-export-filter-TYPE-functions}@comma{} where @var{TYPE} is the type targeted by the filter. Valid types are: @multitable @columnfractions 0.33 0.33 0.33 @@ -17398,21 +17578,21 @@ Org buffer with @samp{~} for the @LaTeX{} backend. 'my-latex-filter-nobreaks) @end lisp -A filter requires three arguments: the code to be transformed, the -name of the backend, and some optional information about the export +A filter requires three arguments: the code to be transformed@comma{} the +name of the backend@comma{} 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} -backend or any other backend, such as @emph{beamer}, derived from +backend or any other backend@comma{} such as @emph{beamer}@comma{} derived from @emph{latex}. @anchor{Defining filters for individual files} @subheading Defining filters for individual files -The Org export can filter not just for backends, but also for +The Org export can filter not just for backends@comma{} 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 +two filters; one removes brackets from time stamps@comma{} 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 +a code block in the same Org file@comma{} which is a handy location for debugging. @example @@ -17429,20 +17609,20 @@ debugging. @subheading Summary of the export process @findex org-export-as -Org mode export is a multi-step process that works on a temporary copy +Org mode export is a multistep process that works on a temporary copy of the buffer. The export process consists of 4 major steps: @enumerate @item -Process the temporary copy, making necessary changes to the buffer +Process the temporary copy@comma{} making necessary changes to the buffer text; @item -Parse the buffer, converting plain Org markup into an abstract +Parse the buffer@comma{} converting plain Org markup into an abstract syntax tree (AST); @item -Convert the AST to text, as prescribed by the selected export +Convert the AST to text@comma{} as prescribed by the selected export backend; @item @@ -17452,11 +17632,11 @@ Post-process the resulting exported text. @noindent Process temporary copy of the source Org buffer @footnote{Unless -otherwise specified, each step of the export process only operates on +otherwise specified@comma{} each step of the export process only operates on the accessible portion of the buffer. When subtree export is selected -(see @ref{The Export Dispatcher}), the buffer is narrowed to the body of -the selected subtree, so that the rest of the buffer text, except -export keywords, does not contribute to the export output.}: +(see @ref{The Export Dispatcher})@comma{} the buffer is narrowed to the body of +the selected subtree@comma{} so that the rest of the buffer text@comma{} except +export keywords@comma{} does not contribute to the export output.}: @enumerate @item @@ -17470,10 +17650,11 @@ Expand @samp{#+include} keywords in the whole buffer (see Remove commented subtrees in the whole buffer (see @ref{Comment Lines}); @item -Replace macros in the whole buffer (see @ref{Macro Replacement}); +Replace macros in the whole buffer (see @ref{Macro Replacement})@comma{} +unless @code{org-export-replace-macros} is nil; @item -When @code{org-export-use-babel} is non-nil (default), process code +When @code{org-export-use-babel} is non-nil (default)@comma{} process code blocks: @itemize @@ -17485,14 +17666,14 @@ Evaluate all the other code blocks according to code block headers (see @ref{Limit code block evaluation}); @item -Remove code, results of evaluation, both, or neither according +Remove code@comma{} results of evaluation@comma{} both@comma{} or neither according to @samp{:exports} header argument (see @ref{Exporting Code Blocks}). @end itemize @end enumerate @noindent -Parse the temporary buffer, creating AST: +Parse the temporary buffer@comma{} creating AST: @enumerate @item @@ -17501,11 +17682,11 @@ The hook functions may still modify the buffer; @item Calculate export option values according to subtree-specific export -settings, in-buffer keywords, @samp{#+BIND} keywords, and buffer-local +settings@comma{} in-buffer keywords@comma{} @samp{#+BIND} keywords@comma{} and buffer-local and global customization. The whole buffer is considered; @item -When @code{org-org-with-cite-processors} is non-nil (default), determine +When @code{org-org-with-cite-processors} is non-nil (default)@comma{} determine contributing bibliographies and record them into export options (see @ref{Citations}). The whole buffer is considered; @@ -17526,8 +17707,7 @@ elements (see @uref{https://orgmode.org/worg/dev/org-element-api.html, Org Eleme (heading (section ...)))) @end example - -Past this point, modifications to the temporary buffer no longer +Past this point@comma{} modifications to the temporary buffer no longer affect the export; Org export works only with the AST; @item @@ -17536,20 +17716,20 @@ Remove elements that are not exported from the AST: @itemize @item Headings according to @samp{SELECT_TAGS} and @samp{EXCLUDE_TAGS} export -keywords; @samp{task}, @samp{inline}, @samp{arch} export options (see +keywords; @samp{task}@comma{} @samp{inline}@comma{} @samp{arch} export options (see @ref{Export Settings}); @item Comments; @item -Clocks, drawers, fixed-width environments, footnotes, @LaTeX{} -environments and fragments, node properties, planning lines, -property drawers, statistics cookies, timestamps, etc according +Clocks@comma{} drawers@comma{} fixed-width environments@comma{} footnotes@comma{} @LaTeX{} +environments and fragments@comma{} node properties@comma{} planning lines@comma{} +property drawers@comma{} statistics cookies@comma{} timestamps@comma{} etc. according to @samp{#+OPTIONS} keyword (see @ref{Export Settings}); @item -Table rows containing width and alignment markers, unless the +Table rows containing width and alignment markers@comma{} unless the selected export backend changes @code{:with-special-rows} export option to non-nil (see @ref{Column Width and Alignment}); @@ -17566,14 +17746,14 @@ Execute @code{org-export-filter-parse-tree-functions}. These functions can modify the AST by side effects; @item -When @code{org-org-with-cite-processors} is non-nil (default), replace +When @code{org-org-with-cite-processors} is non-nil (default)@comma{} replace citation AST nodes and @samp{#+print_bibliography} keyword AST nodes as prescribed by the selected citation export processor (see @ref{Citation export processors}). @end enumerate @noindent -Convert the AST to text by traversing the AST nodes, depth-first: +Convert the AST to text by traversing the AST nodes@comma{} depth-first: @enumerate @item @@ -17591,7 +17771,7 @@ Concatenate all the converted child nodes to produce parent node contents; @item -Convert the nodes with children to text, passing the nodes +Convert the nodes with children to text@comma{} passing the nodes themselves and their exported contents to the corresponding transcoders and then to the export filters (see @ref{Filters}). @end enumerate @@ -17602,7 +17782,7 @@ Post-process the exported text: @enumerate @item -Post-process the converted AST, as prescribed by the export +Post-process the converted AST@comma{} as prescribed by the export backend. @footnote{ See @code{inner-template} in the docstring of @code{org-export-define-backend}.} This step usually adds generated content (like Table of Contents) to the exported text; @@ -17611,14 +17791,14 @@ to the exported text; Execute @code{org-export-filter-body-functions}; @item -Unless body-only export is selected (see @ref{The Export Dispatcher}), -add the necessary metadata to the final document, as prescribed +Unless body-only export is selected (see @ref{The Export Dispatcher})@comma{} +add the necessary metadata to the final document@comma{} as prescribed by the export backend. Examples: Document author/title; HTML headers/footers; @LaTeX{} preamble; @item -When @code{org-org-with-cite-processors} is non-nil (default), add -bibliography metadata, as prescribed by the citation export +When @code{org-org-with-cite-processors} is non-nil (default)@comma{} add +bibliography metadata@comma{} as prescribed by the citation export processor; @item @@ -17629,22 +17809,21 @@ Execute @code{org-export-filter-final-output-functions}. @subheading Extending an existing backend Some parts of the conversion process can be extended for certain -elements so as to introduce a new or revised translation. That is how +elements to introduce a new or revised translation. That is how the HTML export backend was extended to handle Markdown format. The extensions work seamlessly so any aspect of filtering not done by the extended backend is handled by the original backend. Of all the -export customization in Org, extending is very powerful as it operates +export customization in Org@comma{} extending is very powerful as it operates at the parser level. -For this example, make the @emph{ascii} backend display the language used +For this example@comma{} make the @emph{ascii} backend display the language used in a source code block. Also make it display only when some attribute -is non-@code{nil}, like the following: +is non-@code{nil}@comma{} like the following: @example #+ATTR_ASCII: :language t @end example - Then extend ASCII backend with a custom ``my-ascii'' backend. @lisp @@ -17655,7 +17834,7 @@ 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`----" + (format "@comma{}--[ %s ]--\n%s`----" (org-element-property :language src-block) (replace-regexp-in-string "^" "| " @@ -17667,21 +17846,21 @@ channel." @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} backend. If -true, which it is in this example, it creates a box around the code +current element. If not true@comma{} hands over to @emph{ascii} backend. If +true@comma{} which it is in this example@comma{} it creates a box around the code and leaves room for the inserting a string for language. The last form creates the new backend that springs to action only when translating @code{src-block} type elements. -To use the newly defined backend, evaluate the following from an Org +To use the newly defined backend@comma{} 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 +Further steps to consider would be an interactive function@comma{} +self-installing an item in the export dispatcher menu@comma{} and other user-friendly improvements. See @uref{https://orgmode.org/worg/dev/org-export-reference.html} for more details. @@ -17690,7 +17869,7 @@ details. @section Export Region Some export backends include commands to convert a region of Org -formatted text to another format, such as HTML or @LaTeX{}. The +formatted text to another format@comma{} such as HTML or @LaTeX{}. The conversion replaces the original source. Here are such commands: @table @asis @@ -17726,8 +17905,8 @@ Convert the selected region into Markdown. @end table The in-place conversion is particularly handy for quick conversion of -tables and lists in non-Org buffers. For example, in an HTML buffer, -write a list in Org syntax, select it, and convert it to HTML with +tables and lists in non-Org buffers. For example@comma{} in an HTML buffer@comma{} +write a list in Org syntax@comma{} select it@comma{} and convert it to HTML with @kbd{M-x org-html-convert-region-to-html}. @node Publishing @@ -17738,10 +17917,10 @@ write a list in Org syntax, select it, and convert it to HTML with 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. +upload your exported HTML pages and related attachments@comma{} such as +images and source code files@comma{} to a web server. -You can also use Org to convert files into PDF, or even combine HTML +You can also use Org to convert files into PDF@comma{} or even combine HTML and PDF conversion so that files are available in both formats on the server. @@ -17757,7 +17936,7 @@ Publishing has been contributed to Org by David O'Toole. @node Configuration @section Configuration -Publishing needs significant configuration to specify files, +Publishing needs significant configuration to specify files@comma{} destination and many other properties of a project. @menu @@ -17778,8 +17957,8 @@ destination and many other properties of a project. @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 +one variable@comma{} called @code{org-publish-project-alist}. Each element of the +list configures one project@comma{} and may be in one of the two following forms: @lisp @@ -17787,29 +17966,29 @@ forms: @end lisp @noindent -i.e., a well-formed property list with alternating keys and values, +i.e.@comma{} a well-formed property list with alternating keys and values@comma{} 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 +In both cases@comma{} projects are configured by specifying property values. +A project defines the set of files that are to be published@comma{} 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, +When a project takes the second form listed above@comma{} the individual +members of the @code{:components} property are taken to be sub-projects@comma{} 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. +When you publish such a ``meta-project''@comma{} all the components are also +published@comma{} 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 +Most properties are optional@comma{} but some should always be set. In +particular@comma{} Org needs to know where to look for source files@comma{} and where to put published files. @table @asis @@ -17818,20 +17997,20 @@ 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 +publish to a web server 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 +publishing process@comma{} for example@comma{} to run @samp{make} for updating files to be published. Each preparation function is called with a single -argument, the project property list. +argument@comma{} 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 +process@comma{} for example@comma{} to change permissions of the resulting files. +Each completion function is called with a single argument@comma{} the project property list. @end table @@ -17840,7 +18019,7 @@ project property list. @cindex files, selecting for publishing -By default, all files with extension @samp{.org} in the base directory are +By default@comma{} 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 @@ -17848,10 +18027,10 @@ following properties @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. +get all files in @code{:base-directory}@comma{} even without extension. @item @code{:exclude} -Regular expression to match file names that should not be published, +Regular expression to match file names that should not be published@comma{} even though they have been selected on the basis of their extension. @item @code{:include} @@ -17859,7 +18038,7 @@ 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 +Non-@code{nil} means@comma{} check base-directory recursively for files to publish. @end table @@ -17870,38 +18049,38 @@ publish. 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 +is to export Org files as HTML files@comma{} and this is done by the function @code{org-html-publish-to-html} which calls the HTML exporter (see @ref{HTML Export}). But you can also publish your content as PDF files using -@code{org-latex-publish-to-pdf}, or as ASCII, Texinfo, etc., using the +@code{org-latex-publish-to-pdf}@comma{} or as ASCII@comma{} Texinfo@comma{} etc.@comma{} 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 +@emph{archived}@comma{} @emph{commented}@comma{} and @emph{tag-excluded} trees removed@comma{} use @code{org-org-publish-to-org}. This produces @samp{file.org} and puts it in the -publishing directory. If you want a htmlized version of this file, +publishing directory. If you want a htmlized version of this file@comma{} 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.}. +directory is the same as the source directory@comma{} @samp{file.org} is exported +as @samp{file.org.org}@comma{} 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: +non-Org files@comma{} 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. +a list of functions@comma{} which are all called in turn. @item @code{:htmlized-source} -Non-@code{nil} means, publish htmlized source. +Non-@code{nil} means@comma{} publish an htmlized version of the 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 +at least a @code{:publishing-directory} property@comma{} the name of the file to +be published@comma{} and the path to the publishing directory of the output +file. It should take the specified file@comma{} make the necessary +transformation@comma{} if any@comma{} and place the result into the destination folder. @node Publishing options @@ -17911,15 +18090,15 @@ folder. @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 +and @LaTeX{} exporters. In most cases@comma{} 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. +When a property is given a value in @code{org-publish-project-alist}@comma{} its +setting overrides the value of the corresponding user variable@comma{} if +any@comma{} during publishing. Options set within a file (see @ref{Export Settings})@comma{} however@comma{} override everything. @anchor{Generic properties} @subsubheading Generic properties @@ -18295,12 +18474,14 @@ any, during publishing. Options set within a file (see @ref{Export Settings}), @tab @code{org-latex-toc-command} @item @code{:latex-compiler} @tab @code{org-latex-compiler} +@item @code{:latex-use-sans} +@tab @code{org-latex-use-sans} @end multitable @anchor{Markdown specific properties} @subsubheading Markdown specific properties -@multitable {aaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaa} +@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @code{:md-footnote-format} @tab @code{org-md-footnote-format} @item @code{:md-footnotes-section} @@ -18309,6 +18490,8 @@ any, during publishing. Options set within a file (see @ref{Export Settings}), @tab @code{org-md-headline-style} @item @code{:md-toplevel-hlevel} @tab @code{org-md-toplevel-hlevel} +@item @code{:md-link-org-files-as-md} +@tab @code{org-md-link-org-files-as-md} @end multitable @anchor{ODT specific properties} @@ -18317,6 +18500,8 @@ any, during publishing. Options set within a file (see @ref{Export Settings}), @multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @code{:odt-styles-file} @tab @code{org-odt-styles-file} +@item @code{:odt-with-forbidden-chars} +@tab @code{org-odt-with-forbidden-chars} @item @code{:odt-content-template-file} @tab @code{org-odt-content-template-file} @item @code{:odt-display-outline-level} @@ -18386,28 +18571,28 @@ any, during publishing. Options set within a file (see @ref{Export Settings}), @cindex links, publishing -To create a link from one Org file to another, you would use something +To create a link from one Org file to another@comma{} 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 +@ref{External Links}). When published@comma{} 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 +HTML@. If you also publish the Org source file and want to link to it@comma{} +use an @samp{http} link instead of a @samp{file:} link@comma{} because @samp{file} links are converted to link to the corresponding @samp{.html} file. -Links to encrypted Org files, like @samp{[[file:foo.org.gpg]]} are also +Links to encrypted Org files@comma{} like @samp{[[file:foo.org.gpg]]} are also supported. -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 +You may also link to related files@comma{} such as images. Provided you are +careful with relative file names@comma{} and provided you have also +configured Org to upload the related files@comma{} these links will work too. +See @ref{Complex example}@comma{} for an example of this usage. 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 +@ref{Search Options})@comma{} which will be resolved to the +appropriate location in the linked file. For example@comma{} once published +to HTML@comma{} the following links all point to a dedicated anchor in @samp{foo.html}. @example @@ -18427,11 +18612,11 @@ a map of files for a given project. @table @asis @item @code{:auto-sitemap} -When non-@code{nil}, publish a sitemap during +When non-@code{nil}@comma{} 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 +Filename for output of sitemap. Defaults to @samp{sitemap.org}@comma{} which becomes @samp{sitemap.html}. @item @code{:sitemap-title} @@ -18448,32 +18633,32 @@ source files is reflected in the site-map). Defaults to @code{tree}. @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, +file or directory name relative to base directory of the project@comma{} 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 +document titles as descriptions. For specific formatting needs@comma{} one +can use @code{org-publish-find-date}@comma{} @code{org-publish-find-title} and +@code{org-publish-find-property}@comma{} 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}, +list@comma{} which can further be transformed using @code{org-list-to-generic}@comma{} @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 +(default) or @code{last} to display folders first or last@comma{} respectively. +When set to @code{ignore}@comma{} 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{alphabetically} (default)@comma{} @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. @@ -18492,14 +18677,14 @@ 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 +When non-@code{nil}@comma{} 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. +adding a title@comma{} style information@comma{} etc. @cindex @samp{INDEX}, keyword Index entries are specified with @samp{INDEX} keyword. An entry that @@ -18518,30 +18703,30 @@ contains an exclamation mark creates a sub item. @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 +Rsync or Unison@comma{} it might be preferable not to use the built-in remote +publishing facilities of Org mode which rely heavily on Tramp. Tramp@comma{} +while very useful and powerful@comma{} 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 +addition to timestamp comparison@comma{} 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 +Since Unison@comma{} for example@comma{} can be configured as to which files to +transfer to a certain remote destination@comma{} 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 +location@comma{} process your Org files with @code{org-publish} and let the +synchronization tool do the rest. You do not need@comma{} in this scenario@comma{} +to include attachments such as JPG@comma{} 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 +one@comma{} so that you can more easily afford to republish entire projects. +If you set @code{org-publish-use-timestamps-flag} to @code{nil}@comma{} 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 @@ -18552,7 +18737,7 @@ been modified. 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 is more complex@comma{} with a multi-component project. @menu * Simple example:: One-component publishing. @@ -18581,24 +18766,23 @@ directory on the local machine. @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 +This more complicated example publishes an entire website@comma{} including +Org files converted to HTML@comma{} image files@comma{} Emacs Lisp source code@comma{} 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 +To ensure that links are preserved@comma{} care should be taken to replicate +your directory structure on the web server@comma{} and to use relative file +paths. For example@comma{} if your Org files are kept in @samp{~/org/} and your +publishable images in @samp{~/images/}@comma{} 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. +On the web server@comma{} 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. +place on the web server@comma{} and publishing images to it. @lisp (setq org-publish-project-alist @@ -18607,7 +18791,7 @@ place on the web server, and publishing images to it. :base-extension "org" :publishing-directory "/ssh:user@@host:~/html/notebook/" :publishing-function org-html-publish-to-html - :exclude ,(rx (or "PrivateFile.org" (seq line-start "private/"))) ;; regexp + :exclude @comma{}(rx (or "PrivateFile.org" (seq line-start "private/"))) ;; regexp :headline-levels 3 :section-numbers nil :with-toc nil @@ -18632,7 +18816,7 @@ place on the web server, and publishing images to it. @node Triggering Publication @section Triggering Publication -Once properly configured, Org can publish with the following commands: +Once properly configured@comma{} Org can publish with the following commands: @table @asis @item @kbd{C-c C-e P x} (@code{org-publish}) @@ -18661,7 +18845,7 @@ Publish every project. 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 +of the commands above@comma{} 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. @@ -18673,54 +18857,52 @@ keywords. @cindex citation processor While links (see @ref{Hyperlinks}) are often sufficient to refer to -external or internal information from Org, they have their limitations +external or internal information from Org@comma{} they have their limitations when referring to multiple targets or typesetting printed publications. Org mode provides a more sophisticated markup to ``cite'' external -resources. For example, consider the following Org mode snippet +resources. For example@comma{} consider the following Org mode snippet @example #+bibliography: citationdata.bib Org mode is used by various communities [cite:teaching: @@orgteaching; and TeX: @@orgtex]. [cite/author/caps:@@orgtex] uses Org mode to simplify -writing scientific publications, while [cite/author/caps:@@orgteaching] -experiment with Org babel to improve teaching. +writing scientific publications@comma{} while [cite/author/caps:@@orgteaching] +experiments with Org babel to improve teaching. #+print_bibliography: @end example - Org mode will gather citation metadata from the @samp{#+bibliography} database and use it to typeset the exported document in arbitrary -formats. For example, the snippet below shows ASCII export output. +formats. For example@comma{} the snippet below shows ASCII export output. @example -Org mode is used by various communities (teaching: Birkenkrahe, Marcus, -2023, and TeX: Somma, Emmanuele F, 2023). Somma, Emmanuele F uses Org -mode to simplify writing scientific publications, while Birkenkrahe, +Org mode is used by various communities (teaching: Birkenkrahe@comma{} Marcus@comma{} +2023@comma{} and TeX: Somma@comma{} Emmanuele F@comma{} 2023). Somma@comma{} Emmanuele F uses Org +mode to simplify writing scientific publications@comma{} while Birkenkrahe@comma{} Marcus experiment with Org babel to improve teaching. -Birkenkrahe, Marcus (2023). /Teaching Data Science with Literate -Programming Tools/, MDPI. +Birkenkrahe@comma{} Marcus (2023). /Teaching Data Science with Literate +Programming Tools/@comma{} MDPI. -Somma, Emmanuele F (2023). /Simplifying LaTeX with ORG-mode in Emacs/, +Somma@comma{} Emmanuele F (2023). /Simplifying LaTeX with ORG-mode in Emacs/@comma{} TUGboat volume. @end example - -In addition to export, users can use completion to search and insert +In addition to export@comma{} users can use completion to search and insert citations from the bibliography (via @code{org-cite-insert}). Citations -also act like ordinary links, jumping to the citation metadata when +also act like ordinary links@comma{} jumping to the citation metadata when ``following'' them using @code{org-open-at-point}. You can customize every aspect (@emph{capability}) of citation handling using built-in or external @emph{citation processors}. Org mode ships with several built-in citation processors tailored to -work with @LaTeX{} export and Bib@TeX{} bibliographies (@samp{bibtex}, -@samp{biblatex}, and @samp{natbib} processors), or with more generic formats +work with @LaTeX{} export and Bib@TeX{} bibliographies (@samp{bibtex}@comma{} +@samp{biblatex}@comma{} and @samp{natbib} processors)@comma{} or with more generic formats described using @uref{https://citationstyles.org/, Citation Style Language} (@samp{csl} processor). The default citation processor is @samp{basic} - it works with arbitrary @@ -18732,13 +18914,13 @@ More citation processors are distributed as Emacs packages. @vindex org-cite-insert-processor @vindex org-cite-export-processor Multiple citation processors can be mixed to meet your preferences. -Configure @code{org-cite-activate-processor}, @code{org-cite-follow-processor}, -@code{org-cite-insert-processor}, and @code{org-cite-export-processors} to +Configure @code{org-cite-activate-processor}@comma{} @code{org-cite-follow-processor}@comma{} +@code{org-cite-insert-processor}@comma{} and @code{org-cite-export-processors} to select which processor to use for every citation capability: @table @asis @item activate -Fontification, tooltip preview, etc. +Fontification@comma{} tooltip preview@comma{} etc. @item follow At-point actions on citations via @code{org-open-at-point}. @item insert @@ -18759,8 +18941,8 @@ Via different libraries for different target formats. @cindex bibliography @vindex org-cite-global-bibliography -Before adding citations, first set one-or-more bibliographies, either -globally with @code{org-cite-global-bibliography}, or locally using one or +Before adding citations@comma{} first set one-or-more bibliographies@comma{} either +globally with @code{org-cite-global-bibliography}@comma{} or locally using one or more ``bibliography'' keywords. @cindex @samp{BIBLIOGRAPHY}, keyword @@ -18775,10 +18957,10 @@ search for citation keys. @kindex C-c C-x @@ @findex org-cite-insert -One can then insert and edit citations using @code{org-cite-insert}, called +One can then insert and edit citations using @code{org-cite-insert}@comma{} called with @kbd{C-c C-x @@}. -A @emph{citation} requires one or more citation @emph{key(s)}, elements +A @emph{citation} requires one or more citation @emph{key(s)}@comma{} elements identifying a reference in the bibliography. @itemize @@ -18794,7 +18976,7 @@ Each key starts with the character @samp{@@}. @item Each key can be qualified by a @emph{prefix} (e.g.@tie{}``see '') and/or -a @emph{suffix} (e.g.@tie{}``p.@tie{}123''), giving information useful or necessary +a @emph{suffix} (e.g.@tie{}``p.@tie{}123'')@comma{} giving information useful or necessary for the comprehension of the citation but not included in the reference. @@ -18820,8 +19002,7 @@ colon; this usually makes sense only for the author-year styles. [cite/style:common prefix ;prefix @@key suffix; ... ; common suffix] @end example - -When @samp{style} is not specified, one of the two default styles are +When @samp{style} is not specified@comma{} one of the two default styles are used @itemize @@ -18835,7 +19016,7 @@ either the default style specified in the @samp{CITE_EXPORT} keyword @end example @item -or, if @samp{CITE_EXPORT} is not set, using the default @samp{nil} style +or@comma{} if @samp{CITE_EXPORT} is not set@comma{} using the default @samp{nil} style @example [cite:@@key] is the same as [cite/nil:@@key] @@ -18862,12 +19043,12 @@ Org currently includes the following export processors: @itemize @item -Two processors can export to a variety of formats, including @samp{latex} -(and therefore @samp{pdf}), @samp{html}, @samp{odt} and plain (UTF8) text: +Two processors can export to a variety of formats@comma{} including @samp{latex} +(and therefore @samp{pdf})@comma{} @samp{html}@comma{} @samp{odt} and plain (UTF8) text: @table @asis @item basic -a basic export processor, well adapted to situations +a basic export processor@comma{} well adapted to situations where backward compatibility is not a requirement and formatting needs are minimal; @@ -18879,33 +19060,33 @@ Style Language} via @end table @item -In contrast, three other processors target @LaTeX{} and @LaTeX{}-derived +In contrast@comma{} three other processors target @LaTeX{} and @LaTeX{}-derived formats exclusively: @table @asis @item bibtex -this export processor uses Bib@TeX{}, the historical -bibliographic processor used with @LaTeX{}, thus allowing the use of +this export processor uses Bib@TeX{}@comma{} the historical +bibliographic processor used with @LaTeX{}@comma{} thus allowing the use of data and style files compatible with this processor (including a large number of publishers' styles). It only supports @LaTeX{}'s @samp{\cite} and @samp{\nocite} commands. @item natbib -as with the bibtex processor, but using the @LaTeX{} -package @samp{natbib}, allowing more stylistic variants that @LaTeX{}'s +as with the @samp{bibtex} processor@comma{} but using the @LaTeX{} +package @samp{natbib}@comma{} allowing more stylistic variants than @LaTeX{}'s @samp{\cite} command. @item biblatex this backend allows the use of data and formats -prepared for Bib@LaTeX{}, an alternate bibliographic processor used -with @LaTeX{}, which overcomes some serious Bib@TeX{} limitations, but +prepared for Bib@LaTeX{}@comma{} an alternate bibliographic processor used +with @LaTeX{}@comma{} which overcomes some serious Bib@TeX{} limitations@comma{} but has not (yet?)@tie{}been widely adopted by publishers. @end table @end itemize @cindex @samp{CITE_EXPORT}, keyword -The @samp{CITE_EXPORT} keyword specifies the export processor, citation -style, and bibliography style; for example (all arguments are +The @samp{CITE_EXPORT} keyword specifies the export processor@comma{} citation +style@comma{} and bibliography style; for example (all arguments are optional) @example @@ -18913,7 +19094,6 @@ optional) #+cite_export: basic author-year author @end example - @noindent specifies the @samp{basic} export processor with citations inserted as author's name and references indexed by author's names and year; @@ -18922,44 +19102,40 @@ author's name and references indexed by author's names and year; #+cite_export: csl /some/path/to/vancouver-brackets.csl @end example - @noindent -specifies the @samp{csl} processor and CSL style, which in this case +specifies the @samp{csl} processor and CSL style@comma{} which in this case defines numeric citations and numeric references according to the -@samp{Vancouver} specification (as style used in many medical journals), +@samp{Vancouver} specification (as style used in many medical journals)@comma{} following a typesetting variation putting citations between brackets; @example #+cite_export: natbib kluwer @end example - @noindent specifies the @samp{natbib} export processor with a label citation style conformant to the Harvard style and the specification of the Wolkers-Kluwer publisher; since it relies on the @code{bibtex} processor of -your @LaTeX{} installation, it won't export to anything but PDF@. +your @LaTeX{} installation@comma{} it won't export to anything but PDF@. @example -#+cite_export: biblatex numeric,backend=bibtex +#+cite_export: biblatex numeric@comma{}backend=bibtex @end example - @vindex org-cite-biblatex-options @noindent specifies the @samp{biblatex} export processor with the default @samp{numeric} style and the @samp{bibtex} backend. Always define the style first and then the rest of load-time options for the @samp{biblatex} -package. Alternatively, you can use the @code{key=val,key=val} format for +package. Alternatively@comma{} you can use the @code{key=val@comma{}key=val} format for the options as documented in the @samp{biblatex} package documentation: @example -#+cite_export: biblatex backend=bibtex,style=numeric +#+cite_export: biblatex backend=bibtex@comma{}style=numeric @end example - The @code{org-cite-biblatex-options} variable in your Emacs configuration -uses this format. It will only export to PDF, since it relies on the +uses this format. It will only export to PDF@comma{} since it relies on the @code{biblatex} processor of your @LaTeX{} installation. @node Bibliography printing @@ -18973,17 +19149,16 @@ should be printed (note the colon): #+print_bibliography: @end example - The bibliography printed by the @LaTeX{}-based export processors -@samp{bibtex}, @samp{natbib} and @samp{biblatex} has a chapter or section heading by -default, while the @samp{basic} and @samp{csl} processors print the list of +@samp{bibtex}@comma{} @samp{natbib} and @samp{biblatex} has a chapter or section heading by +default@comma{} while the @samp{basic} and @samp{csl} processors print the list of bibliography entries without a heading. A document may contain more than one @samp{PRINT_BIBLIOGRAPHY} keywords. Each of the keywords will trigger printing the bibliography. The keywords can be used with or without additional options. Options -can be used, for example, to print only entries that belong to a +can be used@comma{} for example@comma{} to print only entries that belong to a certain category or to control formatting. The set of supported @samp{PRINT_BIBLIOGRAPHY} options and their interpretation varies between the different citation export processors. Some export processors do @@ -18998,33 +19173,31 @@ not support passing options. The @samp{biblatex} and @samp{csl} export processors support bibliography options through a property list attached to the @samp{PRINT_BIBLIOGRAPHY} -keyword. For example, +keyword. For example@comma{} @example #+print_bibliography: :keyword algebra :type book @end example - Values including spaces must be surrounded with double quotes. If you -need to use a key multiple times, you can separate its values with -commas, but without any space in-between: +need to use a key multiple times@comma{} you can separate its values with +commas@comma{} but without any space in-between: @example -#+print_bibliography: :keyword "algebraic logic" :nottype article,book +#+print_bibliography: :keyword "algebraic logic" :nottype article@comma{}book @end example - The @samp{biblatex} export processor accepts all options supported by Bib@LaTeX{}'s @code{\printbibliography} command. The @samp{csl} processor accepts the following options: @table @asis -@item @samp{:keyword } +@item @samp{:keyword } Print only entries whose keyword field contains all given keywords. -@item @samp{:notkeyword } +@item @samp{:notkeyword } Print only entries whose keyword field does not contain any of the given keywords. @@ -19034,7 +19207,7 @@ Print only entries whose type is information is available (the entry was read from a Bib@TeX{}/Bib@LaTeX{} bibliography) and the CSL entry type otherwise. -@item @samp{:nottype } +@item @samp{:nottype } Print only entries whose type is not among the given entry types. Entry type is determined as in the case of @samp{:type}. @@ -19044,7 +19217,7 @@ Print only entries whose CSL entry type (possibly based on a conversion from Bib@TeX{}/Bib@LaTeX{} to CSL) is @samp{}. -@item @samp{:notcsltype } +@item @samp{:notcsltype } Print only entries whose CSL entry type (possibly based on a conversion from Bib@TeX{}/Bib@LaTeX{} to CSL) is not among the listed entry types. @@ -19060,13 +19233,13 @@ Emacs Lisp predicate returns a non-@code{nil} value. @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 +instructions@comma{} possibly with comments@comma{} 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 +However@comma{} 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: @@ -19079,9 +19252,9 @@ Here is an example source code block in the Emacs Lisp language: #+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 +Source code blocks are one of many Org block types@comma{} which also include +``center''@comma{} ``comment''@comma{} ``dynamic''@comma{} ``example''@comma{} ``export''@comma{} ``quote''@comma{} +``special''@comma{} 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 @@ -19109,15 +19282,15 @@ in the following sections. 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 +essential to modern source code maintenance. Org can edit@comma{} format@comma{} +extract@comma{} export@comma{} and publish source code blocks. Org can also compile +and execute a source code block@comma{} 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 the ``liveliness'' of each -source code block by tweaking the header arguments (see @ref{Using Header Arguments}) for compiling, execution, extraction, and exporting. +source code block by tweaking the header arguments (see @ref{Using Header Arguments}) for compiling@comma{} execution@comma{} extraction@comma{} and exporting. -For editing and formatting a source code block, Org uses an +For editing and formatting a source code block@comma{} Org uses an appropriate Emacs major mode that includes features specifically designed for source code in that language. @@ -19125,32 +19298,32 @@ 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 backends can format a source code -block appropriately, often with native syntax highlighting. +For exporting and publishing@comma{} Org's backends can format a source code +block appropriately@comma{} often with native syntax highlighting. -For executing and compiling a source code block, the user can +For executing and compiling a source code block@comma{} 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 +facilities to collect the result of the execution or compiler output@comma{} +insert it into the Org document@comma{} and/or export it. In addition to +text results@comma{} Org can insert links to other data types@comma{} including +audio@comma{} video@comma{} 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 +ability to pass variables@comma{} functions@comma{} 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 +another@comma{} 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 +management facility was named @emph{Org Babel} by its originators@comma{} 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 +publishing reproducible research by keeping text@comma{} data@comma{} code@comma{} +configuration settings of the execution environment@comma{} the results of +the execution@comma{} and associated narratives@comma{} claims@comma{} references@comma{} and internal and external links in a single Org document. @node Structure of Code Blocks @@ -19162,7 +19335,7 @@ internal and external links in a single Org document. @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 +a source code block@comma{} and directly inline. Both specifications are shown below. A source code block conforms to this structure: @@ -19174,12 +19347,12 @@ A source code block conforms to this structure: #+END_SRC @end example -Do not be put-off by having to remember the source block syntax. Org +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 +in Emacs@comma{} 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. +errors@comma{} increases accuracy@comma{} and maintains consistency. @cindex source code, inline An inline code block conforms to this structure: @@ -19188,7 +19361,6 @@ An inline code block conforms to this structure: src_@{@} @end example - @noindent or @@ -19196,45 +19368,45 @@ or src_[
]@{@} @end example - @table @asis @item @samp{#+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 +Optional. Names the source block@comma{} so it can be called@comma{} like +a function@comma{} from other source blocks or inline code to evaluate or +to capture the results. Code from other blocks@comma{} other files@comma{} 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. Inline code blocks cannot +names@comma{} Org mode's behavior is undefined. Inline code blocks cannot have a name. @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 +requires. The @samp{#+BEGIN_SRC} line takes additional arguments@comma{} as described next. @item @samp{} @cindex language, in code blocks Optional. It is the identifier of the source code language in the -block. See @ref{Languages}, for identifiers of supported languages. +block. See @ref{Languages}@comma{} for identifiers of supported languages. -When @samp{} identifier is omitted, the block also cannot -have @samp{} and @samp{
}. +When @samp{} identifier is omitted@comma{} the block also cannot +have @samp{} and @samp{
}. Otherwise@comma{} the first +switch/argument will be treated as @samp{}. Language identifier is also used to fontify code blocks in Org -buffers, when @code{org-src-fontify-natively} is set to non-@code{nil}. See +buffers@comma{} when @code{org-src-fontify-natively} is set to non-@code{nil}. See @ref{Editing Source Code}. @item @samp{} @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}). +Optional. Switches provide finer control of the code execution@comma{} +export@comma{} and format (see the discussion of switches in @ref{Literal Examples}). @item @samp{
} @cindex header arguments, in code blocks -Optional. Heading arguments control many aspects of evaluation, +Optional. Heading arguments control many aspects of evaluation@comma{} export and tangling of code blocks (see @ref{Using Header Arguments}). -Using Org's properties feature, header arguments can be selectively +Using Org's properties feature@comma{} header arguments can be selectively applied to the entire buffer or specific subtrees of the Org document. @@ -19251,9 +19423,9 @@ 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 +Since header arguments can be set in several ways@comma{} Org prioritizes them in case of overlaps or conflicts by giving local settings -a higher priority. Header values in function calls, for example, +a higher priority. Header values in function calls@comma{} for example@comma{} override header values from global defaults. @anchor{System-wide header arguments} @@ -19263,7 +19435,7 @@ override header values from global defaults. @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 +the @code{org-babel-default-header-args} variable@comma{} which defaults to the following values: @example @@ -19290,14 +19462,14 @@ different default header arguments defined in The most notable difference between default header arguments for inline and normal source blocks is @samp{:exports} argument. For inline -source blocks, results of evaluation are exported by default; not the +source blocks@comma{} results of evaluation are exported by default; not the code. -Unlike the default values, header arguments set using Org mode +Unlike the default values@comma{} header arguments set using Org mode properties (see @ref{Header arguments in Org mode properties}) do apply to both the normal source blocks and inline source blocks. -The example below sets @samp{:noweb} header arguments to @samp{yes}, which makes +The example below sets @samp{:noweb} header arguments to @samp{yes}@comma{} which makes Org expand @samp{:noweb} references by default. @lisp @@ -19306,23 +19478,23 @@ Org expand @samp{:noweb} references by default. (assq-delete-all :noweb org-babel-default-header-args))) @end lisp -@cindex language specific default header arguments +@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:}, where -@var{} is the name of the language. For details, see the +customizing the variable @code{org-babel-default-header-args:}@comma{} where +@var{} is the name of the language. For details@comma{} 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 +For header arguments applicable to the buffer@comma{} 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 +executions for all blocks@comma{} not just R code blocks; no results inserted for any block. @example @@ -19332,11 +19504,11 @@ for any block. @vindex org-use-property-inheritance Header arguments set through Org's property drawers (see @ref{Property Syntax}) apply at the subtree level on down. Since these property -drawers can appear anywhere in the file hierarchy, Org uses outermost +drawers can appear anywhere in the file hierarchy@comma{} 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 +In this example@comma{} @samp{:cache} defaults to @samp{yes} for all code blocks in the subtree. @example @@ -19348,15 +19520,15 @@ subtree. @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 defined through @code{org-set-property} function@comma{} bound to +@kbd{C-c C-x p}@comma{} apply to all active languages. They override properties set in @code{org-babel-default-header-args}. -@cindex language specific header arguments properties +@cindex language-specific header arguments properties @cindex header arguments per language Language-specific header arguments are also read from properties @samp{header-args:} where @var{} is the language -identifier. For example, +identifier. For example@comma{} @example * Heading @@ -19372,18 +19544,18 @@ identifier. For 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}@comma{} 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, +Header arguments are most commonly set at the source code block level@comma{} 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. +variable@comma{} and also those set as header properties. -In the following example, setting @samp{:results} to @samp{silent} makes it +In the following example@comma{} 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{}. @@ -19401,7 +19573,6 @@ The same header arguments in an inline code block: 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 @@ -19413,11 +19584,11 @@ 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) + (message "data1:%S@comma{} data2:%S" data1 data2) #+END_SRC #+RESULTS: -: data1:1, data2:2 +: data1:1@comma{} data2:2 @end example Multi-line header arguments on a named code block: @@ -19439,17 +19610,16 @@ Multi-line header arguments on a named code block: 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}. +syntax of @samp{CALL} keyword@comma{} see @ref{Evaluating Code Blocks}. -In this example, @samp{:exports results} header argument is applied to the +In this example@comma{} @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 +In this example@comma{} @samp{:session special} header argument is applied to the evaluation of @samp{factorial} code block. @example @@ -19467,9 +19637,9 @@ evaluation of @samp{factorial} code block. @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. +covered in the language-specific documentation. The syntax for @samp{var}@comma{} +however@comma{} is the same for all languages. This includes declaring +a variable@comma{} and assigning a default value. The following syntax is used to pass arguments to code blocks using the @samp{var} header argument. @@ -19478,23 +19648,21 @@ the @samp{var} header argument. :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 +body. @var{ASSIGN} is a literal value@comma{} such as a string@comma{} +a number@comma{} a reference to a table@comma{} a list@comma{} a literal example@comma{} another code block---with or without arguments---or the results of evaluating a code block. @var{ASSIGN} may specify a filename for references -to elements in a different file, using a @samp{:} to separate the filename +to elements in a different file@comma{} using a @samp{:} to separate the filename from the reference. @example :var NAME=FILE:REFERENCE @end example - -When @samp{FILE} does not exist, the reference is searched in the current -file, using the verbatim reference. This way, +When @samp{FILE} does not exist@comma{} the reference is searched in the current +file@comma{} using the verbatim reference. This way@comma{} @samp{:var table=tbl:example} will be searched inside the current buffer. Here are examples of passing values by reference: @@ -19519,18 +19687,18 @@ A table named with a @samp{NAME} keyword. : 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 +When passing a table@comma{} you can treat specially the row@comma{} or the +column@comma{} containing labels for the columns@comma{} or the rows@comma{} in the table. @cindex @samp{colnames}, header argument -The @samp{colnames} header argument accepts @samp{yes}, @samp{no}, or @samp{nil} values. +The @samp{colnames} header argument accepts @samp{yes}@comma{} @samp{no}@comma{} 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 non-hline row, even if the initial -table does not contain any horizontal rule. When set to @samp{no}, Org +removes the column names@comma{} processes the table@comma{} puts back the column +names@comma{} and then writes the table to the results block. Using @samp{yes}@comma{} +Org does the same to the first non-hline row@comma{} even if the initial +table does not contain any horizontal rule. When set to @samp{no}@comma{} Org does not pre-process column names at all. @example @@ -19552,10 +19720,10 @@ return [[val + '*' for val in row] for row in tab] @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 +Similarly@comma{} the @samp{rownames} header argument can take two values: @samp{yes} +or @samp{no}. When set to @samp{yes}@comma{} Org removes the first column@comma{} processes +the table@comma{} puts back the first column@comma{} and then writes the table to +the results block. The default is @samp{no}@comma{} 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. @@ -19575,8 +19743,8 @@ return [[val + 10 for val in row] for row in tab] @end example @end table -To refer to a table in another file, join the filename and table name with -a colon, for example: @samp{:var table=other-file.org:example-table}. +To refer to a table in another file@comma{} join the filename and table name with +a colon@comma{} for example: @samp{:var table=other-file.org:example-table}. @table @asis @item list @@ -19601,8 +19769,8 @@ 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. +A code block name@comma{} as assigned by @samp{NAME} keyword from the example +above@comma{} optionally followed by parentheses. @example #+BEGIN_SRC emacs-lisp :var length=table-length() @@ -19614,7 +19782,7 @@ above, optionally followed by parentheses. @end example @item code block with arguments -A code block name, as assigned by @samp{NAME} keyword, followed by +A code block name@comma{} as assigned by @samp{NAME} keyword@comma{} followed by parentheses and optional arguments passed within the parentheses. The block is evaluated with point at its location. @@ -19636,8 +19804,8 @@ The block is evaluated with point at its location. : 4 @end example -@item literal example, or code block contents -A code block or literal example block named with a @samp{NAME} keyword, +@item literal example@comma{} or code block contents +A code block or literal example block named with a @samp{NAME} keyword@comma{} followed by brackets (optional for example blocks). @example @@ -19662,8 +19830,8 @@ 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 +@emph{before} other table-related header arguments are applied@comma{} such as +@samp{hlines}@comma{} @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}: @@ -19674,7 +19842,7 @@ variable @samp{data}: | 3 | c | | 4 | d | -#+BEGIN_SRC emacs-lisp :var data=example-table[0,-1] +#+BEGIN_SRC emacs-lisp :var data=example-table[0@comma{}-1] data #+END_SRC @@ -19705,7 +19873,7 @@ to @samp{data}. | 4 | d | @end example -To pick the entire range, use an empty index, or the single character +To pick the entire range@comma{} use an empty index@comma{} or the single character @samp{*}. @samp{0:-1} does the same thing. Example below shows how to reference the first column only. @@ -19716,7 +19884,7 @@ reference the first column only. | 3 | c | | 4 | d | -#+BEGIN_SRC emacs-lisp :var data=example-table[,0] +#+BEGIN_SRC emacs-lisp :var data=example-table[@comma{}0] data #+END_SRC @@ -19726,7 +19894,7 @@ reference the first column only. 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. +multiple dimensions@comma{} as shown below. @example #+NAME: 3D @@ -19736,7 +19904,7 @@ multiple dimensions, as shown below. ((19 20 21) (22 23 24) (25 26 27))) #+END_SRC -#+BEGIN_SRC emacs-lisp :var data=3D[1,,1] +#+BEGIN_SRC emacs-lisp :var data=3D[1@comma{}@comma{}1] data #+END_SRC @@ -19745,12 +19913,12 @@ multiple dimensions, as shown below. @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 +indexing. You need to take them into account@comma{} 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 +differentiate a value from Lisp code@comma{} Org interprets any value +starting with @samp{(}@comma{} @samp{[}@comma{} @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 @@ -19764,13 +19932,13 @@ the block starts executing. @end example Note that values read from tables and lists are not mistakenly -evaluated as Emacs Lisp code, as illustrated in the following example. +evaluated as Emacs Lisp code@comma{} as illustrated in the following example. @example #+NAME: table | (a b c) | -#+HEADER: :var data=table[0,0] +#+HEADER: :var data=table[0@comma{}0] #+BEGIN_SRC perl $data #+END_SRC @@ -19796,19 +19964,19 @@ 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 +session. For example@comma{} @samp{:session STRING} names it @samp{STRING}. If +@samp{session} has no value@comma{} 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 +code language use the same session. Depending on the language@comma{} +state variables@comma{} code from other blocks@comma{} 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 +support. Not all languages provide this support@comma{} such as C and ditaa. +Even languages@comma{} such as Python and Haskell@comma{} 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. @@ -19820,50 +19988,50 @@ for those code blocks running in a session. @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 +block execution. If it is absent@comma{} then the directory associated with +the current buffer is used. In other words@comma{} 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 +directory with @kbd{M-x cd @key{RET} DIRECTORY}@comma{} and then not setting +@samp{dir}. Under the surface@comma{} @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. +a non-@code{nil} value creates the directory@comma{} if necessary. Setting @samp{dir} to the symbol @code{attach} or the string @code{"'attach"} will -set @samp{dir} to the directory returned by @code{(org-attach-dir)}, set @samp{:mkdir -yes}, and insert any file paths, as when using @samp{:results file}, which -are under the node's attachment directory using @samp{attachment:} links -instead of the usual @samp{file:} links. Any returned path outside of the -attachment directory will use @samp{file:} links as per usual. - -For example, to save the plot file in the @samp{Work/} folder of the home +set @samp{dir} to the directory returned by @code{(org-attach-dir)}@comma{} set +@samp{:mkdirp yes}@comma{} and insert any file paths@comma{} as when using @samp{:results +file}@comma{} which are under the node's attachment directory using +@samp{attachment:} links instead of the usual @samp{file:} links. Any returned +path outside the attachment directory will use @samp{file:} links as per +usual. + +For example@comma{} 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") + matplot(matrix(rnorm(100)@comma{} 10)@comma{} type="l") #+END_SRC @end example -To evaluate the code block on a remote machine, supply a remote +To evaluate the code block on a remote machine@comma{} 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)) + plot(1:10@comma{} main=system("hostname"@comma{} 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 +file. Then Org also inserts a link to the remote file@comma{} thanks to Emacs Tramp. Org constructs the remote path to the file name from -@samp{dir} and @code{default-directory}, as illustrated here: +@samp{dir} and @code{default-directory}@comma{} 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 +When @samp{dir} is used with @samp{session}@comma{} Org sets the starting directory for a new session. But Org does not alter the directory of an already existing session. @@ -19879,8 +20047,8 @@ portability issues. @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 for execution@comma{} like a reset instruction. For example@comma{} you may +use @samp{:prologue "reset"} in a Gnuplot code block or@comma{} for every such block: @lisp @@ -19890,7 +20058,7 @@ block: @end lisp @cindex @samp{epilogue}, header argument -Likewise, the value of the @samp{epilogue} header argument is for appending +Likewise@comma{} the value of the @samp{epilogue} header argument is for appending to the end of the code block for execution. @node Evaluating Code Blocks @@ -19901,19 +20069,19 @@ to the end of the code block for execution. @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}. +Org provides safeguards by prompting for the user's permission before +executing any code. To customize this safeguard@comma{} or disable it@comma{} 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 +in the Org file@comma{} 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. More details in @ref{Results of Evaluation}. -By default, Org enables only Emacs Lisp code blocks for execution. +By default@comma{} Org enables only Emacs Lisp code blocks for execution. See @ref{Languages} to enable other languages. @kindex C-c C-c @@ -19923,12 +20091,12 @@ 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. +@code{org-babel-execute-src-block} function@comma{} which executes the code in the +block@comma{} collects the results@comma{} 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_()} and @samp{src_@{@}} +By calling a named code block@footnote{Actually@comma{} the constructs @samp{call_()} and @samp{src_@{@}} 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}). @@ -19947,17 +20115,17 @@ The syntax for inline named code blocks is: ... call_[]()[] ... @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 +When inline syntax is used@comma{} the result is wrapped based on the +variable @code{org-babel-inline-result-wrap}@comma{} which by default is set to @code{"=%s="} to produce verbatim text suitable for markup. @table @asis @item @samp{} 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{} 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: +another file@comma{} start @samp{} with the file name followed by +a colon. For example@comma{} in order to execute a block named @samp{clear-data} +in @samp{file.org}@comma{} you can write the following: @example #+CALL: file.org:clear-data() @@ -19965,15 +20133,14 @@ in @samp{file.org}, you can write the following: @item @samp{} 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}, +syntax. For example@comma{} a @samp{#+CALL:} line that passes @samp{4} to a code +block named @samp{double}@comma{} which declares the header argument @samp{:var n=2}@comma{} 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. @@ -19981,14 +20148,14 @@ argument syntax. @item @samp{} 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 +evaluation. For example@comma{} @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 affect the results returned by the code block. -For example, @samp{:results html} wraps the results in a @samp{#+BEGIN_EXPORT +For example@comma{} @samp{:results html} wraps the results in a @samp{#+BEGIN_EXPORT html} block before inserting the results in the Org buffer. @end table @@ -20003,7 +20170,7 @@ evaluating untrusted code blocks by prompting for a confirmation. @table @asis @item @samp{yes} -Org evaluates the source code, possibly asking permission according +Org evaluates the source code@comma{} possibly asking permission according to @code{org-confirm-babel-evaluate}. @item @samp{never} or @samp{no} @@ -20013,7 +20180,7 @@ Org never evaluates the source code. 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 +Org does not evaluate the source code when exporting@comma{} yet the user can evaluate it interactively. @item @samp{query-export} @@ -20021,7 +20188,7 @@ 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 +If @samp{eval} header argument is not set@comma{} then Org determines whether to evaluate the source code from the @code{org-confirm-babel-evaluate} variable (see @ref{Code Evaluation Security}). @@ -20033,25 +20200,25 @@ variable (see @ref{Code Evaluation Security}). 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 +and avoid redundant evaluations@comma{} the source block must have a result +already present in the buffer@comma{} 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. +cases@comma{} however@comma{} the cached results may not be reliable. -The caching feature is best for when code blocks are pure functions, +The caching feature is best for when code blocks are pure functions@comma{} 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 +arguments (see @ref{Environment of a Code Block})@comma{} and that do not have +side effects@comma{} and do not rely on external variables other than the +input arguments. Functions that depend on a timer@comma{} file system +objects@comma{} and random number generators are clearly unsuitable for caching. -A note of warning: when @samp{cache} is used in a session, caching may +A note of warning: when @samp{cache} is used in a session@comma{} caching may cause unexpected results. -When the caching mechanism tests for any source code changes, it does +When the caching mechanism tests for any source code changes@comma{} 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}. @@ -20064,13 +20231,13 @@ Default. No caching of results; code block evaluated every time. 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. +@samp{#+RESULTS:} line from previous evaluation. When hash values match@comma{} +Org does not evaluate the code block. When hash values mismatch@comma{} +Org evaluates the code block@comma{} inserts the results@comma{} recalculates the +hash value@comma{} and updates @samp{#+RESULTS:} line. @end table -In this example, both functions are cached. But @samp{caller} runs only if +In this example@comma{} both functions are cached. But @samp{caller} runs only if the result from @samp{random} has changed since the last run. @example @@ -20099,7 +20266,7 @@ the result from @samp{random} has changed since the last run. @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, +header arguments working together. The primary determinant@comma{} however@comma{} is the @samp{results} header argument. It accepts four classes of options. Each code block can take only one option per class: @@ -20126,27 +20293,27 @@ they are mutually exclusive. @table @asis @item @samp{value} -Default for most Babel libraries@footnote{Actually, the constructs @samp{call_()} and @samp{src_@{@}} +Default for most Babel libraries@footnote{Actually@comma{} the constructs @samp{call_()} and @samp{src_@{@}} 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 + value}@comma{} code should execute like a function and return a value. For +languages like Python@comma{} 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 +When evaluating the code block in a session (see @ref{Environment of a Code Block})@comma{} 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@. +language-specific methods to obtain the value. For example@comma{} from +the variable @code{_} in Ruby@comma{} 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 +When using a session@comma{} 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 @@ -20158,24 +20325,23 @@ 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. -The result type detection depends on the code block language, as +The result type detection depends on the code block language@comma{} as described in the documentation for individual languages. See @ref{Languages}. @table @asis -@item @samp{table} -@itemx @samp{vector} +@item @samp{table}@comma{} @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: +value@comma{} 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''. +In-between each table row or below the table headings@comma{} sometimes +results have horizontal lines@comma{} 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 +from the input table. For most code@comma{} this is desirable@comma{} or else those @samp{hline} symbols raise unbound variable errors. A @samp{yes} -accepts such lines, as demonstrated in the following example. +accepts such lines@comma{} as demonstrated in the following example. @example #+NAME: many-cols @@ -20210,23 +20376,22 @@ return tab @item @samp{list} Interpret the results as an Org list. If the result is a single -value, create a list of one element. +value@comma{} create a list of one element. -@item @samp{scalar} -@itemx @samp{verbatim} +@item @samp{scalar}@comma{} @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 +block to that file@comma{} 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, +@samp{output-dir} header arguments. If @samp{output-dir} is not specified@comma{} Org assumes it is the current directory. @example @@ -20237,9 +20402,9 @@ Org assumes it is the current directory. @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 +If @samp{file} header argument is missing@comma{} Org generates the base name of +the output file from the name of the code block@comma{} and its extension +from the @samp{file-ext} header argument. In that case@comma{} both the name and the extension are mandatory. Result can also be interpreted as path to file. See @samp{:results @@ -20254,20 +20419,20 @@ Result can also be interpreted as path to file. See @samp{:results @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-desc} header argument defines the description (see @ref{Link Format}) for the link. If @samp{file-desc} is present but has no value@comma{} the @samp{file} value is used as the link description. When this -argument is not present, the description is omitted. If you want to -provide the @samp{file-desc} argument but omit the description, you can -provide it with an empty vector (i.e., :file-desc []). +argument is not present@comma{} the description is omitted. If you want to +provide the @samp{file-desc} argument but omit the description@comma{} you can +provide it with an empty vector (i.e.@comma{} :file-desc []). @cindex @samp{sep}, header argument -By default, Org assumes that a table written to a file has +By default@comma{} 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)}. +make it executable@comma{} use @samp{:file-mode (identity #o755)}. @example #+BEGIN_SRC shell :results file :file script.sh :file-mode (identity #o755) @@ -20294,9 +20459,9 @@ Result enclosed in a code block. Useful for parsing. Usage example: @samp{:results value code}. @item @samp{drawer} -Results are added directly to the Org file as with @samp{raw}, but are +Results are added directly to the Org file as with @samp{raw}@comma{} but are wrapped in a @samp{RESULTS} drawer or results macro (for inline code -blocks), for later scripting and automated processing. +blocks)@comma{} for later scripting and automated processing. Usage example: @samp{:results value drawer}. @item @samp{html} @@ -20307,12 +20472,11 @@ Results enclosed in a @samp{BEGIN_EXPORT html} block. Usage example: 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, code block output is not written to the disk. The block is -expected to generate the file by its side-effects only, as in the +@item @samp{link}@comma{} @samp{graphics} +When used along with @samp{file} type@comma{} the result is a link to the file +specified in @samp{:file} header argument. However@comma{} unlike plain @samp{file} +type@comma{} code block output is not written to the disk. The block is +expected to generate the file by its side effects only@comma{} as in the following example: @example @@ -20324,27 +20488,27 @@ following example: [[file:org-mode-unicorn.svg]] @end example -If @samp{:file} header argument is omitted, interpret source block result +If @samp{:file} header argument is omitted@comma{} interpret source block result as the file path. @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 +Results enclosed in a @samp{BEGIN_SRC org} block. For comma-escape@comma{} +either @kbd{@key{TAB}} in the block@comma{} 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 +block. Languages supported: Emacs Lisp@comma{} Python@comma{} and Ruby. Usage example: @samp{:results value pp}. @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., +appending strings to @samp{#+BEGIN_} and @samp{#+END_}@comma{} except if the value is +@samp{nil} or @samp{no}. If no string is specified@comma{} 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.@comma{} @example #+BEGIN_SRC emacs-lisp :results html :wrap EXPORT markdown @@ -20369,17 +20533,17 @@ Default. Insert results in the Org buffer. Remove previous results. Usage example: @samp{:results output replace}. @item @samp{silent} -Do not insert results in the Org mode buffer, but echo them in the +Do not insert results in the Org mode buffer@comma{} but echo them in the minibuffer. Usage example: @samp{:results output silent}. @item @samp{none} -Compute results, but do not do anything with them. No inserting in +Compute results@comma{} but do not do anything with them. No inserting in the Org mode buffer nor echo them in the minibuffer. The results can still be used when referenced from another code block. Usage example: @samp{:results none}. @item @samp{discard} -Ignore the results completely. This option is similar to @samp{none}, +Ignore the results completely. This option is similar to @samp{none}@comma{} but no processing is performed on the return value. Calling the code block programmatically (see @ref{How to evaluate source code}) or by reference (see @ref{Passing arguments} and @ref{Noweb Reference Syntax}) will @@ -20402,10 +20566,10 @@ Does not remove previous results. Usage example: @samp{:results output @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 +evaluation. When @samp{post} has any value@comma{} 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 +available to other code blocks@comma{} or even for direct Emacs Lisp code execution. The following two examples illustrate @samp{post} header argument in @@ -20420,7 +20584,7 @@ using @samp{post}. #+END_SRC #+HEADER: :file /tmp/it.png -#+BEGIN_SRC dot :post attr_wrap(width="5cm", data=*this*) :results drawer +#+BEGIN_SRC dot :post attr_wrap(width="5cm"@comma{} data=*this*) :results drawer digraph@{ a -> b; b -> c; @@ -20467,18 +20631,18 @@ to pass data between 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 and @emph{results} for inline code blocks. For some languages, -such as ditaa, Org defaults to @emph{results} both in ordinary source +It is possible to export the @emph{code} of code blocks@comma{} the @emph{results} of +code block evaluation@comma{} @emph{both} the code and the results of code block +evaluation@comma{} or @emph{none}. Org defaults to exporting @emph{code} for most +languages and @emph{results} for inline code blocks. For some languages@comma{} +such as ditaa@comma{} Org defaults to @emph{results} both in ordinary source blocks and in inline source blocks. To export just the body of code -blocks, see @ref{Literal Examples}. To selectively export subtrees of an -Org document, see @ref{Exporting}. +blocks@comma{} see @ref{Literal Examples}. To selectively export subtrees of an +Org document@comma{} 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. +The @samp{exports} header argument specifies whether that part of the Org +file is exported to@comma{} say@comma{} HTML or @LaTeX{} formats. @table @asis @item @samp{code} @@ -20486,7 +20650,7 @@ 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 +The results of evaluation of the code are included in the exported file. Example: @samp{:exports results}. @item @samp{both} @@ -20494,18 +20658,18 @@ 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 +Neither the code nor the results of evaluation are included in the exported file. Whether the code is evaluated at all depends on other options. Example: @samp{:exports none}. @end table -If a source block is named using @samp{NAME} keyword, the same name will be -assigned to the results of evaluation. This way, fuzzy links pointing +If a source block is named using the @samp{NAME} keyword@comma{} the same name will be +assigned to the results of evaluation. This way@comma{} fuzzy links pointing to the named source blocks exported using @samp{:exports results} will remain valid and point to the results of evaluation. Results of evaluation of a named block can also be explicitly named -using a separate @samp{NAME} keyword. The name value set via @samp{NAME} +using a separate @samp{NAME} keyword. The name value set via the @samp{NAME} keyword will be preferred over the parent source block. @example @@ -20522,33 +20686,44 @@ This [[code name][link]] will point to the code block. Another [[results name][link]] will point to the results. @end example - Explicit setting of the result name may be necessary when a named code -block is exported using @samp{:exports both}. Links to such block may -arbitrarily point either to the code block or to its results when -results do not have a distinct name. +block is exported using @samp{:exports both}. Links to such a block may +point arbitrarily either to the code block or to its results when +the results do not have a distinct name. Note that all the links pointing to a source block exported using -@samp{:exports none} will be broken. This will make export process fail, +@samp{:exports none} will be broken. This will cause the export process to fail@comma{} unless broken links are allowed during export (see @ref{Export Settings}). @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. +You can prevent Org from evaluating code blocks for speed or security +reasons: + +@itemize +@item +To speed up export@comma{} use the header argument @samp{:eval never-export} +(see @ref{Evaluating Code Blocks}). +@item +For greater security@comma{} set the @code{org-export-use-babel} variable to +@code{nil}@comma{} but understand that header arguments will have no effect in +this case. +@end itemize + +If results of evaluation are not marked for export (@samp{:exports code} or +@samp{:exports none})@comma{} Org will not evaluate them@comma{} even for @samp{:eval yes}. +The only exception is when a code block uses @samp{:session} - such blocks +are evaluated according to their @samp{:eval} header argument. Turning off evaluation comes in handy when batch processing. For -example, markup languages for wikis, which have a high risk of +example@comma{} markup languages for wikis 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, +in some circumstances. So during export@comma{} to allow evaluation of just +the header arguments but not any code evaluation in the source block@comma{} set @samp{:eval never-export} (see @ref{Evaluating Code Blocks}). Org never evaluates code blocks in commented subtrees when exporting -(see @ref{Comment Lines}). On the other hand, Org does evaluate code +(see @ref{Comment Lines}). On the other hand@comma{} Org does evaluate code blocks in subtrees excluded from export (see @ref{Export Settings}). @node Extracting Source Code @@ -20560,17 +20735,17 @@ blocks in subtrees excluded from export (see @ref{Export Settings}). 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. +programming parlance@comma{} documents on creation are @emph{woven} with code and +documentation@comma{} and on export@comma{} the code is tangled for execution by +a computer. Org facilitates weaving and tangling for producing@comma{} +maintaining@comma{} sharing@comma{} 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 +When Org tangles code blocks@comma{} it expands@comma{} merges@comma{} and transforms them. +Then Org recomposes them into one or more separate files@comma{} as +configured through the options. During this tangling process@comma{} Org +expands variables in the source code@comma{} and resolves any noweb style references (see @ref{Noweb Reference Syntax}). @anchor{Header arguments} @@ -20583,7 +20758,7 @@ 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 +file is derived from the name of the Org file@comma{} and the file extension is derived from the source code language identifier. Example: @samp{:tangle yes}. @@ -20598,6 +20773,9 @@ file name as being relative to the directory of the Org file's location. Example: @samp{:tangle FILENAME}. @end table +@cindex comment trees +Additionally@comma{} code blocks inside commented subtrees (see @ref{Comment Lines}) are never exported. + @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 @@ -20616,6 +20794,14 @@ The default. Do not insert any extra comments during tangling. Wrap the code block in comments. Include links pointing back to the place in the Org file from where the code was tangled. +@findex org-store-link +@vindex org-id-link-to-org-use-id +Do note that Org will use @code{org-store-link} (@ref{Handling Links}) to +store link to code block. Such link may not be unique if the parent +heading title is a duplicate of earlier heading or changes after +tangling. We recommend setting @code{org-id-link-to-org-use-id} to t to +make sure that the link points to the correct heading. + @item @samp{yes} Kept for backward compatibility; same as @samp{link}. @@ -20628,7 +20814,7 @@ the source block. 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 +Includes @samp{link} option@comma{} expands noweb references (see @ref{Noweb Reference Syntax})@comma{} and wraps them in link comments inside the body of the code block. @end table @@ -20647,7 +20833,7 @@ Do not insert newlines to pad the tangled code blocks. @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 +files. By setting it to a string value---for example@comma{} @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. @@ -20655,30 +20841,30 @@ 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}. Permissions are given by an -octal value, which can be provided calling the @code{identity} function on -an elisp octal value. For instance, to create a read-only file one may -use @samp{:tangle-mode (identity #o444)}. To reduce the verbosity required, -a octal shorthand is defined, @samp{oXXX} (@samp{o} for octal). Using this, our +octal value@comma{} which can be provided calling the @code{identity} function on +an elisp octal value. For instance@comma{} to create a read-only file one may +use @samp{:tangle-mode (identity #o444)}. To reduce the verbosity required@comma{} +a octal shorthand is defined@comma{} @samp{oXXX} (@samp{o} for octal). Using this@comma{} our read-only example is @samp{:tangle-mode o444}. Omitting the @samp{o} prefix will -cause the argument to be interpreted as an integer, which can lead to +cause the argument to be interpreted as an integer@comma{} which can lead to unexpected results (@samp{444} is the same as @samp{o674}). -Two other shorthands are recognized, ls-style strings like -@samp{rw-r--r--}, and chmod-style permissions like @samp{g+w}. +Two other shorthands are recognized@comma{} ls-style strings like +@samp{rw-r--r--}@comma{} and chmod-style permissions like @samp{g+w}. Note that chmod-style permissions are based on -@code{org-babel-tangle-default-file-mode}, which is @samp{#o644} by default. +@code{org-babel-tangle-default-file-mode}@comma{} which is @samp{#o644} by default. -When @samp{:tangle-mode} and @samp{:shebang} are both specified, the give +When @samp{:tangle-mode} and @samp{:shebang} are both specified@comma{} the give @samp{:tangle-mode} will override the permissions from @samp{:shebang}. When multiple source code blocks tangle to a single file with conflicting -@samp{:tangle-mode} header arguments, Org's behavior is undefined. +@samp{:tangle-mode} header arguments@comma{} 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 +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 +Some of these expansions may cause premature assignment@comma{} 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. @@ -20719,12 +20905,12 @@ code block expansion. @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. +@code{org-babel-tangle}@comma{} making it suitable for post-processing@comma{} +compilation@comma{} and evaluation of code in the tangled files. @item @code{org-babel-tangle-finished-hook} @vindex org-babel-tangle-finished-hook -This hook is run after post-tangle hooks, in the original buffer. +This hook is run after post-tangle hooks@comma{} in the original buffer. @end table @anchor{Jumping between code and Org} @@ -20732,8 +20918,8 @@ This hook is run after post-tangle hooks, in the original buffer. @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 +But for tangled files@comma{} we want to link back to the Org file@comma{} not to +the tangled source file. To make this extra jump@comma{} Org uses @code{org-babel-tangle-jump-to-org} function with two additional source code block header arguments: @@ -20741,7 +20927,7 @@ code block header arguments: @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 +Set @samp{comments} to @samp{link}@comma{} which makes Org insert links to the Org file. @end enumerate @@ -20753,15 +20939,15 @@ file. @cindex code block, languages Code blocks in dozens of languages are supported. See Worg website -for @uref{https://orgmode.org/worg/org-contrib/babel/languages/index.html, language specific documentation}. +for @uref{https://orgmode.org/worg/org-contrib/babel/languages/index.html, language-specific documentation}. @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 +By default@comma{} only Emacs Lisp is enabled for evaluation. To enable or +disable other languages@comma{} customize the @code{org-babel-load-languages} +variable either through the Emacs customization interface@comma{} or by adding code to the init file as shown next. -In this example, evaluation is disabled for Emacs Lisp, and enabled +In this example@comma{} evaluation is disabled for Emacs Lisp@comma{} and enabled for R@. @lisp @@ -20772,7 +20958,7 @@ for R@. @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, +enables languages when loaded with @code{require} statement. For example@comma{} the following enables execution of Clojure code blocks: @lisp @@ -20787,7 +20973,7 @@ the following enables execution of Clojure code blocks: @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, +major mode edit buffer containing the body of the source code block@comma{} ready for any edits. Use @kbd{C-c '} again to close the buffer and return to the Org buffer. @@ -20800,22 +20986,21 @@ 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 +While editing the source code in the major mode@comma{} the Org Src minor mode remains active. It provides these customization variables as -described below. For even more variables, look in the customization +described below. For even more variables@comma{} 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{-mode} exists, where +If an Emacs major mode named @code{-mode} exists@comma{} where @var{} is the language identifier from code block's -header line, then the edit buffer uses that major mode. Use this +header line@comma{} then the edit buffer uses that major mode. If the +major mode does not exist@comma{} or the language identifier is omitted@comma{} +then the edit buffer falls back to Fundamental mode. Use this variable to arbitrarily map language identifiers to major modes. -When language identifier is omitted in the src block, Org mode's -behavior is undefined. - @item @code{org-src-window-setup} @vindex org-src-window-setup For specifying Emacs window arrangement when the new edit buffer is @@ -20825,15 +21010,15 @@ created. @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 +applies during export or tangling@comma{} and depending on the context@comma{} may +alter leading spaces and tabs. When non-@code{nil}@comma{} 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. +export or tangling@comma{} which is very useful for white-space sensitive +languages@comma{} 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. +When @code{nil}@comma{} Org returns to the edit buffer without further prompts. The default prompts for a confirmation. @end table @@ -20846,8 +21031,8 @@ fontification follows the major mode used to edit the code block (see @code{org-src-lang-modes} above). 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 +languages@comma{} customize @code{org-src-block-faces}. The following example +shades the background of regular blocks@comma{} and colors source blocks only for Python and Emacs Lisp languages. @lisp @@ -20868,36 +21053,35 @@ for Python and Emacs Lisp languages. @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 +Source code blocks can include references to other source code blocks@comma{} +using a noweb@footnote{ For noweb literate programming details@comma{} see @uref{https://www.cs.tufts.edu/~nr/noweb/}.} style syntax: @example <> @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 +source code block@comma{} 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 +the block or blocks being referenced@comma{} or@comma{} in the case of a single +source code block named with @samp{NAME}@comma{} 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. +references. Expansions occur when source code blocks are evaluated@comma{} +tangled@comma{} 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. +code when evaluating@comma{} tangling@comma{} or exporting. @item @samp{yes} Expansion of noweb syntax references in the body of the code block -when evaluating, tangling, or exporting. +when evaluating@comma{} tangling@comma{} or exporting. @item @samp{tangle} Expansion of noweb syntax references in the body of the code block @@ -20922,13 +21106,13 @@ 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, +In the most simple case@comma{} the contents of a single source block is +inserted within other blocks. Thus@comma{} in following example@comma{} @example #+NAME: initialization #+BEGIN_SRC emacs-lisp - (setq sentence "Never a foot too far, even.") + (setq sentence "Never a foot too far@comma{} even.") #+END_SRC #+BEGIN_SRC emacs-lisp :noweb yes @@ -20942,14 +21126,14 @@ the second code block is expanded as @example #+BEGIN_SRC emacs-lisp :noweb yes - (setq sentence "Never a foot too far, even.") + (setq sentence "Never a foot too far@comma{} even.") (reverse sentence) #+END_SRC @end example Note that noweb expansion does not automatically carry over @samp{:var} -header arguments@footnote{In the following example, attempting to evaluate -the second code block will give an error, because the variables +header arguments@footnote{In the following example@comma{} attempting to evaluate +the second code block will give an error@comma{} because the variables defined in the first code block will not be defined in the second block. @example @@ -20973,8 +21157,8 @@ values. }. You may also include the contents of multiple blocks sharing a common -@samp{noweb-ref} header argument, which can be set at the file, subtree, -or code block level. In the example Org file shown next, the body of +@samp{noweb-ref} header argument@comma{} which can be set at the file@comma{} subtree@comma{} +or code block level. In the example Org file shown next@comma{} the body of the source code in each block is extracted for concatenation to a pure code file when tangled. @@ -21005,20 +21189,19 @@ code file when tangled. @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. +use a different separator@comma{} edit the @samp{noweb-sep} header argument. -Alternatively, Org can include the results of evaluation of a single +Alternatively@comma{} Org can include the results of evaluation of a single code block rather than its body [@footnote{The reference is evaluated with -point at the referenced block, using its header arguments (including -inherited)}. Evaluation occurs when parentheses, possibly including -arguments, are appended to the code block name, as shown below. +point at the referenced block@comma{} using its header arguments (including +inherited)}. Evaluation occurs when parentheses@comma{} possibly including +arguments@comma{} are appended to the code block name@comma{} as shown below. @example <> @end example - -Note that in this case, a code block name set by @samp{NAME} keyword is +Note that in this case@comma{} 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. @@ -21049,8 +21232,7 @@ expands to: print(num*10) @end example - -Below, a similar noweb style reference is used, but with parentheses, +Below@comma{} a similar noweb style reference is used@comma{} but with parentheses@comma{} while setting a variable @samp{num} to 10: @example @@ -21061,17 +21243,16 @@ while setting a variable @samp{num} to 10: @noindent Note that the expansion now contains the results of the code block -@samp{some-code}, not the code block itself: +@samp{some-code}@comma{} 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{<>} noweb reference appears behind the -SQL comment syntax, each line of the expanded noweb reference is +SQL comment syntax@comma{} each line of the expanded noweb reference is commented. With: @example @@ -21102,7 +21283,7 @@ expands to: @end example Since this change does not affect noweb replacement text without -newlines in them, inline noweb references are acceptable. +newlines in them@comma{} inline noweb references are acceptable. This feature can also be used for management of indentation in exported code snippets. With: @@ -21142,7 +21323,7 @@ else: @end example This prefix behavior can be turned off in a block by setting the -@samp{noweb-prefix} header argument to @samp{no}, as in: +@samp{noweb-prefix} header argument to @samp{no}@comma{} as in: @example #+BEGIN_SRC elisp :noweb-prefix no @@ -21158,7 +21339,7 @@ which expands to: multi-line body of example") @end example -When in doubt about the outcome of a source code block expansion, you +When in doubt about the outcome of a source code block expansion@comma{} you can preview the results with the following command: @table @asis @@ -21178,15 +21359,15 @@ arguments and pop open the results in a preview buffer. @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 +a function library@comma{} 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}. +remote code block evaluation syntax@comma{} 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}. +For any user to add code to the library@comma{} first save the code in +regular code blocks of an Org file@comma{} and then load the Org file with +@code{org-babel-lob-ingest}@comma{} which is bound to @kbd{C-c C-v i}. @node Key bindings and Useful Functions @section Key bindings and Useful Functions @@ -21342,9 +21523,9 @@ Active key bindings in Org mode buffer: @cindex code block, batch execution @cindex source code, batch execution -Org mode features, including working with source code facilities can +Org mode features@comma{} 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 +for batch processing@comma{} running automated system tasks@comma{} and expanding Org mode's usefulness. The sample script shows batch processing of multiple files using @@ -21386,6 +21567,7 @@ emacs -Q --batch --eval " * Org Crypt:: Encrypting Org files. * Org Mobile:: Viewing and capture on a mobile device. * Drag and Drop & @code{yank-media}:: Dropping and pasting files and images +* Repeating commands:: Repeating navigation commands @end menu @node Completion @@ -21405,11 +21587,11 @@ emacs -Q --batch --eval " @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 +Org has in-buffer completions. Unlike minibuffer completions@comma{} which +are useful for quick command interactions@comma{} 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 +Depending on the context and the keys@comma{} 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. @@ -21422,40 +21604,40 @@ Complete word at point. @itemize @item -At the beginning of an empty headline, complete TODO keywords. +At the beginning of an empty headline@comma{} complete TODO keywords. @item -After @samp{\}, complete @TeX{} symbols supported by the exporter. +After @samp{\}@comma{} 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 +After @samp{:} in a headline@comma{} complete tags. Org deduces the list of +tags from the @samp{TAGS} in-buffer option (see @ref{Setting Tags})@comma{} the +variable @code{org-tag-alist}@comma{} or from all tags used in the current buffer. @item -After @samp{:} and not in a headline, complete property keys. The list +After @samp{:} and not in a headline@comma{} 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}). +After @samp{[[}@comma{} complete link abbreviations (see @ref{Link Abbreviations}). @item -After @samp{[[*}, complete headlines in the current buffer so that they +After @samp{[[*}@comma{} 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, +After @samp{#+}@comma{} complete the special keywords like @samp{TYP_TODO} or +file-specific @samp{OPTIONS}. After option keyword is complete@comma{} pressing @kbd{M-@key{TAB}} again inserts example settings for this keyword. @item -After @samp{STARTUP} keyword, complete startup items. +After @samp{STARTUP} keyword@comma{} complete startup items. @item -When point is anywhere else, complete dictionary words using +When point is anywhere else@comma{} complete dictionary words using Ispell. @end itemize @end table @@ -21466,24 +21648,24 @@ Ispell. @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 +With just a few keystrokes@comma{} it is possible to insert empty structural +blocks@comma{} such as @samp{#+BEGIN_SRC} @dots{} @samp{#+END_SRC}@comma{} or to wrap existing text in such a block. @table @asis -@item @kbd{C-c C-,} (@code{org-insert-structure-template}) +@item @kbd{C-c C-@comma{}} (@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. +Prompt for a type of block structure@comma{} and insert the block at point. +If the region is active@comma{} it is wrapped in the block. First prompts +the user for keys@comma{} which are used to look up a structure type from +the variable below. If the key is @kbd{@key{TAB}}@comma{} @kbd{@key{RET}}@comma{} +or @kbd{@key{SPC}}@comma{} 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 +@code{org-structure-template-alist}@comma{} see the docstring for adding or changing values. @cindex Tempo @@ -21492,9 +21674,9 @@ changing values. @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 +example@comma{} @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 +init file@footnote{ For more information@comma{} please refer to the commentary section in @samp{org-tempo.el}.}. @multitable @columnfractions 0.1 0.9 @@ -21527,25 +21709,25 @@ section in @samp{org-tempo.el}.}. 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 +modifier key@comma{} Speed Keys can speed navigation or execute custom +commands. Besides faster navigation@comma{} 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 +By default@comma{} Org has Speed Keys disabled. To activate Speed Keys@comma{} 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. +trigger a Speed Key@comma{} point must be at the beginning of an Org +headline@comma{} before any of the stars. @vindex org-speed-commands @findex org-speed-command-help Org comes with a pre-defined list of Speed Keys. To add or modify -Speed Keys, customize the option @code{org-speed-commands}. 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, +Speed Keys@comma{} customize the option @code{org-speed-commands}. For more +details@comma{} see the variable's docstring. With Speed Keys activated@comma{} +@kbd{M-x org-speed-command-help}@comma{} or @kbd{?} when point is at the +beginning of an Org headline@comma{} shows currently active Speed Keys@comma{} including the user-defined ones. @node Clean View @@ -21556,11 +21738,11 @@ including the user-defined ones. @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: +Org's outline@comma{} with its stars and lack of indents@comma{} can look cluttered +in short documents. For @emph{book-like} long documents@comma{} the effect is not +as noticeable. Org provides an alternate stars and indentation +scheme@comma{} 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 @@ -21572,8 +21754,8 @@ 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 +Org can achieve this in two ways@comma{} (1) by just displaying the buffer in +this way without changing it@comma{} or (2) by actually indenting every line in the desired amount with hard spaces and hiding leading stars. @menu @@ -21586,8 +21768,8 @@ in the desired amount with hard spaces and hiding leading stars. @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 +To display the buffer in the indented view@comma{} activate Org Indent minor +mode@comma{} 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 @@ -21595,22 +21777,22 @@ 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 +To make more horizontal space@comma{} 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 +By default@comma{} 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 +only one star on each headline is visible@comma{} 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 +default behavior@comma{} 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, +To globally turn on Org Indent mode for all files@comma{} customize the +variable @code{org-startup-indented}. To control it for individual files@comma{} use @samp{STARTUP} keyword as follows: @example @@ -21621,12 +21803,12 @@ use @samp{STARTUP} keyword as follows: @node Hard indentation @subsection Hard indentation -It is possible to use hard spaces to achieve the indentation instead, +It is possible to use hard spaces to achieve the indentation instead@comma{} 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 +Emacs@footnote{This works@comma{} but requires extra effort. Org Indent mode is +more convenient for most applications.}. With Org's support@comma{} 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 +@code{org-adapt-indentation} can also be set to @samp{'headline-data}@comma{} in which case only data lines below the headline will be indented.}: @lisp @@ -21638,7 +21820,7 @@ case only data lines below the headline will be indented.}: @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 +The first setting modifies paragraph filling@comma{} line wrapping@comma{} and structure editing commands to preserving or adapting the indentation as appropriate. @@ -21646,7 +21828,7 @@ as appropriate. @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 +face @code{org-hide} to them. For per-file preference@comma{} use these file @samp{STARTUP} options: @example @@ -21656,8 +21838,8 @@ face @code{org-hide} to them. For per-file preference, use these file @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, +The third setting makes Org use only odd levels@comma{} 1@comma{} 3@comma{} 5@comma{} @dots{}@comma{} in +the outline to create more indentation. On a per-file level@comma{} control this with: @example @@ -21665,7 +21847,7 @@ control this with: #+STARTUP: oddeven @end example -To convert a file between single and double stars layouts, use +To convert a file between single and double stars layouts@comma{} use @kbd{M-x org-convert-to-odd-levels} and @kbd{M-x org-convert-to-oddeven-levels}. @end table @@ -21673,16 +21855,16 @@ To convert a file between single and double stars layouts, use @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 +When in an Org buffer and the region is active@comma{} some commands will +apply to all the subtrees in the active region. For example@comma{} 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. +this@comma{} set the option @code{org-loop-over-headlines-in-active-region} to +non-@code{t}@comma{} 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 +option of the agenda buffer@comma{} 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 @@ -21694,7 +21876,7 @@ options for more details. @cindex Org Num mode @cindex number headlines -The Org Num minor mode, toggled with @kbd{M-x org-num-mode}, +The Org Num minor mode@comma{} toggled with @kbd{M-x org-num-mode}@comma{} displays outline numbering on top of headlines. It also updates it automatically upon changes to the structure of the document. @@ -21702,14 +21884,14 @@ automatically upon changes to the structure of the document. @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. +By default@comma{} all headlines are numbered. You can limit numbering to +specific headlines according to their level@comma{} tags@comma{} @samp{COMMENT} keyword@comma{} +or @samp{UNNUMBERED} property. Set @code{org-num-max-level}@comma{} +@code{org-num-skip-tags}@comma{} @code{org-num-skip-commented}@comma{} +@code{org-num-skip-unnumbered}@comma{} 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 +If @code{org-num-skip-footnotes} is non-@code{nil}@comma{} footnotes sections (see @ref{Creating Footnotes}) are not numbered either. @vindex org-num-face @@ -21719,7 +21901,7 @@ You can control how the numbering is displayed by setting @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 +option @code{org-startup-numerated} to @samp{t}@comma{} or locally on a file by using @samp{#+startup: num}. @node The Very Busy @kbd{C-c C-c} Key @@ -21729,65 +21911,65 @@ option @code{org-startup-numerated} to @samp{t}, or locally on a file by using @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 +the context. It is probably the most over-worked@comma{} multipurpose key combination in Org. Its uses are well documented throughout this -manual, but here is a consolidated list for easy reference. +manual@comma{} but here is a consolidated list for easy reference. @itemize @item -If column view (see @ref{Column View}) is on, exit column view. +If column view (see @ref{Column View}) is on@comma{} 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. +tree@comma{} or from clock display@comma{} remove such highlights. @item -If point is in one of the special @samp{KEYWORD} lines, scan the buffer +If point is in one of the special @samp{KEYWORD} lines@comma{} 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 +cache used to temporarily store the contents of URLs used as values for keywords like @samp{SETUPFILE}. @item -If point is inside a table, realign the table. +If point is inside a table@comma{} realign the table. @item -If point is on a @samp{TBLFM} keyword, re-apply the formulas to the +If point is on a @samp{TBLFM} keyword@comma{} 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 +If the current buffer is a capture buffer@comma{} close the note and file +it. With a prefix argument@comma{} also jump to the target location after saving the note. @item -If point is on a @samp{<<>>}, update radio targets and +If point is on a @samp{<<>>}@comma{} 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. +drawer@comma{} offer property commands. @item -If point is at a footnote reference, go to the corresponding -definition, and @emph{vice versa}. +If point is at a footnote reference@comma{} go to the corresponding +definition@comma{} and @emph{vice versa}. @item -If point is on a statistics cookie, update it. +If point is on a statistics cookie@comma{} update it. @item -If point is in a plain list item with a checkbox, toggle the status +If point is in a plain list item with a checkbox@comma{} toggle the status of the checkbox. @item -If point is on a numbered item in a plain list, renumber the ordered +If point is on a numbered item in a plain list@comma{} renumber the ordered list. @item -If point is on the @samp{#+BEGIN} line of a dynamic block, the block is +If point is on the @samp{#+BEGIN} line of a dynamic block@comma{} the block is updated. @item -If point is at a timestamp, fix the day name in the timestamp. +If point is at a timestamp@comma{} fix the day name in the timestamp. @end itemize @node In-buffer Settings @@ -21796,8 +21978,8 @@ If point is at a timestamp, fix the day name in the timestamp. @cindex in-buffer settings @cindex special keywords -In-buffer settings start with @samp{#+}, followed by a keyword, a colon, -one or more spaces, and then a word for each setting. Org accepts +In-buffer settings start with @samp{#+}@comma{} followed by a keyword@comma{} a colon@comma{} +one or more spaces@comma{} 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. @@ -21816,7 +21998,7 @@ 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 +Sets the category of the agenda file@comma{} which applies to the entire document. @item @samp{#+COLUMNS: %25ITEM ...} @@ -21836,14 +22018,14 @@ 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 +Set tags that all entries in the file inherit from@comma{} 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 +@samp{LINK} keywords for more@comma{} see @ref{Link Abbreviations}. The corresponding variable is @code{org-link-abbrev-alist}. @item @samp{#+PRIORITIES: highest lowest default} @@ -21852,13 +22034,13 @@ corresponding variable is @code{org-link-abbrev-alist}. @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 +three must be either letters A--Z or numbers 0--64. 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 +current buffer@comma{} most useful for specifying the allowed values of a property. @item @samp{#+SETUPFILE: file} @@ -21866,9 +22048,9 @@ a property. 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 when Org opens the main file. If URL is -specified, the contents are downloaded and stored in a temporary +specified@comma{} the contents are downloaded and stored in a temporary file cache. @kbd{C-c C-c} on the settings line re-parses and -re-loads the file, and also resets the temporary file cache. +re-loads the file@comma{} and also resets the temporary file cache. Org also parses and loads @emph{in-buffer settings} from the setup file during normal exporting process. Org parses the @emph{in-buffer @@ -21910,8 +22092,8 @@ settings is @code{org-startup-folded} with a default value of @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, +@code{wrap-prefix} property@comma{} such that Visual Line mode (or purely +setting @code{word-wrap}) wraps long lines@comma{} including headlines@comma{} correctly indented.}. @multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @@ -21950,9 +22132,9 @@ 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 +When visiting a file@comma{} inline images can be automatically displayed. The corresponding variable is -@code{org-startup-with-inline-images}, with a default value @code{nil} to +@code{org-startup-with-inline-images}@comma{} with a default value @code{nil} to avoid delays when visiting a file. @multitable {aaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @@ -21964,9 +22146,9 @@ avoid delays when visiting a file. @vindex org-link-descriptive Bracket links in Org buffers are displayed hiding the link path and -brackets. For example, @samp{[[https://orgmode.org][Org Website]]} is, -by default, displayed as ``Org Website'', hiding the link itself and -just displaying its description. Alternatively, the links can be +brackets. For example@comma{} @samp{[[https://orgmode.org][Org Website]]} is@comma{} +by default@comma{} displayed as ``Org Website''@comma{} hiding the link itself and +just displaying its description. Alternatively@comma{} the links can be displayed in full. The corresponding variable is @code{org-link-descriptive}. @@ -21982,7 +22164,7 @@ displayed in full. The corresponding variable is @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}). +@code{org-log-done}@comma{} @code{org-log-note-clock-out}@comma{} and @code{org-log-repeat}). @multitable {aaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{logdone} @@ -22024,9 +22206,9 @@ intervals can be configured using these options (see variables @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 +headings@comma{} 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} +@code{org-odd-levels-only}@comma{} both with a default setting @code{nil} (meaning @samp{showstars} and @samp{oddeven}). @multitable {aaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @@ -22039,7 +22221,7 @@ variables are @code{org-hide-leading-stars} and @item @samp{noindent} @tab No virtual indentation according to outline level. @item @samp{odd} -@tab Allow only odd outline levels (1, 3, @dots{}). +@tab Allow only odd outline levels (1@comma{} 3@comma{} @dots{}). @item @samp{oddeven} @tab Allow all outline levels. @end multitable @@ -22049,7 +22231,7 @@ variables are @code{org-hide-leading-stars} and @vindex org-time-stamp-custom-formats To turn on custom format overlays over timestamps (variables @code{org-display-custom-times} and -@code{org-timestamp-custom-formats}), use: +@code{org-timestamp-custom-formats})@comma{} use: @multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{customtime} @@ -22070,9 +22252,9 @@ The following options influence the table spreadsheet (variable @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}. +To influence footnote settings@comma{} use the following keywords. The +corresponding variables are @code{org-footnote-define-inline}@comma{} +@code{org-footnote-auto-label}@comma{} and @code{org-footnote-auto-adjust}. @multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{fninline} @@ -22080,7 +22262,7 @@ corresponding variables are @code{org-footnote-define-inline}, @item @samp{fnnoinline} @tab Define footnotes in separate section. @item @samp{fnlocal} -@tab Define footnotes near first reference, but not inline. +@tab Define footnotes near first reference@comma{} but not inline. @item @samp{fnprompt} @tab Prompt for footnote labels. @item @samp{fnauto} @@ -22097,7 +22279,7 @@ corresponding variables are @code{org-footnote-define-inline}, @vindex org-hide-block-startup @vindex org-hide-drawer-startup -To hide blocks or drawers on startup, use these keywords. The +To hide blocks or drawers on startup@comma{} use these keywords. The corresponding variables are @code{org-hide-block-startup} and @code{org-hide-drawer-startup}. @@ -22130,10 +22312,10 @@ variable @code{org-pretty-entities} and the keywords @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 +in this file@comma{} and (potentially) the corresponding @emph{fast tag selection} keys. The corresponding variable is @code{org-tag-alist}. -@item @samp{#+TODO:}, @samp{#+SEQ_TODO:}, @samp{#+TYP_TODO:} +@item @samp{#+TODO:}@comma{} @samp{#+SEQ_TODO:}@comma{} @samp{#+TYP_TODO:} @cindex @samp{SEQ_TODO}, keyword @cindex @samp{TODO}, keyword @cindex @samp{TYP_TODO}, keyword @@ -22148,37 +22330,36 @@ current file. The corresponding variable is @code{org-todo-keywords}. @cindex regular expressions syntax @cindex regular expressions, in searches -Org, as an Emacs mode, makes use of Elisp regular expressions for -searching, matching and filtering. Elisp regular expressions have a -somewhat different syntax then some common standards. Most notably, +Org@comma{} as an Emacs mode@comma{} makes use of Elisp regular expressions for +searching@comma{} matching and filtering. Elisp regular expressions have a +somewhat different syntax then some common standards. Most notably@comma{} alternation is indicated using @samp{\|} and matching groups are denoted by @samp{\(...\)}. For example the string @samp{home\|work} matches either @samp{home} or @samp{work}. -For more information, see @ref{Regexps,Regular Expressions in Emacs,,emacs,}. +For more information@comma{} see @ref{Regexps,Regular Expressions in Emacs,,emacs,}. @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/org-syntax.html, a draft on Worg}, initially written by Nicolas Goaziou. -It defines Org's core internal concepts such as ``headlines'', -``sections'', ``affiliated keywords'', ``(greater) elements'' and ``objects''. +available as @uref{https://orgmode.org/worg/org-syntax.html, a draft on Worg}@comma{} initially written by Nicolas Goaziou. +It defines Org's core internal concepts such as ``headlines''@comma{} +``sections''@comma{} ``affiliated keywords''@comma{} ``(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 +To explore the abstract structure of an Org buffer@comma{} run this in a buffer: @example M-: (org-element-parse-buffer) @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 +stored in this list. Most interactive commands---e.g.@comma{} for structure editing---also rely on the syntactic meaning of the surrounding context. @@ -22191,15 +22372,14 @@ You can probe the syntax of your documents with the command M-x org-lint @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 +their location in a dedicated buffer@comma{} along with a description and +a ``trust level''@comma{} since false-positive are possible. From there@comma{} you can operate on the reports with the following keys: @multitable @columnfractions 0.22 0.78 -@item @kbd{C-j}, @kbd{@key{TAB}} +@item @kbd{C-j}@comma{} @kbd{@key{TAB}} @tab Display the offending line @item @kbd{@key{RET}} @tab Move point to the offending line @@ -22222,7 +22402,7 @@ can operate on the reports with the following keys: @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, +of the Org manual depending on the syntax at point. For example@comma{} using it on a headline displays ``Document Structure'' section. @kbd{q} closes the Info window. @@ -22232,11 +22412,11 @@ using it on a headline displays ``Document Structure'' section. @cindex escape character @cindex zero width space -You may sometimes want to write text that looks like Org syntax, but +You may sometimes want to write text that looks like Org syntax@comma{} 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 +character in some situations@comma{} i.e.@comma{} a backslash in macros (see @ref{Macro Replacement}) and links (see @ref{Link Format})@comma{} or a comma in source and +example blocks (see @ref{Literal Examples}). In the general case@comma{} however@comma{} +we suggest using the zero width space. You can insert one with any of the following: @example @@ -22244,29 +22424,27 @@ C-x 8 zero width space C-x 8 200B @end example - -For example, in order to write @samp{[[1,2]]} as-is in your document, you +For example@comma{} in order to write @samp{[[1@comma{}2]]} as-is in your document@comma{} you may write instead @example -[X[1,2]] +[X[1@comma{}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 +Unlike plain text@comma{} running code comes with risk. Each source code +block@comma{} in terms of risk@comma{} 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 +For users who do not run code blocks or write code regularly@comma{} Org's +default settings should suffice. However@comma{} 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 +automatic execution of code blocks@comma{} here are some details about code evaluation. Org evaluates code in the following circumstances: @@ -22280,17 +22458,17 @@ 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 +When @code{t}@comma{} Org prompts the user for confirmation before executing +each code block. When @code{nil}@comma{} 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 +a custom function@comma{} 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 +The custom function must return either a @code{t} or @code{nil}@comma{} 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 +For example@comma{} here is how to execute ditaa code blocks without prompting: @lisp @@ -22301,7 +22479,7 @@ prompting: @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 +@ref{External Links}). Because such code is not visible@comma{} these links have a potential risk. Org therefore prompts the user when it encounters such links. The customization variables are: @@ -22315,7 +22493,7 @@ Function that prompts the user before executing an Emacs Lisp link. @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. +either by the Calc interpreter@comma{} or by the Emacs Lisp interpreter. @end table @node Interaction @@ -22347,9 +22525,9 @@ embedded calculations. See @ref{Embedded Mode,GNU Emacs Calc Manual,,calc,}. @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 +use calculation suffixes for units@comma{} such as @samp{M} for @samp{Mega}. For a +standard collection of such constants@comma{} install the @samp{constants} +package. Install version 2.0 of this package@comma{} available at @uref{https://github.com/cdominik/constants-for-Emacs}. Org checks if the function @code{constants-get} has been autoloaded. Installation instructions are in the file @samp{constants.el}. @@ -22378,7 +22556,7 @@ depth using the option @code{org-imenu-depth}. Org activates Imenu support only in the buffers opened after loading Imenu library. To enable Imenu support in an already opened Org -buffer, reload Org. +buffer@comma{} reload Org. @item @samp{speedbar.el} by Eric@tie{}M@.@tie{}Ludlam @cindex @file{speedbar.el} @@ -22393,12 +22571,12 @@ a subtree. @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 +Complex ASCII tables with automatic line wrapping@comma{} column- and +row-spanning@comma{} 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 +buffer@comma{} much like Org's code blocks. Because of interference with +other Org mode functionality@comma{} Takaaki Ota tables cannot be edited directly in the Org buffer. @table @asis @@ -22411,7 +22589,7 @@ 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, +Insert a @samp{table.el} table. If there is already a table at point@comma{} 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 @@ -22424,15 +22602,15 @@ possible. @cindex shift-selection @vindex org-support-shift-select -In Emacs, shift-selection combines motions of point with shift key to +In Emacs@comma{} 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-} commands to change timestamps, -TODO keywords, priorities, and item bullet types, etc. Since -@kbd{S-} commands outside of specific contexts do not do -anything, Org offers the variable @code{org-support-shift-select} for +with Org's use of @kbd{S-} commands to change timestamps@comma{} +TODO keywords@comma{} priorities@comma{} and item bullet types@comma{} etc. Since +@kbd{S-} commands outside specific contexts do not do +anything@comma{} 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 +available outside the special contexts where special commands +apply@comma{} and (ii) extending an existing active region even if point moves across a special context. @table @asis @@ -22440,9 +22618,9 @@ moves across a special context. @cindex @file{cua.el} @vindex org-replace-disputed-keys Org key bindings conflict with @kbd{S-} 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 +CUA mode. For Org to relinquish these bindings to CUA mode@comma{} +configure the variable @code{org-replace-disputed-keys}. When set@comma{} Org +moves the following key bindings in Org files@comma{} and in the agenda buffer---but not during date selection. @multitable @columnfractions 0.4 0.4 @@ -22455,8 +22633,8 @@ buffer---but not during date selection. @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 +Yes@comma{} these are unfortunately more difficult to remember. If you +want to have other replacement keys@comma{} look at the variable @code{org-disputed-keys}. @item @samp{ecomplete.el} by Lars Magne Ingebrigtsen @@ -22466,15 +22644,15 @@ 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}), +turn on Orgtbl mode in message buffers (see @ref{Orgtbl Mode})@comma{} 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 +Org mode tries to do the right thing when filling paragraphs@comma{} 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 +@samp{filladapt.el} and Org mode@comma{} so a safe thing to do is to disable filladapt like this: @lisp @@ -22487,7 +22665,7 @@ filladapt like this: 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 +find another key for this command@comma{} or override the key in @code{viper-vi-global-user-map} with @lisp @@ -22497,10 +22675,10 @@ find another key for this command, or override the key in @item @samp{windmove.el} by Hovav Shacham @cindex @file{windmove.el} -This package also uses the @kbd{S-} keys, so everything +This package also uses the @kbd{S-} keys@comma{} 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-}, +mode does not have special functionality on @kbd{S-}@comma{} add this to your configuration: @lisp @@ -22515,7 +22693,7 @@ add this to your configuration: @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: +following code fixes this problem: @lisp (add-hook 'org-mode-hook @@ -22525,7 +22703,7 @@ following code fixed this problem: @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 +If the above code does not fix the conflict@comma{} start by defining the following function: @lisp @@ -22533,7 +22711,7 @@ the following function: (let ((yas/fallback-behavior 'return-nil)) (yas/expand))) @end lisp -Then, tell Org mode to use that function: +Then@comma{} tell Org mode to use that function: @lisp (add-hook 'org-mode-hook @@ -22554,7 +22732,7 @@ 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 +further based on their usage needs. For example@comma{} the normal @kbd{S-} for editing timestamp might be better with @kbd{C-c .} chord. @@ -22635,7 +22813,7 @@ further based on their usage needs. For example, the normal @tab @kbd{C-c C-x @key{RIGHT}} @tab @tab -@item @kbd{C-c C-,} +@item @kbd{C-c C-@comma{}} @tab @kbd{C-c C-x s} @tab @tab @@ -22649,7 +22827,7 @@ further based on their usage needs. For example, the normal 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 +For example@comma{} 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 @@ -22657,24 +22835,23 @@ browsing. @cindex Org protocol, set-up @cindex Installing Org protocol -In order to use Org protocol from an application, you need to register +In order to use Org protocol from an application@comma{} 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 +passed to Emacs through the @samp{emacsclient} command@comma{} so you also need to +ensure an Emacs server is running. More precisely@comma{} 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 +Org protocol comes with three predefined protocols@comma{} detailed in the following sections. Configure @code{org-protocol-protocol-alist} to define your own. @@ -22690,15 +22867,14 @@ your own. @cindex store-link protocol @cindex protocol, store-link -Using the @code{store-link} handler, you can copy links, to that they can +Using the @code{store-link} handler@comma{} you can copy links@comma{} to that they can be inserted using @kbd{M-x org-insert-link} or yanking. More -precisely, the command +precisely@comma{} the command @example emacsclient "org-protocol://store-link?url=URL&title=TITLE" @end example - @noindent stores the following link: @@ -22706,17 +22882,16 @@ stores the following link: [[URL][TITLE]] @end example - -In addition, @var{URL} is pushed on the kill-ring for yanking. +In addition@comma{} @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. +slashes@comma{} 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}: +To use this feature from a browser@comma{} add a bookmark with an arbitrary +name@comma{} e.g.@comma{} @samp{Org: store-link} and enter this as @emph{Location}: @example javascript:location.href='org-protocol://store-link?' + - new URLSearchParams(@{url:location.href, title:document.title@});void(0); + new URLSearchParams(@{url:location.href@comma{} title:document.title@});void(0); @end example Title is an optional parameter. Another expression was recommended earlier: @@ -22734,22 +22909,21 @@ The latter form is compatible with older Org versions from 9.0 to 9.4. @cindex capture protocol @cindex protocol, capture -Activating the ``capture'' handler pops up a @samp{Capture} buffer in Emacs, -using acapture template. +Activating the ``capture'' handler pops up a @samp{Capture} buffer in Emacs@comma{} +using a capture 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}: +To use this feature@comma{} add a bookmark with an arbitrary name@comma{} e.g.@comma{} +@samp{Org: capture}@comma{} and enter this as @samp{Location}: @example javascript:location.href='org-protocol://capture?' + new URLSearchParams(@{ - template: 'x', url: window.location.href, - title: document.title, body: window.getSelection()@}); + template: 'x'@comma{} url: window.location.href@comma{} + title: document.title@comma{} body: window.getSelection()@}); void(0); @end example @@ -22762,13 +22936,13 @@ javascript:location.href='org-protocol://capture?template=x'+ '&body='+encodeURIComponent(window.getSelection());void(0); @end example -It is a bit more cluttered than the former one, but it is compatible +It is a bit more cluttered than the former one@comma{} but it is compatible with previous Org versions 9.0-9.4. In these versions encoding of space as ``+'' character was not supported by URI decoder. @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 +@samp{X} above). If unspecified@comma{} the template key is set in the variable @code{org-protocol-default-template-key}. The following template placeholders are available: @@ -22786,7 +22960,7 @@ placeholders are available: @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 +sources when reading a document. To that effect@comma{} you can use a bookmark with the following location: @example @@ -22796,10 +22970,10 @@ javascript:location.href='org-protocol://open-source?url='+ @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 +names@comma{} 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{:working-suffix}. For example@comma{} assuming you own a local copy of +@samp{https://orgmode.org/worg/} contents at @samp{/home/user/worg}@comma{} you can set @code{org-protocol-project-alist} to the following @lisp @@ -22814,24 +22988,24 @@ names, by stripping URL parameters from the end and replacing the @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 +a typo or have an idea about how to enhance the documentation@comma{} 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. +However@comma{} such mapping may not always yield the desired results. Suppose you maintain an online store located at @samp{https://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{https://example.com/print/posters.html} might be +way@comma{} a request to @samp{https://example.com/print/posters.html} might be rewritten on the server to something like @samp{https://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 +property @code{:rewrites}. This property is a list of cons cells@comma{} each of which maps a regular expression to a path relative to the @code{:working-directory}. @@ -22850,9 +23024,8 @@ adding @code{:rewrites} rules like this: @end lisp @noindent -Since @samp{example.com/$} is used as a regular expression, it maps -@samp{https://example.com/}, @samp{https://example.com}, -@samp{https://www.example.com/} and similar to +Since @samp{example.com/$} is used as a regular expression@comma{} it maps +@samp{https://example.com/}@comma{} @samp{https://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 @@ -22870,13 +23043,13 @@ 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 @ref{Top,Emacs EasyPG Library,,epa,} to -encrypt and decrypt files, and EasyPG needs a correct @ref{Top,GnuPG,,gnupg,} setup. +Org Crypt encrypts the text of an entry@comma{} but not the headline@comma{} or +properties. Behind the scene@comma{} it uses the @ref{Top,Emacs EasyPG Library,,epa,} to +encrypt and decrypt files@comma{} and EasyPG needs a correct @ref{Top,GnuPG,,gnupg,} setup. @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 +encrypted when the file is saved. To use a different tag@comma{} customize the @code{org-crypt-tag-matcher} setting. Here is a suggestion for Org Crypt settings in Emacs init file: @@ -22893,16 +23066,16 @@ Here is a suggestion for Org Crypt settings in Emacs init file: (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, +;; turn it off if you plan to use org-crypt.el quite often. Otherwise@comma{} ;; you'll get an (annoying) message each time you start Org. -;; To turn it off only locally, you can insert this: +;; To turn it off only locally@comma{} 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.: +specifying the respective key as property @samp{CRYPTKEY}@comma{} e.g.: @example * Totally secret :crypt: @@ -22912,7 +23085,7 @@ specifying the respective key as property @samp{CRYPTKEY}, e.g.: @end example Note that the @samp{CRYPTKEY} property is only effective when -@code{org-crypt-key} is non-@code{nil}. If @code{org-crypt-key} is @code{nil}, Org uses +@code{org-crypt-key} is non-@code{nil}. If @code{org-crypt-key} is @code{nil}@comma{} Org uses symmetric encryption unconditionally. Excluding the @samp{crypt} tag from inheritance prevents already encrypted @@ -22924,20 +23097,20 @@ text from being encrypted again. @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 +other applications@comma{} e.g.@comma{} 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. +compatible with Org Mobile. It also describes synchronizing changes@comma{} +such as to notes@comma{} 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 +To change tags and TODO states in the mobile application@comma{} first +customize the variables @code{org-todo-keywords}@comma{} @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 +and TODO keywords@comma{} even if Org files use only some of them. Though +the mobile application is expected to support in-buffer settings@comma{} 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 @@ -22951,7 +23124,7 @@ is required to understand TODO states @emph{sets} (see @ref{Per-file keywords}) @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, +a server@footnote{For a server to host files@comma{} consider using a WebDAV server@comma{} 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: @@ -22960,25 +23133,25 @@ locally just set the variable to point to that directory: (setq org-mobile-directory "~/orgmobile/") @end lisp -Alternatively, by using TRAMP (see @ref{Top,TRAMP User Manual,,tramp,}), +Alternatively@comma{} by using TRAMP (see @ref{Top,TRAMP User Manual,,tramp,})@comma{} @code{org-mobile-directory} may point to a remote directory accessible -through, for example, SSH, SCP, or DAVS: +through@comma{} for example@comma{} SSH@comma{} SCP@comma{} 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 +With a public server@comma{} 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 +encryption@comma{} 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 +storing of passwords@comma{} 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. +file contents@comma{} the file name remains visible on the file systems of +the local computer@comma{} the server@comma{} and the mobile device. @node Pushing to the mobile application @subsection Pushing to the mobile application @@ -22989,22 +23162,22 @@ 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{ +@code{org-directory}@comma{} 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 +defined by the user@footnote{While creating the agendas@comma{} Org mode forces @samp{ID} properties +on all referenced entries@comma{} 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.}. +on outline paths@comma{} assuming they are unique.}. -Finally, Org writes the file @samp{index.org}, containing links to other +Finally@comma{} Org writes the file @samp{index.org}@comma{} 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{ +downloads@comma{} it is expected to only read files whose checksums@footnote{ Checksums are stored automatically in the file @samp{checksums.dat}.} have changed. @@ -23013,10 +23186,10 @@ changed. @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 +More specifically@comma{} 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: +data in an inbox file format@comma{} through the following steps: @enumerate @item @@ -23030,16 +23203,16 @@ inbox file. @item @cindex @samp{FLAGGED}, tag -After moving the entries, Org processes changes to the shared +After moving the entries@comma{} Org processes changes to the shared files. Some of them are applied directly and without user -interaction. Examples include changes to tags, TODO state, +interaction. Examples include changes to tags@comma{} TODO state@comma{} 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 +intervention to clean up. For notes stored in flagged entries@comma{} Org displays them in the echo area when point is on the corresponding agenda item. @@ -23047,20 +23220,20 @@ agenda item. @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 +note as a normal note@comma{} 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 +@samp{FLAGGED} tag; second@comma{} it removes the flagged note from the +property drawer; third@comma{} 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 +From the agenda dispatcher@comma{} @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. +pull@comma{} pull again. @node Drag and Drop & @code{yank-media} @section Drag and Drop & @code{yank-media} @@ -23070,41 +23243,114 @@ pull, pull again. @cindex drag and drop @cindex dnd @vindex org-yank-dnd-method -Org mode supports drag and drop (DnD) of files. By default, Org asks -the user what must be done with the dropped file: attach it, insert -@samp{file:} link, or open the file. Customize @code{org-yank-dnd-method} to +Org mode supports drag and drop (DnD) of files. By default@comma{} Org asks +the user what must be done with the dropped file: attach it@comma{} insert +@samp{file:} link@comma{} or open the file. Customize @code{org-yank-dnd-method} to set the default DnD action. -When DnD method is ``attach'', Org mode first consults DnD metadata to -decide the attach method. For example, when file/files are dragged -from a file manager, Org may attach by copying or by moving. +When DnD method is ``attach''@comma{} Org mode first consults DnD metadata to +decide the attach method. For example@comma{} when file/files are dragged +from a file manager@comma{} Org may attach by copying or by moving. @vindex org-yank-dnd-default-attach-method If Org cannot figure out which attachment method to use from the -metadata, it defaults to @code{org-yank-dnd-default-attach-method} @footnote{By -default, @code{org-yank-dnd-default-attach-method} is set to nil -- use the same +metadata@comma{} it defaults to @code{org-yank-dnd-default-attach-method} @footnote{By +default@comma{} @code{org-yank-dnd-default-attach-method} is set to nil -- use the same value as @code{org-attach-method} (@code{cp} by default).} @cindex pasting files, images from clipboard -Starting from Emacs 29, Org mode supports @code{yank-media} command to yank -images from the clipboard and files from a file manager. +Starting from Emacs 29@comma{} Org mode supports @code{yank-media} command to yank +images from the clipboard@comma{} files from a file manager and tables copied +from LibreOffice Calc documents. @vindex org-yank-image-save-method -When yanking images from clipboard, Org saves the image on disk and -inserts the image link to Org buffer. Images are either saved as -attachments to heading (default) or to a globally defined directory. -The save location is controlled by @code{org-yank-image-save-method}. +When yanking images from clipboard@comma{} Org saves the image on disk and +inserts the image link to Org buffer. Images can be saved as +attachments to heading (default)@comma{} to a globally defined directory@comma{} or +to a directory returned by a function call. The save location is +controlled by @code{org-yank-image-save-method}. @vindex org-yank-image-file-name-function The yanked images are saved under automatically generated name. You can customize @code{org-yank-image-file-name-function} to make Org query the image names or change the naming scheme. -When yanking files copied from a file manager, Org respects the value +When yanking files copied from a file manager@comma{} Org respects the value of @code{org-yank-dnd-method}. Image files pasted this way also respect the value of @code{org-yank-image-save-method} when the action to perform is @samp{attach}. +Tables copied from LibreOffice Calc documents are yanked as Org +tables. + +@node Repeating commands +@section Repeating commands + +@cindex repeat-mode, org-mode +@cindex repeating navigation commands +When @code{repeat-mode} is turned on@comma{} headline motion commands@comma{} link and +block navigation commands by only pressing a single key. For example@comma{} +instead of typing @kbd{C-c C-n} repeatedly@comma{} you can just type +@kbd{C-c C-n n n n p u @dots{}} to move to different headlines. When +a key not in the map is pressed@comma{} it exits @code{repeat-mode} and the +command corresponding to the key is executed (see the +@ref{Repeating,Emacs user manual,,emacs,} for more details). + +By default@comma{} the following commands are made repeatable in separate +keymaps. + +@code{org-navigation-repeat-map}: + +@multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} +@headitem Command +@tab Key binding +@tab Repeat key +@item @code{org-next-visible-heading} +@tab @kbd{C-c C-n} +@tab @kbd{n} +@item @code{org-previous-visible-heading} +@tab @kbd{C-c C-p} +@tab @kbd{p} +@item @code{org-forward-heading-same-level} +@tab @kbd{C-c C-f} +@tab @kbd{f} +@item @code{org-backward-heading-same-level} +@tab @kbd{C-c C-b} +@tab @kbd{b} +@item @code{org-up-heading} +@tab @kbd{C-c C-u} +@tab @kbd{u} +@end multitable + + +@code{org-block-navigation-repeat-map}: + +@multitable {aaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} +@headitem Command +@tab Key binding +@tab Repeat key +@item @code{org-next-block} +@tab @kbd{C-c M-f} +@tab @kbd{f} +@item @code{org-previous-block} +@tab @kbd{C-c M-b} +@tab @kbd{b} +@end multitable + +@code{org-link-navigation-repeat-map}: + +@multitable {aaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} +@headitem Command +@tab Key binding +@tab Repeat key +@item @code{org-next-link} +@tab @kbd{C-c C-x C-n} +@tab @kbd{n} +@item @code{org-previous-link} +@tab @kbd{C-c C-x C-p} +@tab @kbd{p} +@end multitable + @node Hacking @appendix Hacking @@ -23117,6 +23363,7 @@ of Org. * Hooks:: How to reach into Org's internals. * Add-on Packages:: Available extensions. * Adding Hyperlink Types:: New custom link types. +* Adding Hyperlink preview:: Preview behavior for new hyperlink types. * Adding Export Backends:: How to write new export backends. * Tables in Arbitrary Syntax:: Orgtbl for LaTeX and other programs. * Dynamic Blocks:: Automatically filled blocks. @@ -23132,7 +23379,7 @@ of Org. @cindex hooks -Org has a large number of hook variables for adding functionality. A +Org has numerous hook variables for adding functionality. A complete list of hooks with documentation is maintained by the Worg project at @uref{https://orgmode.org/worg/doc.html#hooks}. @@ -23141,7 +23388,7 @@ project at @uref{https://orgmode.org/worg/doc.html#hooks}. @cindex add-on packages -Various authors wrote a large number of add-on packages for Org. Some +Various authors wrote many add-on packages for Org. Some of these packages used to be part of the @samp{org-mode} repository but are now hosted in a separate @samp{org-contrib} repository @uref{https://git.sr.ht/~bzg/org-contrib, here}. A Worg page with more @@ -23152,15 +23399,14 @@ information is at: @uref{https://orgmode.org/worg/org-contrib/}. @cindex hyperlinks, adding new types -Org has many built-in hyperlink types (see @ref{Hyperlinks}), and an +Org has many built-in hyperlink types (see @ref{Hyperlinks})@comma{} 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 +process of adding Org links to Unix man pages@comma{} which look like this @example [[man:printf][The printf manual]] @end example - @noindent The following @samp{ol-man.el} file implements it @@ -23186,7 +23432,7 @@ PATH should be a topic that can be thrown at the man command." (defun org-man-store-link (&optional _interactive?) "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. + ;; This is a man page@comma{} we do make this link. (let* ((page (org-man-get-page-name)) (link (concat "man:" page)) (description (format "Man page for %s" page))) @@ -23209,7 +23455,7 @@ PATH should be a topic that can be thrown at the man command." (pcase format (`html (format "%s" path desc)) (`latex (format "\\href@{%s@}@{%s@}" path desc)) - (`texinfo (format "@@uref@{%s,%s@}" path desc)) + (`texinfo (format "@@uref@{%s@comma{}%s@}" path desc)) (`ascii (format "%s (%s)" desc path)) (t path)))) @@ -23218,7 +23464,7 @@ PATH should be a topic that can be thrown at the man command." @end lisp @noindent -To activate links to man pages in Org, enter this in the Emacs init +To activate links to man pages in Org@comma{} enter this in the Emacs init file: @lisp @@ -23230,32 +23476,102 @@ A review of @samp{ol-man.el}: @enumerate @item -First, @samp{(require 'ol)} ensures that @samp{ol.el} is loaded. +First@comma{} @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 +prefix and associates functions for following@comma{} 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 +For example@comma{} @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 is passed an argument @code{interactive?} -which this function does not use, but other store functions use to +which this function does not use@comma{} but other store functions used to behave differently when a link is stored interactively by the user. -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 +It first checks if the major mode is appropriate. If check fails@comma{} +the function returns @code{nil}@comma{} which means it isn't responsible for +creating a link to the current buffer. Otherwise@comma{} 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 Hyperlink preview +@appendixsec Adding Hyperlink preview + +@cindex hyperlinks, adding preview behavior + +By default@comma{} Org supports previewing external links for links of type +@samp{file} and @samp{attachment} that point to image files. (See @ref{Images}.) + +Support for previewing other link types inline can be added to Org in +the following way: + +@enumerate +@item +Add a @samp{:preview} link parameter to the link type using +@code{org-link-set-parameters}. As an example@comma{} here we add previews for +the @samp{docview} link type. + +@lisp +(org-link-set-parameters + "docview" :preview #'org-link-docview-preview) +@end lisp + +@item +The value of the @samp{:preview} parameter must be a function that +accepts three arguments: +@itemize +@item +an overlay placed from the start to the end of the link@comma{} +@item +the link path@comma{} as a string@comma{} and +@item +the syntax node for the link. +@end itemize +It must return a non-nil value to indicate preview success. A +value of @samp{nil} implies that the preview failed@comma{} and the overlay +placed on the link will be removed. + +In our example@comma{} we use the @samp{convert} program (part of the +@samp{imagemagick} suite of tools) to create the thumbnail that is +displayed inline. + +@lisp +(defun org-link-docview-preview (ov path _elem) + "Preview file at PATH in overlay OV. + +_ELEM is the syntax node of the link element." + (when (executable-find "convert") + (let* ((path (expand-file-name (substitute-in-file-name path))) + (output-file (expand-file-name (concat "org-docview-preview-" + (substring (sha1 path) 0 10) + ".png") + temporary-file-directory))) + ;; Create or find preview for path + (when (or (file-readable-p output-file) + (= 0 (call-process + "convert" + nil (get-buffer-create "*Org Docview Preview Output*") nil + "-thumbnail" "x320" "-colorspace" "rgb" + "-background" "white" "-alpha" "remove" "-strip" + (concat path "[0]") output-file))) + ;; If preview image is available@comma{} display it via the overlay + (overlay-put ov 'display (create-image output-file)))))) +@end lisp + +@item +Now previews of docview links for supported document types (PDF@comma{} +djvu) are generated (along with image file previews) when calling +@code{org-link-preview}. +@end enumerate + @node Adding Export Backends @appendixsec Adding Export Backends @@ -23269,21 +23585,21 @@ backends from existing ones. @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 backend from scratch, and @samp{ox-beamer.el} for an example of +To grok these functions@comma{} see @samp{ox-latex.el} for an example of defining +a new backend from scratch@comma{} and @samp{ox-beamer.el} for an example of deriving from an existing engine. -For creating a new backend from scratch, first set its name as +For creating a new backend from scratch@comma{} first set its name as a symbol in an alist consisting of elements and export functions. To -make the backend visible to the export dispatcher, set @code{:menu-entry} -keyword. For export options specific to this backend, set the +make the backend visible to the export dispatcher@comma{} set @code{:menu-entry} +keyword. For export options specific to this backend@comma{} set the @code{:options-alist}. -For creating a new backend from an existing one, set +For creating a new backend from an existing one@comma{} set @code{:translate-alist} to an alist of export functions. This alist replaces the parent backend functions. -For complete documentation, see @uref{https://orgmode.org/worg/dev/org-export-reference.html, the Org Export Reference on Worg}. +For complete documentation@comma{} 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 @@ -23292,18 +23608,18 @@ For complete documentation, see @uref{https://orgmode.org/worg/dev/org-export-re @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. +Due to Org's success in handling tables with Orgtbl@comma{} a frequently +requested feature is the use of Org's table functions in other modes@comma{} +e.g.@comma{} @LaTeX{}. This would be hard to do in a general way without +complicated customization nightmares. Moreover@comma{} that would take Org +away from its simplicity roots that Orgtbl has proven. There is@comma{} +however@comma{} 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 +simple and isolate complications@comma{} if any@comma{} confined to the translate +function. To add more alien table formats@comma{} 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. @@ -23325,14 +23641,14 @@ 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: +If the mode is C@comma{} 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 +At the location of source@comma{} Org needs a special line to direct Orgtbl to translate and to find the target for inserting the translated table. For example: @@ -23341,11 +23657,10 @@ table. For 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 +@samp{table_name} is the table's reference name@comma{} which is also used in the +receiver lines@comma{} and the @samp{translation_function} is the Lisp function +that translates. This line@comma{} in addition@comma{} 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 @@ -23359,17 +23674,17 @@ 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 +translator function@comma{} 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 +when the source file is compiled or otherwise being worked on@comma{} use one of these strategies: @itemize @item -Place the table in a block comment. For example, in C mode you +Place the table in a block comment. For example@comma{} in C mode you could wrap the table between @samp{/*} and @samp{*/} lines. @item @@ -23377,7 +23692,7 @@ 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 +Comment and uncomment each line of the table during edits. The @kbd{M-x orgtbl-toggle-comment} command makes toggling easy. @end itemize @@ -23386,14 +23701,14 @@ Comment and un-comment each line of the table during edits. The @cindex @LaTeX{}, and Orgtbl mode -To wrap a source table in @LaTeX{}, use the @samp{comment} environment +To wrap a source table in @LaTeX{}@comma{} 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. +activate it@comma{} put @code{\usepackage@{comment@}} in the document header. +Orgtbl mode inserts a radio table skeleton@footnote{By default this works only for @LaTeX{}@comma{} HTML@comma{} 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 +@kbd{M-x orgtbl-insert-radio-table}@comma{} which prompts for a table +name. For example@comma{} if @samp{salesfigures} is the name@comma{} the template inserts: @example @@ -23408,14 +23723,14 @@ inserts: @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 +@code{orgtbl-to-latex} to convert the table to @LaTeX{} format@comma{} 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 +characters@comma{} 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, +expressions. If you are using AUC@TeX{} with the font-latex library@comma{} a much better solution is to add the @samp{comment} environment to the variable @code{LaTeX-verbatim-environments}.}: @@ -23430,15 +23745,15 @@ variable @code{LaTeX-verbatim-environments}.}: | 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) +% $ (optional extra dollar to keep Font Lock happy@comma{} 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. +After editing@comma{} @kbd{C-c C-c} inserts the translated table at the +target location@comma{} 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 +For hand-made custom tables@comma{} note that the translator needs to skip +the first two lines of the source table. Also@comma{} the command has to @emph{splice} out the target table without the header and footer. @example @@ -23462,29 +23777,29 @@ Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ 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}: +control output@comma{} 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}. +When @{@{@{var(BOOLEAN@}@}@} is non-@code{nil}@comma{} return only table body lines; +i.e.@comma{} 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 +original field value. For example@comma{} to wrap each field value in +dollar symbol@comma{} you could use @samp{:fmt "$%s$"}. Format can also wrap +a property list with column numbers and formats@comma{} for example @samp{:fmt + (2 "$%s$" 4 "%s\\%%")}. In place of a string@comma{} 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 +inserting mantissa and exponent@comma{} for example @samp{"%s\\times10^@{%s@}"}. This +may also be a property list with column numbers and formats@comma{} for example @samp{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After -@var{EFMT} has been applied to a value, @var{FMT}---see +@var{EFMT} has been applied to a value@comma{} @var{FMT}---see above---is also applied. Functions with two arguments can be -supplied instead of strings. By default, no special formatting is +supplied instead of strings. By default@comma{} no special formatting is applied. @end table @@ -23503,23 +23818,22 @@ applied. @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}, +(comma-separated values)@comma{} @code{orgtbl-to-tsv} (TAB-separated values)@comma{} +@code{orgtbl-to-latex}@comma{} @code{orgtbl-to-html}@comma{} @code{orgtbl-to-texinfo}@comma{} @code{orgtbl-to-unicode} and @code{orgtbl-to-orgtbl}. They use the generic -translator, @code{orgtbl-to-generic}, which delegates translations to +translator@comma{} @code{orgtbl-to-generic}@comma{} which delegates translations to various export backends. 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]}: +precedence over properties defined inside the function. For example@comma{} +this overrides the default @LaTeX{} line endings@comma{} @code{\\}@comma{} 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 +For a new language translator@comma{} define a converter function. It can be +a generic function@comma{} 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: @@ -23536,8 +23850,8 @@ for a field separator: @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 +a complete list of parameters@comma{} each of which can be passed through to +@code{orgtbl-to-latex}@comma{} @code{orgtbl-to-texinfo}@comma{} and any other function using that generic function. For complicated translations the generic translator function could be @@ -23547,7 +23861,7 @@ 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{mailto:emacs-orgmode@@gnu.org}. +users mailing list@comma{} at @email{mailto:emacs-orgmode@@gnu.org}. @node Dynamic Blocks @appendixsec Dynamic Blocks @@ -23555,13 +23869,13 @@ users mailing list, at @email{mailto:emacs-orgmode@@gnu.org}. @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 +with begin and end markers like any other code block@comma{} 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, +You can insert a dynamic block with @code{org-dynamic-block-insert-dblock}@comma{} +which is bound to @kbd{C-c C-x x} by default. For example@comma{} @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}). @@ -23587,7 +23901,7 @@ Update dynamic block at point. Update all dynamic blocks in the current file. @end table -Before updating a dynamic block, Org removes content between the +Before updating a dynamic block@comma{} 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 @@ -23615,13 +23929,13 @@ The dynamic block's writer function: (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 +To keep dynamic blocks up-to-date in an Org file@comma{} use the function@comma{} +@code{org-update-all-dblocks} in hook@comma{} 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 +Dynamic blocks@comma{} like any other block@comma{} can be narrowed with @code{org-narrow-to-block}. @node Special Agenda Views @@ -23632,23 +23946,23 @@ Dynamic blocks, like any other block, can be narrowed with @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 +@code{agenda}@comma{} @code{agenda*}@footnote{ The @code{agenda*} view is the same as @code{agenda} +except that it only considers @emph{appointments}@comma{} i.e.@comma{} scheduled and deadline items that have a time specification @samp{[h]h:mm} in their -timestamps.}, @code{todo}, @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. +timestamps.}@comma{} @code{todo}@comma{} @code{alltodo}@comma{} @code{tags}@comma{} @code{tags-todo}@comma{} @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 +For a global condition applicable to agenda views@comma{} 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: +with @samp{waiting} status. Manually this is a multistep search process@comma{} +but with a custom view@comma{} 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 +returns @code{nil} on match. Otherwise@comma{} it gives the location from where the search continues. @lisp @@ -23656,8 +23970,8 @@ the search continues. "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 + nil ; tag found@comma{} do not skip + subtree-end))) ; tag not found@comma{} continue after end of subtree @end lisp To use this custom function in a custom agenda command: @@ -23679,11 +23993,11 @@ meaningful string suitable for the agenda view. @findex org-agenda-skip-subtree-if 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 +include all levels@comma{} use @samp{LEVEL>0}@footnote{ Note that@comma{} for +@code{org-odd-levels-only}@comma{} a level number corresponds to order in the +hierarchy@comma{} not to the number of stars.}. Then to selectively pick the +matched entries@comma{} use @code{org-agenda-skip-function}@comma{} which also accepts +Lisp forms@comma{} such as @code{org-agenda-skip-entry-if} and @code{org-agenda-skip-subtree-if}. For example: @table @asis @@ -23697,7 +24011,7 @@ Skip current entry if it has not been scheduled. 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. +Skip current entry if it has a deadline@comma{} 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@. @@ -23706,7 +24020,7 @@ Skip current entry if the TODO keyword is TODO or WAITING@. 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 +Skip current entry if it has any timestamp@comma{} may also be deadline or scheduled. @item @samp{(org-agenda-skip-entry-if 'regexp "regular expression")} @@ -23716,7 +24030,7 @@ Skip current entry if the regular expression matches in the entry. 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. +Same as above@comma{} but check and skip the entire subtree. @end table The following is an example of a search for @samp{waiting} without the @@ -23785,8 +24099,8 @@ This will disable parsing and updating statistic cookies. @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 +details about generation of agenda views@comma{} see the docstrings for the +relevant variables@comma{} and this @uref{https://orgmode.org/worg/agenda-optimization.html, dedicated Worg page} for agenda optimization. @node Extracting Agenda Information @@ -23796,14 +24110,14 @@ optimization. @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 +Through this command-line interface@comma{} 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 +string consists of a single character@comma{} 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}). @@ -23813,10 +24127,9 @@ This example command line directly prints the TODO list to the printer: 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 +When the string parameter length is two or more characters@comma{} Org +matches it with tags/TODO strings. For example@comma{} this example command +line prints items tagged with @samp{shop}@comma{} but excludes items tagged with @samp{NewYork}: @example @@ -23841,16 +24154,16 @@ 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} +For structured processing of agenda output@comma{} 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 +The headline@comma{} without TODO keyword@comma{} TAGS and PRIORITY @item type -The type of the agenda entry, can be +The type of the agenda entry@comma{} can be @multitable {aaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @code{todo} @@ -23864,7 +24177,7 @@ The type of the agenda entry, can be @item @code{scheduled} @tab scheduled @item @code{timestamp} -@tab appointment, selected by timestamp +@tab appointment@comma{} selected by timestamp @item @code{closed} @tab entry was closed on date @item @code{upcoming-deadline} @@ -23876,13 +24189,13 @@ The type of the agenda entry, can be @end multitable @item todo -The TODO keyword, if any +The TODO keyword@comma{} if any @item tags -All tags including inherited ones, separated by colons +All tags including inherited ones@comma{} separated by colons @item date -The relevant date, like @samp{2007-2-14} +The relevant date@comma{} like @samp{2007-2-14} @item time -The time, like @samp{15:00-16:50} +The time@comma{} like @samp{15:00-16:50} @item extra String with extra planning info @item priority-l @@ -23891,12 +24204,12 @@ The priority letter if any was given 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 +If the selection of the agenda item was based on a timestamp@comma{} +including those items with @samp{DEADLINE} and @samp{SCHEDULED} keywords@comma{} 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. +deadline/scheduled)@comma{} 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: @@ -23911,10 +24224,10 @@ $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; $agenda = qx@{$cmd 2>/dev/null@}; # loop over all lines -foreach $line (split(/\n/,$agenda)) @{ +foreach $line (split(/\n/@comma{}$agenda)) @{ # get the individual values - ($category,$head,$type,$todo,$tags,$date,$time,$extra, - $priority_l,$priority_n) = split(/,/,$line); + ($category@comma{}$head@comma{}$type@comma{}$todo@comma{}$tags@comma{}$date@comma{}$time@comma{}$extra@comma{} + $priority_l@comma{}$priority_n) = split(/@comma{}/@comma{}$line); # process and print print "[ ] $head\n"; @} @@ -23931,23 +24244,23 @@ 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 +This includes the TODO keyword@comma{} the tags@comma{} time strings for deadline@comma{} +scheduled@comma{} and clocking@comma{} 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. +be @code{nil}@comma{} in which case the current entry is used. If +@var{WHICH} is @code{nil} or @code{all}@comma{} get all properties. If +@var{WHICH} is @code{special} or @code{standard}@comma{} 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 +@var{POM}. By default@comma{} 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 +entry does not have the property@comma{} then also check higher levels of the +hierarchy. If @var{INHERIT} is the symbol @code{selective}@comma{} use inheritance if and only if the setting of @code{org-use-property-inheritance} selects @var{PROPERTY} for inheritance. @@ -23974,7 +24287,7 @@ Insert a property drawer for the current entry. @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. +They are concatenated@comma{} with spaces as separators. @end defun @defun org-entry-get-multivalued-property pom property @@ -24003,9 +24316,9 @@ in this list. @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, +The functions must take a single argument@comma{} the name of the property@comma{} 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 +values@comma{} use the values as completion help@comma{} but allow also other values to be entered. The functions must return @code{nil} if they are not responsible for this property. @end defopt @@ -24017,8 +24330,8 @@ responsible for this property. @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 +satisfying certain criteria. Internally@comma{} this functionality is used +to produce agenda views@comma{} 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: @@ -24027,16 +24340,16 @@ 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. +at the beginning of the headline@comma{} call the function without arguments. Org returns a list 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 +To avoid preserving point@comma{} Org wraps the call to @var{FUNC} in +@code{save-excursion} form. After evaluation@comma{} 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, +forward. This may not always work as expected under some conditions@comma{} such as if the current subtree 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 +operation. In such rare circumstances@comma{} Org skips the next entry +entirely when it should not. To stop Org from such skips@comma{} make @var{FUNC} set the variable @code{org-map-continue-from} to a specific buffer position. @@ -24049,19 +24362,19 @@ of: @table @asis @item @code{nil} -The current buffer, respecting the restriction, if any. +The current buffer@comma{} respecting the restriction@comma{} if any. @item @code{tree} The subtree started with the entry at point. @item @code{region} -The entries within the active region, if any. +The entries within the active region@comma{} if any. @item @code{file} -The current buffer, without restriction. +The current buffer@comma{} without restriction. @item @code{file-with-archives} -The current buffer, and any archives associated with it. +The current buffer@comma{} and any archives associated with it. @item @code{agenda} All agenda files. @@ -24070,7 +24383,7 @@ All agenda files. 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. +If this is a list@comma{} all files in the list are scanned. @end table @noindent @@ -24086,14 +24399,14 @@ 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 +Used as value for @code{org-agenda-skip-function}@comma{} so whenever the +function returns @code{t}@comma{} @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: +The mapping routine can call any arbitrary function@comma{} even functions +that change metadata 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 @@ -24108,7 +24421,7 @@ for the possible values for @var{ACTION}. @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 +@var{ONOFF} to either @code{on} or @code{off} does not toggle tag@comma{} but ensure that it is either on or off. @end defun @@ -24130,7 +24443,7 @@ and archive trees. @end lisp The following example counts the number of entries with TODO keyword -@samp{WAITING}, in all agenda files. +@samp{WAITING}@comma{} in all agenda files. @lisp (length (org-map-entries t "/+WAITING" 'agenda)) @@ -24142,118 +24455,127 @@ The following example counts the number of entries with TODO keyword @anchor{From Carsten} @appendixsec From Carsten -Org was born in 2003, out of frustration over the user interface of +Org was born in 2003@comma{} 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, +projects@comma{} and using Emacs seemed to be the natural way to go. +However@comma{} having to remember eleven different commands with two or +three keys per command@comma{} only to hide and show parts of the outline +tree@comma{} that seemed entirely unacceptable to me. Also@comma{} when using +outlines to take notes@comma{} I constantly wanted to restructure the tree@comma{} 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 +@samp{outline-magic.el}@comma{} but quickly moved to the more general @samp{org.el}. +As this environment became comfortable for project planning@comma{} the next +step was adding @emph{TODO entries}@comma{} basic @emph{timestamps}@comma{} 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 +has today: to be a new@comma{} outline-based@comma{} plain text mode with innovative +and intuitive editing features@comma{} 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{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 +Since the first release@comma{} literally thousands of emails to me or to the +@email{mailto:emacs-orgmode@@gnu.org, mailing list} have provided a constant stream of bug reports@comma{} feedback@comma{} +new ideas@comma{} 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. +or more aspects of Org. The list may not be complete@comma{} if I have +forgotten someone@comma{} please accept my apologies and let me know. -Before I get to this list, a few special mentions are in order: +Before I get to this list@comma{} 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 +Bastien has written numerous extensions to Org (most of +them integrated into the core by now)@comma{} 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 +central to the success of this project. Bastien also invented Worg@comma{} +helped to establish the Web presence of Org@comma{} 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 +of Org between 2011 and 2013@comma{} 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 +Eric and Dan are jointly responsible for the Org Babel system@comma{} 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 +Org@comma{} including the attachment system (@samp{org-attach.el})@comma{} integration +with Apple Mail (@samp{org-mac-message.el})@comma{} hierarchical dependencies of +TODO items@comma{} habit tracking (@samp{org-habits.el})@comma{} and encryption +(@samp{org-crypt.el}). Also@comma{} 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 +Without Sebastian@comma{} 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}, +of Org onto a much higher level. He also wrote @samp{org-info.js}@comma{} 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 +See below for the full list of contributions! Again@comma{} 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: +I started maintaining Org in January 2011 and officially stepped down +in December 2024@comma{} when Ihor Radchenko agreed to become the new Org +maintainer. I was active for the first few years@comma{} then my involvement +slowly decreased thanks to the help of new core contributors whom I'd +like to thank. @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. +Eric has been 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. +Nicolas was maintaining the consistency of the deepest parts of Org. +His work on @samp{org-element.el} and @samp{ox.el} has been outstanding@comma{} and +it opened the doors for many new ideas and features. He rewrote old +exporters and helped with documenting this change. More importantly +(if that's possible)@comma{} he has been more than reliable during all the +work done for Org 8.0. @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. +Achim rewrote the building process of Org@comma{} turning some @emph{ad hoc} +scripts into a stable 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 +Nick@comma{} who patiently helped users so many times. It is impossible to +overestimate such a great help@comma{} and the list would not be so active without him. + +@item Kyle Meyer +Kyle is maintaining @uref{https://list.orgmode.org, list.orgmode.org} +and takes care of backporting upstream GNU Emacs changes into Org's +repository. He also helped tremendously on the mailing list and in +private@comma{} patiently answering questions@comma{} competently providing advice +and solutions. + +@item Ihor Radchenko +Ihor became Org maintainer in December 2024@comma{} and I'm very grateful +to him for agreeing to take on this role. His responsiveness on the +mailing list@comma{} his determination to improve Org as a core format and +an ecosystem of tools@comma{} his clarity about strategic changes that need +to be made make him an asset for the Org community. @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 fair when shortlisting a few of them@comma{} but Org's history would not be complete if the ones above were not mentioned in this manual. +Of course@comma{} I'm also grateful 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@comma{} with both the +community and the code. + @anchor{List of Contributions} @appendixsec List of Contributions @@ -24282,7 +24604,7 @@ 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. +for Remember@comma{} which are now templates for capture. @item Timothy E Chapman worked on a complete overhaul of the orgmode.org @@ -24294,7 +24616,7 @@ specified time. @item Gregory Chernov patched support for Lisp forms into table -calculations and improved XEmacs compatibility, in particular by +calculations and improved XEmacs compatibility@comma{} in particular by porting @samp{nouline.el} to XEmacs. @item @@ -24305,7 +24627,7 @@ 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 +came up with the idea of properties@comma{} and that there should be an API for them. @item @@ -24313,16 +24635,16 @@ 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 +inspired some of the early development@comma{} 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. +to integrate 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, +Christian Egli converted the documentation into Texinfo format@comma{} +inspired the agenda@comma{} patched CSS formatting into the HTML exporter@comma{} and wrote @samp{org-taskjuggler.el}. @item @@ -24353,7 +24675,7 @@ Eric Fraga drove the development of Beamer export with ideas and testing. @item -Barry Gidden did proofreading the manual in preparation for the book +Barry Gidden proofread the manual in preparation for the book publication through Network Theory Ltd. @item @@ -24372,20 +24694,20 @@ a book. @item Bernt Hansen has driven much of the support for auto-repeating -tasks, task state change logging, and the clocktable. His clear +tasks@comma{} task state change logging@comma{} 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 +Manuel Hermenegildo has contributed various ideas@comma{} 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. +Scott Jaderholm proposed footnotes@comma{} control over whitespace between +folded entries@comma{} and column view for properties. @item Matt Jones wrote MobileOrg Android. @@ -24402,15 +24724,15 @@ 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, +David Maus wrote @samp{org-atom.el}@comma{} maintains the issues file for Org@comma{} and is a prolific contributor on the mailing list with competent -replies, small fixes and patches. +replies@comma{} small fixes and patches. @item Jason@tie{}F@.@tie{}McBrayer suggested agenda export to CSV format. @item -Kyle Meyer helped setting up the @uref{https://public-inbox.org/, public-inbox} archive of the @uref{https://orgmode.org/list/, Org +Kyle Meyer helped to set up the @uref{https://public-inbox.org/, public-inbox} archive of the @uref{https://orgmode.org/list/, Org mailing list} and has been fixing many bugs. @item @@ -24438,11 +24760,11 @@ Todd Neal provided patches for links to Info files and Elisp forms. 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. +Tim O'Callaghan suggested in-file links@comma{} search options for general +file links@comma{} and tags. @item -Osamu Okano wrote @samp{orgcard2ref.pl}, a Perl program to create a text +Osamu Okano wrote @samp{orgcard2ref.pl}@comma{} a Perl program to create a text version of the reference card. @item @@ -24454,10 +24776,10 @@ Oliver Oppitz suggested multi-state TODO items. @item Scott Otterson sparked the introduction of descriptive text for -links, among other things. +links@comma{} among other things. @item -Pete Phillips helped during the development of the TAGS feature, +Pete Phillips helped during the development of the TAGS feature@comma{} and provided frequent feedback. @item @@ -24472,7 +24794,7 @@ experience regarding Org's speed. T@.@tie{}V@.@tie{}Raman reported bugs and suggested improvements. @item -Matthias Rempe (Oelde) provided ideas, Windows support, and quality +Matthias Rempe (Oelde) provided ideas@comma{} Windows support@comma{} and quality control. @item @@ -24483,7 +24805,7 @@ He also acted as mailing list moderator for some time. 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 +Frank Ruell solved the mystery of the @samp{keymapp nil} bug@comma{} a conflict with @samp{allout.el}. @item @@ -24491,11 +24813,11 @@ 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. +Philip Rooke created the Org reference card@comma{} provided lots of +feedback@comma{} developed and applied standards to the Org documentation. @item -Christian Schlauer proposed angular brackets around links, among +Christian Schlauer proposed angular brackets around links@comma{} among other things. @item @@ -24505,12 +24827,13 @@ Paul Sexton wrote @samp{org-ctags.el}. 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. +Ilya Shlyakhter proposed the Archive Sibling@comma{} line numbering in +literal examples@comma{} and remote highlighting for referenced code lines. @item Stathis Sideris wrote the @samp{ditaa.jar} ASCII to PNG converter that is -now packaged into the @uref{https://git.sr.ht/~bzg/org-contrib, org-contrib} repository. +available as a package in some operating systems or can be +downloaded from @uref{https://github.com/stathissideris/ditaa}. @item Daniel Sinder came up with the idea of internal archiving by locking @@ -24520,20 +24843,20 @@ subtrees. Dale Smith proposed link abbreviations. @item -James TD Smith has contributed a large number of patches for +James TD Smith has contributed numerous 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 +Adam Spiers asked for global linking commands@comma{} inspired the link +extension system@comma{} added support for Mairix@comma{} and proposed the mapping API@. @item Ulf Stegemann created the table to translate special symbols to -HTML, @LaTeX{}, UTF-8, Latin-1 and ASCII@. +HTML@comma{} @LaTeX{}@comma{} UTF-8@comma{} Latin-1 and ASCII@. @item -Andy Stewart contributed code to @samp{ol-w3m.el}, to copy +Andy Stewart contributed code to @samp{ol-w3m.el}@comma{} to copy HTML content with links transformation to Org syntax. @item @@ -24563,7 +24886,7 @@ Samuel Wales has provided important feedback and bug reports. Chris Wallace provided a patch implementing the @samp{QUOTE} block. @item -David Wainberg suggested archiving, and improvements to the +David Wainberg suggested archiving@comma{} and improvements to the linking system. @item @@ -24575,7 +24898,7 @@ Roland Winkler requested additional key bindings to make Org work on a TTY@. @item -Piotr Zielinski wrote @samp{org-mouse.el}, proposed agenda +Piotr Zielinski wrote @samp{org-mouse.el}@comma{} proposed agenda blocks and contributed various ideas and code snippets. @item @@ -24585,39 +24908,39 @@ Marco Wahl wrote @samp{ol-eww.el}. @node GNU Free Documentation License @appendix GNU Free Documentation License -@center Version 1.3, 3 November 2008 +@center Version 1.3@comma{} 3 November 2008 @display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. +Copyright @copyright{} 2000@comma{} 2001@comma{} 2002@comma{} 2007@comma{} 2008 Free Software Foundation@comma{} Inc. @uref{https://fsf.org/} Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. +of this license document@comma{} 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 +The purpose of this License is to make a manual@comma{} textbook@comma{} 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 +to copy and redistribute it@comma{} with or without modifying it@comma{} either +commercially or noncommercially. Secondarily@comma{} this License preserves for the author and publisher a way to get credit for -their work, while not being considered responsible for +their work@comma{} while not being considered responsible for modifications made by others. -This License is a kind of ``copyleft'', which means that derivative +This License is a kind of ``copyleft''@comma{} 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 +It complements the GNU General Public License@comma{} 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: +free software@comma{} 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 +software manuals; it can be used for any textual work@comma{} 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. @@ -24625,33 +24948,33 @@ instruction or reference. @item APPLICABILITY AND DEFINITIONS -This License applies to any manual or other work, in any medium, +This License applies to any manual or other work@comma{} in any medium@comma{} 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, +grants a world-wide@comma{} royalty-free license@comma{} unlimited in duration@comma{} 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 +``Document''@comma{} below@comma{} refers to any such manual or work. Any member +of the public is a licensee@comma{} and is addressed as ``you''. You accept +the license if you copy@comma{} 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 +Document or a portion of it@comma{} either copied verbatim@comma{} 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 +fall directly within that overall subject. (Thus@comma{} if the Document +is in part a textbook of mathematics@comma{} 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 +historical connection with the subject or with related matters@comma{} or +of legal@comma{} commercial@comma{} philosophical@comma{} 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 +titles are designated@comma{} as being those of Invariant Sections@comma{} 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 @@ -24659,42 +24982,42 @@ 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 +listed@comma{} as Front-Cover Texts or Back-Cover Texts@comma{} 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 +A Front-Cover Text may be at most 5 words@comma{} and a Back-Cover Text may be at most 25 words. -A ``Transparent'' copy of the Document means a machine-readable copy, +A ``Transparent'' copy of the Document means a machine-readable copy@comma{} represented in a format whose specification is available to the -general public, that is suitable for revising the document +general public@comma{} 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 +available drawing editor@comma{} 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 +Transparent file format whose markup@comma{} or absence of markup@comma{} 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@. +ASCII without markup@comma{} Texinfo input format@comma{} @LaTeX{} input format@comma{} +SGML or XML using a publicly available DTD@comma{} and standard-conforming +simple HTML@comma{} PostScript or PDF designed for human modification. +Examples of transparent image formats include PNG@comma{} 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 +edited only by proprietary word processors@comma{} SGML or XML for which +the DTD and/or processing tools are not generally available@comma{} and +the machine-generated HTML@comma{} 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 +The ``Title Page'' means@comma{} for a printed book@comma{} the title page itself@comma{} +plus such following pages as are needed to hold@comma{} legibly@comma{} 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 +works in formats which do not have any title page as such@comma{} ``Title Page'' means the text near the most prominent appearance of the -work's title, preceding the beginning of the body of the text. +work's title@comma{} 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. @@ -24702,8 +25025,8 @@ 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''.) +stands for a specific section name mentioned below@comma{} such as +``Acknowledgements''@comma{} ``Dedications''@comma{} ``Endorsements''@comma{} 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. @@ -24711,63 +25034,63 @@ 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 +this License@comma{} 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 +You may copy and distribute the Document in any medium@comma{} either +commercially or noncommercially@comma{} provided that this License@comma{} the +copyright notices@comma{} and the license notice saying this License +applies to the Document are reproduced in all copies@comma{} 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, +or further copying of the copies you make or distribute. However@comma{} 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, +You may also lend copies@comma{} under the same conditions stated above@comma{} 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 +have printed covers) of the Document@comma{} numbering more than 100@comma{} and +the Document's license notice requires Cover Texts@comma{} you must +enclose the copies in covers that carry@comma{} clearly and legibly@comma{} all +these Cover Texts: Front-Cover Texts on the front cover@comma{} 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 +covers in addition. Copying with changes limited to the covers@comma{} as long as they preserve the title of the Document and satisfy these -conditions, can be treated as verbatim copying in other respects. +conditions@comma{} 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 +legibly@comma{} you should put the first ones listed (as many as fit +reasonably) on the actual cover@comma{} 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 +numbering more than 100@comma{} you must either include a machine-readable +Transparent copy along with each Opaque copy@comma{} 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 +network protocols a complete Transparent copy of the Document@comma{} free +of added material. If you use the latter option@comma{} you must take +reasonably prudent steps@comma{} when you begin distribution of Opaque +copies in quantity@comma{} 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, +It is requested@comma{} but not required@comma{} that you contact the authors of +the Document well before redistributing any large number of copies@comma{} to give them a chance to provide you with an updated version of the Document. @@ -24775,32 +25098,32 @@ Document. 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 +under the conditions of sections 2 and 3 above@comma{} provided that you +release the Modified Version under precisely this License@comma{} with the +Modified Version filling the role of the Document@comma{} thus licensing distribution and modification of the Modified Version to whoever -possesses a copy of it. In addition, you must do these things in +possesses a copy of it. In addition@comma{} 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 +Use in the Title Page (and on the covers@comma{} if any) a title +distinct from that of the Document@comma{} and from those of previous +versions (which should@comma{} if there were any@comma{} 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 +List on the Title Page@comma{} as authors@comma{} 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. +Modified Version@comma{} together with at least five of the principal +authors of the Document (all of its principal authors@comma{} if it has +fewer than five)@comma{} 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. +Modified Version@comma{} as the publisher. @item Preserve all the copyright notices of the Document. @@ -24810,9 +25133,9 @@ Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. @item -Include, immediately after the copyright notices, a license +Include@comma{} immediately after the copyright notices@comma{} a license notice giving the public permission to use the Modified Version -under the terms of this License, in the form shown in the +under the terms of this License@comma{} in the form shown in the Addendum below. @item @@ -24824,33 +25147,33 @@ license notice. 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, +Preserve the section Entitled ``History''@comma{} Preserve its Title@comma{} and +add to it an item stating at least the title@comma{} year@comma{} new authors@comma{} 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 +Page. If there is no section Entitled ``History'' in the Document@comma{} +create one stating the title@comma{} year@comma{} authors@comma{} and publisher of +the Document as given on its Title Page@comma{} 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 +Preserve the network location@comma{} if any@comma{} given in the Document +for public access to a Transparent copy of the Document@comma{} 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 +itself@comma{} 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 +For any section Entitled ``Acknowledgements'' or ``Dedications''@comma{} +Preserve the Title of the section@comma{} 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 +Preserve all the Invariant Sections of the Document@comma{} unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. @@ -24869,25 +25192,25 @@ 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 +copied from the Document@comma{} you may at your option designate some or all +of these sections as invariant. To do this@comma{} 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 +You may add a section Entitled ``Endorsements''@comma{} provided it contains nothing but endorsements of your Modified Version by various -parties---for example, statements of peer review or that the text has +parties---for example@comma{} 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 +You may add a passage of up to five words as a Front-Cover Text@comma{} and a +passage of up to 25 words as a Back-Cover Text@comma{} 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 +includes a cover text for the same cover@comma{} previously added by you or +by arrangement made by the same entity you are acting on behalf of@comma{} +you may not add another; but you may replace the old one@comma{} 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 @@ -24898,42 +25221,42 @@ imply endorsement of any Modified Version. 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 +this License@comma{} under the terms defined in section 4 above for +modified versions@comma{} provided that you include in the combination all +of the Invariant Sections of all of the original documents@comma{} +unmodified@comma{} and list them all as Invariant Sections of your +combined work in its license notice@comma{} and that you preserve all their Warranty Disclaimers. -The combined work need only contain one copy of this License, and +The combined work need only contain one copy of this License@comma{} 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 +but different contents@comma{} make the title of each such section unique +by adding at the end of it@comma{} in parentheses@comma{} the name of the +original author or publisher of that section if known@comma{} 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 +In the combination@comma{} you must combine any sections Entitled +``History'' in the various original documents@comma{} forming one section Entitled ``History''; likewise combine any sections Entitled -``Acknowledgements'', and any sections Entitled ``Dedications''. You +``Acknowledgements''@comma{} 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 +documents released under this License@comma{} 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 +that is included in the collection@comma{} 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 +You may extract a single document from such a collection@comma{} and +distribute it individually under this License@comma{} provided you insert +a copy of this License into the extracted document@comma{} and follow this License in all other respects regarding verbatim copying of that document. @@ -24941,18 +25264,18 @@ document. 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 +separate and independent documents or works@comma{} in or on a volume of +a storage or distribution medium@comma{} 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 +works permit. When the Document is included in an aggregate@comma{} 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 +copies of the Document@comma{} then if the Document is less than one half +of the entire aggregate@comma{} the Document's Cover Texts may be placed +on covers that bracket the Document within the aggregate@comma{} 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. @@ -24960,72 +25283,72 @@ the whole aggregate. @item TRANSLATION -Translation is considered a kind of modification, so you may +Translation is considered a kind of modification@comma{} 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 +special permission from their copyright holders@comma{} 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 +include a translation of this License@comma{} and all the license notices +in the Document@comma{} and any Warranty Disclaimers@comma{} 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 +this License or a notice or disclaimer@comma{} the original version will prevail. -If a section in the Document is Entitled ``Acknowledgements'', -``Dedications'', or ``History'', the requirement (section 4) to +If a section in the Document is Entitled ``Acknowledgements''@comma{} +``Dedications''@comma{} or ``History''@comma{} 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 +You may not copy@comma{} modify@comma{} sublicense@comma{} or distribute the Document except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, +otherwise to copy@comma{} modify@comma{} sublicense@comma{} or distribute it is void@comma{} and will automatically terminate your rights under this License. -However, if you cease all violation of this License, then your +However@comma{} if you cease all violation of this License@comma{} 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 +provisionally@comma{} unless and until the copyright holder explicitly and +finally terminates your license@comma{} and (b) permanently@comma{} 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 +Moreover@comma{} 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 +violation by some reasonable means@comma{} 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 +that copyright holder@comma{} 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 +permanently reinstated@comma{} 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 Free Software Foundation may publish new@comma{} 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 +versions will be similar in spirit to the present version@comma{} 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 +version of this License ``or any later version'' applies to it@comma{} 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, +the Document does not specify a version number of this License@comma{} 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 +can decide which future versions of this License can be used@comma{} that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Document. @@ -25041,24 +25364,24 @@ 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, +license published by Creative Commons Corporation@comma{} a not-for-profit corporation with a principal place of business in -San Francisco, California, as well as future copyleft versions of +San Francisco@comma{} California@comma{} 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. +``Incorporate'' means to publish or republish a Document@comma{} in whole +or in part@comma{} 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. +License@comma{} and if all works that were first published under this +License somewhere other than this MMC@comma{} and subsequently +incorporated in whole or in part into the MMC@comma{} (1) had no cover +texts or invariant sections@comma{} and (2) were thus incorporated prior +to November 1@comma{} 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. +site under CC-BY-SA on the same site at any time before August 1@comma{} +2009@comma{} provided the MMC is eligible for relicensing. @end enumerate @page @@ -25066,36 +25389,36 @@ site under CC-BY-SA on the same site at any time before August 1, @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 +To use this License in a document you have written@comma{} 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 +Permission is granted to copy@comma{} distribute and/or modify this document +under the terms of the GNU Free Documentation License@comma{} 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 +with no Invariant Sections@comma{} no Front-Cover Texts@comma{} 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, +If you have Invariant Sections@comma{} Front-Cover Texts and Back-Cover Texts@comma{} 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 +with the Invariant Sections being LIST THEIR TITLES@comma{} with +the Front-Cover Texts being LIST@comma{} 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 +If you have Invariant Sections without Cover Texts@comma{} or some other +combination of the three@comma{} merge those two alternatives to suit the situation. -If your document contains nontrivial examples of program code, we +If your document contains nontrivial examples of program code@comma{} we recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, to +free software license@comma{} such as the GNU General Public License@comma{} to permit their use in free software. @node Main Index @@ -25116,8 +25439,8 @@ permit their use in free software. @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 +This is not a complete index of variables and faces@comma{} only the ones +that are mentioned in the manual. For a more complete list@comma{} use @kbd{M-x org-customize} and then click yourself through the tree. @printindex vr diff --git a/elpa/org-9.7.39/doc/orgcard.tex b/elpa/org-9.8.3/doc/orgcard.tex similarity index 99% rename from elpa/org-9.7.39/doc/orgcard.tex rename to elpa/org-9.8.3/doc/orgcard.tex index f96b84d1..c611f5a6 100644 --- a/elpa/org-9.7.39/doc/orgcard.tex +++ b/elpa/org-9.8.3/doc/orgcard.tex @@ -19,7 +19,7 @@ \pdflayout=(1l) % Nothing else needs to be changed below this line. -% Copyright (C) 1987, 1993, 1996--1997, 2001--2025 Free Software +% Copyright (C) 1987, 1993, 1996--1997, 2001--2026 Free Software % Foundation, Inc. % This document is free software: you can redistribute it and/or modify @@ -396,7 +396,7 @@ Formulas typed in field are executed by \kbd{TAB}, formula, \kbd{:=} a field formula. \key{Example: Add Col1 and Col2}{|=\$1+\$2 |} -\key{... with printf format specification}{|=\$1+\$2;\%.2f|} +\key{... with printf-style format specification}{|=\$1+\$2;\%.2f|} \key{... with constants from constants.el}{|=\$1/\$c/\$cm |} \metax{sum from 2nd to 3rd hline}{|:=vsum(@II..@III)|} \key{apply current column formula}{| = |} diff --git a/elpa/org-9.7.39/doc/orgguide.texi b/elpa/org-9.8.3/doc/orgguide.texi similarity index 67% rename from elpa/org-9.7.39/doc/orgguide.texi rename to elpa/org-9.8.3/doc/orgguide.texi index becec7a2..5f64d778 100644 --- a/elpa/org-9.7.39/doc/orgguide.texi +++ b/elpa/org-9.8.3/doc/orgguide.texi @@ -7,22 +7,22 @@ @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} +@set MAINTAINER Ihor Radchenko +@set MAINTAINEREMAIL @email{yantar92@posteo.net} +@set MAINTAINERCONTACT @uref{mailto:yantar92@posteo.net,contact the maintainer} @c %**end of header @copying -Copyright @copyright{} 2004--2025 Free Software Foundation, Inc. +Copyright @copyright{} 2004--2026 Free Software Foundation@comma{} 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 +Permission is granted to copy@comma{} distribute and/or modify this document +under the terms of the GNU Free Documentation License@comma{} 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,'' +Invariant Sections@comma{} with the Front-Cover Texts being ``A GNU Manual@comma{}'' 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.'' -in the full Org manual, which is distributed together with this +in the full Org manual@comma{} which is distributed together with this compact guide. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and @@ -39,7 +39,7 @@ modify this GNU manual.'' @finalout @titlepage @title Org Mode Compact Guide -@subtitle Release 9.7 +@subtitle Release 9.8 @author The Org Mode Developers @page @vskip 0pt plus 1filll @@ -65,7 +65,7 @@ modify this GNU manual.'' * Tags:: Tagging headlines and matching sets of tags. * Properties:: Storing information about an entry. * Dates and Times:: Making items useful for planning. -* Capture, Refile, Archive: Capture Refile Archive. The ins and outs for projects. +* Capture@comma{} Refile@comma{} Archive: Capture Refile Archive. The ins and outs for projects. * Agenda Views:: Collecting information into views. * Markup:: Compose beautiful documents. * Exporting:: Sharing and publishing notes. @@ -101,7 +101,7 @@ Dates and Times * Deadlines and Scheduling:: Planning your work. * Clocking Work Time:: Tracking how long you spent on a task. -Capture, Refile, Archive +Capture@comma{} Refile@comma{} Archive * Capture:: Capturing new stuff. * Refile and Copy:: Moving/copying a tree from one place to another. @@ -145,13 +145,13 @@ Exporting @node Introduction @chapter Introduction -Org is a mode for keeping notes, maintaining TODO lists, and doing +Org is a mode for keeping notes@comma{} maintaining TODO lists@comma{} and doing project planning with a fast and effective plain-text system. It is -also an authoring and publishing system, and it supports working with -source code for literal programming and reproducible research. +also an authoring and publishing system@comma{} and it supports working with +source code for literate programming and reproducible research. This document is a much compressed derivative of the @ref{Top,comprehensive Org -mode manual,,org,}. It contains all basic features and commands, along with +mode manual,,org,}. It contains all basic features and commands@comma{} along with important hints for customization. It is intended for beginners who would shy back from a 200 pages manual because of sheer size. @@ -160,23 +160,22 @@ would shy back from a 200 pages manual because of sheer size. @quotation Important If you are using a version of Org that is part of the Emacs -distribution, please skip this section and go directly to @ref{Activation}. +distribution@comma{} please skip this section and go directly to @ref{Activation}. @end quotation -If you have downloaded Org from the web, either as a distribution -@samp{.zip} or @samp{.tar} file, or as a Git archive, it is best to run it +If you have downloaded Org from the web@comma{} either as a distribution +@samp{.zip} or @samp{.tar} file@comma{} or as a Git archive@comma{} it is best to run it directly from the distribution directory. You need to add the @samp{lisp/} -subdirectories to the Emacs load path. To do this, add the following +subdirectories to the Emacs load path. To do this@comma{} add the following line to your Emacs init file: @example (add-to-list 'load-path "~/path/to/orgdir/lisp") @end example - @noindent -If you have been using git or a tar ball to get Org, you need to run +If you have been using git or a tar ball to get Org@comma{} you need to run the following command to generate autoload information. @example @@ -187,7 +186,7 @@ make autoloads @heading Activation Add the following lines to your Emacs init file to define @emph{global} -keys for three commands that are useful in any Emacs buffer, not just +keys for three commands that are useful in any Emacs buffer@comma{} not just Org buffers. Please choose suitable keys yourself. @lisp @@ -201,22 +200,22 @@ Files with extension @samp{.org} will be put into Org mode automatically. @anchor{Feedback} @heading Feedback -If you find problems with Org, or if you have questions, remarks, or -ideas about it, please mail to the Org mailing list +If you find problems with Org@comma{} or if you have questions@comma{} remarks@comma{} or +ideas about it@comma{} please mail to the Org mailing list @email{mailto:emacs-orgmode@@gnu.org}. For information on how to submit bug -reports, see the @ref{Top,main manual,,org,}. +reports@comma{} see the @ref{Top,main manual,,org,}. @node Document Structure @chapter Document Structure Org is an outliner. Outlines allow a document to be organized in -a hierarchical structure, which, least for me, is the best +a hierarchical structure@comma{} which@comma{} at least for me@comma{} 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 +is achieved by folding@comma{} i.e.@comma{} 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. +the entire show and hide functionalities into a single command@comma{} +@code{org-cycle}@comma{} which is bound to the @kbd{@key{TAB}} key. @menu * Headlines:: How to typeset Org tree nodes. @@ -236,17 +235,17 @@ behavior of @kbd{C-a} and @kbd{C-e} in headlines.} with one or more stars follow a space. For example: @example -* Top level headline +* First (top) level headline ** Second level *** Third level some text *** Third level more text -* Another top level headline +* Another first (top) level headline @end example -Note that a headline named after @code{org-footnote-section}, which -defaults to @samp{Footnotes}, is considered as special. A subtree with +Note that a headline named after @code{org-footnote-section}@comma{} which +defaults to @samp{Footnotes}@comma{} is considered as special. A subtree with this headline will be silently ignored by exporting functions. Some people find the many stars too noisy and would prefer an outline @@ -257,7 +256,7 @@ See @ref{Miscellaneous} for a setup to realize this. @section Visibility Cycling Outlines make it possible to hide parts of the text in the buffer. -Org uses just two commands, bound to @kbd{@key{TAB}} and +Org uses just two commands@comma{} bound to @kbd{@key{TAB}} and @kbd{S-@key{TAB}} (@code{org-cycle} and @code{org-shifttab}) to change the visibility in the buffer. @@ -266,32 +265,30 @@ visibility in the buffer. @emph{Subtree cycling}: Rotate current subtree among the states @example -,-> FOLDED -> CHILDREN -> SUBTREE --. +@comma{}-> FOLDED -> CHILDREN -> SUBTREE --. '-----------------------------------' @end example +When called with a prefix argument (@kbd{C-u @key{TAB}})@comma{} or with the +Shift key@comma{} global cycling is invoked. -When called with a prefix argument (@kbd{C-u @key{TAB}}), or with the -Shift key, global cycling is invoked. - -@item @kbd{S-@key{TAB}} (@code{org-global-cycle}) -@itemx @kbd{C-u @key{TAB}} (@code{org-cycle}) +@item @kbd{S-@key{TAB}} (@code{org-global-cycle})@comma{} @kbd{C-u @key{TAB}} (@code{org-cycle}) @emph{Global cycling}: Rotate the entire buffer among the states @example -,-> OVERVIEW -> CONTENTS -> SHOW ALL --. +@comma{}-> OVERVIEW -> CONTENTS -> SHOW ALL --. '--------------------------------------' @end example -@item @kbd{C-u C-u C-u @key{TAB}} (@code{org-show-all}) -Show all, including drawers. +@item @kbd{C-u C-u C-u @key{TAB}} (@code{org-fold-show-all}) +Show all@comma{} including drawers. @end table -When Emacs first visits an Org file, the global state is set to -@code{showeverything}, i.e., all file content is visible. This can be -configured through the variable @code{org-startup-folded}, or on a per-file -basis by adding a @samp{STARTUP} keyword to @samp{overview}, @samp{content}, -@samp{showall}, @samp{showeverything} or @samp{showlevels} (n = 2..5) like this: +When Emacs first visits an Org file@comma{} the global state is set to +@code{showeverything}@comma{} i.e.@comma{} all file content is visible. This can be +configured through the variable @code{org-startup-folded}@comma{} or on a per-file +basis by adding a @samp{STARTUP} keyword to @samp{overview}@comma{} @samp{content}@comma{} +@samp{showall}@comma{} @samp{showeverything} or @samp{showlevels} (n = 2..5) like this: @example #+STARTUP: content @@ -328,50 +325,46 @@ level heading. @table @asis @item @kbd{M-@key{RET}} (@code{org-meta-return}) Insert new heading with same level as current. If point is in -a plain list item, a new item is created (see @ref{Plain Lists}). When -this command is used in the middle of a line, the line is split and -the rest of the line becomes the new headline@footnote{If you do not want the line to be split, customize the variable +a plain list item@comma{} a new item is created (see @ref{Plain Lists}). When +this command is used in the middle of a line@comma{} the line is split and +the rest of the line becomes the new headline@footnote{If you do not want the line to be split@comma{} customize the variable @code{org-M-RET-may-split-line}.}. @item @kbd{M-S-@key{RET}} (@code{org-insert-todo-heading}) Insert new TODO entry with same level as current heading. -@item @kbd{@key{TAB}} (@code{org-cycle}) in new -@itemx empty entry -In a new entry with no text yet, @kbd{@key{TAB}} cycles through +@item @kbd{@key{TAB}} (@code{org-cycle}) in new@comma{} empty entry +In a new entry with no text yet@comma{} @kbd{@key{TAB}} cycles through reasonable levels. -@item @kbd{M-@key{LEFT}} (@code{org-metaleft}) -@itemx @kbd{M-@key{RIGHT}} (@code{org-metaright}) +@item @kbd{M-@key{LEFT}} (@code{org-metaleft})@comma{} @kbd{M-@key{RIGHT}} (@code{org-metaright}) Promote or demote current heading by one level. -@item @kbd{M-@key{UP}} (@code{org-move-subtree-up}) -@itemx @kbd{M-@key{DOWN}} (@code{org-move-subtree-down}) -Move subtree up or down, i.e., swap with previous or next subtree of +@item @kbd{M-@key{UP}} (@code{org-move-subtree-up})@comma{} @kbd{M-@key{DOWN}} (@code{org-move-subtree-down}) +Move subtree up or down@comma{} i.e.@comma{} swap with previous or next subtree of same level. @item @kbd{C-c C-w} (@code{org-refile}) Refile entry or region to a different location. See @ref{Refile and Copy}. -@item @kbd{C-x n s} (@code{org-narrow-to-subtree}) -@itemx @kbd{C-x n w} (@code{widen}) +@item @kbd{C-x n s} (@code{org-narrow-to-subtree})@comma{} @kbd{C-x n w} (@code{widen}) Narrow buffer to current subtree and widen it again. @end table -When there is an active region (Transient Mark mode), promotion and +When there is an active region (Transient Mark mode)@comma{} promotion and demotion work on all headlines in the region. @node Sparse Trees @section Sparse Trees 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 +trees} for selected information in an outline tree@comma{} so that the entire +document is folded as much as possible@comma{} but the selected information +is made visible along with the headline structure above it@footnote{See also the variable @code{org-fold-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 +Org mode contains several commands creating such trees@comma{} all these commands can be accessed through a dispatcher: @table @asis @@ -385,26 +378,26 @@ matches. Each match is also highlighted; the highlights disappear by pressing @kbd{C-c C-c}. The other sparse tree commands select headings based on TODO -keywords, tags, or properties and will be discussed later in this +keywords@comma{} tags@comma{} or properties and will be discussed later in this manual. @end table @node Plain Lists @section Plain Lists -Within an entry of the outline tree, hand-formatted lists can provide +Within an entry of the outline tree@comma{} 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 +checkboxes (see @ref{Checkboxes}). Org supports editing such lists@comma{} and every exporter (see @ref{Exporting}) can parse and format them. -Org knows ordered lists, unordered lists, and description lists. +Org knows ordered lists@comma{} unordered lists@comma{} and description lists. @itemize @item -@emph{Unordered} list items start with @samp{-}, @samp{+}, or @samp{*} as bullets. +@emph{Unordered} list items start with @samp{-}@comma{} @samp{+}@comma{} or @samp{*} as bullets. @item -@emph{Ordered} list items start with @samp{1.}, or @samp{1)}. +@emph{Ordered} list items start with @samp{1.}@comma{} or @samp{1)}. @item @emph{Description} list use @samp{::} to separate the @emph{term} from the @@ -413,7 +406,7 @@ description. Items belonging to the same list must have the same indentation on the first line. An item ends before the next line that is indented like -its bullet/number, or less. A list ends when all items are closed, or +its bullet/number@comma{} or less. A list ends when all items are closed@comma{} or before two blank lines. An example: @example @@ -425,7 +418,7 @@ before two blank lines. An example: + I really like Miranda Otto. Important actors in this film are: - Elijah Wood :: He plays Frodo - - Sean Astin :: He plays Sam, Frodo's friend. + - Sean Astin :: He plays Sam@comma{} Frodo's friend. @end example The following commands act on items when point is in the first line of @@ -436,35 +429,32 @@ an item (the line with the bullet or number). Items can be folded just like headline levels. @item @kbd{M-@key{RET}} (@code{org-insert-heading}) -Insert new item at current level. With a prefix argument, force +Insert new item at current level. With a prefix argument@comma{} force a new heading (see @ref{Structure Editing}). @item @kbd{M-S-@key{RET}} (@code{org-insert-todo-heading}) Insert a new item with a checkbox (see @ref{Checkboxes}). -@item @kbd{M-@key{UP}} (@code{org-move-item-up}) -@itemx @kbd{M-@key{DOWN}} (@code{org-move-item-down}) +@item @kbd{M-@key{UP}} (@code{org-move-item-up})@comma{} @kbd{M-@key{DOWN}} (@code{org-move-item-down}) Move the item including subitems up/down (swap with previous/next -item of same indentation). If the list is ordered, renumbering is +item of same indentation). If the list is ordered@comma{} renumbering is automatic. -@item @kbd{M-@key{LEFT}} (@code{org-do-promote}) -@itemx @kbd{M-@key{RIGHT}} (@code{org-do-demote}) -Decrease/increase the indentation of an item, leaving children +@item @kbd{M-@key{LEFT}} (@code{org-do-promote})@comma{} @kbd{M-@key{RIGHT}} (@code{org-do-demote}) +Decrease/increase the indentation of an item@comma{} leaving children alone. -@item @kbd{M-S-@key{LEFT}} (@code{org-promote-subtree}) -@itemx @kbd{M-S-@key{RIGHT}} (@code{org-demote-subtree}) -Decrease/increase the indentation of the item, including subitems. +@item @kbd{M-S-@key{LEFT}} (@code{org-promote-subtree})@comma{} @kbd{M-S-@key{RIGHT}} (@code{org-demote-subtree}) +Decrease/increase the indentation of the item@comma{} including subitems. @item @kbd{C-c C-c} (@code{org-toggle-checkbox}) -If there is a checkbox (see @ref{Checkboxes}) in the item line, toggle +If there is a checkbox (see @ref{Checkboxes}) in the item line@comma{} toggle the state of the checkbox. Also verify bullets and indentation consistency in the whole list. @item @kbd{C-c -} (@code{org-cycle-list-bullet}) Cycle the entire list level through the different itemize/enumerate -bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). +bullets (@samp{-}@comma{} @samp{+}@comma{} @samp{*}@comma{} @samp{1.}@comma{} @samp{1)}). @end table @node Tables @@ -492,24 +482,23 @@ 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. Any line starting with @samp{|-} is considered as a horizontal separator line and will be expanded on the next re-align to span the -whole table width. So, to create the above table, you would only type +whole table width. So@comma{} to create the above table@comma{} 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{@key{DEL}}, -@kbd{Backspace}, and all character keys in a special way, so that -inserting and deleting avoids shifting other fields. Also, when +When typing text into a field@comma{} Org treats @kbd{@key{DEL}}@comma{} +@kbd{Backspace}@comma{} and all character keys in a special way@comma{} so that +inserting and deleting avoids shifting other fields. Also@comma{} 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 +@kbd{@key{TAB}}@comma{} @kbd{S-@key{TAB}} or @kbd{@key{RET}}}@comma{} the field is automatically made blank. @anchor{Creation and conversion} @@ -518,13 +507,13 @@ automatically made blank. @table @asis @item @kbd{C-c |} (@code{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 +one @kbd{@key{TAB}} character@comma{} the function assumes that the material +is tab separated. If every line contains a comma@comma{} comma-separated +values (CSV) are assumed. If not@comma{} lines are split at whitespace into fields. -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}}. +If there is no active region@comma{} this command creates an empty Org +table. But it is easier just to start typing@comma{} 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} @@ -535,21 +524,18 @@ table. But it is easier just to start typing, like @kbd{| N a m e | P h o n e | Re-align the table without moving point. @item @kbd{@key{TAB}} (@code{org-table-next-field}) -Re-align the table, move to the next field. Creates a new row if +Re-align the table@comma{} move to the next field. Creates a new row if necessary. @item @kbd{S-@key{TAB}} (@code{org-table-previous-field}) -Re-align, move to previous field. +Re-align@comma{} move to previous field. @item @kbd{@key{RET}} (@code{org-table-next-row}) Re-align the table and move down to next row. Creates a new row if necessary. -@item @kbd{S-@key{UP}} (@code{org-table-move-cell-up}) -@itemx @kbd{S-@key{DOWN}} (@code{org-table-move-cell-down}) -@itemx @kbd{S-@key{LEFT}} (@code{org-table-move-cell-left}) -@itemx @kbd{S-@key{RIGHT}} (@code{org-table-move-cell-right}) -Move a cell up, down, left, and right by swapping with adjacent +@item @kbd{S-@key{UP}} (@code{org-table-move-cell-up})@comma{} @kbd{S-@key{DOWN}} (@code{org-table-move-cell-down})@comma{} @kbd{S-@key{LEFT}} (@code{org-table-move-cell-left})@comma{} @kbd{S-@key{RIGHT}} (@code{org-table-move-cell-right}) +Move a cell up@comma{} down@comma{} left@comma{} and right by swapping with adjacent cell. @end table @@ -557,7 +543,7 @@ cell. @heading Column and row editing @table @asis -@item @kbd{M-@key{LEFT}} (@code{org-table-move-column-left}), @kbd{M-@key{RIGHT}} (@code{org-table-move-column-right}) +@item @kbd{M-@key{LEFT}} (@code{org-table-move-column-left})@comma{} @kbd{M-@key{RIGHT}} (@code{org-table-move-column-right}) Move the current column left/right. @item @kbd{M-S-@key{LEFT}} (@code{org-table-delete-column}) @@ -566,46 +552,45 @@ Kill the current column. @item @kbd{M-S-@key{RIGHT}} (@code{org-table-insert-column}) Insert a new column to the left of point position. -@item @kbd{M-@key{UP}} (@code{org-table-move-row-up}), @kbd{M-@key{DOWN}} (@code{org-table-move-row-down}) +@item @kbd{M-@key{UP}} (@code{org-table-move-row-up})@comma{} @kbd{M-@key{DOWN}} (@code{org-table-move-row-down}) Move the current row up/down. @item @kbd{M-S-@key{UP}} (@code{org-table-kill-row}) Kill the current row or horizontal line. @item @kbd{M-S-@key{DOWN}} (@code{org-table-insert-row}) -Insert a new row above the current row. With a prefix argument, the +Insert a new row above the current row. With a prefix argument@comma{} the line is created below the current one. @item @kbd{C-c -} (@code{org-table-insert-hline}) -Insert a horizontal line below current row. With a prefix argument, +Insert a horizontal line below current row. With a prefix argument@comma{} the line is created above the current line. @item @kbd{C-c @key{RET}} (@code{org-table-hline-and-move}) -Insert a horizontal line below current row, and move the point into +Insert a horizontal line below current row@comma{} and move the point into the row below that line. @item @kbd{C-c ^} (@code{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 +the column to be used for sorting@comma{} and the range of lines is the +range between the nearest horizontal separator lines@comma{} or the entire table. @end table @node Hyperlinks @chapter Hyperlinks -Like HTML, Org provides links inside a file, external links to other -files, Usenet articles, emails, and much more. +Like HTML@comma{} Org provides links inside a file@comma{} external links to other +files@comma{} Usenet articles@comma{} emails@comma{} and much more. -Org recognizes plain URIs, possibly wrapped within angle brackets, and -activate them as clickable links. The general link format, however, +Org recognizes plain URIs@comma{} possibly wrapped within angle brackets@comma{} and +activate them as clickable links. The general link format@comma{} however@comma{} looks like this: @example [[LINK][DESCRIPTION]] @end example - @noindent or alternatively @@ -613,29 +598,28 @@ or alternatively [[LINK]] @end example - -Once a link in the buffer is complete, with all brackets present, Org +Once a link in the buffer is complete@comma{} with all brackets present@comma{} Org changes the display so that @samp{DESCRIPTION} is displayed instead of @samp{[[LINK][DESCRIPTION]]} and @samp{LINK} is displayed instead of @samp{[[LINK]]}. -To edit the invisible @var{LINK} part, use @kbd{C-c C-l} +To edit the invisible @var{LINK} part@comma{} use @kbd{C-c C-l} with the point on the link. @anchor{Internal links} @heading Internal links -If the link does not look like a URL, it is considered to be internal +If the link does not look like a URL@comma{} it is considered to be internal in the current file. The most important case is a link like @samp{[[#my-custom-id]]} which links to the entry with the @samp{CUSTOM_ID} property @samp{my-custom-id}. Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]} lead -to a text search in the current file for the corresponding target, +to a text search in the current file for the corresponding target@comma{} which looks like @samp{<>}. @anchor{External Links} @heading External Links -Org supports links to files, websites, Usenet and email messages, BBDB +Org supports links to files@comma{} websites@comma{} Usenet and email messages@comma{} 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 @@ -645,11 +629,11 @@ the colon. Here are some examples: @item @samp{http://www.astro.uva.nl/=dominik} @tab on the web @item @samp{file:/home/dominik/images/jupiter.jpg} -@tab file, absolute path +@tab file@comma{} absolute path @item @samp{/home/dominik/images/jupiter.jpg} @tab same as above @item @samp{file:papers/last.pdf} -@tab file, relative path +@tab file@comma{} relative path @item @samp{./papers/last.pdf} @tab same as above @item @samp{file:projects.org} @@ -679,7 +663,7 @@ the colon. Here are some examples: 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. Here are a few -examples,, together with an explanation: +examples@comma{} together with an explanation: @multitable {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{file:~/code/main.c::255} @@ -693,29 +677,29 @@ examples,, together with an explanation: @anchor{Handling Links} @heading Handling Links -Org provides methods to create a link in the correct syntax, to insert -it into an Org file, and to follow the link. +Org provides methods to create a link in the correct syntax@comma{} to insert +it into an Org file@comma{} and to follow the link. -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 +The main function is @code{org-store-link}@comma{} called with @kbd{M-x org-store-link}. Because of its importance@comma{} 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. -From an Org buffer, the following commands create, navigate or, more -generally, act on links. +From an Org buffer@comma{} the following commands create@comma{} navigate or@comma{} more +generally@comma{} act on links. @table @asis @item @kbd{C-c C-l} (@code{org-insert-link}) Insert a link. This prompts for a link to be inserted into the -buffer. You can just type a link, or use history keys @kbd{@key{UP}} +buffer. You can just type a link@comma{} or use history keys @kbd{@key{UP}} and @kbd{@key{DOWN}} to access stored links. You will be prompted for the description part of the link. -When called with a @kbd{C-u} prefix argument, file name +When called with a @kbd{C-u} prefix argument@comma{} file name completion is used to link to a file. @item @kbd{C-c C-l} (with point on existing link) (@code{org-insert-link}) -When point is on an existing link, @kbd{C-c C-l} allows you to +When point is on an existing link@comma{} @kbd{C-c C-l} allows you to edit the link and description parts of the link. @item @kbd{C-c C-o} (@code{open-link-at-point}) @@ -723,7 +707,7 @@ Open link at point. @item @kbd{C-c &} (@code{org-mark-ring-goto}) Jump back to a recorded position. A position is recorded by the -commands following internal links, and by @kbd{C-c %}. Using +commands following internal links@comma{} and by @kbd{C-c %}. Using this command several times in direct succession moves through a ring of previously recorded positions. @end table @@ -732,14 +716,14 @@ of previously recorded positions. @chapter TODO Items Org mode does not require TODO lists to live in separate documents. -Instead, TODO items are part of a 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 TODO items remain in the context from which they +Instead@comma{} TODO items are part of a notes file@comma{} because TODO items +usually come up while taking notes! With Org mode@comma{} simply mark any +entry in a tree as being a TODO item. In this way@comma{} information is not +duplicated@comma{} and TODO items remain in the context from which they emerged. Org mode provides methods to give you an overview of all the things -that you have to do, collected from many files. +that you have to do@comma{} collected from many files. @menu * TODO Basics:: Marking and displaying TODO entries. @@ -753,14 +737,13 @@ that you have to do, collected from many files. @node TODO Basics @section Basic TODO Functionality -Any headline becomes a TODO item when it starts with the word @samp{TODO}, +Any headline becomes a TODO item when it starts with the word @samp{TODO}@comma{} for example: @example *** TODO Write letter to Sam Fortune @end example - The most important commands to work with TODO entries are: @table @asis @@ -768,27 +751,25 @@ The most important commands to work with TODO entries are: Rotate the TODO state of the current item among @example -,-> (unmarked) -> TODO -> DONE --. +@comma{}-> (unmarked) -> TODO -> DONE --. '--------------------------------' @end example - The same rotation can also be done ``remotely'' from the agenda buffer with the @kbd{t} command key (see @ref{Agenda Commands}). -@item @kbd{S-@key{RIGHT}} (@code{org-shiftright}) -@itemx @kbd{S-@key{LEFT}} (@code{org-shiftleft}) -Select the following/preceding TODO state, similar to cycling. +@item @kbd{S-@key{RIGHT}} (@code{org-shiftright})@comma{} @kbd{S-@key{LEFT}} (@code{org-shiftleft}) +Select the following/preceding TODO state@comma{} similar to cycling. @item @kbd{C-c / t} (@code{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 +entire buffer@comma{} but shows all TODO items---with not-DONE state---and the headings hierarchy above them. @item @kbd{M-x org-agenda t} (@code{org-todo-list}) 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. See @ref{Global TODO List}, for more information. +buffer. See @ref{Global TODO List}@comma{} for more information. @item @kbd{S-M-@key{RET}} (@code{org-insert-todo-heading}) Insert a new TODO entry below the current one. @@ -811,13 +792,13 @@ states: @noindent The vertical bar separates the @samp{TODO} keywords (states that @emph{need action}) from the @samp{DONE} states (which need @emph{no further action}). If -you do not provide the separator bar, the last state is used as the -@samp{DONE} state. 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 +you do not provide the separator bar@comma{} the last state is used as the +@samp{DONE} state. With this setup@comma{} the command @kbd{C-c C-t} cycles +an entry from @samp{TODO} to @samp{FEEDBACK}@comma{} then to @samp{VERIFY}@comma{} and finally to @samp{DONE} and @samp{DELEGATED}. Sometimes you may want to use different sets of TODO keywords in -parallel. For example, you may want to have the basic @samp{TODO=/=DONE}, +parallel. For example@comma{} you may want to have the basic @samp{TODO=/=DONE}@comma{} but also a workflow for bug fixing. Your setup would then look like this: @@ -828,13 +809,13 @@ this: @end lisp @noindent -The keywords should all be different, this helps Org mode to keep +The keywords should all be different@comma{} this helps Org mode to keep track of which subsequence should be used for a given entry. The example also shows how to define keys for fast access of a particular -state, by adding a letter in parenthesis after each keyword---you will +state@comma{} by adding a letter in parenthesis after each keyword---you will be prompted for the key after @kbd{C-c C-t}. -To define TODO keywords that are valid only in a single file, use the +To define TODO keywords that are valid only in a single file@comma{} use the following text anywhere in the file. @example @@ -843,26 +824,26 @@ following text anywhere in the file. #+TODO: | CANCELED(c) @end example -After changing one of these lines, use @kbd{C-c C-c} with the +After changing one of these lines@comma{} use @kbd{C-c C-c} with the cursor still in the line to make the changes known to Org mode. @node Progress Logging @section Progress Logging -To record a timestamp and a note when changing a TODO state, call the +To record a timestamp and a note when changing a TODO state@comma{} call the command @code{org-todo} with a prefix argument. @table @asis @item @kbd{C-u C-c C-t} (@code{org-todo}) -Prompt for a note and record a the time of the TODO state change. +Prompt for a note and record the time of the TODO state change. @end table Org mode can also 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, +note when you mark a TODO item as DONE@comma{} or even each time you change +the state of a TODO item. This system is highly configurable@comma{} 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}. +task@comma{} see @ref{Clocking Work Time}. @anchor{Closing items} @subheading Closing items @@ -876,10 +857,10 @@ was marked as done. This can be achieved with@footnote{The corresponding in-buf @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 +of the DONE states@comma{} a line @samp{CLOSED: [timestamp]} is inserted just after the headline. -If you want to record a note along with the timestamp, use@footnote{The corresponding in-buffer setting is @samp{#+STARTUP: +If you want to record a note along with the timestamp@comma{} use@footnote{The corresponding in-buffer setting is @samp{#+STARTUP: logenotedone}.} @lisp @@ -887,20 +868,20 @@ logenotedone}.} @end lisp @noindent -You are then be prompted for a note, and that note is stored below the +You are then be prompted for a note@comma{} and that note is stored below the entry with a @samp{Closing Note} heading. @anchor{Tracking TODO state changes} @subheading Tracking TODO state changes You might want to keep track of TODO state changes. You can either -record just a timestamp, or a time-stamped note for a change. These +record just a timestamp@comma{} or a time-stamped note for a change. These records are inserted after the headline as an itemized list. When -taking a lot of notes, you might want to get the notes out of the way +taking a lot of notes@comma{} you might want to get the notes out of the way into a drawer. Customize the variable @code{org-log-into-drawer} to get this behavior. -For state logging, Org mode expects configuration on a per-keyword +For state logging@comma{} Org mode expects configuration on a per-keyword basis. This is achieved by adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note) in parentheses after each keyword. For example: @@ -909,34 +890,32 @@ For example: #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) @end example - @noindent -defines TODO keywords and fast access keys, and also request that -a time is recorded when the entry is set to @samp{DONE}, and that a note is +defines TODO keywords and fast access keys@comma{} and also request that +a time is recorded when the entry is set to @samp{DONE}@comma{} and that a note is recorded when switching to @samp{WAIT} or @samp{CANCELED}. The same syntax works also when setting @code{org-todo-keywords}. @node Priorities @section Priorities -If you use Org mode extensively, you may end up with enough TODO items +If you use Org mode extensively@comma{} 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, +done by placing a @emph{priority cookie} into the headline of a TODO item@comma{} like this @example *** TODO [#A] Write letter to Sam Fortune @end example - -Org mode supports three priorities: @samp{A}, @samp{B}, and @samp{C}. @samp{A} is the -highest, @samp{B} the default if none is given. Priorities make +Org mode supports three priorities: @samp{A}@comma{} @samp{B}@comma{} and @samp{C}. @samp{A} is the +highest@comma{} @samp{B} the default if none is given. Priorities make a difference only in the agenda. @table @asis -@item @kbd{C-c ,} (@code{org-priority}) -Set the priority of the current headline. Press @kbd{A}, -@kbd{B} or @kbd{C} to select a priority, or @kbd{@key{SPC}} +@item @kbd{C-c @comma{}} (@code{org-priority}) +Set the priority of the current headline. Press @kbd{A}@comma{} +@kbd{B} or @kbd{C} to select a priority@comma{} or @kbd{@key{SPC}} to remove the cookie. @item @kbd{S-@key{UP}} (@code{org-priority-up}) @@ -947,12 +926,12 @@ Increase/decrease the priority of the current headline. @node Breaking Down Tasks @section Breaking Tasks Down into Subtasks -It is often advisable to break down large tasks into smaller, +It is often advisable to break down large tasks into smaller@comma{} manageable subtasks. You can do this by creating an outline tree -below a TODO item, with detailed subtasks on the tree. To keep an +below a TODO item@comma{} with detailed subtasks on the tree. 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 +as done@comma{} insert either @samp{[/]} or @samp{[%]} anywhere in the headline. These +cookies are updated each time the TODO status of a child changes@comma{} or when pressing @kbd{C-c C-c} on the cookie. For example: @example @@ -969,7 +948,7 @@ when pressing @kbd{C-c C-c} on the cookie. For example: Every item in a plain list (see @ref{Plain Lists}) can be made into a checkbox by starting it with the string @samp{[ ]}. Checkboxes are not -included into the global TODO list, so they are often great to split +included into the global TODO list@comma{} so they are often great to split a task into a number of simple steps. Here is an example of a checkbox list. @@ -982,15 +961,15 @@ Here is an example of a checkbox list. - [X] order food @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 +Checkboxes work hierarchically@comma{} so if a checkbox item has children +that are checkboxes@comma{} toggling one of the children checkboxes makes the +parent checkbox reflect if none@comma{} some@comma{} or all of the children are checked. The following commands work with checkboxes: @table @asis -@item @kbd{C-c C-c}, @kbd{C-u C-c C-c} (@code{org-toggle-checkbox}) +@item @kbd{C-c C-c}@comma{} @kbd{C-u C-c C-c} (@code{org-toggle-checkbox}) Toggle checkbox status or---with prefix argument---checkbox presence at point. @@ -1007,17 +986,18 @@ cross-correlating information is to assign @emph{tags} to headlines. Org mode has extensive support for tags. 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. +the headline. Tags are normal words containing letters@comma{} numbers@comma{} @samp{_}@comma{} +@samp{@@}@comma{} @samp{#}@comma{} and @samp{%}. Tags must be preceded and followed by a single +colon@comma{} e.g.@comma{} @samp{:work:}. Several tags can be specified@comma{} as in +@samp{:work:urgent:}. Tags by default are in bold face with the same color +as the headline. @anchor{Tag inheritance} @heading Tag inheritance 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 +a heading has a certain tag@comma{} all subheadings inherit the tag as well. +For example@comma{} in the list @example * Meeting with the French group :work: @@ -1026,13 +1006,13 @@ For example, in the list @end example @noindent -the final heading has the tags @samp{work}, @samp{boss}, @samp{notes}, and @samp{action} +the final heading has the tags @samp{work}@comma{} @samp{boss}@comma{} @samp{notes}@comma{} 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.}: +surrounds the entire file. Use a line like this@footnote{As with all these in-buffer settings@comma{} pressing @kbd{C-c C-c} activates any changes in the line.}: @example #+FILETAGS: :Peter:Boss:Secret: @@ -1042,38 +1022,37 @@ surrounds the entire file. Use a line like this@footnote{As with all these in-b @heading Setting tags 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 +After a colon@comma{} @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}) Enter new tags for the current headline. Org mode either offers -completion or a special single-key interface for setting tags, see +completion or a special single-key interface for setting tags@comma{} see below. @item @kbd{C-c C-c} (@code{org-set-tags-command}) -When point is in a headline, this does the same as @kbd{C-c C-q}. +When point is in a headline@comma{} this does the same as @kbd{C-c C-q}. @end table Org supports tag insertion based on a @emph{list of tags}. By default this -list is constructed dynamically, containing all tags currently used in +list is constructed dynamically@comma{} containing all tags currently used in the buffer. 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 +for a given file using the @samp{TAGS} keyword@comma{} like @example #+TAGS: @@work @@home @@tennisclub #+TAGS: laptop car pc sailboat @end example - By default Org mode uses the standard minibuffer completion facilities -for entering tags. However, it also implements another, quicker, tag +for entering tags. However@comma{} it also implements another@comma{} quicker@comma{} 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 +@code{org-tag-alist} in your Emacs init file. For example@comma{} you may find the need to tag many items in different files with @samp{@@home}. In this case you can set something like: @@ -1081,7 +1060,7 @@ case you can set something like: (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 +If the tag is only relevant to the file you are working on@comma{} then you can instead set the @samp{TAGS} keyword as: @example @@ -1101,22 +1080,20 @@ the group tag and its related tags: #+TAGS: [ GTD : Control Persp ] @end example - @noindent -or, if tags in the group should be mutually exclusive: +or@comma{} if tags in the group should be mutually exclusive: @example #+TAGS: @{ Context : @@Home @@Work @} @end example - -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 +When you search for a group tag@comma{} it returns matches for all members in +the group and its subgroups. In an agenda view@comma{} filtering by a group +tag displays or hides headlines tagged with at least one of the members of the group or any of its subgroups. -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 ignore group tags temporarily@comma{} toggle group tags +support with @code{org-toggle-tags-groups}@comma{} bound to @kbd{C-c C-x q}. @anchor{Tag searches} @heading Tag searches @@ -1124,7 +1101,7 @@ support with @code{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. @table @asis @item @kbd{C-c / m} or @kbd{C-c \} (@code{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 +With a @kbd{C-u} prefix argument@comma{} ignore headlines that are not a TODO line. @item @kbd{M-x org-agenda m} (@code{org-tags-view}) @@ -1132,24 +1109,24 @@ 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}) -Create a global list of tag matches from all agenda files, but check +Create a global list of tag matches from all agenda files@comma{} but check only TODO items. @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 +Boolean logic like @samp{+boss+urgent-project1}@comma{} to find entries with tags +@samp{boss} and @samp{urgent}@comma{} but not @samp{project1}@comma{} or @samp{Kathy|Sally} to find +entries which are tagged@comma{} 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 more detailed description -with many examples, see @ref{Matching Tags and Properties}. +keywords@comma{} entry levels and properties. For a more detailed description +with many examples@comma{} see @ref{Matching Tags and Properties}. @node Properties @chapter Properties Properties are key-value pairs associated with an entry. They live in a special drawer with the name @samp{PROPERTIES}. Each property is -specified on a single line, with the key (surrounded by colons) first, +specified on a single line@comma{} with the key (surrounded by colons) first@comma{} and the value after it: @example @@ -1165,11 +1142,11 @@ and the value after it: @end example 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 +setting a property @samp{Xyz_ALL}. This special property is @emph{inherited}@comma{} +so if you set it in a level 1 entry@comma{} it applies to the entire tree. +When allowed values are defined@comma{} 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 +with the CD collection@comma{} we can pre-define publishers and the number of disks in a box like this: @example @@ -1181,13 +1158,12 @@ disks in a box like this: @end example If you want to set properties that can be inherited by any entry in -a file, use a line like: +a file@comma{} use a line like: @example #+PROPERTY: NDisks_ALL 1 2 3 4 @end example - The following commands help to work with properties: @table @asis @@ -1199,21 +1175,21 @@ Remove a property from the current entry. @end table To create sparse trees and special lists with selection based on -properties, the same commands are used as for tag searches (see +properties@comma{} the same commands are used as for tag searches (see @ref{Tags}). The syntax for the search string is described in @ref{Matching Tags and Properties}. @node Dates and Times @chapter Dates and Times -To assist project planning, TODO items can be labeled with a date +To assist project planning@comma{} 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 +something was created or last changed. However@comma{} in Org mode this term is used in a much wider sense. -Timestamps can be used to plan appointments, schedule tasks, set -deadlines, track time, and more. The following sections describe +Timestamps can be used to plan appointments@comma{} schedule tasks@comma{} set +deadlines@comma{} track time@comma{} and more. The following sections describe the timestamp format and tooling that Org mode provides for common use cases dealing with time and time intervals. @@ -1228,7 +1204,7 @@ use cases dealing with time and time intervals. @section Timestamps 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 +a range of times---in a special format@comma{} either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue 12:00-12:30>}. 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 @@ -1251,9 +1227,9 @@ There can be multiple timestamps in an item. @end example @item 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 hours (h), days (d), weeks (w), months (m), +A timestamp may contain a @emph{repeater interval}@comma{} indicating that it +applies not only on the given date@comma{} but again and again after +a certain interval of N hours (h)@comma{} days (d)@comma{} weeks (w)@comma{} months (m)@comma{} or years (y). The following shows up in the agenda every Wednesday: @example @@ -1262,9 +1238,9 @@ or years (y). The following shows up in the agenda every Wednesday: @end example @item Diary-style expression entries -For more complex date specifications, Org mode supports using the +For more complex date specifications@comma{} Org mode supports using the special expression diary entries implemented in the Emacs Calendar -package. For example, with optional time: +package. For example@comma{} with optional time: @example * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month @@ -1280,8 +1256,8 @@ Time range is a timestamp having two time units connected by @samp{-} @end example @item Time/Date range -Two timestamps connected by @samp{--} denote a range. In the agenda, the -headline is shown on the first and last day of the range, and on any +Two timestamps connected by @samp{--} denote a range. In the agenda@comma{} the +headline is shown on the first and last day of the range@comma{} and on any dates that are displayed and fall in the range. The first example specifies just the dates of the range while the second example specifies a time range for each date. @@ -1294,7 +1270,7 @@ specifies a time range for each date. @end example @item Inactive timestamp -Just like a plain timestamp, but with square brackets instead of +Just like a plain timestamp@comma{} 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. @@ -1307,40 +1283,38 @@ do @emph{not} trigger an entry to show up in the agenda. @node Creating Timestamps @section Creating Timestamps -For Org mode to recognize timestamps, they need to be in the specific +For Org mode to recognize timestamps@comma{} 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-timestamp}) Prompt for a date and insert a corresponding timestamp. When point -is at an existing timestamp in the buffer, the command is used to +is at an existing timestamp in the buffer@comma{} 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. With -a prefix argument, it also adds the current time. +command is used twice in succession@comma{} a time range is inserted. With +a prefix argument@comma{} it also adds the current time. @item @kbd{C-c !} (@code{org-timestamp-inactive}) -Like @kbd{C-c .}, but insert an inactive timestamp that does +Like @kbd{C-c .}@comma{} but insert an inactive timestamp that does not cause an agenda entry. -@item @kbd{S-@key{LEFT}} (@code{org-timestamp-down-day}) -@itemx @kbd{S-@key{RIGHT}} (@code{org-timestamp-up-day}) +@item @kbd{S-@key{LEFT}} (@code{org-timestamp-down-day})@comma{} @kbd{S-@key{RIGHT}} (@code{org-timestamp-up-day}) Change date at point by one day. -@item @kbd{S-@key{UP}} (@code{org-timestamp-up}) -@itemx @kbd{S-@key{DOWN}} (@code{org-timestamp-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. +@item @kbd{S-@key{UP}} (@code{org-timestamp-up})@comma{} @kbd{S-@key{DOWN}} (@code{org-timestamp-down}) +On the beginning or enclosing bracket of a timestamp@comma{} change its +type. Within a timestamp@comma{} change the item under point. Point can +be on a year@comma{} month@comma{} day@comma{} hour or minute. When the timestamp +contains a time range like @samp{15:30-16:30}@comma{} modifying the first time +also shifts the second@comma{} shifting the time block with constant +length. To change the length@comma{} modify the second time. @end table -When Org mode prompts for a date/time, it accepts any string -containing some date and/or time information, and intelligently -interprets the string, deriving defaults for unspecified information +When Org mode prompts for a date/time@comma{} it accepts any string +containing some date and/or time information@comma{} and intelligently +interprets the string@comma{} deriving defaults for unspecified information from the current date and time. You can also select a date in the pop-up calendar. See the @ref{Top,manual,,org,} for more information on how exactly the date/time prompt works. @@ -1353,16 +1327,16 @@ planning: @table @asis @item @kbd{C-c C-d} (@code{org-deadline}) -Insert @samp{DEADLINE} keyword along with a time stamp, in the line +Insert @samp{DEADLINE} keyword along with a time stamp@comma{} in the line following the headline. -Meaning: the task---most likely a TODO item, though not +Meaning: the task---most likely a TODO item@comma{} though not necessarily---is supposed to be finished on that date. -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 +On the deadline date@comma{} the task is listed in the agenda. In +addition@comma{} the agenda for @emph{today} carries a warning about the +approaching or missed deadline@comma{} starting @code{org-deadline-warning-days} +before the due date@comma{} and continuing until the entry is marked as done. An example: @example @@ -1372,19 +1346,19 @@ done. An example: @end example @item @kbd{C-c C-s} (@code{org-schedule}) -Insert @samp{SCHEDULED} keyword along with a stamp, in the line following +Insert @samp{SCHEDULED} keyword along with a stamp@comma{} in the line following the headline. Meaning: you are planning to start working on that task on the given date@footnote{This is quite different from what is normally understood by -@emph{scheduling a meeting}, which is done in Org by just inserting a time +@emph{scheduling a meeting}@comma{} which is done in Org by just inserting a time stamp without keyword.}. 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, +as done. If you do not like this@comma{} set the variable +@code{org-agenda-skip-scheduled-if-done}.}. In addition@comma{} 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., +compilation for @emph{today}@comma{} until the entry is marked as done@comma{} i.e.@comma{} the task is automatically forwarded until completed. @example @@ -1394,8 +1368,8 @@ the task is automatically forwarded until completed. @end table 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. In the following example: +organize such tasks using a so-called repeater in a @samp{DEADLINE}@comma{} +@samp{SCHEDULED}@comma{} or plain timestamps. In the following example: @example ** TODO Pay the rent @@ -1417,7 +1391,7 @@ a project. @item @kbd{C-c C-x C-i} (@code{org-clock-in}) Start the clock on the current item (clock-in). This inserts the @samp{CLOCK} keyword together with a timestamp. When called with -a @kbd{C-u} prefix argument, select the task from a list of +a @kbd{C-u} prefix argument@comma{} select the task from a list of recently clocked tasks. @item @kbd{C-c C-x C-o} (@code{org-clock-out}) @@ -1431,11 +1405,11 @@ Update the effort estimate for the current clock task. @item @kbd{C-c C-x C-q} (@code{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. +mistake@comma{} or if you ended up working on something else. @item @kbd{C-c C-x C-j} (@code{org-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 +a @kbd{C-u} prefix argument@comma{} select the target task from a list of recently clocked tasks. @end table @@ -1443,13 +1417,13 @@ The @kbd{l} key may be used in the agenda (see @ref{Built-in Agenda Views}) to s a day. @node Capture Refile Archive -@chapter Capture, Refile, Archive +@chapter Capture@comma{} Refile@comma{} Archive An important part of any organization system is the ability to quickly -capture new ideas and tasks, and to associate reference material with +capture new ideas and tasks@comma{} 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. -Once in the system, tasks and projects need to be moved around. +Once in the system@comma{} tasks and projects need to be moved around. Moving completed project trees to an archive file keeps the system compact and fast. @@ -1469,7 +1443,7 @@ them with different targets for storing notes. @anchor{Setting up capture} @subheading Setting up capture -The following customization sets a default target@footnote{Using capture templates, you get finer control over capture +The following customization sets a default target@footnote{Using capture templates@comma{} you get finer control over capture locations. See @ref{Capture templates}.} file for notes. @lisp @@ -1484,13 +1458,13 @@ You may also define a global key for capturing new material (see @table @asis @item @kbd{M-x org-capture} (@code{org-capture}) -Start a capture process, placing you into a narrowed indirect buffer +Start a capture process@comma{} placing you into a narrowed indirect buffer to edit. @item @kbd{C-c C-c} (@code{org-capture-finalize}) -Once you have finished entering information into the capture buffer, +Once you have finished entering information into the capture buffer@comma{} @kbd{C-c C-c} returns you to the window configuration before -the capture process, so that you can resume your work without +the capture process@comma{} so that you can resume your work without further distraction. @item @kbd{C-c C-w} (@code{org-capture-refile}) @@ -1504,10 +1478,10 @@ Abort the capture process and return to the previous state. @anchor{Capture templates} @subheading Capture templates -You can use templates for different types of capture items, and for +You can use templates for different types of capture items@comma{} and for different target locations. 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 +create general TODO entries@comma{} and you want to put these entries under +the heading @samp{Tasks} in your file @samp{~/org/gtd.org}. Also@comma{} a date tree in the file @samp{journal.org} should capture journal entries. A possible configuration would look like: @@ -1519,7 +1493,7 @@ configuration would look like: "* %?\nEntered on %U\n %i\n %a"))) @end lisp -If you then press @kbd{t} from the capture menu, Org will prepare +If you then press @kbd{t} from the capture menu@comma{} Org will prepare the template for you like this: @example @@ -1527,33 +1501,32 @@ the template for you like this: [[file:LINK TO WHERE YOU INITIATED CAPTURE]] @end example - @noindent -During expansion of the template, special %-escapes@footnote{If you need one of these sequences literally, escape the @samp{%} +During expansion of the template@comma{} special %-escapes@footnote{If you need one of these sequences literally@comma{} escape the @samp{%} with a backslash.} allow dynamic insertion of content. Here is a small selection of the -possibilities, consult the @ref{Top,manual,,org,} for more. +possibilities@comma{} consult the @ref{Top,manual,,org,} for more. @multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{%a} -@tab annotation, normally the link created with @code{org-store-link} +@tab annotation@comma{} normally the link created with @code{org-store-link} @item @samp{%i} -@tab initial content, the region when capture is called with @kbd{C-u} -@item @samp{%t}, @samp{%T} -@tab timestamp, date only, or date and time -@item @samp{%u}, @samp{%U} -@tab like above, but inactive timestamps +@tab initial content@comma{} the region when capture is called with @kbd{C-u} +@item @samp{%t}@comma{} @samp{%T} +@tab timestamp@comma{} date only@comma{} or date and time +@item @samp{%u}@comma{} @samp{%U} +@tab like above@comma{} but inactive timestamps @item @samp{%?} -@tab after completing the template, position point here +@tab after completing the template@comma{} position point here @end multitable @node Refile and Copy @section Refile and Copy -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 +When reviewing the captured data@comma{} you may want to refile or to copy +some of the entries into a different list@comma{} for example into a project. +Cutting@comma{} finding the right location@comma{} and then pasting the note is +cumbersome. To simplify this process@comma{} you can use the following special command: @table @asis @@ -1563,8 +1536,8 @@ 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. -By default, all level 1 headlines in the current buffer are -considered to be targets, but you can have more complex definitions +By default@comma{} all level 1 headlines in the current buffer are +considered to be targets@comma{} but you can have more complex definitions across a number of files. See the variable @code{org-refile-targets} for details. @@ -1575,20 +1548,20 @@ Use the refile interface to jump to a heading. Jump to the location where @code{org-refile} last moved a tree to. @item @kbd{C-c M-w} (@code{org-refile-copy}) -Copying works like refiling, except that the original note is not +Copying works like refiling@comma{} except that the original note is not deleted. @end table @node Archiving @section Archiving -When a project represented by a (sub)tree is finished, you may want to +When a project represented by a (sub)tree is finished@comma{} 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. The most common archiving action is to move a project tree to another -file, the archive file. +file@comma{} the archive file. @table @asis @item @kbd{C-c C-x C-a} (@code{org-archive-subtree-default}) @@ -1601,14 +1574,14 @@ by @code{org-archive-location}. @end table 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@comma{} 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. +items under@comma{} 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 +heading@comma{} see the documentation string of the variable @code{org-archive-location}. -There is also an in-buffer option for setting this variable, for +There is also an in-buffer option for setting this variable@comma{} for example: @example @@ -1618,19 +1591,19 @@ example: @node Agenda Views @chapter Agenda Views -Due to the way Org works, TODO items, time-stamped items, and tagged +Due to the way Org works@comma{} TODO items@comma{} time-stamped items@comma{} 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, +files. To get an overview of open action items@comma{} or of events that are +important for a particular date@comma{} this information must be collected@comma{} sorted and displayed in an organized way. 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. Remote editing from the agenda buffer means, -for example, that you can change the dates of deadlines and +This buffer is read-only@comma{} but provides commands to visit the +corresponding locations in the original Org files@comma{} and even to edit +these files remotely. Remote editing from the agenda buffer means@comma{} +for example@comma{} that you can change the dates of deadlines and appointments from the agenda buffer. For commands available in the -Agenda buffer, see @ref{Agenda Commands}. +Agenda buffer@comma{} see @ref{Agenda Commands}. @menu * Agenda Files:: Files being searched for agenda information. @@ -1647,27 +1620,27 @@ Agenda buffer, see @ref{Agenda Commands}. @section 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}. +files}@comma{} the files listed in the variable @code{org-agenda-files}. @table @asis @item @kbd{C-c [} (@code{org-agenda-file-to-front}) 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 +the front of the list. If it was already in the list@comma{} it is moved +to the front. With a prefix argument@comma{} file is added/moved to the end. @item @kbd{C-c ]} (@code{org-remove-file}) Remove current file from the list of agenda files. @item @kbd{C-'} -@itemx @kbd{C-,} (@code{org-cycle-agenda-files}) -Cycle through agenda file list, visiting one file after the other. +@itemx @kbd{C-@comma{}} (@code{org-cycle-agenda-files}) +Cycle through agenda file list@comma{} visiting one file after the other. @end table @node Agenda Dispatcher @section The Agenda Dispatcher -The views are created through a dispatcher, accessible with @kbd{M-x org-agenda}, or, better, bound to a global key (see @ref{Activation}). +The views are created through a dispatcher@comma{} accessible with @kbd{M-x org-agenda}@comma{} or@comma{} better@comma{} 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: @@ -1676,12 +1649,10 @@ commands: @item @kbd{a} Create the calendar-like agenda (see @ref{Built-in Agenda Views}). -@item @kbd{t} -@itemx @kbd{T} +@item @kbd{t}@comma{} @kbd{T} Create a list of all TODO items (see @ref{Global TODO List}). -@item @kbd{m} -@itemx @kbd{M} +@item @kbd{m}@comma{} @kbd{M} Create a list of headlines matching a given expression (see @ref{Matching Tags and Properties}). @@ -1696,7 +1667,7 @@ the entry. @section The Weekly/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. +a paper agenda@comma{} showing all the tasks for the current week or day. @table @asis @item @kbd{M-x org-agenda a} (@code{org-agenda-list}) @@ -1723,7 +1694,7 @@ diary expression entries directly in Org files: @end example Org can interact with Emacs appointments notification facility. To -add the appointments of your agenda files, use the command +add the appointments of your agenda files@comma{} use the command @code{org-agenda-to-appt}. @node Global TODO List @@ -1732,7 +1703,7 @@ add the appointments of your agenda files, use the command The global TODO list contains all unfinished TODO items formatted and collected into a single place. Remote editing of TODO items lets you can change the state of a TODO entry with a single key press. For -commands available in the TODO list, see @ref{Agenda Commands}. +commands available in the TODO list@comma{} see @ref{Agenda Commands}. @table @asis @item @kbd{M-x org-agenda t} (@code{org-todo-list}) @@ -1740,14 +1711,14 @@ Show the global TODO list. This collects the TODO items from all agenda files (see @ref{Agenda Views}) into a single buffer. @item @kbd{M-x org-agenda T} (@code{org-todo-list}) -Like the above, but allows selection of a specific TODO keyword. +Like the above@comma{} but allows selection of a specific TODO keyword. @end table @node Matching Tags and Properties @section Matching Tags and Properties -If headlines in the agenda files are marked with @emph{tags} (see @ref{Tags}), -or have properties (see @ref{Properties}), you can select headlines based +If headlines in the agenda files are marked with @emph{tags} (see @ref{Tags})@comma{} +or have properties (see @ref{Properties})@comma{} 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}. @@ -1755,40 +1726,40 @@ syntax described here also applies when creating sparse trees with @table @asis @item @kbd{M-x org-agenda m} (@code{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 prompts for a selection criterion@comma{} which is a boolean logic +expression with tags@comma{} like @samp{+work+urgent-withboss} or @samp{work|home} +(see @ref{Tags}). If you often need a specific search@comma{} define a custom command for it (see @ref{Agenda Dispatcher}). @item @kbd{M-x org-agenda M} (@code{org-tags-view}) -Like @kbd{m}, but only select headlines that are also TODO +Like @kbd{m}@comma{} but only select headlines that are also TODO items. @end table 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 +implemented. Each element in the search is either a tag@comma{} a regular +expression matching tags@comma{} or an expression like @samp{PROPERTY OPERATOR +VALUE} with a comparison operator@comma{} accessing a property value. Each +element may be preceded by @samp{-} to select against it@comma{} 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 +optional when @samp{+} or @samp{-} is present. Here are some examples@comma{} using only tags. @table @asis @item @samp{+work-boss} -Select headlines tagged @samp{work}, but discard those also tagged +Select headlines tagged @samp{work}@comma{} 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 +Like before@comma{} but require the @samp{laptop} lines to be tagged also @samp{night}. @end table -You may also test for properties at the same time as matching tags, +You may also test for properties at the same time as matching tags@comma{} see the @ref{Top,manual,,org,} for more information. @node Search View @@ -1805,17 +1776,17 @@ 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 +For example@comma{} the search string @samp{computer equipment} matches entries that contain @samp{computer equipment} as a substring. -Search view can also search for specific keywords in the entry, using +Search view can also search for specific keywords in the entry@comma{} 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]}, +keywords @samp{computer} and @samp{wifi}@comma{} but not the keyword @samp{ethernet}@comma{} and +which are also not matched by the regular expression @samp{8\.11[bg]}@comma{} meaning to exclude both @samp{8.11b} and @samp{8.11g}. -Note that in addition to the agenda files, this command also searches +Note that in addition to the agenda files@comma{} this command also searches the files listed in @code{org-agenda-text-search-extra-files}. @node Agenda Commands @@ -1823,9 +1794,9 @@ the files listed in @code{org-agenda-text-search-extra-files}. 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. This is just a selection of the many commands, explore +buffer itself@comma{} but commands are provided to show and jump to the +original entry location@comma{} and to edit the Org files ``remotely'' from the +agenda buffer. This is just a selection of the many commands@comma{} explore the agenda menu and the @ref{Top,manual,,org,} for a complete list. @anchor{Motion (1)} @@ -1845,7 +1816,7 @@ Previous line (same as @kbd{@key{UP}} and @kbd{C-p}). @table @asis @item @kbd{@key{SPC}} (@code{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. +With a prefix argument@comma{} make sure that drawers stay folded. @item @kbd{@key{TAB}} (@code{org-agenda-goto}) Go to the original location of the item in another window. @@ -1869,7 +1840,7 @@ Switch to week view. @item @kbd{f} (@code{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 +For example@comma{} if the display covers a week@comma{} switch to the following week. @item @kbd{b} (@code{org-agenda-earlier}) @@ -1882,22 +1853,21 @@ Go to today. Prompt for a date and go there. @item @kbd{v l} or @kbd{v L} or short @kbd{l} (@code{org-agenda-log-mode}) -Toggle Logbook mode. In Logbook mode, entries that were marked as +Toggle Logbook mode. In Logbook mode@comma{} 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. When called with a @kbd{C-u} prefix argument, show all -possible logbook entries, including state changes. +shown in the agenda@comma{} as are entries that have been clocked on that +day. When called with a @kbd{C-u} prefix argument@comma{} show all +possible logbook entries@comma{} including state changes. -@item @kbd{r} -@itemx @kbd{g} (@code{org-agenda-redo}) -Recreate the agenda buffer, for example to reflect the changes after +@item @kbd{r}@comma{} @kbd{g} (@code{org-agenda-redo}) +Recreate the agenda buffer@comma{} for example to reflect the changes after modification of the timestamps of items. @item @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 +Save all Org buffers in the current Emacs session@comma{} and also the locations of IDs. @end table @@ -1909,7 +1879,7 @@ locations of IDs. Digit argument. @item @kbd{t} (@code{org-agenda-todo}) -Change the TODO state of the item, both in the agenda and in the +Change the TODO state of the item@comma{} both in the agenda and in the original Org file. @item @kbd{C-k} (@code{org-agenda-kill}) @@ -1927,11 +1897,11 @@ default archiving command set in @code{org-archive-default-command}. Archive the subtree corresponding to the current headline. @item @kbd{C-c C-s} (@code{org-agenda-schedule}) -Schedule this item. With a prefix argument, remove the +Schedule this item. With a prefix argument@comma{} remove the scheduling timestamp @item @kbd{C-c C-d} (@code{org-agenda-deadline}) -Set a deadline for this item. With a prefix argument, remove the +Set a deadline for this item. With a prefix argument@comma{} remove the deadline. @item @kbd{S-@key{RIGHT}} (@code{org-agenda-do-date-later}) @@ -1960,10 +1930,10 @@ Jump to the running clock in another window. @table @asis @item @kbd{q} (@code{org-agenda-quit}) -Quit agenda, remove the agenda buffer. +Quit agenda@comma{} remove the agenda buffer. @item @kbd{x} (@code{org-agenda-exit}) -Exit agenda, remove the agenda buffer and all buffers loaded by +Exit agenda@comma{} remove the agenda buffer and all buffers loaded by Emacs for the compilation of the agenda. @end table @@ -1971,12 +1941,12 @@ Emacs for the compilation of the agenda. @section Custom Agenda Views 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 +shortcuts for frequently used searches@comma{} either creating an agenda +buffer@comma{} or a sparse tree (the latter covering of course only the current buffer). Custom commands are configured in the variable -@code{org-agenda-custom-commands}. You can customize this variable, for +@code{org-agenda-custom-commands}. You can customize this variable@comma{} 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: @@ -1991,7 +1961,7 @@ views: 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. The second parameter is the search -type, followed by the string or regular expression to be used for the +type@comma{} followed by the string or regular expression to be used for the matching. The example above will therefore define: @table @asis @@ -2004,7 +1974,7 @@ 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 +The same search@comma{} but limiting it to headlines that are also TODO items. @end table @@ -2012,9 +1982,9 @@ items. @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 +plain-text notes. However@comma{} it also provides a lightweight yet robust markup language for rich text formatting and more. Used in -conjunction with the export framework (see @ref{Exporting}), you can author +conjunction with the export framework (see @ref{Exporting})@comma{} you can author beautiful documents in Org. @menu @@ -2030,11 +2000,11 @@ beautiful documents in Org. @section Paragraphs 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 +enforce a line break within a paragraph@comma{} use @samp{\\} at the end of a line. -To preserve the line breaks, indentation and blank lines in a region, -but otherwise use normal formatting, you can use this construct, which +To preserve the line breaks@comma{} indentation and blank lines in a region@comma{} +but otherwise use normal formatting@comma{} you can use this construct@comma{} which can also be used to format poetry. @example @@ -2047,22 +2017,22 @@ can also be used to format poetry. #+END_VERSE @end example -When quoting a passage from another document, it is customary to +When quoting a passage from another document@comma{} 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: @example #+BEGIN_QUOTE -Everything should be made as simple as possible, +Everything should be made as simple as possible@comma{} but not any simpler ---Albert Einstein #+END_QUOTE @end example -If you would like to center some text, do it like this: +If you would like to center some text@comma{} do it like this: @example #+BEGIN_CENTER -Everything should be made as simple as possible, \\ +Everything should be made as simple as possible@comma{} \\ but not any simpler #+END_CENTER @end example @@ -2070,8 +2040,8 @@ but not any simpler @node Emphasis and Monospace @section Emphasis and Monospace -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 +You can make words @samp{*bold*}@comma{} @samp{/italic/}@comma{} @samp{_underlined_}@comma{} @samp{=verbatim=} +and @samp{~code~}@comma{} and@comma{} if you must@comma{} @samp{+strike-through+}. Text in the code and verbatim string is not processed for Org specific syntax; it is exported verbatim. @@ -2079,19 +2049,19 @@ exported verbatim. @section Embedded @LaTeX{} For scientific notes which need to be able to contain mathematical -symbols and the occasional formula, Org mode supports embedding @LaTeX{} +symbols and the occasional formula@comma{} Org mode supports embedding @LaTeX{} code into its files. You can directly use @TeX{}-like syntax for special -symbols, enter formulas and entire @LaTeX{} environments. +symbols@comma{} enter formulas and entire @LaTeX{} environments. @example -The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand, +The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand@comma{} the radius of Alpha Centauri is R_@{Alpha Centauri@} = 1.28 x R_@{sun@}. -\begin@{equation@} % arbitrary environments, -x=\sqrt@{b@} % even tables, figures +\begin@{equation@} % arbitrary environments@comma{} +x=\sqrt@{b@} % even tables@comma{} figures \end@{equation@} % etc -If $a^2=b$ and \( b=2 \), then the solution must be +If $a^2=b$ and \( b=2 \)@comma{} then the solution must be either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. @end example @@ -2099,7 +2069,7 @@ either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. @section Literal examples You can include literal examples that should not be subjected to -markup. Such examples are typeset in monospace, so this is well +markup. Such examples are typeset in monospace@comma{} so this is well suited for source code and similar examples. @example @@ -2108,7 +2078,7 @@ suited for source code and similar examples. #+END_EXAMPLE @end example -For simplicity when using small examples, you can also start the +For simplicity when using small examples@comma{} you can also start the example lines with a colon followed by a space. There may also be additional whitespace before the colon: @@ -2117,8 +2087,8 @@ Here is an example : Some example from a text file. @end example -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 +If the example is source code from a programming language@comma{} or any +other text that can be marked up by Font Lock in Emacs@comma{} you can ask for the example to look like the fontified Emacs buffer. @example @@ -2129,22 +2099,21 @@ for the example to look like the fontified Emacs buffer. #+END_SRC @end example -To edit the example in a special buffer supporting this language, use +To edit the example in a special buffer supporting this language@comma{} use @kbd{C-c '} to both enter and leave the editing buffer. @node Images @section Images An image is a link to an image file that does not have a description -part, for example +part@comma{} for example @example ./img/cat.jpg @end example - If you wish to define a caption for the image and maybe a label for -internal cross references (see @ref{Hyperlinks}), make sure that the +internal cross references (see @ref{Hyperlinks})@comma{} make sure that the link is on a line by itself and precede it with @samp{CAPTION} and @samp{NAME} keywords as follows: @@ -2158,8 +2127,8 @@ keywords as follows: @section Creating Footnotes A footnote is defined in a paragraph that is started by a footnote -marker in square brackets in column 0, no indentation allowed. The -footnote reference is simply the marker in square brackets, inside +marker in square brackets in column 0@comma{} no indentation allowed. The +footnote reference is simply the marker in square brackets@comma{} inside text. For example: @example @@ -2172,10 +2141,10 @@ The following commands handle footnotes: @table @asis @item @kbd{C-c C-x f} (@code{org-footnote-action}) -The footnote action command. When point is on a footnote reference, -jump to the definition. When it is at a definition, jump to the -(first) reference. Otherwise, create a new footnote. When this -command is called with a prefix argument, a menu of additional +The footnote action command. When point is on a footnote reference@comma{} +jump to the definition. When it is at a definition@comma{} jump to the +(first) reference. Otherwise@comma{} create a new footnote. When this +command is called with a prefix argument@comma{} a menu of additional options including renumbering is offered. @item @kbd{C-c C-c} (@code{org-ctrl-c-ctrl-c}) @@ -2214,7 +2183,7 @@ Invokes the export dispatcher interface. @end table Org exports the entire buffer by default. If the Org buffer has an -active region, then Org exports just that region. +active region@comma{} then Org exports just that region. @node Export Settings @section Export Settings @@ -2226,8 +2195,7 @@ additional information. These lines may be put anywhere in the file: #+TITLE: I'm in the Mood for Org @end example - -Most proeminent export options include: +Most prominent export options include: @multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} @item @samp{TITLE} @@ -2235,11 +2203,11 @@ Most proeminent export options include: @item @samp{AUTHOR} @tab the author (default taken from @code{user-full-name}) @item @samp{DATE} -@tab a date, fixed, or an Org timestamp +@tab a date@comma{} fixed@comma{} or an Org timestamp @item @samp{EMAIL} @tab email address (default from @code{user-mail-address}) @item @samp{LANGUAGE} -@tab language code, e.g., @samp{en} +@tab language code@comma{} e.g.@comma{} @samp{en} @end multitable Option keyword sets can be inserted from the export dispatcher (see @@ -2251,9 +2219,9 @@ pressing @kbd{#}. 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 +you need to use a different depth@comma{} or turn it off entirely@comma{} 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} +on a per file basis@comma{} using the following @samp{toc} item in @samp{OPTIONS} keyword: @example @@ -2267,17 +2235,16 @@ headline of the file. @node Include Files @section Include Files -During export, you can include the content of another file. For -example, to include your @samp{.emacs} file, you could use: +During export@comma{} you can include the content of another file. For +example@comma{} to include your @samp{.emacs} file@comma{} 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 +parameter specifies the block type: @samp{example}@comma{} @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. @@ -2288,14 +2255,14 @@ You can visit the included file with @kbd{C-c '}. @section 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 +@samp{#} and a whitespace are treated as comments and@comma{} as such@comma{} are not exported. -Likewise, regions surrounded by @samp{#+BEGIN_COMMENT} @dots{} @samp{#+END_COMMENT} +Likewise@comma{} regions surrounded by @samp{#+BEGIN_COMMENT} @dots{} @samp{#+END_COMMENT} are not exported. -Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after -any other keyword or priority cookie, comments out the entire subtree. +Finally@comma{} a @samp{COMMENT} keyword at the beginning of an entry@comma{} but after +any other keyword or priority cookie@comma{} comments out the entire subtree. The command below helps changing the comment status of a headline. @table @asis @@ -2312,11 +2279,10 @@ does not contain any Org markup. UTF-8 export uses additional characters and symbols available in this encoding standards. @table @asis -@item @kbd{C-c C-e t a} -@itemx @kbd{C-c C-e t u} (@code{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 +@item @kbd{C-c C-e t a}@comma{} @kbd{C-c C-e t u} (@code{org-ascii-export-to-ascii}) +Export as an ASCII file with a @samp{.txt} extension. For @samp{myfile.org}@comma{} +Org exports to @samp{myfile.txt}@comma{} overwriting without warning. For +@samp{myfile.txt}@comma{} Org exports to @samp{myfile.txt.txt} in order to prevent data loss. @end table @@ -2328,21 +2294,20 @@ compatible with XHTML 1.0 strict standard. @table @asis @item @kbd{C-c C-e h h} (@code{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. +Export as HTML file with a @samp{.html} extension. For @samp{myfile.org}@comma{} Org +exports to @samp{myfile.html}@comma{} overwriting without warning. @kbd{C-c C-e h o} exports to HTML and opens it in a web browser. @end table The HTML export backend transforms @samp{<} and @samp{>} to @samp{<} and @samp{>}. To include raw HTML code in the Org file so the HTML export backend -can insert that HTML code in the output, use this inline syntax: +can insert that HTML code in the output@comma{} use this inline syntax: @samp{@@@@html:...@@@@}. For example: @example @@@@html:@@@@bold text@@@@html:@@@@ @end example - -For larger raw HTML code blocks, use these HTML export code blocks: +For larger raw HTML code blocks@comma{} use these HTML export code blocks: @example #+HTML: Literal HTML code for export @@ -2355,30 +2320,30 @@ For larger raw HTML code blocks, use these HTML export code blocks: @node @LaTeX{} Export @section @LaTeX{} Export -The @LaTeX{} export backend 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 +The @LaTeX{} export backend can handle complex documents@comma{} incorporate +standard or custom @LaTeX{} document classes@comma{} generate documents using +alternate @LaTeX{} engines@comma{} and produce fully linked PDF files with +indexes@comma{} bibliographies@comma{} and tables of contents@comma{} destined for interactive online viewing or high-quality print publication. -By default, the @LaTeX{} output uses the @emph{article} class. You can change +By default@comma{} the @LaTeX{} output uses the @emph{article} class. You can change this by adding an option like @samp{#+LATEX_CLASS: myclass} in your file. The class must be listed in @code{org-latex-classes}. @table @asis @item @kbd{C-c C-e l l} (@code{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. +Export to a @LaTeX{} file with a @samp{.tex} extension. For @samp{myfile.org}@comma{} +Org exports to @samp{myfile.tex}@comma{} overwriting without warning. @item @kbd{C-c C-e l p} (@code{org-latex-export-to-pdf}) Export as @LaTeX{} file and convert it to PDF file. @item @kbd{C-c C-e l o} (@code{}) -Export as @LaTeX{} file and convert it to PDF, then open the PDF using +Export as @LaTeX{} file and convert it to PDF@comma{} then open the PDF using the default viewer. @end table -The @LaTeX{} export backend can insert any arbitrary @LaTeX{} code, see +The @LaTeX{} export backend can insert any arbitrary @LaTeX{} code@comma{} see @ref{Embedded @LaTeX{}}. There are three ways to embed such code in the Org file and they all use different quoting syntax. @@ -2388,15 +2353,13 @@ Inserting in-line quoted with @@ symbols: Code embedded in-line @@@@latex:any arbitrary LaTeX code@@@@ in a paragraph. @end example - Inserting as one or more keyword lines in the Org file: @example #+LATEX: any arbitrary LaTeX code @end example - -Inserting as an export block in the Org file, where the backend +Inserting as an export block in the Org file@comma{} where the backend exports any code between begin and end markers: @example @@ -2416,7 +2379,7 @@ standard iCalendar format. @table @asis @item @kbd{C-c C-e c f} (@code{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}. +in the same directory@comma{} using a file extension @samp{.ics}. @item @kbd{C-c C-e c c} (@code{org-icalendar-combine-agenda-files}) Create a combined iCalendar file from Org files in @@ -2430,14 +2393,14 @@ Create a combined iCalendar file from Org files in 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. +upload your exported HTML pages and related attachments@comma{} such as +images and source code files@comma{} to a web server. -You can also use Org to convert files into PDF, or even combine HTML +You can also use Org to convert files into PDF@comma{} or even combine HTML and PDF conversion so that files are available in both formats on the server. -For detailed instructions about setup, see the @ref{Top,manual,,org,}. Here is an +For detailed instructions about setup@comma{} see the @ref{Top,manual,,org,}. Here is an example: @lisp @@ -2476,9 +2439,9 @@ of the commands above. @node Working with Source Code @chapter Working with Source Code -Org mode provides a number of features for working with source code, -including editing of code blocks in their native major mode, -evaluation of code blocks, tangling of code blocks, and exporting code +Org mode provides a number of features for working with source code@comma{} +including editing of code blocks in their native major mode@comma{} +evaluation of code blocks@comma{} tangling of code blocks@comma{} and exporting code blocks and their results in several formats. A source code block conforms to this structure: @@ -2495,25 +2458,25 @@ where: @itemize @item -@samp{} is a string used to uniquely name the code block, +@samp{} is a string used to uniquely name the code block@comma{} @item -@samp{} specifies the language of the code block, e.g., -@samp{emacs-lisp}, @samp{shell}, @samp{R}, @samp{python}, etc., +@samp{} specifies the language of the code block@comma{} e.g.@comma{} +@samp{emacs-lisp}@comma{} @samp{shell}@comma{} @samp{R}@comma{} @samp{python}@comma{} etc.@comma{} @item -@samp{} can be used to control export of the code block, +@samp{} can be used to control export of the code block@comma{} @item @samp{
} can be used to control many aspects of code -block behavior as demonstrated below, +block behavior as demonstrated below@comma{} @item @samp{} contains the actual source code. @end itemize 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, +major mode edit buffer containing the body of the source code block@comma{} ready for any edits. Use @kbd{C-c '} again to close the buffer and return to the Org buffer. @@ -2530,7 +2493,7 @@ priority. @table @asis @item System-wide header arguments Those are specified by customizing @code{org-babel-default-header-args} -variable, or, for a specific language @var{LANG} +variable@comma{} or@comma{} for a specific language @var{LANG} @code{org-babel-default-header-args:LANG}. @item Header arguments in properties @@ -2540,7 +2503,7 @@ set through properties drawers apply at the sub-tree level on down. @item Header arguments in code blocks Header arguments are most commonly set at the source code block -level, on the @samp{BEGIN_SRC} line: +level@comma{} on the @samp{BEGIN_SRC} line: @example #+NAME: factorial @@ -2558,8 +2521,8 @@ keyword on each line. @heading Evaluating code blocks Use @kbd{C-c C-c} to evaluate the current code block and insert -its results in the Org document. By default, evaluation is only -turned on for @samp{emacs-lisp} code blocks, however support exists for +its results in the Org document. By default@comma{} evaluation is only +turned on for @samp{emacs-lisp} code blocks@comma{} however support exists for evaluating blocks in many languages. For a complete list of supported languages see the @ref{Top,manual,,org,}. The following shows a code block and its results. @@ -2580,11 +2543,10 @@ the @samp{var} header argument. :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 +body. @var{ASSIGN} is a literal value@comma{} such as a string@comma{} +a number@comma{} a reference to a table@comma{} a list@comma{} a literal example@comma{} another code block---with or without arguments---or the results of evaluating a code block. @@ -2592,9 +2554,9 @@ a code block. @heading Results of evaluation 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 controls the @emph{collection}, -@emph{type}, @emph{format}, and @emph{handling} of code block results. +header arguments working together. The primary determinant@comma{} however@comma{} +is the @samp{results} header argument. It controls the @emph{collection}@comma{} +@emph{type}@comma{} @emph{format}@comma{} and @emph{handling} of code block results. @table @asis @item Collection @@ -2603,34 +2565,34 @@ choose either @samp{output} or @samp{value} (the default). @item Type What result types to expect from the execution of the code block. -You may choose among @samp{table}, @samp{list}, @samp{scalar}, and @samp{file}. Org +You may choose among @samp{table}@comma{} @samp{list}@comma{} @samp{scalar}@comma{} and @samp{file}. Org tries to guess it if you do not provide it. @item Format -How Org processes results. Some possible values are @samp{code}, -@samp{drawer}, @samp{html}, @samp{latex}, @samp{link}, and @samp{raw}. +How Org processes results. Some possible values are @samp{code}@comma{} +@samp{drawer}@comma{} @samp{html}@comma{} @samp{latex}@comma{} @samp{link}@comma{} and @samp{raw}. @item Handling How to insert the results once properly formatted. Allowed values -are @samp{silent}, @samp{replace} (the default), @samp{append}, or @samp{prepend}. +are @samp{silent}@comma{} @samp{replace} (the default)@comma{} @samp{append}@comma{} or @samp{prepend}. @end table -Code blocks which output results to files---e.g.: graphs, diagrams and -figures---can accept a @samp{:file FILENAME} header argument, in which case -the results are saved to the named file, and a link to the file is +Code blocks which output results to files---e.g.: graphs@comma{} diagrams and +figures---can accept a @samp{:file FILENAME} header argument@comma{} in which case +the results are saved to the named file@comma{} and a link to the file is inserted into the buffer. @anchor{Exporting code blocks} @heading Exporting code blocks -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 +It is possible to export the @emph{code} of code blocks@comma{} the @emph{results} of +code block evaluation@comma{} @emph{both} the code and the results of code block +evaluation@comma{} or @emph{none}. Org defaults to exporting @emph{code} for most languages. The @samp{exports} header argument is to specify if that part of the Org -file is exported to, say, HTML or @LaTeX{} formats. It can be set to -either @samp{code}, @samp{results}, @samp{both} or @samp{none}. +file is exported to@comma{} say@comma{} HTML or @LaTeX{} formats. It can be set to +either @samp{code}@comma{} @samp{results}@comma{} @samp{both} or @samp{none}. @anchor{Extracting source code} @heading Extracting source code @@ -2639,9 +2601,9 @@ Use @kbd{C-c C-v t} to create pure source code files by extracting code from source blocks in the current buffer. This is referred to as ``tangling''---a term adopted from the literate programming community. During tangling of code blocks their bodies -are expanded using @code{org-babel-expand-src-block}, which can expand both +are expanded using @code{org-babel-expand-src-block}@comma{} which can expand both variable and ``Noweb'' style references. In order to tangle a code -block it must have a @samp{tangle} header argument, see the @ref{Top,manual,,org,} for +block it must have a @samp{tangle} header argument@comma{} see the @ref{Top,manual,,org,} for details. @node Miscellaneous @@ -2654,29 +2616,29 @@ Org has in-buffer completions with @kbd{M-@key{TAB}}. No minibuffer is involved. Type one or more letters and invoke the hot key to complete the text in-place. -For example, this command will complete @TeX{} symbols after @samp{\}, TODO -keywords at the beginning of a headline, and tags after @samp{:} in +For example@comma{} this command will complete @TeX{} symbols after @samp{\}@comma{} TODO +keywords at the beginning of a headline@comma{} and tags after @samp{:} in a headline. @anchor{Structure Templates} @heading Structure Templates -To quickly insert empty structural blocks, such as @samp{#+BEGIN_SRC} -@dots{} @samp{#+END_SRC}, or to wrap existing text in such a block, use +To quickly insert empty structural blocks@comma{} such as @samp{#+BEGIN_SRC} +@dots{} @samp{#+END_SRC}@comma{} or to wrap existing text in such a block@comma{} use @table @asis -@item @kbd{C-c C-,} (@code{org-insert-structure-template}) -Prompt for a type of block structure, and insert the block at point. -If the region is active, it is wrapped in the block. +@item @kbd{C-c C-@comma{}} (@code{org-insert-structure-template}) +Prompt for a type of block structure@comma{} and insert the block at point. +If the region is active@comma{} it is wrapped in the block. @end table @anchor{Clean view} @heading Clean view Org's default outline with stars and no indents can become too -cluttered for short documents. For @emph{book-like} long documents, the +cluttered for short documents. For @emph{book-like} long documents@comma{} the effect is not as noticeable. Org provides an alternate stars and -indentation scheme, as shown on the right in the following table. It +indentation scheme@comma{} as shown on the right in the following table. It uses only one star and indents text to line with the heading: @example @@ -2690,22 +2652,21 @@ uses only one star and indents text to line with the heading: @end example This kind of view can be achieved dynamically at display time using -Org Indent mode (@kbd{M-x org-indent-mode @key{RET}}), which prepends +Org Indent mode (@kbd{M-x org-indent-mode @key{RET}})@comma{} which prepends intangible space to each line. You can turn on Org Indent mode for -all files by customizing the variable @code{org-startup-indented}, or you +all files by customizing the variable @code{org-startup-indented}@comma{} or you can turn it on for individual files using @example #+STARTUP: indent @end example - If you want the indentation to be hard space characters so that the -plain text file looks as similar as possible to the Emacs display, Org +plain text file looks as similar as possible to the Emacs display@comma{} Org supports you by helping to indent (with @kbd{@key{TAB}}) text below -each headline, by hiding leading stars, and by only using levels 1, 3, +each headline@comma{} by hiding leading stars@comma{} and by only using levels 1@comma{} 3@comma{} etc to get two characters indentation for each level. To get this -support in a file, use +support in a file@comma{} use @example #+STARTUP: hidestars odd diff --git a/elpa/org-9.7.39/doc/pdflayout.sty b/elpa/org-9.8.3/doc/pdflayout.sty similarity index 100% rename from elpa/org-9.7.39/doc/pdflayout.sty rename to elpa/org-9.8.3/doc/pdflayout.sty diff --git a/elpa/org-9.7.39/doc/texinfo.tex b/elpa/org-9.8.3/doc/texinfo.tex similarity index 100% rename from elpa/org-9.7.39/doc/texinfo.tex rename to elpa/org-9.8.3/doc/texinfo.tex diff --git a/elpa/org-9.7.39/etc/Makefile b/elpa/org-9.8.3/etc/Makefile similarity index 100% rename from elpa/org-9.7.39/etc/Makefile rename to elpa/org-9.8.3/etc/Makefile diff --git a/elpa/org-9.7.39/etc/ORG-NEWS b/elpa/org-9.8.3/etc/ORG-NEWS similarity index 89% rename from elpa/org-9.7.39/etc/ORG-NEWS rename to elpa/org-9.8.3/etc/ORG-NEWS index 7f791de1..2aaddcef 100644 --- a/elpa/org-9.7.39/etc/ORG-NEWS +++ b/elpa/org-9.8.3/etc/ORG-NEWS @@ -4,13 +4,930 @@ ORG NEWS -- history of user-visible changes. -*- mode: org; coding: utf-8 -*- #+LINK: doc https://orgmode.org/worg/doc.html#%s #+LINK: msg https://list.orgmode.org/%s/ -#+LINK: git https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=%s +#+LINK: git https://git.savannah.nongnu.org/cgit/org-mode.git/commit/?id=%s +#+macro: kbd (eval (org-texinfo-kbd-macro $1)) -Copyright (C) 2012-2025 Free Software Foundation, Inc. +Copyright (C) 2012-2026 Free Software Foundation, Inc. See the end of the file for license conditions. Please send Org bug reports to mailto:emacs-orgmode@gnu.org. +* Version 9.8 +** Important announcements and breaking changes + +# Here, we list the *most important* changes and changes that _likely_ +# require user action for most Org mode users. +# Sorted from most important to least important. + +*** You may need to update =org-protocol= bookmarklets for browsers + +In Firefox 133 and Firefox 128.5 ESR, the previously suggested +JavaScript bookmarklets replace the current page with the bookmarklet URL +text. We have updated the manual with new bookmarklets that do not +have this problem. + +The new bookmarklets have ~void(0);~ appended at the end, so that they +do not return anything. + +Example: + +#+begin_example +javascript:location.href='org-protocol://store-link?url='+ + encodeURIComponent(location.href);void(0); +#+end_example + +*** =C-c C-x C-v= command toggling inline image display has been reworked + +Previously, =C-c C-x C-v= always toggled image display in the whole +buffer (or narrowed part of the buffer). With prefix argument, it +also forced displaying image links with description. + +Now, =C-c C-x C-v= is bound to a new command ~org-link-preview~, which +uses different defaults: + +1. When the region is active, images in the region are previewed + +2. Otherwise, if there is an image at point, it is toggled. If there + is no image at point, images in the current entry are previewed + +3. With the =C-u= argument, image previews in the active region or at + point are cleared instead + +4. The =C-u C-u= argument unconditionally shows all images in the + accessible portion of the buffer + +5. The =C-u C-u C-u= argument unconditionally clears all images in the + accessible portion of the buffer + +6. Displaying images over links with description can be forced using + numeric argument: + - ~C-u 1~ for toggling all images at point/current entry + - ~C-u 11~ for toggling all images in buffer + +(The first five of these prefix argument behaviors are the same as that of +the ~org-latex-preview~ command.) + +In addition to images, ~org-link-preview~ can also be used to preview +Org links of all types for which preview behavior is defined, see +[[#link-preview][previews for arbitrary link types]]. + +The old ~org-toggle-inline-images~ command is obsolete but still +available. You can bind it back to =C-c C-x C-v= by adding the +following to your config: +#+begin_src emacs-lisp +(eval-after-load 'org-keys + (org-defkey org-mode-map (kbd "C-c C-x C-v") #'org-toggle-inline-images)) +#+end_src + +*** Org mode no longer treats =:results drawer= as verbatim output + +Previously, =:results drawer= left the code block results verbatim in +some scenarios. This is no longer the case, in line with the manual +and the intended purpose of this option. However, the fix may have +brought subtle changes in the code block output for users who made use +of the previous erroneous behavior. If you use =:results drawer= in your +Org documents, please watch out for potential changes in the code evaluation. + +*** Diary-style timestamps are exported together with active timestamps + +~org-export-with-timestamps~ and ~org-icalendar-with-timestamps~ now +treat diary-style timestamps as a type of active timestamp for +purposes of export. + +This mainly affects iCalendar export, where diary timestamps will now +be included when only active timestamps are exported (the default). + +This should have minimal impact on non-iCalendar exporters, since +~org-export-with-timestamps~ was already ~t~ by default. However, +users who manually set ~org-export-with-timestamps~ to ~active~ will +now have diary timestamps included as well. + +To use the old behavior and export active timestamps only without +diary timestamps, users can set ~org-export-with-timestamps~ and +~org-icalendar-with-timestamps~ to ~active-exclude-diary~. + +*** ~org-element-drawer-parser~ assigns ~:pre-blank~ property + +Previously, the whole contents of drawer, including blank lines at the beginning were +parsed as paragraph. Now, the blank lines at the beginning are stored in ~:pre-blank~ +property, just as in other greater elements. + +*** ~org-element-org-data-parser~ now returns syntax node with ~:pre-blank~ property + +Previously, parsing ~org-data~ syntax node did not record information +about blank lines at the beginning of the document. Now, the number +of blank lines is recorded in ~:pre-blank~ property. + +~org-element-org-data-interpreter~ takes into account this information. + +*** Emacs 26 and Emacs 27 support has been dropped + +We maintain compatibility with the latest Emacs release, and two +versions prior the latest. The latest is Emacs 30, so we drop +everything before Emacs 28. + +** New features + +# We list the most important features, and the features that may +# require user action to be used. + +*** Some navigation commands can now be repeated + +When ~repeat-mode~ is turned on, the following navigation commands can +be repeated: + +| Command | Key binding | Repeat key | +|-----------------------------------+------------------------+--------------| +| ~org-next-visible-heading~ | {{{kbd(C-c C-n)}}} | {{{kbd(n)}}} | +| ~org-previous-visible-heading~ | {{{kbd(C-c C-p)}}} | {{{kbd(p)}}} | +| ~org-forward-heading-same-level~ | {{{kbd(C-c C-f)}}} | {{{kbd(f)}}} | +| ~org-backward-heading-same-level~ | {{{kbd(C-c C-b)}}} | {{{kbd(b)}}} | +| ~org-up-heading~ | {{{kbd(C-c C-u)}}} | {{{kbd(u)}}} | +| ~org-next-block~ | {{{kbd(C-c M-f)}}} | {{{kbd(f)}}} | +| ~org-previous-block~ | {{{kbd(C-c M-b)}}} | {{{kbd(b)}}} | +| ~org-next-link~ | {{{kbd(C-c C-x C-n)}}} | {{{kbd(n)}}} | +| ~org-previous-link~ | {{{kbd(C-c C-x C-p)}}} | {{{kbd(p)}}} | + +The keybindings in the repeat-maps can be changed by customizing +~org-navigation-repeat-map~, ~org-link-navigation-repeat-map~, and +~org-block-navigation-repeat-map~. + +See the new [[info:org#Repeating commands]["Repeating commands"]] section in Org mode manual. + +*** New babel backend for C# code blocks + +Org now officially enables C# code block evaluation based on the .NET SDK. +The old backend that does not use .NET SDK remains in org-contrib +and will be removed in a future release. The built-in =ob-csharp.el= should be +considered the official successor. + +*** All Org link types can be previewed +:PROPERTIES: +:CUSTOM_ID: link-preview +:END: + +Org links support a new parameter =:preview= that can be used to +preview arbitrary link types. The value of this parameter should be a +function that is called to preview links of the corresponding type +(see ~org-link-parameters~). + +The new preview system does not bring any brand-new link previews, but +open the possibility for third-party packages to implement custom previews +without having to use non-ideal hacks. + +On the user side, the existing image link previews should now run +smoother, especially in Org buffers that have a lot of image links to +preview. The new previews are less blocking, previewing link in +batches, without fully blocking Emacs. See the new +~org-link-preview-batch-size~ and ~org-link-preview-delay~ options. + +*** New =%\*N= placeholder in ~org-capture-templates~ + +The new placeholder is like =%\N=, but gives access not only to the +=%^{prompt}= values, but also to =%^{prompt}X= values. + +*** Alignment of image previews can be customized + +This feature was added in Org 9.7 but was not documented in the release notes. See [[https://orgmode.org/worg/org-release-notes.html#preview-align][retrospectively added news entry]]. + +*** ~org-open-at-point-global~ now accepts prefix argument + +The argument is passed through to ~org-link-open~, allowing alternative +way to open links, if link ~:follow~ function supports it. + +*** ox-latex: Table of contents generation has been fixed and augmented + +The LaTeX exporter differs from other exporters in that it does not +include unnumbered sections in the table of contents by default. To +include an unnumbered section, set the property =:UNNUMBERED: toc= on +the section. + +Alternatively, you can set the new custom variable +~org-latex-toc-include-unnumbered~ to include unnumbered sections by +default, aligning with other exporters' behavior. In that case, to +exclude a section from the table of contents, mark it as =:UNNUMBERED: +notoc= in its properties. + +*** Tables copied from LibreOffice Calc documents can be pasted as Org tables + +Tables copied into the clipboard from LibreOffice Calc documents can +now be pasted as an Org table using ~yank-media~. + +*** Ditaa code blocks can use ditaa executable, and can produce SVG output + +In order to use a ditaa executable instead of a JAR file, you can set +~org-ditaa-default-exec-mode~ to ~'ditaa~. The location of the +executable can be configured via ~org-ditaa-exec~. + +SVG output can now be generated; note, however, that this requires a +ditaa version of at least 0.11.0. + +*** New datetree capture ~:tree-type~ options +:PROPERTIES: +:CUSTOM_ID: 9.8-datetree-treetype +:END: + +For datetree capture, ~:tree-type~ can now be any subset of ~(year +quarter month week day)~ to construct a datetree with the specified +levels. For back-compatibility, the default value of ~nil~ is an +alias for ~(year month day)~, ~month~ is an alias for ~(year month)~, +and ~week~ is an alias for ~(year week day)~. + +If ~:tree-type~ is a superset of ~(month week)~, then weeks are +assigned to the month containing Thursday, to be consistent with the +ISO-8601 year-week rule. If ~:tree-type~ contains ~(quarter week)~ +but does not contain ~month~, then quarters are defined as 13-week +periods (the final quarter of a 53-week year has 14-weeks). +Otherwise, quarters are defined as 3-month periods. + +Additionally, ~:tree-type~ can be a function, in which case it should +take the date as an argument, and generate a list of pairs for +~org-datetree-find-create-hierarchy~. This allows for creating new +types of datetrees (e.g. for lunar calendars, academic calendars, +retail 4-4-5 calendars, etc). + +*** New =shortdoc= link type + +You can now create links to =shortdoc= documentation groups for Emacs +Lisp functions (see =M-x shortdoc-display-group=). Requires Emacs 28 +or newer. + +*** Beamer export supports setting frame subtitles + +If a headline is exported as a frame, and has its =BEAMER_SUBTITLE= +property set, the value is used as the subtitle. + +*** =:wrap= header argument can now be explicitly disabled + +Previously, presence of =:wrap= argument (inherited or not) in code +block headers always made the block results wrapped. There was no way +to disable wrapping if =:wrap= was specified in the inherited header +arguments. Now, =:wrap no= or =:wrap nil= will explicitly disable +wrapping. + +*** =ob-sqlite=: Added ability to open a database in readonly mode + +Added option ~:readonly~ to =ob-sqlite=. + +With ~:readonly yes~, the database is opened in readonly mode. For +example: + +#+begin_example +,#+begin_src sqlite :db /tmp/rip.db :readonly yes :exports both +create table rip(a,b); +,#+end_src +#+end_example + +This results in an error such as: + +#+begin_example +Runtime error near line 2: attempt to write a readonly database (8) +[ Babel evaluation exited with code 1 ] +#+end_example + +** New and changed options + +# Changes dealing with changing default values of customizations, +# adding new customizations, or changing the interpretation of the +# existing customizations. + +*** New option ~org-edit-keep-region~ + +Since Org 9.7, structure editing commands do not deactivate region +after editing. Now, this is configurable via the new option. + +*** =xelatex= can be used for LaTeX previews + +A new process =xelatex= is added to ~org-preview-process-alist~ to +allow generating LaTeX fragment preview through =xdv= file produced by +XeLaTeX, which has better support for Unicode. + +You can now set ~org-preview-latex-default-process~ to ~'xelatex~. + +*** New link preview system +**** New option ~org-link-preview-batch-size~ + +Org link previews are generated asynchronously and a few at a time, in +batches. This option controls the number of links that are previewed +in each batch. + +**** New option ~org-link-preview-delay~ + +Org link previews are generated asynchronously. This option controls +the minimum idle time in seconds between previews of batches of links. + +*** New and changed export options +**** ~org-html-style-default~ now highlights =#+begin_src c= (lowercase) blocks + +The default value has been changed, adding ~pre.src-c:before { +content: 'C'; }~ (lowercase =c=) that parallels ~pre.src-C:before { +content: 'C'; }~ (uppercase =C=). + +**** ~org-odt-with-latex~ accepts any method from ~org-preview-latex-process-alist~ + +Previously, only a few conversion methods (~dvipng~, ~imagemagick~, +~dvisvgm~) could be used to render LaTeX fragments as images when +exporting to ODT. Now any method in ~org-preview-latex-process-alist~ +can be used. + +**** New environment =onlyenv= in ~org-beamer-environments-default~ + +The =onlyenv= environment limits showing parts of an animated Beamer +slide to specific animation steps. + +#+begin_example +,***** Comment +:PROPERTIES: +:BEAMER_env: onlyenv +:BEAMER_act: <2-> +:END: +This text will be displayed on animation step 2 and later. +#+end_example + +**** =ox-html=: Headline self links can be enabled from an Org mode file + +Previously HTML export could add, to each headline, a link to itself. +To enable it, you had to use the variable +~org-html-self-link-headlines~. + +Now, it's also possible to enable it per Org mode file by adding: +: #+OPTIONS: html-self-link-headlines:t + +**** Allow disabling macro replacement during export + +New custom option ~org-export-replace-macros~ controls whether Org +mode replaces macros in the buffer before export. Set it to nil to +disable macro replacement. + +This variable has no effect on the ={{{results...}}}= macros for inline +code block results. + +**** New option ~org-cite-bibtex-bibliography-style~ + +This option adds a fallback bibliography style for BibTeX when none is +provided in the =#+CITE_EXPORT= options. The default style is +"plain". + +**** New option ~org-cite-csl-bibtex-titles-to-sentence-case~ + +When this option is non-nil then title fields in BibTeX bibliography +entries are converted to sentence-case before being formatted +according to a CSL style, except for entries with a =langid= field +specifying a non-English language. When nil, this conversion is +limited to entries having a =langid= field specifying a variant of +English. The default value is ~t~ as the CSL standard assumes that +English titles are specified in sentence-case but the BibTeX +bibliography format requires them to be written in title-case. + +**** New option ~org-latex-mathml-directory~ + +This option specifies the path where MathML files generated from LaTeX +fragments are stored. + +**** New option ~org-latex-use-sans~ + +This option specifies the PDF should be typeset using the Sans font +specified in the document class (or the user) instead of the default +font (i.e. the Roman font). + +**** New option ~#+LATEX_CLASS_PRE~ + +This option prepends LaTeX code before the LaTeX preamble. + +**** New option ~org-odt-with-forbidden-chars~ + +The new export option controls how to deal with characters that are forbidden +inside ODT documents during export. + +The ODT documents must follow XML1.0 specification and cannot contain +certain Unicode characters. For example, form feed characters like ^L +are disallowed. + +By default, =ox-odt= will strip such characters and display warning. +You may return to the previous behavior by setting +~org-odt-with-forbidden-chars~ to t. + +Note that Emacs warnings can always be suppressed by clicking on ⛔ +symbol or by customizing ~warning-suppress-types~. + +**** New option ~org-md-link-org-files-as-md~ + +This option makes it possible to disable mapping of linked org files +to markdown during export to Markdown. This is analogous to how +~org-html-link-org-files-as-html~ works in export to HTML. + +*** New context available to save in archived headings + +~org-archive-save-context-info~ can now contain ~olid~ symbol to save +parent heading ID in the archived heading. + +*** New hook ~org-archive-finalize-hook~ + +Hook run after successfully archiving a subtree in final location. +Unlike ~org-archive-hook~, which runs in the source Org buffer, the +new hook is called with point on the subtree in the destination file. + +*** Headline/olp target in ~org-capture-templates~ can be a function/variable + +The variable ~org-capture-templates~ accepts a target specification as +function or symbol for headline (~file+headline~) and olp (~file+olp~ +and ~file+olp+datetree~). + +*** The default value of ~org-babel-latex-process-alist~ is no longer taken from ~org-preview-latex-process-alist~ + +The default value used to be pulled from =dvipng= process type from +~org-preview-latex-process-alist~. Now, it defaults to using +=latexmk= (when available), or running =latex= multiple times, so that +all the references are resolved in the generated PNG. + +*** ~org-tags-sort-function~ can now be a list of functions + +~org-tags-sort-function~ can now be set to a list of functions. +Subsequent sorting functions will be used if two tags are found to be +equivalent. See docstring for more information. + +*** New tags sorting function ~org-tags-sort-hierarchy~ + +By setting ~org-tags-sort-function~ to ~org-tags-sort-hierarchy~, tags +are sorted taking their hierarchy into account. See +[[info:org#Tag Hierarchy][Tag Hierarchy]] for how to set up a tag +hierarchy. + +*** New option ~org-cite-basic-complete-key-crm-separator~ + +This option makes ~org-cite~'s ~basic~ insert processor use +~completing-read-multiple~ instead of the default consecutive prompts. +It can also be set to dynamically compute ~crm-separator~ so that the +separator does not appear in completion candidates. + +*** ~org-yank-image-save-method~ can be a function producing directory name + +In previous versions, ~org-yank-image-save-method~ could be either a +symbol ~attach~ or a string -- directory name. Now it can also be a +function, which will be called with no arguments and its return value +will be used as a directory to save the image to. + +*** ~org-refile-targets~ can now match all headlines in the target file(s) + +Candidate refile targets may now be specified with the symbol ~t~ to +indicate that all headlines within the specified file are to be +considered. For example, setting ~org-refile-targets~ to ~((nil . t))~ +will allow one to refile to any heading within the current buffer. + +*** In =ob-ditaa=, the output type is now controlled consistently with other babel backends + +Output file type is determined as specified in Babel documentation: +the suffix of =:file= is the primary determinant, and =:file-ext= +secondary. Header arguments =:pdf= and =:eps= are supported for +backwards compatibility. Default output type is still PNG. + +** New functions and changes in function arguments + +# This also includes changes in function behavior from Elisp perspective. + +*** The deprecated =show= parameter to =org-priority= has been removed + +The =show= parameter for the =org-priority= function was deprecated in +Org 9.2 (released in 2017). Sufficient time has passed, and it is being +removed as part of refactoring for numeric priorities. + +*** ~org-attach-attach~ now returns a link to file stored + +Previously, ~org-attach-attach~ did not have any specified default value. +Now, it returns a list =(LINK DESCRIPTION)= to the file stored. +The link obeys non-nil ~org-attach-store-link-p~ setting. +When ~org-attach-store-link-p~ is nil, an =attachment:= link is returned. + +*** New functions exposing link formatting done by ~org-insert-link~ + +New function ~org-link-get-description~ exposes handling ~:insert-description~ +link parameter and ~org-link-make-description-function~. + +New function ~org-link-make-string-for-buffer~ exposes link and description +cleanups performed by ~org-insert-link~, including cleaning up =<...>= brackets, +stripping current buffer file path from the link, and adjusting =file:= links +according to ~org-link-file-path-type~. + +*** ob-comint: New optional arguments controlling prompt handling + +The new argument ~prompt-handling~ in ~org-babel-comint-with-output~ +and ~org-babel-comint-async-register~ allows Babel languages to +specify how prompts should be handled in comint output. If equal to +~filter-prompts~, prompts are removed from output before it is passed +on to language-specific processing. If equal to +~disable-prompt-filtering~, then the prompt filtering is skipped. If +unset, then the default behavior is the same as ~filter-prompts~ for +backwards compatibility. + +Prompt filtering is needed for some Babel languages, such as ob-shell, +which leave extra prompts in the output as a side effect of +evaluation. However, other Babel languages, like ob-python, don't +leave extra prompts after evaluation, and skipping the prompt +filtering can be more robust for such languages (as this avoids +removing false positive prompts). + +*** Elisp functions for new datetree tree-types + +Accompanying the [[#9.8-datetree-treetype][new datetree capture ~:tree-type~ options]], on the +elisp level ~org-datetree-find-create-entry~ and +~org-datetree-find-create-hierarchy~ generalize +~org-datetree-find-date-create~, ~org-datetree-find-month-create~, and +~org-datetree-find-iso-week-create~ to new datetree types. + +*** New function ~org-src-get-lang-mode-if-bound~ + +The new function is like ~org-src-get-lang-mode~, except that it +ensures the returned major mode for the given language is bound, and +so available to the user. If the mode is not bound, the function can +optionally return a fallback mode and display a message when doing so. +The function was added so that Org can fall back to Fundamental mode +for source blocks where the appropriate major mode is unavailable. + +*** New function ~org-gnus-no-new-news-other-frame~ (to be used in ~org-link-frame-setup~) + +The new function is like ~org-gnus-no-new-news~, but always opens the +link in other frame. + +*** New function ~org-string-width-invisibility-spec~ + +The new function constructs an invisibility spec without folds and +ellipses, suitable for ~org-string-width~. This can be helpful for +performance if ~org-string-width~ is called multiple times. + +*** New command ~org-link-preview~ to preview Org links + +This command replaces ~org-toggle-inline-images~, which is now +obsolete. + +*** New command ~org-link-preview-region~ to preview Org links in a region or the buffer + +This command replaces ~org-display-inline-images~, which is now +obsolete. + +*** New command ~org-link-preview-clear~ to clear Org link previews in a region or the buffer + +This command replaces ~org-remove-inline-images~, which is now +obsolete. + +*** New command ~org-link-preview-refresh~ to refresh Org link previews in the buffer + +This command replaces ~org-redisplay-inline-images~, which is now +obsolete. + +*** ~org-html-head~ and ~org-html-head-extra~ can now be specified as functions + +Previously, ~org-html-head~ and ~org-html-head-extra~ could only be +specified directly as strings. Now, they can be set to functions that +accept the INFO channel and return a string. This makes it possible +to dynamically generate the content of the resulting ~~ tag in +the resulting HTML document. + +*** ~org-element-create~ now ignores ~nil~​s in CHILDREN argument + +When CHILDREN contains ~nil~ elements, they are skipped. This way, + +#+begin_src emacs-lisp +(let ((children nil)) + (org-element-create 'section nil children)) ; => (section nil) +#+end_src + +will yield expected results rather than assigning literal ~nil~ as a child. + +*** ~org-clock-get-clock-string~ now takes an optional ~max-length~ argument + +When a ~max-length~ is passed to ~org-clock-get-clock-string~, it will first +attempt to truncate the headline and add an ellipsis in order to make the entire +clock string fit under the length limit. If the length limit is too small to +accommodate even a single character of the headline, after accounting for spaces +and the surrounding parentheses, it will omit the headline entirely and just +show as much of the clock as fits under the limit. + +*** ~org-string-width~ now takes an optional ~invisibility-spec~ argument + +For performance, if the invisibility spec has been constructed, it can +be passed in as ~invisibility-spec~ instead of having it be +constructed again. + +** Removed or renamed functions and variables + +*** Obsolete functions and variables removed from ~org-datetree~ + +Due to the refactoring of ~org-datetree~ to support the [[#9.8-datetree-treetype][new datetree +capture ~:tree-type~ options]], the internal variable +~org-datetree-base-level~ has been removed, as well as the +undocumented helper function ~org-datetree-insert-line~. + +*** Obsolete functions ~org-let~ and ~org-let2~ are removed + +If any code is still using these ancient functions, it should move to ~cl-progv~. + +*** ~org-show-empty-lines-in-parent~ is now obsolete + +This function is unused in Org code and does not appear to be used in third-party code. +To be removed in future releases. + +*** ~org-edit-src-content-indentation~ is renamed to ~org-src-content-indentation~ + +The new name highlights that the customization affects more than +editing. ~org-src-content-indentation~ also affects detangling, +printing Org syntax tree (for example, during export to Org), and +indentation of src and example blocks in Org buffers. + +*** ~org-cycle-display-inline-images~ is renamed to ~org-cycle-display-link-previews~ + +Inline image previews in Org mode are now provided by the more general +link previews feature. The behavior with regard to image links is +unchanged. + +*** ~org-cycle-inline-images-display~ is renamed to ~org-cycle-link-previews-display~ + +The behavior is unchanged, except in that the new variable now affects +previews of supported link types besides image links. + +*** ~org-startup-with-inline-images~ is renamed to ~org-startup-with-link-previews~ + +The behavior is unchanged, except in that the new variable now affects +previews of supported link types besides image links. + +*** =ob-ditaa=: =org-babel-ditaa-java-cmd= renamed and =org-ditaa-jar-option= made obsolete + +To align with other customizable variable names, which do not contain +the word =babel=, variable =org-babel-ditaa-java-cmd= has been renamed +to =org-ditaa-java-exec=. The old variable =org-babel-ditaa-java-cmd= +is still available as an obsolete alias. + +Variable =org-ditaa-jar-option= did not serve any sensible purpose and +has been made obsolete. Its value is still used in place of default +parameter -jar if the variable is defined. + +** Miscellaneous +*** =ob-calc.el=: Vector and matrix are now inserted as Org tables by default + +~ob-calc~ now formats vector and matrix results as Org tables. This +conversion can be overridden using the ~:results verbatim~ keyword on +a per source block basis. + +To get back the old behavior, add + +#+begin_example +(with-eval-after-load 'ob-calc + (setq org-babel-header-args:calc + (append '(:results . "verbatim") org-babel-header-args:calc))) +#+end_example + +to your configuration. + +The new behavior follows general babel backend rules (auto-detecting +result type), but may affect the existing usage. + +*** ~orgtbl-to-generic~ retains special rows when exporting to Org + +Previously, special table rows were unconditionally removed when +export to Org. Now, the defaults follow what ox-org does - to retain +special rows by default. See [[https://orgmode.org/worg/org-release-notes.html#ox-org-special-table-rows][previous change]]. + +To retain the old behavior, add ~:with-special-rows nil~ to PARAMS argument: + +: (orgtbl-to-generic table '(:with-special-rows nil) + +*** ~org-babel-lob-ingest~ no longer performs noweb expansion when ingesting blocks + +Previously, ~org-babel-lob-ingest~ would expand noweb references when +adding source blocks to the Library of Babel. Now, blocks are stored +with unexpanded noweb references. + +Noweb expansion is handled appropriately when blocks are actually used +via ~org-babel-execute-src-block~ or ~org-babel-exp-do-export~, with +the correct context (~:tangle~, ~:export~, or ~:eval~). + +This change is unlikely to affect most users, but code that directly +accesses ~org-babel-library-of-babel~ may observe the difference. + +*** Trailing =-= is now allowed in plain links + +Previously, plain links like + +: https://domain/test- + +did not include the trailing =-= punctuation. + +Now, the =-= is allowed at the end, and is considered a part of the plain link. + +#+begin_quote +These types of links will likely be encountered for sites where anchor +targets are automatically generated from documentation headings which +are questions. + https://list.orgmode.org/orgmode/87sexh9ddv.fsf@ice9.digital/ +#+end_quote + +*** Update of statistics cookies now respects narrowing + +Calling ~org-update-statistics-cookies~ with a prefix argument will +now only update cookies in the accessible portion of the buffer. + +*** ox-man: Support specifying =#+DATE:= and ~org-export-with-date~ + +Previously, ox-man ignored =#+DATE:= keyword even when +~org-export-with-date~ is set to non-nil. Now, the date is exported +and specified in the =footer-middle= argument of =.TH= macro (see ~man +7 man~). + +*** ox-man: Support specifying =:release= and =:header= in =#+MAN_CLASS_OPTIONS:= in addition to =:section-id= + +The newly added =:release= and =:header= options of =#+MAN_CLASS_OPTIONS= +are respectively mapped to the =footer-inside= and =header-middle= +arguments of the =.TH= macro (see ~man 7 groff_man~). + +*** ~org-capture~ target pointing to headline is now handled uniformly for =plain= entry type + +Previously, when using ~file+regexp~, ~file+function~ or ~function~, =plain= entries +were inserted right at the point according to regexp/function, even when point is +on an existing headline. + +Now, when target points to an existing headline, =plain= entries are +inserted inside its body, honoring ~:prepend~ property. This is more +consistent with how ~item~, ~checkitem~, and ~table-line~ templates +are handled. + +*** ~org-lint~ now checks priorities + +Warnings are raised on headlines containing out-of-bounds, invalid +(e.g., =[#-1]=, =[#AA]=), or malformed (e.g., =[#1=, =[#A=) +priorities. + +*** In Dot code blocks, ~graphviz-dot-mode~ is used if available + +Previously, when editing Dot code blocks with =M-x org-edit-special=, +Dot code would open in Fundamental mode, even when specialized mode is +installed. The new behavior is more DWIM. + +*** Source blocks fall back to Fundamental mode + +Org now falls back to Fundamental mode for source blocks when the +appropriate major mode is unavailable. + +*** Priority speed commands adapt to user options + +Previously, =1=, =2=, and =3= would insert priorities =A=, =B=, and +=C=, which causes errors when using numeric priorities. These now +insert ~org-priority-highest~, ~org-priority-default~, and +~org-priority-lowest~, respectively. + +*** ~org-store-link~ no longer asks to select store function when called noninteractively + +Previously, when multiple store functions are available to store link +at point, ~org-store-link~ would always ask user which store function +to use. + +Now, when ~org-store-link~ is called noninteractively (~interactive?~ +argument is nil), the first matching store function is used. +Interactively, the previous behavior is retained. + +*** Org mode may throw an error when attempting to include remote unsafe resource noninteractively + +Previously, when ~org-resource-download-policy~ is ~ask~ (default), +and Emacs is running in batch mode, Org mode simply skipped unsafe +remote resources in the =#+include:='s. Now, an error is thrown to +avoid seemingly ignored =#+include= statements when publishing via +batch scripts. + +*** HTML export wraps ~~ around all the exported src blocks + +HTML export always uses ~
~ tag around exported src blocks.
+In addition, previously, HTML export used ~~ tag around src
+blocks when ~org-html-klipsify-src~ is non-nil.
+
+Now, both ~
~ and ~~ tags are *always* wrapped around the
+export src blocks.
+
+*** ~yank-media~ and DND handlers now honor the user option ~org-file-link-type~
+
+When inserting file: links, ~yank-media~ and DND handlers now respect
+the user option ~org-file-link-type~.
+
+*** ~org-timer-done-hook~ is now run before the timer is stopped
+
+Previously, ~org-timer-countdown-timer~ and ~org-timer-start-time~
+were unset when the hook is run.  Now, they still hold the timer info.
+
+*** ox-latex: LaTeX images are now stored alongside the exported =.html= file
+
+Previously, LaTeX images (when HTML export does use images for LaTeX)
+were stored alongside the original =.org= file.  Now, they are stored
+alongside the =.html= file.
+
+This change will make links to LaTeX images point to the folder
+containing =.html= file, not the =.org= file.
+
+*** Org mode no longer prevents =flyspell= from spell-checking inside =LOGBOOK= drawers
+
+Previously, spell-checking via =flyspell= was disabled inside
+=LOGBOOK= (or ~org-log-into-drawer~) drawers.  Now, it is no longer
+the case.  It can be useful to see spelling mistakes inside notes
+added via ~org-add-note~ command.
+
+*** ~ob-R~ and ~ob-julia~ no longer use ESS settings for working directory
+
+Previously, without =:dir= parameter, R and Julia code blocks could
+query for working directory during evaluation.  This was because
+~ess-ask-for-ess-directory~ setting was obeyed.
+
+Now, ~ess-ask-for-ess-directory~, ~ess-directory-function~, and
+~ess-directory~ are all ignored during code block evaluation (except
+when session is already running).  In other words, R and Julia code
+blocks now conform to the "16.4 Environment of a Code Block" section
+of Org mode manual that prescribes Org buffer directory or ~:dir~
+value to be used as working dir to run the code blocks.
+
+*** ~org-cancel-repeater~ now cancels all the repeaters inside entry
+
+Previously, ~org-cancel-repeater~ only canceled repeater in the first
+active timestamp inside heading.  Now, all the repeaters are
+canceled.
+
+The function is renamed to ~org-cancel-repeaters~ accordingly (the old
+name is still kept as an alias).
+
+*** ~org-refile~ now saves current position to Org mark ring when jumping to heading
+
+When ~org-refile~ is called with =C-u= or =C-u C-u= prefix argument
+(to jump to heading or to jump to the last refiled heading), it saves
+point to Org mark ring before jumping. Then, the user can return back
+via ~org-mark-ring-goto~.
+
+*** =org-attach= now considers symlinked files when searching pre-existing attach dirs
+
+When Org buffer is opened from a symlink, Org mode looks into the
+original file directory when searching if an attachment directory already exists.
+This way, attachments will remain accessible when opening symlinked Org file.
+
+When no attach dir exists, Org mode will still prefer creating it in
+the "default" directory - where the symlink is located.
+
+*** Texinfo exporter now supports links in headings
+
+The Texinfo exporter no longer removes links from headings.  This
+applies to all headings, below and above the =H= and =toc= export
+=#+OPTIONS:=.
+
+*** Texinfo exporter now considers numeric =toc= values in =#+OPTIONS:=
+
+For example, given =H:3= and =toc:2= in =#+OPTIONS:=, all headings at
+the 1st and 2nd level appear in the table of contents and those at the
+3rd level do not.
+
+*** =ob-tangle= now tangles source blocks that do not specify a =language= if an inherited property sets a tangle filename
+
+Previously, all source blocks that did not specify a =language= where
+ignored by ~org-babel-tangle-collect-blocks~. Now, if it inherits a
+:tangle header argument with a value other than =no= or =yes= (that is, a
+filename), a source block without =language= will get tangled to that
+file.
+
+*** BibTeX is tangled with the standard =.bib= file extension
+
+Previously, =bibtex= source blocks located in a file named =NAME.org=
+were tangled into a file named =NAME.bibtex=.  Now, they are tangled
+into a file named =FILE.bib=, using the standard extension =.bib=,
+matching the rest of the ecosystem, including BibTeX and LaTeX.
+
+*** LaTeX export now respects ~org-latex-with...~ options in the PDF metadata
+
+Previously, the LaTeX exporter handled the PDF metadata =pdfcreator=,
+=pdfauthor= and =pdftitle= as defined in
+~org-latex-hyperref-template~. This has changed, and these three fields
+will be defined as empty and not produce any metadata if their
+corresponding ~org-latex-with-author~, ~org-latex-with-title~, or
+~org-latex-with-creator~ option is set to ~nil~.
+
+*** Fancy HTML5 export uses ~