Release 4.60

This commit is contained in:
Carsten Dominik 2008-01-31 11:33:32 +01:00
parent bd2ceb1b54
commit 09ce054931
7 changed files with 986 additions and 491 deletions

574
org
View File

@ -5,7 +5,7 @@ START-INFO-DIR-ENTRY
* Org Mode: (org). outline-based notes management and organizer
END-INFO-DIR-ENTRY
This manual is for Org-mode (version 4.59).
This manual is for Org-mode (version 4.60).
Copyright (C) 2004, 2005, 2006 Free Software Foundation
@ -27,7 +27,7 @@ File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
Org Mode Manual
***************
This manual is for Org-mode (version 4.59).
This manual is for Org-mode (version 4.60).
Copyright (C) 2004, 2005, 2006 Free Software Foundation
@ -149,6 +149,7 @@ Creating timestamps
Progress Logging
* Closing items:: When was this entry marked DONE?
* Tracking TODO state changes:: When did the status change?
* Clocking work time:: When exactly did you work on this item?
Tags
@ -203,6 +204,14 @@ Exporting
* iCalendar export:: Exporting in iCalendar format
* Text interpretation:: How the exporter looks at the file
HTML export
* Export commands:: How to invode HTML export
* Quoting HTML tags:: Using direct HTML in Org-mode
* Links:: How hyperlinks get transferred to HTML
* Images:: To inline or not to inline?
* CSS support:: Style specifications
Text interpretation by the exporter
* Comment lines:: Some lines will not be exported
@ -537,7 +546,8 @@ the visibility in the buffer.
Reveal context around point, showing the current entry, the
following heading and the hierarchy above. Useful for working
near a location exposed by a sparse tree command (*note Sparse
trees::) or an agenda command (*note Agenda commands::).
trees::) or an agenda command (*note Agenda commands::). With
prefix arg show, on each level, all sibling headings.
`C-c C-x b'
Show the current subtree in an indirect buffer(3). With numerical
@ -802,8 +812,9 @@ only the visible part of the document and print the resulting file.
---------- Footnotes ----------
(1) See also the variables `org-show-hierarchy-above' and
`org-show-following-heading'.
(1) See also the variables `org-show-hierarchy-above',
`org-show-following-heading', and `org-show-siblings' for detailed
control on how much context is shown around each match.
(2) This does not work under XEmacs, because XEmacs uses selective
display for outlining, not text properties.
@ -1679,10 +1690,15 @@ format::), for example:
[[http://www.gnu.org/software/emacs/][GNU Emacs]]
If the description is a file name or URL that points to an image, HTML
export (*note HTML export::) will inline the image as a clickable
button. If there is no description at all and the link points to an
image, that image will be inlined into the exported HTML file.
Org-mode also finds external links in the normal text and activates
them as links. If spaces must be part of the link (for example in
`bbdb:Richard Stallman'), or you need to remove ambiguities about the
end of the link, enclose them in angular brackets.
`bbdb:Richard Stallman'), or if you need to remove ambiguities about
the end of the link, enclose them in angular brackets.

File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
@ -2085,7 +2101,9 @@ from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
also use a prefix argument to quickly select a specific state. For
example `C-3 C-c C-t' will change the state immediately to VERIFY. If
you define many keywords, you can use in-buffer completion (see *Note
Completion::) to insert these words into the buffer.
Completion::) to insert these words into the buffer. Changing a todo
state can be logged with a timestamp, see *Note Tracking TODO state
changes:: for more information.

File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
@ -2564,40 +2582,72 @@ File: org, Node: Progress logging, Prev: Custom time format, Up: Timestamps
====================
Org-mode can automatically record a time stamp when you mark a TODO item
as DONE. You can also measure precisely the time you spent on specific
items in a project by starting and stopping a clock when you start and
stop working on an aspect of a project.
as DONE, or even each time when you change the state of a TODO item.
You can also measure precisely the time you spent on specific items in a
project by starting and stopping a clock when you start and stop working
on an aspect of a project.
* Menu:
* Closing items:: When was this entry marked DONE?
* Tracking TODO state changes:: When did the status change?
* Clocking work time:: When exactly did you work on this item?

File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging
6.4.1 Closing items
-------------------
If you want to keep track of _when_ a certain TODO item was finished,
turn on logging with
turn on logging with(1)
(setq org-log-done t)
Then each time you turn a TODO entry into DONE using either `C-c C-t'
in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
[timestamp]' will be inserted just after the headline. If you turn the
entry back into a TODO item again through further state cycling, that
line will be removed again. In the timeline (*note Timeline::) and in
the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
to display the TODO items closed on each day, giving you an overview of
what has been done on a day. See the variable `org-log-done' for the
possibility to record an additional note together with a timestamp.
entry back into a TODO item through further state cycling, that line
will be removed again. In the timeline (*note Timeline::) and in the
agenda (*note Weekly/Daily agenda::), you can then use the `l' key to
display the TODO items closed on each day, giving you an overview of
what has been done on a day. If you want to record a note along with
the timestamp, use(2)
(setq org-log-done '(done))
---------- Footnotes ----------
(1) The corresponding in-buffer setting is: `#+STARTUP: logdone'
(2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'

File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging
6.4.2 Clocking work time
6.4.2 Tracking TODO state changes
---------------------------------
When TODO keywords are used as workflow states (*note Workflow
states::), you might want to keep track of when a state change occurred,
and you may even want to attach notes to that state change. With the
setting
(setq org-log-done '(state))
each state change will prompt you for a note that will be attached to
the current headline. Very likely you do not want this verbose tracking
all the time, so it is probably better to configure this behavior with
in-buffer options. For example, if you are tracking purchases, put
these into a separate file that starts with:
#+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
#+STARTUP: lognotestate

File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging
6.4.3 Clocking work time
------------------------
Org-mode allows you to clock the time you spent on specific tasks in a
@ -2615,7 +2665,8 @@ also computes the total time spent on each subtree of a project.
same location where the clock was last started. It also directly
computes the resulting time in inserts it after the time range as
`=> HH:MM'. See the variable `org-log-done' for the possibility to
record an additional note together with the clock-out time stamp.
record an additional note together with the clock-out time
stamp(1).
`C-c C-y'
Recompute the time interval after changing one of the time stamps.
@ -2658,7 +2709,7 @@ also computes the total time spent on each subtree of a project.
#+BEGIN: clocktable :maxlevel 2 :block today
#+END: clocktable
and to use a specific time range you could write(1)
and to use a specific time range you could write(2)
#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
:tend "<2006-08-10 Thu 12:00>"
@ -2674,7 +2725,10 @@ worked on or closed during a day.
---------- Footnotes ----------
(1) Note that all parameters must be specified in a single line -
(1) The corresponding in-buffer setting is: `#+STARTUP:
lognoteclock-out'
(2) Note that all parameters must be specified in a single line -
the line is broken here only to fit it onto the manual.

@ -4043,6 +4097,20 @@ Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
HTML formatting, in ways similar to John Grubers _markdown_ language,
but with additional support for tables.
* Menu:
* Export commands:: How to invode HTML export
* Quoting HTML tags:: Using direct HTML in Org-mode
* Links:: How hyperlinks get transferred to HTML
* Images:: To inline or not to inline?
* CSS support:: Style specifications

File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export
10.2.1 HTML export commands
---------------------------
`C-c C-e h'
Export as HTML file `myfile.html'.
@ -4064,11 +4132,23 @@ example,
creates two levels of headings and does the rest as items.
If you want to include HTML tags which should be interpreted as such,

File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export
10.2.2 Quoting HTML tags
------------------------
If you want to include HTML tags which should be interpreted as such,
mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
always transformed to `&lt;' and `&gt;' in HTML export.
Internal links (*note Internal links::) will continue to work in HTML

File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export
10.2.3 Links
------------
Internal links (*note Internal links::) will continue to work in HTML
files only if they match a dedicated `<<target>>'. Automatic links
created by radio targets (*note Radio targets::) will also work in the
HTML file. Links to external files will still work if the HTML file is
@ -4078,7 +4158,38 @@ HTML version also exists of the linked file. For information related to
linking files while publishing them to a publishing directory see *Note
Publishing links::.
You can also give style information for the exported file. The HTML

File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export
10.2.4 Images
-------------
HTML export can inline images given as links in the Org-mode file, and
it can make an image the clickable part of a link. By default(1),
images are inlined if a link does not have a description. So
`[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the
image]]' will just produce a link `the image' that points to the image.
If the description part itself is a `file:' link or a `http:' URL
pointing to an image, this image will be inlined and activated so that
clicking on the image will activate the link. For example, to include
a thumbnail that will link to a high resolution version of the image,
you could use:
[[file:highres.jpg][file:thumb.jpg]]
and you could use `http' addresses just as well.
---------- Footnotes ----------
(1) but see the variable `org-export-html-inline-images'

File: org, Node: CSS support, Prev: Images, Up: HTML export
10.2.5 CSS support
------------------
You can also give style information for the exported file. The HTML
exporter assigns the following CSS classes to appropriate parts of the
document - your style specifications may change these:
.todo TODO keywords
@ -4091,9 +4202,9 @@ document - your style specifications may change these:
The default style specification can be configured through the option
`org-export-html-style'. If you want to use a file-local style, you
may use file variables, best wrapped into a COMMENT section at the end
of the outline tree. For example:
of the outline tree. For example(1):
* COMMENT HTML style specifications
* COMMENT html style specifications
# Local Variables:
# org-export-html-style: " <style type=\"text/css\">
@ -4107,6 +4218,11 @@ the new style visible to Emacs. This command restarts org-mode for the
current buffer and forces Emacs to re-evaluate the local variables
section in the buffer.
---------- Footnotes ----------
(1) Under Emacs 21, the continuation lines for a variable value
should have no `#' at the start of the line.

File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
@ -4702,31 +4818,34 @@ file is visited again in a new Emacs session.
with the initial visibility of the outline tree. The
corresponding variable for global default settings is
`org-startup-folded', with a default value `t', which means
`overview'.
`overview'.
overview top-level headlines only
content all headlines
showall no folding at all, show everything
Then there are options for aligning tables upon visiting a file.
This is useful in files containing narrowed table columns. The
corresponding variable is `org-startup-align-all-tables', with a
default value `nil'.
default value `nil'.
align align all tables
noalign don't align tables on startup
Logging when a TODO item is marked DONE (variable `org-log-done')
can be configured using these options.
logging record a timestamp when an item is marked DONE
nologging don't record when items are marked DONE
Logging TODO state changes and clock intervals (variable
`org-log-done') can be configured using these options.
logging record a timestamp when an item is marked DONE
nologging don't record when items are marked DONE
lognotedone record timestamp and a note when DONE
lognotestate record timestamp, note when TODO state changes
lognoteclock-out record timestamp and a note when clocking out
Here are the options for hiding leading stars in outline headings.
The corresponding variables are `org-hide-leading-stars' and
`org-odd-levels-only', both with a default setting `nil' (meaning
`showstars' and `oddeven').
`showstars' and `oddeven').
hidestars make all but one of the stars starting a headline invisible.
showstars show all stars starting a headline
odd allow only odd outline levels (1,3,...)
oddeven allow all outline levels
To turn on custom format overlays over time stamps (variables
`org-put-time-stamp-overlays' and
`org-time-stamp-overlay-formats'), use
`org-time-stamp-overlay-formats'), use
customtime overlay custom time format
`#+SEQ_TODO: #+TYP_TODO:'
@ -5263,6 +5382,9 @@ if I have forgotten someone, please accept my apologies and let me know.
* Nic Ferrier contributed mailcap and XOXO support.
* John Foerch figured out how to make incremental search show context
around a match in a hidden outline tree.
* Niels Giessen had the idea to automatically archive DONE trees.
* Bastien Guerry provided extensive feedback.
@ -5356,7 +5478,7 @@ Index
(line 6)
* action, for publishing: Publishing action. (line 6)
* activation: Activation. (line 6)
* active region <1>: HTML export. (line 10)
* active region <1>: Export commands. (line 6)
* active region <2>: ASCII export. (line 9)
* active region <3>: Built-in table editor.
(line 171)
@ -5369,8 +5491,9 @@ Index
* agenda views, custom: Custom agenda views. (line 6)
* agenda, batch production: Batch processing. (line 6)
* agenda, with block views: Block agenda. (line 6)
* align, STARTUP keyword: In-buffer settings. (line 29)
* allout.el: Conflicts. (line 6)
* angular brackets, around links: External links. (line 38)
* angular brackets, around links: External links. (line 43)
* applescript, for calendar update: iCalendar export. (line 38)
* archive locations: Moving subtrees. (line 21)
* archiving: Archiving. (line 6)
@ -5426,6 +5549,7 @@ Index
* completion, of TODO keywords: Workflow states. (line 12)
* constants, in calculations: Formula syntax. (line 26)
* constants.el: Cooperation. (line 14)
* content, STARTUP keyword: In-buffer settings. (line 22)
* contents, global visibility state: Visibility cycling. (line 22)
* copying, of subtrees: Structure editing. (line 6)
* creating timestamps: Creating timestamps. (line 6)
@ -5434,6 +5558,7 @@ Index
* custom date/time format: Custom time format. (line 6)
* custom search strings: Custom searches. (line 6)
* customization: Customization. (line 6)
* customtime, STARTUP keyword: In-buffer settings. (line 49)
* cutting, of subtrees: Structure editing. (line 6)
* cycling, of TODO states: TODO basics. (line 13)
* cycling, visibility: Visibility cycling. (line 6)
@ -5462,12 +5587,13 @@ Index
* emphasized text: Export options. (line 25)
* enhancing text: Enhancing text. (line 6)
* evaluate time range: Creating timestamps. (line 66)
* even, STARTUP keyword: In-buffer settings. (line 42)
* exporting: Exporting. (line 6)
* exporting, not: Comment lines. (line 6)
* extended TODO keywords: TODO extensions. (line 6)
* external archiving: Moving subtrees. (line 6)
* external links: External links. (line 6)
* external links, in HTML export: HTML export. (line 35)
* external links, in HTML export: Links. (line 6)
* FAQ: Summary. (line 51)
* feedback: Feedback. (line 6)
* file links: External links. (line 6)
@ -5498,29 +5624,32 @@ Index
* GNUS links: External links. (line 6)
* hand-formatted lists: Enhancing text. (line 11)
* headline levels: Export options. (line 25)
* headline levels, for exporting <1>: HTML export. (line 21)
* headline levels, for exporting <1>: Export commands. (line 17)
* headline levels, for exporting: ASCII export. (line 18)
* headline navigation: Motion. (line 6)
* headline tagging: Tags. (line 6)
* headline, promotion and demotion: Structure editing. (line 6)
* headlines: Headlines. (line 6)
* hide text: Visibility cycling. (line 6)
* hidestars, STARTUP keyword: In-buffer settings. (line 42)
* hiding leading stars: Clean view. (line 6)
* history: History and Acknowledgments.
(line 6)
* HTML export: HTML export. (line 6)
* hyperlinks: Hyperlinks. (line 6)
* iCalendar export: iCalendar export. (line 6)
* images, inline in HTML: Images. (line 6)
* in-buffer settings: In-buffer settings. (line 6)
* inactive timestamp: Time stamps. (line 24)
* index, of published pages: Project page index. (line 6)
* Info links: External links. (line 6)
* inheritance, of tags: Tag inheritance. (line 6)
* inlining images in HTML: Images. (line 6)
* inserting links: Handling links. (line 27)
* installation: Installation. (line 6)
* internal archiving: ARCHIVE tag. (line 6)
* internal links: Internal links. (line 6)
* internal links, in HTML export: HTML export. (line 35)
* internal links, in HTML export: Links. (line 6)
* introduction: Introduction. (line 6)
* italic text: Enhancing text. (line 15)
* jumping, to headlines: Motion. (line 6)
@ -5540,7 +5669,7 @@ Index
* link format: Link format. (line 6)
* links, external: External links. (line 6)
* links, handling: Handling links. (line 6)
* links, in HTML export: HTML export. (line 35)
* links, in HTML export: Links. (line 6)
* links, internal: Internal links. (line 6)
* links, publishing: Publishing links. (line 6)
* links, radio targets: Radio targets. (line 6)
@ -5549,7 +5678,11 @@ Index
* lists, hand-formatted: Enhancing text. (line 11)
* lists, ordered: Plain lists. (line 6)
* lists, plain: Plain lists. (line 6)
* logdone, STARTUP keyword: In-buffer settings. (line 33)
* logging, of progress: Progress logging. (line 6)
* lognoteclock-out, STARTUP keyword: In-buffer settings. (line 33)
* lognotedone, STARTUP keyword: In-buffer settings. (line 33)
* lognotestate, STARTUP keyword: In-buffer settings. (line 33)
* maintainer: Feedback. (line 6)
* mark ring: Handling links. (line 81)
* marking characters, tables: Advanced features. (line 34)
@ -5567,7 +5700,10 @@ Index
(line 6)
* names as TODO keywords: TODO types. (line 6)
* narrow columns in tables: Narrow columns. (line 6)
* noalign, STARTUP keyword: In-buffer settings. (line 29)
* nologging, STARTUP keyword: In-buffer settings. (line 33)
* occur, command: Sparse trees. (line 6)
* odd, STARTUP keyword: In-buffer settings. (line 42)
* option keyword completion: Completion. (line 6)
* options, for custom agenda views: Setting Options. (line 6)
* options, for customization: Customization. (line 6)
@ -5585,11 +5721,12 @@ Index
* outline-mode: Outlines. (line 6)
* outlines: Outlines. (line 6)
* overview, global visibility state: Visibility cycling. (line 22)
* overview, STARTUP keyword: In-buffer settings. (line 22)
* packages, interaction with other: Interaction. (line 6)
* pasting, of subtrees: Structure editing. (line 6)
* per file keywords: Per file keywords. (line 6)
* plain lists: Plain lists. (line 6)
* plain text external links: External links. (line 38)
* plain text external links: External links. (line 43)
* presentation, of agenda items: Presentation and sorting.
(line 6)
* printing sparse trees: Sparse trees. (line 41)
@ -5604,7 +5741,7 @@ Index
* radio targets: Radio targets. (line 6)
* ranges, time: Time stamps. (line 6)
* recomputing table fields: Column formulas. (line 27)
* region, active <1>: HTML export. (line 10)
* region, active <1>: Export commands. (line 6)
* region, active <2>: ASCII export. (line 9)
* region, active <3>: Built-in table editor.
(line 171)
@ -5627,6 +5764,8 @@ Index
* show all, command: Visibility cycling. (line 31)
* show all, global visibility state: Visibility cycling. (line 22)
* show hidden text: Visibility cycling. (line 6)
* showall, STARTUP keyword: In-buffer settings. (line 22)
* showstars, STARTUP keyword: In-buffer settings. (line 42)
* sorting, of agenda items: Sorting of agenda items.
(line 6)
* sparse tree, for deadlines: Creating timestamps. (line 41)
@ -5701,7 +5840,7 @@ Index
* TODO list, global: Global TODO list. (line 6)
* TODO types: TODO types. (line 6)
* TODO workflow: Workflow states. (line 6)
* transient-mark-mode <1>: HTML export. (line 10)
* transient-mark-mode <1>: Export commands. (line 6)
* transient-mark-mode <2>: ASCII export. (line 9)
* transient-mark-mode <3>: Built-in table editor.
(line 171)
@ -5845,17 +5984,17 @@ Key Index
* C-c C-d: Creating timestamps. (line 37)
* C-c C-e: Exporting. (line 19)
* C-c C-e a: ASCII export. (line 9)
* C-c C-e b: HTML export. (line 11)
* C-c C-e b: Export commands. (line 7)
* C-c C-e c: iCalendar export. (line 20)
* C-c C-e h: HTML export. (line 10)
* C-c C-e h: Export commands. (line 6)
* C-c C-e I: iCalendar export. (line 15)
* C-c C-e i: iCalendar export. (line 13)
* C-c C-e t: Export options. (line 13)
* C-c C-e v <1>: XOXO export. (line 11)
* C-c C-e v: Sparse trees. (line 41)
* C-c C-e v a: ASCII export. (line 13)
* C-c C-e v b: HTML export. (line 14)
* C-c C-e v h: HTML export. (line 14)
* C-c C-e v b: Export commands. (line 10)
* C-c C-e v h: Export commands. (line 10)
* C-c C-e x: XOXO export. (line 10)
* C-c C-f: Motion. (line 12)
* C-c C-j: Motion. (line 21)
@ -5871,35 +6010,35 @@ Key Index
* C-c C-r: Visibility cycling. (line 32)
* C-c C-s <1>: Agenda commands. (line 155)
* C-c C-s: Creating timestamps. (line 48)
* C-c C-t <1>: Clocking work time. (line 26)
* C-c C-t <1>: Clocking work time. (line 27)
* C-c C-t: TODO basics. (line 13)
* C-c C-u: Motion. (line 18)
* C-c C-v: TODO basics. (line 26)
* C-c C-w: Creating timestamps. (line 41)
* C-c C-x b: Visibility cycling. (line 38)
* C-c C-x b: Visibility cycling. (line 39)
* C-c C-x C-a: ARCHIVE tag. (line 28)
* C-c C-x C-b: Checkboxes. (line 38)
* C-c C-x C-c: Agenda commands. (line 220)
* C-c C-x C-d: Clocking work time. (line 34)
* C-c C-x C-d: Clocking work time. (line 35)
* C-c C-x C-i: Clocking work time. (line 12)
* C-c C-x C-k: Structure editing. (line 39)
* C-c C-x C-l: Processing LaTeX fragments.
(line 9)
* C-c C-x C-o: Clocking work time. (line 14)
* C-c C-x C-r: Clocking work time. (line 42)
* C-c C-x C-r: Clocking work time. (line 43)
* C-c C-x C-t: Custom time format. (line 12)
* C-c C-x C-u: Dynamic blocks. (line 21)
* C-c C-x C-w <1>: Built-in table editor.
(line 114)
* C-c C-x C-w: Structure editing. (line 39)
* C-c C-x C-x: Clocking work time. (line 30)
* C-c C-x C-x: Clocking work time. (line 31)
* C-c C-x C-y <1>: Built-in table editor.
(line 118)
* C-c C-x C-y: Structure editing. (line 46)
* C-c C-x M-w <1>: Built-in table editor.
(line 111)
* C-c C-x M-w: Structure editing. (line 43)
* C-c C-y <1>: Clocking work time. (line 21)
* C-c C-y <1>: Clocking work time. (line 22)
* C-c C-y: Creating timestamps. (line 66)
* C-c l: Handling links. (line 9)
* C-c {: CDLaTeX mode. (line 21)
@ -5915,7 +6054,7 @@ Key Index
* C-u C-c C-l: Handling links. (line 43)
* C-u C-c C-x C-a: ARCHIVE tag. (line 31)
* C-u C-c C-x C-u <1>: Dynamic blocks. (line 22)
* C-u C-c C-x C-u: Clocking work time. (line 69)
* C-u C-c C-x C-u: Clocking work time. (line 70)
* D: Agenda commands. (line 74)
* d: Agenda commands. (line 71)
* f: Agenda commands. (line 44)
@ -6019,160 +6158,171 @@ Key Index

Tag Table:
Node: Top964
Node: Introduction10454
Node: Summary10869
Node: Installation13781
Node: Activation15159
Node: Feedback16408
Node: Document structure18484
Node: Outlines19258
Node: Headlines19918
Node: Visibility cycling20541
Ref: Visibility cycling-Footnote-122567
Ref: Visibility cycling-Footnote-222625
Ref: Visibility cycling-Footnote-322675
Node: Motion22944
Node: Structure editing23728
Node: Archiving26554
Node: ARCHIVE tag27112
Node: Moving subtrees28905
Node: Sparse trees29946
Ref: Sparse trees-Footnote-132077
Ref: Sparse trees-Footnote-232169
Node: Plain lists32284
Ref: Plain lists-Footnote-135809
Ref: Plain lists-Footnote-236166
Node: Tables36350
Node: Built-in table editor36898
Node: Narrow columns44926
Ref: Narrow columns-Footnote-146865
Node: Table calculations46911
Node: Formula syntax48231
Ref: Formula syntax-Footnote-151136
Node: Lisp formulas51436
Node: Column formulas52225
Node: Advanced features53987
Node: Named-field formulas57241
Node: Editing/debugging formulas57881
Node: Appetizer59639
Node: orgtbl-mode60742
Node: table.el61233
Node: Hyperlinks62210
Node: Link format62983
Node: Internal links64276
Ref: Internal links-Footnote-166265
Node: Radio targets66397
Node: CamelCase links67112
Node: External links67706
Node: Handling links69837
Ref: Handling links-Footnote-174489
Ref: Handling links-Footnote-274726
Node: Link abbreviations74800
Node: Search options76479
Ref: Search options-Footnote-178259
Node: Custom searches78340
Node: Remember79388
Node: TODO items83082
Node: TODO basics84064
Node: TODO extensions85591
Node: Workflow states86386
Node: TODO types87254
Ref: TODO types-Footnote-188912
Node: Per file keywords88994
Ref: Per file keywords-Footnote-190448
Node: Priorities90649
Node: Breaking down tasks91893
Ref: Breaking down tasks-Footnote-192412
Node: Checkboxes92508
Node: Timestamps95263
Node: Time stamps95724
Ref: Time stamps-Footnote-199218
Ref: Time stamps-Footnote-299334
Node: Creating timestamps99489
Node: The date/time prompt102115
Ref: The date/time prompt-Footnote-1103881
Node: Custom time format103987
Node: Progress logging105546
Node: Closing items106075
Node: Clocking work time106979
Ref: Clocking work time-Footnote-1110603
Node: Tags110729
Node: Tag inheritance111491
Node: Setting tags112428
Ref: Setting tags-Footnote-1116627
Ref: Setting tags-Footnote-2116739
Node: Tag searches116822
Node: Agenda views119534
Node: Agenda files121474
Ref: Agenda files-Footnote-1122434
Ref: Agenda files-Footnote-2122583
Node: Agenda dispatcher122776
Node: Built-in agenda views124467
Node: Weekly/Daily agenda125045
Node: Global TODO list127174
Node: Matching headline tags129347
Node: Timeline130418
Node: Stuck projects131084
Node: Presentation and sorting132783
Node: Categories133574
Node: Time-of-day specifications134238
Node: Sorting of agenda items136209
Node: Agenda commands137491
Node: Custom agenda views144144
Node: Storing searches144819
Node: Block agenda146731
Node: Setting Options147961
Node: Batch processing150673
Node: Embedded LaTeX151803
Ref: Embedded LaTeX-Footnote-1152895
Node: Math symbols153085
Node: Subscripts and Superscripts153850
Node: LaTeX fragments154694
Ref: LaTeX fragments-Footnote-1156802
Node: Processing LaTeX fragments157064
Node: CDLaTeX mode158010
Ref: CDLaTeX mode-Footnote-1160494
Node: Exporting160642
Node: ASCII export161956
Node: HTML export163246
Node: XOXO export166082
Node: iCalendar export166521
Node: Text interpretation168344
Node: Comment lines168823
Node: Enhancing text169294
Node: Export options170986
Node: Publishing172653
Ref: Publishing-Footnote-1173449
Node: Configuration173645
Node: Project alist174363
Node: Sources and destinations175429
Node: Selecting files176159
Node: Publishing action176907
Node: Publishing options178140
Node: Publishing links180292
Node: Project page index181805
Node: Sample configuration182583
Node: Simple example183075
Node: Complex example183748
Node: Triggering publication185824
Node: Miscellaneous186509
Node: Completion187143
Node: Customization188614
Node: In-buffer settings189197
Node: The very busy C-c C-c key192816
Node: Clean view194460
Node: TTY keys197037
Node: Interaction198646
Node: Cooperation199043
Node: Conflicts200910
Node: Bugs202502
Node: Extensions and Hacking203896
Node: Extensions204400
Node: Dynamic blocks206187
Node: Special agenda views208143
Ref: Special agenda views-Footnote-1210424
Node: History and Acknowledgments210684
Node: Index215691
Node: Key Index242933
Node: Introduction10833
Node: Summary11248
Node: Installation14160
Node: Activation15538
Node: Feedback16787
Node: Document structure18863
Node: Outlines19637
Node: Headlines20297
Node: Visibility cycling20920
Ref: Visibility cycling-Footnote-123011
Ref: Visibility cycling-Footnote-223069
Ref: Visibility cycling-Footnote-323119
Node: Motion23388
Node: Structure editing24172
Node: Archiving26998
Node: ARCHIVE tag27556
Node: Moving subtrees29349
Node: Sparse trees30390
Ref: Sparse trees-Footnote-132521
Ref: Sparse trees-Footnote-232703
Node: Plain lists32818
Ref: Plain lists-Footnote-136343
Ref: Plain lists-Footnote-236700
Node: Tables36884
Node: Built-in table editor37432
Node: Narrow columns45460
Ref: Narrow columns-Footnote-147399
Node: Table calculations47445
Node: Formula syntax48765
Ref: Formula syntax-Footnote-151670
Node: Lisp formulas51970
Node: Column formulas52759
Node: Advanced features54521
Node: Named-field formulas57775
Node: Editing/debugging formulas58415
Node: Appetizer60173
Node: orgtbl-mode61276
Node: table.el61767
Node: Hyperlinks62744
Node: Link format63517
Node: Internal links64810
Ref: Internal links-Footnote-166799
Node: Radio targets66931
Node: CamelCase links67646
Node: External links68240
Node: Handling links70644
Ref: Handling links-Footnote-175296
Ref: Handling links-Footnote-275533
Node: Link abbreviations75607
Node: Search options77286
Ref: Search options-Footnote-179066
Node: Custom searches79147
Node: Remember80195
Node: TODO items83889
Node: TODO basics84871
Node: TODO extensions86398
Node: Workflow states87193
Node: TODO types88178
Ref: TODO types-Footnote-189836
Node: Per file keywords89918
Ref: Per file keywords-Footnote-191372
Node: Priorities91573
Node: Breaking down tasks92817
Ref: Breaking down tasks-Footnote-193336
Node: Checkboxes93432
Node: Timestamps96187
Node: Time stamps96648
Ref: Time stamps-Footnote-1100142
Ref: Time stamps-Footnote-2100258
Node: Creating timestamps100413
Node: The date/time prompt103039
Ref: The date/time prompt-Footnote-1104805
Node: Custom time format104911
Node: Progress logging106470
Node: Closing items107119
Ref: Closing items-Footnote-1108053
Ref: Closing items-Footnote-2108122
Node: Tracking TODO state changes108195
Node: Clocking work time109051
Ref: Clocking work time-Footnote-1112697
Ref: Clocking work time-Footnote-2112775
Node: Tags112901
Node: Tag inheritance113663
Node: Setting tags114600
Ref: Setting tags-Footnote-1118799
Ref: Setting tags-Footnote-2118911
Node: Tag searches118994
Node: Agenda views121706
Node: Agenda files123646
Ref: Agenda files-Footnote-1124606
Ref: Agenda files-Footnote-2124755
Node: Agenda dispatcher124948
Node: Built-in agenda views126639
Node: Weekly/Daily agenda127217
Node: Global TODO list129346
Node: Matching headline tags131519
Node: Timeline132590
Node: Stuck projects133256
Node: Presentation and sorting134955
Node: Categories135746
Node: Time-of-day specifications136410
Node: Sorting of agenda items138381
Node: Agenda commands139663
Node: Custom agenda views146316
Node: Storing searches146991
Node: Block agenda148903
Node: Setting Options150133
Node: Batch processing152845
Node: Embedded LaTeX153975
Ref: Embedded LaTeX-Footnote-1155067
Node: Math symbols155257
Node: Subscripts and Superscripts156022
Node: LaTeX fragments156866
Ref: LaTeX fragments-Footnote-1158974
Node: Processing LaTeX fragments159236
Node: CDLaTeX mode160182
Ref: CDLaTeX mode-Footnote-1162666
Node: Exporting162814
Node: ASCII export164128
Node: HTML export165418
Node: Export commands166037
Node: Quoting HTML tags166761
Node: Links167104
Node: Images167801
Ref: Images-Footnote-1168672
Node: CSS support168733
Ref: CSS support-Footnote-1170052
Node: XOXO export170165
Node: iCalendar export170604
Node: Text interpretation172427
Node: Comment lines172906
Node: Enhancing text173377
Node: Export options175069
Node: Publishing176736
Ref: Publishing-Footnote-1177532
Node: Configuration177728
Node: Project alist178446
Node: Sources and destinations179512
Node: Selecting files180242
Node: Publishing action180990
Node: Publishing options182223
Node: Publishing links184375
Node: Project page index185888
Node: Sample configuration186666
Node: Simple example187158
Node: Complex example187831
Node: Triggering publication189907
Node: Miscellaneous190592
Node: Completion191226
Node: Customization192697
Node: In-buffer settings193280
Node: The very busy C-c C-c key197139
Node: Clean view198783
Node: TTY keys201360
Node: Interaction202969
Node: Cooperation203366
Node: Conflicts205233
Node: Bugs206825
Node: Extensions and Hacking208219
Node: Extensions208723
Node: Dynamic blocks210510
Node: Special agenda views212466
Ref: Special agenda views-Footnote-1214747
Node: History and Acknowledgments215007
Node: Index220134
Node: Key Index248617

End Tag Table

665
org.el

File diff suppressed because it is too large Load Diff

BIN
org.pdf

Binary file not shown.

201
org.texi
View File

@ -3,7 +3,7 @@
@setfilename ../info/org
@settitle Org Mode Manual
@set VERSION 4.59
@set VERSION 4.60
@set DATE December 2006
@dircategory Emacs
@ -180,6 +180,7 @@ Creating timestamps
Progress Logging
* Closing items:: When was this entry marked DONE?
* Tracking TODO state changes:: When did the status change?
* Clocking work time:: When exactly did you work on this item?
Tags
@ -234,6 +235,14 @@ Exporting
* iCalendar export:: Exporting in iCalendar format
* Text interpretation:: How the exporter looks at the file
HTML export
* Export commands:: How to invode HTML export
* Quoting HTML tags:: Using direct HTML in Org-mode
* Links:: How hyperlinks get transferred to HTML
* Images:: To inline or not to inline?
* CSS support:: Style specifications
Text interpretation by the exporter
* Comment lines:: Some lines will not be exported
@ -622,7 +631,8 @@ Show all.
Reveal context around point, showing the current entry, the following
heading and the hierarchy above. Useful for working near a location
exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda
command (@pxref{Agenda commands}).
command (@pxref{Agenda commands}). With prefix arg show, on each
level, all sibling headings.
@kindex C-c C-x b
@item C-c C-x b
Show the current subtree in an indirect buffer@footnote{The indirect
@ -867,9 +877,10 @@ An important feature of Org-mode is the ability to construct
sparse tree means that the entire document is folded as much as
possible, but the selected information is made visible along with the
headline structure above it@footnote{See also the variables
@code{org-show-hierarchy-above} and
@code{org-show-following-heading}.}. Just try it out and you will see
immediately how it works.
@code{org-show-hierarchy-above}, @code{org-show-following-heading}, and
@code{org-show-siblings} for detailed control on how much context is
shown around each match.}. Just try it out and you will see immediately
how it works.
Org-mode contains several commands creating such trees. The most
basic one is @command{org-occur}:
@ -1857,12 +1868,19 @@ format}), for example:
[[http://www.gnu.org/software/emacs/][GNU Emacs]]
@end example
@noindent
If the description is a file name or URL that points to an image, HTML
export (@pxref{HTML export}) will inline the image as a clickable
button. If there is no description at all and the link points to an
image,
that image will be inlined into the exported HTML file.
@cindex angular brackets, around links
@cindex plain text external links
Org-mode also finds external links in the normal text and activates them
as links. If spaces must be part of the link (for example in
@samp{bbdb:Richard Stallman}), or you need to remove ambiguities about the end of
the link, enclose them in angular brackets.
@samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
about the end of the link, enclose them in angular brackets.
@node Handling links, Link abbreviations, External links, Hyperlinks
@section Handling links
@ -2304,7 +2322,9 @@ TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may also
use a prefix argument to quickly select a specific state. For example
@kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
If you define many keywords, you can use in-buffer completion (see
@ref{Completion}) to insert these words into the buffer.
@ref{Completion}) to insert these words into the buffer. Changing a todo
state can be logged with a timestamp, see @ref{Tracking TODO state
changes} for more information.
@node TODO types, Per file keywords, Workflow states, TODO extensions
@subsection TODO keywords as types
@ -2831,20 +2851,23 @@ format is shorter, things do work as expected.
@cindex logging, of progress
Org-mode can automatically record a time stamp when you mark a TODO item
as DONE. You can also measure precisely the time you spent on specific
items in a project by starting and stopping a clock when you start and
stop working on an aspect of a project.
as DONE, or even each time when you change the state of a TODO item.
You can also measure precisely the time you spent on specific items in a
project by starting and stopping a clock when you start and stop working
on an aspect of a project.
@menu
* Closing items:: When was this entry marked DONE?
* Tracking TODO state changes:: When did the status change?
* Clocking work time:: When exactly did you work on this item?
@end menu
@node Closing items, Clocking work time, Progress logging, Progress logging
@node Closing items, Tracking TODO state changes, Progress logging, Progress logging
@subsection Closing items
If you want to keep track of @emph{when} a certain TODO item was
finished, turn on logging with
finished, turn on logging with@footnote{The corresponding in-buffer
setting is: @code{#+STARTUP: logdone}}
@lisp
(setq org-log-done t)
@ -2853,16 +2876,44 @@ finished, turn on logging with
@noindent
Then each time you turn a TODO entry into DONE using either @kbd{C-c
C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line
@samp{CLOSED: [timestamp]} will be inserted just after the headline.
If you turn the entry back into a TODO item again through further
state cycling, that line will be removed again. In the timeline
(@pxref{Timeline}) and in the agenda (@pxref{Weekly/Daily agenda}),
you can then use the @kbd{l} key to display the TODO items closed on
each day, giving you an overview of what has been done on a day.
See the variable @code{org-log-done} for the possibility to record an
additional note together with a timestamp.
@samp{CLOSED: [timestamp]} will be inserted just after the headline. If
you turn the entry back into a TODO item through further state cycling,
that line will be removed again. In the timeline (@pxref{Timeline}) and
in the agenda (@pxref{Weekly/Daily agenda}), you can then use the
@kbd{l} key to display the TODO items closed on each day, giving you an
overview of what has been done on a day. If you want to record a note
along with the timestamp, use@footnote{The corresponding in-buffer
setting is: @code{#+STARTUP: lognotedone}}
@node Clocking work time, , Closing items, Progress logging
@lisp
(setq org-log-done '(done))
@end lisp
@node Tracking TODO state changes, Clocking work time, Closing items, Progress logging
@subsection Tracking TODO state changes
When TODO keywords are used as workflow states (@pxref{Workflow
states}), you might want to keep track of when a state change occurred,
and you may even want to attach notes to that state change. With the
setting
@lisp
(setq org-log-done '(state))
@end lisp
@noindent
each state change will prompt you for a note that will be attached to
the current headline. Very likely you do not want this verbose tracking
all the time, so it is probably better to configure this behavior with
in-buffer options. For example, if you are tracking purchases, put
these into a separate file that starts with:
@example
#+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT
#+STARTUP: lognotestate
@end example
@node Clocking work time, , Tracking TODO state changes, Progress logging
@subsection Clocking work time
Org-mode allows you to clock the time you spent on specific tasks in a
@ -2882,7 +2933,9 @@ Stop the clock (clock-out). The inserts another timestamp at the same
location where the clock was last started. It also directly computes
the resulting time in inserts it after the time range as @samp{=>
HH:MM}. See the variable @code{org-log-done} for the possibility to
record an additional note together with the clock-out time stamp.
record an additional note together with the clock-out time
stamp@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
lognoteclock-out}}.
@kindex C-c C-y
@item C-c C-y
Recompute the time interval after changing one of the time stamps. This
@ -2951,6 +3004,29 @@ The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
worked on or closed during a day.
@c @node Self-repeating deadlines
@c @section Self-repeating deadlines
@c
@c Org-mode integrates with the Emacs calendar and diary to display cyclic
@c appointments and anniversaries in the agenda (@pxref{The weekly/daily
@c agenda}). However, it can be useful to have certain deadlines and
@c scheduling items to auto-repeat. The advantage of a deadline or
@c scheduled item is that the they produce warnings ahead of time and
@c automatically forward themselves in the agenda until they are done. The
@c abstract difference is therefore between cyclic @i{appointments} and
@c cyclic @i{action items}. For appointments you should use the diary, for
@c actions you can uses an org-mode deadline or scheduling time stamp
@c together with a REPEAT cookie. For example:
@c
@c @example
@c * TODO Income tax to IRS REPEAT(+1y)
@c DEADLINE: <2006-12-19 Tue>
@c @end example
@c
@c Each time you try to mark this entry DONE using @kbd{C-c C-t}, it will
@c automatically switch back to the state TODO, and the deadline will be
@c shifted by 1 year.
@node Tags, Agenda views, Timestamps, Top
@chapter Tags
@cindex tags
@ -4425,6 +4501,17 @@ Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
HTML formatting, in ways similar to John Grubers @emph{markdown}
language, but with additional support for tables.
@menu
* Export commands:: How to invode HTML export
* Quoting HTML tags:: Using direct HTML in Org-mode
* Links:: How hyperlinks get transferred to HTML
* Images:: To inline or not to inline?
* CSS support:: Style specifications
@end menu
@node Export commands, Quoting HTML tags, HTML export, HTML export
@subsection HTML export commands
@cindex region, active
@cindex active region
@cindex transient-mark-mode
@ -4455,11 +4542,17 @@ at a different level, specify it with a prefix argument. For example,
@noindent
creates two levels of headings and does the rest as items.
@node Quoting HTML tags, Links, Export commands, HTML export
@subsection Quoting HTML tags
If you want to include HTML tags which should be interpreted as such,
mark them with @samp{@@} as in @samp{@@<b>bold text@@</b>}.
Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
@samp{&gt;} in HTML export.
@node Links, Images, Quoting HTML tags, HTML export
@subsection Links
@cindex links, in HTML export
@cindex internal links, in HTML export
@cindex external links, in HTML export
@ -4473,6 +4566,33 @@ HTML version also exists of the linked file. For information related to
linking files while publishing them to a publishing directory see
@ref{Publishing links}.
@node Images, CSS support, Links, HTML export
@subsection Images
@cindex images, inline in HTML
@cindex inlining images in HTML
HTML export can inline images given as links in the Org-mode file, and
it can make an image the clickable part of a link. By
default@footnote{but see the variable
@code{org-export-html-inline-images}}, images are inlined if a link does
not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
while @samp{[[file:myimg.jpg][the image]]} will just produce a link
@samp{the image} that points to the image. If the description part
itself is a @code{file:} link or a @code{http:} URL pointing to an
image, this image will be inlined and activated so that clicking on the
image will activate the link. For example, to include a thumbnail that
will link to a high resolution version of the image, you could use:
@example
[[file:highres.jpg][file:thumb.jpg]]
@end example
@noindent
and you could use @code{http} addresses just as well.
@node CSS support, , Images, HTML export
@subsection CSS support
You can also give style information for the exported file. The HTML
exporter assigns the following CSS classes to appropriate parts of the
document - your style specifications may change these:
@ -4488,10 +4608,12 @@ document - your style specifications may change these:
The default style specification can be configured through the option
@code{org-export-html-style}. If you want to use a file-local style,
you may use file variables, best wrapped into a COMMENT section at the
end of the outline tree. For example:
end of the outline tree. For example@footnote{Under Emacs 21, the
continuation lines for a variable value should have no @samp{#} at the
start of the line.}:
@example
* COMMENT HTML style specifications
* COMMENT html style specifications
# Local Variables:
# org-export-html-style: " <style type=\"text/css\">
@ -5162,6 +5284,9 @@ Org-mode file is being visited. The first set of options deals with the
initial visibility of the outline tree. The corresponding variable for
global default settings is @code{org-startup-folded}, with a default
value @code{t}, which means @code{overview}.
@cindex @code{overview}, STARTUP keyword
@cindex @code{content}, STARTUP keyword
@cindex @code{showall}, STARTUP keyword
@example
overview @r{top-level headlines only}
content @r{all headlines}
@ -5171,20 +5296,34 @@ Then there are options for aligning tables upon visiting a file. This
is useful in files containing narrowed table columns. The corresponding
variable is @code{org-startup-align-all-tables}, with a default value
@code{nil}.
@cindex @code{align}, STARTUP keyword
@cindex @code{noalign}, STARTUP keyword
@example
align @r{align all tables}
noalign @r{don't align tables on startup}
@end example
Logging when a TODO item is marked DONE (variable @code{org-log-done})
can be configured using these options.
Logging TODO state changes and clock intervals (variable
@code{org-log-done}) can be configured using these options.
@cindex @code{logdone}, STARTUP keyword
@cindex @code{nologging}, STARTUP keyword
@cindex @code{lognotedone}, STARTUP keyword
@cindex @code{lognoteclock-out}, STARTUP keyword
@cindex @code{lognotestate}, STARTUP keyword
@example
logging @r{record a timestamp when an item is marked DONE}
nologging @r{don't record when items are marked DONE}
logging @r{record a timestamp when an item is marked DONE}
nologging @r{don't record when items are marked DONE}
lognotedone @r{record timestamp and a note when DONE}
lognotestate @r{record timestamp, note when TODO state changes}
lognoteclock-out @r{record timestamp and a note when clocking out}
@end example
Here are the options for hiding leading stars in outline headings. The
corresponding variables are @code{org-hide-leading-stars} and
@code{org-odd-levels-only}, both with a default setting @code{nil}
(meaning @code{showstars} and @code{oddeven}).
@cindex @code{hidestars}, STARTUP keyword
@cindex @code{showstars}, STARTUP keyword
@cindex @code{odd}, STARTUP keyword
@cindex @code{even}, STARTUP keyword
@example
hidestars @r{make all but one of the stars starting a headline invisible.}
showstars @r{show all stars starting a headline}
@ -5194,6 +5333,7 @@ oddeven @r{allow all outline levels}
To turn on custom format overlays over time stamps (variables
@code{org-put-time-stamp-overlays} and
@code{org-time-stamp-overlay-formats}), use
@cindex @code{customtime}, STARTUP keyword
@example
customtime @r{overlay custom time format}
@end example
@ -5749,6 +5889,9 @@ patched CSS formatting into the HTML exporter, and inspired the agenda.
@item
@i{Nic Ferrier} contributed mailcap and XOXO support.
@item
@i{John Foerch} figured out how to make incremental search show context
around a match in a hidden outline tree.
@item
@i{Niels Giessen} had the idea to automatically archive DONE trees.
@item
@i{Bastien Guerry} provided extensive feedback.

Binary file not shown.

View File

@ -1,5 +1,5 @@
% Reference Card for Org Mode
\def\orgversionnumber{4.59}
\def\orgversionnumber{4.60}
\def\year{2006}
%
%**start of header

View File

@ -77,7 +77,7 @@ that can be added."
:group 'editing)
(defcustom outline-regexp "[*\^L]+"
"*Regular expression to match the beginning of a heading.
"Regular expression to match the beginning of a heading.
Any line whose beginning matches this regexp is considered to start a heading.
Note that Outline mode only checks this regexp at the start of a line,
so the regexp need not (and usually does not) start with `^'.
@ -87,7 +87,7 @@ in the file it applies to. See also `outline-heading-end-regexp'."
:group 'outlines)
(defcustom outline-heading-end-regexp "\n"
"*Regular expression to match the end of a heading line.
"Regular expression to match the end of a heading line.
You can assume that point is at the beginning of a heading when this
regexp is searched for. The heading ends at the end of the match.
The recommended way to set this is with a `Local Variables:' list
@ -249,10 +249,10 @@ in the file it applies to."
"Normal hook to be run after outline visibility changes.")
(defvar outline-mode-hook nil
"*This hook is run when outline mode starts.")
"This hook is run when outline mode starts.")
(defvar outline-blank-line nil
"*Non-nil means to leave unhidden blank line before heading.")
"Non-nil means to leave unhidden blank line before heading.")
;;;###autoload
(define-derived-mode outline-mode text-mode "Outline"
@ -316,7 +316,7 @@ Turning on outline mode calls the value of `text-mode-hook' and then of
(add-hook 'change-major-mode-hook 'show-all nil t))
(defcustom outline-minor-mode-prefix "\C-c@"
"*Prefix key to use for Outline commands in Outline minor mode.
"Prefix key to use for Outline commands in Outline minor mode.
The value of this variable is checked as part of loading Outline mode.
After that, changing the prefix key requires manipulating keymaps."
:type 'string
@ -351,7 +351,7 @@ See the command `outline-mode' for more information on this mode."
(show-all)))
(defvar outline-level 'outline-level
"*Function of no args to compute a header's nesting level in an outline.
"Function of no args to compute a header's nesting level in an outline.
It can assume point is at the beginning of a header line and that the match
data reflects the `outline-regexp'.")
@ -702,6 +702,11 @@ This puts point at the start of the current subtree, and mark at the end."
(goto-char beg)))
(defvar outline-isearch-open-invisible-function nil
"Function called if `isearch' finishes in an invisible overlay.
The function is called with the overlay as its only argument.
If nil, `show-entry' is called to reveal the invisible text.")
(defun outline-discard-extents (&optional beg end)
"Clear BEG and END of overlays whose property NAME has value VAL.
Overlays might be moved and/or split.
@ -725,14 +730,6 @@ BEG and END default respectively to the beginning and end of buffer."
(delete-extent ex)))
(current-buffer) beg end nil 'end-closed 'outline)))
;;;(defun outline-discard-extents (from to)
;;; "Delete hideshow extents in region defined by FROM and TO."
;;; (when (< to from)
;;; (setq from (prog1 to (setq to from))))
;;; (map-extents #'(lambda (ex ignored) (delete-extent ex))
;;; (current-buffer) from to nil 'end-closed 'outline))
(defun outline-flag-region (from to flag)
"Hide or show lines from FROM to TO, according to FLAG.
If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
@ -744,11 +741,12 @@ If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
(let ((ex (make-extent from to)))
(set-extent-property ex 'invisible 'outline)
(set-extent-property ex 'outline flag)
(set-extent-property ex 'isearch-open-invisible 'outline-isearch-open-invisible)))
;; FIXME: I don't think XEmacs uses this, actually.
(set-extent-property ex 'isearch-open-invisible
(or outline-isearch-open-invisible-function
'outline-isearch-open-invisible))))
;; Seems only used by lazy-lock. I.e. obsolete.
(run-hooks 'outline-view-change-hook))
;; Function to be set as an outline-isearch-open-invisible' property
;; to the overlay that makes the outline invisible (see
@ -894,7 +892,8 @@ Show the heading too, if it is currently invisible."
(or first (> (funcall outline-level) level)))
(setq first nil)
(outline-next-heading))
(if (bolp)
(if (and (bolp) (not (eolp)))
;; We stopped at a nonempty line (the next heading).
(progn
;; Go to end of line before heading
(forward-char -1)