diff options
author | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2018-04-24 23:26:27 +0200 |
---|---|---|
committer | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2018-04-24 23:26:27 +0200 |
commit | b4e82fb05014a84d5f04d17f4428cd7ebc1c256f (patch) | |
tree | 889d340a060021a38397b9f38c57f0c38b0bff5e | |
parent | a548e491a9dc75ef85e6184313b463cc082d9af0 (diff) | |
download | org-mode-b4e82fb05014a84d5f04d17f4428cd7ebc1c256f.tar.gz |
org-manual: Sync manual with org.texi
-rw-r--r-- | doc/org-manual.org | 235 | ||||
-rw-r--r-- | doc/org.texi | 11 |
2 files changed, 127 insertions, 119 deletions
diff --git a/doc/org-manual.org b/doc/org-manual.org index 0ffa739..29be225 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -9042,10 +9042,12 @@ Time ranges can be specified with two timestamps: : <2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15> -In the headline of the entry itself, a time(range) may also appear as -plain text (like =12:45= or a =8:30-1pm=). If the agenda integrates -the Emacs diary (see [[*Weekly/daily agenda]]), time specifications in -diary entries are recognized as well. +#+vindex: org-agenda-search-headline-for-time +In the headline of the entry itself, a time(range)---like =12:45= or +a =8:30-1pm=---may also appear as plain text[fn:93]. + +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 @@ -9151,7 +9153,7 @@ custom agenda commands. estimates. The difference between this and a custom agenda command is that filtering is very fast, so that you can switch quickly between different filters without having to recreate the - agenda.[fn:93] + agenda.[fn:94] You are prompted for a tag selection letter; {{{kbd(SPC)}}} means any tag at all. Pressing {{{kbd(TAB)}}} at that prompt offers @@ -9579,7 +9581,7 @@ the other commands, the cursor needs to be in the desired line. with the variable ~org-agenda-start-with-clockreport-mode~. By using a prefix argument when toggling this mode (i.e., {{{kbd(C-u R)}}}), the clock table does not show contributions from entries - that are hidden by agenda filtering[fn:94]. See also the + that are hidden by agenda filtering[fn:95]. See also the variable ~org-clock-report-include-clocking-task~. - {{{kbd(v c)}}} :: @@ -10017,7 +10019,7 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(f)}}} :: #+vindex: org-agenda-bulk-custom-functions - Apply a function[fn:95] to marked entries. For example, the + Apply a function[fn:96] to marked entries. For example, the function below sets the =CATEGORY= property of the entries to =web=. @@ -10058,7 +10060,7 @@ the other commands, the cursor needs to be in the desired line. #+cindex: diary entries, creating from agenda Insert a new entry into the diary, using the date at the cursor and (for block entries) the date at the mark. This adds to the - Emacs diary file[fn:96], in a way similar to the {{{kbd(i)}}} + Emacs diary file[fn:97], 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. @@ -10186,13 +10188,13 @@ after the dispatcher command in order to access the command. Usually this will be just a single character, but if you have many similar commands, you can also define two-letter combinations where the first character is the same in several combinations and serves as a prefix -key[fn:97]. The second parameter is the search type, followed by the +key[fn:98]. The second parameter is the search type, followed by the string or regular expression to be used for the matching. The example above will therefore define: - {{{kbd(x)}}} :: - as a global search for agenda entries planned[fn:98] this + as a global search for agenda entries planned[fn:99] this week/day. - {{{kbd(y)}}} :: @@ -10374,8 +10376,8 @@ See the docstring of the variable for more information. If you are away from your computer, it can be very useful to have a printed version of some agenda views to carry around. Org mode can -export custom agenda views as plain text, HTML[fn:99], Postscript, -PDF[fn:100], and iCalendar files. If you want to do this only +export custom agenda views as plain text, HTML[fn:100], Postscript, +PDF[fn:101], and iCalendar files. If you want to do this only occasionally, use the following command: - {{{kbd(C-x C-w)}}} (~org-agenda-write~) :: @@ -10389,7 +10391,7 @@ occasionally, use the following command: If you need to export certain agenda views frequently, you can associate any custom agenda command with a list of output file -names[fn:101]. Here is an example that first defines custom commands +names[fn:102]. Here is an example that first defines custom commands for the agenda and the global TODO list, together with a number of files to which to export them. Then we define two block agenda commands and specify file names for them as well. File names can be @@ -10478,7 +10480,7 @@ emacs -eval (org-batch-store-agenda-views) -kill #+end_src #+texinfo: @noindent -or, if you need to modify some parameters[fn:102] +or, if you need to modify some parameters[fn:103] #+begin_src shell emacs -eval '(org-batch-store-agenda-views \ @@ -10744,9 +10746,9 @@ Here is an example #+vindex: org-latex-listings If the example is source code from a programming language, or any other text that can be marked up by Font Lock in Emacs, you can ask -for the example to look like the fontified Emacs buffer[fn:103]. This +for the example to look like the fontified Emacs buffer[fn:104]. This is done with the code block, where you also need to specify the name -of the major mode that should be used to fontify the example[fn:104], +of the major mode that should be used to fontify the example[fn:105], see [[*Structure Templates]] for shortcuts to easily insert code blocks. #+cindex: @samp{BEGIN_SRC} @@ -10787,7 +10789,7 @@ In HTML, hovering the mouse over such a link remote-highlights the corresponding code line, which is kind of cool. You can also add a =-r= switch which /removes/ the labels from the -source code[fn:105]. With the =-n= switch, links to these references +source code[fn:106]. With the =-n= switch, links to these references are labeled by the line numbers from the code listing. Otherwise links use the labels with no parentheses. Here is an example: @@ -10825,10 +10827,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:106]. The + You need to exit by pressing {{{kbd(C-c ')}}} again[fn:107]. 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:107] to + followed by a space---are edited using ~artist-mode~[fn:108] to allow creating ASCII drawings easily. Using this command in an empty line creates a new fixed-width region. @@ -10882,7 +10884,7 @@ document, e.g., =\under{}not underlined\under= exports as =_not underlined_=. #+cindex: special symbols, in-buffer display If you would like to see entities displayed as UTF-8 characters, use -the following command[fn:108]: +the following command[fn:109]: - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) :: #+kindex: C-c C-x \ @@ -10896,7 +10898,7 @@ the following command[fn:108]: #+cindex: dash, special symbol #+cindex: ellipsis, special symbol In addition to regular entities defined above, Org exports in -a special way[fn:109] the following commonly used character +a special way[fn:110] the following commonly used character combinations: =\-= is treated as a shy hyphen, =--= and =---= are converted into dashes, and =...= becomes a compact set of dots. @@ -10940,7 +10942,7 @@ change this convention. For example, when setting this variable to Plain ASCII is normally sufficient for almost all note taking. Exceptions include scientific notes, which often require mathematical -symbols and the occasional formula. LaTeX[fn:110] is widely used to +symbols and the occasional formula. LaTeX[fn:111] 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 @@ -10962,7 +10964,7 @@ into images (see [[*Previewing LaTeX fragments]]). LaTeX fragments do not need any special marking at all. The following snippets are identified as LaTeX source code: -- Environments of any kind[fn:111]. The only requirement is that the +- Environments of any kind[fn:112]. The only requirement is that the =\begin= statement appears on a new line, preceded by only whitespace. @@ -11006,7 +11008,7 @@ lines: #+vindex: org-preview-latex-default-process If you have a working LaTeX installation and =dvipng=, =dvisvgm= or -=convert= installed[fn:112], LaTeX fragments can be processed to +=convert= installed[fn:113], LaTeX fragments can be processed to produce images of the typeset expressions to be used for inclusion while exporting to HTML (see [[*LaTeX fragments]]), or for inline previewing within Org mode. @@ -11075,7 +11077,7 @@ more details see the documentation of CDLaTeX mode): #+kindex: TAB The {{{kbd(TAB)}}} key expands the template if the cursor is - inside a LaTeX fragment[fn:113]. For example, {{{kbd(TAB)}}} + inside a LaTeX fragment[fn:114]. For example, {{{kbd(TAB)}}} expands =fr= to =\frac{}{}= and position the cursor correctly inside the first brace. Another {{{kbd(TAB)}}} gets you into the second brace. @@ -11290,7 +11292,7 @@ global variables, include: #+cindex: @samp{DATE}, keyword #+vindex: org-export-date-timestamp-format - A date or a time-stamp[fn:114]. + A date or a time-stamp[fn:115]. - =EMAIL= :: @@ -11585,7 +11587,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:115]. If you need to exclude an unnumbered headline, +contents[fn:116]. If you need to exclude an unnumbered headline, along with all its children, set the =UNNUMBERED= property to =notoc= value. @@ -11703,7 +11705,7 @@ following syntax: : #+MACRO: name replacement text; $1, $2 are arguments #+texinfo: @noindent -which can be referenced using ={{{name(arg1, arg2)}}}=[fn:116]. For +which can be referenced using ={{{name(arg1, arg2)}}}=[fn:117]. For example #+begin_example @@ -11817,7 +11819,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:117]. The command below helps changing the +is executed either[fn:118]. The command below helps changing the comment status of a headline. - {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: @@ -12088,7 +12090,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:118]. For valid values see + is set[fn:119]. For valid values see ~org-beamer-environments-default~. To add more values, see ~org-beamer-environments-extra~. #+vindex: org-beamer-environments-default @@ -12664,7 +12666,7 @@ 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:119]. Some MathJax +which should work out of the box with Org[fn:120]. Some MathJax display options can be configured via ~org-html-mathjax-options~, or in the buffer. For example, with the following settings, @@ -12676,7 +12678,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:120]. +extensions =cancel.js= and =noErrors.js=[fn:121]. #+vindex: org-html-mathjax-template See the docstring of ~org-html-mathjax-options~ for all supported @@ -12739,7 +12741,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:121] to +HTML exporter assigns the following special CSS classes[fn:122] 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. @@ -12979,7 +12981,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:122]. +bibliography compiler[fn:123]. *** LaTeX specific export settings :PROPERTIES: @@ -13589,7 +13591,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:123] and are compatible +{{{cite(OpenDocument-v1.2 specification)}}}[fn:124] and are compatible with LibreOffice 3.4. *** Pre-requisites for ODT export @@ -13990,7 +13992,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:124] as your converter, you can + If you prefer to use MathToWeb[fn:125] as your converter, you can configure the above variables as shown below. #+begin_src emacs-lisp @@ -14000,7 +14002,7 @@ document in one of the following ways: "/path/to/mathtoweb.jar") #+end_src - To use LaTeXML[fn:125] use + To use LaTeXML[fn:126] use #+begin_src emacs-lisp (setq org-latex-to-mathml-convert-command @@ -14320,7 +14322,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:126] +OpenDocument-v1.2 specification.[fn:127] #+vindex: org-odt-table-styles For quick preview of this feature, install the settings below and export the @@ -14354,7 +14356,7 @@ templates, define new styles there. To use this feature proceed as follows: -1. Create a table template[fn:127]. +1. Create a table template[fn:128]. A table template is set of =table-cell= and =paragraph= styles for each of the following table cell categories: @@ -14393,7 +14395,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:128]. +2. Define a table style[fn:129]. #+vindex: org-odt-table-styles To define a table style, create an entry for the style in the @@ -15420,7 +15422,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:129]. +=file.org.html= in the publishing directory[fn:130]. Other files like images only need to be copied to the publishing destination; for this you can use ~org-publish-attachment~. For @@ -16797,13 +16799,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:130] calls the +{{{kbd(C-c C-v e)}}} with the point on a code block[fn:131] 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:131] from an Org mode buffer or +By calling a named code block[fn:132] 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]]). @@ -17708,7 +17710,7 @@ for Python and Emacs Lisp languages. #+cindex: syntax, Noweb #+cindex: source code, Noweb reference -Org supports named blocks in Noweb[fn:132] style syntax: +Org supports named blocks in Noweb[fn:133] style syntax: : <<CODE-BLOCK-ID>> @@ -18208,7 +18210,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:133]. +init file[fn:134]. #+attr_texinfo: :columns 0.1 0.9 @@ -18464,7 +18466,7 @@ changes. #+vindex: org-startup-indented Dynamic virtual indentation is controlled by the variable - ~org-startup-indented~.[fn:134] + ~org-startup-indented~.[fn:135] - =indent= :: @@ -18796,7 +18798,7 @@ uses only one star and indents text to line with the heading: #+findex: org-indent-mode To turn this mode on, use the minor mode, ~org-indent-mode~. Text lines that are not headlines are prefixed with spaces to vertically -align with the headline text[fn:135]. +align with the headline text[fn:136]. #+vindex: org-indent-indentation-per-level To make more horizontal space, the headlines are shifted by two stars. @@ -18831,7 +18833,7 @@ headings as shown in examples below. #+vindex: org-adapt-indentation Org supports this with paragraph filling, line wrapping, and structure editing, preserving or adapting the indentation as - appropriate[fn:136]. + appropriate[fn:137]. - /Hiding leading stars/ :: @@ -18865,7 +18867,7 @@ headings as shown in examples below. #+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:137]. + the clutter. This removes two stars from each level[fn:138]. 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: @@ -19433,9 +19435,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:138]. To activate it, put +provided by =comment.sty=[fn:139]. To activate it, put ~\usepackage{comment}~ in the document header. Orgtbl mode inserts -a radio table skeleton[fn:137] with the command {{{kbd(M-x +a radio table skeleton[fn:138] 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: @@ -19454,7 +19456,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:139]: +features[fn:140]: #+begin_example % BEGIN RECEIVE ORGTBL salesfigures @@ -19669,7 +19671,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:140], ~todo~, ~alltodo~, ~tags~, ~tags-todo~, +~agenda~, ~agenda*~[fn:141], ~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. @@ -19712,7 +19714,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:141]. Then to selectively pick +include all levels, use =LEVEL>0=[fn:142]. 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: @@ -20207,13 +20209,13 @@ with Emacs. With a public server, consider encrypting the files. MobileOrg version 1.5 supports encryption for the iPhone. Org also requires =openssl= installed on the local computer. To turn on encryption, set the same password in MobileOrg and in Emacs. Set the -password in the variable ~org-mobile-use-encryption~[fn:142]. Note +password in the variable ~org-mobile-use-encryption~[fn:143]. Note that even after MobileOrg encrypts the file contents, the file name remains visible on the file systems of the local computer, the server, and the mobile device. For a server to host files, consider options like [[http://dropbox.com][Dropbox.com]] -account[fn:143]. On first connection, MobileOrg creates a directory +account[fn:144]. On first connection, MobileOrg creates a directory =MobileOrg= on Dropbox. Pass its location to Emacs through an initialisation file variable as follows: @@ -20235,15 +20237,15 @@ Org pushes files listed in ~org-mobile-files~ to ~org-mobile-directory~. 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:144]. +files should be inside this directory[fn:145]. Push creates a special Org file =agendas.org= with custom agenda views -defined by the user[fn:145]. +defined by the user[fn:146]. Finally, Org writes the file =index.org=, containing links to other files. MobileOrg reads this file first from the server to determine what other files to download for agendas. For faster downloads, -MobileOrg only reads files whose checksums[fn:146] have changed. +MobileOrg only reads files whose checksums[fn:147] have changed. ** Pulling from MobileOrg :PROPERTIES: @@ -20257,7 +20259,7 @@ Org integrates its data in an inbox file format. 1. #+vindex: org-mobile-inbox-for-pull - Org moves all entries found in =mobileorg.org=[fn:147] and appends + Org moves all entries found in =mobileorg.org=[fn:148] and appends them to the file pointed to by the variable ~org-mobile-inbox-for-pull~. Each captured entry and each editing event is a top-level entry in the inbox file. @@ -21114,175 +21116,178 @@ like ~diary-anniversary~, but the argument order is always according to ISO and therefore independent of the value of ~calendar-date-style~. -[fn:93] Custom commands can preset a filter by binding the variable +[fn:93] You can, however, disable this by setting +~org-agenda-search-headline-for-time~ variable to a ~nil~ value. + +[fn:94] Custom commands can preset a filter by binding the variable ~org-agenda-tag-filter-preset~ as an option. This filter is then applied to the view and persists as a basic filter through refreshes and more secondary filtering. The filter is a global property of the entire agenda view---in a block agenda, you should only set this in the global options section, not in the section of an individual block. -[fn:94] Only tags filtering is respected here, effort filtering is +[fn:95] Only tags filtering is respected here, effort filtering is ignored. -[fn:95] You can also create persistent custom functions through +[fn:96] You can also create persistent custom functions through ~org-agenda-bulk-custom-functions~. -[fn:96] This file is parsed for the agenda when +[fn:97] This file is parsed for the agenda when ~org-agenda-include-diary~ is set. -[fn:97] You can provide a description for a prefix key by inserting +[fn:98] You can provide a description for a prefix key by inserting a cons cell with the prefix and the description. -[fn:98] /Planned/ means here that these entries have some planning +[fn:99] /Planned/ means here that these entries have some planning information attached to them, like a time-stamp, a scheduled or a deadline string. See ~org-agenda-entry-types~ on how to set what planning information is taken into account. -[fn:99] For HTML you need to install Hrvoje Niksic's =htmlize.el= +[fn:100] For HTML you need to install Hrvoje Niksic's =htmlize.el= from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Niksic's repository]]. -[fn:100] To create PDF output, the Ghostscript ps2pdf utility must be +[fn:101] To create PDF output, the Ghostscript ps2pdf utility must be installed on the system. Selecting a PDF file also creates the postscript file. -[fn:101] If you want to store standard views like the weekly agenda or +[fn:102] If you want to store standard views like the weekly agenda or the global TODO list as well, you need to define custom commands for them in order to be able to specify file names. -[fn:102] Quoting depends on the system you use, please check the FAQ +[fn:103] Quoting depends on the system you use, please check the FAQ for examples. -[fn:103] This works automatically for the HTML backend (it requires +[fn:104] This works automatically for the HTML backend (it requires version 1.34 of the =htmlize.el= package, which you need to install). Fontified code chunks in LaTeX can be achieved using either the listings package or the [[https://github.com/gpoore/minted][minted]] package. Refer to ~org-export-latex-listings~ for details. -[fn:104] Source code in code blocks may also be evaluated either +[fn:105] Source code in code blocks may also be evaluated either interactively or on export. See [[*Working with Source Code]] for more information on evaluating code blocks. -[fn:105] Adding =-k= to =-n -r= /keeps/ the labels in the source code +[fn:106] Adding =-k= to =-n -r= /keeps/ the labels in the source code while using line numbers for the links, which might be useful to explain those in an Org mode example code. -[fn:106] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get +[fn:107] 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:107] You may select a different-mode with the variable +[fn:108] You may select a different-mode with the variable ~org-edit-fixed-width-region-mode~. -[fn:108] You can turn this on by default by setting the variable +[fn:109] You can turn this on by default by setting the variable ~org-pretty-entities~, or on a per-file base with the =STARTUP= option =entitiespretty=. -[fn:109] This behavior can be disabled with =-= export setting (see +[fn:110] This behavior can be disabled with =-= export setting (see [[*Export Settings]]). -[fn:110] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX +[fn:111] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX system. Many of the features described here as "LaTeX" are really from TeX, but for simplicity I am blurring this distinction. -[fn:111] When MathJax is used, only the environments recognized by +[fn:112] When MathJax is used, only the environments recognized by MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is used to create images, any LaTeX environment is handled. -[fn:112] These are respectively available at +[fn:113] These are respectively available at [[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]] and from the ImageMagick suite. Choose the converter by setting the variable ~org-preview-latex-default-process~ accordingly. -[fn:113] Org mode has a method to test if the cursor is inside such +[fn:114] Org mode has a method to test if the cursor is inside such a fragment, see the documentation of the function ~org-inside-LaTeX-fragment-p~. -[fn:114] The variable ~org-export-date-timestamp-format~ defines how +[fn:115] The variable ~org-export-date-timestamp-format~ defines how this timestamp are exported. -[fn:115] At the moment, some export back-ends do not obey this +[fn:116] 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:116] Since commas separate the arguments, commas within arguments +[fn:117] 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:117] For a less drastic behavior, consider using a select tag (see +[fn:118] For a less drastic behavior, consider using a select tag (see [[*Export Settings]]) instead. -[fn:118] If =BEAMER_ENV= is set, Org export adds =B_environment= tag +[fn:119] 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:119] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by +[fn:120] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by [[http://www.mathjax.org][MathJax]]. -[fn:120] 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:121] 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:121] If the classes on TODO keywords and tags lead to conflicts, +[fn:122] 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:122] This does not allow setting different bibliography compilers +[fn:123] 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:123] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications +[fn:124] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications (OpenDocument) Version 1.2]]. -[fn:124] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]]. +[fn:125] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]]. -[fn:125] See [[http://dlmf.nist.gov/LaTeXML/]]. +[fn:126] See [[http://dlmf.nist.gov/LaTeXML/]]. -[fn:126] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]] +[fn:127] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]] -[fn:127] See the =<table:table-template>= element of the +[fn:128] See the =<table:table-template>= element of the OpenDocument-v1.2 specification. -[fn:128] See the attributes =table:template-name=, +[fn:129] 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:129] If the publishing directory is the same as the source +[fn:130] 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:130] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used +[fn:131] 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:131] Actually, the constructs =call_<name>()= and =src_<lang>{}= +[fn:132] Actually, the constructs =call_<name>()= and =src_<lang>{}= are not evaluated when they appear in a keyword line---i.e. lines starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]]. -[fn:132] For Noweb literate programming details, see +[fn:133] For Noweb literate programming details, see http://www.cs.tufts.edu/~nr/noweb/. -[fn:133] For more information, please refer to the commentary section +[fn:134] For more information, please refer to the commentary section in =org-tempo.el=. -[fn:134] Note that ~org-indent-mode~ also sets the ~wrap-prefix~ +[fn:135] 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:135] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly +[fn:136] 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:136] Also see the variable ~org-adapt-indentation~. +[fn:137] Also see the variable ~org-adapt-indentation~. -[fn:137] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so +[fn:138] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so on. -[fn:138] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en +[fn:139] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en -[fn:139] If the =TBLFM= keyword contains an odd number of dollar +[fn:140] 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 @@ -21290,32 +21295,32 @@ 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:140] The ~agenda*~ view is the same as ~agenda~ except that it +[fn:141] 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:141] Note that, for ~org-odd-levels-only~, a level number +[fn:142] Note that, for ~org-odd-levels-only~, a level number corresponds to order in the hierarchy, not to the number of stars. -[fn:142] If Emacs is configured for safe storing of passwords, then +[fn:143] 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:143] An alternative is to use a WebDAV server. MobileOrg +[fn:144] An alternative is to use a WebDAV server. MobileOrg documentation has details of WebDAV server configuration. Additional help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]]. -[fn:144] Symbolic links in ~org-directory~ need to have the same name +[fn:145] Symbolic links in ~org-directory~ need to have the same name as their targets. -[fn:145] While creating the agendas, Org mode forces ID properties on +[fn:146] While creating the agendas, Org mode forces ID properties on all referenced entries, so that these entries can be uniquely identified if MobileOrg 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:146] Checksums are stored automatically in the file +[fn:147] Checksums are stored automatically in the file =checksums.dat=. -[fn:147] The file will be empty after this operation. +[fn:148] The file will be empty after this operation. diff --git a/doc/org.texi b/doc/org.texi index 39dbafd..c160ec7 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -9708,10 +9708,13 @@ Time ranges can be specified with two timestamps: <2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15> @end example -In the headline of the entry itself, a time(range) may also appear as -plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda integrates -the Emacs diary (see @ref{Weekly/daily agenda}), time specifications in -diary entries are recognized as well. +@vindex org-agenda-search-headline-for-time +In the headline of the entry itself, a time(range)---like @samp{12:45} or +a @samp{8:30-1pm}---may also appear as plain text@footnote{You can, however, disable this by setting +@code{org-agenda-search-headline-for-time} variable to a @code{nil} value.}. + +If the agenda integrates the Emacs diary (see @ref{Weekly/daily agenda}), +time specifications in diary entries are recognized as well. For agenda display, Org mode extracts the time and displays it in a standard 24 hour format as part of the prefix. The example times in |