org-manual: More visible information about "comma escape"
* doc/org-manual.org (Literal Examples): Move information about "comma escape" outside of the footnote. Delete related footnote. Suggested-by: Štěpán Němec
This commit is contained in:
Nicolas Goaziou
parent
d841b38086
commit
9e083fdf42
|
|
@ -11014,6 +11014,19 @@ suited for source code and similar examples.
|
|||
,#+END_EXAMPLE
|
||||
#+end_example
|
||||
|
||||
#+cindex: comma escape, in literal examples
|
||||
There is one limitation, however. You must insert a comma right
|
||||
before lines starting with either =*=, =,*=, =#+= or =,#+=, as those
|
||||
may be interpreted as outlines nodes or some other special syntax.
|
||||
Org transparenly strips these additonal commas whenever it accesses
|
||||
the contents of the block.
|
||||
|
||||
#+begin_example
|
||||
,#+BEGIN_EXAMPLE
|
||||
,,* I am no real headline
|
||||
,#+END_EXAMPLE
|
||||
#+end_example
|
||||
|
||||
For simplicity when using small examples, you can also start the
|
||||
example lines with a colon followed by a space. There may also be
|
||||
additional whitespace before the colon:
|
||||
|
|
@ -11112,10 +11125,10 @@ a shortcut is provided (see [[*Structure Templates]]).
|
|||
#+findex: org-edit-special
|
||||
Edit the source code example at point in its native mode. This
|
||||
works by switching to a temporary buffer with the source code. You
|
||||
need to exit by pressing {{{kbd(C-c ')}}} again[fn:115]. The edited
|
||||
version then replaces the old version in the Org buffer.
|
||||
Fixed-width regions---where each line starts with a colon followed
|
||||
by a space---are edited using Artist mode[fn:116] to allow creating
|
||||
need to exit by pressing {{{kbd(C-c ')}}} again. The edited version
|
||||
then replaces the old version in the Org buffer. Fixed-width
|
||||
regions---where each line starts with a colon followed by
|
||||
a space---are edited using Artist mode[fn:115] to allow creating
|
||||
ASCII drawings easily. Using this command in an empty line creates
|
||||
a new fixed-width region.
|
||||
|
||||
|
|
@ -11134,7 +11147,7 @@ the end of the current line. Then the label is stored as a link
|
|||
|
||||
#+cindex: inlining images
|
||||
#+cindex: images, markup rules
|
||||
An image is a link to an image file[fn:117] that does not have
|
||||
An image is a link to an image file[fn:116] that does not have
|
||||
a description part, for example
|
||||
|
||||
: ./img/cat.jpg
|
||||
|
|
@ -11162,7 +11175,7 @@ command:
|
|||
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:118].
|
||||
~org-startup-with-inline-images~[fn:117].
|
||||
|
||||
** Captions
|
||||
:PROPERTIES:
|
||||
|
|
@ -11254,7 +11267,7 @@ The following command handles footnotes:
|
|||
#+vindex: org-footnote-define-inline
|
||||
#+vindex: org-footnote-section
|
||||
Otherwise, create a new footnote. Depending on the variable
|
||||
~org-footnote-define-inline~[fn:119], the definition is placed right
|
||||
~org-footnote-define-inline~[fn:118], the definition is placed right
|
||||
into the text as part of the reference, or separately into the
|
||||
location determined by the variable ~org-footnote-section~.
|
||||
|
||||
|
|
@ -11269,7 +11282,7 @@ The following command handles footnotes:
|
|||
| {{{kbd(d)}}} | Delete the footnote at point, including definition and references. |
|
||||
|
||||
#+vindex: org-footnote-auto-adjust
|
||||
Depending on the variable ~org-footnote-auto-adjust~[fn:120],
|
||||
Depending on the variable ~org-footnote-auto-adjust~[fn:119],
|
||||
renumbering and sorting footnotes can be automatic after each
|
||||
insertion or deletion.
|
||||
|
||||
|
|
@ -11459,7 +11472,7 @@ global variables, include:
|
|||
|
||||
#+cindex: @samp{DATE}, keyword
|
||||
#+vindex: org-export-date-timestamp-format
|
||||
A date or a time-stamp[fn:121].
|
||||
A date or a time-stamp[fn:120].
|
||||
|
||||
- =EMAIL= ::
|
||||
|
||||
|
|
@ -11474,7 +11487,7 @@ global variables, include:
|
|||
Language to use for translating certain strings
|
||||
(~org-export-default-language~). With =#+LANGUAGE: fr=, for
|
||||
example, Org translates =Table of contents= to the French =Table des
|
||||
matières=[fn:122].
|
||||
matières=[fn:121].
|
||||
|
||||
- =SELECT_TAGS= ::
|
||||
|
||||
|
|
@ -11751,7 +11764,7 @@ 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[fn:123]. If you need to exclude an unnumbered headline,
|
||||
contents[fn:122]. If you need to exclude an unnumbered headline,
|
||||
along with all its children, set the =UNNUMBERED= property to =notoc=
|
||||
value.
|
||||
|
||||
|
|
@ -11870,7 +11883,7 @@ be omitted to use the obvious defaults.
|
|||
| =#+INCLUDE: "~/.emacs" :lines "10-"= | Include lines from 10 to EOF |
|
||||
|
||||
Inclusions may specify a file-link to extract an object matched by
|
||||
~org-link-search~[fn:124] (see [[*Search Options in File Links]]). The
|
||||
~org-link-search~[fn:123] (see [[*Search Options in File Links]]). The
|
||||
ranges for =:lines= keyword are relative to the requested element.
|
||||
Therefore,
|
||||
|
||||
|
|
@ -11910,7 +11923,7 @@ following syntax:
|
|||
: #+MACRO: name replacement text; $1, $2 are arguments
|
||||
|
||||
#+texinfo: @noindent
|
||||
which can be referenced using ={{{name(arg1, arg2)}}}=[fn:125]. For
|
||||
which can be referenced using ={{{name(arg1, arg2)}}}=[fn:124]. For
|
||||
example
|
||||
|
||||
#+begin_example
|
||||
|
|
@ -12029,7 +12042,7 @@ are not exported.
|
|||
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:126]. The command below helps changing the
|
||||
is executed either[fn:125]. The command below helps changing the
|
||||
comment status of a headline.
|
||||
|
||||
- {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
|
||||
|
|
@ -12301,7 +12314,7 @@ should in principle be exportable as a Beamer presentation.
|
|||
|
||||
- Org exports a Beamer frame's objects as block environments. Org can
|
||||
enforce wrapping in special block types when =BEAMER_ENV= property
|
||||
is set[fn:127]. For valid values see
|
||||
is set[fn:126]. For valid values see
|
||||
~org-beamer-environments-default~. To add more values, see
|
||||
~org-beamer-environments-extra~.
|
||||
#+vindex: org-beamer-environments-default
|
||||
|
|
@ -12887,7 +12900,7 @@ as-is.
|
|||
#+vindex: org-html-mathjax-options~
|
||||
LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two
|
||||
different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]],
|
||||
which should work out of the box with Org[fn:128][fn:129]. Some MathJax
|
||||
which should work out of the box with Org[fn:127][fn:128]. Some MathJax
|
||||
display options can be configured via ~org-html-mathjax-options~, or
|
||||
in the buffer. For example, with the following settings,
|
||||
|
||||
|
|
@ -12899,7 +12912,7 @@ in the buffer. For example, with the following settings,
|
|||
#+texinfo: @noindent
|
||||
equation labels are displayed on the left margin and equations are
|
||||
five em from the left margin. In addition, it loads the two MathJax
|
||||
extensions =cancel.js= and =noErrors.js=[fn:130].
|
||||
extensions =cancel.js= and =noErrors.js=[fn:129].
|
||||
|
||||
#+vindex: org-html-mathjax-template
|
||||
See the docstring of ~org-html-mathjax-options~ for all supported
|
||||
|
|
@ -12962,7 +12975,7 @@ line.
|
|||
#+vindex: org-export-html-todo-kwd-class-prefix
|
||||
#+vindex: org-export-html-tag-class-prefix
|
||||
You can modify the CSS style definitions for the exported file. The
|
||||
HTML exporter assigns the following special CSS classes[fn:131] to
|
||||
HTML exporter assigns the following special CSS classes[fn:130] 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.
|
||||
|
|
@ -13201,7 +13214,7 @@ LaTeX export back-end finds the compiler version to use from
|
|||
Org file. See the docstring for the
|
||||
~org-latex-default-packages-alist~ for loading packages with certain
|
||||
compilers. Also see ~org-latex-bibtex-compiler~ to set the
|
||||
bibliography compiler[fn:132].
|
||||
bibliography compiler[fn:131].
|
||||
|
||||
*** LaTeX specific export settings
|
||||
:PROPERTIES:
|
||||
|
|
@ -13823,7 +13836,7 @@ a limit to a level before the absolute limit (see [[*Export Settings]]).
|
|||
|
||||
The ODT export back-end handles creating of OpenDocument Text (ODT)
|
||||
format. Documents created by this exporter use the
|
||||
{{{cite(OpenDocument-v1.2 specification)}}}[fn:133] and are compatible
|
||||
{{{cite(OpenDocument-v1.2 specification)}}}[fn:132] and are compatible
|
||||
with LibreOffice 3.4.
|
||||
|
||||
*** Pre-requisites for ODT export
|
||||
|
|
@ -14224,7 +14237,7 @@ document in one of the following ways:
|
|||
variables ~org-latex-to-mathml-convert-command~ and
|
||||
~org-latex-to-mathml-jar-file~.
|
||||
|
||||
If you prefer to use MathToWeb[fn:134] as your converter, you can
|
||||
If you prefer to use MathToWeb[fn:133] as your converter, you can
|
||||
configure the above variables as shown below.
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
|
|
@ -14235,7 +14248,7 @@ document in one of the following ways:
|
|||
#+end_src
|
||||
|
||||
#+texinfo: @noindent
|
||||
or, to use LaTeXML[fn:135] instead,
|
||||
or, to use LaTeXML[fn:134] instead,
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
(setq org-latex-to-mathml-convert-command
|
||||
|
|
@ -14554,7 +14567,7 @@ with the =#+ATTR_ODT= line. For a discussion on default formatting of
|
|||
tables, see [[*Tables in ODT export]].
|
||||
|
||||
This feature closely mimics the way table templates are defined in the
|
||||
OpenDocument-v1.2 specification[fn:136].
|
||||
OpenDocument-v1.2 specification[fn:135].
|
||||
|
||||
#+vindex: org-odt-table-styles
|
||||
For quick preview of this feature, install the settings below and export the
|
||||
|
|
@ -14588,7 +14601,7 @@ templates, define new styles there.
|
|||
|
||||
To use this feature proceed as follows:
|
||||
|
||||
1. Create a table template[fn:137].
|
||||
1. Create a table template[fn:136].
|
||||
|
||||
A table template is set of =table-cell= and =paragraph= styles for
|
||||
each of the following table cell categories:
|
||||
|
|
@ -14627,7 +14640,7 @@ To use this feature proceed as follows:
|
|||
=</office:automatic-styles>= element of the content template file
|
||||
(see [[x-orgodtcontenttemplate-xml][Factory styles]]).
|
||||
|
||||
2. Define a table style[fn:138].
|
||||
2. Define a table style[fn:137].
|
||||
|
||||
#+vindex: org-odt-table-styles
|
||||
To define a table style, create an entry for the style in the
|
||||
|
|
@ -15715,7 +15728,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
|
||||
publishing directory. If you want a htmlized version of this file,
|
||||
set the parameter ~:htmlized-source~ to ~t~. It produces
|
||||
=file.org.html= in the publishing directory[fn:139].
|
||||
=file.org.html= in the publishing directory[fn:138].
|
||||
|
||||
Other files like images only need to be copied to the publishing
|
||||
destination; for this you can use ~org-publish-attachment~. For
|
||||
|
|
@ -17087,13 +17100,13 @@ See [[*Languages]] to enable other languages.
|
|||
#+kindex: C-c C-v e
|
||||
#+findex: org-babel-execute-src-block
|
||||
Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or
|
||||
{{{kbd(C-c C-v e)}}} with the point on a code block[fn:140] calls the
|
||||
{{{kbd(C-c C-v e)}}} with the point on a code block[fn:139] calls the
|
||||
~org-babel-execute-src-block~ function, which executes the code in the
|
||||
block, collects the results, and inserts them in the buffer.
|
||||
|
||||
#+cindex: @samp{CALL}, keyword
|
||||
#+vindex: org-babel-inline-result-wrap
|
||||
By calling a named code block[fn:141] from an Org mode buffer or
|
||||
By calling a named code block[fn:140] from an Org mode buffer or
|
||||
a table. Org can call the named code blocks from the current Org mode
|
||||
buffer or from the "Library of Babel" (see [[*Library of Babel]]).
|
||||
|
||||
|
|
@ -17445,7 +17458,7 @@ default behavior is to automatically determine the result type.
|
|||
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-ext= header argument. In that case, both the name and the
|
||||
extension are mandatory[fn:142].
|
||||
extension are mandatory[fn:141].
|
||||
|
||||
#+begin_example
|
||||
,#+name: circle
|
||||
|
|
@ -17894,10 +17907,10 @@ Code blocks in the following languages are supported.
|
|||
| Asymptote | =asymptote= | Lisp | =lisp= |
|
||||
| Awk | =awk= | Lua | =lua= |
|
||||
| C | =C= | MATLAB | =matlab= |
|
||||
| C++ | =C++=[fn:143] | Mscgen | =mscgen= |
|
||||
| C++ | =C++=[fn:142] | Mscgen | =mscgen= |
|
||||
| Clojure | =clojure= | Objective Caml | =ocaml= |
|
||||
| CSS | =css= | Octave | =octave= |
|
||||
| D | =D=[fn:144] | Org mode | =org= |
|
||||
| D | =D=[fn:143] | Org mode | =org= |
|
||||
| ditaa | =ditaa= | Oz | =oz= |
|
||||
| Emacs Calc | =calc= | Perl | =perl= |
|
||||
| Emacs Lisp | =emacs-lisp= | Plantuml | =plantuml= |
|
||||
|
|
@ -18026,7 +18039,7 @@ for Python and Emacs Lisp languages.
|
|||
#+cindex: syntax, Noweb
|
||||
#+cindex: source code, Noweb reference
|
||||
|
||||
Org supports named blocks in Noweb[fn:145] style syntax:
|
||||
Org supports named blocks in Noweb[fn:144] style syntax:
|
||||
|
||||
: <<CODE-BLOCK-ID>>
|
||||
|
||||
|
|
@ -18524,7 +18537,7 @@ Org Tempo expands snippets to structures defined in
|
|||
~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
|
||||
example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
|
||||
customizing ~org-modules~ or add =(require 'org-tempo)= to your Emacs
|
||||
init file[fn:146].
|
||||
init file[fn:145].
|
||||
|
||||
#+attr_texinfo: :columns 0.1 0.9
|
||||
| {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= |
|
||||
|
|
@ -18545,17 +18558,20 @@ init file[fn:146].
|
|||
You may sometimes want to write text that looks like Org syntax, but
|
||||
should really read as plain text. Org may use a specific escape
|
||||
character in some situations, e.g., a backslash in macros (see [[*Macro
|
||||
Replacement]]). In the general case, however, we suggest to use the
|
||||
zero width space. You can get it with one of the following:
|
||||
Replacement]]) or a comma in source and example blocks (see [[*Literal
|
||||
Examples]]). In the general case, however, we suggest to use the zero
|
||||
width space. You can insert one with any of the following:
|
||||
|
||||
: C-x 8 <RET> zero width space <RET>
|
||||
: C-x 8 <RET> 200B <RET>
|
||||
|
||||
For example, in order to write =[[1,2]]= as-is in your document, you can
|
||||
write this, where =X= denotes the zero width space character:
|
||||
For example, in order to write =[[1,2]]= as-is in your document, you
|
||||
may write instead
|
||||
|
||||
: [[X1,2]]
|
||||
|
||||
where =X= denotes the zero width space character.
|
||||
|
||||
** Speed Keys
|
||||
:PROPERTIES:
|
||||
:DESCRIPTION: Electric commands at the beginning of a headline.
|
||||
|
|
@ -18794,7 +18810,7 @@ changes.
|
|||
|
||||
#+vindex: org-startup-indented
|
||||
Dynamic virtual indentation is controlled by the variable
|
||||
~org-startup-indented~[fn:147].
|
||||
~org-startup-indented~[fn:146].
|
||||
|
||||
- =indent= ::
|
||||
|
||||
|
|
@ -19135,13 +19151,13 @@ and hiding leading stars.
|
|||
To display the buffer in the indented view, use the minor mode,
|
||||
~org-indent-mode~. Text lines that are not headlines are prefixed
|
||||
with virtual spaces to vertically align with the headline
|
||||
text[fn:148].
|
||||
text[fn:147].
|
||||
|
||||
#+vindex: org-indent-indentation-per-level
|
||||
To make more horizontal space, the headlines are shifted by two stars.
|
||||
This can be configured by the ~org-indent-indentation-per-level~
|
||||
variable. Only one star on each headline is visible, the rest are
|
||||
masked with the same font color as the background[fn:149].
|
||||
masked with the same font color as the background[fn:148].
|
||||
|
||||
#+vindex: org-startup-indented
|
||||
To globally turn on ~org-indent-mode~ for all files, customize the
|
||||
|
|
@ -19154,7 +19170,7 @@ files, use =STARTUP= keyword as follows:
|
|||
|
||||
It is possible to use hard spaces to achieve the indentation instead,
|
||||
if the bare ASCII file should have the indented look also outside
|
||||
Emacs[fn:150]. With Org's support, you have to indent all lines to
|
||||
Emacs[fn:149]. With Org's support, you have to indent all lines to
|
||||
line up with the outline headers. You need these settings:
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
|
|
@ -19175,7 +19191,7 @@ line up with the outline headers. You need these settings:
|
|||
#+vindex: org-adapt-indentation
|
||||
Org supports this with paragraph filling, line wrapping, and
|
||||
structure editing, preserving or adapting the indentation as
|
||||
appropriate[fn:151].
|
||||
appropriate[fn:150].
|
||||
|
||||
- /Hiding leading stars/ ::
|
||||
|
||||
|
|
@ -19208,7 +19224,7 @@ line up with the outline headers. You need these settings:
|
|||
|
||||
#+vindex: org-odd-levels-only
|
||||
Using stars for only odd levels, 1, 3, 5, ..., can also clean up the
|
||||
clutter. This removes two stars from each level[fn:152]. For Org
|
||||
clutter. This removes two stars from each level[fn:151]. For Org
|
||||
to properly handle this cleaner structure during edits and exports,
|
||||
configure the variable ~org-odd-levels-only~. To set this per-file,
|
||||
use either one of the following lines:
|
||||
|
|
@ -19607,7 +19623,7 @@ these variables.
|
|||
|
||||
#+vindex: org-mobile-directory
|
||||
The mobile application needs access to a file directory on
|
||||
a server[fn:153] to interact with Emacs. Pass its location through
|
||||
a server[fn:152] to interact with Emacs. Pass its location through
|
||||
the ~org-mobile-directory~ variable. If you can mount that directory
|
||||
locally just set the variable to point to that directory:
|
||||
|
||||
|
|
@ -19628,7 +19644,7 @@ With a public server, consider encrypting the files. Org also
|
|||
requires OpenSSL installed on the local computer. To turn on
|
||||
encryption, set the same password in the mobile application and in
|
||||
Emacs. Set the password in the variable
|
||||
~org-mobile-use-encryption~[fn:154]. Note that even after the mobile
|
||||
~org-mobile-use-encryption~[fn:153]. 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.
|
||||
|
|
@ -19644,15 +19660,15 @@ The command ~org-mobile-push~ copies files listed in
|
|||
~org-mobile-files~ into the staging area. Files include agenda files
|
||||
(as listed in ~org-agenda-files~). Customize ~org-mobile-files~ to
|
||||
add other files. File names are staged with paths relative to
|
||||
~org-directory~, so all files should be inside this directory[fn:155].
|
||||
~org-directory~, so all files should be inside this directory[fn:154].
|
||||
|
||||
Push creates a special Org file =agendas.org= with custom agenda views
|
||||
defined by the user[fn:156].
|
||||
defined by the user[fn:155].
|
||||
|
||||
Finally, Org writes the file =index.org=, containing links to other
|
||||
files. The mobile application reads this file first from the server
|
||||
to determine what other files to download for agendas. For faster
|
||||
downloads, it is expected to only read files whose checksums[fn:157]
|
||||
downloads, it is expected to only read files whose checksums[fn:156]
|
||||
have changed.
|
||||
|
||||
*** Pulling from the mobile application
|
||||
|
|
@ -19669,7 +19685,7 @@ data in an inbox file format, through the following steps:
|
|||
|
||||
1.
|
||||
#+vindex: org-mobile-inbox-for-pull
|
||||
Org moves all entries found in =mobileorg.org=[fn:158] and appends
|
||||
Org moves all entries found in =mobileorg.org=[fn:157] and appends
|
||||
them to the file pointed to by the variable
|
||||
~org-mobile-inbox-for-pull~. It should reside neither in the
|
||||
staging area nor on the server. Each captured entry and each
|
||||
|
|
@ -20005,9 +20021,9 @@ of these strategies:
|
|||
#+cindex: @LaTeX{}, and Orgtbl mode
|
||||
|
||||
To wrap a source table in LaTeX, use the =comment= environment
|
||||
provided by =comment.sty=[fn:159]. To activate it, put
|
||||
provided by =comment.sty=[fn:158]. To activate it, put
|
||||
~\usepackage{comment}~ in the document header. Orgtbl mode inserts
|
||||
a radio table skeleton[fn:160] with the command {{{kbd(M-x
|
||||
a radio table skeleton[fn:159] with the command {{{kbd(M-x
|
||||
orgtbl-insert-radio-table)}}}, which prompts for a table name. For
|
||||
example, if =salesfigures= is the name, the template inserts:
|
||||
|
||||
|
|
@ -20026,7 +20042,7 @@ The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function
|
|||
~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
|
||||
the table at the target (receive) location named =salesfigures=. Now
|
||||
the table is ready for data entry. It can even use spreadsheet
|
||||
features[fn:161]:
|
||||
features[fn:160]:
|
||||
|
||||
#+begin_example
|
||||
% BEGIN RECEIVE ORGTBL salesfigures
|
||||
|
|
@ -20243,7 +20259,7 @@ 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:
|
||||
~agenda~, ~agenda*~[fn:162], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
|
||||
~agenda~, ~agenda*~[fn:161], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
|
||||
~tags-tree~. Specify a custom function that tests inclusion of every
|
||||
matched item in the view. This function can also skip as much as is
|
||||
needed.
|
||||
|
|
@ -20286,7 +20302,7 @@ meaningful string suitable for the agenda view.
|
|||
#+vindex: org-agenda-skip-function
|
||||
Search for entries with a limit set on levels for the custom search.
|
||||
This is a general approach to creating custom searches in Org. To
|
||||
include all levels, use =LEVEL>0=[fn:163]. Then to selectively pick
|
||||
include all levels, use =LEVEL>0=[fn:162]. Then to selectively pick
|
||||
the matched entries, use ~org-agenda-skip-function~, which also
|
||||
accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
|
||||
~org-agenda-skip-subtree-if~. For example:
|
||||
|
|
@ -21602,102 +21618,97 @@ information on evaluating code blocks.
|
|||
while using line numbers for the links, which might be useful to
|
||||
explain those in an Org mode example code.
|
||||
|
||||
[fn:115] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
|
||||
a comma prepended, to keep them from being interpreted by Org as
|
||||
outline nodes or special syntax. These commas are stripped when
|
||||
editing with {{{kbd(C-c ')}}}, and also before export.
|
||||
|
||||
[fn:116] You may select a different mode with the variable
|
||||
[fn:115] You may select a different mode with the variable
|
||||
~org-edit-fixed-width-region-mode~.
|
||||
|
||||
[fn:117] What Emacs considers to be an image depends on
|
||||
[fn:116] What Emacs considers to be an image depends on
|
||||
~image-file-name-extensions~ and ~image-file-name-regexps~.
|
||||
|
||||
[fn:118] The variable ~org-startup-with-inline-images~ can be set
|
||||
[fn:117] The variable ~org-startup-with-inline-images~ can be set
|
||||
within a buffer with the =STARTUP= options =inlineimages= and
|
||||
=noinlineimages=.
|
||||
|
||||
[fn:119] The corresponding in-buffer setting is: =#+STARTUP: fninline=
|
||||
[fn:118] The corresponding in-buffer setting is: =#+STARTUP: fninline=
|
||||
or =#+STARTUP: nofninline=.
|
||||
|
||||
[fn:120] The corresponding in-buffer options are =#+STARTUP: fnadjust=
|
||||
[fn:119] The corresponding in-buffer options are =#+STARTUP: fnadjust=
|
||||
and =#+STARTUP: nofnadjust=.
|
||||
|
||||
[fn:121] The variable ~org-export-date-timestamp-format~ defines how
|
||||
[fn:120] The variable ~org-export-date-timestamp-format~ defines how
|
||||
this timestamp are exported.
|
||||
|
||||
[fn:122] For export to LaTeX format---or LaTeX-related formats such as
|
||||
[fn:121] For export to LaTeX format---or LaTeX-related formats such as
|
||||
Beamer---, the =org-latex-package-alist= variable needs further
|
||||
configuration. See [[LaTeX specific export settings]].
|
||||
|
||||
[fn:123] At the moment, some export back-ends do not obey this
|
||||
[fn:122] At the moment, some export back-ends do not obey this
|
||||
specification. For example, LaTeX export excludes every unnumbered
|
||||
headline from the table of contents.
|
||||
|
||||
[fn:124] Note that ~org-link-search-must-match-exact-headline~ is
|
||||
[fn:123] 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:125] Since commas separate the arguments, commas within arguments
|
||||
[fn:124] Since commas separate the arguments, commas within arguments
|
||||
have to be escaped with the backslash character. So only those
|
||||
backslash characters before a comma need escaping with another
|
||||
backslash character.
|
||||
|
||||
[fn:126] For a less drastic behavior, consider using a select tag (see
|
||||
[fn:125] For a less drastic behavior, consider using a select tag (see
|
||||
[[*Export Settings]]) instead.
|
||||
|
||||
[fn:127] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
|
||||
[fn:126] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
|
||||
to make it visible. The tag serves as a visual aid and has no
|
||||
semantic relevance.
|
||||
|
||||
[fn:128] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
|
||||
[fn:127] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
|
||||
[[http://www.mathjax.org][MathJax]].
|
||||
|
||||
[fn:129] Please note that exported formulas are part of an HTML
|
||||
[fn:128] Please note that exported formulas are part of an HTML
|
||||
document, and that signs such as =<=, =>=, or =&= have special
|
||||
meanings. See [[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax TeX and LaTeX support]].
|
||||
|
||||
[fn:130] 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:129] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn
|
||||
about extensions.
|
||||
|
||||
[fn:131] If the classes on TODO keywords and tags lead to conflicts,
|
||||
[fn:130] If the classes on TODO keywords and tags lead to conflicts,
|
||||
use the variables ~org-html-todo-kwd-class-prefix~ and
|
||||
~org-html-tag-class-prefix~ to make them unique.
|
||||
|
||||
[fn:132] This does not allow setting different bibliography compilers
|
||||
[fn:131] This does not allow setting different bibliography compilers
|
||||
for different files. However, "smart" LaTeX compilation systems, such
|
||||
as latexmk, can select the correct bibliography compiler.
|
||||
|
||||
[fn:133] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
|
||||
[fn:132] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
|
||||
(OpenDocument) Version 1.2]].
|
||||
|
||||
[fn:134] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
|
||||
[fn:133] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
|
||||
|
||||
[fn:135] See [[http://dlmf.nist.gov/LaTeXML/]].
|
||||
[fn:134] See [[http://dlmf.nist.gov/LaTeXML/]].
|
||||
|
||||
[fn:136] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
|
||||
[fn:135] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
|
||||
|
||||
[fn:137] See the =<table:table-template>= element of the
|
||||
[fn:136] See the =<table:table-template>= element of the
|
||||
OpenDocument-v1.2 specification.
|
||||
|
||||
[fn:138] See the attributes =table:template-name=,
|
||||
[fn:137] See the attributes =table:template-name=,
|
||||
=table:use-first-row-styles=, =table:use-last-row-styles=,
|
||||
=table:use-first-column-styles=, =table:use-last-column-styles=,
|
||||
=table:use-banding-rows-styles=, and =table:use-banding-column-styles=
|
||||
of the =<table:table>= element in the OpenDocument-v1.2 specification.
|
||||
|
||||
[fn:139] If the publishing directory is the same as the source
|
||||
[fn:138] If the publishing directory is the same as the source
|
||||
directory, =file.org= is exported as =file.org.org=, so you probably
|
||||
do not want to do this.
|
||||
|
||||
[fn:140] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
|
||||
[fn:139] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
|
||||
to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding.
|
||||
|
||||
[fn:141] Actually, the constructs =call_<name>()= and =src_<lang>{}=
|
||||
[fn:140] Actually, the constructs =call_<name>()= and =src_<lang>{}=
|
||||
are not evaluated when they appear in a keyword (see [[*Summary of
|
||||
In-Buffer Settings]]).
|
||||
|
||||
[fn:142] Due to the way this header argument is implemented, it
|
||||
[fn:141] Due to the way this header argument is implemented, it
|
||||
implies ":results file". Therefore if it is set for multiple blocks
|
||||
at once (by a subtree or buffer property for example), all blocks are
|
||||
forced to produce file results. This is seldom desired behavior, so
|
||||
|
|
@ -21705,69 +21716,69 @@ 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
|
||||
future.
|
||||
|
||||
[fn:143] C++ language is handled in =ob-C.el=. Even though the
|
||||
[fn:142] C++ language is handled in =ob-C.el=. Even though the
|
||||
identifier for such source blocks is =C++=, you activate it by loading
|
||||
the C language.
|
||||
|
||||
[fn:144] D language is handled in =ob-C.el=. Even though the
|
||||
[fn:143] D language is handled in =ob-C.el=. Even though the
|
||||
identifier for such source blocks is =D=, you activate it by loading
|
||||
the C language.
|
||||
|
||||
[fn:145] For Noweb literate programming details, see
|
||||
[fn:144] For Noweb literate programming details, see
|
||||
http://www.cs.tufts.edu/~nr/noweb/.
|
||||
|
||||
[fn:146] For more information, please refer to the commentary section
|
||||
[fn:145] For more information, please refer to the commentary section
|
||||
in =org-tempo.el=.
|
||||
|
||||
[fn:147] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
|
||||
[fn:146] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
|
||||
property, such that ~visual-line-mode~ (or purely setting ~word-wrap~)
|
||||
wraps long lines (including headlines) correctly indented.
|
||||
|
||||
[fn:148] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
|
||||
[fn:147] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
|
||||
for indenting and wrapping long lines of headlines or text. This
|
||||
minor mode handles ~visual-line-mode~ and directly applied settings
|
||||
through ~word-wrap~.
|
||||
|
||||
[fn:149] Note that turning on ~org-indent-mode~ sets
|
||||
[fn:148] Note that turning on ~org-indent-mode~ sets
|
||||
~org-hide-leading-stars~ to ~t~ and ~org-adapt-indentation~ to ~nil~.
|
||||
|
||||
[fn:150] This works, but requires extra effort. Org Indent mode is
|
||||
[fn:149] This works, but requires extra effort. Org Indent mode is
|
||||
more convenient for most applications.
|
||||
|
||||
[fn:151] Also see the variable ~org-adapt-indentation~.
|
||||
[fn:150] Also see the variable ~org-adapt-indentation~.
|
||||
|
||||
[fn:152] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 5 stars, and so
|
||||
[fn:151] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 5 stars, and so
|
||||
on.
|
||||
|
||||
[fn:153] For a server to host files, consider using a WebDAV server,
|
||||
[fn:152] For a server to host files, consider using a WebDAV server,
|
||||
such as [[https://nextcloud.com][Nextcloud]]. Additional help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]].
|
||||
|
||||
[fn:154] If Emacs is configured for safe storing of passwords, then
|
||||
[fn:153] If Emacs is configured for safe storing of passwords, then
|
||||
configure the variable ~org-mobile-encryption-password~; please read
|
||||
the docstring of that variable.
|
||||
|
||||
[fn:155] Symbolic links in ~org-directory~ need to have the same name
|
||||
[fn:154] Symbolic links in ~org-directory~ need to have the same name
|
||||
as their targets.
|
||||
|
||||
[fn:156] While creating the agendas, Org mode forces =ID= properties
|
||||
[fn:155] While creating the agendas, Org mode forces =ID= properties
|
||||
on all referenced entries, so that these entries can be uniquely
|
||||
identified if Org Mobile flags them for further action. To avoid
|
||||
setting properties configure the variable
|
||||
~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
|
||||
on outline paths, assuming they are unique.
|
||||
|
||||
[fn:157] Checksums are stored automatically in the file
|
||||
[fn:156] Checksums are stored automatically in the file
|
||||
=checksums.dat=.
|
||||
|
||||
[fn:158] The file will be empty after this operation.
|
||||
[fn:157] The file will be empty after this operation.
|
||||
|
||||
[fn:159] https://www.ctan.org/pkg/comment
|
||||
[fn:158] https://www.ctan.org/pkg/comment
|
||||
|
||||
[fn:160] By default this works only for LaTeX, HTML, and Texinfo.
|
||||
[fn:159] By default this works only for LaTeX, HTML, and Texinfo.
|
||||
Configure the variable ~orgtbl-radio-table-templates~ to install
|
||||
templates for other modes.
|
||||
|
||||
[fn:161] If the =TBLFM= keyword contains an odd number of dollar
|
||||
[fn:160] If the =TBLFM= keyword contains an odd number of dollar
|
||||
characters, this may cause problems with Font Lock in LaTeX mode. As
|
||||
shown in the example you can fix this by adding an extra line inside
|
||||
the =comment= environment that is used to balance the dollar
|
||||
|
|
@ -21775,9 +21786,9 @@ expressions. If you are using AUCTeX with the font-latex library,
|
|||
a much better solution is to add the =comment= environment to the
|
||||
variable ~LaTeX-verbatim-environments~.
|
||||
|
||||
[fn:162] The ~agenda*~ view is the same as ~agenda~ except that it
|
||||
[fn:161] The ~agenda*~ view is the same as ~agenda~ except that it
|
||||
only considers /appointments/, i.e., scheduled and deadline items that
|
||||
have a time specification =[h]h:mm= in their time-stamps.
|
||||
|
||||
[fn:163] Note that, for ~org-odd-levels-only~, a level number
|
||||
[fn:162] Note that, for ~org-odd-levels-only~, a level number
|
||||
corresponds to order in the hierarchy, not to the number of stars.
|
||||
|
|
|
|||
Loading…
Reference in New Issue