ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

org-manual: Add missing "Include Files" documentation 

* doc/org-manual.org (Include Files): Add missing documentation.
This commit is contained in:
Nicolas Goaziou 2018-09-29 14:21:07 +02:00
parent d99cc7fb4d
commit 89f8cdedad
1 changed files with 121 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

215
doc/org-manual.org
View File

@ -11620,42 +11620,65 @@ example, to include your =.emacs= file, you could use:
: #+INCLUDE: "~/.emacs" src emacs-lisp : #+INCLUDE: "~/.emacs" src emacs-lisp
#+texinfo: @noindent #+texinfo: @noindent
The optional second and third parameter are the markup (e.g., =quote=, The first parameter is the file name to include. The optional second
=example=, or =src=), and, if the markup is =src=, the language for parameter specifies the block type: =example=, =export= or =src=. The
formatting the contents. The markup is optional; if it is not given, optional third parameter specifies the source code language to use for
assume text is in Org syntax and process it normally. The =INCLUDE= formatting the contents. This is relevant to both =export= and =src=
keyword also allows additional parameters =:prefix1= and =:prefix= to block types.
specify prefixes for the first line and for each following line,
=:minlevel= in order to get Org mode content demoted to a specified
level, as well as any options accepted by the selected markup. For
example, to include a file as an item, use:
: #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " If an included file is specified as having a markup language, Org
neither checks for valid syntax nor changes the contents in any way.
For example and source blocks, Org code-escapes the contents before
inclusion.
You can also include a portion of a file by specifying a lines range If an included file is not specified as having any markup language,
using the =:lines= parameter. The line at the upper end of the range Org assumes it be in Org format and proceeds as usual with a few
is not included. The start and/or the end of the range may be omitted exceptions. Org makes the footnote labels (see [[*Creating Footnotes]])
to use the obvious defaults. in the included file local to that file. The contents of the included
file belong to the same structure---headline, item---containing the
=INCLUDE= keyword. In particular, headlines within the file become
children of the current section. That behavior can be changed by
providing an additional keyword parameter, =:minlevel=. It shifts the
headlines in the included file to become the lowest level. For
example, this syntax makes the included file a sibling of the current
top-level headline:
- =#+INCLUDE: "~/.emacs" :lines "5-10"= :: : #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
Include lines 5 to 10, 10 excluded. Inclusion of only portions of files are specified using ranges
parameter with =:lines= keyword. The line at the upper end of the
range will not be included. The start and/or the end of the range may
be omitted to use the obvious defaults.
- =#+INCLUDE: "~/.emacs" :lines "-10"= :: | =#+INCLUDE: "~/.emacs" :lines "5-10"= | Include lines 5 to 10, 10 excluded |
| =#+INCLUDE: "~/.emacs" :lines "-10"= | Include lines 1 to 10, 10 excluded |
| =#+INCLUDE: "~/.emacs" :lines "10-"= | Include lines from 10 to EOF |
Include lines 1 to 10, 10 excluded. Inclusions may specify a file-link to extract an object matched by
~org-link-search~[fn:120] (see [[*Search Options in File Links]]). The
ranges for =:lines= keyword are relative to the requested element.
Therefore,
- =#+INCLUDE: "~/.emacs" :lines "10-"= :: : #+INCLUDE: "./paper.org::*conclusion" :lines 1-20
Include lines from 10 to EOF. #+texinfo: @noindent
includes the first 20 lines of the headline named =conclusion=.
You can visit the file being included with the following command. To extract only the contents of the matched object, set
=:only-contents= property to non-~nil~. This omits any planning lines
or property drawers. For example, to include the body of the heading
with the custom ID =theory=, you can use
: #+INCLUDE: "./paper.org::#theory" :only-contents t
The following command allows navigating back and forth to the included
document:
- {{{kbd(C-c ')}}} (~org-edit~special~) :: - {{{kbd(C-c ')}}} (~org-edit~special~) ::
#+kindex: C-c ' #+kindex: C-c '
#+findex: org-edit-special #+findex: org-edit-special
Visit the include file at point. Visit the included file at point.
** Macro Replacement ** Macro Replacement
:PROPERTIES: :PROPERTIES:
@ -11672,7 +11695,7 @@ following syntax:
: #+MACRO: name replacement text; $1, $2 are arguments : #+MACRO: name replacement text; $1, $2 are arguments
#+texinfo: @noindent #+texinfo: @noindent
which can be referenced using ={{{name(arg1, arg2)}}}=[fn:120]. For which can be referenced using ={{{name(arg1, arg2)}}}=[fn:121]. For
example example
#+begin_example #+begin_example
@ -11791,7 +11814,7 @@ are not exported.
Finally, a =COMMENT= keyword at the beginning of an entry, but after Finally, a =COMMENT= keyword at the beginning of an entry, but after
any other keyword or priority cookie, comments out the entire subtree. 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 In this case, the subtree is not exported and no code block within it
is executed either[fn:121]. The command below helps changing the is executed either[fn:122]. The command below helps changing the
comment status of a headline. comment status of a headline.
- {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: - {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
@ -12062,7 +12085,7 @@ should in principle be exportable as a Beamer presentation.
- Org exports a Beamer frame's objects as block environments. Org can - Org exports a Beamer frame's objects as block environments. Org can
enforce wrapping in special block types when =BEAMER_ENV= property enforce wrapping in special block types when =BEAMER_ENV= property
is set[fn:122]. For valid values see is set[fn:123]. For valid values see
~org-beamer-environments-default~. To add more values, see ~org-beamer-environments-default~. To add more values, see
~org-beamer-environments-extra~. ~org-beamer-environments-extra~.
#+vindex: org-beamer-environments-default #+vindex: org-beamer-environments-default
@ -12638,7 +12661,7 @@ is.
#+vindex: org-html-mathjax-options~ #+vindex: org-html-mathjax-options~
LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two
different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]], different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]],
which should work out of the box with Org[fn:123][fn:124]. Some MathJax which should work out of the box with Org[fn:124][fn:125]. Some MathJax
display options can be configured via ~org-html-mathjax-options~, or display options can be configured via ~org-html-mathjax-options~, or
in the buffer. For example, with the following settings, in the buffer. For example, with the following settings,
@ -12650,7 +12673,7 @@ in the buffer. For example, with the following settings,
#+texinfo: @noindent #+texinfo: @noindent
equation labels are displayed on the left margin and equations are equation labels are displayed on the left margin and equations are
five em from the left margin. In addition, it loads the two MathJax five em from the left margin. In addition, it loads the two MathJax
extensions =cancel.js= and =noErrors.js=[fn:125]. extensions =cancel.js= and =noErrors.js=[fn:126].
#+vindex: org-html-mathjax-template #+vindex: org-html-mathjax-template
See the docstring of ~org-html-mathjax-options~ for all supported See the docstring of ~org-html-mathjax-options~ for all supported
@ -12713,7 +12736,7 @@ line.
#+vindex: org-export-html-todo-kwd-class-prefix #+vindex: org-export-html-todo-kwd-class-prefix
#+vindex: org-export-html-tag-class-prefix #+vindex: org-export-html-tag-class-prefix
You can modify the CSS style definitions for the exported file. The You can modify the CSS style definitions for the exported file. The
HTML exporter assigns the following special CSS classes[fn:126] to HTML exporter assigns the following special CSS classes[fn:127] to
appropriate parts of the document---your style specifications may appropriate parts of the document---your style specifications may
change these, in addition to any of the standard classes like for change these, in addition to any of the standard classes like for
headlines, tables, etc. headlines, tables, etc.
@ -12953,7 +12976,7 @@ LaTeX export back-end finds the compiler version to use from
Org file. See the docstring for the Org file. See the docstring for the
~org-latex-default-packages-alist~ for loading packages with certain ~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-bibtex-compiler~ to set the
bibliography compiler[fn:127]. bibliography compiler[fn:128].
*** LaTeX specific export settings *** LaTeX specific export settings
:PROPERTIES: :PROPERTIES:
@ -13564,7 +13587,7 @@ a limit to a level before the absolute limit (see [[*Export Settings]]).
The ODT export back-end handles creating of OpenDocument Text (ODT) The ODT export back-end handles creating of OpenDocument Text (ODT)
format. Documents created by this exporter use the format. Documents created by this exporter use the
{{{cite(OpenDocument-v1.2 specification)}}}[fn:128] and are compatible {{{cite(OpenDocument-v1.2 specification)}}}[fn:129] and are compatible
with LibreOffice 3.4. with LibreOffice 3.4.
*** Pre-requisites for ODT export *** Pre-requisites for ODT export
@ -13965,7 +13988,7 @@ document in one of the following ways:
variables ~org-latex-to-mathml-convert-command~ and variables ~org-latex-to-mathml-convert-command~ and
~org-latex-to-mathml-jar-file~. ~org-latex-to-mathml-jar-file~.
If you prefer to use MathToWeb[fn:129] as your converter, you can If you prefer to use MathToWeb[fn:130] as your converter, you can
configure the above variables as shown below. configure the above variables as shown below.
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -13975,7 +13998,7 @@ document in one of the following ways:
"/path/to/mathtoweb.jar") "/path/to/mathtoweb.jar")
#+end_src #+end_src
To use LaTeX​ML[fn:130] use To use LaTeX​ML[fn:131] use
#+begin_src emacs-lisp #+begin_src emacs-lisp
(setq org-latex-to-mathml-convert-command (setq org-latex-to-mathml-convert-command
@ -14295,7 +14318,7 @@ with the =#+ATTR_ODT= line. For a discussion on default formatting of
tables, see [[*Tables in ODT export]]. tables, see [[*Tables in ODT export]].
This feature closely mimics the way table templates are defined in the This feature closely mimics the way table templates are defined in the
OpenDocument-v1.2 specification.[fn:131] OpenDocument-v1.2 specification.[fn:132]
#+vindex: org-odt-table-styles #+vindex: org-odt-table-styles
For quick preview of this feature, install the settings below and export the For quick preview of this feature, install the settings below and export the
@ -14329,7 +14352,7 @@ templates, define new styles there.
To use this feature proceed as follows: To use this feature proceed as follows:
1. Create a table template[fn:132]. 1. Create a table template[fn:133].
A table template is set of =table-cell= and =paragraph= styles for A table template is set of =table-cell= and =paragraph= styles for
each of the following table cell categories: each of the following table cell categories:
@ -14368,7 +14391,7 @@ To use this feature proceed as follows:
=</office:automatic-styles>= element of the content template file =</office:automatic-styles>= element of the content template file
(see [[x-orgodtcontenttemplate-xml][Factory styles]]). (see [[x-orgodtcontenttemplate-xml][Factory styles]]).
2. Define a table style[fn:133]. 2. Define a table style[fn:134].
#+vindex: org-odt-table-styles #+vindex: org-odt-table-styles
To define a table style, create an entry for the style in the To define a table style, create an entry for the style in the
@ -15395,7 +15418,7 @@ If you want to publish the Org file as an =.org= file but with
~org-publish-org-to-org~. This produces =file.org= and put it in the ~org-publish-org-to-org~. This produces =file.org= and put it in the
publishing directory. If you want a htmlized version of this file, publishing directory. If you want a htmlized version of this file,
set the parameter ~:htmlized-source~ to ~t~. It produces set the parameter ~:htmlized-source~ to ~t~. It produces
=file.org.html= in the publishing directory[fn:134]. =file.org.html= in the publishing directory[fn:135].
Other files like images only need to be copied to the publishing Other files like images only need to be copied to the publishing
destination; for this you can use ~org-publish-attachment~. For destination; for this you can use ~org-publish-attachment~. For
@ -16769,13 +16792,13 @@ See [[*Languages]] to enable other languages.
#+kindex: C-c C-v e #+kindex: C-c C-v e
#+findex: org-babel-execute-src-block #+findex: org-babel-execute-src-block
Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or
{{{kbd(C-c C-v e)}}} with the point on a code block[fn:135] calls the {{{kbd(C-c C-v e)}}} with the point on a code block[fn:136] calls the
~org-babel-execute-src-block~ function, which executes the code in the ~org-babel-execute-src-block~ function, which executes the code in the
block, collects the results, and inserts them in the buffer. block, collects the results, and inserts them in the buffer.
#+cindex: @samp{CALL}, keyword #+cindex: @samp{CALL}, keyword
#+vindex: org-babel-inline-result-wrap #+vindex: org-babel-inline-result-wrap
By calling a named code block[fn:136] from an Org mode buffer or By calling a named code block[fn:137] from an Org mode buffer or
a table. Org can call the named code blocks from the current Org mode a table. Org can call the named code blocks from the current Org mode
buffer or from the "Library of Babel" (see [[*Library of Babel]]). buffer or from the "Library of Babel" (see [[*Library of Babel]]).
@ -17133,7 +17156,7 @@ default behavior is to automatically determine the result type.
If =file= is missing, Org generates the base name of the output If =file= is missing, Org generates the base name of the output
file from the name of the code block, and its extension from the file from the name of the code block, and its extension from the
=file-ext= header argument. In that case, both the name and the =file-ext= header argument. In that case, both the name and the
extension are mandatory[fn:137]. extension are mandatory[fn:138].
#+begin_example #+begin_example
,#+name: circle ,#+name: circle
@ -17582,10 +17605,10 @@ Code blocks in the following languages are supported.
| Asymptote | =asymptote= | Lua | =lua= | | Asymptote | =asymptote= | Lua | =lua= |
| Awk | =awk= | MATLAB | =matlab= | | Awk | =awk= | MATLAB | =matlab= |
| C | =C= | Mscgen | =mscgen= | | C | =C= | Mscgen | =mscgen= |
| C++ | =C++=[fn:138] | OCaml | =ocaml= | | C++ | =C++=[fn:139] | OCaml | =ocaml= |
| Clojure | =clojure= | Octave | =octave= | | Clojure | =clojure= | Octave | =octave= |
| CSS | =css= | Org mode | =org= | | CSS | =css= | Org mode | =org= |
| D | =D=[fn:139] | Oz | =oz= | | D | =D=[fn:140] | Oz | =oz= |
| ditaa | =ditaa= | Perl | =perl= | | ditaa | =ditaa= | Perl | =perl= |
| Emacs Calc | =calc= | Plantuml | =plantuml= | | Emacs Calc | =calc= | Plantuml | =plantuml= |
| Emacs Lisp | =emacs-lisp= | Processing.js | =processing= | | Emacs Lisp | =emacs-lisp= | Processing.js | =processing= |
@ -17714,7 +17737,7 @@ for Python and Emacs Lisp languages.
#+cindex: syntax, Noweb #+cindex: syntax, Noweb
#+cindex: source code, Noweb reference #+cindex: source code, Noweb reference
Org supports named blocks in Noweb[fn:140] style syntax: Org supports named blocks in Noweb[fn:141] style syntax:
: <<CODE-BLOCK-ID>> : <<CODE-BLOCK-ID>>
@ -18214,7 +18237,7 @@ Org Tempo expands snippets to structures defined in
~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For ~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
example, {{{kbd(< s TAB)}}} creates a code block. Enable it by example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
customizing ~org-modules~ or add ~(require 'org-tempo)~ to your Emacs customizing ~org-modules~ or add ~(require 'org-tempo)~ to your Emacs
init file[fn:141]. init file[fn:142].
#+attr_texinfo: :columns 0.1 0.9 #+attr_texinfo: :columns 0.1 0.9
| {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= | | {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= |
@ -18487,7 +18510,7 @@ changes.
#+vindex: org-startup-indented #+vindex: org-startup-indented
Dynamic virtual indentation is controlled by the variable Dynamic virtual indentation is controlled by the variable
~org-startup-indented~[fn:142]. ~org-startup-indented~[fn:143].
- =indent= :: - =indent= ::
@ -18819,7 +18842,7 @@ uses only one star and indents text to line with the heading:
#+findex: org-indent-mode #+findex: org-indent-mode
To turn this mode on, use the minor mode, ~org-indent-mode~. Text To turn this mode on, use the minor mode, ~org-indent-mode~. Text
lines that are not headlines are prefixed with spaces to vertically lines that are not headlines are prefixed with spaces to vertically
align with the headline text[fn:143]. align with the headline text[fn:144].
#+vindex: org-indent-indentation-per-level #+vindex: org-indent-indentation-per-level
To make more horizontal space, the headlines are shifted by two stars. To make more horizontal space, the headlines are shifted by two stars.
@ -18854,7 +18877,7 @@ headings as shown in examples below.
#+vindex: org-adapt-indentation #+vindex: org-adapt-indentation
Org supports this with paragraph filling, line wrapping, and Org supports this with paragraph filling, line wrapping, and
structure editing, preserving or adapting the indentation as structure editing, preserving or adapting the indentation as
appropriate[fn:144]. appropriate[fn:145].
- /Hiding leading stars/ :: - /Hiding leading stars/ ::
@ -18888,7 +18911,7 @@ headings as shown in examples below.
#+vindex: org-odd-levels-only #+vindex: org-odd-levels-only
Using stars for only odd levels, 1, 3, 5, ..., can also clean up Using stars for only odd levels, 1, 3, 5, ..., can also clean up
the clutter. This removes two stars from each level[fn:145]. the clutter. This removes two stars from each level[fn:146].
For Org to properly handle this cleaner structure during edits For Org to properly handle this cleaner structure during edits
and exports, configure the variable ~org-odd-levels-only~. To and exports, configure the variable ~org-odd-levels-only~. To
set this per-file, use either one of the following lines: set this per-file, use either one of the following lines:
@ -19299,13 +19322,13 @@ with Emacs. With a public server, consider encrypting the files.
MobileOrg version 1.5 supports encryption for the iPhone. Org also MobileOrg version 1.5 supports encryption for the iPhone. Org also
requires =openssl= installed on the local computer. To turn on requires =openssl= installed on the local computer. To turn on
encryption, set the same password in MobileOrg and in Emacs. Set the encryption, set the same password in MobileOrg and in Emacs. Set the
password in the variable ~org-mobile-use-encryption~[fn:146]. Note password in the variable ~org-mobile-use-encryption~[fn:147]. Note
that even after MobileOrg encrypts the file contents, the file name that even after MobileOrg encrypts the file contents, the file name
remains visible on the file systems of the local computer, the server, remains visible on the file systems of the local computer, the server,
and the mobile device. and the mobile device.
For a server to host files, consider options like [[http://dropbox.com][Dropbox.com]] For a server to host files, consider options like [[http://dropbox.com][Dropbox.com]]
account[fn:147]. On first connection, MobileOrg creates a directory account[fn:148]. On first connection, MobileOrg creates a directory
=MobileOrg= on Dropbox. Pass its location to Emacs through an =MobileOrg= on Dropbox. Pass its location to Emacs through an
initialisation file variable as follows: initialisation file variable as follows:
@ -19327,15 +19350,15 @@ Org pushes files listed in ~org-mobile-files~ to
~org-mobile-directory~. Files include agenda files (as listed in ~org-mobile-directory~. Files include agenda files (as listed in
~org-agenda-files~). Customize ~org-mobile-files~ to add other files. ~org-agenda-files~). Customize ~org-mobile-files~ to add other files.
File names are staged with paths relative to ~org-directory~, so all File names are staged with paths relative to ~org-directory~, so all
files should be inside this directory[fn:148]. files should be inside this directory[fn:149].
Push creates a special Org file =agendas.org= with custom agenda views Push creates a special Org file =agendas.org= with custom agenda views
defined by the user[fn:149]. defined by the user[fn:150].
Finally, Org writes the file =index.org=, containing links to other Finally, Org writes the file =index.org=, containing links to other
files. MobileOrg reads this file first from the server to determine files. MobileOrg reads this file first from the server to determine
what other files to download for agendas. For faster downloads, what other files to download for agendas. For faster downloads,
MobileOrg only reads files whose checksums[fn:150] have changed. MobileOrg only reads files whose checksums[fn:151] have changed.
** Pulling from MobileOrg ** Pulling from MobileOrg
:PROPERTIES: :PROPERTIES:
@ -19349,7 +19372,7 @@ Org integrates its data in an inbox file format.
1. 1.
#+vindex: org-mobile-inbox-for-pull #+vindex: org-mobile-inbox-for-pull
Org moves all entries found in =mobileorg.org=[fn:151] and appends Org moves all entries found in =mobileorg.org=[fn:152] and appends
them to the file pointed to by the variable them to the file pointed to by the variable
~org-mobile-inbox-for-pull~. Each captured entry and each editing ~org-mobile-inbox-for-pull~. Each captured entry and each editing
event is a top-level entry in the inbox file. event is a top-level entry in the inbox file.
@ -19640,9 +19663,9 @@ of these strategies:
#+cindex: @LaTeX{}, and Orgtbl mode #+cindex: @LaTeX{}, and Orgtbl mode
To wrap a source table in LaTeX, use the =comment= environment To wrap a source table in LaTeX, use the =comment= environment
provided by =comment.sty=[fn:152]. To activate it, put provided by =comment.sty=[fn:153]. To activate it, put
~\usepackage{comment}~ in the document header. Orgtbl mode inserts ~\usepackage{comment}~ in the document header. Orgtbl mode inserts
a radio table skeleton[fn:145] with the command {{{kbd(M-x a radio table skeleton[fn:146] with the command {{{kbd(M-x
orgtbl-insert-radio-table)}}}, which prompts for a table name. For orgtbl-insert-radio-table)}}}, which prompts for a table name. For
example, if =salesfigures= is the name, the template inserts: example, if =salesfigures= is the name, the template inserts:
@ -19661,7 +19684,7 @@ The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function
~orgtbl-to-latex~ to convert the table to LaTeX format, then insert ~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
the table at the target (receive) location named =salesfigures=. Now the table at the target (receive) location named =salesfigures=. Now
the table is ready for data entry. It can even use spreadsheet the table is ready for data entry. It can even use spreadsheet
features[fn:153]: features[fn:154]:
#+begin_example #+begin_example
% BEGIN RECEIVE ORGTBL salesfigures % BEGIN RECEIVE ORGTBL salesfigures
@ -19876,7 +19899,7 @@ Dynamic blocks, like any other block, can be narrowed with
#+vindex: org-agenda-skip-function #+vindex: org-agenda-skip-function
#+vindex: org-agenda-skip-function-global #+vindex: org-agenda-skip-function-global
Org provides a special hook to further limit items in agenda views: Org provides a special hook to further limit items in agenda views:
~agenda~, ~agenda*~[fn:154], ~todo~, ~alltodo~, ~tags~, ~tags-todo~, ~agenda~, ~agenda*~[fn:155], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
~tags-tree~. Specify a custom function that tests inclusion of every ~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 matched item in the view. This function can also skip as much as is
needed. needed.
@ -19919,7 +19942,7 @@ meaningful string suitable for the agenda view.
#+vindex: org-agenda-skip-function #+vindex: org-agenda-skip-function
Search for entries with a limit set on levels for the custom search. 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 This is a general approach to creating custom searches in Org. To
include all levels, use =LEVEL>0=[fn:155]. Then to selectively pick include all levels, use =LEVEL>0=[fn:156]. Then to selectively pick
the matched entries, use ~org-agenda-skip-function~, which also the matched entries, use ~org-agenda-skip-function~, which also
accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
~org-agenda-skip-subtree-if~. For example: ~org-agenda-skip-subtree-if~. For example:
@ -21296,66 +21319,70 @@ this timestamp are exported.
specification. For example, LaTeX export excludes every unnumbered specification. For example, LaTeX export excludes every unnumbered
headline from the table of contents. headline from the table of contents.
[fn:120] Since commas separate the arguments, commas within arguments [fn:120] Note that ~org-link-search-must-match-exact-headline~ is
locally bound to non-~nil~. Therefore, ~org-link-search~ only matches
headlines and named elements.
[fn:121] Since commas separate the arguments, commas within arguments
have to be escaped with the backslash character. So only those have to be escaped with the backslash character. So only those
backslash characters before a comma need escaping with another backslash characters before a comma need escaping with another
backslash character. backslash character.
[fn:121] For a less drastic behavior, consider using a select tag (see [fn:122] For a less drastic behavior, consider using a select tag (see
[[*Export Settings]]) instead. [[*Export Settings]]) instead.
[fn:122] If =BEAMER_ENV= is set, Org export adds =B_environment= tag [fn:123] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
to make it visible. The tag serves as a visual aid and has no to make it visible. The tag serves as a visual aid and has no
semantic relevance. semantic relevance.
[fn:123] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by [fn:124] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
[[http://www.mathjax.org][MathJax]]. [[http://www.mathjax.org][MathJax]].
[fn:124] Please note that exported formulas are part of an HTML [fn:125] Please note that exported formulas are part of an HTML
document, and that signs such as =<=, =>=, or =&= have special document, and that signs such as =<=, =>=, or =&= have special
meanings. See [[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax TeX and LaTeX support]]. meanings. See [[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax TeX and LaTeX support]].
[fn:125] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn [fn:126] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn
about extensions. about extensions.
[fn:126] If the classes on TODO keywords and tags lead to conflicts, [fn:127] If the classes on TODO keywords and tags lead to conflicts,
use the variables ~org-html-todo-kwd-class-prefix~ and use the variables ~org-html-todo-kwd-class-prefix~ and
~org-html-tag-class-prefix~ to make them unique. ~org-html-tag-class-prefix~ to make them unique.
[fn:127] This does not allow setting different bibliography compilers [fn:128] This does not allow setting different bibliography compilers
for different files. However, "smart" LaTeX compilation systems, such for different files. However, "smart" LaTeX compilation systems, such
as latexmk, can select the correct bibliography compiler. as latexmk, can select the correct bibliography compiler.
[fn:128] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications [fn:129] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
(OpenDocument) Version 1.2]]. (OpenDocument) Version 1.2]].
[fn:129] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]]. [fn:130] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
[fn:130] See [[http://dlmf.nist.gov/LaTeXML/]]. [fn:131] See [[http://dlmf.nist.gov/LaTeXML/]].
[fn:131] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]] [fn:132] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
[fn:132] See the =<table:table-template>= element of the [fn:133] See the =<table:table-template>= element of the
OpenDocument-v1.2 specification. OpenDocument-v1.2 specification.
[fn:133] See the attributes =table:template-name=, [fn:134] See the attributes =table:template-name=,
=table:use-first-row-styles=, =table:use-last-row-styles=, =table:use-first-row-styles=, =table:use-last-row-styles=,
=table:use-first-column-styles=, =table:use-last-column-styles=, =table:use-first-column-styles=, =table:use-last-column-styles=,
=table:use-banding-rows-styles=, and =table:use-banding-column-styles= =table:use-banding-rows-styles=, and =table:use-banding-column-styles=
of the =<table:table>= element in the OpenDocument-v1.2 specification. of the =<table:table>= element in the OpenDocument-v1.2 specification.
[fn:134] If the publishing directory is the same as the source [fn:135] If the publishing directory is the same as the source
directory, =file.org= is exported as =file.org.org=, so you probably directory, =file.org= is exported as =file.org.org=, so you probably
do not want to do this. do not want to do this.
[fn:135] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used [fn:136] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding. to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding.
[fn:136] Actually, the constructs =call_<name>()= and =src_<lang>{}= [fn:137] Actually, the constructs =call_<name>()= and =src_<lang>{}=
are not evaluated when they appear in a keyword line---i.e. lines are not evaluated when they appear in a keyword line---i.e. lines
starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]]. starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]].
[fn:137] Due to the way this header argument is implemented, it [fn:138] Due to the way this header argument is implemented, it
implies ":results file". Therefore if it is set for multiple blocks implies ":results file". Therefore if it is set for multiple blocks
at once (by a subtree or buffer property for example), all blocks are at once (by a subtree or buffer property for example), all blocks are
forced to produce file results. This is seldom desired behavior, so forced to produce file results. This is seldom desired behavior, so
@ -21363,60 +21390,60 @@ it is recommended to set this header only on a per-block basis. It is
possible that this aspect of the implementation might change in the possible that this aspect of the implementation might change in the
future. future.
[fn:138] C++ language is handled in =ob-C.el=. Even though the [fn:139] C++ language is handled in =ob-C.el=. Even though the
identifier for such source blocks is =C++=, you activate it by loading identifier for such source blocks is =C++=, you activate it by loading
the C language. the C language.
[fn:139] D language is handled in =ob-C.el=. Even though the [fn:140] D language is handled in =ob-C.el=. Even though the
identifier for such source blocks is =D=, you activate it by loading identifier for such source blocks is =D=, you activate it by loading
the C language. the C language.
[fn:140] For Noweb literate programming details, see [fn:141] For Noweb literate programming details, see
http://www.cs.tufts.edu/~nr/noweb/. http://www.cs.tufts.edu/~nr/noweb/.
[fn:141] For more information, please refer to the commentary section [fn:142] For more information, please refer to the commentary section
in =org-tempo.el=. in =org-tempo.el=.
[fn:142] Note that ~org-indent-mode~ also sets the ~wrap-prefix~ [fn:143] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
property, such that ~visual-line-mode~ (or purely setting ~word-wrap~) property, such that ~visual-line-mode~ (or purely setting ~word-wrap~)
wraps long lines (including headlines) correctly indented. wraps long lines (including headlines) correctly indented.
[fn:143] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly [fn:144] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
for indenting and wrapping long lines of headlines or text. This for indenting and wrapping long lines of headlines or text. This
minor mode handles ~visual-line-mode~ and directly applied settings minor mode handles ~visual-line-mode~ and directly applied settings
through ~word-wrap~. through ~word-wrap~.
[fn:144] Also see the variable ~org-adapt-indentation~. [fn:145] Also see the variable ~org-adapt-indentation~.
[fn:145] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so [fn:146] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
on. on.
[fn:146] If Emacs is configured for safe storing of passwords, then [fn:147] If Emacs is configured for safe storing of passwords, then
configure the variable, ~org-mobile-encryption-password~; please read configure the variable, ~org-mobile-encryption-password~; please read
the docstring of that variable. the docstring of that variable.
[fn:147] An alternative is to use a WebDAV server. MobileOrg [fn:148] An alternative is to use a WebDAV server. MobileOrg
documentation has details of WebDAV server configuration. Additional documentation has details of WebDAV server configuration. Additional
help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]]. help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]].
[fn:148] Symbolic links in ~org-directory~ need to have the same name [fn:149] Symbolic links in ~org-directory~ need to have the same name
as their targets. as their targets.
[fn:149] While creating the agendas, Org mode forces ID properties on [fn:150] While creating the agendas, Org mode forces ID properties on
all referenced entries, so that these entries can be uniquely all referenced entries, so that these entries can be uniquely
identified if MobileOrg flags them for further action. To avoid identified if MobileOrg flags them for further action. To avoid
setting properties configure the variable setting properties configure the variable
~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies ~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
on outline paths, assuming they are unique. on outline paths, assuming they are unique.
[fn:150] Checksums are stored automatically in the file [fn:151] Checksums are stored automatically in the file
=checksums.dat=. =checksums.dat=.
[fn:151] The file will be empty after this operation. [fn:152] The file will be empty after this operation.
[fn:152] https://www.ctan.org/pkg/comment [fn:153] https://www.ctan.org/pkg/comment
[fn:153] If the =TBLFM= keyword contains an odd number of dollar [fn:154] If the =TBLFM= keyword contains an odd number of dollar
characters, this may cause problems with Font Lock in LaTeX mode. As characters, this may cause problems with Font Lock in LaTeX mode. As
shown in the example you can fix this by adding an extra line inside shown in the example you can fix this by adding an extra line inside
the =comment= environment that is used to balance the dollar the =comment= environment that is used to balance the dollar
@ -21424,9 +21451,9 @@ expressions. If you are using AUCTeX with the font-latex library,
a much better solution is to add the =comment= environment to the a much better solution is to add the =comment= environment to the
variable ~LaTeX-verbatim-environments~. variable ~LaTeX-verbatim-environments~.
[fn:154] The ~agenda*~ view is the same as ~agenda~ except that it [fn:155] The ~agenda*~ view is the same as ~agenda~ except that it
only considers /appointments/, i.e., scheduled and deadline items that only considers /appointments/, i.e., scheduled and deadline items that
have a time specification =[h]h:mm= in their time-stamps. have a time specification =[h]h:mm= in their time-stamps.
[fn:155] Note that, for ~org-odd-levels-only~, a level number [fn:156] Note that, for ~org-odd-levels-only~, a level number
corresponds to order in the hierarchy, not to the number of stars. corresponds to order in the hierarchy, not to the number of stars.