aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/ChangeLog15
-rw-r--r--doc/misc/htmlfontify.texi49
-rw-r--r--doc/misc/org.texi78
3 files changed, 97 insertions, 45 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 91a328198a2..fba163a84ac 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,18 @@
12013-01-09 Bastien Guerry <bzg@gnu.org>
2
3 * org.texi (Pushing to MobileOrg): Add footnote about using
4 symbolic links in `org-directory'.
5 (Timestamps, Deadlines and scheduling): Use `diary-float' instead
6 of the now obsolete alias `org-float'.
7 (TODO basics): Add `org-use-fast-todo-selection' to the variable
8 index. Fix description of TODO keywords cycling.
9 (Advanced features): Add missing argument for @item.
10 (Storing searches): Add index entries and a note about
11 *-tree agenda views.
12 (Structure editing): Document `org-mark-element' and
13 `org-mark-subtree'.
14 (Tag inheritance): Document `org-agenda-use-tag-inheritance'.
15
12013-01-08 Juri Linkov <juri@jurta.org> 162013-01-08 Juri Linkov <juri@jurta.org>
2 17
3 * info.texi (Go to node): Mention the abbreviated format 18 * info.texi (Go to node): Mention the abbreviated format
diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi
index 911cdd3cd5f..6cb8942bf15 100644
--- a/doc/misc/htmlfontify.texi
+++ b/doc/misc/htmlfontify.texi
@@ -7,7 +7,7 @@
7 7
8@copying 8@copying
9This manual documents Htmlfontify, a source code -> crosslinked + 9This manual documents Htmlfontify, a source code -> crosslinked +
10formatted + syntax colorised html transformer. 10formatted + syntax colorized html transformer.
11 11
12Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. 12Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc.
13 13
@@ -56,7 +56,7 @@ modify this GNU manual.''
56@menu 56@menu
57* Introduction:: About Htmlfontify. 57* Introduction:: About Htmlfontify.
58* Usage & Examples:: How to use Htmlfontify. 58* Usage & Examples:: How to use Htmlfontify.
59* Customisation:: Fine-tuning Htmlfontify's behaviour. 59* Customization:: Fine-tuning Htmlfontify's behaviour.
60* Requirements:: External programs used by Htmlfontify. 60* Requirements:: External programs used by Htmlfontify.
61* GNU Free Documentation License:: The license for this documentation. 61* GNU Free Documentation License:: The license for this documentation.
62* Index:: Index of contents. 62* Index:: Index of contents.
@@ -68,7 +68,7 @@ modify this GNU manual.''
68 68
69Htmlfontify provides a means of converting individual Emacs buffers, 69Htmlfontify provides a means of converting individual Emacs buffers,
70source files, or entire source trees to html, preserving formatting 70source files, or entire source trees to html, preserving formatting
71and Emacs colorisation / syntax highlighting as much as possible 71and Emacs colorization / syntax highlighting as much as possible
72through careful application of CSS stylesheets and html tags. 72through careful application of CSS stylesheets and html tags.
73 73
74It can also turn instances of functions, methods and (for some 74It can also turn instances of functions, methods and (for some
@@ -76,7 +76,7 @@ languages) variables and other constructs and items into links
76to their definitions, and create an index file (or files) of 76to their definitions, and create an index file (or files) of
77all such symbols, also linked to their points of definition. 77all such symbols, also linked to their points of definition.
78 78
79Htmlfontify also provides several customisation items, which should 79Htmlfontify also provides several customization items, which should
80allow it to mesh more-or-less seamlessly with various templating or 80allow it to mesh more-or-less seamlessly with various templating or
81publishing systems (in the event, for instance, that you don't want 81publishing systems (in the event, for instance, that you don't want
82to produce the html pages directly). 82to produce the html pages directly).
@@ -93,7 +93,7 @@ batch mode.
93@menu 93@menu
94* Interactive:: Using Htmlfontify interactively. 94* Interactive:: Using Htmlfontify interactively.
95* Non-interactive:: Using Htmlfontify from elisp. 95* Non-interactive:: Using Htmlfontify from elisp.
96* Variables:: Variables (other than customisation entries). 96* Variables:: Variables (other than customization entries).
97* Data Structures:: Important data structures. 97* Data Structures:: Important data structures.
98* Examples:: Example(s) of Htmlfontify in use. 98* Examples:: Example(s) of Htmlfontify in use.
99@end menu 99@end menu
@@ -236,7 +236,7 @@ color map specified, otherwise it uses Htmlfontify's built in map.
236@end lisp 236@end lisp
237 237
238Return a @code{defface} style alist of possible specifications for 238Return a @code{defface} style alist of possible specifications for
239@var{face}, with any entries resulting from user customisation 239@var{face}, with any entries resulting from user customization
240(@code{custom-set-faces}) taking precedence. 240(@code{custom-set-faces}) taking precedence.
241 241
242See also: @ref{hfy-default-face-def} 242See also: @ref{hfy-default-face-def}
@@ -268,10 +268,10 @@ does things like deferring fontification until a section of the buffer is
268exposed and rendered, or until Emacs is idle for a while. Sometimes, in 268exposed and rendered, or until Emacs is idle for a while. Sometimes, in
269non-interactive circumstances, or if it can't see X, it doesn't bother 269non-interactive circumstances, or if it can't see X, it doesn't bother
270with some of the harder stuff. While this is all great from the perspective 270with some of the harder stuff. While this is all great from the perspective
271of a user waiting for Emacs to load a 20000 line file and colorise it, 271of a user waiting for Emacs to load a 20000 line file and colorize it,
272it's a pain from the point of view from non-interactive code. This function 272it's a pain from the point of view from non-interactive code. This function
273lies, cheats, steals and generally bullies Emacs into fontifying a buffer 273lies, cheats, steals and generally bullies Emacs into fontifying a buffer
274from start to finish, with all the extra frills, whether it thinks it nneds 274from start to finish, with all the extra frills, whether it thinks it needs
275to or not. Oh yes: it operates on the current buffer. 275to or not. Oh yes: it operates on the current buffer.
276 276
277@item hfy-link-style-string 277@item hfy-link-style-string
@@ -861,7 +861,7 @@ As per @ref{hfy-color} but for background colors.
861(hfy-kludge-cperl-mode) 861(hfy-kludge-cperl-mode)
862@end lisp 862@end lisp
863 863
864cperl mode does its damndest not to do some of its fontification when not 864cperl mode does its best to not do some of its fontification when not
865in a windowing system---we try to trick it@dots{} 865in a windowing system---we try to trick it@dots{}
866 866
867@item hfy-href 867@item hfy-href
@@ -1044,7 +1044,7 @@ Convert an Emacs @code{:width} attribute to a CSS font-stretch attribute.
1044@section Variables 1044@section Variables
1045@cindex variables 1045@cindex variables
1046 1046
1047Important variables that are not customisation items: 1047Important variables that are not customization items:
1048 1048
1049@table @code 1049@table @code
1050 1050
@@ -1234,7 +1234,7 @@ main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file))
1234 1234
1235;; Here's the function I actually call---it asks me for a section label, 1235;; Here's the function I actually call---it asks me for a section label,
1236;; and source and destination directories, and then binds a couple of 1236;; and source and destination directories, and then binds a couple of
1237;; customisation variable in a let before calling htmlfontify: 1237;; customization variable in a let before calling htmlfontify:
1238(defun rtfm-build-source-docs (section srcdir destdir) 1238(defun rtfm-build-source-docs (section srcdir destdir)
1239 (interactive 1239 (interactive
1240 "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ") 1240 "s section[eg- emacs / p4-blame]:\nD source-dir: \nD output-dir: ")
@@ -1252,11 +1252,11 @@ main-content <=MAIN_CONTENT;\n" rtfm-section file style rtfm-section file))
1252 (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html"))) 1252 (htmlfontify-copy-and-link-dir srcdir destdir ".src" ".html")))
1253@end lisp 1253@end lisp
1254 1254
1255@node Customisation 1255@node Customization
1256@chapter Customisation 1256@chapter Customization
1257@cindex variables (customisation) 1257@cindex variables (customization)
1258 1258
1259Htmlfontify provides the following variable and customisation entries: 1259Htmlfontify provides the following variable and customization entries:
1260 1260
1261@table @code 1261@table @code
1262@comment AUTOGENERATED BLOCK 1262@comment AUTOGENERATED BLOCK
@@ -1394,7 +1394,7 @@ when @ref{hfy-display-class} has been set (the normal Htmlfontify way of
1394extracting potentially non-current face information doesn't necessarily 1394extracting potentially non-current face information doesn't necessarily
1395work for @code{default}). 1395work for @code{default}).
1396 1396
1397For example, I customise this to: 1397For example, I customize this to:
1398 1398
1399@lisp 1399@lisp
1400((t :background "black" :foreground "white" :family "misc-fixed")) 1400((t :background "black" :foreground "white" :family "misc-fixed"))
@@ -1405,7 +1405,7 @@ For example, I customise this to:
1405@anchor{hfy-init-kludge-hooks} 1405@anchor{hfy-init-kludge-hooks}
1406 1406
1407List of functions to call when starting htmlfontify-buffer to do any 1407List of functions to call when starting htmlfontify-buffer to do any
1408kludging necessary to get highlighting modes to bahave as you want, even 1408kludging necessary to get highlighting modes to behave as you want, even
1409when not running under a window system. 1409when not running under a window system.
1410 1410
1411@item hfy-shell-file-name 1411@item hfy-shell-file-name
@@ -1421,7 +1421,7 @@ Currently this is only required/used when using GNU etags, see
1421@vindex hfy-optimisations 1421@vindex hfy-optimisations
1422@anchor{hfy-optimisations} 1422@anchor{hfy-optimisations}
1423 1423
1424Optimisations to turn on. So far, the following have been implemented: 1424Optimizations to turn on. So far, the following have been implemented:
1425 1425
1426@table @option 1426@table @option
1427@item merge-adjacent-tags 1427@item merge-adjacent-tags
@@ -1454,7 +1454,8 @@ Suppress hyperlinking between files highlighted by different modes.
1454 1454
1455@end table 1455@end table
1456 1456
1457Note: like compiler optimisations, these optimise the _output_ of the code, 1457Note: like compiler optimizations, these optimize the @emph{output} of
1458the code,
1458not the processing of the source itself, and are therefore likely to slow 1459not the processing of the source itself, and are therefore likely to slow
1459Htmlfontify down, at least a little. Except for skip-refontification, 1460Htmlfontify down, at least a little. Except for skip-refontification,
1460which can never slow you down, but may result in incomplete fontification. 1461which can never slow you down, but may result in incomplete fontification.
@@ -1470,7 +1471,7 @@ Regex to remove from the <style> a variant of an Htmlfontify CSS class.
1470@anchor{hfy-link-extn} 1471@anchor{hfy-link-extn}
1471 1472
1472File extension used for href links---useful where the Htmlfontify 1473File extension used for href links---useful where the Htmlfontify
1473output files are going to be processed again, with a rersulting change 1474output files are going to be processed again, with a resulting change
1474in file extension. If @code{nil}, then any code using this should fall back 1475in file extension. If @code{nil}, then any code using this should fall back
1475to @ref{hfy-extn}. 1476to @ref{hfy-extn}.
1476 1477
@@ -1570,16 +1571,16 @@ money are always welcome.
1570 1571
1571@item 1572@item
1572A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts 1573A copy of etags (exuberant-ctags or GNU etags). Htmlfontify attempts
1573to autodetect the version you have and customise itself accordingly, 1574to autodetect the version you have and customize itself accordingly,
1574but you should be able to override this. 1575but you should be able to override this.
1575 1576
1576See: @ref{Customisation} 1577See: @ref{Customization}
1577 1578
1578@item 1579@item
1579A copy of find (e.g., GNU find) that provides the @code{-path} predicate. 1580A copy of find (e.g., GNU find) that provides the @code{-path} predicate.
1580 1581
1581You may be able to work around this with a suitable clever shell 1582You may be able to work around this with a suitable clever shell
1582command and the customisation entry: @ref{hfy-find-cmd} 1583command and the customization entry: @ref{hfy-find-cmd}
1583 1584
1584@item 1585@item
1585A copy of sed (e.g., GNU sed). 1586A copy of sed (e.g., GNU sed).
@@ -1603,7 +1604,7 @@ A copy of the @code{file} command.
1603@item Functions 1604@item Functions
1604@printindex fn 1605@printindex fn
1605 1606
1606@item Variables & Customisation 1607@item Variables & Customization
1607@printindex vr 1608@printindex vr
1608 1609
1609@end table 1610@end table
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index 47ee0954671..75298db29fe 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -2,7 +2,7 @@
2@c %**start of header 2@c %**start of header
3@setfilename ../../info/org 3@setfilename ../../info/org
4@settitle The Org Manual 4@settitle The Org Manual
5@set VERSION 7.9.2 (GNU Emacs 24.3) 5@set VERSION 7.9.3+ (GNU Emacs 24.3)
6 6
7@c Use proper quote and backtick for code sections in PDF output 7@c Use proper quote and backtick for code sections in PDF output
8@c Cf. Texinfo manual 14.2 8@c Cf. Texinfo manual 14.2
@@ -1470,6 +1470,13 @@ Move subtree up (swap with previous subtree of same
1470level). 1470level).
1471@orgcmd{M-S-@key{down},org-move-subtree-down} 1471@orgcmd{M-S-@key{down},org-move-subtree-down}
1472Move subtree down (swap with next subtree of same level). 1472Move subtree down (swap with next subtree of same level).
1473@orgcmd{M-h,org-mark-element}
1474Mark the element at point. Hitting repeatedly will mark subsequent elements
1475of the one just marked. E.g. hitting @key{M-h} on a paragraph will mark it,
1476hitting @key{M-h} immediately again will mark the next one.
1477@orgcmd{C-c @@,org-mark-subtree}
1478Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1479of the same level than the marked subtree.
1473@orgcmd{C-c C-x C-w,org-cut-subtree} 1480@orgcmd{C-c C-x C-w,org-cut-subtree}
1474Kill subtree, i.e., remove it from buffer but save in kill ring. 1481Kill subtree, i.e., remove it from buffer but save in kill ring.
1475With a numeric prefix argument N, kill N sequential subtrees. 1482With a numeric prefix argument N, kill N sequential subtrees.
@@ -3747,6 +3754,8 @@ The most important commands to work with TODO entries are:
3747@table @kbd 3754@table @kbd
3748@orgcmd{C-c C-t,org-todo} 3755@orgcmd{C-c C-t,org-todo}
3749@cindex cycling, of TODO states 3756@cindex cycling, of TODO states
3757@vindex org-use-fast-todo-selection
3758
3750Rotate the TODO state of the current item among 3759Rotate the TODO state of the current item among
3751 3760
3752@example 3761@example
@@ -3754,14 +3763,19 @@ Rotate the TODO state of the current item among
3754'--------------------------------' 3763'--------------------------------'
3755@end example 3764@end example
3756 3765
3757The same rotation can also be done ``remotely'' from the timeline and 3766If TODO keywords have fast access keys (see @ref{Fast access to TODO
3758agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). 3767states}), you will be prompted for a TODO keyword through the fast selection
3768interface; this is the default behavior when
3769@var{org-use-fast-todo-selection} is @code{non-nil}.
3770
3771The same rotation can also be done ``remotely'' from the timeline and agenda
3772buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3759 3773
3760@orgkey{C-u C-c C-t} 3774@orgkey{C-u C-c C-t}
3761Select a specific keyword using completion or (if it has been set up) 3775When TODO keywords have no selection keys, select a specific keyword using
3762the fast selection interface. For the latter, you need to assign keys 3776completion; otherwise force cycling through TODO states with no prompt. When
3763to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for 3777@var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3764more information. 3778selection interface.
3765 3779
3766@kindex S-@key{right} 3780@kindex S-@key{right}
3767@kindex S-@key{left} 3781@kindex S-@key{left}
@@ -4617,9 +4631,8 @@ changes in the line.}:
4617@noindent 4631@noindent
4618@vindex org-use-tag-inheritance 4632@vindex org-use-tag-inheritance
4619@vindex org-tags-exclude-from-inheritance 4633@vindex org-tags-exclude-from-inheritance
4620To limit tag inheritance to specific tags, or to turn it off entirely, use 4634To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4621the variables @code{org-use-tag-inheritance} and 4635To turn it off entirely, use @code{org-use-tag-inheritance}.
4622@code{org-tags-exclude-from-inheritance}.
4623 4636
4624@vindex org-tags-match-list-sublevels 4637@vindex org-tags-match-list-sublevels
4625When a headline matches during a tags search while tag inheritance is turned 4638When a headline matches during a tags search while tag inheritance is turned
@@ -4630,6 +4643,15 @@ of matches may then become very long. If you only want to see the first tags
4630match in a subtree, configure the variable 4643match in a subtree, configure the variable
4631@code{org-tags-match-list-sublevels} (not recommended). 4644@code{org-tags-match-list-sublevels} (not recommended).
4632 4645
4646@vindex org-agenda-use-tag-inheritance
4647Tag inheritance is relevant when the agenda search tries to match a tag,
4648either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4649types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4650have your tags correctly set in the agenda, so that tag filtering works fine,
4651with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4652this: the default value includes all agenda types, but setting this to nil
4653can really speed up agenda generation.
4654
4633@node Setting tags, Tag searches, Tag inheritance, Tags 4655@node Setting tags, Tag searches, Tag inheritance, Tags
4634@section Setting tags 4656@section Setting tags
4635@cindex setting tags 4657@cindex setting tags
@@ -5512,7 +5534,7 @@ example with optional time
5512 5534
5513@example 5535@example
5514* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month 5536* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5515 <%%(org-float t 4 2)> 5537 <%%(diary-float t 4 2)>
5516@end example 5538@end example
5517 5539
5518@item Time/Date range 5540@item Time/Date range
@@ -5850,7 +5872,7 @@ entries. Org mode will issue early and late warnings based on the
5850assumption that the timestamp represents the @i{nearest instance} of 5872assumption that the timestamp represents the @i{nearest instance} of
5851the repeater. However, the use of diary sexp entries like 5873the repeater. However, the use of diary sexp entries like
5852@c 5874@c
5853@code{<%%(org-float t 42)>} 5875@code{<%%(diary-float t 42)>}
5854@c 5876@c
5855in scheduling and deadline timestamps is limited. Org mode does not 5877in scheduling and deadline timestamps is limited. Org mode does not
5856know enough about the internals of each sexp function to issue early and 5878know enough about the internals of each sexp function to issue early and
@@ -6539,7 +6561,7 @@ suggestion.} for capturing new material.
6539@table @kbd 6561@table @kbd
6540@orgcmd{C-c c,org-capture} 6562@orgcmd{C-c c,org-capture}
6541Call the command @code{org-capture}. Note that this keybinding is global and 6563Call the command @code{org-capture}. Note that this keybinding is global and
6542not active by default; you need to install it. If you have templates 6564not active by default: you need to install it. If you have templates
6543@cindex date tree 6565@cindex date tree
6544defined @pxref{Capture templates}, it will offer these templates for 6566defined @pxref{Capture templates}, it will offer these templates for
6545selection or use a new Org outline node as the default template. It will 6567selection or use a new Org outline node as the default template. It will
@@ -8621,6 +8643,13 @@ buffer, or a sparse tree (the latter covering of course only the current
8621buffer). 8643buffer).
8622@kindex C-c a C 8644@kindex C-c a C
8623@vindex org-agenda-custom-commands 8645@vindex org-agenda-custom-commands
8646@cindex agenda views, main example
8647@cindex tags, as an agenda view
8648@cindex todo, as an agenda view
8649@cindex tags-todo
8650@cindex todo-tree
8651@cindex occur-tree
8652@cindex tags-tree
8624 8653
8625Custom commands are configured in the variable 8654Custom commands are configured in the variable
8626@code{org-agenda-custom-commands}. You can customize this variable, for 8655@code{org-agenda-custom-commands}. You can customize this variable, for
@@ -8681,6 +8710,9 @@ additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8681Peter, or Kim) as additional tag to match. 8710Peter, or Kim) as additional tag to match.
8682@end table 8711@end table
8683 8712
8713Note that the @code{*-tree} agenda views need to be called from an
8714Org buffer as they operate on the current buffer only.
8715
8684@node Block agenda, Setting Options, Storing searches, Custom agenda views 8716@node Block agenda, Setting Options, Storing searches, Custom agenda views
8685@subsection Block agenda 8717@subsection Block agenda
8686@cindex block agenda 8718@cindex block agenda
@@ -16537,14 +16569,18 @@ to the directory @code{org-mobile-directory}. By default this list contains
16537all agenda files (as listed in @code{org-agenda-files}), but additional files 16569all agenda files (as listed in @code{org-agenda-files}), but additional files
16538can be included by customizing @code{org-mobile-files}. File names will be 16570can be included by customizing @code{org-mobile-files}. File names will be
16539staged with paths relative to @code{org-directory}, so all files should be 16571staged with paths relative to @code{org-directory}, so all files should be
16540inside this directory. The push operation also creates a special Org file 16572inside this directory@footnote{Symbolic links in @code{org-directory} need to
16541@file{agendas.org} with all custom agenda view defined by the 16573have the same name than their targets.}.
16542user@footnote{While creating the agendas, Org mode will force ID properties 16574
16543on all referenced entries, so that these entries can be uniquely identified 16575The push operation also creates a special Org file @file{agendas.org} with
16544if @i{MobileOrg} flags them for further action. If you do not want to get 16576all custom agenda view defined by the user@footnote{While creating the
16545these properties in so many entries, you can set the variable 16577agendas, Org mode will force ID properties on all referenced entries, so that
16546@code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then 16578these entries can be uniquely identified if @i{MobileOrg} flags them for
16547rely on outline paths, in the hope that these will be unique enough.}. 16579further action. If you do not want to get these properties in so many
16580entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
16581to @code{nil}. Org mode will then rely on outline paths, in the hope that
16582these will be unique enough.}.
16583
16548Finally, Org writes the file @file{index.org}, containing links to all other 16584Finally, Org writes the file @file{index.org}, containing links to all other
16549files. @i{MobileOrg} first reads this file from the server, and then 16585files. @i{MobileOrg} first reads this file from the server, and then
16550downloads all agendas and Org files listed in it. To speed up the download, 16586downloads all agendas and Org files listed in it. To speed up the download,