forked from mirrors/org-mode
Release 4.51
This commit is contained in:
parent
d45806cc97
commit
fdf165e556
513
org
513
org
|
@ -5,7 +5,7 @@ START-INFO-DIR-ENTRY
|
||||||
* Org Mode: (org). outline-based notes management and organizer
|
* Org Mode: (org). outline-based notes management and organizer
|
||||||
END-INFO-DIR-ENTRY
|
END-INFO-DIR-ENTRY
|
||||||
|
|
||||||
This manual is for Org-mode (version 4.50).
|
This manual is for Org-mode (version 4.51).
|
||||||
|
|
||||||
Copyright (C) 2004, 2005, 2006 Free Software Foundation
|
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
|
Org Mode Manual
|
||||||
***************
|
***************
|
||||||
|
|
||||||
This manual is for Org-mode (version 4.50).
|
This manual is for Org-mode (version 4.51).
|
||||||
|
|
||||||
Copyright (C) 2004, 2005, 2006 Free Software Foundation
|
Copyright (C) 2004, 2005, 2006 Free Software Foundation
|
||||||
|
|
||||||
|
@ -111,6 +111,7 @@ Hyperlinks
|
||||||
* Internal links:: Links to other places in the current file
|
* Internal links:: Links to other places in the current file
|
||||||
* External links:: URL-like links to the world
|
* External links:: URL-like links to the world
|
||||||
* Handling links:: Creating, inserting and following
|
* Handling links:: Creating, inserting and following
|
||||||
|
* Link abbreviations:: Shortcuts for writing complex links
|
||||||
* Search options:: Linking to a specific location
|
* Search options:: Linking to a specific location
|
||||||
* Custom searches:: When the default search is not enough
|
* Custom searches:: When the default search is not enough
|
||||||
* Remember:: Org-trees store quick notes
|
* Remember:: Org-trees store quick notes
|
||||||
|
@ -140,6 +141,10 @@ Timestamps
|
||||||
* Creating timestamps:: Commands which insert timestamps
|
* Creating timestamps:: Commands which insert timestamps
|
||||||
* Progress logging:: Documenting when what work was done.
|
* Progress logging:: Documenting when what work was done.
|
||||||
|
|
||||||
|
Creating timestamps
|
||||||
|
|
||||||
|
* The date/time prompt::
|
||||||
|
|
||||||
Progress Logging
|
Progress Logging
|
||||||
|
|
||||||
* Closing items:: When was this entry marked DONE?
|
* Closing items:: When was this entry marked DONE?
|
||||||
|
@ -1445,6 +1450,7 @@ links to other files, Usenet articles, emails, and much more.
|
||||||
* Internal links:: Links to other places in the current file
|
* Internal links:: Links to other places in the current file
|
||||||
* External links:: URL-like links to the world
|
* External links:: URL-like links to the world
|
||||||
* Handling links:: Creating, inserting and following
|
* Handling links:: Creating, inserting and following
|
||||||
|
* Link abbreviations:: Shortcuts for writing complex links
|
||||||
* Search options:: Linking to a specific location
|
* Search options:: Linking to a specific location
|
||||||
* Custom searches:: When the default search is not enough
|
* Custom searches:: When the default search is not enough
|
||||||
* Remember:: Org-trees store quick notes
|
* Remember:: Org-trees store quick notes
|
||||||
|
@ -1553,9 +1559,11 @@ File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
|
||||||
|
|
||||||
Org-mode also supports CamelCase words as links. This feature is not
|
Org-mode also supports CamelCase words as links. This feature is not
|
||||||
turned on by default because of the inconsistencies this system suffers
|
turned on by default because of the inconsistencies this system suffers
|
||||||
from. To activate CamelCase words as links, you need to customize the
|
from. It is also possible that this feature will disappear entirely in
|
||||||
option `org-activate-links'. A CamelCase word then leads to a text
|
a future version of Org-mode. To activate CamelCase words as links, you
|
||||||
search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
|
need to customize the option `org-activate-links'. A CamelCase word
|
||||||
|
then leads to a text search such that `CamelCaseLink' is equivalent to
|
||||||
|
`[[camel case link]]'.
|
||||||
|
|
||||||
|
|
||||||
File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
|
File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
|
||||||
|
@ -1601,7 +1609,7 @@ them as links. If spaces must be part of the link (for example in
|
||||||
end of the link, enclose them in angular brackets.
|
end of the link, enclose them in angular brackets.
|
||||||
|
|
||||||
|
|
||||||
File: org, Node: Handling links, Next: Search options, Prev: External links, Up: Hyperlinks
|
File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks
|
||||||
|
|
||||||
4.4 Handling links
|
4.4 Handling links
|
||||||
==================
|
==================
|
||||||
|
@ -1678,7 +1686,8 @@ insert it into an org-mode file, and to follow the link.
|
||||||
Under Emacs 22, also `mouse-1' will follow a link.
|
Under Emacs 22, also `mouse-1' will follow a link.
|
||||||
|
|
||||||
`mouse-3'
|
`mouse-3'
|
||||||
Like `mouse-2', but force file links to be opened with Emacs.
|
Like `mouse-2', but force file links to be opened with Emacs, and
|
||||||
|
internal links to be displayed in another window(2).
|
||||||
|
|
||||||
`C-c %'
|
`C-c %'
|
||||||
Push the current position onto the mark ring, to be able to return
|
Push the current position onto the mark ring, to be able to return
|
||||||
|
@ -1697,10 +1706,53 @@ the list of stored links. To keep it in the list later use, use a
|
||||||
triple `C-u' prefix to `C-c C-l', or configure the option
|
triple `C-u' prefix to `C-c C-l', or configure the option
|
||||||
`org-keep-stored-link-after-insertion'.
|
`org-keep-stored-link-after-insertion'.
|
||||||
|
|
||||||
|
(2) See the variable `org-display-internal-link-with-indirect-buffer'
|
||||||
File: org, Node: Search options, Next: Custom searches, Prev: Handling links, Up: Hyperlinks
|
|
||||||
|
|
||||||
4.5 Search options in file links
|
|
||||||
|
File: org, Node: Link abbreviations, Next: Search options, Prev: Handling links, Up: Hyperlinks
|
||||||
|
|
||||||
|
4.5 Link abbreviatons
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Long URLs can be cumbersome to type, and often many similar links are
|
||||||
|
needed in a document. For this you can use link abbreviations. An
|
||||||
|
abbreviated link looks like this
|
||||||
|
|
||||||
|
[[linkword::tag][description]]
|
||||||
|
|
||||||
|
where the tag is optional. Such abbreviations are resolved according to
|
||||||
|
the information in the variable `org-link-abbrev-alist' that relates
|
||||||
|
the linkwords to replacement text. Here is an example:
|
||||||
|
|
||||||
|
(setq org-link-abbrev-alist
|
||||||
|
'(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
|
||||||
|
("google" . "http://www.google.com/search?q=")
|
||||||
|
("ads" . "http://adsabs.harvard.edu/cgi-bin/
|
||||||
|
nph-abs_connect?author=%s&db_key=AST")))
|
||||||
|
|
||||||
|
If the replacement text contains the string `%s', it will be
|
||||||
|
replaced with the tag. Otherwise the tag will be appended to the string
|
||||||
|
in order to create the link. You may also specify a function that will
|
||||||
|
be called with the tag as the only argument to create the link.
|
||||||
|
|
||||||
|
With the above setting, you could link to a specific bug with
|
||||||
|
`[[bugzilla::129]]', search the web for OrgMode with
|
||||||
|
`[[google::OrgMode]]' and find out what the Org-mode author is doing
|
||||||
|
besides Emacs hacking with `[[ads::Dominik,C]]'.
|
||||||
|
|
||||||
|
If you need special abbreviations just for a single Org-mode buffer,
|
||||||
|
you can define them in the file with
|
||||||
|
|
||||||
|
#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
|
||||||
|
#+LINK: google http://www.google.com/search?q=%s
|
||||||
|
|
||||||
|
In-buffer completion *note Completion:: can be used after `[' to
|
||||||
|
complete link abbreviations.
|
||||||
|
|
||||||
|
|
||||||
|
File: org, Node: Search options, Next: Custom searches, Prev: Link abbreviations, Up: Hyperlinks
|
||||||
|
|
||||||
|
4.6 Search options in file links
|
||||||
================================
|
================================
|
||||||
|
|
||||||
File links can contain additional information to make Emacs jump to a
|
File links can contain additional information to make Emacs jump to a
|
||||||
|
@ -1750,7 +1802,7 @@ single colon.
|
||||||
|
|
||||||
File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
|
File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
|
||||||
|
|
||||||
4.6 Custom Searches
|
4.7 Custom Searches
|
||||||
===================
|
===================
|
||||||
|
|
||||||
The default mechanism for creating search strings and for doing the
|
The default mechanism for creating search strings and for doing the
|
||||||
|
@ -1772,7 +1824,7 @@ implementation example. Search for `BibTeX links' in the source file.
|
||||||
|
|
||||||
File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
|
File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
|
||||||
|
|
||||||
4.7 Remember
|
4.8 Remember
|
||||||
============
|
============
|
||||||
|
|
||||||
Another way to create org entries with links to other files is through
|
Another way to create org entries with links to other files is through
|
||||||
|
@ -2303,12 +2355,37 @@ format.
|
||||||
end. With prefix arg, insert result after the time range (in a
|
end. With prefix arg, insert result after the time range (in a
|
||||||
table: into the following column).
|
table: into the following column).
|
||||||
|
|
||||||
When Org-mode prompts for a date/time, the function reading your
|
* Menu:
|
||||||
input will replace anything you choose not to specify with the current
|
|
||||||
date and time. For details, see the documentation string of
|
* The date/time prompt::
|
||||||
`org-read-date'. Also, a calender will pop up to allow selecting a
|
|
||||||
date. The calendar can be fully controlled from the minibuffer, and a
|
|
||||||
date can be selected with the following commands:
|
File: org, Node: The date/time prompt, Prev: Creating timestamps, Up: Creating timestamps
|
||||||
|
|
||||||
|
6.2.1 The date/time prompt
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
When Org-mode prompts for a date/time, the prompt suggests to enter an
|
||||||
|
ISO date. But it will in fact accept any string containing some date
|
||||||
|
and/or time information. You can, for example, use `C-y' to paste a
|
||||||
|
(possibly multi-line) string copied from an email message. Org-mode
|
||||||
|
will find whatever information is in there and will replace anything not
|
||||||
|
specified with the current date and time. For example:
|
||||||
|
|
||||||
|
3-2-5 --> 2003-02-05
|
||||||
|
feb 15 --> currentyear-02-15
|
||||||
|
sep 12 9 --> 2009-09-12
|
||||||
|
12:45 --> today 12:45
|
||||||
|
22 sept 0:34 --> currentyear-09-22 0:34
|
||||||
|
12 --> currentyear-currentmonth-12
|
||||||
|
Fri --> nearest Friday (today or later)
|
||||||
|
|
||||||
|
The function understands English month and weekday abbreviations. If
|
||||||
|
you want to use unabbreviated names and/or other languages, configure
|
||||||
|
the variables `parse-time-months' and `parse-time-weekdays'.
|
||||||
|
|
||||||
|
Parallel to the minibuffer prompt, a calendar is popped up(1). You
|
||||||
|
can control the calendar fully from the minibuffer:
|
||||||
|
|
||||||
`<'
|
`<'
|
||||||
Scroll calendar backwards by one month.
|
Scroll calendar backwards by one month.
|
||||||
|
@ -2340,6 +2417,11 @@ date can be selected with the following commands:
|
||||||
`<RET>'
|
`<RET>'
|
||||||
Choose date in calendar (only if nothing typed into minibuffer).
|
Choose date in calendar (only if nothing typed into minibuffer).
|
||||||
|
|
||||||
|
---------- Footnotes ----------
|
||||||
|
|
||||||
|
(1) If you don't need/want the calendar, configure the variable
|
||||||
|
`org-popup-calendar-for-date-prompt'.
|
||||||
|
|
||||||
|
|
||||||
File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
|
File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
|
||||||
|
|
||||||
|
@ -2649,6 +2731,10 @@ This buffer is read-only, but provides commands to visit the
|
||||||
corresponding locations in the original Org-mode files, and even to
|
corresponding locations in the original Org-mode files, and even to
|
||||||
edit these files remotely.
|
edit these files remotely.
|
||||||
|
|
||||||
|
Two variables control how the agenda buffer is displayed and whether
|
||||||
|
the window configuration is restored when the agenda exits:
|
||||||
|
`org-agenda-window-setup' and `org-agenda-restore-windows-after-quit'.
|
||||||
|
|
||||||
* Menu:
|
* Menu:
|
||||||
|
|
||||||
* Agenda files:: Files being searched for agenda information
|
* Agenda files:: Files being searched for agenda information
|
||||||
|
@ -4280,6 +4366,9 @@ buffer and use the key to complete text right there.
|
||||||
in-buffer option, *note Setting tags::), or it is created
|
in-buffer option, *note Setting tags::), or it is created
|
||||||
dynamically from all tags used in the current buffer.
|
dynamically from all tags used in the current buffer.
|
||||||
|
|
||||||
|
* After `[', complete link abbreviations (*note Link
|
||||||
|
abbreviations::).
|
||||||
|
|
||||||
* After `#+', complete the special keywords like `TYP_TODO' or
|
* After `#+', complete the special keywords like `TYP_TODO' or
|
||||||
`OPTIONS' which set file-specific options for Org-mode. When
|
`OPTIONS' which set file-specific options for Org-mode. When
|
||||||
the option keyword is already complete, pressing `M-<TAB>'
|
the option keyword is already complete, pressing `M-<TAB>'
|
||||||
|
@ -4359,6 +4448,11 @@ file is visited again in a new Emacs session.
|
||||||
tags in this file, and (potentially) the corresponding _fast tag
|
tags in this file, and (potentially) the corresponding _fast tag
|
||||||
selection_ keys. The corresponding variable is `org-tag-alist'.
|
selection_ keys. The corresponding variable is `org-tag-alist'.
|
||||||
|
|
||||||
|
`#+LINK: linkword replace'
|
||||||
|
These lines (several are allowed) specify link abbreviations.
|
||||||
|
*Note Link abbreviations::. The corresponding variable is
|
||||||
|
`org-link-abbrev-alist'.
|
||||||
|
|
||||||
`#+CATEGORY:'
|
`#+CATEGORY:'
|
||||||
This line sets the category for the agenda file. The category
|
This line sets the category for the agenda file. The category
|
||||||
applies for all subsequent lines until the next `#+CATEGORY' line,
|
applies for all subsequent lines until the next `#+CATEGORY' line,
|
||||||
|
@ -4873,6 +4967,8 @@ if I have forgotten someone, please accept my apologies and let me know.
|
||||||
* Daniel Sinder came up with the idea of internal archiving by
|
* Daniel Sinder came up with the idea of internal archiving by
|
||||||
locking subtrees.
|
locking subtrees.
|
||||||
|
|
||||||
|
* Dale Smith proposed link abbreviations.
|
||||||
|
|
||||||
* David O'Toole wrote `org-publish.el' and drafted the manual
|
* David O'Toole wrote `org-publish.el' and drafted the manual
|
||||||
chapter about publishing.
|
chapter about publishing.
|
||||||
|
|
||||||
|
@ -4910,6 +5006,7 @@ Index
|
||||||
|